pytest教程-43-钩子函数-pytest_report_header

2024-05-09 22:52

本文主要是介绍pytest教程-43-钩子函数-pytest_report_header,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

领取资料,咨询答疑,请➕wei:  June__Go

上一小节我们学习了pytest_runtest_makereport钩子函数的使用方法,本小节我们讲解一下pytest_report_header钩子函数的使用方法。

pytest_report_header 钩子函数允许你在 pytest 的终端报告的头部添加自定义信息。这个钩子在生成报告时被调用,通常用于显示测试环境的配置信息、版本信息或其他重要的上下文信息。

以下是一个具体的代码示例,展示了如何在 conftest.py 文件中使用 pytest_report_header 钩子函数:

# conftest.pyimport pytestdef pytest_report_header(config):# 获取 pytest 配置信息env = config.get('env', {})version = env.get('MY_APP_VERSION', 'unknown')platform = env.get('MY_PLATFORM', 'unknown')# 创建自定义的报告头部信息header_info = (f"Testing Environment:\n"f"  Application Version: {version}\n"f"  Platform: {platform}\n"f"  Start Time: {time.ctime()}\n")# 返回自定义的报告头部信息return header_info# 你可以在 pytest.ini 文件中设置环境变量,例如:
# [pytest]
# env = MY_APP_VERSION=1.0.0
# env = MY_PLATFORM=development

在这个示例中,我们首先从 config 对象中获取环境变量,这些环境变量包含了应用版本和平台信息。然后,我们创建了一个包含这些信息的字符串,作为自定义的报告头部信息。最后,我们返回这个字符串,它将在 pytest 的终端报告头部显示。

请注意,为了使这个示例工作,你需要在 pytest.ini 文件中设置相应的环境变量,或者在命令行中使用 --env 参数来设置它们。这样,当你运行测试时,pytest_report_header 钩子函数就会读取这些环境变量,并在报告头部显示相应的信息。

这个示例展示了如何使用 pytest_report_header 钩子函数来增强 pytest 的报告,使其包含更多关于测试环境的信息。在实际应用中,你可以根据需要添加或修改头部信息的内容。

在这个更复杂的示例中,我们将使用 pytest_report_header 钩子函数来展示如何集成多个源的信息,包括环境变量、系统信息和自定义的测试统计数据。我们将在 pytest 的报告头部显示这些信息,以便为测试提供更多的上下文。

首先,确保你的项目中有一个 conftest.py 文件。然后,在 conftest.py 文件中定义 pytest_report_header 钩子函数:

# conftest.pyimport pytest
import os
import platform
import time
from collections import defaultdict# 假设我们有一个自定义的统计器来跟踪测试结果
class TestStatistics:def __init__(self):self.passed = 0self.failed = 0self.skipped = 0def increment(self, result):if result == "passed":self.passed += 1elif result == "failed":self.failed += 1elif result == "skipped":self.skipped += 1def summary(self):return {"passed": self.passed,"failed": self.failed,"skipped": self.skipped}# 全局统计器实例
test_statistics = TestStatistics()def pytest_runtest_logreport(report):# 更新测试统计数据if report.passed:test_statistics.increment("passed")elif report.failed:test_statistics.increment("failed")elif report.skipped:test_statistics.increment("skipped")def pytest_report_header(config):# 获取系统信息system_info = platform.platform()# 获取环境变量env_vars = ", ".join([f"{key}={value}" for key, value in os.environ.items() if key.startswith('TEST_')])# 获取自定义的测试统计数据stats_summary = test_statistics.summary()# 创建自定义的报告头部信息header_info = (f"Testing Report Header\n"f"System: {system_info}\n"f"Environment Variables: {env_vars}\n"f"Test Statistics:\n"f"   Passed: {stats_summary['passed']}\n"f"   Failed: {stats_summary['failed']}\n"f"   Skipped: {stats_summary['skipped']}\n"f"   Total: {stats_summary['passed'] + stats_summary['failed'] + stats_summary['skipped']}\n"f"Start Time: {time.ctime()}\n")# 返回自定义的报告头部信息return header_info# 在 pytest 运行结束时重置统计器
def pytest_sessionfinish(session, exitstatus):test_statistics = TestStatistics()

