使用HTMLTestReport生成Python测试报告

在Python开发中，测试是一个非常重要的环节。测试可以保证代码的正确性，提高软件质量，同时也可以帮助开发人员快速定位和修复问题。为了更好地管理和展示测试结果，我们可以使用HTMLTestReport生成美观且易读的测试报告。

HTMLTestReport简介

HTMLTestReport是一个Python库，它可以将测试结果以HTML报告的形式展示。它可以生成详细的测试结果，包括测试用例的执行结果、用例的执行时间和错误信息等。HTMLTestReport还支持多种自定义设置，如标题、测试人员信息、报告背景色等，使得测试报告更加美观和个性化。

安装HTMLTestReport

在使用HTMLTestReport之前，我们首先需要安装它。可以通过以下命令使用pip进行安装：

pip install HTMLTestReportCN

安装完成后，我们就可以在Python中使用HTMLTestReport了。

生成测试报告的步骤

下面我们来演示如何使用HTMLTestReport生成测试报告的步骤。

首先，我们需要创建一个测试用例文件。假设我们有一个简单的加法函数，我们可以编写一个测试用例文件test_calculator.py来对这个函数进行测试。

import unittest

def add(a, b):
    return a + b

class TestCalculator(unittest.TestCase):
    def test_add(self):
        self.assertEqual(add(2, 3), 5)

if __name__ == "__main__":
    unittest.main()

接下来，我们需要编写生成测试报告的代码。我们可以创建一个名为generate_report.py的文件，并在其中编写以下代码：

import unittest
from HTMLTestReportCN import HTMLTestRunner

# 导入测试用例文件
from test_calculator import TestCalculator

# 创建测试套件
suite = unittest.TestSuite()
suite.addTest(TestCalculator("test_add"))

# 创建测试运行器
runner = HTMLTestRunner(output="./report", report_title="测试报告", report_desc="执行测试的结果如下：")

# 运行测试套件
runner.run(suite)

在上面的代码中，我们首先导入了unittest和HTMLTestRunner，然后导入了我们编写的测试用例文件。接着，我们创建一个测试套件，并将测试用例添加到测试套件中。最后，我们创建了一个测试运行器，并指定了输出路径、报告标题和报告描述。最后，我们调用测试运行器的run()方法来执行测试套件。

生成测试报告

接下来，我们可以运行generate_report.py来生成测试报告。在命令行中执行以下命令：

python generate_report.py

执行完成后，我们可以在当前目录下的report文件夹中找到生成的测试报告。

自定义测试报告

HTMLTestReport还支持一些自定义设置，可以根据需要来进行配置。下面是一些常用的自定义设置：

  • 设置报告的标题和描述
runner = HTMLTestRunner(output="./report", report_title="测试报告", report_desc="执行测试的结果如下：")
  • 设置测试报告的样式
runner.report_styles = {
    "body": "font-family: Arial, sans-serif; width: 80%; margin: 0 auto;",
    "table_header": "background-color: #f5f5f5; font-weight: bold; text-align: center;",
    "table_cell": "border: 1px solid #ddd; padding: 8px; text-align: center;",
    "pass": "background-color: #dff0d8; color: #3c763d;",
    "fail": "background-color: #f2dede; color: #a94442;",
    "error": "background-color: #f2dede; color: #a94442;",
    "skip": "background-color: #d9edf7; color: #31708f;",
    "button": "padding: 8px 12px; background-color: #337ab7; color: #fff; border: none; border-radius: 4px; cursor: pointer;"
}
  • 设置测试报告的背景色
runner.report_background_color = "#fff"
  • 设置测试报告中的饼状图颜色
runner.pie_colors = ["#5cb85c", "#d9534f",