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

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

---

一、Allure测试报告介绍

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

---

二、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 # 用于将一些通用的函数做为测试步骤输出到报告，调用此函数的地方会向报告中输出步骤

---

三、生成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报告。 

四、团队实践建议

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