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

本篇文章将介绍如何使用开源的测试报告生成框架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。

原文地址:https://www.cnblogs.com/d-d-w/p/9599254.html

时间: 2024-10-09 09:51:03

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

pytest + allure 生成测试报告

pytest测试样例规则:测试文件以test_开头(以_test结尾也可以)测试类以Test开头,并且不能带有 init 方法测试函数以test_开头断言使用基本的assert即可 ubuntu 安装alluresudo apt-add-repository ppa:qameta/alluresudo apt-get update sudo apt-get install allure mac安装allure:brew install allure 源码安装参考地址:https://bintra

Samba在CentOS下的图形化界面的安装

第一步:构建yum仓库(在此用的是北交大的yum仓库) 打开目录/etc/yum.repos.d下的CentOS-Base.repo文件,此处是我自己建的yum仓库,修改里面的链接地址为北交大的镜像的地址: [bjtu] name=CentOS-$releasever - Base mirrorlist=http://mirror.bjtu.edu.cn/centos/6.5/os/i386/ baseurl=http://mirror.bjtu.edu.cn/centos/6.5/os/i38

Jmeter3.0-多维度的图形化HTML报告

本文转载于推酷:http://www.tuicool.com/articles/BNvuEzr 在JMeter3.0之前,官方只提供在工具的UI上对测试结果部分维度的图形化展示,这对我带来了两方面的困扰: 在实际使用中,在平台中集成JMeter后需要页面展示TPS曲线,平均响应时间曲线等图表时,需要我们手动操刀摆弄如Hightcharts/Echarts等前端图表库. 要查看历史的测试结果,需要启动JMeter的图形化界面,导入保存的CSV结果,过程繁琐,并且当结果集较大时,JMeter需要耗费

JMeter3.0_多维度的图形化HTML报告

一.新特性简介 JMeter3.0提供一个用于生成HTML页面格式图形化报告的扩展模块.该模块支持通过两种方式生成多维度图形化测试报告: 在JMeter性能测试结束时,自动生成本次测试的HTML图形化报告 使用一个已有的结果文件(如CSV文件)来生成该次结果的HTML图形化报告 其默认提供的度量维度包括: APDEX(Application Performance Index)指数 聚合报告 类似于UI上的Aggregate Report Errors报告 展示不同错误类型的数量以及百分比 响应

JMeter性能测试3.0时代之-多维度的图形化HTML报告

在上一篇博客JMeter性能测试3.0时代之-全新JMeter插件管理中我说会写真正的JMeter 3.0新特性,时隔两周,总算在这个周末,暂停其他安排,来继续这个未完成的系列.本文主要介绍JMeter3.0引入的新特性:Dashboard Report,图形化的HTML格式多维度测试报告.借助这个特性,可以很大程度上降低我们搭建基于JMeter的性能测试平台时,在结果展示上的难度,将更多的经历放在后端的平台功能而不是去临时学习前端图表库. 一.为什么谈这个新特性 在JMeter3.0之前,官方

Java学习之图形化界面(Swing基础)

Java学习之图形化界面(Swing基础) 一.Java图形化界面发展史 起初在早期的计算机系统中,电脑只提供命令行界面(CLI),现在在Windows中开个DOS窗口,就可以历史足迹,这就是命令行界面在 现在Windows界面中的体现. 后来Apple公司率先在电脑的操作系统中实现了图形化的用户界面(Graphical User Interface,简称GUI),但由于Apple公司封闭的市场策略,自己完成电脑硬件.操作系统.应用软件一条龙的产品,与其它PC不兼容.这使得Apple公司错过了一

pytest+allure(allure-pytest基于这个插件)生成漂亮的报告+显示

一:环境准备 1.python3.6 2.windows环境 3.pycharm 4.allure-pytest 5.allure2.8.0 6.java1.8 allure-pytest快速安装 在cmd中输入 pip install allure-pytest,回车 二:报告生成 第1步:下载allure.zip,下载地址:allure-github: https://github.com/allure-framework/allure2 ,找到对应版本,并下载 第2步:解压allure.z

pytest系列(四)- pytest+allure+jenkins - 持续集成平台生成allure报告

pytest是什么 pytest是python的一款测试框架,拥有unittest的功能并比它更丰富. allure是什么 有非常多的优秀的测试框架,但却是有非常少优秀的报告工具可以展示非常清楚的用例执行过程和结果. allure是一款开源的,专门用来展示测试结果的工具,目的是希望团队内部每一个人都可以看到非常清楚的测试结果. allure可以与非常多的著名测试框架做集成. 像java语言,可以与junit4,junit5,TestNG测试框架集成. python语言,可以与pytest,beh

Pytest集成Allure生成测试报告

Pytest集成Allure生成测试报告 1.Allure安装 1)Allure报告的demo样式(是不是很漂亮呢) 2)Allure下载 选择需要的版本,下载zip文件,解压即可 2.添加allure环境变量 path:D:\Program Files\allure-2.13.1\bin 3.查看生成的allure报告 cmd:allure serve allure生成的报告路径 启动后会自动跳转到 http://192.168.11.1:54011/ 打开测试报告 4.pytest中集成al