用 Pytest+Allure 生成漂亮的 HTML 图形化测试报告

本篇文章将介绍如何使用开源的测试报告生成框架 Allure 生成规范、格式统一、美观的测试报告。
通过这篇文章的介绍,你将能够: 

将 Allure 与 Pytest 测试框架相结合;
如何定制化测试报告内容
执行测试之后,生成 Allure 格式的测试报告。

Allure 是一款非常轻量级并且非常灵活的开源测试报告生成框架。它支持绝大多数测试框架, 例如 TestNG、Pytest、JUint 等。它简单易用,易于集成。下面就 Pytest 如何与 Allure 集成做详细介绍。

Pytest 是 Python 的单元测试框架,非常方便和易用。强烈推荐对于用 Python 进行测试工作的小伙伴使用这个测试框架,相比与 Python 自带的 UnitTest 好用太多太多。今天我们主要是介绍如何将测试报告生成工具 Allure 集成到 Pytest 中。

Allure Pytest Adaptor 是 Pytest 的一个插件,通过它我们可以生成 Allure 所需要的用于生成测试报告的数据。安装 pytest-allure-adaptor 插件方法:

pytest-allure-adaptor 官网中详细介绍了 pytest-allure-adaptor 所具有的功能。本篇文章不会再翻译一遍,而是从实际入手,给大家介绍如何将其应用到自己的框架中。

为了使用 Allure 生成报告,需要在 conftest.py 和测试脚本中加入 Allure 特性。

首先,conftest.py 中可以通过 allure.environment 方法将测试环境的信息输出到报告中,比如将测试时用的 host 和测试用的 browser 添加到测试报告中:

接着,在测试脚本中,添加 allure 特性,直接看下面的脚本,我通过在脚本中添加注释的方式给大家解释 allure 特性的用途。比如测试脚本是
test_shopping_trolley.py:
上面使用了Allure的几个特性:

@allure.feature # 用于定义被测试的功能,被测产品的需求点
@allure.story # 用于定义被测功能的用户场景,即子功能点
with allure.step # 用于将一个测试用例,分成几个步骤在报告中输出
allure.attach # 用于向测试报告中输入一些附加的信息,通常是一些测试数据信息
@pytest.allure.step # 用于将一些通用的函数作为测试步骤输出到报告,调用此函数的地方会向报告中输出步骤
测试脚本中添加了 Allure 特性之后,在执行测试的时候需要先生成 Allure 报告所需要的测试结果数据。在 py.test 执行测试的时候,指定 –alluredir 选项及测试数据保存的目录即可:
./result/ 中保存了本次测试的结果数据。另外,还可以执行指定 features 或者 stories 执行一部分测试用例,比如执行‘购物车功能’下的‘加入购物车’子功能的测试用例:
接下来我们可以利用上面命令产生的测试数据生成 Allure 测试报告了。生成 Allure 测试报告有两种方式:一个是命令行方式,一个是利用 Jenkins 插件。下面分别介绍。
首先需要安装命令行工具,如果是 Mac 电脑,推荐使用 Homebrew 安装。
安装完成后,通过下面的命令将 ./result/ 目录下的测试数据生成测试报告:
这样在 ./report/ 目录下就生成了 Allure 的测试报告了。–clean 目的是先清空测试报告目录,再生成新的测试报告。
通过下面的命令打开测试报告:
本机的浏览器将打开网页
http://127.0.0.1:8083/index.html 2
展示测试报告。
打开生成的测试报告后,浏览器被自动调起,展示测试报告。下面我们分别看看测试报告的几个页面。 

1.首页

首页中展示了本次测试的测试用例数量,成功用例、失败用例、跳过用例的比例,测试环境信息,SUITES,FEATURES BY STORIES等基本信息,当与Jenkins做了持续置成后,TREND区域还将显示,历次测试的通过情况。

首页的左边栏,还从不同的维度展示测试报告的其他信息,大家可以自己点进去看看。

2. Behaviors

接下来,我们点击一下FEATURES BY STORIES,将进入Behaviors页面,这个页面按照FEATURES和 STORIES展示测试用例的执行结果:
从这个页面可以看到“购物车功能”这个FEATURES包含的三个STORIES的测试用例执行情况。

3,、Suites

Allure测试报告将每一个测试脚本,作为一个Suite。在首页点击Suites区域下面的任何一条Suite,都将进入Suites页面。

这个页面,将脚本的目录结果展示本次所有的测试用例执行情况。

4. 测试用例页面

在Suites页面上点击任何一条测试用例,Suites页面的右侧将展示这条用例的详细执行情况。

从这个页面可以看到测试用例执行的每一个步骤,以及每个步骤的执行结果。测试用例为什么失败,这里一目了然。

首先需要给Jenkins安装Allure Plugin。在Jenkins的插件管理页面,搜索“allure”,在搜索结果页,选择“Allure Jenkins Plugin”进行安装。

安装完成之后重启一下Jenkins。在Jenkins的“全局工具管理”页面,找到Allure Commandline模块进行安装:

点击后,弹出下面的页面,输入Allure的命令别名和版本后,点击Apply 和Save。

