学会这些pytest-Allure常用特性allure.attach、allure.step、fixture、environment、categories，某里测开：大哥教教小弟

最新推荐文章于 2024-05-08 16:26:45 发布
最新推荐文章于 2024-05-08 16:26:45 发布
阅读量2.1k 收藏 25
点赞数 28
文章标签： pytest 服务器 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_70618214/article/details/134599149
版权

allure.attach

allure.attach用于在测试报告中添加附件，补充测试结果。附件格式可以是txt、jpg等，附件内容通常是测试数据、截图等。

allure.attach提供了两种方法：allure.attach()，allure.attach.file()

allure.attach()

作用：在测试报告中生成指定内容、名称、类型的附件

语法：allure.attach(body, name=None, attachment_type=None, extension=None)

参数说明：

  1. body，需要显示的内容，也可以理解为写入附件的内容
  2. name，附件名称
  3. attachment_type，附件类型，如csv、jpg、html 等，由allure.attachment_type提供
  4. extension：附件扩展名，不常用

allure.attach.file()

作用：向测试用例中上传附件

语法：allure.attach.file(source, name=None, attachment_type=None, extension=None)

参数说明：source为文件路径，其他参数与allure.attach()参数一致。

在UI自动化测试中，会经常用到这个方法来上传用例执行的截图。

示例

test_login.py：

import allure
import pytest
import requests
import json

data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]
ids = ["username:{}-password:{}".format(username, password) for username, password in data]

@allure.epic("xx在线购物平台接口测试")
@allure.feature("登录模块")
class TestLogin:

    @allure.story("用户登录")
    @allure.title("登录")
    @pytest.mark.parametrize("username, password", data, ids=ids)
    def test_login(self, username, password):
        headers = {"Content-Type": "application/json;charset=utf8"}
        url = "http://127.0.0.1:5000/login"
        _data = {
            "username": username,
            "password": password
        }
        allure.attach(
            body="用户名-{}，密码-{}".format(username, password),
            name="登录参数",
            attachment_type=allure.attachment_type.TEXT
        )
        res = requests.post(url=url, headers=headers, json=_data).text
        res = json.loads(res)
        assert res['code'] == 1000
        
    @allure.story("用户退出登录")
    @allure.title("退出登录")
    def test_logout(self):
        '''这条测试用例仅仅只是为了举例说明allure.attach.file的使用'''
        print("退出登录，并截图")
        # 截图路径
        testcase_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
        source_path = testcase_path + "/screenshot/logout.jpg"
        allure.attach.file(
            source=source_path,
            name="退出登录后截图",
            attachment_type=allure.attachment_type.JPG
        )
        assert True

上述代码中使用了@pytest.mark.parametrize()，Allure能够很好的支持@pytest.mark.parametrize()进行参数化。

run.py：

if __name__ == '__main__':
    pytest.main(['testcase/test_login.py', '-s', '-q', '--alluredir', './result'])
    os.system('allure generate ./result -o ./report --clean')

运行run.py，测试报告结果展示如下：

allure.attach()结果：

allure.attach.file()结果：

从结果可以看出来，两种方法都在报告中对应的测试用例中展示了附件内容。

从allure.attach()结果还可以看出来，Allure能够很好的支持@pytest.mark.parametrize()进行参数化。

with allure.step

上一篇文章我们使用了装饰器@allure.step()标记函数使之成为测试步骤，而在测试函数/方法中，我们还可以通过with allure.step()的方式标记测试步骤。

它们之间的区别在于，@allure.step()用于标记通用函数，当这个被标记的函数被调用后，会插入步骤说明并展示在Allure报告中。

而with allure.step()则是将普通的代码标记为测试步骤，执行到这段代码时则会在Allure报告中展示步骤说明。

我们在上面代码的基础上，加入with allure.step()，示例如下：

import allure
import pytest
import requests
import json


data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]
ids = ["username:{}-password:{}".format(username, password) for username, password in data]

