Pytest測試框架（三）：pytest fixture 用法

測試開發小記發表於2021-01-03

xUnit style 結構的 fixture用於初始化測試函式， pytest fixture是對傳統的 xUnit 架構的setup/teardown功能的改進。pytest fixture為測試準備一個良好的測試環境，測試函式使用的每個 fixture通常有一個引數(以 fixture 命名)，測試函式通過引數訪問它們。本文將介紹pytest fixture的一些基本用法。

@pytest.fixture

import pytest

@pytest.fixture()
def login():
    print("登入")
    return 8

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self, login):
        print("\n開始執行測試用例2")
        print(login)
        assert 2 + login == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100

if __name__ == '__main__':
    pytest.main()

test_case2需要呼叫login方法（或者獲取login的返回值），pytest 將會尋找並呼叫@pytest.fixture標記的login() 方法。

結果：

PASSED                           [ 33%]
開始執行測試用例1
登入
PASSED                           [ 66%]
開始執行測試用例2
8
PASSED                           [100%]
開始執行測試用例3

共享 fixture 函式：conftest.py

在測試過程中，多個測試檔案可能都要呼叫 fixture 函式，可以將其移動到 conftest.py 檔案中。conftest.py 檔案中的 fixture 函式不需要在測試函式中匯入，可以被 pytest 自動識別，查詢順序從測試類開始，然後是測試模組，然後是 conftest.py 檔案，最後是內建外掛和第三方外掛。

conftest.py ：

import pytest
@pytest.fixture()
def login():
    print("登入")
    return 8

測試用例：

import pytest

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self, login):
        print("\n開始執行測試用例2")
        print(login)
        assert 2 + login == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

PASSED                           [ 33%]
開始執行測試用例1
登入
PASSED                           [ 66%]
開始執行測試用例2
8
PASSED                           [100%]
開始執行測試用例3

yield方法

使用yield關鍵字可以實現setup/teardown的功能，在yield關鍵字之前的程式碼在case之前執行，yield之後的程式碼在case執行結束後執行

import pytest

@pytest.fixture()
def login():
    print("登入")
    yield
    print("退出登入")

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self, login):
        print("\n開始執行測試用例2")
        assert 2 + 8 == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

PASSED                      [ 33%]
開始執行測試用例1
登入
PASSED                      [ 66%]
開始執行測試用例2
退出登入
PASSED                      [100%]
開始執行測試用例3

addfinalizer方法

addfinalizer也可以實現環境的清理，實現與yield方法相同的效果，跟yield不同的是需要註冊作為終結器使用的函式。

import pytest

@pytest.fixture()
def login(request):
    print("登入")
    def demo_finalizer():
        print("退出登入")
    # 註冊demo_finalizer為終結函式
    request.addfinalizer(demo_finalizer)

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self, login):
        print("\n開始執行測試用例2")
        assert 2 + 8 == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

PASSED               [ 33%]
開始執行測試用例1
登入
PASSED               [ 66%]
開始執行測試用例2
退出登入
PASSED               [100%]
開始執行測試用例3

fixture 作用範圍：Scope

fixture 作用範圍可以為module、class、session和function，預設作用域為function。

function：每一個函式或方法都會呼叫
class：每一個類呼叫一次
module：每一個.py檔案呼叫一次
session：是多個檔案呼叫一次

scope="function"

import pytest

@pytest.fixture(scope="function")
def login():
    print("登入...")

class Test_Demo():
    def test_case1(self, login):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self, login):
        print("\n開始執行測試用例2")
        assert 2 + 8 == 10

    def test_case3(self, login):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100

if __name__ == '__main__':
    pytest.main()

結果：

登入...
PASSED                      [ 33%]
開始執行測試用例1
登入...
PASSED                      [ 66%]
開始執行測試用例2
登入...
PASSED                      [100%]
開始執行測試用例3

scope="class"

一個class裡面多個用例都呼叫了此fixture，那麼只在class裡所有用例開始前執行一次

import pytest

@pytest.fixture(scope="class")
def login():
    print("登入...")

結果：

登入...
PASSED                      [ 33%]
開始執行測試用例1
PASSED                      [ 66%]
開始執行測試用例2
PASSED                      [100%]
開始執行測試用例3

fixture自動應用

autouse引數

autouse設定為True時，自動呼叫fixture功能。由於預設作用域為function，不指定scope則每個方法都會呼叫fixture方法。

import pytest

@pytest.fixture(autouse=True)
def login():
    print("登入...")

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self):
        print("\n開始執行測試用例2")
        assert 2 + 8 == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

登入...
PASSED                    [ 33%]
開始執行測試用例1
登入...
PASSED                    [ 66%]
開始執行測試用例2
登入...
PASSED                    [100%]
開始執行測試用例3

@pytest.mark.usefixtures()

