首頁 > 軟體

Pytest框架之fixture詳解(一)

2022-06-30 14:02:54

相關文章

Pytest框架之fixture詳解(一)

Pytest框架之fixture詳解(二)

Pytest框架之fixture詳解(三)

我們在編寫測試用例,都會涉及到用例執行之前的環境準備工作,和用例執行之後的環境清理工作。

程式碼版的測試用例也不例外。在自動化測試框架當中,我們也需要編寫:

用例執行之前的環境準備工作程式碼(前置工作程式碼)

用例執行之後的環境清理工作(後置工作程式碼)

通常,在自動化測試框架當中,都叫做fixture。

pytest作為python語言的測試框架,它的fixture有2種實現方式。

  • 一種是xunit-style,跟unittest框架的機制非常相似,即setup/teardown系列
  • 一種是它自己的fixture機制,以@pytest.fixture裝飾器來申明。

pytest的fixture實現方式一:xunit-style

pytest的xunit-style有三個級別的fixture:測試模組、測試類、測試函數。

1、測試函數/方法級別:每一個測試函數都會執行的前置和後置。

測試類內部的測試方法:

  • 前置函數名稱:setup_method
  • 後置函數名稱:teardown_method

模組下的測試函數:

  • 前置函數名稱:setup_function
  • 後置函數名稱:teardown_function

2、測試類級別:一個測試類只執行一次前置和後置。

  • 前置函數名稱:setup_class
  • 後置函數名稱:teardown_class

注意:用@classmethod裝飾

3、測試模組級別:一個測試模組只執行一次前置和後置。

  • 前置函數名稱:setup_module
  • 後置函數名稱:teardown_module
from selenium import webdriver
from time import sleep
from random import randint
​
​
def setup_module():
    print("====  模組級的 setup 操作  ====")
​
​
def teardown_module():
    print("====  模組級的 teardown 操作  ====")
​
​
def test_random():
    assert randint(1, 5) == 3
​
​
class TestWeb:
​
    @classmethod
    def setup_class(cls):
        print("====  測試類級的 setup 操作  ====")
​
    @classmethod
    def teardown_class(cls):
        print("====  測試類級的 teardown 操作  ====")
​
    def setup_method(self):
        print("====  測試用例級的 setup 操作  ====")
        self.driver = webdriver.Chrome()
​
    def teardown_method(self):
        print("====  測試用例級的 teardown 操作  ====")
        self.driver.quit()
​
    def test_search(self):
        self.driver.get("https://www.baidu.com/")
        self.driver.find_element_by_id("kw").send_keys("檸檬班")
        self.driver.find_element_by_id("su").click()
        sleep(1)

pytest也支援執行unittest的測試用例。支援unittest以下特性:

  • @unittest.skip
  • setUp/tearDown;
  • setUpClass/tearDownClass;
  • setUpModule/tearDownModule;

pytest的fixture實現方式二:fixture機制

通過@pytest.fixture裝飾器來定義fixture。一個函數被@pytest.fixture裝飾,那麼這個函數就是fixture。

使用fixture時,分為二個部分:fixture定義、fixture呼叫。

除此之外,還有fixture的共用機制,巢狀呼叫機制。

1、定義fixture。

1)fixture通過函數實現。

2)使用@pytest.fixture進行裝飾

import pytest
​
@pytest.fixture
def init():
    pass

3)前置準備工作程式碼和後置清理工作程式碼,都寫在一個函數裡面。

4)通過yeild關鍵字,區分前置程式碼和後置程式碼 。yeild之前的程式碼為前置程式碼,yeild之後的程式碼為後置程式碼

在實際應用場景當中,可以只有前置準備工作程式碼,也可以只有後置清理工作程式碼。

import pytest
​
​
@pytest.fixture
def init():
    print("用例執行之前,執行的程式碼")  # 前置程式碼
    yield
    print("用例執行之後,執行的程式碼")  # 後置程式碼
  
​
@pytest.fixture
def init2():
    print("用例執行之前,執行的程式碼")  # 只有用例執行之前的前置準備程式碼
     
​
@pytest.fixture
def init3():
    yield
    print("用例執行之後,執行的程式碼")  # 只有用例執行之後的後置清理程式碼

5)fixture有4個作用域:測試對談(session)、測試模組(module)、測試類(class)、測試用例(function)

測試對談:pytest執行測試用例的整個過程,稱為對談。

比如pytest收集到了100條用例並執行完成,這個過程稱為測試對談。

設定fixture的作用域:通過@pytest.fixture(scope=作用域)來設定。預設情況下,scope=function

import pytest
​
​
# 沒有設定scope,預設為測試函數級別。即呼叫此fixture的測試類/模組/函數下,每個測試函數都會執行一次這個fixture
@pytest.fixture
def init():
    print("用例執行之前,執行的程式碼")  # 前置程式碼
    yield
    print("用例執行之後,執行的程式碼")  # 後置程式碼
