Python 测试框架 pytest —— 生成测试报告
Pytest 执行过测试任务后我们需要查看整体测试情况，本文记录使用 pytest 生成测试报告的几种方法。
简介
- Pytest 生成测试报告有几种方法，本文以
mtutils库中的测试代码为例，分别尝试几种测试报告的使用
ResultLog
- pytest 自带测试报告输出功能
- 该功能在 pytest 6.1 以后的版本中被删除
使用方法
- 在 pytest 命令中加入参数
--resultlog = path-to-log.txt示例
pytest --resultlog=./log.txt test-dirpytest-HTML
- pytest-HTML 是一个 python 包，用于生成 pytest 测试结果的HTML报告
安装测试包
pip3 install pytest-html使用方法
- 在 pytest 命令中加入参数
--html=report.html示例
pytest .\tests --html=report.html- 在浏览器打开该文件
JunitXML
- 可以选择生成 XML 文件显示日志
使用方法
- 在 pytest 命令中加入参数
--junitxml=./log.xml 示例
pytest .\tests --junitxml=./log.xml - 得到 xml 文件
<?xml version="1.0" encoding="utf-8"?><testsuites><testsuite name="pytest" errors="0" failures="0" skipped="0" tests="4" time="1.132" timestamp="2022-06-16T10:48:47.656215" hostname="VVD"><testcase classname="tests.test_utils.test_utils" name="test_get_list_from_list" time="0.001" /><testcase classname="tests.test_utils.test_utils" name="test_segment_intersection" time="0.001" /><testcase classname="tests.test_utils.test_utils" name="test_concat_generator" time="0.002" /><testcase classname="tests.test_utils.test_utils" name="test_get_mac_address" time="0.002" /></testsuite></testsuites>- 在 wps 中打开
allure
- 是一款可以生成测试报告的工具
- 需要java 环境
- GitHub： https://github.com/allure-framework/allure2
配置 java 环境
- 下载 java jdk
- 安装 jdk 包
- 测试是否安装成功，执行
java --version返回java 版本表示 java 环境配置成功
C:\Users\Administrator>java --version
java 18.0.1.1 2022-04-22
Java(TM) SE Runtime Environment (build 18.0.1.1+2-6)
Java HotSpot(TM) 64-Bit Server VM (build 18.0.1.1+2-6, mixed mode, sharing)下载 allure
- 下载地址： https://github.com/allure-framework/allure2/releases
- 选择 zip 包下载并解压到一个目录
- 配置 bin 文件夹到系统环境变量
- 测试是否安装成功，在终端执行
allure --version正常返回 allure 版本表明配置成功
C:\Users\Administrator>allure --version
2.18.1安装 allure 包
pip install allure-pytest 使用方法
- 生成 allure 报告内容，在 pytest 命令中加入参数
--alluredir=reports-dir- 生成报告内容后，用 allure 命令解析并查看报告
allure serve reports-dir示例
- 生成 allure 测试报告到
reports/allure文件夹
pytest .\tests\ --alluredir=reports/allure- 显示 allure 报告
allure serve reports\allure- 报告效果
Coverage
- Coverage 包可以辅助 pytest 查看代码运行级别的覆盖率并生成直观的 html 测试报告
- pytest-cov 是pytest的一个插件，其本质是引用 python coverage 库用来统计代码覆盖率
- 新版 pytest 默认已经自带，手动安装
pip install pytest-cover使用方法
- 在 pytest 命令中加入
--cov=.\code\参数，用于统计制定文件夹中的代码运行覆盖率，该参数指向的是被测试的代码，不是测试代码 - 在 pytest 命令中加入
--cov-report=html参数输出 html 报告
示例
- 以
mtutils库中的测试代码为例
pytest --cov=.\lib\ .\tests\ --cov-report=html- 运行完成后生成了
htmlcov文件夹，其中包含了覆盖率的 html 网页报告 - 报告效果
- 点击指定文件可以查看代码运行覆盖情况
- 红线表明未被覆盖到的代码
参考资料
本文参与 腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。
原始发表：2022年6月16日，如有侵权请联系 cloudcommunity@tencent.com 删除
目录
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号