pytest官方文档fixtures调用

把苹果咬哭的测试笔记 2022-06-05 我要评论

pytest官方文档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的复用性。

pytest官方文档fixtures调用