本篇文章將介紹如何使用開(kāi)源的測(cè)試報(bào)告生成框架 Allure 生成規(guī)范、格式統(tǒng)一、美觀的測(cè)試報(bào)告。
通過(guò)這篇文章的介紹，你將能夠：?

將 Allure 與 Pytest 測(cè)試框架相結(jié)合；
如何定制化測(cè)試報(bào)告內(nèi)容
執(zhí)行測(cè)試之后，生成 Allure 格式的測(cè)試報(bào)告。

Allure 是一款非常輕量級(jí)并且非常靈活的開(kāi)源測(cè)試報(bào)告生成框架。它支持絕大多數(shù)測(cè)試框架， 例如 TestNG、Pytest、JUint 等。它簡(jiǎn)單易用，易于集成。下面就 Pytest 如何與 Allure 集成做詳細(xì)介紹。

Pytest 是 Python 的單元測(cè)試框架，非常方便和易用。強(qiáng)烈推薦對(duì)于用 Python 進(jìn)行測(cè)試工作的小伙伴使用這個(gè)測(cè)試框架，相比與 Python 自帶的 UnitTest 好用太多太多。今天我們主要是介紹如何將測(cè)試報(bào)告生成工具 Allure 集成到 Pytest 中。

Allure Pytest Adaptor 是 Pytest 的一個(gè)插件，通過(guò)它我們可以生成 Allure 所需要的用于生成測(cè)試報(bào)告的數(shù)據(jù)。安裝 pytest-allure-adaptor 插件方法：

pytest-allure-adaptor 官網(wǎng)中詳細(xì)介紹了 pytest-allure-adaptor 所具有的功能。本篇文章不會(huì)再翻譯一遍，而是從實(shí)際入手，給大家介紹如何將其應(yīng)用到自己的框架中。

為了使用 Allure 生成報(bào)告，需要在 conftest.py 和測(cè)試腳本中加入 Allure 特性。

首先，conftest.py 中可以通過(guò) allure.environment 方法將測(cè)試環(huán)境的信息輸出到報(bào)告中，比如將測(cè)試時(shí)用的 host 和測(cè)試用的 browser 添加到測(cè)試報(bào)告中：

接著，在測(cè)試腳本中，添加 allure 特性，直接看下面的腳本，我通過(guò)在腳本中添加注釋的方式給大家解釋 allure 特性的用途。比如測(cè)試腳本是
test_shopping_trolley.py：
上面使用了Allure的幾個(gè)特性：

@allure.feature # 用于定義被測(cè)試的功能，被測(cè)產(chǎn)品的需求點(diǎn)
@allure.story # 用于定義被測(cè)功能的用戶場(chǎng)景，即子功能點(diǎn)
with allure.step # 用于將一個(gè)測(cè)試用例，分成幾個(gè)步驟在報(bào)告中輸出
allure.attach # 用于向測(cè)試報(bào)告中輸入一些附加的信息，通常是一些測(cè)試數(shù)據(jù)信息
@pytest.allure.step # 用于將一些通用的函數(shù)作為測(cè)試步驟輸出到報(bào)告，調(diào)用此函數(shù)的地方會(huì)向報(bào)告中輸出步驟
測(cè)試腳本中添加了 Allure 特性之后，在執(zhí)行測(cè)試的時(shí)候需要先生成 Allure 報(bào)告所需要的測(cè)試結(jié)果數(shù)據(jù)。在 py.test 執(zhí)行測(cè)試的時(shí)候，指定 –alluredir 選項(xiàng)及測(cè)試數(shù)據(jù)保存的目錄即可：
./result/ 中保存了本次測(cè)試的結(jié)果數(shù)據(jù)。另外，還可以執(zhí)行指定 features 或者 stories 執(zhí)行一部分測(cè)試用例，比如執(zhí)行‘購(gòu)物車功能’下的‘加入購(gòu)物車’子功能的測(cè)試用例：
接下來(lái)我們可以利用上面命令產(chǎn)生的測(cè)試數(shù)據(jù)生成 Allure 測(cè)試報(bào)告了。生成 Allure 測(cè)試報(bào)告有兩種方式：一個(gè)是命令行方式，一個(gè)是利用 Jenkins 插件。下面分別介紹。
首先需要安裝命令行工具，如果是 Mac 電腦，推薦使用 Homebrew 安裝。
安裝完成后，通過(guò)下面的命令將 ./result/ 目錄下的測(cè)試數(shù)據(jù)生成測(cè)試報(bào)告：
這樣在 ./report/ 目錄下就生成了 Allure 的測(cè)試報(bào)告了。–clean 目的是先清空測(cè)試報(bào)告目錄，再生成新的測(cè)試報(bào)告。
通過(guò)下面的命令打開(kāi)測(cè)試報(bào)告：
本機(jī)的瀏覽器將打開(kāi)網(wǎng)頁(yè)
http://127.0.0.1:8083/index.html 2
展示測(cè)試報(bào)告。
打開(kāi)生成的測(cè)試報(bào)告后，瀏覽器被自動(dòng)調(diào)起，展示測(cè)試報(bào)告。下面我們分別看看測(cè)試報(bào)告的幾個(gè)頁(yè)面。?

