Python测试框架之pytest（一）

忘是亡心i 2023-01-08 03:24 179阅读 0赞

pytest是一个非常成熟的全功能的python测试框架，主要有以下几个特点：

原文地址：https://www.cnblogs.com/wxcx/p/13709570.html

简单灵活，容易上手  
支持参数化  
能够支持简单的单元测试和复杂的功能测试，还可以用来做selenium/appium等自动化测试，接口自动化测试（pytest+request）  
pytest具有很多第三方插件，并且可以自定义扩展，比较好用的如pytest-selenium（集成selenium）、pytest-html（完美html测试报告生成）、pytest-rerunfailures（失败case重复执行）、pytest-xdist（多CPU分发）等  
测试用例的skip和xfail处理  
可以很好的和Jenkins集成  
report框架----allure 也支持了pytest

加油吧，测试人！路就在脚下，成功就在明天！

未来的你肯定会感谢现在拼命的自己！

给大家推荐一个软件测试技术交流群：810119819 群友福利免费领取

愿你我相遇，皆有所获！ 欢迎关注微信公众号：程序员阿沐

1.免费领取一份216页软件测试工程师面试宝典文档资料。

2.软件测试学习路线以及相对应的视频学习教程免费分享！

## 1.Pytest安装 ##

安装

pip install -U pytest

## 2.验证安装 ##

pytest --version #会展示当前自己安装的版本

![在这里插入图片描述][20210118194209110.png]

## 3.pytest文档 ##

官方文档：https://docs.pytest.org/en/latest/contents.html

在pytest框架中，有如下约束：

所有的单测文件名都需要满足test\_*.py格式或*\_test.py格式。  
在单测文件中，测试类以Test开头，并且不能带有 init 方法(注意：定义class时，需要以T开头，不然pytest是不会去运行该class的)  
在单测类中，可以包含一个或多个test\_开头的函数。  
此时，在执行pytest命令时，会自动从当前目录及子目录中寻找符合上述约束的测试函数来执行。

## 4. Pytest运行方式 ##

# file_name: test_abc.py
    import pytest # 引入pytest包
    def test_a(): # test开头的测试函数
        print("------->test_a")
        assert 1 # 断言成功
    def test_b():
        print("------->test_b")
        assert 0 # 断言失败
    if __name__ == '__main__':
           pytest.main(["-s","test_abc.py"]) # 调用pytest的main函数执行测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70]  
**测试类主函数**

pytest.main(["-s","test_abc.py"])
    
    通过python代码执行 pytest.main()
    1.直接执行pytest.main() 【自动查找当前目录下，以test_开头的文件或者以_test结尾的py文件】
    2.设置pytest的执行参数 pytest.main(['--html=./report.html','test_login.py'])【执行test_login.py文件，并生成html格式的报告】
    main()括号内可传入执行参数和插件参数，通过[]进行分割，[]内的多个参数通过‘逗号,’进行分割
    运行目录及子包下的所有用例  pytest.main(['目录名'])
    运行指定模块所有用例  pytest.main(['test_reg.py'])
    运行指定模块指定类指定用例  pytest.main(['test_reg.py::TestClass::test_method'])  冒号分割
     
          
    -m=xxx: 运行打标签的用例
    -reruns=xxx，失败重新运行
    -q: 安静模式, 不输出环境信息
    -v: 丰富信息模式, 输出更详细的用例执行信息
    -s: 显示程序中的print/logging输出
    --resultlog=./log.txt 生成log
    --junitxml=./log.xml 生成xml报告

**命令行模式**

pytest 文件路径/测试文件名
    例如：pytest ./test_abc.py

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 1]  
或者直接输入pytest也可以执行

## 5.Pytest Exit Code 含义清单 ##

Exit code 0 所有用例执行完毕，全部通过  
Exit code 1 所有用例执行完毕，存在Failed的测试用例  
Exit code 2 用户中断了测试的执行  
Exit code 3 测试执行过程发生了内部错误  
Exit code 4 pytest 命令行使用错误  
Exit code 5 未采集到可用测试用例文件

## 6. 如何获取帮助信息 ##

查看pytest版本

pytest --version

显示可用的内置函数参数

pytest --help

## 7.控制测试用例执行 ##

在第N个用例失败后，结束测试执行

