Pytest权威教程-13skip及xfail: 处理不能成功的测试用例

雨点打透心脏的1/2处 2023-10-09 10:13 48阅读 0赞

## skip及xfail: 处理不能成功的测试用例 ##

你可以标记无法在某些平台上运行的测试用例或你希望失败的测试用例,以便pytest可以相应地处理它们并提供测试会话的摘要,同时保持测试套件为*通过状态*。

一个**Skip**意味着你希望如果某些条件得到满足你的测试才执行,否则pytest应该完全跳过运行该用例。常见示例是在非Windows平台上跳过仅限Windows的测试用例,或者跳过依赖于当前不可用的外部资源的测试用例(例如数据库)。

一个**xfail**意味着已知测试失败并标记原因。一个常见的例子是对尚未实现的函数的测试,或者尚未修复的错误。当测试通过时尽管预计会失败(标记为`pytest.mark.xfail`),但它在\*并将在测试摘要及报告中显示为**xpass**.

`pytest`分别计算并列出*skip*和*xfail*测试。默认情况下不显示有关skip/ xfailed测试的详细信息,以避免输出混乱。你可以使用该`-r`选项查看与测试进度中显示的“短”字母对应的详细信息：

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

`-r`可以通过运行找到有关该选项的更多详细信息。`pytest-h`

