第十五：Pytest-html报告修改与汉化

1.前言

1.1.Pytest框架可以使用两种测试报告，其中一种就是使用pytest-html插件生成的测试报告，但是报告中有一些信息没有什么用途或者显示的不太好看，还有一些想要在报告中展示的信息却没有，最近又有人问我pytest-html生成的报告，能不能汉化？

2.生成报告（和python2.7配合使用无法生成报告】）

2.1.test_pytest_html.py

import pytestdef login(username, password):"""模拟登录"""user = "linux超"pwd = "linux超哥"if user == username and pwd == password:return {"code": 1001, "msg": "登录成功", "data": None}else:return {"code": 1000, "msg": "用户名或密码错误", "data": None}test_data = [# 测试数据{"case": "用户名正确, 密码正确","user": "linux超","pwd": "linux超哥","expected": {"code": 1001, "msg": "登录成功", "data": None}},{"case": "用户名正确, 密码为空","user": "linux超","pwd": "","expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}},{"case": "用户名为空, 密码正确","user": "","pwd": "linux超哥","expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}},{"case": "用户名错误, 密码错误","user": "linux","pwd": "linux","expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}}
]class TestLogin(object):@pytest.mark.parametrize("data", test_data)def test_login(self, data):result = login(data["user"], data["pwd"])assert result == data["expected"]if __name__ == '__main__':pytest.main(['-sv', "D:\PythonTest\MyPytestHtml\pytest_html_optimization", "--html", "report.html"])

2.2.原始报告。

3.修改Environment

3.1.可以看到原始的测试报告里面的Environment中所有的信息和被测系统的环境关系不是很大，主要的信息其实是一些开发环境，那么如果想添加或者删除一些信息，比如删除Java_Home，添加测试接口地址该如何添加讷？

3.2.在项目的根目录新键conftest.py文件

def pytest_configure(config):# 添加接口地址与项目名称config._metadata["项目名称"] = "Linux超博客园自动化测试项目v1.0"config._metadata['接口地址'] = 'https://www.cnblogs.com/linuxchao/'# 删除Java_Homeconfig._metadata.pop("JAVA_HOME")

3.3.修改后的效果

4.修改Summary

4.1.原始的Summary部分只显示了测试用例数及用例执行时间，那么如果想在这个位置添加测试人员等一些信息该如何实现？

4.2.conftest.py文件

@pytest.mark.optionalhook
def pytest_html_results_summary(prefix):prefix.extend([html.p("所属部门: xx测试中心")])prefix.extend([html.p("测试人员: Linux超")])

4.3.修改后的效果

5.修改Results

5.1.Results主要展示的是测试结果信息，而且这里也有一些不符合实际需求的信息，比如Test列显示的内容很长，它主要是测试用例所在的路径及测试类，测试用例及测试数据拼接而成的，可读性很差，从这个描述根本看不出来的测试用例测试的是什么，所以我们希望它能这样显示：测试+用例名称[user：用户名-pwd：密码] ，如：测试用户名正确，密码正确[user：Linux超-pwd：Linux超哥]，下面我们就来实现这样的效果。

6.优化Test

6.1.原始的测试报告的Test列表的信息是怎么生成的。找到pytest-html插件的安装位置，打开plugin.py文件。

1    class TestResult:
2         def __init__(self, outcome, report, logfile, config):
3             self.test_id = report.nodeid
4             if getattr(report, "when", "call") != "call":
5                 self.test_id = "::".join([report.nodeid, report.when])
6             self.time = getattr(report, "duration", 0.0)
7             self.outcome = outcome

6.2.第3行，5行，就是报告中Test信息的来源了，test_pytest_html.py::TestLogin::test_login[data0] 这样一条信息，实际是用例的nodeid，而【data0】是测试用例参数化时的每个参数。其中参数化方法@pytest.mark.parametrize(“data”, test_data)的参数ids的作用主要就是用来标记测试用例(第9篇文章)，增加测试用例执行后输出信息的可读性，因此可以使用这个参数来改变【data0】，让它显测试数据。

# 改变输出结果
ids = ["测试：{}->[用户名:{}-密码:{}-预期:{}]".format(data["case"], data["user"], data["pwd"], data["expected"]) for data in test_data
]class TestLogin(object):# 添加ids参数@pytest.mark.parametrize("data", test_data, ids=ids)def test_login(self, data):result = login(data["user"], data["pwd"])assert result == data["expected"]

6.3.修改完之后再次执行，生成测试报告。

6.4.中文部分显示的都是乱码。

6.5.解决中文乱码。

6.6.conftest.py文件

