【PyTest】玩转HTML报告：修改、汉化和优化_pytest html报告设置 errors

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新软件测试全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注软件测试）

正文

• pytest.main(['-sv', "D:\PythonTest\MyPytestHtml\pytest_html_optimization", "--html", "report.html"])

原始报告

修改Environment

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

我们需要在项目的根目录新键contest.py文件，文件中添加如下代码

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

修改后的效果

修改Summary

原始的Summary部分只显示了测试用例数及用例执行时间，那么如果我们想在这个位置添加测试人员等一些信息该如何实现？同样在conftest.py文件中添加如下代码

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

修改后的效果

修改Results

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

优化Test

先手我们分析一波源码，看一下原始的测试报告的Test列表的信息是怎么生成的。找到我们pytest-html插件的安装位置，打开plugin.py文件，你会发现这样一块代码

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

第3行，5行，就是报告中Test信息的来源了，test_pytest_html.py::TestLogin::test_login[data0] 这样一条信息，实际是用例的nodeid，而【data0】是测试用例参数化时的每个参数，ids的作用主要就是用来标记测试用例(不知道的可以去看一下那篇文章)，增加测试用例执行后输出信息的可读性，因此我们可以使用这个参数来改变【data0】，让它显示我们的测试数据，ok，在我们的测试代码中添加并修改如下代码

1. # 改变输出结果
2. ids = [
3. "测试：{}->[用户名:{}-密码:{}-预期:{}]".
4. format(data["case"], data["user"], data["pwd"], data["expected"]) for data in test_data
5. ]
6. • 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"]

修改完之后再次执行我们的测试代码，生成测试报告

很遗憾，中文部分显示的都是乱码，还得继续修改

解决中文乱码

在conftest.py文件中继续添加如下代码

1. import pytest
2. from py._xmlgen import html
3. • • @pytest.mark.hookwrapper

• def pytest_runtest_makereport(item):
• outcome = yield
• report = outcome.get_result()
• getattr(report, 'extra', [])
• report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape") # 解决乱码

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

中文已经可以正常显示了，很开心，但是前面还是有一堆的目录及测试类，我仍然不想要，那么我们继续修改

删除多余部分

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

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

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

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

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

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

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

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

1. function init () {
2. reset_sort_headers();
3. • 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)
• });
• // 修改用例报告显示的用例名称 add by linux静
• 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";
• }
• • };

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

修改后的效果

你没有看错，确实成功了，小小成就感还是有的，哈哈！

删除Links

报告中的links从来没看见有内容过，所以我打算把这一列删除，在contest.py文件中添加如下代码

1. @pytest.mark.optionalhook
2. def pytest_html_results_table_header(cells):
3. cells.pop(-1) # 删除link列
4. • • @pytest.mark.optionalhook

• def pytest_html_results_table_row(report, cells):
• cells.pop(-1) # 删除link列

修改后的效果

增加失败截图与用例描述

用例添加失败截图和添加一列用例的描述信息，在之前文章中已经说过了，所以你可以通过以下链接去看我之前的文章，错误截图只有web自动化测试才会有哦

完整的conftest.py代码

仅供参考

1. """
2. ------------------------------------
3. @Time : 2019/8/28 19:50
4. @Auth : linux超
5. @File : conftest.py
6. @IDE : PyCharm
7. @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
8. @QQ : 28174043@qq.com
9. @GROUP: 878565760
10. ------------------------------------
11. """
12. import pytest
13. from selenium import webdriver
14. from py._xmlgen import html
15. • driver = None

• • • @pytest.mark.hookwrapper
• def pytest_runtest_makereport(item):
• """当测试失败的时候，自动截图，展示到html报告中"""
• outcome = yield
• pytest_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;" ' \
• # 'onclick="window.open(this.src)" align="right"/></div>' % screen_img
• # extra.append(pytest_html.extras.html(html))
• # report.extra = extra
• extra.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_Home
• config._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 driver
• print('------------open browser------------')
• driver = webdriver.Firefox()
• • yield driver
• print('------------close browser------------')
• driver.quit()

汉化报告

最后一步，汉化我们的测试报告，因为都是英文的，可能有的同学不太喜欢或者说领导不太喜欢，接下来就开始我们的汉化之路，汉化还是比较简单的， 只要小心谨慎即可

声明：以下修改的所有文件均存在pytest-html插件的源码目录下

修改plugin.py

plugin.py文件主要用来生成测试报告的html代码的，因此汉化肯定离不开修改这个文件了，接下来一步一步按照我的步骤修改吧(注释部分是源码，紧接着的是我修改后的代码)

1. # if len(log) == 0:
2. # log = html.div(class_='empty log')
3. # log.append('No log output captured.')
4. if len(log) == 0: # modify by linux超
5. log = html.div(class_='empty log')
6. log.append('未捕获到日志')
7. additional_html.append(log)
8. # head = html.head(
9. # html.meta(charset='utf-8'),
10. # html.title('Test Report'),
11. # html_css)
12. head = html.head( # modify by linux超
13. html.meta(charset='utf-8'),
14. html.title('测试报告'),
15. html_css)
16. # outcomes = [Outcome('passed', self.passed),
17. # Outcome('skipped', self.skipped),
18. # Outcome('failed', self.failed),
19. # Outcome('error', self.errors, label='errors'),
20. # Outcome('xfailed', self.xfailed,
21. # label='expected failures'),
22. # Outcome('xpassed', self.xpassed,
23. # label='unexpected passes')]
24. outcomes = [Outcome('passed', self.passed, label="通过"),
25. Outcome('skipped', self.skipped, label="跳过"),
26. Outcome('failed', self.failed, label="失败"),
27. Outcome('error', self.errors, label='错误'),
28. Outcome('xfailed', self.xfailed,
29. label='预期失败'),
30. Outcome('xpassed', self.xpassed,
31. label='预期通过')]
32. # if self.rerun is not None:
33. # outcomes.append(Outcome('rerun', self.rerun))
34. if self.rerun is not None:
35. outcomes.append(Outcome('重跑', self.rerun))
36. • # summary = [html.p(

• # '{0} tests ran in {1:.2f} seconds. '.format(
• # numtests, suite_time_delta)),
• # html.p('sfsf',

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注软件测试）

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
36. -# summary = [html.p(`

• # '{0} tests ran in {1:.2f} seconds. '.format(
• # numtests, suite_time_delta)),
• # html.p('sfsf',

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注软件测试）
[外链图片转存中…(img-zZmRWyuM-1713176929766)]

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！