Pytest學習（四） - fixture的使用

久曲健發表於2020-10-24

前言

寫這篇文章，整體還是比較坎坷的，我發現有知識斷層，理解再整理寫出來，還真的有些難。

作為java黨硬磕Python，雖然對我而言是常事了（因為我比較愛折騰，哈哈），但這並不能影響我的熱情。

執念這東西，有時真的很強大，回想下，你有多久沒有特別想堅持學一樣技能或者看一本書了呢。

之前就有很多粉絲和我說，六哥pytest很簡單，都是入門的東西不愛看，網上有很多教程，能不能寫點乾貨呀，但我為什麼還是要堅持寫呢？

簡單呀，因為我想學，我之前都是拿來改改直接用，“哪裡不會點哪裡”，箇中細節處理不是很懂，想好好消化下，再整理寫出來。

fixture功能

  • 傳入測試中的資料集
  • 配置測試前系統的資料準備，即初始化資料
  • 為批量測試提供資料來源

fixture可以當做引數傳入

如何使用

在函式上加個裝飾器@pytest.fixture()，個人理解為，就是java的註解在方法上標記下，依賴注入就能用了。
fixture是有返回值，沒有返回值預設為None。用例呼叫fixture返回值時，把fixture的函式名當做變數用就可以了,示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 18:23
# @Author  : longrong.lang
# @FileName: test_fixture_AsParam.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
import pytest
@pytest.fixture()
def param():
    return "fixture當做引數"
def test_Asparam(param):
    print('param : '+param)

輸出結果:

多個fixture的使用

示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 18:43
# @Author  : longrong.lang
# @FileName: test_Multiplefixture.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
多個fixture使用情況
'''
import pytest
@pytest.fixture()
def username():
    return '軟體測試君'
@pytest.fixture()
def password():
    return '123456'
def test_login(username, password):
    print('\n輸入使用者名稱：'+username)
    print('輸入密碼：'+password)
    print('登入成功，傳入多個fixture引數成功')

輸出結果：

fixture的引數使用

示例程式碼如下：

@pytest.fixture(scope="function", params=None, autouse=False, ids=None, name=None)
def test():
    print("fixture初始化引數列表")

引數說明：

  • scope：即作用域，function"（預設），"class"，"module"，"session"四個
  • params：可選引數列表，它將導致多個引數呼叫fixture函式和所有測試使用它。
  • autouse：預設：False，需要用例手動呼叫該fixture；如果是True，所有作用域內的測試用例都會自動呼叫該fixture
  • ids：params測試ID的一部分。如果沒有將從params自動生成.
  • name：預設：裝飾器的名稱，同一模組的fixture相互呼叫建議寫個不同的name。
  • session的作用域：是整個測試會話，即開始執行pytest到結束測試

scope引數作用範圍

控制fixture的作用範圍：session>module>class>function

  • function：每一個函式或方法都會呼叫
  • class：每一個類呼叫一次，一個類中可以有多個方法
  • module：每一個.py檔案呼叫一次，該檔案內又有多個function和class
  • session：是多個檔案呼叫一次，可以跨.py檔案呼叫，每個.py檔案就是module

scope四個引數的範圍

1、scope="function

@pytest.fixture（）如果不寫引數，引數就是scope="function"，它的作用範圍是每個測試用例執行之前執行一次，銷燬程式碼在測試用例之後執行。在類中的呼叫也是一樣的。
示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:05
# @Author  : longrong.lang
# @FileName: test_fixture_scopeFunction.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
scope="function"示例
'''
import pytest
# 預設不填寫
@pytest.fixture()
def test1():
    print('\n預設不填寫引數')
# 寫入預設引數
@pytest.fixture(scope='function')
def test2():
    print('\n寫入預設引數function')
def test_defaultScope1(test1):
    print('test1被呼叫')
def test_defaultScope2(test2):
    print('test2被呼叫')
class Testclass(object):
    def test_defaultScope2(self, test2):
        print('\ntest2,被呼叫，無返回值時，預設為None')
        assert test2 == None
if __name__ == '__main__':
    pytest.main(["-q", "test_fixture_scopeFunction.py"])

輸出結果：

2、scope="class"

