能够经过命令行查看全部marker,包括内置和自定义的python
pytest --markers
内置marker本文先讲usefixtures 、filterwarnings 、skip 、skipif 、xfail这5个。参数化的marker我会写在《pytest参数化》中,hook的marker我会写在《pytest hook》中,插件的marker(pytest-ordering、allure等)我会写在《pytest插件》中。当前只需知道有以上这些分类的marker便可,更多内容请关注后续文章。web
若是咱们只想把fixture注入到test中,test不直接访问fixture的时候,就须要用到usefixtures。shell
示例,test须要一个临时目录,可是并不须要知道这个目录具体路径在哪windows
# content of conftest.py import os import shutil import tempfile import pytest @pytest.fixture def cleandir(): old_cwd = os.getcwd() newpath = tempfile.mkdtemp() os.chdir(newpath) yield os.chdir(old_cwd) shutil.rmtree(newpath)
# content of test_setenv.py import os import pytest @pytest.mark.usefixtures("cleandir") class TestDirectoryInit: def test_cwd_starts_empty(self): assert os.listdir(os.getcwd()) == [] with open("myfile", "w") as f: f.write("hello") def test_cwd_again_starts_empty(self): assert os.listdir(os.getcwd()) == []
TestDirectoryInit的测试方法须要一个临时目录做为当前工做目录,在类上添加@pytest.mark.usefixtures("cleandir")
,类的方法不加fixture也能有"cleandir"的效果。api
usefixtures能够添加多个fixtureapp
@pytest.mark.usefixtures("cleandir", "anotherfixture")
usefixtures能够用在pytestmark,做用域是定义所在module的全部tests函数
pytestmark = pytest.mark.usefixtures("cleandir")
usefixtures也能够用在pytest.ini,做用域是整个项目的全部tests测试
# content of pytest.ini [pytest] usefixtures = cleandir
不过须要注意的是fixture函数自己是不能用usefixtures的,若是想要嵌套fixture,只能经过在fixture修饰的函数中,添加参数这种方式。ui
过滤警告信息。this
示例,api_v1()抛出了“api v1”的警告,test_one()函数使用filterwarnings过滤掉了
import warnings def api_v1(): warnings.warn(UserWarning("api v1, should use functions from v2")) return 1 @pytest.mark.filterwarnings("ignore:api v1") def test_one(): assert api_v1() == 1
一样能够添加到pytestmark和pytest.ini中。
跳过,不测试。
示例,skip须要添加reason哦
@pytest.mark.skip(reason="no way of currently testing this") def test_the_unknown(): ...
不过,更实用的方式是调用pytest.skip(reason)函数,而不是用mark,这样就能够用if判断跳不跳
def test_function(): if not valid_config(): pytest.skip("unsupported configuration")
allow_module_level 能够跳过整个module
import sys import pytest if not sys.platform.startswith("win"): pytest.skip("skipping windows-only tests", allow_module_level=True)
if判断跳不跳,还能够用skipif。
示例,若是Python版本小于3.6就跳过测试
import sys @pytest.mark.skipif(sys.version_info < (3, 6), reason="requires python3.6 or higher") def test_function(): ...
若是想在summary中看到reason,须要添加-rs参数。
能够把skipif赋值给变量,而后直接引用变量,或者把变量import到其余module中使用
# 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(): ...
skipif添加到class上,会跳过类中全部方法。
可使用pytestmark跳过module内全部test
# test_module.py pytestmark = pytest.mark.skipif(...)
若是function有多个skipif做用,只要有一个为True,就会跳过。
明知失败,依然前行!很差意思跑偏了。xfail就是expected fail,预期失败
@pytest.mark.xfail def test_function(): ...
执行后summary不会统计为"failed",会单独列出来。若是结果失败了,“expected to fail” (XFAIL);若是结果成功了,“unexpectedly passing” (XPASS)。可是整个执行结果是”Tests passed“。
if判断
def test_function(): if not valid_config(): pytest.xfail("failing configuration (but should work)")
值得注意的是,marker会继续执行全部test代码,pytest.xfail()函数会抛出异常,中断执行后续代码
添加condition,判断条件
@pytest.mark.xfail(sys.platform == "win32", reason="bug in a 3rd party library") def test_function(): ...
添加reason,理由
@pytest.mark.xfail(reason="known parser issue") def test_function(): ...
添加raises,抛出异常/错误
@pytest.mark.xfail(raises=RuntimeError) def test_function(): ...
添加run,禁止运行
@pytest.mark.xfail(run=False) def test_function(): ...
添加strict,严格模式,即便xpass也会强制失败,summary中有输出信息”[XPASS(strict)] “,测试结果为”Tests failed“。
@pytest.mark.xfail(strict=True) def test_function(): ...
断言成功也强制失败,确实够强势的!
能够在ini文件中定义全局strict
[pytest] xfail_strict=true
在命令行添加--runxfail,忽略xfail marker,至关于没有添加这个标记的效果,该成功就成功,该失败就失败,再强势也不虚,哈哈,恶灵退散。
pytest --runxfail
pytest --runxfail
再强势也不虚,恶灵退散,哈哈。
经过注解自定义marker
# content of test_server.py import pytest @pytest.mark.webtest def test_send_http(): pass # perform some webtest test for your app def test_something_quick(): pass def test_another(): pass class TestClass: def test_method(self): pass
在命令行经过-m
指定运行mark打标的test
$ pytest -v -m webtest
也能够反选
$ pytest -v -m "not webtest"
可是,这样定义的marker是未注册的!在执行后会警告,PytestUnknownMarkWarning。若是添加了命令行参数--strict-markers
,未注册的marker会报错。
能够在pytest.ini文件中注册,冒号后面的全部代码都是marker说明,包括换行
[pytest] markers = slow: marks tests as slow (deselect with '-m "not slow"') serial
更高级的,能够在pytest_configure hook函数中注册,这主要用在第三方插件
def pytest_configure(config): config.addinivalue_line( "markers", "env(name): mark test to run only on named environment" )
本文介绍了5个pytest内置的marker,接着介绍了如何自定义marker和注册marker。经过marker,可让咱们更灵活的执行用例。
参考资料
docs-pytest-org-en-stable