玄武模板網(wǎng)站制作報價怎么聯(lián)系百度推廣
本篇文章將介紹如何使用開源的測試報告生成框架 Allure 生成規(guī)范、格式統(tǒng)一、美觀的測試報告。
通過這篇文章的介紹,你將能夠:?
將 Allure 與 Pytest 測試框架相結(jié)合;
如何定制化測試報告內(nèi)容
執(zhí)行測試之后,生成 Allure 格式的測試報告。
Allure 是一款非常輕量級并且非常靈活的開源測試報告生成框架。它支持絕大多數(shù)測試框架, 例如 TestNG、Pytest、JUint 等。它簡單易用,易于集成。下面就 Pytest 如何與 Allure 集成做詳細介紹。
Pytest 是 Python 的單元測試框架,非常方便和易用。強烈推薦對于用 Python 進行測試工作的小伙伴使用這個測試框架,相比與 Python 自帶的 UnitTest 好用太多太多。今天我們主要是介紹如何將測試報告生成工具 Allure 集成到 Pytest 中。
Allure Pytest Adaptor 是 Pytest 的一個插件,通過它我們可以生成 Allure 所需要的用于生成測試報告的數(shù)據(jù)。安裝 pytest-allure-adaptor 插件方法:
pytest-allure-adaptor 官網(wǎng)中詳細介紹了 pytest-allure-adaptor 所具有的功能。本篇文章不會再翻譯一遍,而是從實際入手,給大家介紹如何將其應(yīng)用到自己的框架中。
為了使用 Allure 生成報告,需要在 conftest.py 和測試腳本中加入 Allure 特性。
首先,conftest.py 中可以通過 allure.environment 方法將測試環(huán)境的信息輸出到報告中,比如將測試時用的 host 和測試用的 browser 添加到測試報告中:
接著,在測試腳本中,添加 allure 特性,直接看下面的腳本,我通過在腳本中添加注釋的方式給大家解釋 allure 特性的用途。比如測試腳本是
test_shopping_trolley.py:
上面使用了Allure的幾個特性:
@allure.feature # 用于定義被測試的功能,被測產(chǎn)品的需求點
@allure.story # 用于定義被測功能的用戶場景,即子功能點
with allure.step # 用于將一個測試用例,分成幾個步驟在報告中輸出
allure.attach # 用于向測試報告中輸入一些附加的信息,通常是一些測試數(shù)據(jù)信息
@pytest.allure.step # 用于將一些通用的函數(shù)作為測試步驟輸出到報告,調(diào)用此函數(shù)的地方會向報告中輸出步驟
測試腳本中添加了 Allure 特性之后,在執(zhí)行測試的時候需要先生成 Allure 報告所需要的測試結(jié)果數(shù)據(jù)。在 py.test 執(zhí)行測試的時候,指定 –alluredir 選項及測試數(shù)據(jù)保存的目錄即可:
./result/ 中保存了本次測試的結(jié)果數(shù)據(jù)。另外,還可以執(zhí)行指定 features 或者 stories 執(zhí)行一部分測試用例,比如執(zhí)行‘購物車功能’下的‘加入購物車’子功能的測試用例:
接下來我們可以利用上面命令產(chǎn)生的測試數(shù)據(jù)生成 Allure 測試報告了。生成 Allure 測試報告有兩種方式:一個是命令行方式,一個是利用 Jenkins 插件。下面分別介紹。
首先需要安裝命令行工具,如果是 Mac 電腦,推薦使用 Homebrew 安裝。
安裝完成后,通過下面的命令將 ./result/ 目錄下的測試數(shù)據(jù)生成測試報告:
這樣在 ./report/ 目錄下就生成了 Allure 的測試報告了。–clean 目的是先清空測試報告目錄,再生成新的測試報告。
通過下面的命令打開測試報告:
本機的瀏覽器將打開網(wǎng)頁
http://127.0.0.1:8083/index.html 2
展示測試報告。
打開生成的測試報告后,瀏覽器被自動調(diào)起,展示測試報告。下面我們分別看看測試報告的幾個頁面。?
1.首頁
首頁中展示了本次測試的測試用例數(shù)量,成功用例、失敗用例、跳過用例的比例,測試環(huán)境信息,SUITES,FEATURES BY STORIES等基本信息,當(dāng)與Jenkins做了持續(xù)置成后,TREND區(qū)域還將顯示,歷次測試的通過情況。
首頁的左邊欄,還從不同的維度展示測試報告的其他信息,大家可以自己點進去看看。
2. Behaviors
接下來,我們點擊一下FEATURES BY STORIES,將進入Behaviors頁面,這個頁面按照FEATURES和 STORIES展示測試用例的執(zhí)行結(jié)果:
從這個頁面可以看到“購物車功能”這個FEATURES包含的三個STORIES的測試用例執(zhí)行情況。
3,、Suites
Allure測試報告將每一個測試腳本,作為一個Suite。在首頁點擊Suites區(qū)域下面的任何一條Suite,都將進入Suites頁面。
這個頁面,將腳本的目錄結(jié)果展示本次所有的測試用例執(zhí)行情況。
4. 測試用例頁面
在Suites頁面上點擊任何一條測試用例,Suites頁面的右側(cè)將展示這條用例的詳細執(zhí)行情況。
從這個頁面可以看到測試用例執(zhí)行的每一個步驟,以及每個步驟的執(zhí)行結(jié)果。測試用例為什么失敗,這里一目了然。
首先需要給Jenkins安裝Allure Plugin。在Jenkins的插件管理頁面,搜索“allure”,在搜索結(jié)果頁,選擇“Allure Jenkins Plugin”進行安裝。
安裝完成之后重啟一下Jenkins。在Jenkins的“全局工具管理”頁面,找到Allure Commandline模塊進行安裝:
點擊后,彈出下面的頁面,輸入Allure的命令別名和版本后,點擊Apply 和Save。
按照下面的圖示,在Excute Shell和構(gòu)建后操作部分寫上對應(yīng)的配置信息,即可。
這樣,我們的Jenkins Job執(zhí)行完測試用例時候,將在Job的主頁面上看到Allure Report圖標(biāo),點擊進去就看到了Allure Report報告。
團隊內(nèi)部可能不同項目使用的測試框架不一樣,每個測試框架生成的測試報告也不一樣。但由于 Allure 報告支持很多測試框架,通過 Allure 可以生成格式一致的測試報告,這就對外提供格式一致的測試報告提供了方便。
建議:團隊內(nèi)部都采用 Allure 生成測試報告。由于團隊內(nèi)部有的項目采用的 Java+TestNG 的測試架構(gòu),后面有時間,也介紹一下如何在 TestNG 框架如何集成 Allure。
最后感謝每一個認真閱讀我文章的人,禮尚往來總是要有的,雖然不是什么很值錢的東西,如果你用得到的話可以直接拿走: