前言
pytest默认执行用例是根据项目下的文件名称按ascii码去收集运行的;文件中的用例是从上往下按顺序执行的。
pytest_collection_modifyitems 这个函数顾名思义就是收集测试用例、改变用例的执行顺序的。
【严格意义上来说,我们在用例设计原则上用例就不要有依赖顺序,这样才能更好的体现出测试用例的意义。(测试用例的执行不需要按照顺序来执行,而是随即执行)】
1、Hook方法之 pytest_collection_modifyitems :
pytest_collection_modifyitems 是在用例收集完毕之后被调用,可以用来调整测试用例执行顺序;
它有三个参数,分别是:
session:会话对象;
config:配置对象;
items:用例对象列表;改变items里面用例的顺序就可以改变用例的执行顺序了
这三个参数分别有不同的作用,都可以拿来单独使用,修改用例执行顺序主要是使用 items 参数【用例执行之前,收集到的测试用例会以元素对象的方式存放在用例对象列表items中】
2、pytest_collection_modifyitems方法源码:
def pytest_collection_modifyitems(session, config, items):
""" called after collection has been performed, may filter or re-order
the items in-place.
:param _pytest.main.Session session: the pytest session object
:param _pytest.config.Config config: pytest config object
:param List[_pytest.nodes.Item] items: list of item objects
"""
一、针对单个测试.py文件修改测试用例执行顺序
首先准备三个测试用例:
import pytest
class TestDemoA:
def test_A_001(self):
pass
def test_A_002(self):
pass
def test_A_003(self):
pass
if __name__ == '__main__':
pytest.main(['-s'])
正常情况下pytest 会按照从上到下的顺序依次执行(模块级会先以模块名按ascii编码进行排序):
使用pytest_collection_modifyitems修改单个测试文件中的用例执行顺序
在 conftest.py 文件中 使用pytest_collection_modifyitems 钩子方法:
# conftest.py
# 在收集完测试用例后才会执行
def pytest_collection_modifyitems(items):
print('pytest 收集到的所有测试用例:\n',items)
if __name__ == '__main__':
pytest.main(['-s'])
可以看到控制台中打印出来了收集到的三个测试用例的对象,而且是在测试用例执行之前便已经收集;【先收集测试用例,然后执行测试用例】
在执行完 pytest_collection_modifyitems 之后才显示收集到了 3 个用例;
如果我们在 pytest_collection_modifyitems 中对用例进行调整,便会影响用例是否执行和执行顺序;
利用 items 获取收集到的用例名和用例节点:
# conftest.py
def pytest_collection_modifyitems(items):
print('pytest 收集到的所有测试用例:\n', items)
for item in items:
print('---' * 10)
print('用例名:', item.name)
print('用例节点:', item.nodeid)
if __name__ == '__main__':
pytest.main(['-s'])
运行结果:
修改用例执行顺序和剔除测试用例:
# conftest.py
def pytest_collection_modifyitems(items):
# 将用例名拿出来存入新列表new_items
new_items = []
for item in items:
new_items.append(item.name)
# 1. 删除 test_A_002 用例
# 获取 test_A_002 在新列表的索引
index_2 = new_items.index('test_A_002')
# 在老列表中删除这个索引
del items[index_2]
del new_items[index_2] # 新列表同步删除,和老列表保持同步
# 2. 调换 1 和 3 的顺序
# 获取 1 和 3 在新列表的索引
index_1 = new_items.index('test_A_001')
index_3 = new_items.index('test_A_003')
# 根据索引在老列表中调换位置
items[index_1], items[index_3] = items[index_3], items[index_1]
运行结果:
可以看到控制台输出的结果中,用例3和用例1的顺序调换了,用例2由于被删除所以没有执行;
代码写的比较粗糙,但是思路就是这样:想办法干涉 items列表中用例对象的排序;
二、针对多个测试.py文件
pytest默认执行顺序
先设计一个简单的 pytest 项目,有a和b两个包,分别在 test_a.py 和 test_b.py 写测试用例
conftest.py内容:
import pytest
def pytest_collection_modifyitems(session, items):
print("收集到的测试用例:%s"%items)
test_a.py内容:
def test_a_1():
print("测试用例a_1")
def test_a_2():
print("测试用例a_2")
test_b.py内容:
def test_b_2():
print("测试用例b_2")
def test_b_1():
print("测试用例b_1")
运行完成后可以看到收集到的测试用例【会在测试用例开始执行前收集】:
从结果可以看出运行的时候先按模块名称ascii码去收集,单个py文件里面的用例按从上到下写的顺序收集。
items用例排序
如果我想改变上面的用例执行顺序,以所有用例名称ascii码排序(测试方法名)。
先获取到收集的用例的名称,以用例名称排序就可以了。
def pytest_collection_modifyitems(session, items):
print(type(items))
print("收集到的测试用例:%s" % items)
# sort排序,根据用例名称item.name的ASCII码排序
items.sort(key=lambda x: x.name)
print("排序后的用例:%s" % items)
for item in items:
print("用例名:%s" % item.name)
重新执行后结果:
重新排序后就可以按用例的名称ascii码顺序执行了。
标签:items,pytest,collection,用例,测试用例,modifyitems From: https://www.cnblogs.com/guanqibuyu/p/16599632.html