Pytest+Allure+Excel接口自动化测试框架实战

news2024/11/18 5:40:11

1. Allure 简介

简介

Allure 框架是一个灵活的、轻量级的、支持多语言的测试报告工具，它不仅以 Web 的方式展示了简介的测试结果，而且允许参与开发过程的每个人可以从日常执行的测试中，最大限度地提取有用信息。

Allure 是由 Java 语言开发的，支持 Pytest，JaveScript、PHP、Ruby 等。

  • 从 DEV/QA 的角度来看，Allure 提供了详尽的测试报告，比如简化了常见缺陷的统计；失败的测试可以分为 bug 和被中断的测试；还可以配置日志、步骤、fixture、附件、计时、执行历史；以及与 TMS、BUG 管理系统、Jenkins 集成等。所以，通过以上配置，所有负责的开发人员和测试人员可以尽可能地掌握测试信息。
  • 从管理者的角度来看，Allure 提供了一个清晰的“大图”，即 High Level 的统计报告，其中包括已覆盖的特性、缺陷聚集的位置、执行时间轴的外观以及许多其他方便的事情。Allure 的模块化和可扩展性保证了你总是能够对某些东西进行微调，使得 Allure 更适合你。

那么下面就来说说如何使报告更加详细的显示我们需要的信息，以及 Allure 与 Jenkins 的集成。

安装

（Windows/Mac 通用安装方法）

下载地址：https://github.com/allure-framework/allure2/releases，下载所需版本的 zip 包。

安装：

  1. 解压 —> 进入 bin 目录 —> 运行 allure.bat
  2. 把 bin 目录加入 Path 环境变量
  3. 配合 pytest，使用 allure2 生成更加精美的测试报告：pip install allure-pytest

运行方法

在测试执行期间收集结果

pytest [测试文件] -s -q --alluredir=./result/ --clean-alluredir
  • -s：表示将执行成功的案例日志打印出来
  • -q：若跟文件执行路径则代表只需要执行的文件
  • --alluredir：指定存储测试结果的路径（若目录不存在则会新建）
  • --clean-alluredir：清除历史结果数据

查看测试报告

方式一：用于在本地渲染后对外展示结果

allure serve ./result/

方式二：用于在本地渲染和查看结果

# 生成报告
allure generate ./result/ -o ./report/ --clean  # 注意：覆盖路径加 --clean

# 打开报告
allure open -h 127.0.0.1 -p 8883 ./report/

注意：/report/ 目录中的 index.html 就是最终的结果页面，但直接通过浏览器打开这个文件是看不到实际报告内容的，这是因为实际报告内容需要 allure 进行渲染后才能看到

这可能是B站最详细的pytest自动化测试框架教程，整整100小时，全程实战！！！

2. Allure 常用特性

场景：

  • 希望在报告中看到测试功能，子功能或场景，测试步骤，包括测试附加信息。

解决：

  • import allure
  • @allure.feature('功能名称')
  • @allure.story('子功能名称')
  • @allure.title('测试用例名称')
  • @allure.step('步骤细节')
  • @allure.description('测试用例描述')
  • @allure.attach('具体文本信息')：需要附加的信息，可以是数据，文本，图片，视频，网页
  • 如果只测试登录功能运行的时候可以加限制过滤，如：pytest 文件名 --allure_features '购物车功能' --allure_stories '加入购物车'

@alllure.feature() 与 @allure.store() 的关系

feature 相当于一个大的功能或模块。将 case 分类到某个 feature 中，并在报告中的 behaviors 中显示，相当于 testsuite。

story 相当于分支功能/模块，属于 feature 之下的结构，并在报告中的 features 中显示，相当于 testcase。

feature 与 story 类似于父子关系。

@allure.step() 与 with allure.step() 的区别

  • 测试过程中每个步骤，一般放在具体逻辑方法中。
  • 可以放在关键步骤中，在报告中显示。
  • 在 App、Web 自动化测试当中，建议每切换到一个新的页面当做一个 step。
  • 用法：
    • @allure.step()：只能以装饰器的形式放在类或者方法上。
    • with allure.step()：可以放在测试用例方法里面，但测试步骤的代码需要被该语句包含。

