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

发表于:2022-4-26 09:32

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:Edisonyao    来源:博客园

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

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

  命令行安装
  建议先在命令行中切换到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=报告名称 要执行的脚本文件  ,执行上述脚本查看结果。

  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")

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

  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号