本篇文章將介紹如何使用開源的測試報告生成框架 Allure 生成規(guī)范、格式統(tǒng)一、美觀的測試報告。
通過這篇文章的介紹,你將能夠:
- 將 Allure 與 Pytest 測試框架相結合邻薯;
- 如何定制化測試報告內容
- 執(zhí)行測試之后,生成 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 方法將測試環(huán)境的信息輸出到報告中试读,比如將測試時用的 host 和測試用的 browser 添加到測試報告中:
接著杠纵,在測試腳本中,添加 allure 特性钩骇,直接看下面的腳本比藻,我通過在腳本中添加注釋的方式給大家解釋 allure 特性的用途铝量。比如測試腳本是
test_shopping_trolley.py:
上面使用了Allure的幾個特性: - @allure.feature # 用于定義被測試的功能,被測產品的需求點
- @allure.story # 用于定義被測功能的用戶場景银亲,即子功能點
- with allure.step # 用于將一個測試用例慢叨,分成幾個步驟在報告中輸出
- allure.attach # 用于向測試報告中輸入一些附加的信息,通常是一些測試數據信息
- @pytest.allure.step # 用于將一些通用的函數作為測試步驟輸出到報告务蝠,調用此函數的地方會向報告中輸出步驟
測試腳本中添加了 Allure 特性之后拍谐,在執(zhí)行測試的時候需要先生成 Allure 報告所需要的測試結果數據。在 py.test 執(zhí)行測試的時候馏段,指定 –alluredir 選項及測試數據保存的目錄即可:
./result/ 中保存了本次測試的結果數據轩拨。另外,還可以執(zhí)行指定 features 或者 stories 執(zhí)行一部分測試用例院喜,比如執(zhí)行‘購物車功能’下的‘加入購物車’子功能的測試用例:
接下來我們可以利用上面命令產生的測試數據生成 Allure 測試報告了亡蓉。生成 Allure 測試報告有兩種方式:一個是命令行方式,一個是利用 Jenkins 插件喷舀。下面分別介紹寸宵。
首先需要安裝命令行工具,如果是 Mac 電腦元咙,推薦使用 Homebrew 安裝梯影。
安裝完成后,通過下面的命令將 ./result/ 目錄下的測試數據生成測試報告:
這樣在 ./report/ 目錄下就生成了 Allure 的測試報告了庶香。–clean 目的是先清空測試報告目錄甲棍,再生成新的測試報告。
通過下面的命令打開測試報告:
本機的瀏覽器將打開網頁
http://127.0.0.1:8083/index.html
展示測試報告赶掖。
打開生成的測試報告后感猛,瀏覽器被自動調起,展示測試報告奢赂。下面我們分別看看測試報告的幾個頁面陪白。
首頁
首頁中展示了本次測試的測試用例數量,成功用例膳灶、失敗用例咱士、跳過用例的比例,測試環(huán)境信息轧钓,SUITES序厉,F(xiàn)EATURES BY STORIES等基本信息,當與Jenkins做了持續(xù)置成后毕箍,TREND區(qū)域還將顯示弛房,歷次測試的通過情況。
首頁的左邊欄而柑,還從不同的維度展示測試報告的其他信息文捶,大家可以自己點進去看看荷逞。Behaviors
接下來,我們點擊一下FEATURES BY STORIES粹排,將進入Behaviors頁面颅围,這個頁面按照FEATURES和 STORIES展示測試用例的執(zhí)行結果:
從這個頁面可以看到“購物車功能”這個FEATURES包含的三個STORIES的測試用例執(zhí)行情況。Suites
Allure測試報告將每一個測試腳本恨搓,作為一個Suite院促。在首頁點擊Suites區(qū)域下面的任何一條Suite,都將進入Suites頁面斧抱。
這個頁面常拓,將腳本的目錄結果展示本次所有的測試用例執(zhí)行情況。
- 測試用例頁面
在Suites頁面上點擊任何一條測試用例辉浦,Suites頁面的右側將展示這條用例的詳細執(zhí)行情況弄抬。
從這個頁面可以看到測試用例執(zhí)行的每一個步驟,以及每個步驟的執(zhí)行結果宪郊。測試用例為什么失敗掂恕,這里一目了然。
首先需要給Jenkins安裝Allure Plugin弛槐。在Jenkins的插件管理頁面懊亡,搜索“allure”,在搜索結果頁乎串,選擇“Allure Jenkins Plugin”進行安裝店枣。
安裝完成之后重啟一下Jenkins。在Jenkins的“全局工具管理”頁面叹誉,找到Allure Commandline模塊進行安裝:
點擊后鸯两,彈出下面的頁面,輸入Allure的命令別名和版本后长豁,點擊Apply 和Save钧唐。
按照下面的圖示,在Excute Shell和構建后操作部分寫上對應的配置信息匠襟,即可钝侠。
這樣,我們的Jenkins Job執(zhí)行完測試用例時候宅此,將在Job的主頁面上看到Allure Report圖標机错,點擊進去就看到了Allure Report報告。
團隊內部可能不同項目使用的測試框架不一樣父腕,每個測試框架生成的測試報告也不一樣。但由于 Allure 報告支持很多測試框架青瀑,通過 Allure 可以生成格式一致的測試報告璧亮,這就對外提供格式一致的測試報告提供了方便萧诫。
建議:團隊內部都采用 Allure 生成測試報告。由于團隊內部有的項目采用的 Java+TestNG 的測試架構枝嘶,后面有時間帘饶,也介紹一下如何在 TestNG 框架如何集成 Allure。
喜歡軟件測試的小伙伴們群扶,如果我的博客對你有幫助及刻、如果你喜歡我的博客內容,請 “點贊” “評論” “收藏” 一鍵三連哦竞阐!