如何使用Pytest生成HTML测试报告及优化？

lsekfe

一、安装插件
　　要生成html类型的报告，需要使用pytest-html插件，可以在IDE中安装，也可以在命令行中安装。插件安装
　　的位置涉及到不同项目的使用，这里不再详述，想了解的可自行查询。
　　IDE中安装
　　在File>Settings>Project>Project Interpreter界面，点击“ + ”搜索pytest-html即可进行安装。

命令行安装
　　建议先在命令行中切换到python安装路径“ Lib\site-packages ”目录，再执行安装命令。

1. pip install -U pytest-html

复制代码

二、生成html报告
　　先准备一个简单的执行脚本：

1. import pytest
   
2. 
   
3. 
   
4. def fun(x):
   
5.     return x + 1
   
6. 
   
7. def test_answer_1():
   
8.     """测试断言一"""
   
9.     assert fun(3) == 4
   
10. def test_answer_2():
    
11.     """测试断言二"""
    
12.     assert fun(5) == 7
    
13. 
    
14. @pytest.mark.parametrize("test_input,expected",[
    
15.     ("3+5",8),
    
16.     ("2+4",6),
    
17.     pytest.param("6 * 9",42,marks=pytest.mark.xfail),
    
18.     pytest.param("6 * 6",42,marks=pytest.mark.skip)
    
19. ])
    
20. 
    
21. def test_mark(test_input,expected):
    
22.     """用例集合"""
    
23.     assert eval(test_input) == expected
    
24. 
    
25. if __name__ == '__main__':
    
26.     pytest.main(['-v','--html=report.html','test_08.py'])

复制代码

生成报告命令 pytest --html=报告名称 要执行的脚本文件  ，执行上述脚本查看结果。

report.html：报告名称，[url=]记录[/url]报告生成时间以及插件版本
　　Environment：测试环境
　　Summary：用例统计
　　Results：测试结果，点击Show all details / Hide all details可以展开结果详情或收缩全部结果
　　三、使用小技巧
　　指定路径
　　通过上述命令运行脚本后可以发现，测试报告保存在项目的根目录下，查找报告比较繁琐。我们可以在运行命令中指定报告路径 pytest -v --html=./outputs/report.html test_08.py ，代码执行完成，可以发现项目根目录下生成了outputs文件，测试报告也在其中。
　　报告独立
　　当本地执行完成，想把测试报告分享出去，却发现分享出去的报告打开后样式丢失。因为代码执行完成会生成assets文件，将CSS保存在了本地。我们可以通过命令将CSS写入HTML中，这样生成的测试报告就能对外分享了。

1. pytest -v --html=./outputs/report.html --self-contained-html test_08.py

复制代码

四、报告优化
　　在实际的工作中，通过上述操作生成的测试报告一般不是我们想要的结果。环境信息通过增减更换成需
　　要展示的内容、增加用例描述、去掉多余的列等等。这里需要将优化代码写入conftest.py文件，该文件名是固
　　定的不可更改。
　　导入引用包：

1. import pytest
   
2. from py._xmlgen import html
   
3. from datetime import datetime

复制代码

修改测试环境：

1. @pytest.mark.parametrize
   
2. def pytest_configure(config):
   
3.     config._metadata.pop("JAVA_HOME") # 删除java_home
   
4.     config._metadata["项目名称"] = "引擎自动化" # 添加项目名称
   
5.     config._metadata["接口地址"] = "https://www.example.com/poke" # 添加接口地址

复制代码

修改用例统计：

1. @pytest.mark.parametrize
   
2. def pytest_html_results_summary(prefix,summary,postfix):
   
3.     prefix.extend([html.p("所属部门：测试组")])
   
4.     prefix.extend([html.p("测试人员：许卫玲")])

复制代码

修改结果显示：

1. @pytest.mark.optionalhook
   
2. def pytest_html_results_table_header(cells):
   
3.     cells.insert(1,html.th("Description")) # 表头添加Description
   
4.     cells.insert(2,html.th("Time",class_="sortable time",col="time"))
   
5.     cells.pop(-1) # 删除link
   
6. 
   
7. @pytest.mark.optionalhook
   
8. def pytest_html_results_table_row(report,cells):
   
9.     cells.insert(1,html.td(report.description)) # 表头对应的内容
   
10.     cells.insert(2,html.td(datetime.now(),class_="col-time"))
    
11.     cells.pop(-1) # 删除link
    
12. 
    
13. @pytest.mark.hookwrapper
    
14. def pytest_runtest_makereport(item,call): # Description取值为用例说明__doc__
    
15.     outcome = yield
    
16.     report = outcome.get_result()
    
17.     report.description = str(item.function.__doc__)
    
18.     report.nodeid = report.nodeid.encode("utf-8").decode("unicode_escape")

复制代码

修改完成，重新执行脚本，查看最终效果。