
本文節選自霍格沃玆測試學院測試開發内部教材,進階學習文末加群!
測試報告在項目中是至關重要的角色,一個好的測試報告:
- 可以展現測試人員的工作量;
- 開發人員可以從測試報告中了解缺陷的情況;
- 測試經理可以從測試報告中看到測試人員的執行情況及測試用例的覆寫率;
- 項目負責人可以通過測試報告檢視整個項目還餘留多少問題,此次版本是否測試通過;
是以打造一個美觀、一目了然的測試報告,清晰的反應品質問題,并提供給相關人員了解項目的整體狀态,是非常必要的。
Pytest 結合 Allure 生成測試報告
Allure 架構是一種靈活的、輕量級、支援多語言測試報告工具,它不僅能夠以簡潔的 Web 報告形式顯示已測試的内容,而且允許參與開發過程的每個人從測試的日常執行中提取最大限度的有用資訊。同時支援多種語言包括 Java、Python、JavaScript、Ruby、Groovy、PHP、.Net、 Scala。
安裝
Mac 可以使用 brew 安裝 allure,安裝指令如下:
brew install allure
其他作業系統請參考:
https://docs.qameta.io/allure/#_installing_a_commandline與 pytest 結合需要安裝 allure-pytest 插件:
pip install allure-pytest
檢視 Allure 版本:
allure --version
運作
第一步:在 pytest 執行測試的時候,指定參數 --alluredir 選項及結果資料儲存的目錄,代碼如下:
pytest --alluredir=tmp/my_allure_results
tmp/my_allure_results 中儲存了本次測試的結果資料。
第二步:打開報告,需要啟動 allure 服務,在 terminal 中輸入 allure serve [path/to/allure_results],代碼如下:
allure serve path/to/allure_results
也可以使用 allure generate 生成 HTML 格式的測試結果報告,并使用 allure open 來打開報告。
allure generate ./result/ -o ./report/ --clean
上面的指令将 ./result/ 目錄下的測試資料生成HTML測試報告到 ./report 路徑下,
--clean
選項目的是先清空測試報告目錄,再生成新的測試報告,然後使用下面的指令打開報告。
allure open -h 127.0.0.1 -p 8883 ./report/
上面這個指令則會啟動一個 Web 服務将已經生成的測試報告打開。打開生成的測試報告,在預設的浏覽器打開測試報告,報告如下:
上面的測試報告首頁中展示了此次測試的測試用例數量以及成功用例、失敗用例、跳過用例的比例、測試環境、SUITES、FEATURES BY STORIES 等基本資訊。當與 Jenkins 做了持續置成後,TREND 區域還将顯示,曆次測試的通過情況。
首頁的左邊欄,還從不同的次元展示測試報告的其他資訊。重點頁面介紹:
- Behaviors 頁面,按照 FEATURES 和 STORIES 展示測試用例的執行結果;
- Suites 頁面,Allure 測試報告将每一個測試腳本,作為一個 Suite。在首頁裡點選 Suites 區域内的任何一條 Suite,都會進入 Suites 頁面;
- Graphs 頁面,展示了此次測試結果的統計資訊,比如測試用例執行結果狀态、測試用例重要等級分布、測試用例執行時間分布等;
- 測試用例詳情頁面,在 Suites 頁面上點選任何一條測試用例,Suites 頁面的右側将展示這條用例的詳細執行情況。在這個頁面可以看到測試用例的每個步驟,以及每個步驟的執行結果,包括步驟裡面添加的連結、圖檔、網頁片段或者視訊作為重要資訊的補充。在這裡可以一目了在的看到用例失敗的原因。
實戰案例 | 百度搜尋功能自動化測試
在實際項目中,一旦用例報錯,我們希望能夠将當時應用的狀态記錄下來,記錄這些狀态的方式可以是日志、截圖、視訊等手段,并将這些記錄在測試報告中,友善相關人員定位問題。我們基于 Pytest 與 Allure 結合生成測試報告來實作這個目标。
以百度 Web 網頁版本測試為例,百度首頁呈現的功能:新聞、網頁、貼吧、知道、音樂、圖檔、視訊、地圖等,我們以百度網頁的搜尋功能為例,使用 Allure、pytest 結合 Selenium 自動化測試架構,完成一個搜尋功能的測試。
為了模拟百度搜尋功能場景,這裡需要建立兩個檔案,資料檔案與用例檔案。首先建立資料管理檔案 data/data.yml,代碼如下:
- allure
- pytest
- unittest
然後,建立用例檔案名為 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("打開百度網頁"):
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("關閉浏覽器"):
driver.quit()
代碼解析:
- allure.testcase 用例辨別,給定用例的連結,可以與用例的管理位址關聯。
- allure.feature 功能子產品劃分,友善管理和運作測試用例。
- pytest.mark.parametrize 用來參數化測試用例。
- allure.step 用來添加測試步驟,在測試報告裡面會展示出來這個步驟說明。
執行:
pytest test_baidudemo.py -s -q --alluredir=./result/
allure serve ./result/
測試結果圖:
上面的測試報告展示運作時間,時長,用例數,通過率,以及測試套件 SUITES,環境等資訊。
點選左側欄最下方的 Package 可以看到所有的測試用例以及測試資料,點選一條用例右側會展示出用例的優先級,資料,測試步驟以及每個步驟的的名稱及附加的圖檔等資訊。這裡添加了一個測試用例的連結,可以與測試用例的管理連結關聯起來,友善後期統計覆寫率。
另外,pytest 與 Allure 也可以與 Jenkins 內建,實作自動化測試的持續內建。