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

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

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

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

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

# conftest.py

import pytest

def 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.py

import pytest
import os
import platform
import time
from collections import defaultdict

# 假设我们有一个自定义的统计器来跟踪测试结果
class TestStatistics:
    def __init__(self):
        self.passed = 0
        self.failed = 0
        self.skipped = 0

    def increment(self, result):
        if result == "passed":
            self.passed += 1
        elif result == "failed":
            self.failed += 1
        elif result == "skipped":
            self.skipped += 1

    def 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