pytest 自動化測試框架(一)

阿新 • • 發佈：2020-10-22

本文節選自霍格沃玆測試學院內部教材，文末連結進階學習。

簡介

pytest 是一個成熟的全功能 Python 測試工具，可以幫助您編寫更好的程式。它與 Python 自帶的 Unittest 測試框架類似，但 pytest 使用起來更簡潔和高效，並且相容 unittest 框架。pytest 有以下實用特性：

pytest 能夠支援簡單的單元測試和複雜的功能測試；
pytest 本身支援單元測試；
可以結合 Requests 實現介面測試；
結合 Selenium、Appium 實現自動化功能測試；
使用 pytest 結合 Allure 整合到 Jenkins 中可以實現持續整合。工作中一般會使用持續整合來完成程式碼整合到主幹分支之後的迴歸測試，通過自動化測試的手段來實現產品的快速迭代，同時還能保證產品的高質量。
pytest 支援 315 種以上的外掛；

參考網站：

http://plugincompat.herokuapp.com/
https://docs.pytest.org/

安裝

pip install -U pytest

檢視版本

pytest --version

用例的識別與執行

用例編寫規範：

測試檔案以test_開頭（以_test結尾也可以）
測試類以Test開頭，並且不能帶有 init 方法
測試函式以test_開頭
斷言使用基本的assert即可

建立一個 python 檔案，命名以test_開頭（或者以_test結尾），建立測試方法以test_

開頭，測試類需要以Test開頭。建立檔名為test_add.py檔案，程式碼如下：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
def add(x, y):
    return x + y

def test_add():
    assert add(1, 10) == 11
    assert add(1, 1) == 2
    assert add(1, 99) == 100

class TestClass:
    def test_one(self):
        x = "this"
        assert "h" in x

    def test_two(self):
        x  
= "hello"
        assert hasattr(x, "check")

執行test_add.py檔案，在命令列進入到這個檔案所在的路徑，可以直接使用 pytest 命令執行，pytest 會找當前目錄以及遞查詢子目錄下所有的test_*.py或*_test.py的檔案，把其當作測試檔案。在這些檔案裡，pytest 會收集符合編寫規範的函式，類以及方法，當作測試用例並且執行，執行如下：

 $ pytest
....

test_add.py ..F  [100%]
....

self = <test_cases.test_add.TestClass object at 0x1091810d0>

    def test_two(self):
        x = "hello"
>       assert hasattr(x, "check")
E       AssertionError: assert False
E        +  where False = hasattr('hello', 'check')

test_add.py:18: AssertionError
===================================================== 1 failed, 2 passed in 0.05s 
...

結果分析：執行結果中，F代表用例未通過(斷言錯誤)，.用例通過。如果有報錯會有詳細的錯誤資訊。pytest 也支援 Unittest 模式的用例定義。

執行引數

pytest 帶有很多引數，可以使用pytest --help來檢視幫助文件，下面介紹幾種常用的引數：

無引數

讀取路徑下所有符合規則的檔案，類，方法，函式全部執行。使用方法如下：

pytest 或者 py.test

-v 引數

列印詳細執行日誌資訊，一般在除錯的時候加上這個引數，終端會打印出每條用例的詳細日誌資訊，方便定位問題。使用方法如下：

pytest -v

-s 引數

帶控制檯輸出結果，當你的程式碼裡面有print輸出語句，如果想在執行結果中列印print輸出的程式碼，在執行的時候可以新增-s引數，一般在除錯的時候使用，使用方法如下：

pytest -s

-k 引數

跳過執行某個或者某些用例。

應用場景：在測試場景中，開發人員有一部分功能程式碼還沒實現，測試人員已經將測試用例設計出來，或者測試人員發現了某功能上的 bug 需要開發人員修復之後再測試這部分有缺陷的測試用例，可以將這部分測試用例在執行的時候暫時跳過，等功能實現或者 bug 解決之後再加入執行。

使用方法如下：

pytest -k '類名' 
pytest -k '方法名' 
pytest -k '類名 and not 方法名' //執行類裡所有的方法，不包含某個方法

-x 引數

遇到用例失敗立即停止執行。

應用場景：在迴歸測試過程中，假如一共有10條基礎用例，當開發人員打完包提交測試的時候，需要先執行這10條基礎用例，全部通過才能提交給測試人員正式測試。如果有一條用例失敗，都將這個版本打回給開發人員。這時就可以新增-x引數，一旦發現有失敗的用例即中止執行。

使用方法如下：

pytest -x

--maxfail 引數

用例失敗個數達到閥值停止執行。具體用法：

pytest --maxfail=[num]