fixture為class級別的時候，如果一個class裡面有多個用例，都呼叫了此fixture，那麼此fixture只在此class裡所有用例開始前執行一次。
示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:15
# @Author  : longrong.lang
# @FileName: test_fixture_scopeClass.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
scope="class"示例
'''
import pytest
@pytest.fixture(scope='class')
def data():
    # 這是測試資料
    print('這是我的資料來源,優先準備著哈')
    return [1, 2, 3, 4, 5]
class TestClass(object):
    def test1(self, data):
        # self可以理解為它自己的，英譯漢我就是這麼學的哈哈
        print('\n輸出我的資料來源：' + str(data))
if __name__ == '__main__':
    pytest.main(["-q", "test_fixture_scopeClass.py"])

輸出結果：

3、scope="module"

fixture為module時，在當前.py指令碼里面所有用例開始前只執行一次。
示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:27
# @Author  : longrong.lang
# @FileName: test_scopeModule.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
fixture為module示例
'''
import pytest
@pytest.fixture(scope='module')
def data():
    return '\nscope為module'
def test1(data):
    print(data)
class TestClass(object):
    def text2(self, data):
        print('我在類中了哦，' + data)
if __name__ == '__main__':
    pytest.main(["-q", "test_scopeModule.py"])

輸出結果：

4、scope="session"

fixture為session，允許跨.py模組呼叫，通過conftest.py 共享fixture。
也就是當我們有多個.py檔案的用例的時候，如果多個用例只需呼叫一次fixture也是可以實現的。
必須以conftest.py命名，才會被pytest自動識別該檔案。放到專案的根目錄下就可以全域性呼叫了，如果放到某個package下，那就在該package內有效。
檔案目錄結構如下：

建立公共資料，命名為conftest.py，示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:37
# @Author  : longrong.lang
# @FileName: conftest.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
import pytest
@pytest.fixture(scope='session')
def commonData():
    str = ' 通過conftest.py 共享fixture'
    print('獲取到%s' % str)
    return str

建立測試指令碼test_scope1.py，示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:45
# @Author  : longrong.lang
# @FileName: test_scope1.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
import pytest
def testScope1(commonData):
    print(commonData)
    assert commonData == ' 通過conftest.py 共享fixture'
if __name__ == '__main__':
    pytest.main(["-q", "test_scope1.py"])

建立測試指令碼test_scope2.py，示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 19:45
# @Author  : longrong.lang
# @FileName: test_scope1.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
import pytest
def testScope2(commonData):
    print(commonData)
    assert commonData == ' 通過conftest.py 共享fixture'
if __name__ == '__main__':
    pytest.main(["-q", "test_scope2.py"])

然後同時執行兩個檔案，cmd到指令碼所在目錄，輸入命令

pytest -s test_scope2.py test_scope1.py

輸出結果：

知識點：

一個工程下可以有多個conftest.py的檔案，在工程根目錄下設定的conftest檔案起到全域性作用。在不同子目錄下也可以放conftest.py的檔案，作用範圍只能在改層級以及以下目錄生效，另conftest是不能跨模組呼叫的。

fixture的呼叫

  • 將fixture名作為測試用例函式的輸入引數
  • 測試用例加上裝飾器：@pytest.mark.usefixtures(fixture_name)
  • fixture設定autouse=True

