Python测试框架之pytest详解

前言

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

官方文档介绍：

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安装

1.2验证安装

1.3pytest文档

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

1.4 Pytest运行方式

1.测试类主函数模式

2.命令行模式

例如：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 版本

显示可用的内置函数参数

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

1.7 控制测试用例执行

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

2.指定测试模块

3.指定测试目录

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

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

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

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

运行模块中的指定用例

运行模块中的指定方法

6.通过标记表达式执行

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

7.通过包执行测试

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

1.8 多进程运行cases

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

安装pytest-xdist：

运行模式：

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

1.9 重试运行cases

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

安装pytest-rerunfailures：

运行模式：

NUM填写重试的次数。

1.10 显示print内容

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

运行模式：

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

2.Pytest的setup和teardown函数

函数级别setup()／teardown()

运行于测试方法的始末，即:运行一次测试函数会运行一次setup和teardown

执行结果：

2.2.类级别

运行于测试类的始末，即:在一个测试内只运行一次setup_class和teardown_class，不关心测试类内有多少个测试函数。

代码示例：

3.Pytest配置文件

pytest的配置文件通常放在测试目录下，名称为pytest.ini，命令行运行时会使用该配置文件中的配置.

4 Pytest常用插件

插件列表网址：https://plugincompat.herokuapp.com

包含很多插件包，大家可依据工作的需求选择使用。

4.1 前置条件：

1.文件路径：

2.pyetst.ini配置文件内容：

4.2 Pytest测试报告

pytest-HTML是一个插件，pytest用于生成测试结果的HTML报告。兼容Python 2.7,3.6

安装方式：pip install pytest-html

通过命令行方式，生成xml/html格式的测试报告，存储于用户指定路径。插件名称：pytest-html

使用方法： 命令行格式：pytest --html=用户路径/report.html

示例：

5.pytest的高阶用法(一)

前置条件：

1.文件路径：

2.pyetst.ini配置文件内容：

5.1pytest之fixture

fixture修饰器来标记固定的工厂函数,在其他函数，模块，类或整个工程调用它时会被激活并优先执行,通常会被用于完成预置处理和重复操作。

5.2fixture第一个例子(通过参数引用)

示例：

5.3.fixture第二个例子(通过函数引用)

示例：

5.4.fixture第三个例子(默认设置为运行)

5.5.fixture第四个例子(设置作用域为function)

示例：

5.6.fixture第五个例子(设置作用域为class)

示例：

5.7.fixture第六个例子(返回值)

示例一:

示例二:

6.Pytest高阶用法(二)

前置条件：

1.文件路径：

2.pyetst.ini配置文件内容：

6.1.跳过测试函数

示例：

6.2 标记为预期失败函数

6.3 函数数据参数化

方便测试函数对测试属于的获取。

方法：

单个参数示例：

多个参数示例：

函数返回值类型示例：

6.4 修改 Python traceback 输出

6.5 执行失败的时候跳转到 PDB

执行用例的时候，跟参数 --pdb，这样失败的时候，每次遇到失败，会自动跳转到 PDB

6.6 设置断点

在用例脚本中加入如下python代码，pytest会自动关闭执行输出的抓取，这里，其他test脚本不会受到影响，带断点的test上一个test正常输出

6.7 获取用例执行性能数据

获取最慢的10个用例的执行耗时

6.8 生成 JUnitXML 格式的结果文件

这种格式的结果文件可以被Jenkins或其他CI工具解析

6.9禁用插件

例如，关闭 doctest 插件

6.10 从Python代码中调用pytest

6.11 测试脚本迁移后快速部署包含pytest的virtualenv

例如你从Gitlab仓库里clone了项目组的刀刀同学编写的测试脚本到你自己的电脑里，你想修改些东西，并调试，咋办？可以通过下面的操作快速创建 VirtualEnv

遇到的问题

问题：

pytest可以输出覆盖率的html报告

使用命令如下：

有可能遇到报错：

• (venv) zhangxiaofans-MacBook-Pro:mgap-mendel joe$ pytest --cov-report=html
• usage: pytest [options] [file_or_dir] [file_or_dir] [...]
• pytest: error: unrecognized arguments: --cov-report=html
• inifile: None
• rootdir: /Users/joe/workspace/platform/mgap-mendel/mgap-mendel

原因：

缺少pytest cov的包

解决方法