Pytest测试框架系列 - allure 报告进阶使用

最新推荐文章于 2024-04-26 21:53:40 发布
最新推荐文章于 2024-04-26 21:53:40 发布
阅读量1.6k 收藏 6
点赞数 2
分类专栏： pytest 系列 文章标签： python
本文版权归原作者所有，仅供学习参考之用，转载请注明出处未经作者允许请务必保留此段声明！
本文链接：https://blog.csdn.net/u010454117/article/details/118769461
版权

前言

上一篇文章我们讲解了pytest allure的使用，但是还有一些知识点我们还没有学会，下面让我们继续学习，更加灵活的使用allure报告。

进阶功能

  • allure 命令行参数
  • 与参数化 parametrize 结合使用
  • allure.dynamic 动态更新信息
  • allure 报告显示环境配置信息

Allure 命令行参数

前面文章我们学习了很多命令行参数，这里说的是allure相关的命令行参数，主要用来用例筛选，跟前面用例标记一样，这里的标记不需要我们新建标记，由于我们在使用allure属性的时候用例已经标记。

我们可以通过 pytest -h，查看有哪些命令参数

--allure-severities=SEVERITIES_SET
                        Comma-separated list of severity names.
                        Tests only with these severities will be run.
                        Possible values are: blocker, critical, normal, minor, trivial.
  --allure-epics=EPICS_SET
                        Comma-separated list of epic names.
                        Run tests that have at least one of the specified feature labels.
  --allure-features=FEATURES_SET
                        Comma-separated list of feature names.
                        Run tests that have at least one of the specified feature labels.
  --allure-stories=STORIES_SET
                        Comma-separated list of story names.
                        Run tests that have at least one of the specified story labels.
  --allure-ids=IDS_SET  Comma-separated list of IDs.
                        Run tests that have at least one of the specified id labels.
  --allure-link-pattern=LINK_TYPE:LINK_PATTERN
                        Url pattern for link type. Allows short links in test,
                        like 'issue-1'. Text will be formatted to full url with python
                        str.format().

从上面可以看出来常用命令行参数，但是常用的就是2个：

  • –allure-epics=EPICS_SET
  • –allure-severities=SEVERITIES_SET

–allure-epics=EPICS_SET 根据业务功能执行用例，关键代码示例：

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/14 14:46
# @Author　 : king
# @File　　  :test_allure.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import logging
import allure
import pytest
from class_06.case_step import step_02, step_01, step_03, step_04, step_05

@allure.epic("教材")
@allure.feature("教材管理")
class TestTextBook:

    @allure.story("添加教材成功")
    @allure.testcase("http://XXX.XXX.x.x:8081/butly/testcase-1.html")
    @allure.issue("http://XXX.XXX.x.x:8081/butly/bug-1.html")
    @allure.link("https://blog.csdn.net/u010454117")
    @allure.title("添加教材")
    @allure.description_html("<h2><font color='red'>正常添加教材</font></h2>")
    @allure.severity(allure.severity_level.BLOCKER)
    def test_add_textbook(self):
        """用例描述:
        1.在教材界面，点击新增按钮
        2.在新增教材界面，选择教材版本、章节信息
        3.点击确定按钮
        """
        logging.info("开始添加教材操作")
        step_01()
        step_02()
        step_05()
        logging.info("添加教材完成")

    @allure.testcase("http://XXX.XXX.x.x:8081/butly/testcase-2.html")
    @allure.issue("http://XXX.XXX.x.x:8081/butly/bug-3.html")
    @allure.link("https://blog.csdn.net/u010454117")
    @allure.title("删除教材")
    @allure.story("删除教材成功")
    @allure.description("正常删除教材数据")
    @allure.severity(allure.severity_level.CRITICAL)
    def test_delete_textbook(self):
        """用例描述:
        1.在教材界面，选择需要删除的教材
        2.在教材界面，点击删除按钮
        3.再确认删除界面，点击确定按钮
        """
        logging.info("开始删除教材操作")
        step_03()
        step_04()
        logging.info("删除教材完成")

