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" % str1
    if not isinstance(str2, str):
        return "%s is not a string" % str2
    return 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 pytest

data = [
    {
        "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中,epicfeaturestory 是用来组织测试用例的层次结构,它们帮助团队更好地理解和管理测试用例。

  • 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

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

Learn ComputeShader 01 First Computer Shader

使用Unity版本:2019.4.12f1 整体流程: 1添加一个quad object并添加一个无光照材质 2.相机投影模式设置为正交 3.调整quad使其完全显示在相机内 4.创建脚本并且使用计算着色器覆盖quad的纹理 5.创建一个compute shader 前三步完成以后结果应该是这…

深入了解计算机系统——利用循环展开对程序的优化

系列文章: 操作系统详解(1)——操作系统的作用 操作系统详解(2)——异常处理(Exception) 操作系统详解(3)——进程、并发和并行 操作系统详解(4)——进程控制(fork, waitpid, sleep, execve) 操作系统详解(5)——信号(Signal) 文章目录 一些概念CPE 初步优化消除不必…

Mysql基础篇

1 数据库的三大范式 第一范式:强调的是列的原子性,即数据库表的每一列都是不可分割的原子数据项。 第二范式:在第一范式的基础上,消除非主属性对主属性的部分函数依赖。要求实体的非主键完全依赖于主键。所谓完全依赖是指不能存…

Linux进程间通讯

文章目录 Linux进程间通讯1、进程间通信介绍1.1、进程间通信目的1.2、进程间通信发展1.3、进程间通信分类 2、管道2.1、什么是管道2.2、匿名管道2.2.1、标准输入stdin和标准输出stdout通信2.2.2、父子进程通信2.2.3、父子进程通信现象2.2.4、父子进程通信特性2.2.5、进程池 2.3…

【window环境、Linux环境、QT三种方法实现TCP通信】

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录 前言一、Windows环境下实现TCP通信1.服务器2.客户端3.运行 二、Linux环境下实现TCP通信1.服务端2.客户端 三、Qt实现TCP通信1.服务端1.客户端 总结 前言 大多数项目…

RAG文本解析工具open-parse

简介 对于RAG来说,将文本有效的分块(chucking)是很重要的一件事,open-parse是一个用来分块pdf的开源工具,它主要基于视觉驱动(Visually-Driven)的方式来将文档分块,也就是说它不仅仅是按照段落或者字数来对文档分块,而…

easyx 按键信息

前言 看看代码吧 ExMessage msg { 0 }; bool button(int x, int y, int w, int h, const char* text) {//绘制按钮setfillcolor(RGB(230, 231, 232));fillroundrect(x, y, x w, y h, 5, 5);if ((msg.x > x && msg.x<x w && msg.y>y && …

为什么要分库分表?(设计高并发系统的时候,数据库层面该如何设计?)

目录 1.分表 2.分库 说白了&#xff0c;分库分表是两回事儿&#xff0c;大家可别搞混了&#xff0c;可能是光分库不分表&#xff0c;也可能是光分表不分库&#xff0c;都有可能。 我先给大家抛出来一个场景。 假如我们现在是一个小创业公司(或者是一个 BAT …

java反序列化之URLDNS链学习

一、前言 近来学习java反序列化&#xff0c;听p神所说这个URLDNS利用链比较好理解&#xff0c;故决定由此进入学习的第一篇。 URLDNS是Java反序列化中比较简单的一个链&#xff0c;由于URLDNS不需要依赖第三方的包&#xff0c;同时不限制jdk的版本&#xff0c;所以通常用于检…

hertzbeat 源码阅读记录

关于自定义标签的说明 EmailValid.java HostValid PhoneNumValid 枚举值说明&#xff1a;

【OpenGL实践08】现代渲染管线在GLUT和Pygame和Qt.QOpenGLWidget上各自的实现代码

Qt.QOpenGLWidget进行现代渲染管线实验效果 一、说明 据说QOpenGLWidget是用来取代QGLWidget的继承者&#xff0c;我们试图将GLUT上的旧代码改成QOpenGLWidget&#xff0c;本以为差别不大&#xff0c;轻易搞定&#xff0c;经实践发现要付出极大努力才能完成。经多次实验发现G…

Java面试八股之Java中为什么没有全局变量

Java中为什么没有全局变量 Java中没有传统意义上的全局变量&#xff0c;这是因为Java语言设计遵循面向对象的原则&#xff0c;强调封装性和模块化&#xff0c;以及避免全局状态带来的副作用。 封装性&#xff1a; 全局变量违反了面向对象编程中的封装原则&#xff0c;即隐藏对…

【ZYNQ】zynq启动模式及程序固化

一、前言 由于zynq含有arm cpu ,其启动模式由ps主导&#xff0c;与纯逻辑的fpga不相同&#xff0c;此处做一个记录。 二、zynq启动模式 关于zynq的启动模式详细内容可以参考官方文档&#xff1a;ug585-Zynq 7000 SoC Technical Reference Manual&#xff0c;第六章。 2.1 启…

帮助中心系统搭建不再是难题,这几个工具来帮你

在面临客户服务挑战时&#xff0c;有效的帮助中心系统是提升用户满意度和解决问题效率的关键。幸运的是&#xff0c;搭建一个功能全面的帮助中心不再是什么难事。下面&#xff0c;我要为你介绍三款能够帮忙打造帮助中心的超实用工具&#xff0c;让你的客户支持体验迅速升级。 1…

网页使用之如何返回json/xml

后端返回json数据给前端进行渲染的方式比较熟悉&#xff0c;至于返回html页面&#xff0c;返回xml的方式接触逐渐减少&#xff0c;来在项目中熟悉这一点。 返回文本数据 json姿势的返回实属最简单的方式&#xff0c;在SpringBoot应用中&#xff0c;有两种简单的方式 1.直接在…

S32K的JLINK与PE接线方法与刷程序失败问题

S32K的JLINK与PE接线方法与刷程序失败问题 1、PE的接线方法2、JLINK的接线方法3、刷程序失败问题 1、PE的接线方法 2、JLINK的接线方法 3、刷程序失败问题 出现如下问题&#xff1a; Secure Debug might be enabled on this device.lf so.please unlock the device via PEmic…

一段音频驱动照片唱歌,EMO模型上线通义APP

把一段音频、一张照片输入AI模型&#xff0c;就能让图中人物开口唱歌说话&#xff0c;让奥黛丽赫本唱《上春山》、陶俑仕女说英文RAP、爱因斯坦说中文段子。不久前&#xff0c;这款名为EMO的模型因为阿里通义实验室的一篇论文火遍海内外&#xff0c;模型的产品化进程也广受关注…

运动耳机哪个牌子性价比高?推荐五款高性价比运动耳机

跑步、健身、游泳……无论你的运动喜好是什么&#xff0c;一款好的运动蓝牙耳机都能为你的运动体验加分。然而&#xff0c;市面上的运动蓝牙耳机品牌众多&#xff0c;如何选择一款既舒适又实用的产品呢&#xff1f;本文将为你提供一些选购运动蓝牙耳机建议&#xff0c;并为你推…

企业规模扩大,SD-WAN实现跨省快速组网

随着数字化时代的飞速发展&#xff0c;企业面临着前所未有的挑战与机遇。5G、VoIP、AI和物联网等新技术的兴起&#xff0c;不仅改变了商业格局&#xff0c;也对企业网络提出了更高的要求。随着企业规模的不断扩大&#xff0c;企业如何搭建跨省的、高性能、超融合、简化运维的组…

解决Jmeter 4.x 请求到elasticsearch 中文乱码的问题

文章目录 前言解决Jmeter 4.x 请求到elasticsearch 中文乱码的问题 前言 如果您觉得有用的话&#xff0c;记得给博主点个赞&#xff0c;评论&#xff0c;收藏一键三连啊&#xff0c;写作不易啊^ _ ^。   而且听说点赞的人每天的运气都不会太差&#xff0c;实在白嫖的话&#…