AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

pytest学习和使用23-通俗易懂的聊聊allure常用特性集合及使用方法说明

2023-03-30 124
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： pytest学习和使用23-通俗易懂的聊聊allure常用特性集合及使用方法说明

1 @allure.step()

  • @allure.step()装饰器，可以让测试用例在allure报告中显示详细的测试过程；
  • step() 只有一个参数title，传什么就在allure上就显示什么；
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_step.py
# 作用：@allure.step特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import pytest
import allure

@allure.step("步骤1：用户登陆")
def test_login():
    pass

@allure.step("步骤2：用户数据检查")
def test_check():
    test_login()


if __name__ == '__main__':
    pytest.main(["-s", "test_allure_step.py"])
  • 运行命令再回顾下：
pytest -n auto --alluredir=allure test_allure_step.py
allure serve allure
  • 运行后如下：

在这里插入图片描述
在这里插入图片描述

  • 还有一种场景就是用例之间的嵌套， step() 支持支持位置参数和关键字参数；
  • 如下：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_step1.py
# 作用：@allure.step特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import pytest
import allure

@allure.step("步骤1：用户登陆{0}, {passwd}")
def login(name, passwd):
    pass

@allure.step("步骤2:数据检查")
def check():
    login("zhang", "123456")

@allure.step("步骤3:登陆")
def test_case():
    check()

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

在这里插入图片描述

2 allure.attach

  • allure报告支持显示许多不同类型的附件；
  • 使用方法是：
allure.attach(body, name, attachment_type, extension)
  • 参数说明：
body：附件内容
name：附件名称
attachment_type：附件类型，是 allure.attachment_type 里面的其中一种
extension：附件扩展名
  • 而allure.attachment_type的类型如下，可以查看源码：
class AttachmentType(Enum):

    def __init__(self, mime_type, extension):
        self.mime_type = mime_type
        self.extension = extension

    TEXT = ("text/plain", "txt")
    CSV = ("text/csv", "csv")
    TSV = ("text/tab-separated-values", "tsv")
    URI_LIST = ("text/uri-list", "uri")

    HTML = ("text/html", "html")
    XML = ("application/xml", "xml")
    JSON = ("application/json", "json")
    YAML = ("application/yaml", "yaml")
    PCAP = ("application/vnd.tcpdump.pcap", "pcap")

    PNG = ("image/png", "png")
    JPG = ("image/jpg", "jpg")
    SVG = ("image/svg-xml", "svg")
    GIF = ("image/gif", "gif")
    BMP = ("image/bmp", "bmp")
    TIFF = ("image/tiff", "tiff")

    MP4 = ("video/mp4", "mp4")
    OGG = ("video/ogg", "ogg")
    WEBM = ("video/webm", "webm")

    PDF = ("application/pdf", "pdf")
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_attach.py
# 作用：allure.attach特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure
import pytest

def test_login():
    allure.attach("user01,user02,user03", "用户信息", allure.attachment_type.TEXT)
    pass

在这里插入图片描述

  • allure.attach（）的另一种使用方法为：
allure.attach.file(source, name, attachment_type, extension)
  • 参数说明：
source：文件路径
body：附件内容
name：附件名称
attachment_type：附件类型，是 allure.attachment_type 里面的其中一种
extension：附件扩展名
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_attach.py
# 作用：allure.attach特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure
import pytest

def test_login():
    allure.attach("user01,user02,user03", "用户信息", allure.attachment_type.TEXT)
    pass

def test_login_info():
    allure.attach.file("./user_info.csv", attachment_type=allure.attachment_type.CSV)
    pass

在这里插入图片描述