在測試方法上加@pytest.mark.usefixtures()

import pytest

@pytest.fixture()
def login():
    print("登入...")

@pytest.mark.usefixtures("login")
class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 1 + 1 == 2

    def test_case2(self):
        print("\n開始執行測試用例2")
        assert 2 + 8 == 10

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

登入...
PASSED                [ 33%]
開始執行測試用例1
登入...
PASSED                [ 66%]
開始執行測試用例2
登入...
PASSED                [100%]
開始執行測試用例3

fixture函式引數化

如果多條用例都需要呼叫相同引數，可以將fixture函式引數化。fixture 函式將執行每個引數值，fixture通過固定引數request傳遞。

import pytest

@pytest.fixture(scope="module", params=[
    [1, 1, 2],
    [2, 8, 10],
    [99, 1, 100]
])
def data(request):
    yield request.param

class Test_Demo():
    def test_case1(self):
        print("\n開始執行測試用例1")
        assert 2 + 8 == 10

    def test_case2(self, data):
        print("\n開始執行測試用例2")
        assert data[0] + data[1] == data[2]

    def test_case3(self):
        print("\n開始執行測試用例3")
        assert 99 + 1 == 100


if __name__ == '__main__':
    pytest.main()

結果：

PASSED                     [ 20%]
開始執行測試用例1
PASSED              [ 40%]
開始執行測試用例2
PASSED              [ 60%]
開始執行測試用例2
PASSED              [ 80%]
開始執行測試用例2
PASSED                     [100%]
開始執行測試用例3

--THE END--

文章標題：Pytest測試框架（三）：pytest fixture 用法
本文作者：hiyo
本文連結：https://www.cnblogs.com/hiyong/p/14163280.html
歡迎關注公眾號:「測試開發小記」及時接收最新技術文章！

『德不孤』Pytest框架 — 13、Pytest中Fixture裝飾器（三）
2022-03-13
框架
python @pytest.fixture示例及用法
2024-03-18
Python
【pytest系列】- fixture測試夾具詳解
2021-05-08
Python測試框架pytest命令列引數用法
2020-09-11
Python框架命令列
pytest fixture 使用
2024-07-03
pytest 精通 fixture
2020-09-23
python測試框架-pytest
2022-01-18
Python框架
pytest介面測試之fixture傳引數request
2021-09-11
『德不孤』Pytest框架 — 12、Pytest中Fixture裝飾器（二）
2022-03-13
框架
『德不孤』Pytest框架 — 11、Pytest中Fixture裝飾器（一）
2022-03-12
框架
『德不孤』Pytest框架 — 9、Pytest測試報告
2022-03-10
框架測試報告
自動化測試 —— Pytest fixture及conftest詳解
2024-04-01
pytest(6)-Fixture(韌體)
2022-02-15
Pytest單元測試框架——Pytest+Allure+Jenkins的應用
2020-06-09
框架Jenkins
Pytest測試框架（一）：pytest安裝及用例執行
2021-01-01
框架
Python自動化測試框架-pytest
2024-06-15
Python框架
pytest封神之路第三步精通fixture
2020-09-18
這次，我掌握了 pytest 中 fixture 的使用及 pytest 執行測試的載入順序
2024-05-15
pytest(2)-pytest-html測試報告
2022-02-13
HTML測試報告
Python測試框架pytest入門基礎
2021-12-17
Python框架
Pytest學習（四） - fixture的使用
2020-10-24
pytest進階之fixture函式
2021-03-27
函式
pytest_BDD + allure 自動化測試框架
2021-12-12
框架
6.pytest 強大的 fixture (上)
2020-12-27
7.pytest 強大的 fixture (中)
2020-12-28
8.pytest 強大的 fixture (下)
2020-12-29
Python單元測試框架pytest常用測試報告型別
2021-02-04
Python框架測試報告型別
自動化測試中如何判斷測試是否透過？詳解 Pytest 測試框架的斷言用法
2020-05-11
框架
關於 pytest 外掛 pytest-rerunfailures 和 fixture 的相容性問題
2020-10-30
AI
『德不孤』Pytest框架 — 8、Pytest斷言
2022-02-27
框架
Pytest單元測試框架生成HTML測試報告及優化
2022-01-28
框架HTML測試報告優化
pytest 中，pytest.ini 檔案為什麼會對 fixture 產生影響
2020-11-11
python自動化測試框架pytest和unittest區別！！！
2019-08-11
Python框架
pytest+python3+requests+jenkins+git+allure介面測試框架
2021-01-02
PythonJenkinsGit框架
python 之 pytest框架
2024-08-16
Python框架
【pytest】fixture 與 setup, teardown 的優先順序
2024-07-29
pytest：通過scope控制fixture的作用範圍
2021-01-27
pytest-testreport測試報告
2024-07-30
測試報告