使用HTMLTestRunner生成漂亮的测试报告

小蓝 • 2024-11-30 09:08 • 编程

一、HTMLTestRunner简介

HTMLTestRunner是Python中的一个第三方测试框架，可以生成美观易读的测试报告。它使用HTML格式呈现测试结果，支持颜色编码和图表，方便查看和分析测试结果。HTMLTestRunner可以在Python 2.x和3.x环境下使用。

使用HTMLTestRunner需要先安装该框架。可以通过命令pip install HTMLTestRunner进行安装。安装后，就可以通过导入HTMLTestRunner模块来使用。

二、使用HTMLTestRunner生成测试报告

使用HTMLTestRunner生成测试报告需要遵循以下步骤：

1.编写测试脚本

首先需要编写测试脚本，可以使用Python中的unittest模块编写测试用例和测试套件。例如，以下代码演示了如何编写一个简单的测试用例：

import unittest

class TestStringMethods(unittest.TestCase):

    def test_upper(self):
        self.assertEqual('foo'.upper(), 'FOO')

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

可以使用 unittest.makeSuite(TestStringMethods) 将 TestStringMethods 类添加到测试套件中。以下代码演示了如何生成一个包含一个测试用例的测试套件：

suite = unittest.TestSuite()
suite.addTest(TestStringMethods('test_upper'))

2.运行测试脚本

在运行测试脚本时，需要将测试结果输出到文件中。可以使用Python内置的codecs模块打开文件，并将输出编码为utf-8。以下代码演示了如何运行测试脚本并将结果输出到文件中：

import codecs
import unittest
import HTMLTestRunner

# 加载测试套件
suite = unittest.TestSuite()
suite.addTest(TestStringMethods('test_upper'))

# 打开文件
fp = codecs.open('result.html', mode='w', encoding='utf-8')

# 运行测试并生成报告
runner = HTMLTestRunner.HTMLTestRunner(stream=fp, title='测试报告', description='测试结果如下：')
runner.run(suite)

# 关闭文件
fp.close()

3.查看测试报告

运行测试脚本后，将生成一个名为result.html的文件，包含了测试结果。可以使用浏览器打开该文件查看测试报告。以下是部分测试报告的示例：

测试报告

测试结果如下：

用例名称	测试结果
test_upper (TestStringMethods)	成功

三、优化测试报告样式

生成的测试报告使用了HTML格式，但默认样式可能不够美观。可以通过修改HTMLTestRunner模块中的样式来优化测试报告样式。

HTMLTestRunner提供了外部样式表以方便用户自定义样式。可以将样式表放在同一目录下的文件中，并在运行测试时将文件名传递给HTMLTestRunner。以下代码演示了如何使用外部样式表：

import codecs
import unittest
import HTMLTestRunner

# 加载测试套件
suite = unittest.TestSuite()
suite.addTest(TestStringMethods('test_upper'))

# 打开文件
fp = codecs.open('result.html', mode='w', encoding='utf-8')

# 运行测试并生成报告
runner = HTMLTestRunner.HTMLTestRunner(stream=fp, title='测试报告', description='测试结果如下：', stylesheet='style.css')
runner.run(suite)

# 关闭文件
fp.close()

可以在样式表文件中定义如下样式：

body {
    background-color: #F5F5F5;
    font-family: Arial, Helvetica, sans-serif;
}

h1 {
    color: #445566;
    font-size: 24px;
    text-align:center;
    margin:0px 0px 20px 0px;
}

table {
    width: 100%;
    margin: 20px 0px;
    border-collapse: collapse;
    font-size: 14px;
}

th {
    background-color: #D3D3D3;
    font-weight: normal;
    text-align: left;
    padding: 5px 10px;
    border: 1px solid #B5B5B5;
}

td {
    background-color: #FFFFFF;
    text-align: left;
    padding: 5px 10px;
    border: 1px solid #B5B5B5;
}

.fail {
    color: #FF0000;
    font-weight:bold;
}

.pass {
    color: #00CC00;
    font-weight:bold;
}

修改样式后，运行测试脚本将生成美观易读的测试报告。

四、结语

本文介绍了如何使用HTMLTestRunner生成美观易读的测试报告，并优化了测试报告的样式。HTMLTestRunner是Python中一个方便易用的测试框架，可以帮助测试人员更方便地查看和分析测试结果。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/190923.html