『心善渊』Selenium3.0基础 — 29、使用HTMLTestRunner生成unittest的HTML报告

目录

• 1、HTMLTestRunner介绍
• 2、HTMLTestRunner的使用
• 3、测试报告示例
• 4、封装成模块

1、HTMLTestRunner介绍

HTMLTestRunner是一个基于unittest单元测试框架生成HTML报告的第三库。

2、HTMLTestRunner的使用

1. 将下载好的HTMLTestRunner解压，把HTMLTestRunner.py放入Python安装目录的Lib文件下，
   
   如：F:\DevInstall\envs\python\python377\Lib（推荐）
   
   或者F:\DevInstall\envs\python\python377\Lib\site-packages都可以。
   
   （注：如果你有自己封装的测试框架，也可以放在框架中，当作工具类应引入也行。）
2. 将HTMLTestRunner模块用import导入测试脚本文件中。
3. 通过open()方法以二进制写模式'wb'打开当前目录下的测试报告.html，如果没有，则自动创建。
4. 调用HTMLTestRunner模块下的HTMLTestRunner类，参数说明如下：
   • stream：指定测试报告文件
   • title：定义测试报告的标题
   • description：定义测试报告的副标题
   • verbosity：报告的详细程度，只有0、1、2 ，2为最详细。
5. 通过HTMLTestRunner的run()方法来运行测试套件中的测试用例.

3、测试报告示例

"""
run_case.py
1.将需要执行的测试用例,添加到测试套件中
2.将用例执行结果生成HTML格式的测试报告
HTMLTestRunner.py文件放置在python安装目录中的Lib目录中
备注:
    运行结果三种:
    ok  表示用例执行通过
    F   表示用例执行失败
    E   表示代码错误
"""
import os
import unittest
import HTMLTestRunner
import time

# 1.确定测试用例存放路径
case_path = "./testcase"

# 2.将测试文件夹中的测试用例添加到测试套件中
discover = unittest.defaultTestLoader.discover(case_path, pattern="test*.py")

# 3.执行测试用例并生成测试报告
# 3.1 确定测试报告存放路径
report_path = "./report"

# 3.2 确定测试报告名称
now = time.strftime("%Y_%m_%d %H-%M-%S")
# 测试报告文件名
report_file = report_path + "/" + now + "report.html"  

# 打开文件并写入数据
with open(report_file, "wb") as fp:
    # 实例化
    """
        title：报告的标题
        description：报告的描述
        stream:执行结果全部卸载该文件纵
        verbosity：报告的详细程度，0.1.2 ，2为最详细
        retry：重试，这个功能是坏的，不能用。
    """
    runner = HTMLTestRunner.HTMLTestRunner(
        title="ECShop项目web自动化测试报告",
        description="ECShop登录功能",
        verbosity=2,
        stream=fp
    )
    runner.run(discover)

4、封装成模块

# coding=utf-8
import time
import os
import unittest
import HTMLTestRunner

# 定位测试用例目录(可以再封装)
project_dir = os.path.abspath(os.path.dirname(os.path.abspath(__file__)) + '\..')
testcase_dir = project_dir + r"\testcase"

def creatsuite():
    '''获取测试集'''
    # 搜索测试用例
    testcases = unittest.defaultTestLoader.discover(testcase_dir, pattern="test*.py", top_level_dir=None)
    return testcases

def run(title=u'自动化测试报告', description=u'环境配置等信息'):
    """执行测试并生成报告"""

    # 如果没有测试报告目录自动创建
    for filename in os.listdir(project_dir):
        if filename == "reports":
            break
    else:
        os.mkdir(project_dir + r'\reports')

    # 执行测试用例并生成测试报告
    # 1 确定测试报告存放路径
    report_path = project_dir + r'\reports'
    print(report_path)
    # 2 确定测试报告名称
    now = time.strftime("%Y_%m_%d_%H-%M-%S")
    report_file = report_path + "\\" + now + "report.html"  # 测试报告文件名

    # 打开文件并写入
    with open(report_file, "wb") as fp:
        # 实例化
        """
            title：报告的标题
            description：报告的描述
            stream:执行结果全部卸载该文件纵
            verbosity：报告的详细程度，0.1.2 ，2为最详细
            retry：重试，这个是坏的，不能用
        """
        runner = HTMLTestRunner.HTMLTestRunner(
            title=title,
            description=description,
            verbosity=2,
            stream=fp
        )
        runner.run(creatsuite())

if __name__ == '__main__':
    run()
    """
    封装成目录，如果需要生成报告的测试，
    直接调用该模块中的run()方法即可。

    例如：
        # 引入模块
        from util import TestRunnerReport

        # 执行测试用例
        TestRunnerReport.run(title='ewr',description='123131')

    注意：这里只是提供一种封装的思路，仅供参考，
        可以根据自己的情况按需封装。
    """