HtmlTestRunner 项目教程

HtmlTestRunner 项目教程

HtmlTestRunnerA Test Runner in python, for Human Readable HTML Reports项目地址:https://gitcode.com/gh_mirrors/ht/HtmlTestRunner

1. 项目的目录结构及介绍

HtmlTestRunner 项目的目录结构如下：

HtmlTestRunner/
├── HtmlTestRunner/
│   ├── __init__.py
│   ├── result.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── report.html
│   │   └── styles.css
│   └── runner.py
├── tests/
│   ├── __init__.py
│   ├── test_example.py
│   └── test_suite.py
├── setup.py
├── README.md
└── requirements.txt

目录结构介绍：

• HtmlTestRunner/: 核心代码目录，包含了项目的所有源代码。

  • init.py: 初始化文件，使得该目录可以作为 Python 包导入。
  • result.py: 处理测试结果的模块。
  • templates/: 包含 HTML 报告的模板文件。
    • base.html: 基础 HTML 模板。
    • report.html: 测试报告的 HTML 模板。
    • styles.css: 报告的样式文件。
  • runner.py: 测试运行器的主模块。

• tests/: 包含项目的测试用例。

  • init.py: 初始化文件，使得该目录可以作为 Python 包导入。
  • test_example.py: 示例测试用例。
  • test_suite.py: 测试套件的示例。

• setup.py: 项目的安装脚本。

• README.md: 项目的说明文档。

• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

HtmlTestRunner 项目的启动文件是 runner.py。该文件包含了测试运行器的主要逻辑，负责执行测试用例并生成 HTML 格式的测试报告。

runner.py 文件介绍：

• HTMLTestRunner: 这是测试运行器的主类，继承自 unittest.TextTestRunner。它负责执行测试用例并生成 HTML 报告。
• run(): 这是 HTMLTestRunner 类的主要方法，用于运行测试套件并生成报告。

使用示例：

import unittest
from HtmlTestRunner import HTMLTestRunner

class TestStringMethods(unittest.TestCase):
    def test_upper(self):
        self.assertEqual('foo'.upper(), 'FOO')

if __name__ == '__main__':
    unittest.main(testRunner=HTMLTestRunner(output='test_reports'))

3. 项目的配置文件介绍

HtmlTestRunner 项目没有专门的配置文件，但可以通过命令行参数或代码中的参数来配置测试运行器的行为。

配置参数：

• output: 指定生成的 HTML 报告的输出目录。
• report_name: 指定生成的 HTML 报告的文件名。
• combine_reports: 是否将所有测试用例的报告合并为一个报告。

示例配置：

from HtmlTestRunner import HTMLTestRunner

runner = HTMLTestRunner(output='test_reports', report_name='my_report', combine_reports=True)
runner.run(suite)

通过这些配置参数，可以灵活地控制测试报告的生成方式。

HtmlTestRunnerA Test Runner in python, for Human Readable HTML Reports项目地址:https://gitcode.com/gh_mirrors/ht/HtmlTestRunner