按照下面的图示,在Excute Shell和构建后操作部分写上对应的配置信息,即可。
这样,我们的Jenkins Job执行完测试用例时候,将在Job的主页面上看到Allure Report图标,点击进去就看到了Allure Report报告。

团队内部可能不同项目使用的测试框架不一样,每个测试框架生成的测试报告也不一样。但由于 Allure 报告支持很多测试框架,通过 Allure 可以生成格式一致的测试报告,这就对外提供格式一致的测试报告提供了方便。

建议:团队内部都采用 Allure 生成测试报告。由于团队内部有的项目采用的 Java+TestNG 的测试架构,后面有时间,也介绍一下如何在 TestNG 框架如何集成 Allure。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

在这里插入图片描述

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!   

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

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

什么是Web组件(Web Components)?它们的主要部分有哪些?

聚沙成塔每天进步一点点 ⭐ 专栏简介⭐ Web 组件(Web Components)⭐ 自定义元素(Custom Elements)⭐ 影子 DOM(Shadow DOM)⭐ HTML 模板(HTML Templates)⭐ HTML 导入(HT…

微信小程序云开发手搓微标提示,逻辑思路记录及代码实现

目录 写前小叙 功能需求背景 首页js的逻辑思路第一部分 发布公告js逻辑 首页js显示“新”公告思路实现 首页js关闭“新”公告思路实现 管理员“已阅读”js逻辑 首页js显示“新”邮件思路实现 首页js关闭“新”邮件思路实现 写前小叙 今儿凌晨,我又是一个人…

GitLab使用的最简便方式

GitLab介绍 GitLab是一个基于Git版本控制系统的开源平台,用于代码托管,持续集成,以及协作开发。它提供了一套完整的工具,以帮助开发团队协同工作、管理和部署代码。 往往在企业内部使用gitlab管理代码,记录一下将本地代…

SAP 选择屏幕动态通过Radio Button 显示与隐藏以及控制是否必输

如何在选择屏幕上进行动态展示屏幕字段,并且进行必输项检查控制 1. 选择屏幕定义 SELECTION-SCREEN BEGIN OF BLOCK b1 WITH FRAME TITLE TEXT-001.SELECTION-SCREEN BEGIN OF LINE.PARAMETERS: p_r1 TYPE c RADIOBUTTON GROUP grp USER-COMMAND uc DEFAULT X. &q…

算法刷题 week2

目录 week21. 二维数组中的查找题目题解(单调性扫描) O(nm) 2.替换空格题目题解(线性扫描) O(n)(双指针扫描) O(n) 3.从尾到头打印链表题目题解(遍历链表) O(n) week2 1. 二维数组中的查找 题目 题解 (单调性扫描) O(nm) 核心在于发现每个子矩阵右上角的数的性质&#xff1…

【适配的一些小细节】

使用svg 使用img引入svg图片的时候 使用的时候 <img src"./img/logo.svg"/>

上半年毛利率高达82%,敷尔佳“风采不减当年”?

随着公众护肤意识的提升&#xff0c;消费者相比之前对基础护肤变得更加注重产品的成分、功效及安全性。为迎合市场需求&#xff0c;敷尔佳重磅打造了多款新品&#xff0c;2022 年四季度上市的有医用重组III 型人源化胶原蛋白贴&#xff0c;今年上半年新推的有御龄紧致次抛精华液…

WPS 换行后缩进、加粗等自定义样式的清除

在使用WPS的Word编辑文字时&#xff0c;经常会出现换行后&#xff0c;自动缩进这种格式&#xff0c;需要清除这种样式&#xff0c;可以按照下图来操作&#xff1a;

《Python趣味工具》——自制emoji3

今日目标 在上次&#xff0c;我们绘制了静态的emoji图。并且总结了turtle中的常用函数。 本次我们将尝试制作一个动态的emoji&#xff0c;让你的表情包动起来&#xff01; 文章目录 一、动画原理&#xff1a;二、制作动画&#xff1a;1. 修改eyes_black()函数&#xff1a;2. 绘…

继续复制:元胞自动机中的自我复制

兰顿循环。 一、说明 任何观察生物体的人都非常清楚&#xff0c;它们可以产生像自己一样的其他生物体。这是它们的正常功能&#xff0c;如果他们不这样做&#xff0c;它们就不会存在&#xff0c;而且这很可能是它们在世界上比比皆是的原因。换句话说&#xff0c;生物体是基本…

1.1 安装配置CentOS

文章目录 零、学习目标一、导入新课二、新课讲解&#xff08;一&#xff09;安装VMWare Workstation1、获取安装程序2、进入安装向导3、按提示完成安装 &#xff08;二&#xff09;虚拟网络编辑器1、启动虚拟网络编辑器2、选择VMnet8虚拟网3、更改网络配置4、查看DHCP设置5、查…

ROS 入门

目录 简介 ROS诞生背景 ROS的设计目标 ROS与ROS2 安装ROS 1.配置ubuntu的软件和更新 2.设置安装源 3.设置key 4.安装 5.配置环境变量 安装可能出现的问题 安装构建依赖 卸载 ROS架构 1.设计者 2.维护者 3. 立足系统架构: ROS 可以划分为三层 ROS通信机制 话…