3 @allure.description()

  • 添加更详细的测试用例描述；
  • 格式为：@allure.description(str），类似于函数声明下方添加 """ """；
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_description.py
# 作用：@allure.description特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure
import pytest

# 使用方法一
@allure.description("""
这个用例的主要所用是验证？
哦，对了，我也不知道干啥的！！！
""")
def test_case01():
    num = 100 * (1 + 9)
    assert num == 1000

# 使用方法二
def test_case02():
    """
    这是一个用例！
    这个用例什么也没做！
    这个用例只是简单做个验证而已~
    """
    pass

在这里插入图片描述
在这里插入图片描述

4 @allure.title()

  • 描述测试用例的标题，可为中文；
  • 格式为：@allure.title(str)
  • 如下：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_title.py
# 作用：@allure.title特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure

@allure.title("用户正常登陆")
def test_login01():
    pass

@allure.title("用户名错误")
def test_login02():
    pass

在这里插入图片描述

  • 另外，allure.title()支持占位符传递关键字参数；
  • 如下：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_allure_title1.py
# 作用：@allure.title特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure
import pytest

@allure.title("用户登陆")
@pytest.fixture
def test_login(request):
    args = request.param
    user = args["name"]
    pwd = args["password"]
    print(user, pwd, args)
    yield user, pwd

@allure.title("正常登陆，用户信息为：{test_login}")
@pytest.mark.parametrize("test_login", [
    {"name": "xiaoli", "password": "123456"},
    {"name": "laoli", "password": "123456"}], indirect=True)
def test_login_info(test_login):
    user, pwd = test_login
    allure.attach(f"用户名：{user}, 密码：{pwd}")

在这里插入图片描述

5 @allure.link()、@allure.issue()、allure.testcase()

  • 为了将allure报告和一些系统集成，可以更快速的跳转到指定地址；
  • 源码为：
def link(url, link_type=LinkType.LINK, name=None):
    return safely(plugin_manager.hook.decorate_as_link(url=url, link_type=link_type, name=name))
  • 参数说明：
issue()和testcase()其实调用的也是link()，只是link_type不一样
url：跳转的链接；
name：可选参数，显示在allure报告的名字，不传则显示完整的链接；
link_type：跳转的type类型；LINK、ISSUE、TEST_CASE，即访问链接、Bug链接、测试用例链接；
总结：三个方法是一样的，只是link_type不一样，allure报告显示的样式不一样。
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_link_issue_testcase.py
# 作用：@allure.link()、@allure.issue()、@allure.testcase()的特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure

@allure.link("https://blog.csdn.net/NoamaNelson")
def test_blog_link():
    pass

@allure.link("https://blog.csdn.net/NoamaNelson", name="点击查看博客主页")
def test_blog_link1():
    pass

@allure.issue('https://bbs.csdn.net/forums/NoamaNelson', '全栈测试技术社区')
def test_blog_issue():
    pass

@allure.testcase("https://bbs.csdn.net/forums/NoamaNelson?category=10003&typeId=1566629", "测试用例地址")
def test_blog_testcase():
    pass

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

6 @allure.epic()、@allure.feature()、@allure.story()

  • allure的三种标记装饰器，可以显示在allure报告上；
  • @pytest.mark 不会显示在allure报告上；
  • 作用：
@allure.epic：往下是 feature
@allure.feature：功能点的描述，模块往下是 story
@allure.story：故事，往下是 title
注意：
story 是 feature 的子集。
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_epic_feature_story.py
# 作用：@allure.epic()、@allure.feature()、@allure.story()特性
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure

def test_case01():
    pass

@allure.story('epic01')
def test_case02():
    pass

@allure.story('story01')
def test_case03():
    pass

@allure.story('story02')
def test_case04():
    pass

@allure.feature('feature02')
@allure.story('story02')
def test_case05():
    pass

在这里插入图片描述

7 @allure.severity

  • 在 allure 报告可以看到不同级别用例的缺陷数量，即标记用例级别 ；
  • 使用方法：
@allure.severity(allure.severity_level.xxx)
# xxx为级别
  • 比如@allure.severity(allure.severity_level.TRIVIAL)，可以看下源码：
class Severity(str, Enum):
    BLOCKER = 'blocker'
    CRITICAL = 'critical'
    NORMAL = 'normal'
    MINOR = 'minor'
    TRIVIAL = 'trivial'
  • 从以上可以看出有5个等级，分别是：
blocker：阻塞缺陷
critical：严重缺陷
normal： 一般缺陷
minor：次要缺陷
trivial： 轻微缺陷
  • 举例：
# -*- coding:utf-8 -*-
# 作者：虫无涯
# 日期：2023/3/28 
# 文件名称：test_severity.py
# 作用：@allure.severity标记用例级别
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import allure

# @allure.severity(allure.severity_level.NORMAL)
@allure.severity("normal")
@allure.description("""normal级别用例""")
def test_case01():
    print("用例01")

# @allure.severity(allure.severity_level.CRITICAL)
@allure.severity("critical")
@allure.description("""critical级别用例""")
def test_case02():
    print("用例02")

# @allure.severity(allure.severity_level.BLOCKER)
@allure.severity("blocker")
@allure.description("""blocker级别用例""")
def test_case03():
    print("用例03")

# @allure.severity(allure.severity_level.MINOR)
@allure.severity("minor")
@allure.description("""minor级别用例""")
def test_case04():
    print("用例04")

# @allure.severity(allure.severity_level.TRIVIAL)
@allure.severity("trivial")
@allure.description("""trivial级别用例""")
def test_case05():
    print("用例05")

@allure.description("""没标记,默认为 normal""")
def test_case06():
    print("用例06")

在这里插入图片描述

  • 没标记的默认normal：

在这里插入图片描述

  • 图表样式：

在这里插入图片描述

  • 也可以使用命令行参数 allure-severities根据优先级选择需要运行的测试用例，比如：
pytest test_severity.py -sq --alluredir=./allure --allure-severities=blocker,critical
用例02
.用例03
.
2 passed in 0.10s
文章标签：
测试技术
虫无涯
目录
相关文章
Deephub
|
4月前
|
Python
11个提升Python列表编码效率的高级技巧
Python中关于列表的一些很酷的技巧
Deephub
54 1
啊猪是的读来过倒
|
5月前
|
数据处理 Python
从零开始学迭代器生成器：打造高效、易读的Python代码
从零开始学迭代器生成器：打造高效、易读的Python代码
啊猪是的读来过倒
45 7
智物科技库
|
4月前
|
SQL 存储 算法
一些使用python过程中的小贴士
摘要： 在Python中，`type`是一个特殊类型，既是类型也是对象。`isinstance()`函数表明`type`和`object`都是类型并且是彼此的基类。`all()`和`any()`函数分别检查可迭代对象的所有元素是否都为真或至少有一个元素为真。链式操作如`==`和`in`具有相同的优先级，从左到右结合，可能导致意外的结果，例如`False == False in [False]`实际上是`True`，因为`False in [False]`先计算并返回`True`，然后与`False == True`比较。
智物科技库
18 1
小空门123-30335
|
4月前
|
前端开发 JavaScript API
MkDocs是一个用Python编写的快速、简单且易于定制的静态网站生成器
MkDocs是一个用Python编写的快速、简单且易于定制的静态网站生成器
小空门123-30335
45 0
龙大吉
|
6月前
|
测试技术 Python
Python 高级主题：如何实现一个简单的 Python 单元测试？
Python单元测试示例：使用`unittest`模块测试`my_function`函数。定义函数`my_function(x)`返回`x*2`，然后创建`TestMyFunction`类继承`unittest.TestCase`，包含两个测试方法检验不同输入。通过`unittest.main()`运行测试。遵循小写字母命名测试方法和使用断言检查结果的最佳实践。可选`pytest`等第三方库进行复杂测试。
龙大吉
30 1
sumith
|
6月前
|
Python
Python基础学习 -- 生成器与装饰器
Python基础学习 -- 生成器与装饰器
sumith
30 0
Carl_奕然
|
自然语言处理 搜索推荐 索引
Python3，我只用一段代码，就写了个词云生成器，功能强大到怀疑人生。
Python3，我只用一段代码，就写了个词云生成器，功能强大到怀疑人生。
Carl_奕然
94 0
北京-宏哥
|
测试技术 数据库 Python
python接口自动化（二十二）--unittest执行顺序隐藏的坑（详解）
大多数的初学者在使用 unittest 框架时候，不清楚用例的执行顺序到底是怎样的。对测试类里面的类和方法分不清楚，不知道什么时候执行，什么时候不执行。虽然或许通过代码实现了，也是稀里糊涂的一知半解，这样还好，好歹自己鼓 捣出了，但是时间和效率并不是很高，下次遇到还是老样子。那么本篇通过最简单案例来给给为小伙伴详细讲解、演示一下 unittest 执行顺序。
北京-宏哥
256 0
python接口自动化（二十二）--unittest执行顺序隐藏的坑（详解）
北岛末巷
|
Python
Python学习笔记第十一天(迭代器与生成器)
Python学习笔记第十一天讲解迭代器、StopIteration、生成器的用法。
北岛末巷
90 0
Python学习笔记第十一天(迭代器与生成器)
pbruxexakfzni
|
测试技术 Python
pytest基本用法简介
pytest基本用法简介
pbruxexakfzni
172 0
pytest基本用法简介

热门文章

最新文章

  • 1
    Flutter之禅 内存优化篇
  • 2
    《Cadence 16.6电路设计与仿真从入门到精通》——2.4 Design Entry CIS原理图图形界面　
  • 3
    记一次对网络抖动经典案例的分析
  • 4
    国外成人网站xHamster大量用户信息黑市变卖，部分账号涉及英美政府官员
  • 5
    用户密码以BCrypt加密的方式来防范被破解
  • 6
    带你理清CPU，cache和存储器之间的逻辑运作
  • 7
    Git设置代理服务器
  • 8
    【DSW Gallery】PAI-DSW开通及授权
  • 9
    吐血整理：机器学习的30个基本概念，都在这里了（手绘图解）
  • 10
    MOSS站点的迁移(备份还原)
  • 1
    设计模式之 5 大创建型模式，万字长文深剖 ，近 30 张图解！
    49
  • 2
    《C++新特性：为多线程数据竞争检测与预防保驾护航》
    41
  • 3
    Kotlin - 区间与数组
    41
  • 4
    Kotlin - 参数与异常
    39
  • 5
    Kotlin - 运算符与中缀表达式
    34
  • 6
    Kotlin - 函数与Lambda表达式
    23
  • 7
    Kotlin - 分支与循环
    19
  • 8
    天气预报1天-中国气象局-地址查询版免费API接口教程
    20
  • 9
    《C++智能合约与区块链底层交互全解析：构建坚实的去中心化应用桥梁》
    19

    • 相关课程

    更多
  • Python语言基础 - 语法入门
  • Python Web开发基础
  • Python 脚本进阶
  • 【Python入门】Python数据处理编程基础
  • Go语言核心编程 - 面向对象、文件、单元测试、反射、TCP编程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • Python第五讲——关于爬虫如何做js逆向的思路
  • Python 脚本速查手册
  • Python系列直播第一讲——Python中的一切皆对象

    • 相关实验场景

    更多
  • 用Python画圣诞树
  • 语言入门-1：环境构建
  • Python选择及循环结构
  • 云端Python及基本操作
  • Python网络通信程序典型应用
  • Python新手入门
    • 下一篇
    阿里云OSS设置跨域访问