@allure.epic("资源")
@allure.feature("资源管理")
class TestResources:

    @allure.testcase("http://XXX.XXX.x.x:8081/butly/testcase-5.html")
    @allure.issue("http://XXX.XXX.x.x:8081/butly/bug-5.html")
    @allure.link("https://blog.csdn.net/u010454117")
    @allure.title("添加资源")
    @allure.story("添加资源成功")
    @allure.severity(allure.severity_level.BLOCKER)
    def test_add_resources(self):
        """用例描述:
        1.在资源界面，点击添加的资源
        2.在资源预览界面，点击添加按钮
        """
        logging.info("开始添加资源操作")
        step_01()
        step_02()
        step_05()
        logging.info("添加资源完成")

    @allure.testcase("http://XXX.XXX.x.x:8081/butly/testcase-6.html")
    @allure.issue("http://XXX.XXX.x.x:8081/butly/bug-6.html")
    @allure.link("https://blog.csdn.net/u010454117")
    @allure.title("删除资源")
    @allure.story("删除资源成功")
    @allure.severity(allure.severity_level.CRITICAL)
    def test_delete_resources(self):
        """用例描述:
        1.在备课界面，点击资源的删除按钮
        2.在资源删除确定界面，点击确定按钮
        """
        logging.info("开始删除资源操作")
        step_01()
        step_04()
        logging.info("删除资源完成")
        assert "删除成功" == "删除成功"

if __name__ == '__main__':
    pytest.main()

在命令行执行命令 pytest -v --alluredir ./report/allure --allure-epics=资源, 查看结果：从执行结果看出来，只执行了两条用例。
执行结果

–allure-severities=SEVERITIES_SET 根据用例等级执行

演示代码上述一样，在命令行执行命令 pytest -v --alluredir ./report/allure --allure-severities=blocker, 查看结果：从执行结果看出来，只执行了两条用例。
执行结果
使用allure命令行参数筛选，减少了在手动打标记的操作，使用场景： 冒烟用例可以标记为block、或者只允许一个业务的功能等

与参数化 parametrize 结合使用

我们特别在做接口自动化的时候，参数化场景使用的很多，我们先来看下参数化和allure报告基本结合的示例：

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/16 22:14
# @Author　 : king
# @File　　  :test_allure_params.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import allure
import pytest


datas = [
    {"user": "king", "pwd": 123456},
    {"user": "king1", "pwd": 1234567},
    {"user": "hello", "pwd": 123456}
]

@pytest.mark.parametrize("data", datas)
def test_login(data):
    print(data)
    assert data["user"].startswith("king") and data["pwd"] == 123456

if __name__ == '__main__':
    pytest.main(["-s", "-v"])

我们执行 pytest --alluredir ./report test_allure_params.py 和 allure serve ./report 后，查看 allure 报告。
执行结果
现在看这个报告，用例标题显示的不太友好，可读性不强，我们可以通过三种方式进行优化

  • 通过给@pytest.mark.parametrize 增加一个参数 ids，前面讲解参数化的时候讲解过
  • 通过@allure.title()增加
  • 通过allure.dynamic.title(title) 动态修改属性(后面讲解)

通过给@pytest.mark.parametrize

示例：

@pytest.mark.parametrize("data", datas, 
ids=["正确的用户名和密码", "正确的用户名和错误的密码", "不存在的用户名和密码"])
def test_login(data):
    print(data)
    assert data["user"].startswith("king") and data["pwd"] == 123456

我们再次执行 pytest --alluredir ./report test_allure_params.py 和 allure serve ./report 后，查看 allure 报告，现在看起来用例标题是不是友好很多了
执行结果

通过@allure.title()

示例：

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/16 23:39
# @Author　 : king
# @File　　  :test_allure_params1.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import allure
import pytest

datas = [
    {"user": "king", "pwd": 123456, "information": "正确的用户名和密码"},
    {"user": "king1", "pwd": 1234567, "information": "正确的用户名和错误的密码"},
    {"user": "hello", "pwd": 123456, "information": "不存在的用户名和密码"}
]

@pytest.mark.parametrize("data", datas)
@allure.title('{data[information]}')
def test_login(data):
    print(data)
    assert data["user"].startswith("king") and data["pwd"] == 123456

if __name__ == '__main__':
    pytest.main(["-s", "-v"])

我们继续再次执行 pytest --alluredir ./report test_allure_params.py 和 allure serve ./report 后，查看 allure 报告，现在看起来用例标题更加简洁
执行结果

allure.dynamic 动态更新信息

有时候我们需要根据用例信息动态显示信息，这样我们就需要在用例执行期间或者用例执行完成修改我们的展示信息，这就用到了动态更新信息功能。

  • allure.dynamic.feature
  • allure.dynamic.link
  • allure.dynamic.issue
  • allure.dynamic.testcase
  • allure.dynamic.story
  • allure.dynamic.title
  • allure.dynamic.description

我们这里就讲下常用的 allure.dynamic.title 和 allure.dynamic.description

场景：我们根据标识来进行不同的逻辑判断执行不同的方法

示例：

# !/usr/bin/python3
# _*_coding:utf-8 _*_
""""
# @Time　　:2021/7/17 0:11
# @Author　 : king
# @File　　  :test_update_info.py
# @Software  :PyCharm
# @blog     :https://blog.csdn.net/u010454117
# @WeChat Official Account: 【测试之路笔记】
"""
import allure
import pytest

def login(user, pwd):
    if user.startswith("king") and pwd == 123456:
        print("用户登录成功！")
        return True
    print("用户登录失败！")
    return False

def home(user):
    print("{} 您好，欢迎登录系统！".format(user))

datas = [
    {"user": "king", "pwd": 123456},
    {"user": "king1", "pwd": 1234567},
    {"user": "hello", "pwd": 123456}
]

@pytest.mark.parametrize("data", datas)
def test_login(data):
    flag = login(data["user"], data["pwd"])
    if flag:
        allure.dynamic.title("登录成功，进入首页")
        description = """
            1.登录系统，登录参数为，用户名：{} ，密码 {}
            2.进入首页
        """.format(data["user"], data["pwd"])
        allure.dynamic.description(description)
        home(data["user"])
    else:
        allure.dynamic.title("登录失败，提示错误信息")
        description = """
                    1.登录系统，登录参数为，用户名：{} ，密码 {}
                    2.登录失败，提示错误信息
                """.format(data["user"], data["pwd"])
        allure.dynamic.description(description)
        allure.dynamic.title("登录失败,登录用户名：{} ，密码 {}".format(data["user"], data["pwd"]))
        raise

if __name__ == '__main__':
    pytest.main()

我们执行 pytest --alluredir ./report test_updata_info.py 和 allure serve ./report 后，查看 allure 报告
执行结果
动态修改信息就讲到这里，其他动态更新信息方法可以自己动手实践一下，但是这里大家可能有个疑问，当时同时存在 allure.dynamic.title 、@allure.title() 和 ids 时，那该怎么显示呢？

通过源码..\Lib\site-packages\allure_pytest\utils.py 的111行可以看出来优先级：

def allure_name(item, parameters):
    name = escape_name(item.name)
    title = allure_title(item)
    return title.format(**{**parameters, **item.funcargs}) if title else name

具体执行过程就不做多讲解，大家选择使用其中一种方式即可。

优先级：allure.dynamic.title > @allure.title() > ids

allure 报告显示环境配置信息

从allure报告总览页面看见，环境区域显示为空，既然有这个功能，我们就能够配置环境。
allure 环境显示
根据官方文档说明：
环境配置
要将信息添加到环境小部件，只需在生成报告之前创建environment.properties（或environment.xml）文件到allure-results目录

  • environment.properties
  • environment.xml

environment.properties 示例
环境变量
environment.properties

platform=Windows
python.Version=3.7.0
pytest.Version=6.2.4
allure-pytest.Version=2.9.43
project=lecture
User=king

我们执行 allure serve ./report 后，查看 allure 报告，查看环境区域显示
环境显示
environment.xml 方式
示例
environment.xml

<environment>
    <parameter>
        <key>platform</key>
        <value>Windows</value>
    </parameter>
    <parameter>
        <key>python.Version</key>
        <value>3.7.0</value>
    </parameter>
    <parameter>
        <key>pytest.Version</key>
        <value>6.2.4</value>
    </parameter>
    <parameter>
        <key>allure-pytest.Version</key>
        <value>2.9.43</value>
    </parameter>
    <parameter>
        <key>project</key>
        <value>Lecture</value>
    </parameter>
        <parameter>
        <key>User</key>
        <value>king</value>
    </parameter>
</environment>

我们执行 allure serve ./report 后，查看 allure 报告，查看环境区域显示
执行环境
问题：我们现在每次都是在结果界面新建并输入，但是我们如果代码自动执行时，肯定不能手动新建环境配置文件

解决方法：我们可以新建一个文件复制方法将环境配置文件，在生成报告之前复制到执行结果目录，或者直接在结果目录代码新建配置文件并写入环境信息

总结

  • allure 命令行参数，使用allure命令行参数筛选，减少手动打标记的操作，使用场景： 冒烟用例可以标记为block、或者按照业务功能用例执行等，执行用例时根据命令行参数筛选指定用例
  • 与参数化 parametrize 结合使用，主要是更新用例属性信息，使用报告内容显示更加友好
  • allure.dynamic 动态更新信息，我们需要根据用例信息动态显示信息，这样我们就需要在用例执行期间或者用例执行完成修改我们的展示信息
  • allure 报告显示环境配置信息，要将环境信息添加到报告模块，只需在生成报告之前创建environment.properties（或environment.xml）文件到allure-results目录

