Pytest-HTML 报告文件名定制指南：实现动态与自包含报告

本文详细介绍了如何定制 `pytest-html` 生成的 html 测试报告文件名。通过使用 `--html` 命令行选项，用户可以指定静态文件名或结合 shell 命令实现动态、带时间戳的命名。同时，文章强调了使用 `--self-contained-html` 选项生成独立报告的重要性，以避免多个报告共享同一 `assets` 文件夹的问题，确保每个报告的完整性。

Pytest-HTML 报告文件名定制

pytest-html 插件为 pytest 提供了一个命令行选项 --html，允许用户自定义生成的 HTML 报告的文件路径和文件名。这解决了报告默认命名为 report.html 并反复覆盖的问题。

1. 指定静态报告文件名

最直接的方法是使用 --html 选项并提供一个具体的文件名。

示例：

# 检查当前目录下是否存在html文件
$ ls | grep -c "html"
0

# 运行测试并指定报告文件名为 mycustomreportfilename.html
$ pytest --html=mycustomreportfilename.html tests/*

# 输出类似：
# - Generated html report: file:/path/to/mycustomreportfilename.html -

# 再次检查，确认文件已生成
$ ls | grep -c "html"
1

$ ls | grep "html"
mycustomreportfilename.html

通过这种方式，每次运行 pytest 时，报告都会生成为 mycustomreportfilename.html。如果文件已存在，则会被覆盖。

立即学习“前端免费学习笔记（深入）”；

2. 实现动态、带时间戳的报告文件名

为了避免报告被覆盖，并为每次测试运行生成唯一的报告，可以结合 shell 的日期/时间命令（如 Bash 中的 date 命令）来动态生成文件名。

示例：

# 检查当前目录下是否存在html文件
$ ls | grep -c "html"
0

# 运行测试，文件名包含当前时间戳
$ pytest --html="$(date +%Y%m%d_%H%M%SZ)_report.html" tests/*
$ pytest --html="$(date +%Y%m%d_%H%M%SZ)_report.html" tests/*
$ pytest --html="$(date +%Y%m%d_%H%M%SZ)_report.html" tests/*

# 检查生成的报告文件
$ ls | grep -c "html"
3

$ ls | grep "html"
20240106_171151Z_report.html
20240106_171202Z_report.html
20240106_171206Z_report.html

在上述示例中，$(date +%Y%m%d_%H%M%SZ) 会在命令执行时被替换为当前的日期和时间，从而生成一个唯一的报告文件名。

爱图表

AI驱动的智能化图表创作平台

下载

3. 确保报告独立性：使用 --self-contained-html

当生成多个动态命名的 HTML 报告时，pytest-html 默认可能会为所有报告生成一个共享的 assets 文件夹。这意味着如果某个报告被删除，或者 assets 文件夹被修改，可能会影响其他报告的显示。

为了确保每个 HTML 报告都是完全独立的，包含所有必要的 CSS、JavaScript 和图像资源，建议使用 --self-contained-html 选项。这将把所有资源内嵌到单个 HTML 文件中，使得报告更易于分享和归档。

示例：

# 运行测试并生成自包含的动态命名报告
$ pytest --html="$(date +%Y%m%d_%H%M%SZ)_report.html" --self-contained-html tests/*

通过添加 --self-contained-html，每个生成的 HTML 文件将包含其自身所需的所有资源，从而保证报告的完整性和独立性。

注意事项与总结

1. --html 选项的文档状态： 截至 pytest-html 4.1.1 版本，--html 选项并未在官方文档中明确列出，但它确实存在于插件的源代码中，并可正常使用。这表明它是一个可用的功能，但可能不如其他核心功能那样被广泛宣传。
2. 动态命名与环境： 动态命名依赖于运行 pytest 的 shell 环境。确保你的 shell 支持 date 或其他日期/时间命令，并且语法正确。
3. 报告标题定制： 虽然本文关注文件名，但可以通过在 conftest.py 中定义 pytest_html_report_title 钩子函数来定制报告内部的标题，例如：

   # conftest.py
   def pytest_html_report_title(report):
      report.title = '我的API测试报告'

   这与文件名定制是相互独立的。

通过以上方法，用户可以灵活地控制 pytest-html 生成的报告文件名，无论是简单的静态命名，还是复杂的动态、带时间戳的命名，并能通过 self-contained-html 选项确保报告的独立性和可移植性。这些功能极大地提升了测试报告的管理和可用性。