从0到1精通自动化测试，pytest自动化测试框架，pytest-html报告优化（十五）

目录

一、前言

二、修改报告

三、添加Description

 四、代码参考

五、效果展示

---

一、前言

pytest-html测试报告默认是不展示用例描述Description内容，之前用unittest生成的报告是可以展示用例的描述，也就是test开头的用例下三个引号里面的注释（docstring）内容

pytest-html框架是可以修改生成的报告内容的，可以自己添加和删除html报告的table内容

二、修改报告

pytest-html官方文档地址【https://pypi.org/project/pytest-html/】
l可以通过为标题行实现自定义钩子来修改列，下面的示例在conftest.py脚本中使用测试函数docstring添加描述（Description）列，添加可排序时间（Time）列，并删除链接(Link)列：

from datetime import datetime
from py.xml import html
import pytest

@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):
    cells.insert(2, html.th('Description'))
    cells.insert(1, html.th('Time', class_='sortable time', col='time'))
    cells.pop()

@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):
    cells.insert(2, html.td(report.description))
    cells.insert(1, html.td(datetime.utcnow(), class_='col-time'))
    cells.pop()

@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    report.description = str(item.function.__doc__)

还可以通过pytest_html_results_table_row 挂钩删除所有单元格来删除结果。下面的示例从报表中删除所有测试通过的结果：

import pytest

@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):
    if report.passed:
      del cells[:]

日志输出和附加HTML可以通过pytest_html_results_table_html挂钩来修改。下面的示例清空测试通过的日志输出：

import pytest

@pytest.mark.optionalhook
def pytest_html_results_table_html(report, data):
    if report.passed:
        del data[:]
        data.append(html.div('No log output captured.', class_='empty log'))

三、添加Description

通过上面的官方文档，可以自己修改下测试报告，在报告里面添加一列的内容，添加到第二列，于是修改如下，红色代码全部注释掉

第三个@pytest.mark.hookwrapper，这个在之前测试报告里面添加截图时候，已经写过了，只需在最后加一句代码即可

report.description = str(item.function.doc)

 四、代码参考

from datetime import datetime
from py.xml import html
import pytest

@pytest.mark.hookwrapper
def pytest_runtest_makereport(item):
    """
    当测试失败的时候，自动截图，展示到html报告中
    :param item:
    """
    pytest_html = item.config.pluginmanager.getplugin('html')
    outcome = yield
    report = outcome.get_result()
    extra = getattr(report, 'extra', [])

    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;" ' \
                       'οnclick="window.open(this.src)" align="right"/></div>' % screen_img
                extra.append(pytest_html.extras.html(html))
        report.extra = extra
        report.description = str(item.function.__doc__)

@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):
    cells.insert(1, html.th('Description'))

@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):
    cells.insert(1, html.td(report.description))

五、效果展示

修改完之后cmd运行

pytest  —html=report.html —self-contained-html

---

          【下面是我整理的2023年最全的软件测试工程师学习知识架构体系图】

---

一、Python编程入门到精通

二、接口自动化项目实战  

三、Web自动化项目实战

四、App自动化项目实战 

五、一线大厂简历

六、测试开发DevOps体系 

七、常用自动化测试工具

八、JMeter性能测试 

九、总结（尾部小惊喜）

生命不息，奋斗不止。每一份努力都不会被辜负，只要坚持不懈，终究会有回报。珍惜时间，追求梦想。不忘初心，砥砺前行。你的未来，由你掌握！

生命短暂，时间宝贵，我们无法预知未来会发生什么，但我们可以掌握当下。珍惜每一天，努力奋斗，让自己变得更加强大和优秀。坚定信念，执着追求，成功终将属于你！

只有不断地挑战自己，才能不断地超越自己。坚持追求梦想，勇敢前行，你就会发现奋斗的过程是如此美好而值得。相信自己，你一定可以做到！

【软件测试技术交流（免费领取全套软件测试资料）】：320231853（备注C）http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=UBH4PjR4hSntDh18bIZXbg5jEI31_zVm&authKey=wLGsRx5vLPAVvPIjB2%2Fr7iqX94aprgV3J9KUkUR%2FDa6gpvNl0kgSj1AP8OlbtUvv&noverify=0&group_code=320231853