使用pytest的 reporting特性来生成报告

2024-08-30 16:44

本文主要是介绍使用pytest的 reporting特性来生成报告,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

特性

1.HTML 报告:使用 pytest-html 插件,你可以生成 HTML 格式的测试报告。只需在项目的 pytest.ini 文件中添加以下内容:

[pytest]
addopts = --html=report.html

然后,在运行 pytest 时,将会生成一个名为 report.html 的 HTML 文件,其中包含了测试用例的详细信息和结果。

2.XML 报告:使用 pytest-xml 插件,你可以生成 XML 格式的测试报告。同样,在项目的 pytest.ini 文件中添加以下内容:

[pytest]
addopts = --xml=report.xml

运行 pytest 后,将会生成一个名为 report.xml 的 XML 文件,可供其他工具或系统使用。

3.JSON 报告:使用 pytest-json 插件,你可以生成 JSON 格式的测试报告。在 pytest.ini 文件中添加以下内容:

[pytest]
addopts = --json=report.json

运行 pytest 后,将会生成一个名为 report.json 的 JSON 文件,包含了测试用例的相关信息。

4.控制台报告:默认情况下,pytest 在控制台输出测试结果。你可以通过设置 pytest.ini 文件中的 verbosity 选项来控制报告的详细程度,例如:

[pytest]
verbosity = 2

这些 reporting 特性可以帮助你更好地了解测试的执行情况,并与其他团队成员或工具进行共享和分析。

如何在报告中添加自定义字段?

要在 pytest 的报告中添加自定义字段,你可以使用 pytest-html 插件来生成 HTML 格式的报告,并在报告中添加自定义字段。以下是一个示例,展示了如何在 HTML 报告中添加自定义字段 Environment 和 Execution Time:

import datetime
from py.xml import html
import pytest
import time
# 修改报告名称
def pytest_html_report_title(report):report.title = "接口自动化测试报告"
# 添加环境项
def pytest_configure(config):config._metadata('测试人员') = 'emily'
# 添加执行时间
def pytest_html_results_table_header(cells):cells.insert(0, html.th('用例编号'))cells.insert(1, html.th('所属模块'))cells.insert(2, html.th('用例名称'))cells.insert(3, html.th('接口路径'))cells.insert(5, html.th('执行时间', class_='sortable time', col='time'))cells.pop(6)cells.pop()
# 获取测试节点
def pytest_html_results_table_row(report, cells):url = 'http://xxx.com'testnode = report.nodeid.encode("utf-8").decode("unicode_escape")caseid = testnode.split('-')(3)cells.insert(0, html.td(caseid))module = testnode.split('-')(2)cells.insert(1, html.td(module))casename = testnode.split('-')(1)url = url+testnode.split('-')(4)(:-1)cells.insert(2, html.td(casename))cells.insert(3, html.td(url))cells.insert(5, html.td(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), class_='col-time'))cells.pop(6)cells.pop()
# 在运行测试之前执行的钩子函数
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):outcome = yieldreport = outcome.get_result()report.casename = str(item.function.__code__.co_varnames)

首先,在 pytest_configure 函数中,使用 config._metadata 来添加一个名为 测试人员 的自定义字段,其值为 emily。接下来,在 pytest_html_results_table_header 函数中,向 HTML 报告的表头中添加了一个名为 执行时间 的新列。然后,在 pytest_html_results_table_row 函数中,从测试用例中获取相关信息,并将其插入到报告的行数据中。最后,使用 pytest_runtest_makereport 钩子函数来修改测试用例的名称,使其包含函数的参数名。

运行 pytest 命令后,将会生成一个名为 report.html 的 HTML 文件,其中包含了测试用例的详细信息和结果,并且包含了自定义字段 Environment 和 Execution Time。

如何在报告中添加图表?

可以使用一些第三方库或工具来实现。以下是一种常见的方法,使用 Python 的 Matplotlib 库来生成图表并将其嵌入到 HTML 报告中:

  1. 首先,确保你已经安装了 Matplotlib 库。

  2. 在你的测试用例中,使用 Matplotlib 绘制图表,并将其保存为图像文件(例如 PNG 格式)。

  3. 在 HTML 报告中,使用 HTML 和 CSS 来嵌入和显示图像。你可以在报告的适当位置添加 标签,并指定图像的路径。

