pytest学习和使用16-HTML报告如何生成？（pytest-html）

news2025/1/18 4:36:03

16-HTML报告如何生成？（pytest-html）

  • 1 插件介绍
  • 2 pytest-html安装
  • 3 生成报告
    • 3.1 插件执行方式
    • 3.2 执行效果
    • 3.3 指定报告生成的路径
  • 4 合并css
  • 5 报告中的行显示设置
  • 6 报告增强
    • 6.1 自定义css
    • 6.2 报告标题
    • 6.3 环境
    • 6.4 其他摘要信息
    • 6.5 Extra内容
    • 6.6 修改结果表

1 插件介绍

  • pytest-HTML是一个插件，pytest用于生成测试结果的HTML报告；
  • 这个插件需要进行安装。

2 pytest-html安装

  • 直接使用pip安装即可：
pip  install pytest-html
  • 安装信息如下：
C:\Users\Administrator>pip  install pytest-html
Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple
Requirement already satisfied: pytest-html in d:\python37\lib\site-packages (2.0.1)
Requirement already satisfied: pytest>=5.0 in d:\python37\lib\site-packages (from pytest-html) (6.2.4)
Requirement already satisfied: pytest-metadata in d:\python37\lib\site-packages (from pytest-html) (1.8.0)
Requirement already satisfied: colorama in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (0.4.4)
Requirement already satisfied: py>=1.8.2 in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (1.10.0)
Requirement already satisfied: atomicwrites>=1.0 in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (1.4.0)
Requirement already satisfied: importlib-metadata>=0.12 in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (2.1.1)
Requirement already satisfied: pluggy<1.0.0a1,>=0.12 in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (0.13.1)
Requirement already satisfied: toml in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (0.10.2)
Requirement already satisfied: packaging in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (20.8)
Requirement already satisfied: iniconfig in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (1.1.1)
Requirement already satisfied: attrs>=19.2.0 in d:\python37\lib\site-packages (from pytest>=5.0->pytest-html) (20.3.0)
Requirement already satisfied: zipp>=0.5 in d:\python37\lib\site-packages (from importlib-metadata>=0.12->pytest>=5.0->pytest-html) (1.2.0)
Requirement already satisfied: pyparsing>=2.0.2 in d:\python37\lib\site-packages (from packaging->pytest>=5.0->pytest-html) (2.4.7)
  • 插件版本查看：
C:\Users\Administrator>pip show pytest-html
Name: pytest-html
Version: 2.0.1
Summary: pytest plugin for generating HTML reports
Home-page: https://github.com/pytest-dev/pytest-html
Author: Dave Hunt
Author-email: dhunt@mozilla.com
License: Mozilla Public License 2.0 (MPL 2.0)
Location: d:\python37\lib\site-packages
Requires: pytest, pytest-metadata
Required-by:

3 生成报告

3.1 插件执行方式

  • 使用如下命令在命令行执行：
pytest --html=report.html
  • 执行后，在当前目录下生成一个吗，名为report.html的报告：
    在这里插入图片描述

3.2 执行效果

在这里插入图片描述

3.3 指定报告生成的路径

  • 当前目录下：
pytest --html=report.html
  • 指定目录下：
pytest --html=./report/report.html

在这里插入图片描述

  • 指定某个用例运行，生成报告保存到指定目录下：
pytest --html=./report/report.html

在这里插入图片描述

4 合并css

  • 从生成的报告可以看出，除了report.html外，还有个文件style.css;
  • 这个文件是报告的样式，是独立的，那么我们分享报告的时候，就必须把这个样式也加上，比较麻烦：
    在这里插入图片描述
body {
	font-family: Helvetica, Arial, sans-serif;
	font-size: 12px;
	/* do not increase min-width as some may use split screens */
	min-width: 800px;
	color: #999;
}

h1 {
	font-size: 24px;
	color: black;
}

h2 {
	font-size: 16px;
	color: black;
}

p {
    color: black;
}

a {
	color: #999;
}

table {
	border-collapse: collapse;
}

/******************************
 * SUMMARY INFORMATION
 ******************************/

#environment td {
	padding: 5px;
	border: 1px solid #E6E6E6;
}

#environment tr:nth-child(odd) {
	background-color: #f6f6f6;
}

/******************************
 * TEST RESULT COLORS
 ******************************/
