【pytest官方文檔】解讀fixtures - 2. fixtures的調用方式

【pytest官方文檔】解讀fixtures – 2. fixtures的調用方式

既然fixtures是給執行測試做準備工作的，那麼pytest如何知道哪些測試函數或者 fixtures要用到哪一個fixtures呢？
說白了，就是fixtures的調用。

一、測試函數聲明傳參請求fixture

測試函數通過將fixture聲明為參數來請求fixture。

def test_my_fruit_in_basket(my_fruit, fruit_basket):
    # 這是一個測試函數
    assert my_fruit in fruit_basket

參考上一章出現的示例，測試函數test_my_fruit_in_basket通過傳入my_fruit, fruit_basket來調用這2個fixture。

當pytest運行測試函數時，它會查看該測試函數中的參數，然後搜索與這些參數具有相同名稱的fixture。
一旦pytest找到這些對象，它就會運行這些fixture。

二、fixture中的返回值傳遞給測試函數

此外，如果fixture中還有返回的內容，pytest可以拿到，並將這些對象作為參數傳遞給測試函數。
舉個例子：

class Fruit:
    def __init__(self, name):
        self.name = name
        self.cubed = False

    def cube(self):
        self.cubed = True


class FruitSalad:
    def __init__(self, *fruit_bowl):
        self.fruit = fruit_bowl
        self._cube_fruit()

    def _cube_fruit(self):
        for fruit in self.fruit:
            fruit.cube()


# Arrange
@pytest.fixture
def fruit_bowl():
    return [Fruit("apple"), Fruit("banana")]


def test_fruit_salad(fruit_bowl):
    # Act
    # 這裡接收到fixture函數fruit_bowl的返回值，
    # 也就是[Fruit("apple"), Fruit("banana")]，並使用
    fruit_salad = FruitSalad(*fruit_bowl)

    # Assert
    # python內置函數all()，用於判斷給定的可迭代參數 iterable 中的所有元素是否都為 TRUE，
    # 如果是返回 True，否則返回 False
    assert all(fruit.cubed for fruit in fruit_salad.fruit)

ps：其實這裡可以寫幾行非常簡單的程式碼說明意思，不過突然覺得看點稍微繞的程式碼也沒啥壞處。

可能python不太熟悉的朋友會覺得官方示例比較晦澀，其實我們重點不是關注這個，而且弄明白這裡面的傳遞關係：

首先，測試函數test_fruit_salad 請求fruit_bowl（也就是 def test_fruit_salad(fruit_bowl):）
此時，pytest將會執行這個fixture函數fruit_bowl，並將返回的對象作為fruit_bowl參數傳遞給測試函數test_fruit_salad。

這就是當一個fixture被請求調用的時候，發生的事情。

如果上面的fixture函數做的事情換做我們自己手動來執行，應該是這樣的：

# 上面的2個類不變
...
def fruit_bowl():
    return [Fruit("apple"), Fruit("banana")]


def test_fruit_salad(fruit_bowl):
    # Act
    fruit_salad = FruitSalad(*fruit_bowl)

    # Assert
    assert all(fruit.cubed for fruit in fruit_salad.fruit)


# Arrange
bowl = fruit_bowl()
test_fruit_salad(fruit_bowl=bowl)

相信看到這裡，大家應該對fixture的調用過程已經了解。

如果覺得官方程式碼示例有些晦澀，那麼這裡再附上一個簡易版的：

import pytest


# Arrange
@pytest.fixture
def fruit_bowl():
    return ["蘋果", "香蕉"]


def test_fruit_salad(fruit_bowl):
    # Act
    fruit_salad = fruit_bowl[0] + fruit_bowl[1]

    # Assert
    assert fruit_salad == "蘋果香蕉"

接下來，繼續跟著官方文檔解讀fixture的特點：fixture調用別的fixture、fixture的復用性。

Tags: pytest學習筆記一個小小測試的成長日常