给测试用例划分优先级

场景：

通常测试有冒烟测试、回归测试、线上验证测试等，那么就需要按照重要性级别来分别执行，比如上线时要把主流程和重要模块都跑一遍。

解决：

  • 通过附加 pytest.mark 标记描述
  • 通过 allure.feature、allure.story 标记描述
  • 通过 allure.severity 直接标记用例级别

根据测试用例的重要性划分测试用例等级，如果没指定等级，默认为 NORMAL 级别：

  • BLOCKER：阻塞缺陷（功能未实现，无法下一步）
  • CRITICAL：严重缺陷（功能点缺失）
  • NORMAL：一般缺陷（边界情况，格式错误）
  • MINOR：次要缺陷（界面错误与ui需求不符）
  • TRIVIAL：轻微缺陷（必须项无提示，或者提示不规范）

步骤： 

  1. 在方法、函数和类上面加：@allure.severity(allure.severity_level.TRIVIAL)
  2. 指定执行对应级别的用例：pytest -s -v 文件名 --allure-severities normal, critical

给 Allure 测试报告添加内容（图片、附件、文本、截图、HTML 等）

场景：

  • 前端自动化测试经常需要附加图片或 html，比如在适当的地方、适当的时机截图等。

解决：

  • @allure.attach() 显示许多不同类型的提供的附件，可以补充测试、步骤或测试结果。

步骤：

  • 在测试报告里附加网页：
    • 格式：allure.attach(body(内容), name, attachment_typeextension)
    • 示例：allure.attach('<head>/head><body>首页</body>', '这是错误页的结果信息', allure.attachment_type.HTML)
  • 在测试报告里附加图片：
    • 格式：allure.attach.file(source, name, attachment_type, extension)
    • 示例：allure.attach.file("./result/b.png", attachment_type=allure.attachment_type.PNG)

集成测试管理系统

@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))

def issue(url, name=None):
    return link(url, link_type=LinkType.ISSUE, name=name)

def testcase(url, name=None):
    return link(url, link_type=LinkType.TEST_CASE, name=name)

小结

  • issue() 和 testcase() 其实调用的也是 link()，只是 link_type 不一样。
  • 必传参数 url：跳转的链接。
  • 可选参数 name：显示在 Allure 报告的名字，如果不传就是显示完整的链接（建议传，不然可读性不高）。
  • 可以理解成：三个方法是一样的，我们都提供跳转链接和名字，只是链接的 type 不一样，最终显示出来的样式不一样而已（type 不一样，样式不一样）。
  • 如果你喜欢，只用 @allure.link() 也可以。
  • 而出现三个装饰器的原因是为了更好地将链接进行分类（访问链接、Bug 链接、测试用例链接）。

代码示例


import allure

TEST_CASE_LINK = 'https://github.com/qameta/allure-integrations/issues/8#issuecomment-268313637'

@allure.link('https://www.youtube.com/watch?v=4YYzUTYZRMU')
def test_with_link():
    pass

@allure.link('https://www.youtube.com/watch?v=Su5p2TqZxKU', name='点击我看一看youtube吧')
def test_with_named_link():
    pass

@allure.issue('140', 'bug issue链接')
def test_with_issue_link():
    pass

@allure.testcase(TEST_CASE_LINK, '测试用例地址')
def test_with_testcase_link():
    pass

运行结果，查看 Allure 报告

3. 接口自动化测试框架示例

完整工程：https://github.com/juno3550/InterfaceAutoTestWithPytest

测试方法示例

 1 import pytest
 2 import allure
 3 import logging
 4 from util.assert_util import assert_keyword
 5 from util.request_util import api_request
 6 from util.global_var import *
 7 from util.excel_util import excel_util
 8 
 9 
