Pytest之测试命名规则的使用

背景：

pytest以特定规则搜索测试用例，所以测试用例文件、测试类以及类中的方法、测试函数这些命名都必须符合规则，才能被pytest搜索到并加入测试运行队列中。

默认搜索规则：

如果pytest命令行有指定目录，则从该目录中开始查找测试用例文件，如果没有指定，则从当前运行目录开始查找文件。注意，该查找是递归查找，子目录中的文件也会被查找到。
并不是能够查找到目录下的所有文件，只有符合命名规则的文件才会被查找。默认规则是以test_开头或者以_test结尾的.py文件。
在测试文件中查找Test开头的类，以及类中以test_开头的方法，查找测试文件中test_开头的函数。

测试用例默认命名规则

除非pytest命令指定到测试用例文件，否则测试用例文件命名应该以 test_开头或者以_test结尾。
测试函数命名，测试类的方法命名应该以test_开头。
测试类命名应当以Test开头。

tips: 测试类的不应该有构造函数。

笔者习惯装测试用例的文件夹，测试用例文件，测试函数，类中的测试方法都以test_开头。建议保持一种统一的风格。

示例：

# func.pydef add(a,b): return a+b# ./test_case/test_func.pyimport pytestfrom func import *class TestFunc: #def __init__(self):  #self.a = 1 def test_add_by_class(self):  assert add(2,3) == 5def test_add_by_func(): assert add(4,6) == 10'''# stdout:============================= test session starts =============================platform win32 -- python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1rootdir: D:/python3.7/project/pytestplugins: allure-pytest-2.8.9, rerunfailures-8.0collected 2 itemstest_case/test_func.py ..                                                [100%]============================== 2 passed in 0.04s ==============================[Finished in 1.3s]######################################################################'''

测试结果中，test_case/test_func.py … 。两个点号代表两个测试用例。

错误示范，当测试类有构造函数时：

# func.pydef add(a,b): return a+b# ./test_case/test_func.pyimport pytestfrom func import *class TestFunc: def __init__(self):  self.a = 1 def test_add_by_class(self):  assert add(2,3) == 5def test_add_by_func(): assert add(4,6) == 10'''# stdout:============================= test session starts =============================platform win32 -- python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1rootdir: D:/python3.7/project/pytestplugins: allure-pytest-2.8.9, rerunfailures-8.0collected 1 itemtest_case/test_func.py .                                                 [100%]============================== warnings summary ===============================test_case/test_func.py:4  D:/python3.7/project/pytest/test_case/test_func.py:4: PytestCollectionWarning: cannot collect test class 'TestFunc' because it has a __init__ constructor (from: test_case/test_func.py)    class TestFunc:-- Docs: https://docs.pytest.org/en/latest/warnings.html======================== 1 passed, 1 warning in 0.04s =========================[Finished in 1.4s]######################################################################'''

会报错，pytest只能找到test_开头的函数，但是不能找到Test开头的含有构造函数的测试类。

自定义测试用例命名规则

如果因为某种需要，需要使用其他命名规则命名的测试文件、测试函数、测试类以及测试类的方法，可以通过pytest.ini配置文件做到。

在测试系统的顶层目录创建pytest.ini文件，在pytest.ini文件中写入如下配置：

[pytest]# 更改测试文件命名规则python_files = HG*# 更改测试类命名规则python_classes = HG*# 更嗨测试函数命名规则python_functions = HG*

示例：

# func.pydef add(a,b): return a+b# ./test_case/HG_func.pyimport pytestfrom func import *class HGFunc: #def __init__(self):  #self.a = 1 def HG_add_by_class(self):  assert add(2,3) == 5def HG_add_by_func(): assert add(4,6) == 10'''stdout:============================= test session starts =============================platform win32 -- python 3.7.0, pytest-5.3.4, py-1.8.1, pluggy-0.13.1 -- D:/python3.7/python.execachedir: .pytest_cacherootdir: D:/python3.7/project/pytest, inifile: pytest.iniplugins: allure-pytest-2.8.9, rerunfailures-8.0collecting ... collected 2 itemstest_case/HG_func.py::HGFunc::HG_add_by_class PASSED                     [ 50%]test_case/HG_func.py::HG_add_by_func PASSED                              [100%]============================== 2 passed in 0.03s ==============================[Finished in 1.3s]'''

Tips：

pytest.ini是可以改变pytest运行方式的配置文件，但是正常情况下，测试系统里根本不需要存在pytest.ini文件，我们使用默认的运行方式即可工作。
pytest.ini还有许多其他个性化配置，当有需要时，可以在自动化测试项目的顶层目录里创建pytest.ini文件，添加配置，达到个性化运行的目的。

到此这篇关于Pytest之测试命名规则的使用的文章就介绍到这了,更多相关Pytest 命名规则内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

最后更新于 2021-11-08 08:13:10 并被添加「」标签，已有位童鞋阅读过。

本站使用「署名 4.0 国际」创作共享协议，可自由转载、引用，但需署名作者且注明文章出处