應用場景：在迴歸測試過程中，假如一共有10條基礎用例，當開發人員打完包提交測試的時候，需要先執行這10條基礎用例，全部通過才能提交給測試人員正式測試。如果執行過程中有 [num] 條用例失敗，即中止執行，後面測試用例都放棄執行，直接退出。這時可以使用--maxfail引數。

使用方法如下：

-m 引數

將執行有 @pytest.mark.[標記名] 這個標記的測試用例。

應用場景：在自動化測試過程中可以將測試用例新增標籤進行分類，比如登入功能、搜尋功能、購物車功能、訂單結算功能等，在執行的時候可以只執行某個功能的所有的測試用例，比如這個版本只想驗證登入功能，那就在所有登入功能的測試用例方法上面加上裝飾符@pytest.mark.login，執行的時候使用命令新增一個-m引數，例如執行pytest -m login命令就可以只執行登入功能這部分的測試用例。

使用方法如下：

pytest -m [標記名]

執行模式

pytest 提供了多種執行模式，讓開發和除錯更得心應手。指定某個模組，執行單獨一個 pytest 模組。

應用場景：在編寫測試用例的時候，經常會單獨除錯某個類，或者某個方法，這時可以使用 Pycharm 裡面自帶的除錯方式，點選用例方法名前面的綠色按鈕，也可以使用命令列的方式單獨執行某個用例。

pytest 中可以使用pytest 檔名.py單獨執行某個 Python 檔案，也可以使用pytest 檔名.py::類名單獨執行某個檔案中的類，使用pytest 檔名.py::類名::方法名單獨執行類中的某個方法。

使用方法如下：

pytest 檔名.py
pytest 檔名.py::類名
pytest 檔名.py::類名::方法名

在 Pycharm 中執行 pytest 用例

開啟 Pycharm -> 設定 -> Tools -> Python Integrated Tools -> Testing: pytest

首先次設定成 pytest ，需要安裝 pytest，可以直接按照這個頁面的提示點選“fix”,也可以在 Project interpreter 裡面新增 pytest 依賴包。安裝完 pytest 之後，編寫的符合規則的測試用例都能被識別出來並且標出一個綠色的執行按鈕，點選這個按鈕也能執行某個方法或者某個類。例如：

Pycharm 設定執行方式為 pytest 之後，用例左側會顯示綠色按鈕，可以直接點選這個按鈕來執行這條用例。

pytest 框架結構

與 unittest 類似，執行用例前後會執行 setup，teardown 來增加用例的前置和後置條件。pytest 框架中使用 setup，teardown 更靈活，按照用例執行級別可以分為以下幾類：