@allure.epic("xx在线购物平台接口测试")
@allure.feature("登录模块")
class TestLogin:

    @allure.story("用户登录")
    @allure.title("登录")
    @pytest.mark.parametrize("username, password", data, ids=ids)
    def test_login(self, username, password):
        headers = {"Content-Type": "application/json;charset=utf8"}
        url = "http://127.0.0.1:5000/login"
        _data = {
            "username": username,
            "password": password
        }
        # 第一步，请求登录接口
        with allure.step("请求登录接口"):
            allure.attach(
                body="用户名-{}，密码-{}".format(username, password),
                name="登录参数",
                attachment_type=allure.attachment_type.TEXT
            )
            res = requests.post(url=url, headers=headers, json=_data).text
            res = json.loads(res)
        # 第二步，获取返回参数进行断言
        with allure.step("断言"):
            assert res['code'] == 1000

 自动化测试相关教程推荐：

2023最新自动化测试自学教程新手小白26天入门最详细教程,目前已有300多人通过学习这套教程入职大厂！！_哔哩哔哩_bilibili

2023最新合集Python自动化测试开发框架【全栈/实战/教程】合集精华，学完年薪40W+_哔哩哔哩_bilibili

测试开发相关教程推荐

2023全网最牛，字节测试开发大佬现场教学，从零开始教你成为年薪百万的测试开发工程师_哔哩哔哩_bilibili

postman/jmeter/fiddler测试工具类教程推荐

讲的最详细JMeter接口测试/接口自动化测试项目实战合集教程，学jmeter接口测试一套教程就够了！！_哔哩哔哩_bilibili

2023自学fiddler抓包，请一定要看完【如何1天学会fiddler抓包】的全网最详细视频教程！！_哔哩哔哩_bilibili

2023全网封神，B站讲的最详细的Postman接口测试实战教学，小白都能学会_哔哩哔哩_bilibili

测试报告结果展示如下：

代码中插入的测试步骤如上图中的标记所示。

fixture

pytest的fixture函数可以实现setup、teardown的功能，而Allure会跟踪每个fixture的调用情况，详细显示调用了哪些fixture和参数以及调用顺序。

我们在上面代码的基础上，加入fixture函数，示例如下：

import allure
import pytest
import requests
import json

@pytest.fixture(scope="class", autouse=True)
def fixture_demo(request):
    print("连接数据库")
    def finalizer():
        print("关闭数据库")
    request.addfinalizer(finalizer)


data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]
ids = ["username:{}-password:{}".format(username, password) for username, password in data]

@allure.epic("xx在线购物平台接口测试")
@allure.feature("登录模块")
class TestLogin:

    @allure.story("用户登录")
    @allure.title("登录")
    @pytest.mark.parametrize("username, password", data, ids=ids)
    def test_login(self, username, password):
        headers = {"Content-Type": "application/json;charset=utf8"}
        url = "http://127.0.0.1:5000/login"
        _data = {
            "username": username,
            "password": password
        }
        # 第一步，请求登录接口
        with allure.step("请求登录接口"):
            allure.attach(
                body="用户名-{}，密码-{}".format(username, password),
                name="登录参数",
                attachment_type=allure.attachment_type.TEXT
            )
            res = requests.post(url=url, headers=headers, json=_data).text
            res = json.loads(res)
        # 第二步，获取返回参数进行断言
        with allure.step("断言"):
            assert res['code'] == 1000

测试报告结果展示如下：

从结果可以看出来，Allure测试报告展示了用例调用的fixture函数信息。多个fixture函数被调用及其执行顺序的展示，这里不做过多说明。

environment

在Allure报告的首页可以展示此次测试执行的环境信息 (如测试环境、测试人员、被测系统版本号、系统配置环境等)，这需要通过创建environment.properties或environment.xml进行配置，并把文件放置在--alluredir指定的文件夹中 (博主这里即result文件夹)。

environment.properties示例如下：

system=win
python=3.7.7
version=1.0.1
host=127.0.0.1

或environment.xml

<environment>
    <parameter>
        <key>system</key>
        <value>win</value>
    </parameter>
    <parameter>
        <key>python</key>
        <value>3.7.7</value>
    </parameter>
    <parameter>
        <key>version</key>
        <value>1.0.1</value>
    </parameter>
    <parameter>
        <key>host</key>
        <value>127.0.0.1</value>
    </parameter>