pytest -x  #第01次失败就停止测试
    pytest --maxfail=2   #出现2个失败就终止测试
    
    
    # file_name: test_abc.py
    import pytest # 引入pytest包
    def test_a(): # test开头的测试函数
         print("------->test_a")
         assert 1 # 断言成功
    def test_b():
         print("------->test_b")
         assert 0 # 断言失败
    def test_c():
        print("------->test_c")
        assert 0  # 断言失败
    def test_d():
        print("------->test_d")
        assert 0  # 断言失败
    if __name__ == '__main__':
            pytest.main(["-s","test_abc.py"]) # 调用pytest的main函数执行测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 3]  
通过node id指定测试用例

node id 由模块文件名，分隔符，类名，方法名，参数构成

运行模块中的指定用例

pytest test_mod.py::test_func：<br>pytest test_abc.py::test_a

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 4]  
运行模块中的指定方法

pytest test\_mod.py::TestClass::test\_method :

pytest test_abc.py::Test_Class::test_c
    
    import pytest
    def test_a():
        assert 1
    def test_b():
        assert 0
    class Test_Class():
        def test_c(self):
            assert 1
    if __name__ == '__main__':
            pytest.main(["-s","test_abc.py"])

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 5]  
　通过标记表达式执行

pytest -m slow

这条命令会执行被装饰器 @pytest.mark.slow 装饰的所有测试用例

通过包执行测试

pytest --pyargs pkg.testing

这条命令会自动导入包 pkg.testing，并使用该包所在的目录，执行下面的用例。

## 8.多进程运行cases ##

当cases量很多时，运行时间也会变的很长，如果想缩短脚本运行的时长，就可以用多进程来运行。

安装pytest-xdist：

pip install -U pytest-xdist

运行模式：

pytest test_se.py -n NUM

其中NUM填写并发的进程数。

## 9.重试运行cases ##

在做接口测试时，有事会遇到503或短时的网络波动，导致case运行失败，而这并非是我们期望的结果，此时可以就可以通过重试运行cases的方式来解决。

安装pytest-rerunfailures：

pip install -U pytest-rerunfailures

运行模式：

pytest test_se.py --reruns NUM

NUM填写重试的次数。

## 10.显示print内容 ##

在运行测试脚本时，为了调试或打印一些内容，我们会在代码中加一些print内容，但是在运行pytest时，这些内容不会显示出来。如果带上-s，就可以显示了。

运行模式：

pytest test_se.py -s

另外，pytest的多种运行模式是可以叠加执行的，比如说，你想同时运行4个进程，又想打印出print的内容。可以用：

pytest test_se.py -s -n 4

## 11，pytest参数 ##

**1、-K EXPRESSION**

执行某个关键字的用例  
用例要匹配给出的表达式；使用python的语法，匹配的范围是文件名、类名、函数名为变量，用and来区分

**2、–maxfail=num**

当错误个数到达给定数时，退出测试，这里就不列举实例了，结果与-x类似

**3、-m MARKEXPR**

只能运行有相应标识的测试用例，使用这个参数，测试用例要使用@pytest.mark.marker修饰

**4、 -v, --verbose**

详细结果

**5、-q, --quiet**

极简结果显示，简化控制台的输出，可以看出输出信息和之前不添加-q不信息不一样， 下图中有两个…点代替了pass结果

**6、-s**

输入我们用例中的调式信息，比如print的打印信息等，我们在用例中加上一句 print(driver.title)，我们再运行一下我们的用例看看，调试信息输出

**7、-V**

可以输出用例更加详细的执行信息，比如用例所在的文件及用例名称等

**8、–junit-xml=path**

输出xml文件格式，在与jenkins做集成时使用

**9、 --result-log=path**

将最后的结果保存到本地文件中

注意：标黄的是经常使用的

加油吧，测试人！路就在脚下，成功就在明天！

未来的你肯定会感谢现在拼命的自己！

给大家推荐一个软件测试技术交流群：810119819 群友福利免费领取

愿你我相遇，皆有所获！ 欢迎关注微信公众号：程序员阿沐

1.免费领取一份216页软件测试工程师面试宝典文档资料。

2.软件测试学习路线以及相对应的视频学习教程免费分享！

[20210118194209110.png]: /images/20221119/4ddcc1b6b88f4eddad8da320defeded5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70]: /images/20221119/856c3514c9134a5fbd963bcbaf178dc6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 1]: /images/20221119/c57ef55083434a8fb7bc811af5310162.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 2]: /images/20221119/7ff88e2b8ea1448aabb26a2ba8e124da.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20210118194452627.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210118194509743.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20210118194531548.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDM0MzE4,size_16,color_FFFFFF,t_70