正文 

当前位置： 首页 > java > java教程

用pytest+allure生成漂亮的html图形化测试报告

丹D      2022-02-14     453

关键词：

本篇文章将介绍如何使用开源的测试报告生成框架Allure生成规范、格式统一、美观的测试报告。 
通过这篇文章的介绍，你将能够： 
- 将Allure与Pytest测试框架相结合； 
- 执行测试之后，生成Allure格式的测试报告。

1、Allure测试报告介绍

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

2、Pytest框架集成Allure

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

2.1 安装Allure Pytest Adaptor

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

  • 1

2.2 使用Allure Pytest Adaptor改造基于Pytest的测试用例

pytest-allure-adaptor官网中详细介绍了pytest-allure-adaptor所具有的功能。本篇文章不会再翻译一遍，而是从实际入手，给大家介绍如何将其应用到自己的框架中。 
为了使用Allure生成报告，需要在conftest.py和测试脚本中加入Allure特性。

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

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22

接着，在测试脚本中，添加allure特性，直接看下面的脚本，我通过在脚本中添加注释的方式给大家解释allure特性的用途。比如测试脚本是test_shopping_trolley.py：

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36

上面使用了Allure的几个特性：

  • @allure.feature # 用于定义被测试的功能，被测产品的需求点
  • @allure.story # 用于定义被测功能的用户场景，即子功能点
  • with allure.step # 用于将一个测试用例，分成几个步骤在报告中输出
  • allure.attach # 用于向测试报告中输入一些附加的信息，通常是一些测试数据信息
  • @pytest.allure.step # 用于将一些通用的函数作为测试步骤输出到报告，调用此函数的地方会向报告中输出步骤

3、生成Allure测试报告

测试脚本中添加了Allure特性之后，在执行测试的时候需要先生成Allure报告所需要的测试结果数据。在py.test执行测试的时候，指定–alluredir选项及测试数据保存的目录即可：

  • 1

./result/中保存了本次测试的结果数据。另外，还可以执行指定features或者stories执行一部分测试用例，比如执行‘购物车功能’下的‘加入购物车’子功能的测试用例：

  • 1

接下来我们可以利用上面命令产生的测试数据生成Allure测试报告了。生成Allure测试报告有两种方式：一个是命令行方式，一个是利用Jenkins插件。下面分别介绍。

3.1 命令行方式

3.1.1 安装命令行工具

首先需要安装命令行工具，如果是Mac电脑，推荐使用Homebrew安装。

  • 1
3.1.2 生成测试报告

安装完成后，通过下面的命令将./result/目录下的测试数据生成测试报告：

  • 1

这样在./report/目录下就生成了Allure的测试报告了。–clean目的是先清空测试报告目录，再生成新的测试报告。

3.1.3 打开测试报告

通过下面的命令打开测试报告：

  • 1

本机的浏览器将打开http://127.0.0.1:8083/index.html网页，展示测试报告。

3.1.4 测试报告解读

打开生成的测试报告后，浏览器被自动调起，展示测试报告。下面我们分别看看测试报告的几个页面。

  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页面的右侧将展示这条用例的详细执行情况。 

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

3.2 利用Jenkins插件方式

3.2.1 安装 Allure Plugin

首先需要给Jenkins安装Allure Plugin。在Jenkins的插件管理页面，搜索“allure”，在搜索结果页，选择“Allure Jenkins Plugin”进行安装。 
安装完成之后重启一下Jenkins。 
在Jenkins的“全局工具管理”页面，找到Allure Commandline模块进行安装： 

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

3.2.2 配置Job

按照下面的图示，在Excute Shell和构建后操作部分写上对应的配置信息，即可。 

这样，我们的Jenkins Job执行完测试用例时候，将在Job的主页面上看到Allure Report图标，点击进去就看到了Allure Report报告。 

4、团队实践建议

团队内部可能不同项目使用的测试框架不一样，每个测试框架生成的测试报告也不一样。但由于Allure报告支持很多测试框架，通过Allure可以生成格式一致的测试报告，这就对外提供格式一致的测试报告提供了方便。 
建议：团队内部都采用Allure生成测试报告。 
由于团队内部有的项目采用的Java+TestNG的测试架构，后面有时间，我将会介绍一下如何在TestNG框架如何集成Allure。

 

pytest_allure2生成html报告

pip安装pytest-allure-adaptor，github地址 https://github.com/allure-framework/allure-pytestpip3installpytest-allure-adaptor/python3-mpipinstallpytest-allure-adaptor 生成xml报告pytest-s-q--alluredirrep 查看详情

allure生成漂亮的测试报告(代码片段)

...洁阅读的测试报告框架。它支持大多数的测试框架，如：Pytest、TestNG等，简单易用便于集成。[allure官方文档]AllureFramework是一种灵活的轻量级多语言测试报告工具，不仅可以以简洁的Web报告形式非常简洁地显示已测试的内容，也... 查看详情

pytest系列（26）-清空allure历史报告记录(代码片段)

