Allure精通指南（04）静态和动态生成报告标记

2024-04-26 03:44
文章标签 标记 动态 精通 生成 静态 报告 指南 04 allure

本文主要是介绍Allure精通指南（04）静态和动态生成报告标记，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

      • Allure 静态定制报告标记
      • Allure 动态生成报告标记
      • Allure 实现方式选择
      • Allure 分类执行
        • 运行epic相关
        • 运行feature相关
        • 运行story相关
        • 运行story相关
        • 运行feature和多个story相关（取并集）

请添加图片描述

Allure 静态定制报告标记

定义和用法：

  • Decorators API主要通过注解（annotations）或装饰器（decorators）来扩展测试代码，为Allure报告提供额外的信息。
  • 这些注解或装饰器直接应用于测试方法、钩子方法或测试类上。

应用场景：

  • 步骤描述：使用 @Step 注解来标记测试方法或代码块，描述测试执行的各个步骤。
  • 标题和描述：使用 @Title 和 @Description 注解为测试用例或测试套件提供自定义的标题和描述。
  • 附件：使用 @Attachment 注解将文件或图片附加到测试报告中。
  • 参数和值：使用 @Parameter 和 @Value 注解传递参数和获取结果值，以便在报告中展示。

优点：

  • 简洁：直接在测试代码中使用注解，无需编写额外的代码。
  • 可读性：注解提供了对测试行为的明确描述，增强了代码的可读性。
  • 易于维护：当测试代码变更时，注解可以轻松地随之更新。

缺点：

  • 功能限制：注解可能不支持所有Allure报告的功能，特别是在需要动态生成报告内容的情况下。
  • 框架支持：不是所有的测试框架都支持Allure的注解。

test_case_03.py文件示例代码

缺点：每个用例都需要手动添加描述信息，较为繁琐，且难以维护

