自動化測試報告(allure/html)


pytest有兩種生成測試報告的方法(html和allure),今天就給大家一一介紹下

html

一.pytest-html基本語法

1.安裝:pip install pytest-html

2.查看版本:pip show pytest-html

3.生成測試報告基本語法:

語法一:pytest --html=生成報告的url  運行用例的.py文件

語法二:pytest --html=生成報告的url  --self-contained-html 運行用例的.py文件

二.實例

1.創建一個test_pytestHtml.py文件,編寫幾條用例(忽略警告)

2.在Terminal運行命令:pytest --html=生成報告的url  運行用例的.py文件,運行成功后,這個時候我們去

生成報告的url下可以看見生成兩個文件,一個是我們生成的html報告,另一個是assets文件,里面存放的是

css文件,打開素材的html報告后可以看見用例的執行情況

3.我們再在Terminal運行命令:pytest --html=生成報告的url  --self-contained-html 運行用例的.py文件,

 同樣運行成功后,我們去看下生成的文件,發現只有html生成,並沒有assets文件,這是因為css語法

 寫在了html文件中,沒有單獨放出來。所以方便以后報告的發送,建議使用第二中語法。

三.修改生成的測試報告(掛鈎用法見pytest官方:https://docs.pytest.org/en/latest/reference/reference.html#hooks)

1.環境的修改

我們可以看到在html中248行,環境是以表格的形式呈現出來的,如果我們想刪除某些默認環境或者添加自

己想要的環境,可在根目錄下創建conftest.py文件,如下圖,pytest_configure(config): 許插件和conftest文

 件執行初始配置。我在再來重新生成html報告可以看見我們在Environment下修改的內容

2.概括的修改

可以看到源代碼中264行表示的是概括,但默認的內容只有用例總數和運行時間,如果我們想要增加自己想要的

 信息模塊,可在conftest.py下編寫函數,再次運行生成html文件就可看見需要的內容了

 

3.標題的修改

 同樣在conftest文件下編寫pytest_html_report_title函數,如下

 

allure(如果可以的話建議使用allure,美觀+高級+好用)

一.環境配置

1.下載jdk配置java運行環境,下載地址:https://www.oracle.com/java/technologies/downloads/#jdk18-windows

2.下載安裝完成后配置java環境變量(屬性>高級設置>環境變量>新建),添加JAVA_HOME。

 在path下里添加:%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin

3.配置完成后可在dos窗口輸入javac,java -version,能輸出版本號及相關指令即安裝配置成功

4.下載allure工具:https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/,下載成功

    后配置環境變量,path下添加allure的bin文件所在目錄

5.配置完成在dos創建輸入allure有相關內容時即安裝成功

6.安裝allure-pytest工具,打開你使用的編程工具,這里以pycharm為例,在Terminal輸入pip install allure-pytest

二.allure報告的生成指令

1.生成json文件:pytest  -q --alluredir=生成json文件的路徑     需要運行的case路徑(說明:-q簡要輸出)

2.將生成的json文件轉出html格式

   (1)指定路徑生成html報告:allure  generate -o  生成html報告的路徑    json文件路徑

   (2)默認路徑生成html報告:allure generate -clear   json文件路徑(說明:默認路徑

             為allure-report,clear清空該路徑原有的報告)

   (3)open及serve用法

            serve:allure serve  -o  生成html報告的路徑    json文件路徑(說明:與generater

                        不同的是,serve生成html后會自動在瀏覽器打開該報告)

            open:allure open  -h  ip地址  html路徑(說明:打開生成的html報告)

            注:serve和open運行時會自動打開一個java進程,且只能手動關閉,因此多次使用

                  serve和open會增加內存消耗

           

三.allure報告的用法(本次介紹下面幾種常用的allure方法)

方法 說明
@allure.epic() 一級類目
@allure.feature() 二級類目
@allure.story() 三級類目
@allure.title() 用例標題
@allure.testcase() case地址
@allure.issue() bug地址
@allure.description() case描述
@allure.step() case步驟
@allure.severity() case等級
@allure.link() 鏈接

1.@allure.epic(),allure.feature(),allure.story()的使用

 (1)創建一個test.two.py文件,寫法如下

import allure

@allure.epic("我是一級目錄") @allure.feature("我是二級目錄") @allure.story("我是三級目錄") class TestDome: def test_one(self): print("我是test_one") assert True def test_two(self): print("我是test_two") assert False

(2)生成json文件:pytest --alluredir=./report/2022-5-22  testcase/test_two.py

(3)將生成的json文件轉出html:allure generate -o ./allure-report/2022-5-22  ./report/2022-5-22

          此時我們可以看見allrue-report目錄下有個2022-5-22/index.html,打開后在Behaviors下可看見運行case

  

2.@allure.title()的使用

(1)從上面可以看出每條case的標題都是函數名字(如:test_one,test_two),我們可以用title修改默認標題

class TestDome:
    @allure.title("我是one")
    def test_one(self):
        print("我是test_one")
        assert True

    @allure.title("我是two")
    def test_two(self):
        print("我是test_two")
        assert False

(2)運行后的結果

   

3.@allure.testcase(),@allure.issue(),@allure.link()用法

(1)allure作用與class上,那么該class下所有的函數都會被定義到,如果allure作用於

         每個函數上,那么只對該函數生效

@allure.testcase("path url", name="我是存放測試用例的地址")
@allure.issue("bug url", name="bug地址")
@allure.link("link url", name="鏈接地址")
class TestDome:
    @allure.title("我是one")
    def test_one(self):
        print("我是test_one")
        assert True

    @allure.title("我是two")
    def test_two(self):
        print("我是test_two")
        assert False

(2)運行后的結果,可以看出case右側多出links模塊

  

 4.@allure.description()用法

(1)用法一:使用description編寫case描述

import pytest
import allure


@allure.epic("我是一級目錄")
@allure.feature("我是二級目錄")
@allure.story("我是三級目錄")
@allure.testcase("path url", name="我是存放測試用例的地址")
@allure.issue("bug url", name="bug地址")
@allure.link("link url", name="鏈接地址")
class TestDome:
    @allure.description("我是來描述test_one這條case的")
    @allure.title("我是one")
    def test_one(self):
        print("我是test_one")
        assert True

    @allure.title("我是two")
    def test_two(self):
        print("我是test_two")
        assert False

運行后該條case右側overview多出了description模塊

(2)用法二:無需使用@allure.description(),可在函數中使用(""""""),生成測試報告會自動獲取

import pytest
import allure


@allure.epic("我是一級目錄")
@allure.feature("我是二級目錄")
@allure.story("我是三級目錄")
@allure.testcase("path url", name="我是存放測試用例的地址")
@allure.issue("bug url", name="bug地址")
@allure.link("link url", name="鏈接地址")
class TestDome:
    @allure.title("我是one")
    def test_one(self):
        """我是test_one實例方法,該方法是TestDome第一個實例方法"""
        print("我是test_one")
        assert True

    @allure.title("我是two")
    def test_two(self):
        print("我是test_two")
        assert False

# pytest --alluredir=./report/2022-5-22-02  testcase/test_two.py
# allure generate -o ./allure-report/2022-5-22-02  ./report/2022-5-22-02

運行后的結果

5.@allure.step()用法

(1)該方法在函數外使用時直接@allure.step()即可。要是在函數中使用,需要with allure.step(): 

import pytest
import allure


class TestDome:
    @allure.step("步驟一")
    @allure.step("步驟二")
    @allure.step("步驟三")
    def test_one(self):
        print("我是test_one")
        assert True

    def test_two(self):
        print("我是test_two")
        assert False
import pytest
import allure


class TestDome:

    def test_one(self):
        with allure.step("步驟一:打開登錄頁面"):
            with allure.step("步驟二:輸入正確的用戶名和密碼"):
                with allure.step("步驟三:點擊登錄"):
                    assert True

    def test_two(self):
        print("我是test_two")
        assert False

運行后結果,可以看到test body下的運行步驟

  

6.@allure.severity()用法

(1)severity有四種等級

blocker 阻塞缺陷
critical 嚴重缺陷
normal 一般缺陷
trivial 輕微缺陷
minor 次要缺陷

(2)具體用法:@allure.severity("等級")

import pytest
import allure


class TestDome:
    @allure.severity("trivial")
    def test_one(self):
        with allure.step("步驟一:打開登錄頁面"):
            with allure.step("步驟二:輸入正確的用戶名和密碼"):
                with allure.step("步驟三:點擊登錄"):
                    assert True

    def test_two(self):
        print("我是test_two")
        assert False

(3)運行結果,如果不手動定義的話,默認為normal bug

四.allure和pytest參數連用

1.@pyteat.mark.parametrize參數化

import pytest
import allure


class TestDome:
    @pytest.mark.parametrize("param", [{"name": "李明", "age": 18}, {"name": "李華", "age": 17}])
    def test_one(self,param):
        with allure.step("步驟一:打開登錄頁面"):
            with allure.step("步驟二:輸入正確的用戶名和密碼"):
                with allure.step("步驟三:點擊登錄"):
                    assert True

    def test_two(self):
        print("我是test_two")
        assert False

運行后結果,可以看出這里test_one運行了兩次,成功測試報告后參數值會自己填充在parameters中

 

2.skip和xfail

(1)我們先來了解下這兩種方法的定義

    @pytest.mark.skip()來跳過該條case不執行,可以看出以下代碼運行后並不會執行test_one  case

import pytest
import allure


class TestDome:
@pytest.mark.skip(reason="跳過該條case")
def test_one(self):
print("我是test_one")
assert True

def test_two(self):
print("我是test_two")
assert True

  @pytest.mark.xfail()標記預期結果值,

import pytest
import allure


class TestDome:
    @pytest.mark.xfail(reason="預期返回True")
    def test_one(self):
        print("我是test_one")
        assert True

    def test_two1(self):
        print("我是test_two")
        assert True

 (2)接下來進入正題,skip and xfail與alure一起使用這里直接貼圖吧,具體寫法和上面一致

這里可以看出test_one case跳過后並沒有運行,置灰顯示

 五.在allure報告中打印日志和print內容

1.首先我們需要先封裝下logging日志,具體寫法如下(這里你定義一個函數,編寫在函數中)

import logging
import os

logger = logging.getLogger("weixin_api_log")  # 設置日志名稱
logger.setLevel(logging.DEBUG)  # 設置日志等級
formats = logging.Formatter("[%(asctime)s] [%(levelname)s] %(message)s")  # 設置打印格式
file_url = logging.FileHandler("C:/Users/XXX/PycharmProjects/weixin_api/log/weixin.log", mode="a+",
                               encoding="utf8")  # log文件路徑
# file_url1 = logging.StreamHandler()  # 操作台打印
file_url.setFormatter(formats)  # 賦予打印格式
# file_url1.setFormatter(formats)

logger.addHandler(file_url)
# logger.addHandler(file_url1)

2.創建test_one.py調用logging

import pytest
import allure
from commom.log import logger
import datetime


class TestDome:
    def test_one(self):
        logger.debug(f"日志時間:{datetime.datetime.now()}")
        print("我是test_one")
        assert True

    def test_two1(self):
        print("我是test_two")
        assert True

3.運行結果(這里需要注意的是,運行是不用加-s參數,如果加的話,print打印內容不會再報告中顯示)

 

在test body下log里會展示打印的日志,stdout里展示的是print打印的內容

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM