unittest测试报告——unittestreport帮你生成漂亮的HTML报告

unittestreport

前言:

一直以来很多使用unittest做自动化测试的的小伙伴都在想，unittest这个官方库为什么没有直接生成测试报告的方法，自己在网上找的一些生成报告的开源的模块，生成的报告模板大都不太美观。于是小编(木森)这两天就自己专门写了一个unittest生成测试报告的库（unittestreport），现在已经上传到PyPi，大家可通过pip命令去下载，接下来就给大家分享一下，这个库怎么使用！

一、unittestreport安装

安装命令：

cmd命令行下输入下面的命令进行安装

pip install unittestreport

github地址： https://github.com/musen123/UnitTestReport

二、使用说明

话不多说，给大家介绍一下怎么使用之前，这边先给大家展示一下报告的效果图

报告效果图：

 

1、使用案例

看完之后有没有觉得还不错，喜欢这个风格报告的小伙伴可以赶紧去安装了！不仅生成的测试报告清新美观，使用起来也非常的简单，接下来就和大家来讲讲如何使用，首先我们先来看一个使用案例

import unittest
from unittestteport import TestRunner
​
# 第一步：加载测试套件
suite1 = unittest.defaultTestLoader.discover(r"xxx\xxx\cases")
# 第二步：创建运行对象，传入测试套件
runner = TestRunner(suite1)
# 第三步：执行测试
runner.run()

 

从上面的案例可以看得出来，使用只需要三步，就可以执行测试用例，并且生产一个漂亮的测试报告！

第一步：收集用例

第二步：使用unittestteport中的TestRunner创建一个运行对象

第三步：执行测试

2、参数解析

接下来给大家详细的介绍一下TestRunner的主要使用参数，用户在创建运行对象的时候，除了传入测试套件，还可以自定义报告的标题、描述等相关信息，详细介绍如下：

class TestRunner():
    """unittest运行程序"""
​
    def __init__(self, suite: unittest.TestSuite,
                 filename="report.html",
                 report_dir=".",
                 title=\'测试报告\',
                 tester=\'木森\',
                 desc="木森执行测试的报告",
                 templates=1
                 ):
        """
        初始化用例运行程序
        :param suites: 测试套件
        :param filename: 报告文件名
        :param report_dir:报告文件的路径
        :param title:测试套件标题
        :param tester:测试者
        :param desc:相关的描述信息
        :param templates: 可以通过参数值1或者2，指定报告的样式模板，目前只有两个模板
        """

 

3、其他报告的整合

很多小伙伴在之前生成测试报告，使用的比较多的是BeautifulReport和HTMLTestRunnerNew这两个模块，考虑带方便大家使用，该模块除了可以生成上面展示的测试报告，还可以生产BeautifulReport风格的测试报告，以及HTMLTestRunnerNew的测试报告(感谢这两个开源模块的作者)，那么接下来就给大家说说如何生产这两种风格的报告吧，

1、BeautifulReport风格的报告

其实要生产BeautifulReport风格的报告，非常简单只需要改一个参数即可，案例及报告效果如下

# 创建运行对象的时候加一个参数templates把值设为2即可

runner = TestRunner(suite1，templates=2)

2、HTMLTestRunnerNew风格报告

关于HTMLTestRunnerNew，小编这边直接把源码整合了进来，导入进来即可使用，使用的参数不变,案例代码及效果图如下：

import unittest
from unittestteport import TestRunner,HTMLTestRunner
​
# 第一步：加载测试套件
suite1 = unittest.defaultTestLoader.discover(r"xxx\xxx\cases")
# 第二步：创建运行对象，传入测试套件
runner = HTMLTestRunner(stream=open("report.html",\'wb\'), title=\'木森的测试报告\',)
# 第三步：执行测试
runner.run()

 

三、扩展说明

本模块是木森老师最近开发出来的第一个版本，还没有经过全面的测试，大家在使用的过程中发现有问题，欢迎找木森老师提bug，以便对该模块后续的的优化和修改！

另外该模块还支持多线程执行unittest测试用例，关于多线程运行的使用和注意点，后续有时间了再给大家介绍！