pytest系列——skip&skipif跳过测试用例
前言
在我们自动化测试过程中,经常会遇到功能阻塞、功能未实现、环境等一系列外部因素问题导致的一些用例执行不了,这时我们就可以用到跳过skip用例,如果我们注释掉或删除掉,后面还要进行恢复操作。
① pytest.mark.skip
装饰器可以标记无法在某些平台上运行的测试功能,或者希望失败的测试功能,使其跳过。
②skip意味着只有在满足某些条件时才希望测试通过,否则pytest应该跳过其运行其他测试。 常见示例是在非Windows平台上跳过仅限Windows的测试,或跳过测试依赖于当前不可用的外部资源(例如数据库)。
③xfail意味着您希望测试由于某种原因而失败。 一个常见的例子是对功能的测试尚未实施,或尚未修复的错误。 当测试通过时尽管预计会失败(标记 pytest.mark.xfail ),它是一个xpass,将在测试摘要中报告。
。 当测试通过时尽管预计会失败(标记pytest.mark.xfail
),它是一个xpass,将在测试摘要中报告。
④pytest计数并分别列出skip和xfail测试。 未显示有关跳过/ xfailed测试的详细信息默认情况下,以避免混乱输出。 可以使用-r
选项查看与short
字母对应的详细信息显示在测试进度中。
⑤有关-r选项的更多详细信息,请运行 pytest -h
⑥skip跳过成功的情况,标识为 s ============================= 2 skipped in 0.04s ==============================
总的来讲:skip和skipif允许你跳过不希望运行的测试。
skip
①跳过测试函数的最简单方法是使用跳过装饰器pytest.mark.skip
标记它,可以传递一个可选的跳过用例的原因,形参是reason
代码示例:
@pytest.mark.skip(reason="no way of currently testing this")
def test_the_unknown():
...
②也可以通过在测试方法执行期间跳过pytest.skip(reason=reason)
功能。【一般在测试方法中与 if
分支方法共同使用,表示在测试用例执行期间满足某条件从而跳过。(与skip标记不同的是,标记更像是一个烙印,打上后直接跳过)】
代码示例:【注意】此时的pytest.skip(reason=reason)
已经不再是一个装饰器,而是一个函数;此外需要注意的是,pytest.skip(reason=reason)
放置位置对测试用例的的执行至关重要。如果只放在一个测试用例中,则仅仅会跳过这一个测试用例。
def test_function():
if not valid_config():
pytest.skip("unsupported configuration")
③还可以使用 pytest.skip(reason=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
①如果希望有条件地跳过某些内容,则可以使用pytest.mark.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():
...
对于较大的测试套件,通常最好有一个专门的模块来定义标记,然后在测试用例模块导入并引用【这样做的好处:方便管理和查看测试用例的标记】;这种方法一致适用于整个测试套件。
skip类或模块
①在类上使用 skipif
标记。
示例:如果 pytest.mark.skipif
装饰器跳过条件为True,则此标记将为该类的每个测试方法生成跳过结果。
@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"
【注意】:强烈建议不要在使用继承的类上使用 skipif 标记。 pytest中的一个已知错误标记可能会导致超类中的意外行为。
②如果要跳过某个测试模块的所有测试方法,可以在全局级别使用 pytestmark
名称。
示例:
# test_module.py
pytestmark = pytest.mark.skipif(...)
skip文件或目录
有时可能需要跳过整个文件或目录:例如,如果测试依赖于特定于Python的版本功能或包含您不希望pytest运行的代码。
小技巧
这是一个快速指南,介绍如何在不同情况下跳过模块中的测试。
1、无条件地跳过模块中的所有测试:
pytestmark = pytest.mark.skip("all tests still WIP")
2、根据某些条件跳过模块中的所有测试
pytestmark = pytest.mark.skipif(sys.platform == "win32", "tests for linux → only"
3、如果缺少某些导入,则跳过模块中的所有测试
pexpect = pytest.importorskip("pexpect")