Skip and xfail: dealing with tests that cannot succeed

pytest

pytest -rxXs
# show extra info on xfailed, xpassed, and skipped tests

Skiping test functions

• 方式一： 直接使用skip decorator

@pytest.mark.skip(reason="no way of currently testing this")
def test_the_unknown():
...

• 方式二： 在测试函数中使用pytest.skip()函数

def test_function():
    if not valid_config():
        pytest.skip("unsupported configuration")

• 如果想要跳过整个model的测试，则可以使用：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)

skipif

在某些条件下才进行skip， 那么则使用skipif

• 在单个test case中

import sys
@pytest.mark.skipif(sys.version_info < (3,6), reason="requires python3.6 or higher")
    def test_function():
        ...

如果条件为真， 则该test function将会被skip。

• 在一个 test 文件中

import mymodule
minversion = pytest.mark.skipif(mymodule.__versioninfo__ < (1,1), reason="at least mymodule-1.1 required")
@minversion
def test_function():
    ...

• 你可以通过导入 the marker 来在另一个test module中使用它

# test_myothermodule.py
from test_mymodule import minversion
@minversion
def test_anotherfunction():
    ...

Skip all test functions of a class or module

• classes：

@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"

如果条件为真， the marker 将跳过该class中的所有test 方法