10 register_test_data = excel_util.get_sheet_data("注册")
11 login_test_data = excel_util.get_sheet_data("登录")
12 
13 
14 @allure.feature("登录模块")
15 @pytest.mark.dependency(name="TestLoginModule")
16 class TestLoginModule:
17         
18     @allure.story("注册功能")
19     @allure.title('用户注册')  # 指定测试用例标题，默认是函数名
20     @allure.description('通过接口进行用户注册')  # 添加测试用例描述
21     @allure.severity(allure.severity_level.BLOCKER)  # 阻塞级别
22     @pytest.mark.run(order=1)
23     @pytest.mark.parametrize('case_data', register_test_data)
24     def test_register(self, case_data):
25         with allure.step("读取请求数据，调用接口"):
26             logging.info("接口用例数据：%s" % case_data)
27             response = api_request(case_data[API_IP], case_data[API_URI], case_data[REQUEST_METHOD],
28                                    case_data[API_REQUEST_DATA], case_data[RESPONSE_EXTRACT_VAR],
29                                    case_data[REQUEST_HEADER], case_data[REQUEST_COOKIE])
30         with allure.step("获取响应数据，进行断言"):
31             assert_keyword(response, case_data[RESPONSE_ASSERT_KEYWORD])
32 
33     @allure.story("登录功能")
34     @allure.title('用户登录')  # 指定测试用例标题，默认是函数名
35     @allure.description('通过接口进行用户登录')  # 添加测试用例描述
36     @allure.severity(allure.severity_level.BLOCKER)  # 阻塞级别
37     @pytest.mark.run(order=2)
38     @pytest.mark.parametrize('case_data', login_test_data)
39     def test_login(self, case_data):
40         with allure.step("读取请求数据，调用接口"):
41             logging.info("接口用例数据：%s" % case_data)
42             response = api_request(case_data[API_IP], case_data[API_URI], case_data[REQUEST_METHOD],
43                                    case_data[API_REQUEST_DATA], case_data[RESPONSE_EXTRACT_VAR],
44                                    case_data[REQUEST_HEADER], case_data[REQUEST_COOKIE])
45         with allure.step("获取响应数据，进行断言"):
46             assert_keyword(response, case_data[RESPONSE_ASSERT_KEYWORD])
47 
48 
49 if __name__ == "__main__":
50     test_dir = os.path.dirname(__file__)
51     pytest.main(['-s', '-q', test_dir, '--alluredir', '../test_result/', "--clean-alluredir"])
52     os.system('allure generate ../test_result/ -o ../test_report/ --clean')
53     os.system('allure open -h 127.0.0.1 -p 8881 ../test_report/')

测试数据示例

Allure 报告结果示例

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

C#文件操作从入门到精通（1）——INI文件操作

C#文件操作从入门到精通（1）——INI文件操作

点击这里：微软官方文档查看writePrivateProfileString函数定义 常见错误： 1、中文路径写入失败，为啥？ 2、文件不是全路径，只有文件名也会写入失败： 3、GetLastError怎么使用？ GetLastError错误代码含义： (0)-操作成功完成。 (1)-功能错误。 (2)- 系统找不到指定的文件…
阅读更多...
62 # 借用 promise 写成类的方法

62 # 借用 promise 写成类的方法

新建 62 文件夹&#xff0c;里面添加三个文件 index.html <!DOCTYPE html> <html lang"en"><head><meta charset"UTF-8"><meta name"viewport" content"widthdevice-width, initial-scale1.0"><tit…
阅读更多...
在周末，找回属于自己的时间～

在周末，找回属于自己的时间～

&#x1f3c6;作者简介&#xff0c;黑夜开发者&#xff0c;全栈领域新星创作者✌&#xff0c;2023年6月csdn上海赛道top4。 &#x1f466;&#x1f3fb;个人主页 &#xff1a; 点击这里 &#x1f4bb;推荐专栏1&#xff1a;PHP面试题专区&#xff08;2023&#xff09; PHP入门基…
阅读更多...
【深度学习】Inst-Inpaint: Instructing to Remove Objects with Diffusion Models，指令式图像修复

【深度学习】Inst-Inpaint: Instructing to Remove Objects with Diffusion Models，指令式图像修复