示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 20:10
# @Author  : longrong.lang
# @FileName: test_fixtureCall.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
fixture呼叫示例
'''
import pytest
# 呼叫方式一
@pytest.fixture
def login1():
    print('第一種呼叫')
# 傳login
def test_case1(login1):
    print("\n測試用例1")
# 不傳login
def test_case2():
    print("\n測試用例2")
# 呼叫方式二
@pytest.fixture
def login2():
    print("第二種呼叫")
@pytest.mark.usefixtures("login2", "login1")
def test_case3():
    print("\n測試用例3")
# 呼叫方式三
@pytest.fixture(autouse=True)
def login3():
    print("\n第三種呼叫")
# 不是test開頭，加了裝飾器也不會執行fixture
@pytest.mark.usefixtures("login2")
def loginss():
    print(123)
if __name__ == '__main__':
    pytest.main(["-q", "test_fixtureCall.py"])

輸出結果：

小結：

  • 在類宣告上面加 @pytest.mark.usefixtures() ，代表這個類裡面所有測試用例都會呼叫該fixture
  • 可以疊加多個 @pytest.mark.usefixtures() ，先執行的放底層，後執行的放上層
  • 可以傳多個fixture引數，先執行的放前面，後執行的放後面
  • 如果fixture有返回值，用 @pytest.mark.usefixtures() 是無法獲取到返回值的，必須用傳參的方式（參考方式一）
  • 不是test開頭，加了裝飾器也不會執行fixture

fixture依賴其他fixture的呼叫

新增了 @pytest.fixture ，如果fixture還想依賴其他fixture，需要用函式傳參的方式，不能用 @pytest.mark.usefixtures() 的方式，否則會不生效

示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 20:23
# @Author  : longrong.lang
# @FileName: test_fixtureRelyCall.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang

'''
fixture依賴其他fixture的呼叫示例
'''
import pytest


@pytest.fixture(scope='session')
# 開啟瀏覽器
def openBrowser():
    print('\n開啟Chrome瀏覽器')


# @pytest.mark.usefixtures('openBrowser')這麼寫是不行的哦，肯定不好使
@pytest.fixture()
# 輸入賬號密碼
def loginAction(openBrowser):
    print('\n輸入賬號密碼')


#  登入過程
def test_login(loginAction):
    print('\n點選登入進入系統')


if __name__ == '__main__':
    pytest.main(["-q", "test_fixtureRelyCall.py"])

輸出結果：

fixture的params

@pytest.fixture有一個params引數，接受一個列表，列表中每個資料都可以作為用例的輸入。也就說有多少資料，就會形成多少用例，具體示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 20:30
# @Author  : longrong.lang
# @FileName: test_fixtureParams.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
fixture的params示例
'''
import pytest

seq=[1,2]


@pytest.fixture(params=seq)
def params(request):
    # request用來接收param列表資料
    return request.param



def test_params(params):
    print(params)
    assert 1 == params

輸出結果：

fixture之yield實現teardown

fixture裡面的teardown,可以用yield來喚醒teardown的執行，示例程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 20:44
# @Author  : longrong.lang
# @FileName: test_fixtrueYield.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
fixture之yield示例
'''

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

import pytest


@pytest.fixture(scope='module')
def open():
    print("開啟瀏覽器！！！")
    yield
    print('關閉瀏覽器！！！')


def test01():
    print("\n我是第一個用例")


def test02(open):
    print("\n我是第二個用例")


if __name__ == '__main__':
    pytest.main(["-q", "test_fixtrueYield.py"])

輸出結果：

yield遇到異常

還在剛才的程式碼中修改，將test01函式中新增異常，具體程式碼如下：

# -*- coding: utf-8 -*-
# @Time    : 2020/10/24 20:44
# @Author  : longrong.lang
# @FileName: test_fixtrueYield.py
# @Software: PyCharm
# @Cnblogs ：https://www.cnblogs.com/longronglang
'''
fixture之yield示例
'''

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

import pytest


@pytest.fixture(scope='module')
def open():
    print("開啟瀏覽器！！！")
    yield
    print('關閉瀏覽器！！！')


def test01():
    print("\n我是第一個用例")
    # 如果第一個用例異常了，不影響其他的用例執行
    raise Exception #此處異常


def test02(open):
    print("\n我是第二個用例")


if __name__ == '__main__':
    pytest.main(["-q", "test_fixtrueYield.py"])

輸出結果：

小結

  • 如果yield前面的程式碼，即setup部分已經丟擲異常了，則不會執行yield後面的teardown內容
  • 如果測試用例丟擲異常，yield後面的teardown內容還是會正常執行

addfinalizer終結函式(不太熟悉)

@pytest.fixture(scope="module")
def test_addfinalizer(request):
    # 前置操作setup
    print("==再次開啟瀏覽器==")
    test = "test_addfinalizer"

    def fin():
        # 後置操作teardown
        print("==再次關閉瀏覽器==")

    request.addfinalizer(fin)
    # 返回前置操作的變數
    return test


def test_anthor(test_addfinalizer):
    print("==最新用例==", test_addfinalizer)

小結：

  • 如果 request.addfinalizer() 前面的程式碼，即setup部分已經丟擲異常了，則不會執行 request.addfinalizer() 的teardown內容（和yield相似，應該是最近新版本改成一致了）
  • 可以宣告多個終結函式並呼叫

相關文章