(请参阅\[如何更改命令行选项默认值)

### 跳过测试用例 ###

版本2.9中的新函数。

跳过测试用例的最简单方法是使用`skip`装饰器标记它,可以传递一个可选的`reason`：

@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 sys
    import pytest
    
    if not sys.platform.startswith("win"):
        pytest.skip("skipping windows-only tests",allow_module_level=True)

**参考**: pytest.mark.skip

#### `skipif` ####

2.0版中的新函数。

如果你希望有条件地跳过某些内容,则可以使用`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():
        ...

你可以导入mark标记并在另一个测试模块中重复使用它：

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

对于较大的测试套件,通常最好有一个文件来定义标记,然后在整个测试套件中一致地应用这些标记。

或者,你可以使用\[条件字符串而不是布尔值,但它们不能在模块之间轻松共享,因此主要出于向后兼容性原因支持它们。

**参考**: pytest.mark.skipif

#### 跳过类或模块的所有测试用例 ####

你可以`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`,则此标记将为该类的每个测试用例生成跳过结果。

如果要跳过模块的所有测试用例,可以`pytestmark`在全局级别使用该名称：

# test_module.py
    pytestmark = pytest.mark.skipif(...)

如果将多个`skipif`装饰器应用于测试用例,则如果任何跳过条件为真,则将跳过该装饰器。

#### 跳过文件或目录 ####

有时你可能需要跳过整个文件或目录,例如,如果测试依赖于Python版本特定的函数或包含你不希望运行pytest的代码。在这种情况下,你必须从集合中排除文件和目录。有关更多信息,请参阅\[自定义测试集合。

#### 跳过缺少的导入依赖关系 ####

你可以在模块级别或测试或测试setup方法中使用以下帮助程序：

docutils = pytest.importorskip("docutils")

如果`docutils`无法在此处导入,则会导致测试跳过结果。你还可以根据库的版本号跳过：

docutils = pytest.importorskip("docutils",minversion="0.3")

将从指定模块的`__version__`属性中读取版本。

#### 摘要 ####

以下是如何在不同情况下跳过模块中的测试用例的快速指南：

1.  无条件地跳过模块中的所有测试用例如:

pytestmark = pytest.mark.skip("all tests still WIP")

1.  根据某些条件跳过模块中的所有测试用例如:

pytestmark = pytest.mark.skipif(sys.platform == "win32",reason="tests for linux only")

1.  如果缺少某些导入,则跳过模块中的所有测试用例如:

pexpect = pytest.importorskip("pexpect")

### XFail：将测试函数标记为预期失败 ###

你可以使用`xfail`标记指示你希望测试失败：

@pytest.mark.xfail
    def test_function():
        ...

将运行此测试,但在失败时不会报告回溯。相反,终端报告会将其列在“预期失败”(`XFAIL`)或“意外传递”(`XPASS`)部分中。

或者,你也可以`XFAIL`在测试或设置函数中强制标记测试：

def test_function():
        if not valid_config():
            pytest.xfail("failing configuration (but should work)")

这将无条件地制作```test_function``XFAIL```。请注意,`pytest.xfail`调用后不会执行其他代码,与标记不同。那是因为它是通过引发已知异常在内部实现的。

**参考**: pytest.mark.xfail

#### `strict`参数 ####

版本2.9中的新函数。

双方`XFAIL`并`XPASS`除非不失败的测试套件,`strict`只有关键字的参数作为传递`True`：

@pytest.mark.xfail(strict=True)
    def test_function():
        ...

这将导致\`XPASS(“意外通过”)此测试的结果导致测试套件失败。

你可以`strict`使用`xfail_strict`ini选项更改参数的默认值：

[pytest]
    xfail_strict=true

#### reason参数 ####

与skipif一样,你也可以在特定平台上标记你对失败的期望：

@pytest.mark.skipif(3,6),reason="python3.6 api changes")
    def test_function():
        ...

#### raises参数 ####

如果你想更具体地说明测试失败的原因,可以在`raises`参数中指定单个异常或异常元组。

@pytest.mark.xfail(raises=RuntimeError)
    def test_function():
        ...

然后,如果测试失败并且没有提到的例外,那么测试将被报告为常规失败`raises`。

#### run参数 ####

如果测试应标记为xfail并且如此报告但不应该执行,请使用以下`run`参数`False`：

@pytest.mark.xfail(run=False)
    def test_function():
        ...

这对于崩溃解释器的xfailing测试特别有用,应该稍后进行调查。

#### 忽略xfail ####

通过在命令行上指定：

pytest --runxfail

你可以强制运行并报告`xfail`标记的测试,就像它根本没有标记一样。这也导致`pytest.xfail`没有效果。

#### 示例 ####

这是一个简单的测试文件,有几个使用方法：

import pytest
    
    xfail = pytest.mark.xfail
    
    @xfail
    def test_hello():
        assert 0
    
    @xfail(run=False)
    def test_hello2():
        assert 0
    
    @xfail("hasattr(os,'sep')")
    def test_hello3():
        assert 0
    
    @xfail(reason="bug 110")
    def test_hello4():
        assert 0
    
    @xfail('pytest.__version__[0] != "17"')
    def test_hello5():
        assert 0
    
    def test_hello6():
        pytest.xfail("reason")
    
    @xfail(raises=IndexError)
    def test_hello7():
        x = []
        x[1] = 1

使用report-on-xfail选项运行它会提供以下输出：

example $ pytest -rx xfail_demo.py
    =========================== test session starts ============================
    platform linux -- Python 3.x.y,pytest-4.x.y,py-1.x.y,pluggy-0.x.y
    cachedir: $PYTHON_PREFIX/.pytest_cache
    rootdir: $REGENDOC_TMPDIR/example
    collected 7 items
    
    xfail_demo.py xxxxxxx                                                [100%]
    ========================= short test summary info ==========================
    XFAIL xfail_demo.py::test_hello
    XFAIL xfail_demo.py::test_hello2
      reason: [NOTRUN]
    XFAIL xfail_demo.py::test_hello3
      condition: hasattr(os,'sep')
    XFAIL xfail_demo.py::test_hello4
      bug 110
    XFAIL xfail_demo.py::test_hello5
      condition: pytest.__version__[0] != "17"
    XFAIL xfail_demo.py::test_hello6
      reason: reason
    XFAIL xfail_demo.py::test_hello7
    
    ======================== 7 xfailed in 0.12 seconds =========================

### skip/xfail参数设置 ###

使用参数化时,可以将skip和xfail等标记应用于各个测试实例如:

import pytest
    
    @pytest.mark.parametrize(
        ("n","expected"),
        [
            (1,2),
            pytest.param(1,0,marks=pytest.mark.xfail),
            pytest.param(1,3,marks=pytest.mark.xfail(reason="some bug")),
            (2,3),
            (3,4),
            (4,5),
            pytest.param(
                10,11,marks=pytest.mark.skipif(sys.version_info >= (3,0),reason="py2k")
            ),
        ],
    )
    def test_increment(n,expected):
        assert n + 1 == expected

转载于:https://www.cnblogs.com/superhin/p/11477606.html