​
​
# 設定scope為class。呼叫此fixture的測試類下,只執行一次這個fixture.
@pytest.fixture(scope="class")
def init2():
    print("用例執行之前,執行的程式碼")  # 只有用例執行之前的前置準備程式碼
​
​
# 設定scope為session。autouse表示自動使用。
# 那麼在pytest收集用例後,開始執行用例之前會自動化執行這個fixture當中的前置程式碼,
# 當所有用例執行完成之後,自動化執行這個fixture的後置程式碼。
@pytest.fixture(scope="session",autouse=True)
def init3():
    yield
    print("用例執行之後,執行的程式碼")  # 只有用例執行之後的後置清理代

6)fixture的返回值設定:yeild 返回值

當測試用例當中,要使用fixture裡生成的資料時,則需要fixture返回資料。

若有資料返回則:yeild 返回值

import pytest
from selenium import webdriver
from time import sleep
​
​
# 設定scope為class。呼叫此fixture的測試類下,只執行一次這個fixture.
@pytest.fixture(scope="class")
def init2():
    print("==== 測試類下,執行所有用例之前,執行的程式碼 ====")
    driver = webdriver.Chrome()
    yield driver   # 返回driver物件
    print("==== 測試類下,執行所有用例之後,執行的程式碼 ====")
    driver.quit()

2、呼叫fixture

在fixture定義好之後,可以明確:

  • 1)fixture處理了哪些前置準備工作、哪些後置清理工作
  • 2)fixture作用在哪個範圍(是測試函數?還是測試類?還是測試對談?還是測試模組?)

在以上2點都定下來了之後,接下來就是,在測試用例當中,根據需要呼叫不同的fixture。

呼叫方法有2種:

  • 1、在測試用例/測試類上面加上:@pytest.mark.usefixture("fixture的函數名字")
  • 2、將fixture函數名,作為測試用例函數的引數。

第2種用法,主要是用引數來接收fixture的返回值,以便在測試用例中使用。

第一種方式案例如下:

第二種方式案例如下:

3、conftest.py共用機制

在某些大的業務場景下,很多用例當中,會使用相同的前置準備工作,和後置清理工作。

如果在每個測試模組下,都把前置準備工作,和後置清理工作寫一遍,在維護上和優化上講不夠好。

pytest框架提供了一個fixture共用的機制 ,可以讓不同的用例模組,使用同一個fixture。這就是conftest.py檔案。

3.1 conftest.py共用實現

1)在專案根目錄下,建立一個conftest.py檔案。

2)檔名必須是conftest.py,大小寫敏感,不可改名字。

3)conftest.py當中,可以編寫多個fixture

4)在測試用例檔案當中,不需要引入conftest.py檔案。直接呼叫fixture的函數名,會自動去conftest.py當中查詢的。

3.2 conftest.py層級作用域

conftest.py在專案根目錄下,則專案下的所有測試用例,均可使用conftest.py中定義的fixture。即專案根目錄下的conftest.py,作用域是整個專案。

那,如果,conftest.py當中的fixture,只想在某個python包內可用呢?

conftest.py實現了層級作用域。

簡單來說就是:conftest.py 在哪個目錄下,此目錄下(包含子目錄)的所有用例可使用其中的fixture。

如下圖:

  • 根目錄下的conftest.py裡的fixture,無論專案下的哪個用例,都可以使用。
  • 子目錄moduleA下的conftest.py裡的fixture,只有moduleA下的用例可以使用。
  • 子目錄moduleB下的conftest.py裡的fixture,只有moduleB下的用例可以使用。

moduleB下的用例檔案test_module_b.py中的用例,即可以使用根目錄下的conftest.py中的fixuture,又可以使用自己目錄下的conftest.py的fixture:

那麼有個問題,如果出現了同名fixture怎麼辦呢?

這裡涉及到了,測試用例在執行時,呼叫fixture的順序。一般來講,按就近原則呼叫。

測試用例檔案中的fixture > 當前目錄中的fixture > 上級目錄中的fixture > 根目錄中的fixture

4、fixture巢狀

fixture不但支援共用 ,還支援巢狀使用。

巢狀使用即:一個fixture,可以做另外一個fixture的引數。

如下圖所示:名為init2的fixture,可以作為init的引數。

並且,init當中,將init2的返回值,同樣返回。

當在用例當中,呼叫init時,init會自動去呼叫init2。

下圖案例中,init2為class級作用域,init為function級作用域。

fixture的執行順序如下:

  • init2的後置程式碼
  • init的後置程式碼
  • init的前置程式碼
  • init2的前置程式碼

到此這篇關於Pytest框架之fixture的文章就介紹到這了。希望對大家的學習有所幫助,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com