span.passed, .passed .col-result {
	color: green;
}
span.skipped, span.xfailed, span.rerun, .skipped .col-result, .xfailed .col-result, .rerun .col-result {
	color: orange;
}
span.error, span.failed, span.xpassed, .error .col-result, .failed .col-result, .xpassed .col-result  {
	color: red;
}


/******************************
 * RESULTS TABLE
 *
 * 1. Table Layout
 * 2. Extra
 * 3. Sorting items
 *
 ******************************/

/*------------------
 * 1. Table Layout
 *------------------*/

#results-table {
	border: 1px solid #e6e6e6;
	color: #999;
	font-size: 12px;
	width: 100%
}

#results-table th, #results-table td {
	padding: 5px;
	border: 1px solid #E6E6E6;
	text-align: left
}
#results-table th {
	font-weight: bold
}

/*------------------
 * 2. Extra
 *------------------*/

.log:only-child {
	height: inherit
}
.log {
	background-color: #e6e6e6;
	border: 1px solid #e6e6e6;
	color: black;
	display: block;
	font-family: "Courier New", Courier, monospace;
	height: 230px;
	overflow-y: scroll;
	padding: 5px;
	white-space: pre-wrap
}
div.image {
	border: 1px solid #e6e6e6;
	float: right;
	height: 240px;
	margin-left: 5px;
	overflow: hidden;
	width: 320px
}
div.image img {
	width: 320px
}
.collapsed {
	display: none;
}
.expander::after {
	content: " (show details)";
	color: #BBB;
	font-style: italic;
	cursor: pointer;
}
.collapser::after {
	content: " (hide details)";
	color: #BBB;
	font-style: italic;
	cursor: pointer;
}

/*------------------
 * 3. Sorting items
 *------------------*/
.sortable {
	cursor: pointer;
}

.sort-icon {
	font-size: 0px;
	float: left;
	margin-right: 5px;
	margin-top: 5px;
	/*triangle*/
	width: 0;
	height: 0;
	border-left: 8px solid transparent;
	border-right: 8px solid transparent;
}

.inactive .sort-icon {
	/*finish triangle*/
	border-top: 8px solid #E6E6E6;
}

.asc.active .sort-icon {
	/*finish triangle*/
	border-bottom: 8px solid #999;
}

.desc.active .sort-icon {
	/*finish triangle*/
	border-top: 8px solid #999;
}
  • 所以为了方便，我们把这个css样式合并到html里，命令如下：
pytest --html=report.html --self-contained-html
  • 再次运行报告查看下，此时只有report.html文件，且样式已经合并进来了：
    在这里插入图片描述

5 报告中的行显示设置

  • 默认生成功的报告中的所有行都是被展开的,如图：
    在这里插入图片描述
  • 我们可以自定义显示的样式：
?collapsed=Passed,XFailed,Skipped

6 报告增强

详细参考官网文档：https://github.com/pytest-dev/pytest-html

6.1 自定义css

  • 可以使用--CSS选项在命令行上传递自定义CSS：
$ pytest --html=report.html --css=highcontrast.css --css=accessible.css

6.2 报告标题

  • 默认情况下，报告标题将是报告的文件名；
  • 您可以使用pytest_html_report_title钩子对其进行编辑：
def pytest_html_report_title(report):
    report.title = "My very own title!"

6.3 环境

  • Environment部分由pytest-metadata插件提供；
  • 可以通过pytest_configure和pytest_sessionfinish钩子访问；
  • 要在运行测试之前修改Environment部分，请使用pytest_configure：
def pytest_configure(config):
    config._metadata["foo"] = "bar"
  • 要在测试运行后修改Environment部分，请使用pytest_sessionfinish：
import pytest


@pytest.hookimpl(tryfirst=True)
def pytest_sessionfinish(session, exitstatus):
    session.config._metadata["foo"] = "bar"

请注意，在上面的示例中，@pytest.hookimpl（tryfirst=True）非常重要，因为这可以确保在任何其他插件（包括pytest-html和pytest-metadata）运行之前尽最大努力运行pytest_sessionfinish。如果省略了这一行，那么Environment表将不会更新，因为插件的pytest_sessionfinish将首先执行，因此不会接受您的更改。

除非元数据是集合.OrderedDict，否则生成的表将按字母顺序排序。

可以从环境表中编辑变量。重做的变量将显示其名称，但其值将灰显。这可以通过在INI配置文件（例如：pytest.INI）中设置environment_table_redact_list来实现。environment_table_redact_list是正则表达式的行列表。与此列表中的正则表达式匹配的任何环境表变量都会对其值进行编校。