以下是一个简单的示例,展示了如何在 HTML 报告中添加图表:

import pytest
import matplotlib.pyplot as plt
def test_sample_function():# 生成图表数据x = [1, 2, 3, 4, 5]y = [2, 4, 6, 8, 10]# 绘制图表plt.plot(x, y)plt.xlabel('X 轴')plt.ylabel('Y 轴')plt.title('图表示例')plt.savefig('chart.png')# 断言图表文件存在assert os.path.exists('chart.png')
@pytest.mark.parametrize('param', [1, 2, 3])
def test_with_params(param):# 在这里使用参数进行测试
# 修改报告名称
def pytest_html_report_title(report):report.title = "测试报告"
# 添加图表到报告中
def pytest_html_results_table_header(cells):cells.insert(0, html.th('用例编号'))cells.insert(1, html.th('所属模块'))cells.insert(2, html.th('用例名称'))cells.insert(3, html.th('图表', class_='sortable chart', col='chart'))
# 获取测试节点
def pytest_html_results_table_row(report, cells):url = 'http://xxx.com'testnode = report.nodeid.encode("utf-8").decode("unicode_escape")caseid = testnode.split('-')(3)cells.insert(0, html.td(caseid))module = testnode.split('-')(2)cells.insert(1, html.td(module))casename = testnode.split('-')(1)cells.insert(2, html.td(casename))cells.insert(3, html.td(html.Img(src='chart.png')))cells.pop(4)cells.pop()
# 在运行测试之前执行的钩子函数
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):outcome = yieldreport = outcome.get_result()report.casename = str(item.function.__code__.co_varnames)

在上述示例中,首先在测试用例中生成图表并保存为 chart.png。然后,在 HTML 报告的表头中添加了一个名为 图表 的新列。在报告的行数据中,使用 标签嵌入了图表图像。

感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:


这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取   

这篇关于使用pytest的 reporting特性来生成报告的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1121373

相关文章

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传:从崩溃边缘抢救进度二、多线程加速:榨干网络带宽三、速度控制:做网络的好邻居四、终端交互

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

从入门到精通C++11 <chrono> 库特性

《从入门到精通C++11<chrono>库特性》chrono库是C++11中一个非常强大和实用的库,它为时间处理提供了丰富的功能和类型安全的接口,通过本文的介绍,我们了解了chrono库的基本概念... 目录一、引言1.1 为什么需要<chrono>库1.2<chrono>库的基本概念二、时间段(Durat

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

ModelMapper基本使用和常见场景示例详解

《ModelMapper基本使用和常见场景示例详解》ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置(如匹配策略、转换器),可集成SpringBoot,减少样板... 目录1. 添加依赖2. 基本用法示例:简单对象映射3. 自定义映射规则4. 集合映射5. 高级配置匹

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

使用Python绘制3D堆叠条形图全解析

《使用Python绘制3D堆叠条形图全解析》在数据可视化的工具箱里,3D图表总能带来眼前一亮的效果,本文就来和大家聊聊如何使用Python实现绘制3D堆叠条形图,感兴趣的小伙伴可以了解下... 目录为什么选择 3D 堆叠条形图代码实现:从数据到 3D 世界的搭建核心代码逐行解析细节优化应用场景:3D 堆叠图

Springboot如何正确使用AOP问题

《Springboot如何正确使用AOP问题》:本文主要介绍Springboot如何正确使用AOP问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录​一、AOP概念二、切点表达式​execution表达式案例三、AOP通知四、springboot中使用AOP导出

Navicat数据表的数据添加,删除及使用sql完成数据的添加过程

《Navicat数据表的数据添加,删除及使用sql完成数据的添加过程》:本文主要介绍Navicat数据表的数据添加,删除及使用sql完成数据的添加过程,具有很好的参考价值,希望对大家有所帮助,如有... 目录Navicat数据表数据添加,删除及使用sql完成数据添加选中操作的表则出现如下界面,查看左下角从左