Pytest系列(14)- 配置檔案pytest.ini的詳細使用
如果你還想從頭學起Pytest,可以看看這個系列的文章哦!
https://www.cnblogs.com/poloyy/category/1690628.html
前言
pytest配置檔案可以改變pytest的執行方式,它是一個固定的檔案pytest.ini檔案,讀取配置資訊,按指定的方式去執行
非test檔案
pytest裡面有些檔案是非test檔案
- pytest.ini:pytest的主配置檔案,可以改變pytest的預設行為
- conftest.py:測試用例的一些fixture配置
- _init_.py:識別該資料夾為python的package包
檢視pytest.ini的配置選項
cmd執行
pytest --help
找到這部分內容
[pytest] ini-options in the first pytest.ini|tox.ini|setup.cfg file found: markers (linelist): markers for test functions empty_parameter_set_mark (string): default marker for empty parametersets norecursedirs (args): directory patterns to avoid for recursion testpaths (args): directories to search for tests when no files or directories are given in the command line. usefixtures (args): list of default fixtures to be used with this project python_files (args): glob-style file patterns for Python test module discovery python_classes (args): prefixes or glob names for Python test class discovery python_functions (args): prefixes or glob names for Python test function and method discovery disable_test_id_escaping_and_forfeit_all_rights_to_community_support (bool): disable string escape non-ascii characters, might cause unwanted side effects(use at your own risk) console_output_style (string): console output: "classic", or with additional progress information ("progress" (percentage) | "count"). xfail_strict (bool): default for the strict parameter of xfail markers when not given explicitly (default: False) enable_assertion_pass_hook (bool): Enables the pytest_assertion_pass hook.Make sure to delete any previously generated pyc cache files. junit_suite_name (string): Test suite name for JUnit report junit_logging (string): Write captured log messages to JUnit report: one of no|log|system-out|system-err|out-err|all junit_log_passing_tests (bool): Capture log information for passing tests to JUnit report: junit_duration_report (string): Duration time to report: one of total|call junit_family (string): Emit XML for schema: one of legacy|xunit1|xunit2 doctest_optionflags (args): option flags for doctests doctest_encoding (string): encoding used for doctest files cache_dir (string): cache directory path. filterwarnings (linelist): Each line specifies a pattern for warnings.filterwarnings. Processed after -W/--pythonwarnings. log_print (bool): default value for --no-print-logs log_level (string): default value for --log-level log_format (string): default value for --log-format log_date_format (string): default value for --log-date-format log_cli (bool): enable log display during test run (also known as "live logging"). log_cli_level (string): default value for --log-cli-level log_cli_format (string): default value for --log-cli-format log_cli_date_format (string): default value for --log-cli-date-format log_file (string): default value for --log-file log_file_level (string): default value for --log-file-level log_file_format (string): default value for --log-file-format log_file_date_format (string): default value for --log-file-date-format log_auto_indent (string): default value for --log-auto-indent faulthandler_timeout (string): Dump the traceback of all threads if a test takes more than TIMEOUT seconds to finish. Not available on Windows. addopts (args): extra command line options minversion (string): minimally required pytest version rsyncdirs (pathlist): list of (relative) paths to be rsynced for remote distributed testing. rsyncignore (pathlist): list of (relative) glob-style paths to be ignored for rsyncing. looponfailroots (pathlist): directories to check for changes
pytest.ini應該放哪裡?
就放在專案根目錄下 ,不要亂放,不要亂起其他名字
接下來講下常用的配置項
marks
作用:測試用例中添加了 @pytest.mark.webtest 裝飾器,如果不新增marks選項的話,就會報warnings
格式:list列表型別
寫法:
[pytest] markers = weibo: this is weibo page toutiao: toutiao xinlang: xinlang
xfail_strict
作用:設定xfail_strict = True可以讓那些標記為@pytest.mark.xfail但實際通過顯示XPASS的測試用例被報告為失敗
格式:True 、False(預設),1、0
寫法:
[pytest] # mark標記說明 markers = weibo: this is weibo page toutiao: toutiao xinlang: xinlang xfail_strict = True
具體程式碼栗子
未設定 xfail_strict = True 時,測試結果顯示XPASS
@pytest.mark.xfail() def test_case1(): a = "a" b = "b" assert a != b
collecting ... collected 1 item
02斷言異常.py::test_case1 XPASS [100%]
============================= 1 xpassed in 0.02s ==============================
已設定 xfail_strict = True 時,測試結果顯示failed
collecting ... collected 1 item 02斷言異常.py::test_case1 FAILED [100%] 02斷言異常.py:54 (test_case1) [XPASS(strict)] ================================== FAILURES =================================== _________________________________ test_case1 __________________________________ [XPASS(strict)] =========================== short test summary info =========================== FAILED 02斷言異常.py::test_case1 ============================== 1 failed in 0.02s ==============================
addopts
作用:addopts引數可以更改預設命令列選項,這個當我們在cmd輸入一堆指令去執行用例的時候,就可以用該引數代替了,省去重複性的敲命令工作
比如:想測試完生成報告,失敗重跑兩次,一共執行兩次,通過分散式去測試,如果在cmd中寫的話,命令會很長
pytest -v --rerun=2 --count=2 --html=report.html --self-contained-html -n=auto
每次都這樣敲不太現實,addopts就可以完美解決這個問題
[pytest] # mark markers = weibo: this is weibo page toutiao: toutiao xinlang: xinlang xfail_strict = True # 命令列引數 addopts = -v --reruns=1 --count=2 --html=reports.html --self-contained-html -n=auto
加了addopts之後,我們在cmd中只需要敲pytest就可以生效了!!
log_cli
作用:控制檯實時輸出日誌
格式:log_cli=True 或False(預設),或者log_cli=1 或 0
log_cli=0的執行結果
log_cli=1的執行結果
結論
很明顯,加了log_cli=1之後,可以清晰看到哪個package下的哪個module下的哪個測試用例是否passed還是failed;
所以平時測試程式碼是否有問題的情況下推薦加!!!但如果拿去批量跑測試用例的話不建議加,誰知道會不會影響執行效能呢?
norecursedirs
作用:pytest 收集測試用例時,會遞迴遍歷所有子目錄,包括某些你明知道沒必要遍歷的目錄,遇到這種情況,可以使用 norecursedirs 引數簡化 pytest 的搜尋工作【還是挺有用的!!!】
預設設定: norecursedirs = .* build dist CVS _darcs {arch} *.egg
正確寫法:多個路徑用空格隔開
[pytest] norecursedirs = .* build dist CVS _darcs {arch} *.egg venv src resources log report util
更改測試用例收集規則
pytest預設的測試用例收集規則
- 檔名以 test_*.py 檔案和 *_test.py
- 以 test_ 開頭的函式
- 以 Test 開頭的類,不能包含 __init__ 方法
- 以 test_ 開頭的類裡面的方法
我們是可以修改或者新增這個用例收集規則的;當然啦,是建議在原有的規則上新增的,如下配置
[pytest] python_files = test_* *_test test* python_classes = Test* test* python_functions = test_* test*
&nbs