import pytest
from py._xmlgen import html@pytest.mark.hookwrapper
def pytest_runtest_makereport(item):outcome = yieldreport = outcome.get_result()getattr(report, 'extra', [])report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape")  # 解决乱码

6.7.再次执行测试代码，查看报告输出。

7.删除多余部分

7.1.要删除前面多余的部分，接下来只能通过修改报告的html了，因为源码中实在没找到在哪里能够修改这个显示，查看一下html报告的页面元素属性。

7.2.看到这里，想到用什么方法来修改了嘛？想到的是使用js代码改变这个元素的innerText，先实验一下，切换到【控制台】依次执行如下代码。

// 找到Test列中所有的表格元素
var test_name = document.getElementBysClassName("col-name");
// 修改第1个表格的innerText属性
test_name[0].innerText = test_name[0].innerText.split("\[")[1].split(["\]")[0];  // 以[符号分割一次，再以]分割一次，得到目标字符串

7.3.以上带代码只能修改一个表格，所以要修改多个表格只能使用循环了，再次重写js代码。

var case_name_td = document.getElementsByClassName("col-name")for(var i = 0; i < case_name_td.length; i++)try{case_name_td[i].innerText = case_name_td[i].innerText.split("\[")[1].split("\]")[0];}catch(err){// 如果表格中没有[]会抛异常，如果抛异常我就显示null，如果你想显示别的东西自己改吧，因为通常只要我们使用参数化就有[]显示case_name_td[i].innerText = "null";}

7.4.js代码写好了但是要放在哪里，又是个问题？通过查看报告的html源码发现在html代码的开头引入了这样一些代码。

7.5.在pytest-html插件的源码中，发现插件的resource目录下有一个main.js文件，里面的代码就是上述html代码中的js脚本，一模一样的。

7.6.而且在main.js中确实存在一个init()方法，通过以上分析，应该不难猜测生成测试报告时，会自动把main.js文件加载到html中，而且是从init()方法开始的，因此尝试一下把编写的js代码放到init()方法内部实验一下。

function init () {reset_sort_headers();add_collapse();show_filters();toggle_sort_states(find('.initial-sort'));find_all('.sortable').forEach(function(elem) {elem.addEventListener("click",function(event) {sort_column(elem);}, false)});// 修改用例报告显示的用例名称var case_name_td = document.getElementsByClassName("col-name")for(var i = 0; i < case_name_td.length; i++)try{case_name_td[i].innerText = case_name_td[i].innerText.split("\[")[1].split("\]")[0];}catch(err){// 如果表格中没有[]会抛异常，如果抛异常我就显示null，如果你想显示别的东西自己改吧，因为通常只要我们使用参数化就有[]显示case_name_td[i].innerText = "null";}};

7.7.添加完之后保存，再次执行测试代码，查看测试报告。

8.删除Links

8.1.报告中links从没看见有内容过，所以把这一列删除。

8.2.conftest.py文件

@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):cells.pop(-1)  # 删除link列@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):cells.pop(-1)  # 删除link列

8.3.修改后的效果。

9.增加失败截图与用例描述。

9.1.用例添加失败截图和添加一列用例的描述信息，在之前文章中已经说过了。

https://blog.csdn.net/hyq413950612/article/details/123743418?spm=1001.2014.3001.5502

https://blog.csdn.net/hyq413950612/article/details/123790898

10.完整的conftest.py文件

import pytest
from selenium import webdriver
from py._xmlgen import htmldriver = None@pytest.mark.hookwrapper
def pytest_runtest_makereport(item):"""当测试失败的时候，自动截图，展示到html报告中"""outcome = yieldpytest_html = item.config.pluginmanager.getplugin('html')report = outcome.get_result()extra = getattr(report, 'extra', [])# 如果你生成的是web ui自动化测试，请把下面的代码注释打开，否则无法生成错误截图# if report.when == 'call' or report.when == "setup":#     xfail = hasattr(report, 'wasxfail')#     if (report.skipped and xfail) or (report.failed and not xfail):  # 失败截图#         file_name = report.nodeid.replace("::", "_") + ".png"#         screen_img = capture_screenshot()#         if file_name:#             html = '<div><img src="data:image/png;base64,%s" alt="screenshot" style="width:600px;height:300px;" ' \#                    'οnclick="window.open(this.src)" align="right"/></div>' % screen_img#             extra.append(pytest_html.extras.html(html))#     report.extra = extraextra.append(pytest_html.extras.text('some string', name='Different title'))report.description = str(item.function.__doc__)report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape")  # 解决乱码def capture_screenshot():'''截图保存为base64'''return driver.get_screenshot_as_base64()def pytest_configure(config):# 添加接口地址与项目名称config._metadata["项目名称"] = "Linux超博客园自动化测试项目v1.0"config._metadata['接口地址'] = 'https://www.cnblogs.com/linuxchao/'# 删除Java_Homeconfig._metadata.pop("JAVA_HOME")@pytest.mark.optionalhook
def pytest_html_results_summary(prefix):prefix.extend([html.p("所属部门: xx测试中心")])prefix.extend([html.p("测试人员: Linux超")])@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):cells.insert(1, html.th('Description'))cells.pop(-1)  # 删除link列@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):cells.insert(1, html.td(report.description))cells.pop(-1)  # 删除link列@pytest.fixture(scope='session')
def driver():global driverprint('------------open browser------------')driver = webdriver.Firefox()yield driverprint('------------close browser------------')driver.quit()

11.汉化报告。

11.1.以下修改的所有文件均存在pytest-html插件的源码目录。

11.2.修改plugin.py：plugin.py文件主要用来生成测试报告的html代码的，因此汉化肯定离不开修改这个文件了。

# if len(log) == 0:
#     log = html.div(class_='empty log')
#     log.append('No log output captured.')
if len(log) == 0:log = html.div(class_='empty log')log.append('未捕获到日志')
additional_html.append(log)

# head = html.head(
#     html.meta(charset='utf-8'),
#     html.title('Test Report'),
#     html_css)
head = html.head(html.meta(charset='utf-8'),html.title('测试报告'),html_css)

# outcomes = [Outcome('passed', self.passed),
#             Outcome('skipped', self.skipped),
#             Outcome('failed', self.failed),
#             Outcome('error', self.errors, label='errors'),
#             Outcome('xfailed', self.xfailed,
#                     label='expected failures'),
#             Outcome('xpassed', self.xpassed,
#                     label='unexpected passes')]
outcomes = [Outcome('passed', self.passed, label="通过"),Outcome('skipped', self.skipped, label="跳过"),Outcome('failed', self.failed, label="失败"),Outcome('error', self.errors, label='错误'),Outcome('xfailed', self.xfailed,label='预期失败'),Outcome('xpassed', self.xpassed,label='预期通过')]

# if self.rerun is not None:
#     outcomes.append(Outcome('rerun', self.rerun))
if self.rerun is not None:outcomes.append(Outcome('重跑', self.rerun))# summary = [html.p(
#     '{0} tests ran in {1:.2f} seconds. '.format(
#         numtests, suite_time_delta)),
#     html.p('sfsf',
#            class_='filter',
#            hidden='true')]
summary = [html.p('执行了{0}个测试用例, 历时:{1:.2f}秒 . '.format(numtests, suite_time_delta)),html.p('(取消)勾选复选框, 以便筛选测试结果',class_='filter',hidden='true')]

# cells = [
#     html.th('Result',
#             class_='sortable result initial-sort',
#             col='result'),
#     html.th('Test', class_='sortable', col='name'),
#     html.th('Duration', class_='sortable numeric', col='duration'),
#     html.th('Links')]
cells = [html.th('通过/失败',class_='sortable result initial-sort',col='result'),html.th('用例', class_='sortable', col='name'),html.th('耗时', class_='sortable numeric', col='duration'),html.th('链接')]

# results = [html.h2('Results'), html.table([html.thead(
#     html.tr(cells),
#     html.tr([
#         html.th('No results found. Try to check the filters',
#                 colspan=len(cells))],
#             id='not-found-message', hidden='true'),
#     id='results-table-head'),
#     self.test_logs], id='results-table')]
results = [html.h2('测试结果'), html.table([html.thead(html.tr(cells),html.tr([html.th('无测试结果, 试着选择其他测试结果条件',colspan=len(cells))],id='not-found-message', hidden='true'),id='results-table-head'),self.test_logs], id='results-table')]

#html.p('Report generated on {0} at {1} by '.format(
html.p('生成报告时间{0} {1} Pytest-Html版本：'.format(

# body.extend([html.h2('Summary')] + summary_prefix
#             + summary + summary_postfix)
body.extend([html.h2('用例统计')] + summary_prefix  + summary + summary_postfix)

# environment = [html.h2('Environment')]
environment = [html.h2('测试环境')]

11.3.plugin.py文件到这就修改完，在生成报告查看下效果。

11.4.修改main.js文件。

/*
function add_collapse() {// Add links for show/hide allvar resulttable = find('table#results-table');var showhideall = document.createElement("p");showhideall.innerHTML = '<a href="javascript:show_all_extras()">Show all details</a> / ' +'<a href="javascript:hide_all_extras()">Hide all details</a>';resulttable.parentElement.insertBefore(showhideall, resulttable);
*/
function add_collapse() { // Add links for show/hide allvar resulttable = find('table#results-table');var showhideall = document.createElement("p");showhideall.innerHTML = '<a href="javascript:show_all_extras()">显示详情</a> / ' +'<a href="javascript:hide_all_extras()">隐藏详情</a>';resulttable.parentElement.insertBefore(showhideall, resulttable);

11.5.修改style.css文件：这个文件主要用来美化测试报告的。

.expander::after {content: " (展开详情)";color: #BBB;font-style: italic;cursor: pointer;
}
.collapser::after {content: " (隐藏详情)";color: #BBB;font-style: italic;cursor: pointer;
}

11.6.最后报告效果。

12.安装汉化版插件

12.1.为了方便大家使用，跳过修改源码过程，已经把汉化版的pytest-html插件源码上传到了GitHub。

https://github.com/13691579846/pytest-html

12.2.方法一：

1.如果你已经安装过了pytest-html，请先卸载 pip uninstall pytest-html

2.下载插件源码到本地，git clone https://github.com/13691579846/pytest-html 或者按照下图方法下载。

3.打开CMD切换到插件中setup.py文件所在目录，执行如下命令python setup.py install

12.3.方法二：

1.如果未安装过pytest-html插件，请先执行如下命令安装
pip install pytest-html

2.按照方法1的方式下载汉化后的插件，把下载后的插件中的部分分件覆盖到python第三方库目录下pytest-html下的部分文件

12.4.方法三：

1.直接下载汉化后的源码，把源码中的pytest_html直接丢到python第三方库存放目录也可。

12.5.方法四：

1.按照文章步骤，一步一步修改自己的源码

12.6.方法五：

1.下载pytest源码后使用pip install ./pytest-html 安装。

13.参考地址：

1.pytest-html管网

2.https://pypi.org/project/pytest-html/

3.https://github.com/pytest-dev/pytest-html

第十五：Pytest-html报告修改与汉化相关推荐

星历表ASC2EPH修改且汉化
C ********************************************************************************** C PARAMETER ( N ...
Android对现有的apk进行修改（汉化，修改QQ尾巴）
我们可以用压缩软件把apk打开,对一些apk进行简单的修改,比如说替换掉里面的原有图片,换成自己喜欢的(ps:图片名字必须一样),对一些国外的软件进行汉化,然后在利用辅助软件对修改过的apk进行再次签 ...
python连载第十五篇~史上最全列表知识源码+答案
#2017-12-19 19:34:41 December Tuesday the 51 week, the 353 day #python连载第十五篇~list列表#列表定义,访问,索引,操作,切片 ...
求索十五载：百度地图绘就的时代浪漫
无论是大航海时期,欧洲人用羊皮卷绘制的南极地图,还是<周礼>中记载的,"掌九州之图,以知其山林川泽之阻":无论是国家大事,如苏秦为了说服赵王而"以天下地图案之 ...
Jmeter的Html报告汉化及解析
经常有人提出Jmeter生成的html报告都是英文的看不懂,能不能给解释一下,一般提出这种问题的人要么是懒,要么是对性能测试不是很了解(隔行如隔山嘛,可以理解).所以我专门整理了Jmeter报告的汉化 ...
第十五届智能车竞赛技术报告-成电金秋-AI电磁
01引言 1.1 大赛介绍全国大学生"恩智浦"杯智能汽车竞赛是以"立足培养.重在参与.鼓励探索.追求卓越"为宗旨,鼓励创新的一项科技竞赛活动.今年首次新增了 ...
第十五届全国大学生智能汽车竞赛全国总决赛提交技术报告通知
第十五届全国大学生智能汽车竞赛获得全国总决赛资格和创意比赛队伍提交技术报告的通知参加全国总决赛的竞速赛和创意赛的每支队伍必须提交竞赛车模制作技术报告. 这两个文档应在2019年8月27日前通过邮 ...
JavaScript学习（十五）—内部样式与外部样式的修改与设置
JavaScript学习(十五)-内部样式与外部样式的修改与设置 (一).行内样式获取方式:元素节点.style.CSS属性名称: 注意:如果CSS属性中包含"-",那么需要采用 ...
我的世界服务器群系修改,我的世界创世神教程第五十五节修改选区的生物群系|功能介绍|难点介绍|这节...
我的世界WorldEdit创世神高级系列教程第五十五节修改选区的生物群系.本教程由64条不同的技巧,功能介绍,难点介绍,防范措施介绍,工具介绍等组成.适合高级玩家和腐竹们来学习.这节内容给大家介绍修 ...

第十五：Pytest-html报告修改与汉化

第十五：Pytest-html报告修改与汉化相关推荐

最新文章

热门文章