例如，以下命令将对与正则表达式^foo$、.*redact.*或bar匹配的所有环境表变量进行编校：

[pytest]
environment_table_redact_list = ^foo$
    .*redact.*
    bar

6.4 其他摘要信息

  • 可以使用pytest_html_results_Summary挂钩编辑Summary部分：
from py.xml import html


def pytest_html_results_summary(prefix, summary, postfix):
    prefix.extend([html.p("foo: bar")])

6.5 Extra内容

  • 可以通过在报告对象上创建“extra”列表来向HTML报告添加详细信息；
  • 以下是可以添加的extra 内容类型：

Type

Example

Raw HTML

extra.html('<div>Additional HTML</div>')

JSON

extra.json({'name': 'pytest'})

Plain text

extra.text('Add some simple Text')

URL

extra.url('http://www.example.com/')

Image

extra.image(image, mime_type='image/gif', extension='gif')

Image

extra.image('/path/to/file.png')

Image

extra.image('http://some_image.png')

  • 注意：从文件添加图像时，路径可以是绝对路径，也可以是相对路径；
  • 注意：当使用--self-contained-html时，作为文件或链接添加的图像可能无法按预期工作，有关详细信息，请参阅 Creating a self-contained report一节。
  • 还有几种图像格式的方便类型：

Image format

Example

PNG

extra.png(image)

JPEG

extra.jpg(image)

SVG

extra.svg(image)

  • 以下示例使用pytest_runtest_makereport钩子添加了各种类型的附加功能，该钩子可以在plugin或conftest.py文件中实现：
import pytest


@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
    pytest_html = item.config.pluginmanager.getplugin("html")
    outcome = yield
    report = outcome.get_result()
    extra = getattr(report, "extra", [])
    if report.when == "call":
        # always add url to report
        extra.append(pytest_html.extras.url("http://www.example.com/"))
        xfail = hasattr(report, "wasxfail")
        if (report.skipped and xfail) or (report.failed and not xfail):
            # only add additional html on failure
            extra.append(pytest_html.extras.html("<div>Additional HTML</div>"))
        report.extra = extra
  • 还可以为html以外的所有类型指定名称参数，这将更改创建的超链接的标题：
extra.append(pytest_html.extras.text("some string", name="Different title"))
  • 还可以使用fixture extra直接在测试函数中添加内容，而不需要实现挂钩。这些通常会在插件添加任何额外功能之前结束。
from pytest_html import extras


def test_extra(extra):
    extra.append(extras.text("some string"))

6.6 修改结果表

  • 可以通过为表头和行实现自定义挂钩来修改报表的列；
  • 以下示例conftest.py使用测试函数docstring添加描述列，添加可排序时间列，并删除链接列：
from datetime import datetime
from py.xml import html
import pytest


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


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.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    report.description = str(item.function.__doc__)
  • 还可以通过实现pytest_html_results_table_row钩子并删除所有单元格来删除结果。以下示例从报告中删除所有传递的结果：
def pytest_html_results_table_row(report, cells):
    if report.passed:
        del cells[:]
  • 可以通过实现pytest_HTML_results.HTML钩子来修改日志输出和其他HTML。以下示例用日志为空的通知替换所有其他HTML和日志输出：
from py.xml import html


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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/144844.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

198. 打家劫舍

198. 打家劫舍

198. 打家劫舍 你是一个专业的小偷&#xff0c;计划偷窃沿街的房屋。每间房内都藏有一定的现金&#xff0c;影响你偷窃的唯一制约因素就是相邻的房屋装有相互连通的防盗系统&#xff0c;如果两间相邻的房屋在同一晚上被小偷闯入&#xff0c;系统会自动报警。 给定一个代表每个…
阅读更多...
MySQL调优-Innodb引擎SQL执行的BufferPool缓存机制

MySQL调优-Innodb引擎SQL执行的BufferPool缓存机制

目录 Innodb引擎SQL执行的BufferPool缓存机制 为什么Mysql不能直接更新磁盘上的数据而且设置这么一套复杂的机制来执行SQL了&#xff1f; 为什么直接更新磁盘是随机读写&#xff1f;为什么读写磁盘的日志文件是顺序读写&#xff1f; 为什么不直接读写磁盘而是选择读写Buffer…
阅读更多...
【吐槽贴】项目经理的进阶日常：项目要收尾了，我却慌了

【吐槽贴】项目经理的进阶日常：项目要收尾了，我却慌了