论文&#xff1a;https://arxiv.org/abs/2304.03246 code:http://instinpaint.abyildirim.com/ 文章目录 AbstractIntroductionRelated WorkDataset GenerationMethodPS Abstract 图像修复任务是指从图像中擦除不需要的像素&#xff0c;并以语义一致且逼真的方式填充它们。传统…
阅读更多...
C++基础知识 （引用）

C++基础知识 （引用）

⭐️ 往期相关文章 ✨ 链接&#xff1a;C基础知识&#xff08;命名空间、输入输出、函数的缺省参数、函数重载&#xff09; ⭐️ 引用 引用从语法的层面上讲&#xff1a;引用不是定义一个新的变量&#xff0c;而是给已存在的变量取了一个别名&#xff0c;编译器不会为引用变…
阅读更多...
黑马大数据学习笔记3-MapReduce配置和YARN部署以及基本命令

黑马大数据学习笔记3-MapReduce配置和YARN部署以及基本命令

目录 部署说明MapReduce配置文件YARN配置文件分发配置文件集群启动命令开始启动YARN集群 查看YARN的WEB UI页面保存快照YARN集群的启停命令一键启动脚本单进程启停 提交MapReduce任务到YARN执行提交wordcount示例程序查看运行日志提交求圆周率示例程序 p41~43 https://www.bili…
阅读更多...
无线温湿度信息中继器模块的组成和工作状态及编程与组网建议

无线温湿度信息中继器模块的组成和工作状态及编程与组网建议

在无线温湿度信息收集系统中&#xff0c;信息中继器模块是连接终端信息点与互联网的重要节点。本文将详细介绍该模块的组成和工作状态&#xff0c;并给出编程和组网的建议。 一、组成 该无线温湿度信息中继器模块由以下几个核心组成部分构成&#xff1a; STM32F103ZET6主控芯片…
阅读更多...
17- C++ const和异常-5 (C++)

17- C++ const和异常-5 (C++)

第六章 C对C的拓展2 6.1 const详解 6.1.1 const 修饰普通变量 被修饰的对象是只读的 const int a; //a的值是只读的 int const a; const int * p; 该语句表示指向整形常量的 指针&#xff0c;它指向的值不能修改。 int const * p; 该语句与b的含义相同&#xff0c;表…
阅读更多...
adobe ps beta的使用方法

adobe ps beta的使用方法

1、人物换发型。 1&#xff09;套索套选出来相关的头发。 2&#xff09;点击生成&#xff0c;输入“red hair” 按“生成”键。 2、人物换眼睛。 1&#xff09;套索套选出来相关的眼睛区域&#xff0c;大一点范围。 2&#xff09;点击生成&#xff0c;输入“blue eyes"…
阅读更多...
【Golang 接口自动化03】 解析接口返回XML

【Golang 接口自动化03】 解析接口返回XML

目录 解析接口返回数据 定义结构体 解析函数&#xff1a; 测试 优化 资料获取方法 上一篇我们学习了怎么发送各种数据类型的http请求&#xff0c;这一篇我们来介绍怎么来解析接口返回的XML的数据。 解析接口返回数据 定义结构体 假设我们现在有一个接口返回的数据resp如…
阅读更多...
分布式软件架构——内容分发网络

分布式软件架构——内容分发网络

内容分发网络&#xff08;CDN&#xff0c;Content Distribution Network或Content Delivery Network&#xff09; 其基本思路是尽可能避开互联网上有可能影响数据传输速度和稳定性的瓶颈和环节&#xff0c;使内容传输得更快、更稳定。通过在网络各处放置节点服务器所构成的在现…
阅读更多...
【数据结构与算法】归并排序

【数据结构与算法】归并排序

归并排序 归并排序&#xff08;MERGE-SORT&#xff09;是利用归并的思想实现的排序方法&#xff0c;该算法采用经典的分治&#xff08;divide-and-conquer&#xff09;策略&#xff08;分治法将问题分&#xff08;divide&#xff09;成一些小的问题然后递归求解&#xff0c;而…
阅读更多...
LaTex语法(常用数学符号的语法和注意事项)