import pytest
import allure# 测试函数
@allure.step("测试步骤2，字符串相加：{0}，{1}")  # 测试步骤，可通过format机制自动获取函数参数
def str_add(str1, str2):print("进入str_add函数")if not isinstance(str1, str):return "%s is not a string" % str1if not isinstance(str2, str):return "%s is not a string" % str2return str1 + str2@allure.title("测试用例名称：测试字符串相等")
@allure.tag("测试用例标签1", "测试用例标签2", "测试用例标签3")
@allure.description("测试用例描述信息：测试两个字符串是否相等")
@allure.severity("critical")  # 优先级，包含blocker, critical, normal, minor, trivial 几个不同的等级
@allure.feature("测试模块_demo1")  # 功能块，feature功能分块时比story大,即同时存在feature和story时,feature为父节点
@allure.story("测试模块_demo2")  # 功能块，具有相同feature或story的用例将规整到相同模块下,执行时可用于筛选
@allure.issue("测试用例缺陷编号：对应外部管理系统的地址或标识")  # 问题表识，关联标识已有的问题，可为一个url链接地址
@allure.testcase("测试用例关联编号：对应外部管理系统的地址或标识")  # 用例标识，关联标识用例，可为一个url链接地址
@pytest.mark.parametrize("para_one, para_two",  # 用例参数[("hello world", "hello world"),  # 用例参数的参数化数据(4, 4),("中文", "中文")],ids=["test ASCII string",  # 对应用例参数化数据的用例名"test digital string","test unicode string"])
def test_case_example(para_one, para_two):"""用例描述：测试字符串相等:param para_one: 参数1:param para_two: 参数2"""# 获取参数paras = vars()# 关联F的资料信息, 可在报告中记录保存必要的相关信息with allure.step("测试步骤1，用例参数：{0}".format(paras)):pass  # 动态生成step节点，必须使用with，否则会不生成# 调用测试函数res = str_add(para_one, para_two)# 对必要的测试中间结果数据做备份with allure.step("测试步骤3，str_add返回结果：{0}".format(res)):pass# 测试步骤，对必要的测试过程加以说明with allure.step("测试步骤4，结果校验 {0} == {1}".format(res, para_one + para_two)):assert res == para_one + para_two, res

allure报告效果

请添加图片描述

Allure 动态生成报告标记

定义和用法：

  • Runtime API提供了编程式的方式来生成Allure报告。
  • 它允许在测试执行过程中动态地创建报告内容，包括添加步骤、日志、附件等。

应用场景：

  • 动态内容：当测试执行的结果需要动态地影响报告内容时，使用Runtime API可以很方便地实现。
  • 复杂逻辑：对于需要复杂逻辑或条件判断的测试场景，Runtime API提供了更大的灵活性。
  • 自定义扩展：通过Runtime API，你可以创建自定义的报告内容，如自定义的日志条目、图表等。

优点：

  • 灵活性：Runtime API提供了丰富的接口和方法，允许根据测试执行的实际情况动态地生成报告内容。
  • 强大的功能：与Decorators API相比，Runtime API支持更多的Allure报告功能，如创建嵌套步骤、自定义日志级别等。

缺点：

  • 复杂性：使用Runtime API需要编写更多的代码，可能会增加测试代码的复杂性。
  • 性能影响：在测试执行过程中频繁地调用Runtime API的方法可能会对性能产生一定的影响。

test_case_04.py文件示例代码

import allure
import pytestdata = [{"title": "测试用例名称：用户注册","tag": ["测试用例标签1", "测试用例标签2", "测试用例标签3"],"description": "测试用例描述信息：用户注册成功","severity": "critical","epic": "测试目录_xxx1","feature": "测试模块_xxx2","story": "测试功能_xxx1","issue": "测试用例缺陷编号：对应外部管理系统的地址或标识","testcase": "测试用例关联编号：对应外部管理系统的地址或标识","datagram": {"步骤1": {"url": "/xxx/xxx/xxx","method": "post","headers": {'Content-Type': 'application/json'},"params": {"username": "admin", "password": "123456"}}}},{"title": "测试用例名称：用户注册","tag": ["测试用例标签1", "测试用例标签2", "测试用例标签3"],"description": "测试用例描述信息：用户注册失败","severity": "critical","epic": "测试目录_xxx1","feature": "测试模块_xxx2","story": "测试功能_xxx1","issue": "测试用例缺陷编号：对应外部管理系统的地址或标识","testcase": "测试用例关联编号：对应外部管理系统的地址或标识","datagram": {"步骤1": {"url": "/xxx/xxx/xxx","method": "post","headers": {'Content-Type': 'application/json'},"params": {"username": "admin", "password": "123123"}}}},{"title": "测试用例名称：订单查询","tag": ["测试用例标签1", "测试用例标签2", "测试用例标签3"],"description": "测试用例描述信息：订单查询成功","severity": "critical","epic": "测试目录_xxx2","feature": "测试模块_xxx1","story": "测试功能_xxx1","issue": "测试用例缺陷编号：对应外部管理系统的地址或标识","testcase": "测试用例关联编号：对应外部管理系统的地址或标识","datagram": {"步骤1": {"url": "/xxx/xxx/xxx","method": "post","headers": {'Content-Type': 'application/json'},"params": {"username": "admin", "password": "123456"}},"步骤2": {"url": "/xxx/xxx/xxx","method": "get","params": {"id": "10086", "datetime": "2024-04-15"}}}}
]@pytest.mark.parametrize('datagram', data)
class TestCase:def test_case(self, datagram):allure.dynamic.title(datagram["title"])for tag in datagram["tag"]:allure.dynamic.tag(tag)allure.dynamic.description(datagram["description"])allure.dynamic.severity(datagram["severity"])allure.dynamic.epic(datagram["epic"])allure.dynamic.feature(datagram["feature"])allure.dynamic.story(datagram["story"])allure.dynamic.issue(datagram["issue"])allure.dynamic.testcase(datagram["testcase"])# 获取实际需要的测试数据datagram = datagram.get("datagram")print("测试数据类型：", type(datagram))print("测试数据详情：", datagram)# 模拟测试数据检查，避免不必要的错误if not datagram or not isinstance(datagram, dict) or not all(x.startswith("步骤") for x in datagram.keys()):assert False, "缺少测试数据或测试数据格式错误"# 开始测试，模拟执行测试用例过程的日志with allure.step("开始测试"):allure.attach(body="一条测试开始了...", name="测试日志", attachment_type=allure.attachment_type.TEXT)if datagram.get("步骤1"):with allure.step("执行步骤1"):# 这里可以编写实际的测试代码params = datagram["步骤1"]["params"]username = params["username"]password = params["password"]actual = username == "admin" and password == "123456"if not actual:assert_info = f"用户名: {username}, 密码: {password}，验证失败"allure.attach(body=assert_info, name="验证详情", attachment_type=allure.attachment_type.TEXT)assert False, f"用户名或密码错误: {username}, {password}"else:assert_info = f"用户名: {username}, 密码: {password}，验证成功"allure.attach(body=assert_info, name="验证详情", attachment_type=allure.attachment_type.TEXT)assert True, "验证成功"if datagram.get("步骤2"):with allure.step("执行步骤2"):# 这里可以编写实际的测试代码assert True, "假设执行步骤2成功"with allure.step("结束测试"):allure.attach(body="测试结束", name="测试日志", attachment_type=allure.attachment_type.TEXT)

allure报告效果

请添加图片描述

Allure 实现方式选择

  • 基于需求：选择使用哪种API取决于具体需求。如果测试场景相对简单，并且报告内容主要是静态的，那么Decorators API可能是一个更好的选择。
  • Decorators API 更适合在测试代码中直接添加静态的描述和标记，适用于测试步骤简单、报告内容相对固定的场景。
  • Runtime API 更适合需要动态生成报告内容或实现复杂逻辑的场景，它提供了更多的控制选项和灵活性，但可能会增加代码的复杂性和对性能的影响。

Allure 分类执行

在Allure中，epic、feature、story 是用来组织测试用例的层次结构，它们帮助团队更好地理解和管理测试用例。

  • Epic（史诗）：通常代表一个大的功能或需求，可以包含多个 feature。
  • Feature（功能）：属于一个 epic，代表一个具体的功能或模块，可以包含多个 story。
  • Story（故事）：是 feature 的一个子集，代表一个具体的子功能或场景。
运行epic相关
pytest --alluredir=./results --allure-epics="需求1"
运行feature相关
pytest --alluredir=./results --allure-features="功能模块2"
运行story相关
pytest --alluredir=./results --allure-stories="子功能1"
运行story相关
pytest --alluredir=./results --allure-stories="子功能1,子功能2"
运行feature和多个story相关（取并集）
pytest --alluredir=./results --allure-features="功能模块1" --allure-stories="子功能1,子功能2"

请注意，当同时使用多个 --allure-* 参数时，Allure会根据这些条件筛选测试用例，并运行满足所有条件的测试用例的并集。

此外，请确保您的测试用例已经使用Allure的注解（如 @epic, @feature, @story）进行了适当的标记，以便 Allure 可以识别并应用这些筛选条件。例如：

import pytest
from allure_commons.types import AllureAttributeType@pytest.mark.epic("需求1")
@pytest.mark.feature("功能模块2")
@pytest.mark.story("子功能1")
def test_example():assert True

这篇关于Allure精通指南（04）静态和动态生成报告标记的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/936622。

相关文章

从基础到高级详解Python数值格式化输出的完全指南

从基础到高级详解Python数值格式化输出的完全指南

《从基础到高级详解Python数值格式化输出的完全指南》在数据分析、金融计算和科学报告领域,数值格式化是提升可读性和专业性的关键技术,本文将深入解析Python中数值格式化输出的相关方法,感兴趣的小伙... 目录引言：数值格式化的核心价值一、基础格式化方法1.1 三种核心格式化方式对比1.2 基础格式化示例
阅读更多...
sysmain服务可以禁用吗? 电脑sysmain服务关闭后的影响与操作指南

sysmain服务可以禁用吗? 电脑sysmain服务关闭后的影响与操作指南

《sysmain服务可以禁用吗?电脑sysmain服务关闭后的影响与操作指南》在Windows系统中，SysMain服务（原名Superfetch）作为一个旨在提升系统性能的关键组件，一直备受用户关... 在使用 Windows 系统时，有时候真有点像在「开盲盒」。全新安装系统后的「默认设置」，往往并不尽编
阅读更多...
Python ORM神器之SQLAlchemy基本使用完全指南

Python ORM神器之SQLAlchemy基本使用完全指南

《PythonORM神器之SQLAlchemy基本使用完全指南》SQLAlchemy是Python主流ORM框架,通过对象化方式简化数据库操作,支持多数据库,提供引擎、会话、模型等核心组件,实现事务... 目录一、什么是SQLAlchemy？二、安装SQLAlchemy三、核心概念1. Engine（引擎）
阅读更多...
Python自动化处理PDF文档的操作完整指南

Python自动化处理PDF文档的操作完整指南

《Python自动化处理PDF文档的操作完整指南》在办公自动化中,PDF文档处理是一项常见需求,本文将介绍如何使用Python实现PDF文档的自动化处理,感兴趣的小伙伴可以跟随小编一起学习一下... 目录使用pymupdf读写PDF文件基本概念安装pymupdf提取文本内容提取图像添加水印使用pdfplum
阅读更多...
Maven中生命周期深度解析与实战指南

Maven中生命周期深度解析与实战指南

《Maven中生命周期深度解析与实战指南》这篇文章主要为大家详细介绍了Maven生命周期实战指南,包含核心概念、阶段详解、SpringBoot特化场景及企业级实践建议,希望对大家有一定的帮助... 目录一、Maven 生命周期哲学二、default生命周期核心阶段详解（高频使用）三、clean生命周期核心阶
阅读更多...
Python从Word文档中提取图片并生成PPT的操作代码

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中，我们经常需要从 W
阅读更多...
基于Python实现自动化邮件发送系统的完整指南

基于Python实现自动化邮件发送系统的完整指南

《基于Python实现自动化邮件发送系统的完整指南》在现代软件开发和自动化流程中,邮件通知是一个常见且实用的功能,无论是用于发送报告、告警信息还是用户提醒,通过Python实现自动化的邮件发送功能都能... 目录一、前言：二、项目概述三、配置文件 `.env` 解析四、代码结构解析1. 导入模块2. 加载环
阅读更多...
Python实战之SEO优化自动化工具开发指南

Python实战之SEO优化自动化工具开发指南

《Python实战之SEO优化自动化工具开发指南》在数字化营销时代,搜索引擎优化（SEO）已成为网站获取流量的重要手段,本文将带您使用Python开发一套完整的SEO自动化工具,需要的可以了解下... 目录前言项目概述技术栈选择核心模块实现1. 关键词研究模块2. 网站技术seo检测模块3. 内容优化分析模
阅读更多...
使用Python的requests库来发送HTTP请求的操作指南

使用Python的requests库来发送HTTP请求的操作指南

《使用Python的requests库来发送HTTP请求的操作指南》使用Python的requests库发送HTTP请求是非常简单和直观的,requests库提供了丰富的API,可以发送各种类型的HT... 目录前言1. 安装 requests 库2. 发送 GET 请求3. 发送 POST 请求4. 发送
阅读更多...
Nginx中配置使用非默认80端口进行服务的完整指南

Nginx中配置使用非默认80端口进行服务的完整指南

《Nginx中配置使用非默认80端口进行服务的完整指南》在实际生产环境中,我们经常需要将Nginx配置在其他端口上运行,本文将详细介绍如何在Nginx中配置使用非默认端口进行服务,希望对大家有所帮助... 目录一、为什么需要使用非默认端口二、配置Nginx使用非默认端口的基本方法2.1 修改listen指令
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2