用Pytest+Allure產生漂亮的HTML圖形化測試報告

標籤：nbsp   class   資訊   不同的   網頁   包含   情況   with   number   

本篇文章將介紹如何使用開源的測試報告產生架構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+Allure產生漂亮的HTML圖形化測試報告