如果你还想从头学起Pytest，可以看看这个系列的文章哦！https://www.cnblogs.com/poloyy/category/1690628.html 背景pytest运行测试用例生成allure报告时，当测试用例名称修改后重新运行，会保留历史运行记录又或者分开运行两个测试用例... 查看详情

pytest文档13-allure2生成html报告(史上最详细)

...ort框架,支持java的Junit/testng等框架,当然也可以支持python的pytest框架，也可以集成到Jenkins上展示高大上的报告界面。环境准备1.python3.62.windows环境3.pycharm4.pytest-allure-adaptor5.allure2.7.06.java1.8**作者：上海-悠悠QQ交流群：588402570**py 查看详情

pytest+allure生成自动化测试报告

一、allure生成自动化测试报告1.安装pipinstallallure-pytest，allure-pytest插件，用来生成Allure测试报告所需要的数据，在pytest.ini文件中配置生成数据文件路径   addopts=-s--alluredir=./report/html2.下载allure：https://github.com/allure-fram 查看详情

pytest测试报告美化

参考技术Apytest-HTML是一个插件，pytest用于生成测试结果的HTML报告。兼容Python2.7,3.6安装方式：pipinstallpytest-html然后写一个测试类在命令行中执行：如下：在当前目录下可以看到生成了一个report.html的文件，点开就可以看到测试报... 查看详情

pytest+yaml框架-10.allure生成报告(代码片段)

前言本插件是基于pytest框架开发的，所以pytest的插件都能使用，生成报告可以用到allure报告pip安装插件pipinstallpytest-yaml-yoyoallure报告功能在v1.0.8版本上实现allure命令行工具allure是一个命令行工具，需要去github上下载最... 查看详情

allure生成测试报告，index.html页面内容为空

该条仅供参考，只是其中一种情况之前使用的各种版本：python：3.7.3allure：2.13.10pytest：6.2.4allure-pytest：2.9.42 pytest.main(["-s",\'test_three.py\',\'--alluredir\',\'../allure-result/html/\'])>alluregenerateallure-result 查看详情

19-pytest-allure-pytest环境搭建(代码片段)

...安装alluer安装allure命令行工具代码示例查看报告前言使用pytest跑完了用例，还要有个漂亮的报告展示出自动化case的结果，现在一起来学习下alluer吧安装alluer#直接安装pipinstallpytes#豆瓣镜像安装，速度快pip3installallure-pyt... 查看详情

allure05-生成独立的allure测试报告

...allure提供两种命令打开测试报告allureopen进入cmd执行测试pytest--alluredir测 查看详情

pytest结合allure生成测试报告

#官方文档：   https://docs.qameta.io/allure/#_installing_a_commandline 引用官方文档中的话：Allure框架是一个灵活的轻量级多语言测试报告工具，它不仅以web的方式展示了简介的测试结果，而且允许参与开发过程的每个人从日... 查看详情

pytest+yaml框架-10.allure生成报告(代码片段)

前言本插件是基于pytest框架开发的，所以pytest的插件都能使用，生成报告可以用到allure报告pip安装插件pipinstallpytest-yaml-yoyoallure报告功能在v1.0.8版本上实现allure命令行工具allure是一个命令行工具，需要去github上下载最... 查看详情

pytest-allure描述用例详细讲解(代码片段)

pytest+allure是最完美的结合了，关于allure的使用，本篇做一个总结。allure报告可以很多详细的信息描述测试用例，包括epic、feature、story、title、issue、testcase、severity等环境准备python3.6pytest4.5.0allure-pytest2.8.6allure用例描述使用方法参... 查看详情

python+pytest生成完美allure报告入门(代码片段)

 目录​一、Allure的安装及快速入门1、Allure介绍2、Allure安装（1）安装python插件（2）安装allure3、allure使用(1)示例代码二、Allure详解1、title标题（1）示例2、description描述（1）示例3、标签@allure.fea 查看详情

超详细从入门到精通，pytest自动化测试框架实战教程-allure测试报告(代码片段)

...能测试九、总结（尾部小惊喜）前言前面介绍了pytest的用例编写、前后置方式、用例标记等方法。还有一个pytest如何集成测试报告。Pytest自动化测试框架：https://www.bilibili.com/video/BV18K411m7FH/pytest本身是没有生成测试报... 查看详情

allure报告定制（pytest+jenkins）(代码片段)

...法。@allure.feature(‘ceshi‘)通过查找allure安装位置，发现pytest_plugin.py中的类AllureHelper有step()、story()、feature()等方法  所以在调用的时候，引入类即可allure.MASTER_HELPER.feature(‘ceshi‘)#定义功能importallure#@allure.environment(report=... 查看详情

pytest问题解决遇到pytest执行不了allure，生成不了allure测试报告怎么办？(代码片段)

大家好，我是好学的小师弟。最近在用pytest执行allure的时候，发现生成不了测试报告，尝试了好久，最后终于找到了解决方法。【allure下载链接】allure_2.13.6_GitHub前提条件:首先检查自己的allure有没有配置好环境变... 查看详情

pytest基础特性02

参考技术Apytest-html           生成html格式的自动化测试报告pytest-xdist           测试用例分布式执行，多cpu分发pytest-ordering      ... 查看详情