在这个示例中,我们首先定义了一个 TestStatistics 类来跟踪测试结果。在每个测试用例执行后,我们通过 pytest_runtest_logreport 钩子函数更新统计数据。

然后,在 pytest_report_header 钩子函数中,我们收集了系统信息、环境变量和自定义的测试统计数据。我们将这些信息组合成一个多行字符串,作为报告的头部信息。这个字符串包含了系统平台、环境变量、测试统计数据和测试开始时间。

请注意,为了使这个示例工作,你需要在 pytest.ini 文件中设置相应的环境变量,或者在命令行中使用 --env 参数来设置它们。此外,你可能需要在测试运行结束后重置统计器,以避免在连续运行多个测试时统计数据相互干扰。

这个示例展示了如何使用 pytest_report_header 钩子函数来创建一个包含丰富信息的测试报告头部。在实际应用中,你可以根据需要添加或修改头部信息的内容,以及如何集成和展示测试统计数据。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走,希望可以帮助到大家!领取资料,咨询答疑,请➕wei:  June__Go

这篇关于pytest教程-43-钩子函数-pytest_report_header的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

MySQL字符串常用函数详解

《MySQL字符串常用函数详解》本文给大家介绍MySQL字符串常用函数,本文结合实例代码给大家介绍的非常详细,对大家学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql字符串常用函数一、获取二、大小写转换三、拼接四、截取五、比较、反转、替换六、去空白、填充MySQL字符串常用函数一、

Windows环境下解决Matplotlib中文字体显示问题的详细教程

《Windows环境下解决Matplotlib中文字体显示问题的详细教程》本文详细介绍了在Windows下解决Matplotlib中文显示问题的方法,包括安装字体、更新缓存、配置文件设置及编码調整,并... 目录引言问题分析解决方案详解1. 检查系统已安装字体2. 手动添加中文字体(以SimHei为例)步骤

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

MySql基本查询之表的增删查改+聚合函数案例详解

《MySql基本查询之表的增删查改+聚合函数案例详解》本文详解SQL的CURD操作INSERT用于数据插入(单行/多行及冲突处理),SELECT实现数据检索(列选择、条件过滤、排序分页),UPDATE... 目录一、Create1.1 单行数据 + 全列插入1.2 多行数据 + 指定列插入1.3 插入否则更

Java JDK1.8 安装和环境配置教程详解

《JavaJDK1.8安装和环境配置教程详解》文章简要介绍了JDK1.8的安装流程,包括官网下载对应系统版本、安装时选择非系统盘路径、配置JAVA_HOME、CLASSPATH和Path环境变量,... 目录1.下载JDK2.安装JDK3.配置环境变量4.检验JDK官网下载地址:Java Downloads

PostgreSQL中rank()窗口函数实用指南与示例

《PostgreSQL中rank()窗口函数实用指南与示例》在数据分析和数据库管理中,经常需要对数据进行排名操作,PostgreSQL提供了强大的窗口函数rank(),可以方便地对结果集中的行进行排名... 目录一、rank()函数简介二、基础示例:部门内员工薪资排名示例数据排名查询三、高级应用示例1. 每

全面掌握 SQL 中的 DATEDIFF函数及用法最佳实践

《全面掌握SQL中的DATEDIFF函数及用法最佳实践》本文解析DATEDIFF在不同数据库中的差异,强调其边界计算原理,探讨应用场景及陷阱,推荐根据需求选择TIMESTAMPDIFF或inte... 目录1. 核心概念:DATEDIFF 究竟在计算什么?2. 主流数据库中的 DATEDIFF 实现2.1

MySQL中的LENGTH()函数用法详解与实例分析

《MySQL中的LENGTH()函数用法详解与实例分析》MySQLLENGTH()函数用于计算字符串的字节长度,区别于CHAR_LENGTH()的字符长度,适用于多字节字符集(如UTF-8)的数据验证... 目录1. LENGTH()函数的基本语法2. LENGTH()函数的返回值2.1 示例1:计算字符串

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker