【PyTest】玩转HTML报告：修改、汉化和优化

前言

Pytest框架可以使用两种测试报告，其中一种就是使用pytest-html插件生成的测试报告，但是报告中有一些信息没有什么用途或者显示的不太好看，还有一些我们想要在报告中展示的信息却没有，最近又有人问我pytest-html生成的报告，能不能汉化？答案是肯定的，那么今天就教大家如何优化和汉化pytest-html测试报告解决上述问题

生成报告

我们先编写一个简单的测试代码，生成一份原始的测试报告，来看看哪些需要修改

测试代码

1. test_pytest_html.py

3. """

4. ------------------------------------

5. @Time : 2019/8/28 19:45

6. @Auth : linux超

7. @File : test_pytest_html.py

8. @IDE : PyCharm

9. @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!

10. @QQ : 28174043@qq.com

11. @GROUP: 878565760

12. ------------------------------------

13. """

14. import pytest

17. def login(username, password):

18. """模拟登录"""

19. user = "linux静"

20. pwd = "linux静静"

21. if user == username and pwd == password:

22. return {"code": 1001, "msg": "登录成功", "data": None}

23. else:

24. return {"code": 1000, "msg": "用户名或密码错误", "data": None}

27. test_data = [

28. # 测试数据

29. {

30. "case": "用户名正确, 密码正确",

31. "user": "linux静",

32. "pwd": "linux静静",

33. "expected": {"code": 1001, "msg": "登录成功", "data": None}

34. },

35. {

36. "case": "用户名正确, 密码为空",

37. "user": "linux静",

38. "pwd": "",

39. "expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}

40. },

41. {

42. "case": "用户名为空, 密码正确",

43. "user": "",

44. "pwd": "linux静静",

45. "expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}

46. },

47. {

48. "case": "用户名错误, 密码错误",

49. "user": "linux",

50. "pwd": "linux",

51. "expected": {"code": 1000, "msg": "用户名或密码错误", "data": None}

52. }

53. ]

56. class TestLogin(object):

58. @pytest.mark.parametrize("data", test_data)

59. def test_login(self, data):

60. result = login(data["user"], data["pwd"])

61. assert result == data["expected"]

64. if __name__ == '__main__':

65. 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. ]

7. class TestLogin(object):

8. # 添加ids参数

9. @pytest.mark.parametrize("data", test_data, ids=ids)

10. def test_login(self, data):

11. result = login(data["user"], data["pwd"])

12. assert result == data["expected"]

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

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

解决中文乱码

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

1. import pytest

2. from py._xmlgen import html

5. @pytest.mark.hookwrapper

6. def pytest_runtest_makereport(item):

7. outcome = yield

8. report = outcome.get_result()

9. getattr(report, 'extra', [])

10. 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();

4. add_collapse();

6. show_filters();

8. toggle_sort_states(find('.initial-sort'));

10. find_all('.sortable').forEach(function(elem) {

11. elem.addEventListener("click",

12. function(event) {

13. sort_column(elem);

14. }, false)

15. });

16. // 修改用例报告显示的用例名称 add by linux静

17. var case_name_td = document.getElementsByClassName("col-name")

18. for(var i = 0; i < case_name_td.length; i++)

19. try{

20. case_name_td[i].innerText = case_name_td[i].innerText.split("\[")[1].split("\]")[0];

21. }

22. catch(err){

23. // 如果表格中没有[]会抛异常，如果抛异常我就显示null，如果你想显示别的东西自己改吧，因为通常只要我们使用参数化就有[]显示

24. case_name_td[i].innerText = "null";

25. }

27. };

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

修改后的效果

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

删除Links

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

1. @pytest.mark.optionalhook

2. def pytest_html_results_table_header(cells):

3. cells.pop(-1) # 删除link列

6. @pytest.mark.optionalhook

7. def pytest_html_results_table_row(report, cells):

8. 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

16. driver = None

19. @pytest.mark.hookwrapper

20. def pytest_runtest_makereport(item):

21. """当测试失败的时候，自动截图，展示到html报告中"""

22. outcome = yield

23. pytest_html = item.config.pluginmanager.getplugin('html')

25. report = outcome.get_result()

26. extra = getattr(report, 'extra', [])

27. # 如果你生成的是web ui自动化测试，请把下面的代码注释打开，否则无法生成错误截图

28. # if report.when == 'call' or report.when == "setup":

29. # xfail = hasattr(report, 'wasxfail')

30. # if (report.skipped and xfail) or (report.failed and not xfail): # 失败截图

31. # file_name = report.nodeid.replace("::", "_") + ".png"

32. # screen_img = capture_screenshot()

33. # if file_name:

34. # html = '<div><img src="data:image/png;base64,%s" alt="screenshot" style="width:600px;height:300px;" ' \

35. # 'onclick="window.open(this.src)" align="right"/></div>' % screen_img

36. # extra.append(pytest_html.extras.html(html))

37. # report.extra = extra

38. extra.append(pytest_html.extras.text('some string', name='Different title'))

39. report.description = str(item.function.__doc__)

40. report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape") # 解决乱码

43. def capture_screenshot():

44. '''截图保存为base64'''

45. return driver.get_screenshot_as_base64()

48. def pytest_configure(config):

49. # 添加接口地址与项目名称

50. config._metadata["项目名称"] = "Linux超博客园自动化测试项目v1.0"

51. config._metadata['接口地址'] = 'https://www.cnblogs.com/linuxchao/'

52. # 删除Java_Home

53. config._metadata.pop("JAVA_HOME")

56. @pytest.mark.optionalhook

57. def pytest_html_results_summary(prefix):

58. prefix.extend([html.p("所属部门: xx测试中心")])

59. prefix.extend([html.p("测试人员: Linux静")])

62. @pytest.mark.optionalhook

63. def pytest_html_results_table_header(cells):

64. cells.insert(1, html.th('Description'))

65. cells.pop(-1) # 删除link列

68. @pytest.mark.optionalhook

69. def pytest_html_results_table_row(report, cells):

70. cells.insert(1, html.td(report.description))

71. cells.pop(-1) # 删除link列

74. @pytest.fixture(scope='session')

75. def driver():

76. global driver

77. print('------------open browser------------')

78. driver = webdriver.Firefox()

80. yield driver

81. print('------------close browser------------')

82. 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))

37. # summary = [html.p(

38. # '{0} tests ran in {1:.2f} seconds. '.format(

39. # numtests, suite_time_delta)),

40. # html.p('sfsf',

41. # class_='filter',

42. # hidden='true')]

43. summary = [html.p( # modify by linux超

44. '执行了{0}个测试用例, 历时:{1:.2f}秒 . '.format(

45. numtests, suite_time_delta)),

46. html.p('(取消)勾选复选框, 以便筛选测试结果',

47. class_='filter',

48. hidden='true')]

49. # cells = [

50. # html.th('Result',

51. # class_='sortable result initial-sort',

52. # col='result'),

53. # html.th('Test', class_='sortable', col='name'),

54. # html.th('Duration', class_='sortable numeric', col='duration'),

55. # html.th('Links')]# modify by linux超

56. cells = [

57. html.th('通过/失败',

58. class_='sortable result initial-sort',

59. col='result'),

60. html.th('用例', class_='sortable', col='name'),

61. html.th('耗时', class_='sortable numeric', col='duration'),

62. html.th('链接')]

63. # results = [html.h2('Results'), html.table([html.thead(

64. # html.tr(cells),

65. # html.tr([

66. # html.th('No results found. Try to check the filters',

67. # colspan=len(cells))],

68. # id='not-found-message', hidden='true'),

69. # id='results-table-head'),

70. # self.test_logs], id='results-table')]

71. results = [html.h2('测试结果'), html.table([html.thead( # modify by linux超

72. html.tr(cells),

73. html.tr([

74. html.th('无测试结果, 试着选择其他测试结果条件',

75. colspan=len(cells))],

76. id='not-found-message', hidden='true'),

77. id='results-table-head'),

78. self.test_logs], id='results-table')]

79. #html.p('Report generated on {0} at {1} by '.format(

80. html.p('生成报告时间{0} {1} Pytest-Html版本：'.format( # modify by linux超

81. # body.extend([html.h2('Summary')] + summary_prefix

82. # + summary + summary_postfix)

83. body.extend([html.h2('用例统计')] + summary_prefix # modify by linux超

84. + summary + summary_postfix)

85. # environment = [html.h2('Environment')]

86. environment = [html.h2('测试环境')] # modify by linux超

plugin.py文件到这就修改完了，你可以生成报告查看以下效果，接下来修改main.js

修改main.js

1. /*

2. function add_collapse() {

3. // Add links for show/hide all

4. var resulttable = find('table#results-table');

5. var showhideall = document.createElement("p");

6. showhideall.innerHTML = '<a href="javascript:show_all_extras()">Show all details</a> / ' +

7. '<a href="javascript:hide_all_extras()">Hide all details</a>';

8. resulttable.parentElement.insertBefore(showhideall, resulttable);

9. */

10. function add_collapse() { // modify by linux超

11. // Add links for show/hide all

12. var resulttable = find('table#results-table');

13. var showhideall = document.createElement("p");

14. showhideall.innerHTML = '<a href="javascript:show_all_extras()">显示详情</a> / ' +

15. '<a href="javascript:hide_all_extras()">隐藏详情</a>';

16. resulttable.parentElement.insertBefore(showhideall, resulttable);

17. 修改style.css

最后修改style.css，这个文件主要用来美化测试报告的，如果你对css比较熟悉，可以自定义报告样式

1. .expander::after {

2. content: " (展开详情)";

3. color: #BBB;

4. font-style: italic;

5. cursor: pointer;

6. }

7. .collapser::after {

8. content: " (隐藏详情)";

9. color: #BBB;

10. font-style: italic;

11. cursor: pointer;

12. }

到目前为止，所有的汉化都已经完成了，接下来我们执行一下测试代码，查看一下报告的效果

最后报告效果

安装汉化版插件

为了方便大家使用，跳过修改源码过程，我已经把汉化版的pytest-html插件源码上传到了我的GitHub ，下面说一下使用方法

方法1

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

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

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

python setup.py install

方法2

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

pip install pytest-html

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

方法3

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

方法4

最后一个方法就是按照我的文章步骤，一步一步修改自己的源码

方法5

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

学习安排上

作为一位过来人也是希望大家少走一些弯路，如果你不想再体验一次学习时找不到资料，没人解答问题，坚持几天便放弃的感受的话，在这里我给大家分享一些自动化测试的学习资源，希望能给你前进的路上带来帮助。【保证100%免费】

视频文档获取方式：

这份文档和视频资料，对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！以上均可以分享，点下方小卡片即可自行领取。