Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告

image.png

測(cè)試報(bào)告在項(xiàng)目中是至關(guān)重要的角色,一個(gè)好的測(cè)試報(bào)告:

  1. 可以體現(xiàn)測(cè)試人員的工作量;
  2. 開(kāi)發(fā)人員可以從測(cè)試報(bào)告中了解缺陷的情況;
  3. 測(cè)試經(jīng)理可以從測(cè)試報(bào)告中看到測(cè)試人員的執(zhí)行情況及測(cè)試用例的覆蓋率;
  4. 項(xiàng)目負(fù)責(zé)人可以通過(guò)測(cè)試報(bào)告查看整個(gè)項(xiàng)目還余留多少問(wèn)題,此次版本是否測(cè)試通過(guò);

所以打造一個(gè)美觀、一目了然的測(cè)試報(bào)告,清晰的反應(yīng)質(zhì)量問(wèn)題,并提供給相關(guān)人員了解項(xiàng)目的整體狀態(tài),是非常必要的。

Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告

Allure 框架是一種靈活的、輕量級(jí)、支持多語(yǔ)言測(cè)試報(bào)告工具,它不僅能夠以簡(jiǎn)潔的 Web 報(bào)告形式顯示已測(cè)試的內(nèi)容,而且允許參與開(kāi)發(fā)過(guò)程的每個(gè)人從測(cè)試的日常執(zhí)行中提取最大限度的有用信息。同時(shí)支持多種語(yǔ)言包括 Java、Python、JavaScript、Ruby、Groovy、PHP、.Net、 Scala。

安裝

Mac 可以使用 brew 安裝 allure,安裝命令如下:

brew install allure 

其他操作系統(tǒng)請(qǐng)參考:

https://docs.qameta.io/allure/#_installing_a_commandline

與 pytest 結(jié)合需要安裝 allure-pytest 插件:

pip install allure-pytest

查看 Allure 版本:

allure --version

運(yùn)行

第一步:在 pytest 執(zhí)行測(cè)試的時(shí)候,指定參數(shù) --alluredir 選項(xiàng)及結(jié)果數(shù)據(jù)保存的目錄,代碼如下:

pytest --alluredir=tmp/my_allure_results

tmp/my_allure_results 中保存了本次測(cè)試的結(jié)果數(shù)據(jù)。

第二步:打開(kāi)報(bào)告,需要啟動(dòng) allure 服務(wù),在 terminal 中輸入 allure serve [path/to/allure_results],代碼如下:

allure serve path/to/allure_results

也可以使用 allure generate 生成 HTML 格式的測(cè)試結(jié)果報(bào)告,并使用 allure open 來(lái)打開(kāi)報(bào)告。

allure generate ./result/ -o ./report/ --clean

上面的命令將 ./result/ 目錄下的測(cè)試數(shù)據(jù)生成HTML測(cè)試報(bào)告到 ./report 路徑下,-–clean 選項(xiàng)目的是先清空測(cè)試報(bào)告目錄,再生成新的測(cè)試報(bào)告,然后使用下面的命令打開(kāi)報(bào)告。

allure open -h 127.0.0.1 -p 8883 ./report/ 

上面這個(gè)命令則會(huì)啟動(dòng)一個(gè) Web 服務(wù)將已經(jīng)生成的測(cè)試報(bào)告打開(kāi)。打開(kāi)生成的測(cè)試報(bào)告,在默認(rèn)的瀏覽器打開(kāi)測(cè)試報(bào)告,報(bào)告如下:

Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告
Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告

上面的測(cè)試報(bào)告首頁(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)頁(yè)面介紹:

  • Behaviors 頁(yè)面,按照 FEATURES 和 STORIES 展示測(cè)試用例的執(zhí)行結(jié)果;
  • Suites 頁(yè)面,Allure 測(cè)試報(bào)告將每一個(gè)測(cè)試腳本,作為一個(gè) Suite。在首頁(yè)里點(diǎn)擊 Suites 區(qū)域內(nèi)的任何一條 Suite,都會(huì)進(jìn)入 Suites 頁(yè)面;
  • Graphs 頁(yè)面,展示了此次測(cè)試結(jié)果的統(tǒng)計(jì)信息,比如測(cè)試用例執(zhí)行結(jié)果狀態(tài)、測(cè)試用例重要等級(jí)分布、測(cè)試用例執(zhí)行時(shí)間分布等;
  • 測(cè)試用例詳情頁(yè)面,在 Suites 頁(yè)面上點(diǎn)擊任何一條測(cè)試用例,Suites 頁(yè)面的右側(cè)將展示這條用例的詳細(xì)執(zhí)行情況。在這個(gè)頁(yè)面可以看到測(cè)試用例的每個(gè)步驟,以及每個(gè)步驟的執(zhí)行結(jié)果,包括步驟里面添加的鏈接、圖片、網(wǎng)頁(yè)片段或者視頻作為重要信息的補(bǔ)充。在這里可以一目了在的看到用例失敗的原因。

實(shí)戰(zhàn)案例|百度搜索功能自動(dòng)化測(cè)試

