用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。