LaTex语法(常用数学符号的语法和注意事项)

说明:[]括号表示把语法括起来&#xff0c;并不表示LaTex语法。 1. 求和符号(Σ) 这个符号的基本语法为&#xff1a;[\sum_{}^{}]。 符号有两种模式&#xff1a;内联数学模式(inside math mode)和显示数学模式(displayed math mode)。 内联数学模式&#xff1a;排版时使用各…
阅读更多...
CAN通信的位定时与同步

CAN通信的位定时与同步

位定时与同步 1.位时间 1.1相关基本概念 1&#xff09;系统时钟&#xff1a;记为 t c l k t_{clk} tclk​&#xff1b; 2&#xff09;CAN时钟周期&#xff1a;CAN时钟是由系统时钟分频而来的一个时间长度值&#xff0c;表示CAN控制器的工作时钟&#xff0c;实际上就是一个时…
阅读更多...
【前端知识】React 基础巩固(四十二)——React Hooks的介绍

【前端知识】React 基础巩固(四十二)——React Hooks的介绍

React 基础巩固(四十二)——React Hooks的介绍 一、为什么需要Hook? Hook 是 React 16.8 的新增特性&#xff0c;它可以让我们在不编写class的情况下使用state以及其他的React特性&#xff08;比如生命周期&#xff09;。 class组件 VS 函数式组件&#xff1a; class的优势…
阅读更多...
C语言每日一题：9.《数据结构》链表的中间节点+链表的倒数第k个节点。

C语言每日一题：9.《数据结构》链表的中间节点+链表的倒数第k个节点。

第一题&#xff1a; 题目链接&#xff1a; >思路一&#xff1a; 1.第一遍遍历链表&#xff0c;直到找到尾结束第一次遍历&#xff0c;遍历的过程中记录链表长度。定义长度为k。 2.确定中间是第几个节点&#xff0c;计算是k/21根据题目要求。 3.再一次去遍历我们的数组&…
阅读更多...
iOS开发-格式化时间显示刚刚几分钟前几小时前等

iOS开发-格式化时间显示刚刚几分钟前几小时前等

iOS开发-格式化时间显示刚刚几分钟前几小时前等 在开发中经常遇到从服务端获取的时间戳&#xff0c;需要转换显示刚刚、几分钟前、几小时前、几天前、年月日等格式。 主要用到了NSCalendar、NSDateComponents这两个类 NSString *result nil;NSCalendarUnit components (NSC…
阅读更多...
minGPT 代码详解（训练 GPT 模型执行两位数加法）

minGPT 代码详解（训练 GPT 模型执行两位数加法）

文章目录 1. MinGPT 项目简介2. 相关论文2.1 GPT-12.2 GPT-22.3 GPT-3 3. 代码详解3.1 项目结构3.2 GPT 模型代码详解3.2.1 Transformer block3.2.2 GPT 3.3 两位数加法实验3.3.1 数据集构造3.3.2 训练器3.3.3 模型参数设置3.3.4 训练过程 1. MinGPT 项目简介 MinGPT 是 GPT 模…
阅读更多...
【Linux】关于Bad magic number in super-block 当尝试打开/dev/sda1 时找不到有效的文件系统超级块

【Linux】关于Bad magic number in super-block 当尝试打开/dev/sda1 时找不到有效的文件系统超级块

每个区段与 superblock 的信息都可以使用 dumpe2fs 这个指令来查询的&#xff01; 不过可惜的是&#xff0c;我们的 CentOS 7 现在是以 xfs 为默认文件系统&#xff0c; 所以目前你的系统应该无法使用 dumpe2fs 去查询任何文件系统的。 因为目前两个版本系统的根目录使用的文…
阅读更多...
Servlet文件的下载

Servlet文件的下载

第一种方法直接在前端使用超链接&#xff0c;也就是a标签 浏览器不能识别会直接下载&#xff08;像压缩文件不能直接下载&#xff09;&#xff0c;浏览器能识别&#xff0c;想要下载加一个download属性。download可以不写任何信息。 首先在web下建一个文件&#xff0c;放需要…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023