1. 前言
pytest.mark.skip可以標記無法在某些平臺上運行的測試功能,或者您希望失敗的測試功能
skip意味著只有在滿足某些條件時才希望測試通過,否則pytest應該跳過運行測試。 常見示例是在非Windows平臺上跳過僅限Windows的測試,或跳過測試依賴于當前不可用的外部資源(例如數據庫)。
xfail意味著您希望測試由于某種原因而失敗。 一個常見的例子是對功能的測試尚未實施,或尚未修復的錯誤。 當測試通過時盡管預計會失敗(標有pytest.mark.xfail),它是一個xpass,將在測試摘要中報告。
pytest計數并分別列出skip和xfail測試。 未顯示有關跳過/ xfailed測試的詳細信息默認情況下,以避免混亂輸出。 您可以使用-r選項查看與“short”字母對應的詳細信息顯示在測試進度中
pytest -rxXs # show extra info on xfailed, xpassed, and skipped tests
有關-r選項的更多詳細信息,請運行pytest -h
2. skip
跳過測試函數的最簡單方法是使用跳過裝飾器標記它,可以傳遞一個可選的原因
@pytest.mark.skip(reason="no way of currently testing this")
def test_the_unknown():
...
或者,也可以通過調用來在測試執行或設置期間強制跳過pytest.skip(reason)
功能:
def test_function():
if not valid_config():
pytest.skip("unsupported configuration")
也可以使用pytest.skip(reason,allow_module_level = True)
跳過整個模塊級別:
import pytest
if not pytest.config.getoption("--custom-flag"):
pytest.skip("--custom-flag is missing, skipping tests", allow_module_level=True)
3. skipif
如果您希望有條件地跳過某些內容,則可以使用skipif代替。 這是標記測試的示例在Python3.6之前的解釋器上運行時要跳過的函數
import sys
@pytest.mark.skipif(sys.version_info < (3,6),
reason="requires python3.6 or higher")
def test_function():
...
如果條件在收集期間評估為True,則將跳過測試函數,具有指定的原因使用-rs時出現在摘要中。
您可以在模塊之間共享skipif標記。參考以下案例
# content of test_mymodule.py
import mymodule
minversion = pytest.mark.skipif(mymodule.__versioninfo__ < (1,1),
reason="at least mymodule-1.1 required")
@minversion
def test_function():
...
您可以導入標記并在另一個測試模塊中重復使用它:
# test_myothermodule.py
from test_mymodule import minversion
@minversion
def test_anotherfunction():
...
對于較大的測試套件,通常最好有一個文件來定義標記,然后一致適用于整個測試套件。
或者,您可以使用條件字符串而不是布爾值,但它們之間不能輕易共享它們支持它們主要是出于向后兼容的原因
4. skip類或模塊
您可以在類上使用skipif標記(與任何其他標記一樣):
@pytest.mark.skipif(sys.platform == 'win32',
reason="does not run on windows")
class TestPosixCalls(object):
def test_function(self):
"will not be setup or run under 'win32' platform"
如果條件為True,則此標記將為該類的每個測試方法生成跳過結果
警告:強烈建議不要在使用繼承的類上使用skipif。 pytest中的一個已知錯誤標記可能會導致超類中的意外行為。
如果要跳過模塊的所有測試功能,可以在全局級別使用pytestmark名稱
# test_module.py
pytestmark = pytest.mark.skipif(...)
如果將多個skipif裝飾器應用于測試函數,則如果任何跳過條件為真,則將跳過它
5. skip缺少導入依賴項
您可以在模塊級別或測試或測試設置功能中使用以下幫助程序
docutils = pytest.importorskip("docutils")
如果無法在此處導入docutils,則會導致測試跳過結果。 你也可以跳過庫的版本號
docutils = pytest.importorskip("docutils", minversion="0.3")
將從指定模塊的version屬性中讀取版本。
6. 常用
1.無條件地跳過模塊中的所有測試:
pytestmark = pytest.mark.skip(“all tests still WIP”)
2.根據某些條件跳過模塊中的所有測試
?→ only”
3.如果缺少某些導入,則跳過模塊中的所有測試
pexpect = pytest.importorskip(“pexpect”)
- 導入 package,使用其文件系統位置來查找和執行用例。執行 pkg 目錄下的所有用例:
py.test --pyargs pkg
- 運行指定模塊中的某個用例,如運行 test_mod.py 模塊中的 test_func 測試函數:
pytest test_mod.py::test_func
- 運行某個類下的某個用例,如運行 TestClass 類下的 test_method 測試方法:
pytest test_mod.py::TestClass::test_method