如何自己实现一个HTMLRunner

在使用unittest框架时，我们常常需要下载一个HTMLRunnerCN.py用来生成HTML格式的报告，那么我们能不能自己实现一个呢？

HTMLRunner是模仿unittest自带的TextTestRunner()实现的，我们先来看看TextTestRunner()的运行流程。

TextTestRunner使用方法

import unittest

suite = unittest.defaultTestLoader.discover("./")

with open("report.txt", "w") as f:   # 将运行结果保存为txt文件

    unittest.TextTestRunner().run(suite)

运行流程

TextTestRunner 内部实现了一个TextTestResult(继承自unittest.TestResult类)来记录测试结果
TextTestRunner().run()实际调用suite(result) 既suite.run(result) (result用来记录结果)
suite.run(result)会遍历suite中的用例，依次调用case(result)既case.run(result)
case.run(result)时，首先会调用result.testRun+=1然后执行用例方法testMethod(), 如果用例失败、出错、跳过则用例会分别调用result.addSuccess(),result.addFailure()等方法，在对应的result.failures,result.errors列表中添加用例信息，默认成功用例result中不处理
运行完返回result(测试结果对象）

unittest.TextTestRunner和网上的HTMLRunner都是基于stream流去写的文件，每执行一条用例，把对应的结果和信息写到流中，最后输出成文件，这种方法需要很多的细节控制，比较复杂。

我们可以采用解析执行完返回result结果，通过Jinjia2模板引擎渲染，将数据渲染到模板里，形成报告文件。

Jinjia2是一个三方包，可以将模板代码中的{{变量名}}等占位符将变量值渲染进去，支持循环和if判断。安装方法pip install jinjia2

实现步骤

首先我们要写个模板

TPL = '''

<!DOCTYPE html>

<html lang="en">

    <head>

        <meta charset="UTF-8">

        <title>{{title}}</title>

    </head>

    <body>

        <h2>{{title}}</h2>

        <h3>{{description}}</h3>

        <br/>

        <table border="1">

            {% for case in cases %}

            <tr>

                <td>{{case.name}}</td>

                <td>{{case.status}}</td>

                <td>{{case.exec_info}}</td>

            </tr>

            {% endfor %}

        </table>

    </body>

</html>

'''

{{title}},{{description}}能将传入的数据中的相应的变量值填充进去
{% for case in cases%} ...{% endfor %}遍历cases列表中每一个用例数据，每个生成一个表格行(<tr>...</tr>）

自定义一个Result类

由于默认的TestResult()将各种状态的用例分散存的，我们可以自定义一个Result类来处理用例成功、失败、出错执行的操作

class Result(unittest.TestResult):

    def __init__(self):

        super().__init__()

        self.cases = []

    def addSuccess(self, test):

        self.cases.append({"name": test.id(), "status": "pass", "exec_info": ""})

    def addError(self, test, exec_info):

        self.cases.append({"name": test.id(), "status": "error",

                             "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addFailure(self, test, exec_info):

        self.cases.append({"name": test.id(), "status": "fail",

                             "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addSkip(self, test, reason):

        self.cases.append({"name": test.id(), "status": "skip", "exec_info": reason))

addSuccess等方法对应用例成功或其他状态时在result结果中的操作
_exec_info_to_string: 默认用例传过来的exec_info是Trackback对象

,需要转换为字符串，replace将\n转为网页的换行<br/>

实现我们的HTMLRunner

class HTMLRunner(object):

    def __init__(self, output, title="Test Report", description=""):

        self.file = output

        self.title = title

        self.description = description

    def run(self, suite):

        result = Result()   # 用于保存测试结果

        suite(result)  # 执行测试

        # 渲染数据到模板

        content = Template(TPL).render({"title": self.title,

                                        "description": self.description,

                                        "cases": result.cases})

        with open(self.file, "w") as f:

            f.write(content)  # 写入文件

        return result

使用方法(自己准备几条用例)

suite = unittest.defaultTestLoader.discover("./")

HTMLRunner(output="report.html",

           title="测试报告",

           description="测试报告描述").run(suite)

生成的测试报告

整体代码

美化格式，增加执行统计信息

import time

import unittest

from jinja2 import Template

TPL = '''

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>{{title}}</title>

    <link rel="stylesheet" href="https://cdn.staticfile.org/twitter-bootstrap/4.1.0/css/bootstrap.min.css">

</head>

<body>

<div class="container">

    <h1 class="pt-4">测试报告</h1>

    <h6>测试报告描述信息</h6>

    <h6>执行: {{run_num}} 通过: {{pass_num}} 失败: {{fail_num}} 出错: {{error_num}} 跳过: {{skipped_num}}</h6>

    <h6 class="pb-2">执行时间: {{duration}}s</h6>

    <table class="table table-striped">

        <thead><tr><th>用例名</th><th>状态</th><th>执行信息</th></tr></thead>

        <tbody>

            {% for case in cases %}

            <tr><td>{{case.name}}</td><td>{{case.status}}</td><td>{{case.exec_info}}</td></tr>

            {% endfor %}

        </tbody>

    </table>

</div>

</body>

</html>

'''

class Result(unittest.TestResult):

    def __init__(self):

        super().__init__()

        self.success = []

        self.cases = []

    def addSuccess(self, test):

        self.success.append(test)

        self.cases.append({"name": test.id(), "status": "pass", "exec_info": ""})

    def addError(self, test, exec_info):

        self.errors.append((test, exec_info))

        self.cases.append({"name": test.id(), "status": "error",

                           "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addFailure(self, test, exec_info):

        self.failures.append((test, exec_info))

        self.cases.append({"name": test.id(), "status": "fail",

                           "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addSkip(self, test, exec_info):

        self.skipped.append((test, exec_info))

        self.cases.append({"name": test.id(), "status": "skip",

                           "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addExpectedFailure(self, test, exec_info):

        self.success.append(test)

        self.cases.append({"name": test.id(), "status": "pass",

                           "exec_info": self._exc_info_to_string(exec_info, test)

                          .replace("\n", "<br/>")})

    def addUnexpectedSuccess(self, test):

        self.failures.append((test, "UnexpectedSuccess"))

        self.cases.append({"name": test.id(), "status": "fail", "exec_info": "UnexpectedSuccess"})

class HTMLRunner(object):

    def __init__(self, output, title="Test Report", description=""):

        self.file = output

        self.title = title

        self.description = description

    def run(self, suite):

        result = Result()   # 用于保存测试结果

        start_time = time.time()

        suite(result)  # 执行测试

        duration = round(time.time() - start_time, 6)

        print(len(result.success), len(result.failures))

        # 渲染数据到模板

        content = Template(TPL).render({"title": self.title,

                                        "description": self.description,

                                        "cases": result.cases,

                                        "run_num": result.testsRun,

                                        "pass_num": len(result.success),

                                        "fail_num": len(result.failures),

                                        "skipped_num": len(result.skipped),

                                        "error_num": len(result.errors),

                                        "duration": duration})

        with open(self.file, "w") as f:

            f.write(content)  # 写入文件

        return result

if __name__ == "__main__":

    suite = unittest.defaultTestLoader.discover("./")

    HTMLRunner(output="report.html",

               title="测试报告",

               description="测试报告描述").run(suite)

Python测试交流，欢迎添加作者微信：lockingfree

如何自己实现一个HTMLRunner的更多相关文章

为什么很多人坚信“富贵险中求”？
之家哥 2017-11-15 09:12:31 微信QQ微博下载APP 摘要网贷之家小编根据舆情频道的相关数据,精心整理的关于<为什么很多人坚信"富贵险中求"?>的 ...
python基础全部知识点整理,超级全(20万字+)
目录 Python编程语言简介 https://www.cnblogs.com/hany-postq473111315/p/12256134.html Python环境搭建及中文编码 https:// ...
让HTMLrunner 报告的子列表都默认展示出来的方法(方便发送邮件时可以方便查看)
1.找到生成的测试报告,获取到all元素 2.在HTMLrunner源码,</script> 标签上加入一个函数 #让所有列表都展示出来window.onload = function ...
Tomcat一个BUG造成CLOSE_WAIT
之前应该提过,我们线上架构整体重新架设了,应用层面使用的是Spring Boot,前段日子因为一些第三方的原因,略有些匆忙的提前开始线上的内测了.然后运维发现了个问题,服务器的HTTPS端口有大量的C ...
如何一步一步用DDD设计一个电商网站（九）—— 小心陷入值对象持久化的坑
阅读目录前言场景1的思考场景2的思考避坑方式实践结语一.前言在上一篇中(如何一步一步用DDD设计一个电商网站(八)—— 会员价的集成),有一行注释的代码: public interfa ...
如何一步一步用DDD设计一个电商网站（八）—— 会员价的集成
阅读目录前言建模实现结语一.前言前面几篇已经实现了一个基本的购买+售价计算的过程,这次再让售价丰满一些,增加一个会员价的概念.会员价在现在的主流电商中,是一个不大常见的模式,其带来的问题是 ...
SQLSERVER将一个文件组的数据移动到另一个文件组
SQLSERVER将一个文件组的数据移动到另一个文件组有经验的大侠可以直接忽视这篇文章~ 这个问题有经验的人都知道怎麽做,因为我们公司的数据量不大没有这个需求,也不知道怎麽做实验今天求助了QQ群里 ...
构建一个基本的前端自动化开发环境 —— 基于 Gulp 的前端集成解决方案（四）
通过前面几节的准备工作,对于 npm / node / gulp 应该已经有了基本的认识,本节主要介绍如何构建一个基本的前端自动化开发环境. 下面将逐步构建一个可以自动编译 sass 文件.压缩 ja ...
【造轮子】打造一个简单的万能Excel读写工具
大家工作或者平时是不是经常遇到要读写一些简单格式的Excel? shit!~很蛋疼,因为之前吹牛,就搞了个这东西,还算是挺实用,和大家分享下. 厌烦了每次搞简单类型的Excel读写?不怕~来,喜欢流式 ...

随机推荐

【规律】A Rational Sequence
题目描述 An infinite full binary tree labeled by positive rational numbers is defi ned by:• The label of ...
AlertManager 部署及使用
熟悉了 Grafana 的报警功能,但是 Grafana 的报警功能目前还比较弱,只支持 Graph 的图表的报警.今天来给大家介绍一个功能更加强大的报警工具:AlertManager. 简介之前我 ...
springcloud eureka注册中心分布式配置
最近在学习springcloud,做下笔记以及记下遇到的坑. 1.建立maven工程,结构很简单,一个启动类和一个配置文件,结构如下图所示 2.启动类代码如下,需要添加注册中心注解:EnableEur ...
Cache的一些总结
输出缓存这是最简单的缓存类型,它保存发送到客户端的页面副本,当下一个客户端发送相同的页面请求时,此页面不会重新生成(在缓存有限期内),而是从缓存中获取该页面:当然由于缓存过期或被回收,这时页面会重新 ...
SQL游标示例
DECLARE @@totalNum INT;SET @@totalNum=0;DECLARE @num INT;DECLARE @CustomInfo NVARCHAR(MAX);DECLARE M ...
JS-闭包练习
首先,第一个输出,因为前置运算,i要先参与输出,然后再自增,所以输出为0 第二个输出,因为f1和f2是不同的函数,不共享i变量,所以输出也为0 第三个输出,因为是f1,共享i,所以i加了1,输出为1 ...
docker第一篇容器技术入门
Container 容器是一种基础工具,泛指任何可以容纳其它物品的工具. Linux Namespaces (docker容器技术主要是通过6个隔离技术来实现) namespace 系统调用参数 ...
SQL脚本优化
1.创建索引一.要尽量避免全表扫描,首先应考虑在 where 及 order by 涉及的列上建立索引 (1)在经常需要进行检索的字段上创建索引,比如要按照表字段username进行检索,那么就应 ...
2019年C题视觉情报信息分析
2019 年第十六届中国研究生数学建模竞赛C 题任务1中图三:图3 中拍照者距离地面的高度目录: 0.试题分析: 1.构建摄像机模型 2.摄像机参数假定 3.像平面坐标计算 4.图像标定及数值测 ...
构建之法个人作业5——alpha2项目测试
[相关信息] Q A 这个作业属于哪个课程 https://edu.cnblogs.com/campus/xnsy/2019autumnsystemanalysisanddesign/ 这个作业要求在 ...