在實(shí)際項(xiàng)目中,一旦用例報(bào)錯(cuò),我們希望能夠?qū)?dāng)時(shí)應(yīng)用的狀態(tài)記錄下來(lái),記錄這些狀態(tài)的方式可以是日志、截圖、視頻等手段,并將這些記錄在測(cè)試報(bào)告中,方便相關(guān)人員定位問(wèn)題。我們基于 Pytest 與 Allure 結(jié)合生成測(cè)試報(bào)告來(lái)實(shí)現(xiàn)這個(gè)目標(biāo)。

以百度 Web 網(wǎng)頁(yè)版本測(cè)試為例,百度首頁(yè)呈現(xiàn)的功能:新聞、網(wǎng)頁(yè)、貼吧、知道、音樂(lè)、圖片、視頻、地圖等,我們以百度網(wǎng)頁(yè)的搜索功能為例,使用 Allure、pytest 結(jié)合 Selenium 自動(dòng)化測(cè)試框架,完成一個(gè)搜索功能的測(cè)試

為了模擬百度搜索功能場(chǎng)景,這里需要?jiǎng)?chuàng)建兩個(gè)文件,數(shù)據(jù)文件與用例文件。首先創(chuàng)建數(shù)據(jù)管理文件 data/data.yml,代碼如下:

- allure
- pytest
- unittest

然后,創(chuàng)建用例文件名為 test_baidudemo.py,代碼如下:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import allure
import pytest
import yaml
from selenium import webdriver
import time

@allure.testcase("http://www.github.com")
@allure.feature("百度搜索")
@pytest.mark.parametrize('test_data1', yaml.safe_load(\
open("data/data.yml")))
def test_steps_demo(test_data1):
    with allure.step("打開(kāi)百度網(wǎng)頁(yè)"):
        driver = webdriver.Chrome()
        driver.get("http://www.baidu.com")
        driver.maximize_window()

    with allure.step(f"輸入搜索詞:{test_data1}"):
        driver.find_element_by_id("kw").send_keys(test_data1)
        time.sleep(2)
        driver.find_element_by_id("su").click()
        time.sleep(2)

    with allure.step("保存圖片"):
        driver.save_screenshot("./result/b.png")
        allure.attach.file("./result/b.png", \
        attachment_type=allure.attachment_type.PNG)
    with allure.step("關(guān)閉瀏覽器"):
        driver.quit()

代碼解析:

  • allure.testcase 用例標(biāo)識(shí),給定用例的鏈接,可以與用例的管理地址關(guān)聯(lián)。
  • allure.feature 功能模塊劃分,方便管理和運(yùn)行測(cè)試用例。
  • pytest.mark.parametrize 用來(lái)參數(shù)化測(cè)試用例。
  • allure.step 用來(lái)添加測(cè)試步驟,在測(cè)試報(bào)告里面會(huì)展示出來(lái)這個(gè)步驟說(shuō)明。

執(zhí)行:

 pytest test_baidudemo.py -s -q --alluredir=./result/

 allure serve ./result/

測(cè)試結(jié)果圖:

Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告
Pytest 結(jié)合 Allure 生成測(cè)試報(bào)告

上面的測(cè)試報(bào)告展示運(yùn)行時(shí)間,時(shí)長(zhǎng),用例數(shù),通過(guò)率,以及測(cè)試套件 SUITES,環(huán)境等信息。

點(diǎn)擊左側(cè)欄最下方的 Package 可以看到所有的測(cè)試用例以及測(cè)試數(shù)據(jù),點(diǎn)擊一條用例右側(cè)會(huì)展示出用例的優(yōu)先級(jí),數(shù)據(jù),測(cè)試步驟以及每個(gè)步驟的的名稱及附加的圖片等信息。這里添加了一個(gè)測(cè)試用例的鏈接,可以與測(cè)試用例的管理鏈接關(guān)聯(lián)起來(lái),方便后期統(tǒng)計(jì)覆蓋率。

另外,pytest 與 Allure 也可以與 Jenkins 集成,實(shí)現(xiàn)自動(dòng)化測(cè)試的持續(xù)集成。更多測(cè)試開(kāi)發(fā)實(shí)戰(zhàn)進(jìn)階技巧,推薦學(xué)習(xí)霍格沃茲《測(cè)試開(kāi)發(fā)實(shí)戰(zhàn)進(jìn)階》課程。

(文章來(lái)源于霍格沃茲測(cè)試學(xué)院)
更多技術(shù)資料點(diǎn)此鏈接獲取http://qrcode.testing-studio.com/f?from=jianshu&url=https://ceshiren.com/t/topic/3595

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,923評(píng)論 6 535
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,740評(píng)論 3 420
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 176,856評(píng)論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 63,175評(píng)論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,931評(píng)論 6 410
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 55,321評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,383評(píng)論 3 443
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書人閱讀 42,533評(píng)論 0 289
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,082評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,891評(píng)論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,067評(píng)論 1 371
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,618評(píng)論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,319評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 34,732評(píng)論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 35,987評(píng)論 1 289
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,794評(píng)論 3 394
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,076評(píng)論 2 375

推薦閱讀更多精彩內(nèi)容