如何使用Pytest生成一份完美的测试报告

古城微笑少年丶 2024-03-23 11:46 54阅读 0赞

### 安装插件 ###

要生成HTML类型的报告，需要使用pytest-html插件，可以在IDE中安装，也可以在命令行中安装。插件安装的位置涉及到不同项目的使用，这里不再详述，想了解的可自行查询。

### IDE中安装 ###

在File>Settings>Project>Project Interpreter界面，点击“ + ”搜索pytest-html即可进行安装。

![342eb0f167c641eea5987c7368796f80.png][]

**命令行安装**

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

pip install -U pytest-html

（左右滑动查看完整代码）

**生成html报告**

先准备一个简单的执行脚本：

import pytest
    
    
    def fun(x):
        return x + 1
    
    
    def test_answer_1():
        """测试断言一"""
        assert fun(3) == 4
    def test_answer_2():
        """测试断言二"""
        assert fun(5) == 7
    
    
    @pytest.mark.parametrize("test_input,expected",[
        ("3+5",8),
        ("2+4",6),
        pytest.param("6 * 9",42,marks=pytest.mark.xfail),
        pytest.param("6 * 6",42,marks=pytest.mark.skip)
    ])
    
    
    def test_mark(test_input,expected):
        """用例集合"""
        assert eval(test_input) == expected
    
    
    if __name__ == '__main__':
        pytest.main(['-v','--html=report.html','test_08.py'])

（左右滑动查看完整代码）

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

![f52eb9c8c00247179b8dfe84ed7545a4.png][]

*  report.html：报告名称，记录报告生成时间以及插件版本；
 *  Environment：测试环境；
 *  Summary：用例统计；
 *  Results：测试结果，点击Show all details / Hide all details可以展开结果详情或收缩全部结果。

#### 使用小技巧 ####

#### 指定路径 ####

通过上述命令运行脚本后可以发现，测试报告保存在项目的根目录下，查找报告比较繁琐。

我们可以在运行命令中指定报告路径 pytest -v --html=./outputs/report.html test\_08.py ，代码执行完成，可以发现项目根目录下生成了outputs文件，测试报告也在其中。

#### 报告独立 ####

当本地执行完成，想把测试报告分享出去，却发现分享出去的报告打开后样式丢失。

因为代码执行完成会生成assets文件，将CSS保存在了本地。我们可以通过命令将CSS写入HTML中，这样生成的测试报告就能对外分享了。

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

（左右滑动查看完整代码）

**报告优化**

在实际的工作中，通过上述操作生成的测试报告一般不是我们想要的结果。

环境信息通过增减更换成需要展示的内容、增加用例描述、去掉多余的列等等。这里需要将优化代码写入conftest.py文件，该文件名是固定的不可更改。

**导入引用包：**

import pytest
    from py._xmlgen import html
    from datetime import datetime

（左右滑动查看完整代码）

**修改测试环境：**

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

（左右滑动查看完整代码）

**修改用例统计：**

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

（左右滑动查看完整代码）

**修改结果显示：**

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

（左右滑动查看完整代码）

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

![411b26bbe1ff418aa7b7c0b1a8be365a.png][]

**End**

**最后感谢每一个认真阅读我文章的人，看着粉丝一路的上涨和关注，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走**

![626d31455646428eb4e13ef366479b01.png][]

这些资料，对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！凡事要趁早，特别是技术行业，一定要提升技术功底。希望对大家有所帮助……

![f24bc2a0525847a495a6854650d8620c.png][]

[342eb0f167c641eea5987c7368796f80.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e103108db3f44376bfea0d38a3a9eeee.png
[Python]: https://so.csdn.net/so/search?q=Python%E5%AE%89%E8%A3%85&spm=1001.2101.3001.7020
[f52eb9c8c00247179b8dfe84ed7545a4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/a00fe8994d434db7bb4905352ea509bc.png
[411b26bbe1ff418aa7b7c0b1a8be365a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/a6fa6ab47fb648e18597f9e71c24d327.png
[626d31455646428eb4e13ef366479b01.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/5cb58e5264264c468fa44415b8c02a19.png
[f24bc2a0525847a495a6854650d8620c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/517a634e61124175ad3150788dfdcaa4.png