</environment>

生成报告后首页展示ENVIRONMENT信息如下：

categories

Allure报告中有一栏叫Categories，即分类，用于展示测试结果，默认只显示两类缺陷结果：

  1. Product defects 产品缺陷（测试结果：failed）
  2. Test defects 测试缺陷（测试结果：error/broken）

如下图所示

如果想要缺陷分类显示更丰富，我们可以通过创建categories.json文件进行自定义缺陷分类，并把文件放置在--alluredir指定的文件夹中 (即同environment.properties放在同一目录中)。

categories.json示例如下：

[
  {
    "name": "Passed tests",
    "matchedStatuses": ["passed"]
  },
  {
    "name": "Ignored tests",
    "matchedStatuses": ["skipped"]
  },
  {
    "name": "Infrastructure problems",
    "matchedStatuses": ["broken", "failed"],
    "messageRegex": ".*bye-bye.*"
  },
  {
    "name": "Outdated tests",
    "matchedStatuses": ["broken"],
    "traceRegex": ".*FileNotFoundException.*"
  },
  {
    "name": "Product defects",
    "matchedStatuses": ["failed"]
  },
  {
    "name": "Test defects",
    "matchedStatuses": ["broken"]
  }
]

参数说明：

  1. name：分类名称
  2. matchedStatuses：测试用例的运行状态，默认["failed", "broken", "passed", "skipped", "unknown"]
  3. messageRegex：测试用例运行的错误信息，默认是 .* ，通过正则去匹配
  4. traceRegex：测试用例运行的错误堆栈信息，默认是 .* ，同样通过正则去匹配

执行后会在报告的Categories中展示，首页CATERORIES栏展示如下：

Categories页面展示：

总结

Allure中常用的特性大致就这些，以上仅为简单示例，大家可根据自身项目的需要按需选择使用。Allure提供的特性当然也不止这些，如果感兴趣大家可以查看Allure官方文档了解更多。

  总结：

 光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

如果对你有帮助的话，点个赞收个藏，给作者一个鼓励。也方便你下次能够快速查找。

如有不懂还要咨询下方小卡片，博主也希望和志同道合的测试人员一起学习进步

在适当的年龄，选择适当的岗位，尽量去发挥好自己的优势。

我的自动化测试开发之路，一路走来都离不每个阶段的计划，因为自己喜欢规划和总结，

测试开发视频教程、学习笔记领取传送门！！