1.首頁(yè)

首頁(yè)中展示了本次測(cè)試的測(cè)試用例數(shù)量，成功用例、失敗用例、跳過(guò)用例的比例，測(cè)試環(huán)境信息，SUITES，FEATURES BY STORIES等基本信息，當(dāng)與Jenkins做了持續(xù)置成后，TREND區(qū)域還將顯示，歷次測(cè)試的通過(guò)情況。

首頁(yè)的左邊欄，還從不同的維度展示測(cè)試報(bào)告的其他信息，大家可以自己點(diǎn)進(jìn)去看看。

2. Behaviors

接下來(lái)，我們點(diǎn)擊一下FEATURES BY STORIES，將進(jìn)入Behaviors頁(yè)面，這個(gè)頁(yè)面按照FEATURES和 STORIES展示測(cè)試用例的執(zhí)行結(jié)果：
從這個(gè)頁(yè)面可以看到“購(gòu)物車功能”這個(gè)FEATURES包含的三個(gè)STORIES的測(cè)試用例執(zhí)行情況。

3,、Suites

Allure測(cè)試報(bào)告將每一個(gè)測(cè)試腳本，作為一個(gè)Suite。在首頁(yè)點(diǎn)擊Suites區(qū)域下面的任何一條Suite，都將進(jìn)入Suites頁(yè)面。

這個(gè)頁(yè)面，將腳本的目錄結(jié)果展示本次所有的測(cè)試用例執(zhí)行情況。

4. 測(cè)試用例頁(yè)面

在Suites頁(yè)面上點(diǎn)擊任何一條測(cè)試用例，Suites頁(yè)面的右側(cè)將展示這條用例的詳細(xì)執(zhí)行情況。

從這個(gè)頁(yè)面可以看到測(cè)試用例執(zhí)行的每一個(gè)步驟，以及每個(gè)步驟的執(zhí)行結(jié)果。測(cè)試用例為什么失敗，這里一目了然。

首先需要給Jenkins安裝Allure Plugin。在Jenkins的插件管理頁(yè)面，搜索“allure”，在搜索結(jié)果頁(yè)，選擇“Allure Jenkins Plugin”進(jìn)行安裝。

安裝完成之后重啟一下Jenkins。在Jenkins的“全局工具管理”頁(yè)面，找到Allure Commandline模塊進(jìn)行安裝：

點(diǎn)擊后，彈出下面的頁(yè)面，輸入Allure的命令別名和版本后，點(diǎn)擊Apply 和Save。

按照下面的圖示，在Excute Shell和構(gòu)建后操作部分寫(xiě)上對(duì)應(yīng)的配置信息，即可。
這樣，我們的Jenkins Job執(zhí)行完測(cè)試用例時(shí)候，將在Job的主頁(yè)面上看到Allure Report圖標(biāo)，點(diǎn)擊進(jìn)去就看到了Allure Report報(bào)告。

團(tuán)隊(duì)內(nèi)部可能不同項(xiàng)目使用的測(cè)試框架不一樣，每個(gè)測(cè)試框架生成的測(cè)試報(bào)告也不一樣。但由于 Allure 報(bào)告支持很多測(cè)試框架，通過(guò) Allure 可以生成格式一致的測(cè)試報(bào)告，這就對(duì)外提供格式一致的測(cè)試報(bào)告提供了方便。

建議：團(tuán)隊(duì)內(nèi)部都采用 Allure 生成測(cè)試報(bào)告。由于團(tuán)隊(duì)內(nèi)部有的項(xiàng)目采用的 Java+TestNG 的測(cè)試架構(gòu)，后面有時(shí)間，也介紹一下如何在 TestNG 框架如何集成 Allure。

最后感謝每一個(gè)認(rèn)真閱讀我文章的人，禮尚往來(lái)總是要有的，雖然不是什么很值錢(qián)的東西，如果你用得到的話可以直接拿走：