最近忙着写年终总结&#xff0c;还以为这次的年终奖稳了&#xff0c;结果犯了一个致命的错误&#xff0c;年终奖差点都没了。我负责的一个项目由于客户方比较着急&#xff0c;计划在过年放假前要完成交付&#xff0c;项目进度都完成的差不多了。现在还剩近10天的工期&#xff0…
阅读更多...
2022尚硅谷SSM框架跟学(二)MyBatis基础二

2022尚硅谷SSM框架跟学(二)MyBatis基础二

2022尚硅谷SSM框架跟学二MyBatis基础二6.MyBatis的各种查询功能6.1查询一个实体类对象6.2查询一个list集合6.3查询单个数据MyBatis别名对应文档6.4查询一条数据为map集合6.5查询多条数据为map集合(1)方式一(2)方式二7.特殊SQL的执行7.1模糊查询7.2批量删除7.3动态设置表名7.4添…
阅读更多...
SpringBoot+VUE前后端分离项目学习笔记 - 【16 SpringBoot集成JWT】

SpringBoot+VUE前后端分离项目学习笔记 - 【16 SpringBoot集成JWT】

JWT简介 JWT是json web token缩写。用点号分为三段&#xff0c;分别表示头、信息和签名。可以使用在RESTFUL接口定义&#xff0c; 也可以使用在普通的web。它将用户信息加密到token里&#xff0c;服务器不保存任何用户信息。服务器通过密钥验证token的正确性&#xff0c;判断是…
阅读更多...
模板的基本概念

模板的基本概念

模板函数模板泛型编程基本概念函数模板格式函数模板的实现函数模板的实例化类模板类模板格式类模板的实例化模板参数的匹配原则复数的相加函数模板 泛型编程 泛型编程是编写与类型无关的通用代码&#xff0c;是代码复用的一种手段。模板是泛型编程的基础。 基本概念 函数模…
阅读更多...
【自学C++】C++命名空间引入

【自学C++】C++命名空间引入

C命名空间引入 C命名空间引入教程 C 中的命名空间的引入&#xff0c;我们通常使用 using 语句后面加上命名空间名即可。 C命名空间引入详解 语法 using namespace namespaceName参数 参数描述using引入命名空间使用的关键字。namespace引入命名空间使用的关键字。namespa…
阅读更多...
数影周报：2亿Twitter用户资料仅售2美元，微盟集团将筹约15.9亿港元

数影周报：2亿Twitter用户资料仅售2美元，微盟集团将筹约15.9亿港元

本周看点&#xff1a;黑客以2美元出售2亿Twitter用户个人资料&#xff1b;Twitter 第三轮裁员&#xff1b;京东科技成立京东云事业部&#xff1b;TikTok Shop越南收入赶超Lazada&#xff1b;微盟集团将筹资约15.9亿港元......数据安全那些事黑客以2美元出售2亿Twitter用户资料近…
阅读更多...
2023年山东最新建筑施工架子工（建筑特种作业）模拟题库及答案

2023年山东最新建筑施工架子工（建筑特种作业）模拟题库及答案

百分百题库提供特种工&#xff08;架子工&#xff09;考试试题、特种工&#xff08;架子工&#xff09;考试预测题、特种工&#xff08;架子工&#xff09;考试真题、特种工&#xff08;架子工&#xff09;证考试题库等,提供在线做题刷题&#xff0c;在线模拟考试&#xff0c;助…
阅读更多...
mosquitto使用与openssl证书配置

mosquitto使用与openssl证书配置

开发环境&#xff1a;ubuntu18.04 64bitmqtt客户端测试工具&#xff1a;mqtt.fx 1.7.11.安装# 引入库 sudo apt-add-repository ppa:mosquitto-dev/mosquitto-ppa sudo apt-get update # 安装 sudo apt-get install mosquitto #安装客户端 sudo apt-get install mosquitto-clie…
阅读更多...
《NDT-LOAM: A Real-Time Lidar Odometry andMapping With Weighted NDT and LFA》深大学生

《NDT-LOAM: A Real-Time Lidar Odometry andMapping With Weighted NDT and LFA》深大学生

Abstract激光雷达同时定位和建图&#xff08;Lidar-SLAM&#xff09;从激光雷达上处理点云&#xff0c;并完成定位和建图。激光激光通常分为前端里程计和后端优化&#xff0c;可以并行运行以提高计算效率。前端里程计通过处理点云来估计激光雷达的运动&#xff0c;在点云配准中…
阅读更多...
python自学之《21天学通Python》(6)