模組級（setup_module/teardown_module）在模組始末呼叫
函式級（setup_function/teardown_function）在函式始末呼叫(在類外部）
類級（setup_class/teardown_class）在類始末呼叫（在類中）
方法級（setup_method/teardown_methond）在方法始末呼叫（在類中）
方法級（setup/teardown）在方法始末呼叫（在類中）

呼叫順序：

setup_module > setup_class >setup_method > setup > teardown > teardown_method > teardown_class > teardown_module

驗證上面的執行順序，看下面的案例。

建立檔名為 test_run_step.py ，程式碼如下：

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

def setup_module():
    print("\nsetup_module，只執行一次，當有多個測試類的時候使用")

def teardown_module():
    print("\nteardown_module，只執行一次，當有多個測試類的時候使用")

class TestPytest1(object):

    @classmethod
    def setup_class(cls):
        print("\nsetup_class1，只執行一次")

    @classmethod
    def teardown_class(cls):
        print("\nteardown_class1，只執行一次")

    def setup_method(self):
        print("\nsetup_method1，每個測試方法都執行一次")

    def teardown_method(self):
        print("teardown_method1，每個測試方法都執行一次")

    def test_three(self):
        print("test_three，測試用例")

    def test_four(self):
        print("test_four，測試用例")

class TestPytest2(object):

    @classmethod
    def setup_class(cls):
        print("\nsetup_class2，只執行一次")

    @classmethod
    def teardown_class(cls):
        print("\nteardown_class2，只執行一次")

    def setup_method(self):
        print("\nsetup_method2，每個測試方法都執行一次")

    def teardown_method(self):
        print("teardown_method2，每個測試方法都執行一次")

    def test_two(self):
        print("test_two，測試用例")

    def test_one(self):
        print("test_one，測試用例")

上面的程式碼執行完成後，檢視測試結果來分析執行測試順序：

...
plugins: html-2.0.1, rerunfailures-8.0, xdist-1.31.0, ordering-0.6, forked-1.1.3, allure-pytest-2.8.11, metadata-1.8.0
collecting ... collected 4 items

test_run.py::TestPytest1::test_three 
setup_module，只執行一次，當有多個測試類的時候使用
setup_class1，只執行一次
setup_method1，每個測試方法都執行一次  PASSED      [ 25%]test_three，測試用例
teardown_method1，每個測試方法都執行一次
test_run.py::TestPytest1::test_four 
setup_method1，每個測試方法都執行一次    PASSED    [ 50%]test_four，測試用例
teardown_method1，每個測試方法都執行一次
teardown_class1，只執行一次
test_run.py::TestPytest2::test_two 
setup_class2，只執行一次
setup_method2，每個測試方法都執行一次    PASSED    [ 75%]test_two，測試用例
teardown_method2，每個測試方法都執行一次
test_run.py::TestPytest2::test_one 
setup_method2，每個測試方法都執行一次    PASSED     [100%]test_one，測試用例
teardown_method2，每個測試方法都執行一次
teardown_class2，只執行一次
teardown_module，只執行一次，當有多個測試類的時候使用
============================== 4 passed in 0.03s ===============================
...

從上面的結果可以看出 setup_module 和 teardown_module 在整個模組只執行一次，setup_class 和 teardown_class 在類裡面只執行一次，setup_method 和 teardown_method 在每個方法前後都會呼叫。

控制用例的執行順序

pytest 載入所有的測試用例是亂序的，如果想指定用例的順序，可以使用 pytest-order 外掛，指定用例的執行順序只需要在測試用例的方法前面加上裝飾器@pytest.mark.run(order=[num])設定order的對應的num值，它就可以按照 num 的大小順序來執行。

應用場景：有時執行測試用例需要指定它的順序，比如有些場景需要先執行完登入，才能執行後續的流程比如購物流程，下單流程，這時就需要指定測試用例的順序。通過pytest-ordering這個外掛可以完成用例順序的指定。

安裝

pip install pytest-ordering

案例

建立一個測試檔案“test_order.py”，程式碼如下：

import pytest

class TestPytest(object):

    @pytest.mark.run(order=-1)
    def test_two(self):
        print("test_two，測試用例")

    @pytest.mark.run(order=3)
    def test_one(self):
        print("test_one，測試用例")

    @pytest.mark.run(order=1)
    def test_three(self):
        print("\ntest_three，測試用例")

執行結果，如下檢視執行順序：

省略...
plugins: html-2.0.1, rerunfailures-8.0, xdist-1.31.0, \
ordering-0.6, forked-1.1.3, allure-pytest-2.8.11, metadata-1.8.0
collecting ... collected 3 items

test_order.py::TestPytest::test_three 
test_order.py::TestPytest::test_one 
test_order.py::TestPytest::test_two 
省略...

從上面的執行結果可以看出，執行時以 order 的順序執行：order=1，order=3，order=-1。

pytest 自動化測試框架(一)

簡介

安裝

用例的識別與執行

執行引數

在 Pycharm 中執行 pytest 用例

pytest 框架結構

控制用例的執行順序

安裝

案例

更多技術文章分享及測試資料點此獲取

pytest 自動化測試框架(一)

介面自動化測試框架開發(pytest+allure+aiohttp+ 用例自動生成)

推薦一款自動化測試框架，超級容易上手——Airtest

Python介面自動化測試框架: pytest+allure+jsonpath+requests+excel實現的介面自動化測試框架(學習成果)

Web UI自動化測試框架Seldom實戰一

一文講透！實現一個Python+Selenium的自動化測試框架如此簡單！

測開實戰 / 介面自動化測試框架開發(pytest+allure+aiohttp+用例自動生成)

自動化測試框架pytest -- 安裝和入門到精通實戰

pytest+yaml+allure介面自動化測試框架04.處理request

為什麼自動化測試框架中優先用 Pytest而不是 Robot Framework？

【自動化測試框架】pytest和unitttest你知道多少？區別在哪？該用哪個？

Python 自動化測試框架unittest與pytest的區別

《手把手教你》系列基礎篇（八十一）-java+ selenium自動化測試-框架設計基礎-TestNG如何暫停執行一些case（詳解教程）

《手把手教你》系列基礎篇（九十一）-java+ selenium自動化測試-框架設計基礎-Logback實現日誌輸出-下篇（詳解教程）

基於Selenium+Python的web自動化測試框架

Python3+Requests+Excel完整介面自動化測試框架的實現

python中的selenium安裝的步驟（瀏覽器自動化測試框架）

Pytest 單元測試框架標記用例

對於自動化測試框架的總結

還在糾結搭建框架無從下手？Python + Selenium，分分鐘搭建 Web 自動化測試框架

pytest 自動化測試框架(一)

簡介

安裝

用例的識別與執行

執行引數

在 Pycharm 中執行 pytest 用例

pytest 框架結構

控制用例的執行順序

安裝

案例

相關推薦