本篇文章將介紹如何使用開源的測驗報告生成框架 Allure 生成規范、格式統一、美觀的測驗報告,
通過這篇文章的介紹,你將能夠:
- 將 Allure 與 Pytest 測驗框架相結合;
- 如何定制化測驗報告內容
- 執行測驗之后,生成 Allure 格式的測驗報告,
Allure 是一款非常輕量級并且非常靈活的開源測驗報告生成框架,它支持絕大多數測驗框架, 例如 TestNG、Pytest、JUint 等,它簡單易用,易于集成,下面就 Pytest 如何與 Allure 集成做詳細介紹,
Pytest 是 Python 的單元測驗框架,非常方便和易用,強烈推薦對于用 Python 進行測驗作業的小伙伴使用這個測驗框架,相比與 Python 自帶的 UnitTest 好用太多太多,今天我們主要是介紹如何將測驗報告生成工具 Allure 集成到 Pytest 中,
Allure Pytest Adaptor 是 Pytest 的一個插件,通過它我們可以生成 Allure 所需要的用于生成測驗報告的資料,安裝 pytest-allure-adaptor 插件方法:
pytest-allure-adaptor 官網中詳細介紹了 pytest-allure-adaptor 所具有的功能,本篇文章不會再翻譯一遍,而是從實際入手,給大家介紹如何將其應用到自己的框架中,
為了使用 Allure 生成報告,需要在 conftest.py 和測驗腳本中加入 Allure 特性,
首先,conftest.py 中可以通過 allure.environment 方法將測驗環境的資訊輸出到報告中,比如將測驗時用的 host 和測驗用的 browser 添加到測驗報告中:
接著,在測驗腳本中,添加 allure 特性,直接看下面的腳本,我通過在腳本中添加注釋的方式給大家解釋 allure 特性的用途,比如測驗腳本是
test_shopping_trolley.py:
上面使用了Allure的幾個特性: - @allure.feature # 用于定義被測驗的功能,被測產品的需求點
- @allure.story # 用于定義被測功能的用戶場景,即子功能點
- with allure.step # 用于將一個測驗用例,分成幾個步驟在報告中輸出
- allure.attach # 用于向測驗報告中輸入一些附加的資訊,通常是一些測驗資料資訊
- @pytest.allure.step # 用于將一些通用的函式作為測驗步驟輸出到報告,呼叫此函式的地方會向報告中輸出步驟
測驗腳本中添加了 Allure 特性之后,在執行測驗的時候需要先生成 Allure 報告所需要的測驗結果資料,在 py.test 執行測驗的時候,指定 –alluredir 選項及測驗資料保存的目錄即可:
./result/ 中保存了本次測驗的結果資料,另外,還可以執行指定 features 或者 stories 執行一部分測驗用例,比如執行‘購物車功能’下的‘加入購物車’子功能的測驗用例:
接下來我們可以利用上面命令產生的測驗資料生成 Allure 測驗報告了,生成 Allure 測驗報告有兩種方式:一個是命令列方式,一個是利用 Jenkins 插件,下面分別介紹,
首先需要安裝命令列工具,如果是 Mac 電腦,推薦使用 Homebrew 安裝,
安裝完成后,通過下面的命令將 ./result/ 目錄下的測驗資料生成測驗報告:
這樣在 ./report/ 目錄下就生成了 Allure 的測驗報告了,–clean 目的是先清空測驗報告目錄,再生成新的測驗報告,
通過下面的命令打開測驗報告:
本機的瀏覽器將打開網頁
http://127.0.0.1:8083/index.html
展示測驗報告,
打開生成的測驗報告后,瀏覽器被自動調起,展示測驗報告,下面我們分別看看測驗報告的幾個頁面,
-
首頁
首頁中展示了本次測驗的測驗用例數量,成功用例、失敗用例、跳過用例的比例,測驗環境資訊,SUITES,FEATURES BY STORIES等基本資訊,當與Jenkins做了持續置成后,TREND區域還將顯示,歷次測驗的通過情況,
首頁的左邊欄,還從不同的維度展示測驗報告的其他資訊,大家可以自己點進去看看, -
Behaviors
接下來,我們點擊一下FEATURES BY STORIES,將進入Behaviors頁面,這個頁面按照FEATURES和 STORIES展示測驗用例的執行結果:
從這個頁面可以看到“購物車功能”這個FEATURES包含的三個STORIES的測驗用例執行情況, -
Suites
Allure測驗報告將每一個測驗腳本,作為一個Suite,在首頁點擊Suites區域下面的任何一條Suite,都將進入Suites頁面,
這個頁面,將腳本的目錄結果展示本次所有的測驗用例執行情況,
4. 測驗用例頁面
在Suites頁面上點擊任何一條測驗用例,Suites頁面的右側將展示這條用例的詳細執行情況,
從這個頁面可以看到測驗用例執行的每一個步驟,以及每個步驟的執行結果,測驗用例為什么失敗,這里一目了然,
首先需要給Jenkins安裝Allure Plugin,在Jenkins的插件管理頁面,搜索“allure”,在搜索結果頁,選擇“Allure Jenkins Plugin”進行安裝,
安裝完成之后重啟一下Jenkins,在Jenkins的“全域工具管理”頁面,找到Allure Commandline模塊進行安裝:
點擊后,彈出下面的頁面,輸入Allure的命令別名和版本后,點擊Apply 和Save,
按照下面的圖示,在Excute Shell和構建后操作部分寫上對應的配置資訊,即可,
這樣,我們的Jenkins Job執行完測驗用例時候,將在Job的主頁面上看到Allure Report圖示,點擊進去就看到了Allure Report報告,
團隊內部可能不同專案使用的測驗框架不一樣,每個測驗框架生成的測驗報告也不一樣,但由于 Allure 報告支持很多測驗框架,通過 Allure 可以生成格式一致的測驗報告,這就對外提供格式一致的測驗報告提供了方便,
建議:團隊內部都采用 Allure 生成測驗報告,由于團隊內部有的專案采用的 Java+TestNG 的測驗架構,后面有時間,也介紹一下如何在 TestNG 框架如何集成 Allure,
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/467969.html
標籤:其他
上一篇:初識python
