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

本篇文章將介紹如何使用開源的測試報告生成框架 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
    展示測試報告赶掖。
    打開生成的測試報告后感猛,瀏覽器被自動調起,展示測試報告奢赂。下面我們分別看看測試報告的幾個頁面陪白。
  1. 首頁
    首頁中展示了本次測試的測試用例數量,成功用例膳灶、失敗用例咱士、跳過用例的比例,測試環(huán)境信息轧钓,SUITES序厉,F(xiàn)EATURES BY STORIES等基本信息,當與Jenkins做了持續(xù)置成后毕箍,TREND區(qū)域還將顯示弛房,歷次測試的通過情況。
    首頁的左邊欄而柑,還從不同的維度展示測試報告的其他信息文捶,大家可以自己點進去看看荷逞。

  2. Behaviors
    接下來,我們點擊一下FEATURES BY STORIES粹排,將進入Behaviors頁面颅围,這個頁面按照FEATURES和 STORIES展示測試用例的執(zhí)行結果:
    從這個頁面可以看到“購物車功能”這個FEATURES包含的三個STORIES的測試用例執(zhí)行情況。

  3. Suites

Allure測試報告將每一個測試腳本恨搓,作為一個Suite院促。在首頁點擊Suites區(qū)域下面的任何一條Suite,都將進入Suites頁面斧抱。
這個頁面常拓,將腳本的目錄結果展示本次所有的測試用例執(zhí)行情況。

  1. 測試用例頁面
    在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。

原文鏈接

更多技術文章

喜歡軟件測試的小伙伴們群扶,如果我的博客對你有幫助及刻、如果你喜歡我的博客內容,請 “點贊” “評論” “收藏” 一鍵三連哦竞阐!

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末缴饭,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子骆莹,更是在濱河造成了極大的恐慌颗搂,老刑警劉巖,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件幕垦,死亡現(xiàn)場離奇詭異丢氢,居然都是意外死亡,警方通過查閱死者的電腦和手機先改,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進店門疚察,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人仇奶,你說我怎么就攤上這事稍浆。” “怎么了猜嘱?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵衅枫,是天一觀的道長。 經常有香客問我朗伶,道長弦撩,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任论皆,我火速辦了婚禮益楼,結果婚禮上,老公的妹妹穿的比我還像新娘点晴。我一直安慰自己感凤,他們只是感情好,可當我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布粒督。 她就那樣靜靜地躺著陪竿,像睡著了一般。 火紅的嫁衣襯著肌膚如雪屠橄。 梳的紋絲不亂的頭發(fā)上族跛,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天闰挡,我揣著相機與錄音,去河邊找鬼礁哄。 笑死长酗,一個胖子當著我的面吹牛,可吹牛的內容都是我干的桐绒。 我是一名探鬼主播夺脾,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼茉继!你這毒婦竟也來了咧叭?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤馒疹,失蹤者是張志新(化名)和其女友劉穎佳簸,沒想到半個月后,有當地人在樹林里發(fā)現(xiàn)了一具尸體颖变,經...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡生均,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了腥刹。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片马胧。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖衔峰,靈堂內的尸體忽然破棺而出佩脊,到底是詐尸還是另有隱情,我是刑警寧澤垫卤,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布威彰,位于F島的核電站,受9級特大地震影響穴肘,放射性物質發(fā)生泄漏歇盼。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一评抚、第九天 我趴在偏房一處隱蔽的房頂上張望豹缀。 院中可真熱鬧,春花似錦慨代、人聲如沸邢笙。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽氮惯。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間筐骇,已是汗流浹背债鸡。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工江滨, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留铛纬,地道東北人。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓唬滑,卻偏偏與公主長得像告唆,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子晶密,可洞房花燭夜當晚...
    茶點故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內容