API_autoTest
項目介紹
1. pytest命名規范
文件名需要以 test_ 開頭或者以 _test.py 結尾。例如，test_login.py、user_management_test.py 這樣的命名方式，pytest 能夠自動識別并將其作為測試文件來執行其中的測試用例。
如果在測試文件中定義測試類，類名要以 Test 開頭，并且類名不能包含 init 方法。
class TestCalculator:def test_addition(self):result = 1 + 2assert result == 3
函數名同樣要以 test_ 開頭。
def test_subtraction():result = 5 - 3assert result == 2
2. 注釋書寫：
方法、類的注釋書寫，寫到方法內，或者類內，使用三個單引號，或者3雙引號
方便其他人不進入方法就能查看，可以帶參數，跟返回值
例如：
"""將測試結果記錄下來。:param a: 參數a:param b: 參數b:return: 計劃id"""
3. pycharm常用快捷鍵，windows版-mac請自行查詢
- ctrl+alt+o,導入刪除無效的引用包
- ctrl+A, ctrl+alt+L，全選，格式化代碼
- ctrl+shift+F ,全局搜索【與windows的繁體切換沖突，可禁用繁體切換】
4. 目錄結構
- com ：存放公共方法
- config ：統一，存放配置文件。env.yml - 環境配置文件
- file : 項目用到文件。
- photo : 項目用到的圖片
- pytest.ini : pytest參數配置
- test_API : 具體請求接口文件夾
- allure-report ： allure報告地址
- conftest.py : 統一配置，接口啟動+結束設置
- run.py : 啟動文件
5. pytest關聯jira用例，自動化測試用例名稱命名規范：
- 對應jira用例的編號數字（有幾個寫幾個，編號之間用&關聯）；
- 市場：OTC（場外）、IB（銀行間）、SH（上交所）、SZ（深交所）、BJ（北交所）、FB（非標）、Clearing（清算結算）、CR（合規風控）、Public（公共基礎）、STATs（統計報表）
- 券商：GT（國泰君安）、EB（光大證券）等
- 證券類別：fund（基金）、stock（股票）、bond（債券）、repo（協議正回購）、reverse-repo（協議逆回購）、SPV(資管計劃)、Ge-repo（通用正回購）、Ge-reverse-repo（通用逆回購）等
- 委托方向：sub（申購）、redeem（贖回）、buy（買）等
- 在后面加其他想加的信息。舉例：O45_21966&21967_SH-GT-fund-buy-XXX_test.py
- 用例文件命名中一定要帶著jira的用例號
- 不允許不帶不帶jira號的_test文件提交git
- jira號的前后都是 下劃線 _,如果多個jira號，中間為&連接
- 數據分離的excel的命名規則；和測試用例的名稱一致。
6. git提交忽略文件
.gitignore
# 忽略 Python 編譯后的文件
__pycache__/
*.pyc
*.pyo
*.pyd# 忽略 Excel 打開后的臨時文件
~$*.xlsx
~$*.xls# 忽略 PyCharm 相關文件
.idea/
*.iml# 忽略 log 文件
*.log
7.其他注意事項
- 增加新文件，備注寫清楚這個文件是做什么的（實現了什么事）
- 增加新方法，最好寫清楚備注，入參，返回值信息，例如：
def get_run_id(cycle_id, issuenum):"""獲取運行run_id:param cycle_id: 測試周期id:param issuenum: 用例編號:return:返回 需要運行用例的id，也就是說這個run_id + 運行狀態，能改變用例狀態顯示結果"""# 根據測試周期id，用例編號id# 查詢，運行run_idselect = "SELECT run.ID FROM ao_69e499_testcycle cycle JOIN " \"ao_69e499_testrun run ON run.TEST_CYCLE_ID=cycle.ID JOIN " \"jiraissue issue ON issue.ID=run.TC_ID WHERE cycle.ID = %s and issue.issuenum = %s"arg = [cycle_id, issuenum]result = DBmysql().select(select, arg)return str(result[0][0])
- 復雜業務邏輯模塊一定要寫清楚備注，方便自己后面回來查看，也方便別人理解
- 提交git時【commit】會展示要提交的詳情，編譯后的文件不要提交，只提交以.py/.xlsx/.xls/.yml這種后綴的
- 測試文件/代碼 不要提交
- py文件中自己測試部分的代碼，注釋再后提交
- commit提交后，一定要記得push
- 如果提交git時，提示提交不了，可以重新在自己桌面建個新文件夾，在新文件夾中重拉代碼（目的重新建議與git最新的代碼的映射關系），將自己修改后的代碼放到新文件夾中（不要覆蓋！選跳過替換），與git文件有沖突的部分一定要合并代碼后再提交
