網站首頁 編程語言 正文
前言
fixture是在測試函數運行前后，由pytest執行的外殼函數。fixture中的代碼可以定制，滿足多變的測試需求，包括定義傳入測試中的數據集、配置測試前系統的初始狀態、為批量測試提供數據源等等。fixture是pytest的精髓所在，類似unittest中setup/teardown，但是比它們要強大、靈活很多，它的優勢是可以跨文件共享。
一、Pytest fixture
1.pytest fixture幾個關鍵特性
- 有獨立的命名，并通過聲明它們從測試函數、模塊、類或整個項目中的使用來激活
- 按模塊化的方式實現，每個fixture都可以互相調用
- fixture可以實現unittest不能實現的功能，比如unittest中的測試用例和測試用例之間是無法傳遞參數和數據的，但是fixture卻可以解決這個問題
- fixture的范圍從簡單的單元擴展到復雜的功能測試，允許根據配置和組件選項對fixture和測試用例進行參數化
2.Pytest fixture定義
- 定義fixture跟定義普通函數差不多，唯一區別就是在函數上加個裝飾器@pytest.fixture()，fixture命名不要用test_開頭，跟用例區分開。用例才是test_開頭的命名；
- fixture裝飾器里的scope有四個級別的參數：function（不寫默認這個）、class、module、session；
- fixture可以有返回值，如果沒有return，默認會是None；用例調用fixture的返回值，就是直接把fixture的函數名稱作為參數傳入；
- fixture可以返回一個元組、列表或字典；
- 測試用例可傳單個、多個fixture參數；
- fixture與fixture間可相互調用；
3.Pytest fixture用法
1）用法一：作為參數使用
fixture的名字直接作為測試用例的參數，用例調用fixture的返回值，直接將fixture的函數名稱當做變量名稱；如果用例需要用到多個fixture的返回數據，fixture也可以返回一個元祖，list或字典，然后從里面取出對應數據。
① 將fixture函數作為參數傳遞給測試用例
@pytest.fixture()
def login():
print("this is login fixture")
user = "chen"
pwd = 123456
return user, pwd
def test_login(login):
"""將fixture修飾的login函數作為參數傳遞給本用例"""
print(login)
assert login[0] == "chen"
assert login[1] == 123456
assert "chen" in str(login)② 同一個用例中傳入多個fixture函數
@pytest.fixture()
def user():
user = "cris"
return user
@pytest.fixture()
def pwd():
pwd = "123456"
return pwd
def test_trans_fixture(user, pwd):
"""同一條用例中傳入多個fixture函數"""
print(user, pwd)
assert "cris" in str(user)
assert pwd == "123456"③ fixture函數之間的相互傳遞
@pytest.fixture()
def user2():
user = "cris"
return user
@pytest.fixture()
def login_info(user2):
"""fixture與fixture函數之間的相互傳遞"""
pwd = "e10adc3949ba59abbe56e057f20f883e"
return user2, pwd
def test_assert_login_info(login_info):
print(login_info)
print(type(login_info))
assert login_info[0] == "cris"
assert login_info[1] == "e10adc3949ba59abbe56e057f20f883e"2）用法二：提供靈活的類似setup和teardown功能
Pytest的fixture另一個強大的功能就是在函數執行前后增加操作，類似setup和teardown操作，但是比setup和teardown的操作更加靈活；具體使用方式是同樣定義一個函數，然后用裝飾器標記為fixture，然后在此函數中使用一個yield語句，yield語句之前的就會在測試用例之前使用，yield之后的語句就會在測試用例執行完成之后再執行。
@pytest.fixture()
def run_function():
print("run before function...")
yield
print("run after function...")
def test_run_1(run_function):
print("case 1")
def test_run_2():
print("case 2")
def test_run_3(run_function):
print("case 3")運行結果如下：
常見的應用場景：@pytest.fixture可以用在selenium中測試用例執行前后打開、關閉瀏覽器的操作：
@pytest.fixture()
def fixture_driver():
driver = webdriver.Chrome()
yield driver
driver.quit()
def test_baidu(fixture_driver):
driver = fixture_driver
driver.get("http://www.baidu.com")
driver.find_element_by_id('kw').send_keys("python fixture")
driver.find_element_by_id('su').click()3）用法三：利用pytest.mark.usefixtures疊加調用多個fixture
如果一個方法或者一個class用例想要同時調用多個fixture，可以使用@pytest.mark.usefixtures()進行疊加。注意疊加順序，先執行的放底層，后執行的放上層。
需注意：
- ① 與直接傳入fixture不同的是，@pytest.mark.usefixtures無法獲取到被fixture裝飾的函數的返回值；
- ② @pytest.mark.usefixtures的使用場景是：被測試函數需要多個fixture做前后置工作時使用；
@pytest.fixture
def func_1():
print("用例前置操作---1")
yield
print("用例后置操作---1")
@pytest.fixture
def func_2():
print("用例前置操作---2")
yield
print("用例后置操作---2")
@pytest.fixture
def func_3():
print("用例前置操作---3")
yield
print("用例后置操作---3")
@pytest.mark.usefixtures("func_3") # 最后執行func_3
@pytest.mark.usefixtures("func_2") # 再執行func_1
@pytest.mark.usefixtures("func_1") # 先執行func_1
def test_func():
print("這是測試用例")執行結果：
4）用法四：fixture自動使用autouse=True
當用例很多的時候，每次都傳這個參數，會很麻煩。fixture里面有個參數autouse，默認是False沒開啟的，可以設置為True開啟自動使用fixture功能，這樣用例就不用每次都去傳參了，autouse設置為True，自動調用fixture功能。所有用例都會生效，包括類中的測試用例和類以外的測試用例。
@pytest.fixture(autouse=True, scope="function")
def func_auto():
"""autouse為True時，會作用于每一條用例"""
print("\n---用例前置操作---")
yield
print("---用例后置操作---")
# func_auto函數的autouse=True時，無論是否使用usefixtures引用func_auto，都會執行func_auto
@pytest.mark.usefixtures("func_auto")
def test_01():
print("case 1")
def test_02():
print("case 2")
class Test:
def test_03(self):
print("case 3")執行結果：
4.Pytest fixture四種作用域
fixture(scope='function'，params=None，autouse=False，ids=None，name=None)fixture里面有個scope參數可以控制fixture的作用范圍：
- function：每一個函數或方法都會調用
- class：每一個類調用一次，一個類中可以有多個方法
- module：每一個.py文件調用一次，該文件內又有多個function和class
- session：多個文件調用一次，可以跨.py文件調用（通常這個級別會結合conftest.py文件使用）
1）function級別
function默認模式為@pytest.fixture() 函數級別，即scope="function"，scope可以不寫。每一個函數或方法都會調用，每個測試用例執行前都會執行一次function級別的fixture。
# @pytest.fixture(scope="function")等價于@pytest.fixture()
@pytest.fixture(scope="function")
def func_auto():
"""用例級別fixture，作用域單個用例"""
print("\n---function級別的用例前置操作---")
yield
print("---function級別的用例后置操作---")
# test_01會引用func_auto函數，test_02沒有用修飾器修飾，故不會引用
def test_func_auto_fixture_1(func_auto):
print("func 1 print")
def test_func_auto_fixture_2():
print("func 2 print")2）class級別
fixture的scope值還可以是class，此時則fixture定義的動作就會在測試類class的所有用例之前和之后運行，需注意：測試類中只要有一個測試用例的參數中使用了class級別的fixture，則在整個測試類的所有測試用例都會調用fixture函數
① 用例類中的測試用例調用fixture
執行fixture定義的動作，以及此測試類的所有用例結束后同樣要運行fixture指定的動作
@pytest.fixture(scope="class")
def class_auto():
"""類級別fixture，作用域整個類"""
print("\n---class級別的用例前置操作---")
yield
print("---class級別的用例后置操作---")
class TestClassAutoFixture:
# class級別的fixture任意一個用例引用即可
def test_class_auto_fixture_1(self, class_auto):
print("class 1 print")
def test_class_auto_fixture_2(self):
print("class 1 print")測試類中的第1條測試用例引用了fixture修飾的函數，則整個測試類的所有測試用例都會執行fixture函數的前置操作，在所有用例執行完成后，都會執行fixture函數的后置操作。
② 用例類外的測試用例調用fixture
如果在類外的函數中去使用class級別的fixture，則此時在測試類外每個測試用例中，fixture跟function級別的fixture作用是一致的，即在類外的函數中引用了class級別的fixture，則在此函數之前和之后同樣去執行fixture定義的對應的操作。
def test_class_auto_fixture(class_auto):
print("class 1 print")如下圖所示，測試類外的函數引用了class級別的fixture，則它的作用會等同于function級別的fixture，
運行結果如下：
3）module級別
在Python中module即.py文件，當fixture定義為module時，則此fixture將在當前文件中起作用。這里需要特別說明的是，當fixture的scope定義為module時，只要當前文件中有一個測試用例使用了fixture，不管這個用例是在類外，還是在類中，都會在當前文件（模塊）的所有測試用例執行之前去執行fixture定義的行為以及當前文件的所有用例結束之后同樣去執行fixture定義的對應操作。
@pytest.fixture(scope="module")
def module_auto():
"""作用于整個py文件"""
print("\n---module級別的用例前置操作---")
yield
print("---module級別的用例后置操作---")
# 測試類外和測試類內的函數方法都調用了module級別的fixture，但整個py文件只會生效一次fixture。
def test_module_scope_out_class(module_auto):
print("case scope 01")
class TestScope1:
def test_scope_01(self):
print("case scope 01")
def test_scope_02(self, module_auto):
print("case scope 02")
def test_scope_03(self):
print("case scope 03")若類中的方法分別調用了class級別的fixture和module級別的fixture，則會兩個fixture都生效：
# 順序在前面fixture會先執行
def test_scope_01(self, module_auto, class_auto):
print("case scope 01")若類中的方法同時調用了function級別、class級別、module級別的fixture，則3種fixture會同時生效：
# 順序在前面fixture會先執行
def test_scope_02(self, module_auto, class_auto, func_auto):
print("case scope 02")4）session級別(使用conftest.py共享fixture)
當fixture的scope定義為session時，是指在當前目錄下的所有用例之前和之后執行fixture對應的操作
fixture為session級別是可以跨.py模塊調用的，也就是當我們有多個.py文件的用例的時候，如果多個用例只需調用一次fixture，那就可以設置為scope="session"，并且寫到conftest.py文件里
使用方式：
- ① 定義測試用例文件
- ② 在指定目錄下創建conftest.py（固定命名，不可修改）文件，然后在conftest.py文件中定義fixture方法，將scope指定為session，此時在當前目錄下只要有一個用例使用了此fixture，則就會在當前目錄下所有用例之前和之后會執行fixture定義的對應的操作。
@pytest.fixture(scope="session", )
def session_auto():
"""session級別的fixture,針對該目錄下的所有用例都生效"""
print("\n---session級別的用例前置操作---")
yield
print("---session級別的用例后置操作---")定義了session級別的fixture，存放于該用例文件的同一個目錄下的conftest.py文件中，該目錄下的任一用例文件中的任一測試用例，引用了這個session級別的fixture，則這個session級別的fixture會針對這整個用例文件會生效。若存放在根目錄下，則針對整個工程的所有用例都會生效。
class TestSessionAutoFixture:
# session級別的fixture任意一個用例引用即可
def test_session_auto_fixture_1(self, session_auto):
print("session 1 print")
def test_session_auto_fixture_2(self):
print("session 1 print")
def test_session_auto_fixture():
print("session 1 print")運行結果如下：
5.Pytest fixture其他參數用法
1）ids參數-修改用例結果名稱
@pytest.mark.parametrize() 還提供了第三個 ids 參數來自定義顯示結果。
stars = ["劉德華", "張學友", "黎明", "郭富城"]
# 利用列表生成式生成一個用例名稱的列表
ids = [f"test-case-bsd5o550550j" for d in range(len(stars))]
@pytest.mark.parametrize("name", stars, ids=ids)
def test_multi_param(name):
print(f"my name is {name}")注：ids生成的用例名稱數量一定要和用例數量一致，否則會報錯，
執行結果如下：
2）name參數-重命名fixture函數名稱
@pytest.fixture(name="rename_get_user_info")
def get_user_info():
user_name = "周潤發"
print(user_name)
# 此處需傳入重命名后的fixture函數名
@pytest.mark.usefixtures("rename_get_user_info")
def test_parametrize_by_use_fixtures():
"""通過usefixtures裝飾器傳入fixture"""
print(f"test parametrize use fixtures")
def test_parametrize_by_fixture_name(rename_get_user_info):
"""將fixture函數名作為形參傳入"""
print(f"test parametrize use fixtures")3）params參數-提供返回值供測試函數調用
示例一
@pytest.fixture(params=[{"name": "周潤發"}, {"age": 61}, {"height": 183}])
def fix_func(request): # request為內建fixture
# 使用request.param作為返回值供測試函數調用，params的參數列表中包含了做少元素，該fixture就會被調用幾次，分別作用在每個測試函數上
return request.param # request.param為固定寫法
def test_fix_func(fix_func):
print(f"fixture函數fix_func的返回值為：{fix_func}")
"""打印結果如下：
fixture函數fix_func的返回值為：{'name': '周潤發'}
fixture函數fix_func的返回值為：{'age': 61}
fixture函數fix_func的返回值為：{'height': 183}
"""示例二：
params = [
{"case_id": 1, "case_title": "驗證正常添加車輛", "car_name": "蘇C99688", "car_type": 1, "origin": 1, "expected": "200"},
{"case_id": 2, "case_title": "驗證添加重復車輛", "car_name": "蘇C99688", "car_type": 1, "origin": 1, "expected": "500"},
{"case_id": 3, "case_title": "驗證車牌號為空", "car_name": "", "car_type": 2, "origin": 1, "expected": "500"}]
@pytest.fixture(params=params)
def add_car_params(request):
return request.param
def test_add_car(add_car_params):
print(f"{add_car_params['case_id']}-{add_car_params['case_title']}-{add_car_params['car_name']}")
"""
運行結果如下：
1-驗證正常添加車輛-蘇C99688
2-驗證添加重復車輛-蘇C99688
3-驗證車牌號為空-
"""6.內置fixture
1）tmpdir和tmpdir_factory
內置的tmpdir和tmpdir_factory負責在測試開始運行前創建臨時文件目錄，并在測試結束后刪除。如果測試代碼要對文件進行讀/寫操作，那么可以使用tmpdir或tmpdir_factory來創建文件或目錄。單個測試使用tmpdir，多個測試使用tmpdir_factory。tmpdir的作用范圍是函數級別，tmpdir_factory的作用范圍是會話級別。
def test_tmpdir(tmpdir):
# tmpdir already has a path name associated with it
# join() extends the path to include a filename
# the file is created when it's written to
a_file = tmpdir.join('something.txt')
# you can create directories
a_sub_dir = tmpdir.mkdir('anything')
# you can create files in directories (created when written)
another_file = a_sub_dir.join('something_else.txt')
# this write creates 'something.txt'
a_file.write('contents may settle during shipping')
# this write creates 'anything/something_else.txt'
another_file.write('something different')
# you can read the files as well
assert a_file.read() == 'contents may settle during shipping'
assert another_file.read() == 'something different'
def test_tmpdir_factory(tmpdir_factory):
# you should start with making a directory
# a_dir acts like the object returned from the tmpdir fixture
a_dir = tmpdir_factory.mktemp('mydir')
# base_temp will be the parent dir of 'mydir'
# you don't have to use getbasetemp()
# using it here just to show that it's available
base_temp = tmpdir_factory.getbasetemp()
print('base:', base_temp)
# the rest of this test looks the same as the 'test_tmpdir()'
# example except I'm using a_dir instead of tmpdir
a_file = a_dir.join('something.txt')
a_sub_dir = a_dir.mkdir('anything')
another_file = a_sub_dir.join('something_else.txt')
a_file.write('contents may settle during shipping')
another_file.write('something different')
assert a_file.read() == 'contents may settle during shipping'
assert another_file.read() == 'something different'2）pytestconfig
內置的pytestconfig可以通過命令行參數、選項、配置文件、插件、運行目錄等方式來控制pytest。pytestconfig是request.config的快捷方式，它在pytest文檔里有時候被稱為“pytest配置對象”。
要理解pytestconfig如何工作，可以添加一個自定義的命令行選項，然后在測試中讀取該選項。
def pytest_addoption(parser):
""""添加一個命令行選項"""
parser.addoption(
"--env", default="test", choices=["dev", "test", "pre"], help="enviroment parameter")以pytest_addoption添加的命令行選項必須通過插件來實現，或者在項目頂層目錄的conftest.py文件中完成。它所在的conftest.py不能處于測試子目錄下。
上述是一個傳入測試環境的命令行選項，接下來可以在測試用例中使用這些選項。
def test_option(pytestconfig):
print('the current environment is:', pytestconfig.getoption('env'))# 運行測試
pytest -s -q test_config.py::test_option由于前面的pytest_addoption中定義的env的默認參數是test，所以通過pytestconfig.getoption獲取到的env的值就是test：
3）其他內置fixture
- cache：作用是存儲一段測試會話的信息，在下一段測試會話中使用；
- capsys：capsys 有兩個功能：允許使用代碼讀取 stdout 和 stderr；可以臨時禁制抓取日志輸出；
- monkeypatch：可以在運行期間對類或模塊進行動態修改。在測試中，monkey patch 常用于替換被測試代碼的部分運行環境，或者將輸入依賴或輸出依賴替換成更容易測試的對象或函數；
- doctest_namespace：doctest 模塊是 Python 標準庫的一部分，借助它，可以在函數的文檔字符串中放入示例代碼，并通過測試確保有效。你可以使用 --doctest-modules 標識搜尋并運行 doctest 測試用例；
- recwarn：可以用來檢查待測代碼產生的警告信息；recwarn 的值就像是一個警告信息列表，列表里的每個警告信息都有4個屬性 category、message、filename、lineno。警告信息在測試開始后收集，如果你在意的警告信息出現在測試尾部，則可以在信息收集前使用 recwarn.clear() 清除不需要的內容。除了 recwarn，pytest 還可以使用 pytest.warns() 來檢查警告信息。
二、Pytest conftest全局作用文件詳解
Pytest支持在測試的目錄中，創建conftest.py文件，進行全局配置。
conftest.py文件須知：
- 可以跨.py文件調用，有多個.py文件調用時，可讓conftest.py只調用了一次fixture，或調用多次fixture；
- conftest.py與運行的用例要在同一個pakage下，并且有__init__.py文件；
- 不需要import導入conftest.py，pytest用例會自動識別該文件，放到項目的根目錄下就可以全局目錄調用了，如果放到某個package下，那就在package內有效，可有多個conftest.py；
- conftest.py配置腳本名稱是固定的，不能改名稱；
- conftest.py文件不能被其他文件導入；
- 所有同目錄測試文件運行前都會執行conftest.py文件；
原文鏈接：https://blog.51cto.com/u_12612738/5674831
相關推薦
- 2022-09-18 go?mock?server的簡易實現示例_Golang
- 2022-06-12 startup.bat啟動Tomcat閃退問題原因及解決_Tomcat
- 2023-07-15 es6中export和export default的區別
- 2022-08-02 C#定時器組件FluentScheduler用法_C#教程
- 2022-11-01 React?Hooks?useReducer?逃避deps組件渲染次數增加陷阱_React
- 2022-05-12 前端在線預覽 tiff 格式的圖片
- 2022-06-17 C#關鍵字之重寫override介紹_C#教程
- 2022-06-22 Git的撤銷、修改和回退命令_其它綜合
- 最近更新
-
- window11 系統安裝 yarn
- 超詳細win安裝深度學習環境2025年最新版（
- Linux 中運行的top命令 怎么退出？
- MySQL 中decimal 的用法？ 存儲小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎操作-- 運算符，流程控制 Flo
- 1. Int 和Integer 的區別，Jav
- spring @retryable不生效的一種
- Spring Security之認證信息的處理
- Spring Security之認證過濾器
- Spring Security概述快速入門
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權
- redisson分布式鎖中waittime的設
- maven:解決release錯誤：Artif
- restTemplate使用總結
- Spring Security之安全異常處理
- MybatisPlus優雅實現加密？
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務發現-Nac
- Spring Security之基于HttpR
- Redis 底層數據結構-簡單動態字符串（SD
- arthas操作spring被代理目標對象命令
- Spring中的單例模式應用詳解
- 聊聊消息隊列，發送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠程分支
提供CDN加速