以上为内容纯属个人理解，如有不足，欢迎各位大神指正，转载请注明出处!

如果觉得文章不错，欢迎关注微信公众号，微信公众号每天推送相关测试技术文章
个人微信号

测试之路king
关注
  • 2
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
windows使用pytest-allure生成测试报告转成为html文件
06-18
在Windows操作系统中，使用pytest-allure框架生成测试报告并将其转换为HTML文件是自动化测试过程中一个常见的需求。pytest-allure是Allure Framework的一个插件，它提供了美观且功能丰富的测试结果展示方式，使得...
4-Pytest框架+Allure-V8.3-2021.01.18.pdf
01-27
4. 生成测试报告：使用--allure-dir选项生成测试报告，例如pytest test_sample.py --allure-dir=./report。 pytest框架和Allure测试报告的应用场景： 1. 单元测试：pytest框架和Allure测试报告可以用于单元测试，...
从0到1精通自动化测试，pytest自动化测试框架，allure描述用例详细讲解（二十二）
2301_78276982的博客
07-03 173
pytest+allure是最完美的结合了，关于allure的使用，本篇做一个总结。
世界级别allure
active2的博客
01-28 678
1、前言 pytest+allure是最完美的结合了，关于allure的使用，本篇做一个总结。 allure报告可以很多详细的信息描述测试用例，包括epic、feature、story、title、issue、testcase、severity等 环境准备 2、安装及配置 allure用例描述 使用方法 参数值 参数说明 @allure.epic() epic描述 敏捷里面的概念，定义史诗，往下是feature @allure.feature() 模块名..
Python测试框架pytest（28）测试报告Allure - 动态生成标题、动态生成功能、报告添加用例失败截图
Meng
11-03 7421
目录 1、动态生成标题 1.1、示例一：参数化无标题 1.2、示例二：参数化有标题 1.3、示例三：参数化使用ids 1.4、示例四：参数化动态生成标题 1.5、示例五：参数化动态生成标题优化 2、动态生成功能 2.1、示例一：allure.dynamic.title() 2.2、示例二：allure.dynamic.description() 2.3、示例三：结合@pytest.mark.parametrize() 2.4、示例四：全部方法示例 3、报告添加用例失...
从0到1精通自动化测试，pytest自动化测试框架，allure标记用例级别severity（二十一）
2301_78276982的博客
07-01 1027
我们在做功能测试的时候，执行完一轮测试用例，输出测试报告的时候，会有统计缺陷的数量和等级在做自动化测试的过程中，当你的测试用例越来越多的时候，如果执行一轮测试发现了几个测试不通过，我们也希望能快速统计出缺陷的等级pytest结合allure框架可以对用例的等级做详细的划分。
allure简介
weixin_50464533的博客
02-21 3177
allure简介
csdn最新最全 Allure快速入门 自动化测试报告
分享测试知识
04-08 4355
目录 1.关于Allure 2.Allure安装 3.Allure用法 3.1 语法格式 3.2 常用option和command 4.Allure报告结构 5.Allure特性 5.1 Flaky 5.2 Environment 5.3 Categories 6.Allure与Pytest集成 6.1 Allure行为驱动 6.2 Allure和Pytest安装 6.3 Allure与Pytest集成示例 1.关于Allure     Allure框架是一个..
Airtest+Pytest+Allure框架demo
04-16
Allure支持多种测试框架，包括Pytest，能够整合不同框架的测试结果，生成包括测试步骤、日志、断言信息和缺陷跟踪在内的综合报告。这对于团队协作和测试结果的沟通非常有帮助，可以清晰地展示测试的覆盖情况和问题...
Pytest02:介绍pytest项目框架结构-附件资源
03-05
Pytest02:介绍pytest项目框架结构-附件资源
pytest自动化测试框架学习源码01
01-27
在学习`pytestDemo`时，你可能会遇到引入某些插件的配置，如`pytest-cov`用于代码覆盖率报告。 7. **异常处理**：pytest会捕获并报告任何未处理的异常，使得测试失败的原因一目了然。这对于调试和修复问题非常有...
Allure精通指南（05）定制化报告内容（环境信息、图标、缺陷类别）
最新发布
weixin_54217348的博客
04-26 798
想要深入了解pytest，成为Python测试领域的大佬吗？本教程系列将带你从零开始，逐步掌握pytest的核心知识和高级技巧。无论你是初学者还是进阶者，都能在这里找到适合自己的突破点。开启pytest学习之旅，为自动化测试工作扬帆起航！
ALLURE架构整理
lw的博客
06-06 1294
ALLURE1.开始安装1.1.安装命令行1.1.1. Linux1.1.2. Mac OS X1.1.3. Windows1.1.4. 手动安装2.报告结构2.1.总览页面2.2.类别2.3.测试套2.4.图表2.5.时间刻度2.6.功能2.7.包2.8测试用例页面3.Pytest与Allure3.1. 安装3.2. 用法示例：3.3. 基本报告3.4. 支持的 Pytest 功能XfailskipifFixtures 和 finalizersParametrization3.5 Allure Featu
Allure扩展的各种文件类型
weixin_48595415的博客
11-19 514
在自动化测试中，可以运用allure的该功能对成功或失败的测试用例进行说明。如：失败时保存该条用例的录屏，截图，json文件等等。 allure扩展测试用例常用的文件类型如下： TEXT、CSV、THML、XML、JSON、YAML、PNG、JPG、MP4、PDF 使用方法： 1、导入allure包 2、在用例执行前（或中或后）进行扩展 3、语法，举两个例子。 以TEXT为例： allure.attach('this is text',attachment_type=all...
Java(38).Allure报告--注解(定制测试报告)
fen_fen的专栏
10-01 2491
1.Allure注解分类 Allure注释大致可分类如下： /**@Epic -Epics可用作您的产品或项目的大量需求的占位符。Epic将在适当的时候分为较小的用户故事。 *用户故事可以拆分为较小的任务，并且可以是较大的Feature和Epic的一部分。 */ @Epic @Features //是一个标注信息注解，但是改标注可以把相同的标注统一到相同模块下用于筛选 @Stories/@Story //使用@Severity批注测试缺陷等
Python Allure注解释义/装饰器解释和allure的方法(上传文件等)使用示例
Franciz777的博客
04-23 3987
目录标题Allure的装饰器解释@allure.parent_suite,@allure.suite,@allure.sub_suite@allure.epic, @allure.feature, @allure.story,@allure.title@allure.id,@allure.link,@allure.label,@allure.issue,@allure.description,@allure.severity,@allure.tag,@allure.testcase,@allure.desc
Pytest--使用与调用
How2Code的博客
03-17 8876
1. 通过python -m pytest调用pytest 你可以通过python的解释器来执行测试： python -m pytest 这和直接执行pytest [...]命令的效果几乎是一样的。 2. pytest执行结束时返回的状态码 运行pytest可能导致六种不同的退出代码： ExitCode0：所有收集到的测试用例通过 ExitCode1：测试已收集并运行，但有些测试失败 ExitCode2：测试执行被用户中断 ExitCode3：执行测试时发生内部错误 ExitCode4：pytest命令
pytest assume无法导入：解决ImportError: cannot import name ‘assume‘ from ‘pytest‘问题
tianshuiyimo的博客
05-08 4470
代码如下： from pytest import assume 报错： ImportError: cannot import name ‘assume’ from ‘pytest’ (C:\Users\zeng\AppData\Local\Programs\Python\Python39\lib\site-packages\pytest_init_.py) 首先复制了这段报错信息百度，百度有两种说法，一种说法是因为我的.py文件和python内置模块的文件名相同，所以导致ide无法区分，而导入失败。但检查
allure报告---动态显示模块名和用例标题
lixiaomei0623的专栏
09-13 4901
一、allure报告动态参数化展示模块名和用例标题 使用@pytest.mark.parametrize 参数化完成数据驱动时，如果标题写死或者使用别名的方式 这样在报告中的可读性也不高 如何更美观的展示报告，增加报告的可读性呢，我们需要把从excel中获取到的sheetName作为动态的模块名，caseName作为每条用例的名称 方法一：allure.dynamic 动态属性 只需要增加两行代码，如下图所示： 修改后的allure报告，动态的展示了模块名称和用例标题 上边用的是下...
如何升级allure-pytest和pytest-allure的版本
06-09
您可以使用以下命令升级allure-pytest和pytest-allure的版本： ``` pip install --upgrade allure-pytest pytest-allure-adaptor ``` 这会将您的allure-pytest和pytest-allure适配器升级到最新版本。确保在执行此命令之前，您已经安装了pip和相应的python环境。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

测试之路king

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值