python自学之《21天学通Python》(6)

第9章 迭代器、生成器与装饰器 迭代器、生成器与装饰器是Python语言中常用的语法形式。 迭代器的使用简化了循环程序的代码并可以节约内存&#xff0c;生成器的使用也可以节约大量的内存&#xff0c;特别是需要生成大量序列的对象时。迭代器是一种可以从其中连续迭代的一个容器…
阅读更多...
Shell 数组

Shell 数组

数组中可以存放多个值。Bash Shell 只支持一维数组&#xff08;不支持多维数组&#xff09;&#xff0c;初始化时不需要定义数组大小&#xff08;与 PHP 类似&#xff09;。与大部分编程语言类似&#xff0c;数组元素的下标由 0 开始。Shell 数组用括号来表示&#xff0c;元素用…
阅读更多...
教你如何巧妙化解SSRF漏洞攻击

教你如何巧妙化解SSRF漏洞攻击

SSRF是一种由攻击者构造请求&#xff0c;由服务端发起请求的安全漏洞。一般情况下&#xff0c;ssrf攻击的目标是外网无法访问的内部系统。简单来说就是利用服务器漏洞以服务器的身份发送一条构造好的请求给服务器所在内网进行攻击。 SSRF漏洞&#xff08; 服务器端请求伪造 &a…
阅读更多...
【pandas】教程：9-如何轻松处理时间序列数据

【pandas】教程：9-如何轻松处理时间序列数据

Pandas 如何轻松处理时间序列数据 数据 本节使用的数据为 data/air_quality_no2_long.csv&#xff0c;链接为 pandas案例和教程所使用的数据-机器学习文档类资源-CSDN文库 import pandas as pd import matplotlib.pyplot as pltair_quality pd.read_csv("data/air_qua…
阅读更多...
实战字节码-01-基础知识

实战字节码-01-基础知识

开篇字节码是什么、做什么这类问题不在这里赘述&#xff0c;《实战字节码》系列旨在帮助没接触过字节码的人能够快速上手做应用开发&#xff0c;并构建字节码技术的知识骨架&#xff0c;所以不会系统地介绍字节码技术的方方面面&#xff0c;也尽量避免叙述理论和概念相关的东西…
阅读更多...
【笔记：模拟CMOS集成电路】噪声——基本电路噪声性能（2）

【笔记：模拟CMOS集成电路】噪声——基本电路噪声性能（2）

【笔记&#xff1a;模拟CMOS集成电路】噪声——基本电路噪声性能&#xff08;2&#xff09;前言1 噪声——分析基础2 噪声——基本电路噪声性能2.1 MOS管噪声模型(1)电阻RG热噪声和沟道热噪声(2)衬底电阻热噪声(3)源极寄生电阻RS热噪声2.2常见组态的单级放大器噪声分析2.2.1 CS…
阅读更多...
Python电影观众数量回归分析 随机森林 可视化 实验报告

Python电影观众数量回归分析 随机森林 可视化 实验报告

实验报告&#xff1a;Python电影观众数量回归分析随机森林可视化-数据挖掘文档类资源-CSDN文库 前言 随着经济的发展和人民日益增长的美好生活需要的显著提升&#xff0c;看电影成为了人民群众在闲暇时光娱乐的重要途径。面对百花齐放的电影产业&#xff0c;哪些电影更能带动市…
阅读更多...
OpenGL期末大作业——模拟太阳系(免费开源)

OpenGL期末大作业——模拟太阳系(免费开源)

目录 一、项目介绍 二、配置与运行 三、项目地址 一、项目介绍 这是一个综合的openGL场景&#xff0c;模拟太阳系。场景中有光照&#xff0c;纹理等&#xff0c;并有丰富的视角控制&#xff0c;UI交互&#xff0c;比如WASD/IJKL键控制视角的移动等等。一个太阳系的场景&#…
阅读更多...
大数据基础平台搭建-（五）Hive搭建

大数据基础平台搭建-（五）Hive搭建

大数据基础平台搭建-&#xff08;五&#xff09;Hive搭建 大数据平台系列文章&#xff1a; 1、大数据基础平台搭建-&#xff08;一&#xff09;基础环境准备 2、大数据基础平台搭建-&#xff08;二&#xff09;Hadoop集群搭建 3、大数据基础平台搭建-&#xff08;三&#xff09…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023