软件测试凡哥
关注
  • 28
    点赞
  • 踩
  • 25
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Pytest学习笔记（12）-allure特性·@allure.step()和allure.attach
黎晟 的博客
02-14 2740
allure.step()和allure.attach 前言 allure除了支持常用的pytest功能外（ xfails、fixture、skips和skipif、parametrize），自身还有一些强大实用的功能。 本次主要介绍step和attach功能，可以设置测试步骤及添加报告中的附件。 @allure.step() Allure 报告的最重要的方面是它允许对每个测试用例的调用进行非常详细的步骤说明 通过@allure.step装饰器来实现 可以存储在您的测试之外，并在需要时仅导入 Step 方
pytest系列——allure（三）之在测试报告中为测试用例添加附件（@allure.attach()）
mashang_z111的博客
11-07 2223
allure测试报告同样支持显示不同类型的附件，对测试用例、测试步骤以及fixture函数的结果加以补充。或者的作用是为allure测试报告的测试用例执行结果添加附件。
Allure插件常用方法介绍
captain
04-24 1116
Allure是一个强大的测试报告框架，提供了一系列方法来生成漂亮、交互式的测试报告。下面是Allure插件的一些常用方法的详细介绍：attach：将附件添加到报告中。step：创建一个测试步骤。feature：指定测试用例所属的功能特性。story：指定测试用例所属的用户故事。issue：指定测试用例相关的问题或缺陷。severity：指定测试用例的严重程度。link：添加一个链接到测试报告中。这些只是Allure插件的一小部分方法，它们可以帮助您创建更具可读性和可视化效果的测试报告。
自动化测试平台pytest+allure可视化之allure.attach的使用教程
m0_38106954的博客
08-27 1983
allure：在报告中增加附件： ①allure.attach(’arg1’,’arg2’,’arg3’)： 参数详解： arg1：附件 arg2：附件名称 arg3：类型(支持:HTML,JPG,PNG,JSON,OTHER,TEXTXML) 特别注意：参数顺序不能乱。比如插入图片时，图片文件和名称位置错了会报TypeError: Object of type bytes is not JSON serializable ②allure.attach.file(’arg1’,’arg2’,’.
Pytest系列（20）- allure的特性，@allure.step()、allure.attach的详细使用
qq_33801641的博客
04-17 8235
如果你还想从头学起Pytest，可以看看这个系列的文章哦！ https://www.cnblogs.com/poloyy/category/1690628.html 前言 allure除了支持pytest自带的特性之外（fixture、parametrize、xfail、skip），自己本身也有强大的特性可以在pytest中使用 @allure.step allure报告最重...
pytest学习和使用-allure特性总览中的Environment、Categories设置以及Flaky test使用
伤心的辣条
07-18 503
Flaky test在被测对象和测试条件都不变的情况下，有时候失败、有时候成功的测试；实际上就是不稳定的测试，或者随机失败(随机成功)的测试；标记成Flaky是为了当用例失败的情况下，我们能获取足够详细的信息。
学会这些pytest-Allure常用特性allure.attach、allure.step、fixture、environment、categories
最新发布
2301_81967703的博客
05-08 648
在Allure报告的首页可以展示此次测试执行的环境信息 (如测试环境、测试人员、被测系统版本号、系统配置环境等)，这需要通过创建environment.properties或environment.xml进行配置，并把文件放置在--alluredir指定的文件夹中 (博主这里即result文件夹)。它们之间的区别在于，@allure.step()用于标记通用函数，当这个被标记的函数被调用后，会插入步骤说明并展示在Allure报告中。从结果可以看出来，两种方法都在报告中对应的测试用例中展示了附件内容。
码尚 python+requests+pytest+allure+yaml+DDT+logs 接口自动化框-各分支源码总汇
06-07
1pytest插件，运行规则以及参数，pytest.ini配置文 件，跳过用例，用例执行顺序，夹具等 2Fixture固件，contest.py，断言以及Allure报告生成！ 3Allure报告定制以及Parametrize数据驱动 4requests模块详解以及Cookie...
python+requests+pytest+allure+yaml+DDT+logs 接口自动化框架终极版
06-07
2Fixture固件，contest.py，断言以及Allure报告生成！ 3Allure报告定制以及Parametrize数据驱动 4requests模块详解以及Cookie，Session关联处理 5接口统一请求封装和接口关联封装 6接口自动化框架封装之规范YAML测试...
pytest+Allure框架的封装源代码
02-02
本项目实战将探讨如何利用pytest、requests以及Allure框架构建一个高效、详尽的接口自动化测试框架。以下是对这些关键技术的详细解释： 首先，`pytest` 是Python社区广泛使用的单元测试框架，它扩展了Python内置的`...
慧测-Pytest大全详解-道长.docx
08-28
慧测-Pytest大全详解-道长 Pytest 是 Python 一个第三方单元测试框架，具有非凡的第三方插件可以扩展，例如：Allure，兼容 unittest 但比原生 unittest 更高效简洁。Pytest 的安装非常简单，只需要通过 pip 安装...
allure-2.13.0.zip
07-28
1. pytest是一个高度可扩展的测试框架，支持函数、类和模块级别的测试组织，以及参数化、 fixture和标记等高级特性。 2. 它的断言机制非常灵活，允许使用自然语言断言，比如`assert x == y`，还可以自定义断言。 3. ...
学完能涨薪5k的接口自动化测试框架pytest-Allure常用特性allure.attach、allure.step、fixture、environment、categories
MXB1220的博客
12-06 153
也方便你下次能够快速查找。如有不懂还要咨询下方小卡片，博主也希望和志同道合的测试人员一起学习进步在适当的年龄，选择适当的岗位，尽量去发挥好自己的优势。我的自动化测试开发之路，一路走来都离不每个阶段的计划，因为自己喜欢规划和总结，测试开发视频教程、学习笔记领取传送门！！
Pytest（14） - allure参数：@allure.step()、allure.attach
qq_38870503的博客
12-06 3087
@allure.step() 通过 @allure.step() 装饰器，可以对每个测试用例进行详细的步骤说明。 参数说明： @allure.step()只有一个参数，也就是结果图中TestBody中所显示的内容。 使用场景 适用于方法嵌套 参数传递 支持位置参数和关键字参数 {0}，{arg2}，可看第四步那里，如果函数的参数没有匹配成功就会报错哦 # -*- coding: utf-8 -*- import yaml import pytest import allure @allure.step
【转载】Python—Pytest+Allure定制报告
weixin_30378623的博客
07-15 55
原 Python—Pytest+Allure定制报告 2018年12月20日 14:02:13 ElenaYu 阅读数 1358 版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/yu1014745867/article/details/85120334 参考资料： https:...
pytest（三十三）--allure.step()添加测试用例步骤
weixin_44732155的博客
08-01 371
前言 一般流程性的测试用例，写成自动化用例时，步骤较多写起来会比较长。在测试用例里面添加详细的步骤有助于更好的阅读，也方便报错后快速的定位到问题。 举个常见的测试场景用例：从登陆开始，到浏览商品添加购物车，最后下单支付。 用例步骤：1.登陆，2.浏览商品，3.添加购物车，4.生成订单，5.支付成功 用例设计 先把上面的每个环节，写成函数放到c_function.py #c_function.p...
pytest文档38-allure.step()添加测试用例步骤
qq_27371025的博客
06-30 911
前言 一般流程性的测试用例，写成自动化用例时，步骤较多写起来会比较长。在测试用例里面添加详细的步骤有助于更好的阅读，也方便报错后快速的定位到问题。 举个常见的测试场景用例：从登陆开始，到浏览商品添加购物车，最后下单支付 用例步骤：1.登陆， 2.浏览商品 3.添加购物车 4.生成订单 5.支付成功 用例设计 先把上面的每个环节，写成函数放到common_fucntion.py # common_fucntion.py import allure import pytest ''' 流程性的用例，添加测试
pytest学习和使用22-allure特性 丨总览中的Environment、Categories设置以及Flaky test使用
虫无涯的博客
03-21 374
Flaky test在被测对象和测试条件都不变的情况下，有时候失败、有时候成功的测试；实际上就是不稳定的测试，或者随机失败(随机成功)的测试；标记成Flaky是为了当用例失败的情况下，我们能获取足够详细的信息。
pytest selenium allure 失败截图
07-17
要在 pytest 和 Selenium 结合使用时，使用 Allure 进行失败截图，您可以按照以下步骤操作： 1. 确保已安装 `pytest`, `pytest-selenium` 和 `pytest-allure-adaptor`： ```shell pip install pytest pytest-selenium pytest-allure-adaptor ``` 2. 创建一个带有 Allure 报告的测试用例文件，例如 `test_example.py`： ```python import allure import pytest from selenium import webdriver @pytest.fixture(scope="module") def setup(request): driver = webdriver.Chrome() request.cls.driver = driver yield driver.quit() @allure.step("示例测试步骤") def test_example(setup): with allure.step("打开网页"): setup.driver.get("https://www.example.com") with allure.step("断言标题"): assert setup.driver.title == "Example Domain" with allure.step("失败截图"): if not setup.driver.title == "Example Domain": allure.attach(setup.driver.get_screenshot_as_png(), name="失败截图", attachment_type=allure.attachment_type.PNG) ``` 3. 运行测试用例并生成 Allure 报告： ```shell pytest --alluredir=./results ``` 4. 生成 Allure 报告： ```shell allure serve ./results ``` 在运行测试用例后，Allure 将会捕获失败的断言，并生成对应的失败截图。您可以在 Allure 报告中查看这些截图，以便更好地分析和调试测试用例的失败原因。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值