Python测试框架之pytest详解

前言

Python测试框架之前一直用的是unittest+HTMLTestRunner，听到有人说pytest很好用，所以这段时间就看了看pytest文档，在这里做个记录。

官方文档介绍：

Pytest is a framework that makes building simple and scalable tests easy. Tests are expressive and readable—no boilerplate code required. Get started in minutes with a small unit test or complex functional test for your application or library.

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

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

1.pytest安装

1.1安装

pip install -U pytest

1.2验证安装

pytest --version # 会展示当前已安装版本

1.3pytest文档

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

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

所有的单测文件名都需要满足test_*.py格式或*_test.py格式。

在单测文件中，测试类以Test开头，并且不能带有 init 方法(注意：定义class时，需要以T开头，不然pytest是不会去运行该class的)

在单测类中，可以包含一个或多个test_开头的函数。

此时，在执行pytest命令时，会自动从当前目录及子目录中寻找符合上述约束的测试函数来执行。

1.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函数执行测试

1.测试类主函数模式

pytest.main("-s test_abc.py")

2.命令行模式

pytest 文件路径／测试文件名

例如：pytest ./test_abc.py

1.5 Pytest Exit Code 含义清单

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

1.6 如何获取帮助信息

查看 pytest 版本

pytest --version

显示可用的内置函数参数

pytest --fixtures

通过命令行查看帮助信息及配置文件选项

pytest --help

1.7 控制测试用例执行

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

pytest -x # 第01次失败，就停止测试

pytest --maxfail=2 # 出现2个失败就终止测试

2.指定测试模块

pytest test_mod.py

3.指定测试目录

pytest testing/

4.通过关键字表达式过滤执行

pytest -k "MyClass and not method"

这条命令会匹配文件名、类名、方法名匹配表达式的用例，这里这条命令会运行 TestMyClass.test_something， 不会执行 TestMyClass.test_method_simple

5.通过 node id 指定测试用例

nodeid由模块文件名、分隔符、类名、方法名、参数构成，举例如下：

运行模块中的指定用例

pytest test_mod.py::test_func

运行模块中的指定方法

ytest test_mod.py::TestClass::test_method

6.通过标记表达式执行

pytest -m slow

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

7.通过包执行测试

pytest --pyargs pkg.testing

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

1.8 多进程运行cases

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

安装pytest-xdist：

pip install -U pytest-xdist

运行模式：

pytest test_se.py -n NUM

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

1.9 重试运行cases

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

安装pytest-rerunfailures：

pip install -U pytest-rerunfailures

运行模式：

pytest test_se.py --reruns NUM

NUM填写重试的次数。

1.10 显示print内容

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

运行模式：

pytest test_se.py -s