发布于 由admin

Python高级技术之：`Python`的`fixture`：`pytest`的`fixture`在测试依赖注入中的应用。

各位观众老爷们，今天咱们来聊聊Python测试界的一大利器——pytest的fixture，这玩意儿啊，用好了能让你的测试代码优雅得像个诗人，用不好嘛…那就只能哭着加班了。

开场白：测试的烦恼

话说回来，写测试啊，有时候真的让人头大。尤其是当你的测试用例需要依赖一些共享的资源，比如数据库连接、配置文件、甚至是模拟的用户对象时，你会发现自己写了一堆重复的代码，而且维护起来简直就是噩梦。

举个例子，假设你要测试一个用户注册的功能，你可能需要在每个测试用例里都连接一次数据库，创建一些测试数据，然后再执行测试。这要是只有几个测试用例还好，要是几百个呢？你不得累死？

import sqlite3

def test_register_user_success():
    # 建立数据库连接
    conn = sqlite3.connect(':memory:')
    cursor = conn.cursor()

    # 创建 users 表
    cursor.execute('''
        CREATE TABLE users (
            id INTEGER PRIMARY KEY,
            username TEXT,
            email TEXT
        )
    ''')

    # 插入测试数据
    cursor.execute("INSERT INTO users (username, email) VALUES ('testuser', '[email protected]')")
    conn.commit()

    # 执行测试逻辑
    # ...

    # 清理数据库
    cursor.close()
    conn.close()

def test_register_user_duplicate_username():
    # 建立数据库连接
    conn = sqlite3.connect(':memory:')
    cursor = conn.cursor()

    # 创建 users 表
    cursor.execute('''
        CREATE TABLE users (
            id INTEGER PRIMARY KEY,
            username TEXT,
            email TEXT
        )
    ''')

    # 插入测试数据
    cursor.execute("INSERT INTO users (username, email) VALUES ('testuser', '[email protected]')")
    conn.commit()

    # 执行测试逻辑
    # ...

    # 清理数据库
    cursor.close()
    conn.close()

# ... 更多测试用例，重复的代码

看到没？每个测试用例都重复了建立数据库连接、创建表、插入数据的操作，简直是代码界的“复制粘贴大法”。这不仅让代码变得臃肿，而且一旦数据库连接方式发生变化，你得修改所有测试用例，想想都可怕。

救星登场：pytest的fixture

这个时候，pytest的fixture就像一位白马王子，骑着七彩祥云来拯救你了。它可以让你把这些共享的资源和操作封装起来，然后在测试用例里像“依赖注入”一样使用它们。

简单来说，fixture就是一个函数，它可以返回任何你想要的东西，比如数据库连接、配置文件、模拟对象等等。然后，你只需要在测试用例的参数列表中声明这个fixture的名字，pytest就会自动调用这个fixture函数，并将它的返回值传递给你的测试用例。

fixture的定义和使用

首先，你需要使用@pytest.fixture装饰器来定义一个fixture函数。

import pytest
import sqlite3

@pytest.fixture
def db_connection():
    # 建立数据库连接
    conn = sqlite3.connect(':memory:')
    cursor = conn.cursor()

    # 创建 users 表
    cursor.execute('''
        CREATE TABLE users (
            id INTEGER PRIMARY KEY,
            username TEXT,
            email TEXT
        )
    ''')

    # 插入测试数据
    cursor.execute("INSERT INTO users (username, email) VALUES ('testuser', '[email protected]')")
    conn.commit()

    # 返回数据库连接对象
    yield conn  # 使用 yield 关键字，让fixture在测试结束后进行清理

    # 清理数据库
    cursor.close()
    conn.close()

在这个例子中，我们定义了一个名为db_connection的fixture函数，它负责建立数据库连接、创建users表、并插入一些测试数据。注意，这里我们使用了yield关键字，这表示这个fixture函数会在测试用例执行之前执行一部分代码（建立连接、创建表、插入数据），然后在测试用例执行之后执行另一部分代码（清理数据库）。

接下来，你就可以在测试用例中使用这个fixture了。

def test_register_user_success(db_connection):
    # 使用 db_connection fixture 提供的数据库连接
    cursor = db_connection.cursor()

    # 执行测试逻辑
    # ...

    # 不需要手动清理数据库，db_connection fixture 会自动清理

看到没？在test_register_user_success函数的参数列表中，我们声明了db_connection这个参数，pytest会自动调用db_connection这个fixture函数，并将它的返回值（数据库连接对象）传递给test_register_user_success函数。这样，你就可以直接使用db_connection提供的数据库连接了，而不需要在每个测试用例里都重复写那些建立连接、创建表、插入数据的代码了。

fixture的作用域（Scope）

fixture还有一个很重要的概念，就是作用域（Scope）。作用域决定了fixture函数何时被调用，以及它的返回值在哪些测试用例中共享。

pytest提供了以下几种作用域：

  • function（默认）： 每个测试用例都会调用一次fixture函数。
  • class： 每个测试类只会调用一次fixture函数，同一个测试类中的所有测试用例共享同一个fixture的返回值。
  • module： 每个模块只会调用一次fixture函数，同一个模块中的所有测试用例共享同一个fixture的返回值。
  • package： 每个包只会调用一次fixture函数，同一个包中的所有测试用例共享同一个fixture的返回值。
  • session： 整个测试会话只会调用一次fixture函数，所有测试用例共享同一个fixture的返回值。

你可以通过scope参数来指定fixture的作用域。

@pytest.fixture(scope="module")
def config():
    # 读取配置文件
    config_data = {"api_url": "http://example.com/api"}
    return config_data

在这个例子中，我们定义了一个名为config的fixture函数，它的作用域是module，这意味着每个模块只会调用一次config函数，同一个模块中的所有测试用例共享同一个config的返回值（配置文件数据）。

fixture的参数化（Parametrization）

有时候，你可能需要对同一个测试用例使用不同的fixture返回值进行测试。这个时候，你就可以使用fixture的参数化功能。

你可以通过params参数来指定fixture的参数列表。

import pytest

@pytest.fixture(params=[1, 2, 3])
def number(request):
    return request.param

def test_number(number):
    assert number > 0

在这个例子中，我们定义了一个名为number的fixture函数，它的参数列表是[1, 2, 3]。pytest会自动对test_number函数进行三次测试，每次测试都会使用不同的number值（1、2、3）。

fixture的自动使用（Autouse）

有时候，你可能希望某个fixture函数在所有测试用例中自动被调用，而不需要在每个测试用例的参数列表中都声明它。这个时候，你就可以使用fixture的自动使用功能。

你可以通过autouse参数来指定fixture是否自动使用。

import pytest

@pytest.fixture(autouse=True)
def setup():
    # 在所有测试用例执行之前执行一些操作
    print("Setting up...")

在这个例子中，我们定义了一个名为setup的fixture函数，它的autouse参数被设置为True，这意味着setup函数会在所有测试用例执行之前自动被调用。

fixture的依赖（Dependency）

fixture之间也可以相互依赖。你只需要在一个fixture函数的参数列表中声明另一个fixture的名字，pytest就会自动调用被依赖的fixture函数，并将它的返回值传递给当前的fixture函数。

import pytest

@pytest.fixture
def user_data():
    return {"username": "testuser", "email": "[email protected]"}

@pytest.fixture
def create_user(user_data, db_connection):
    # 使用 user_data 和 db_connection fixture
    cursor = db_connection.cursor()
    cursor.execute("INSERT INTO users (username, email) VALUES (?, ?)", (user_data["username"], user_data["email"]))
    db_connection.commit()
    return user_data["username"]

在这个例子中，create_user这个fixture函数依赖于user_data和db_connection这两个fixture函数。pytest会自动调用user_data和db_connection函数，并将它们的返回值传递给create_user函数。

fixture的清理（Teardown）

就像前面db_connection例子中使用的yield一样，fixture可以进行资源清理。 尤其是在需要释放资源（例如关闭文件、断开数据库连接）时非常有用。除了使用yield，还可以使用request.addfinalizer方法。

import pytest

@pytest.fixture
def temp_file(request):
    # 创建临时文件
    file = open("temp.txt", "w")
    file.write("This is a temporary file.")
    file.close()

    def fin():
        # 清理临时文件
        import os
        os.remove("temp.txt")
        print ("n[teardown] removing temp file")
    request.addfinalizer(fin)  # 注册清理函数

    return "temp.txt"

def test_temp_file(temp_file):
    # 使用临时文件
    with open(temp_file, "r") as f:
        content = f.read()
    assert content == "This is a temporary file."

fixture的命名

fixture的命名应该具有描述性，能够清晰地表达fixture的作用。通常使用小写字母，并用下划线分隔单词。 例如：db_connection，user_data，config等。 避免使用过于笼统的名称，例如data，setup等。

fixture的优势总结

  • 代码重用： 将共享的资源和操作封装成fixture，避免代码重复。
  • 可维护性： 一旦fixture的实现发生变化，只需要修改fixture函数，而不需要修改所有测试用例。
  • 可读性： 测试用例更加简洁明了，更容易理解。
  • 依赖注入： 方便地将测试用例依赖的资源注入到测试用例中。
  • 灵活性： 可以通过作用域、参数化、自动使用等功能来灵活地控制fixture的行为。

fixture使用的最佳实践

  1. 保持fixture的职责单一： 一个fixture只负责提供一个特定的资源或执行一个特定的操作。
  2. 使用合适的作用域： 根据实际需求选择合适的作用域，避免不必要的资源创建和销毁。
  3. 使用参数化来测试不同的场景： 使用参数化来对同一个测试用例使用不同的fixture返回值进行测试。
  4. 合理使用自动使用功能： 只在必要的时候才使用自动使用功能，避免对所有测试用例都产生影响。
  5. 注意fixture之间的依赖关系： 避免循环依赖，确保fixture之间的依赖关系清晰明了。
  6. 编写清晰的清理代码： 确保fixture能够正确地清理资源，避免资源泄露。
  7. 使用描述性的名称： 确保fixture的名称能够清晰地表达fixture的作用。
  8. 将fixture放在conftest.py文件中： 将常用的fixture放在conftest.py文件中，使其在所有测试文件中都可用。

conftest.py的妙用

conftest.py是一个特殊的文件，pytest会自动识别它，并将其中定义的fixture函数在所有测试文件中都可用。这使得你可以在一个地方定义全局的fixture，而不需要在每个测试文件中都重复定义它们。

例如，你可以在conftest.py文件中定义一个数据库连接的fixture，然后在所有测试文件中都使用它。

# conftest.py
import pytest
import sqlite3

@pytest.fixture(scope="session")
def db_connection():
    # 建立数据库连接
    conn = sqlite3.connect(':memory:')
    cursor = conn.cursor()

    # 创建 users 表
    cursor.execute('''
        CREATE TABLE users (
            id INTEGER PRIMARY KEY,
            username TEXT,
            email TEXT
        )
    ''')
    yield conn
    cursor.close()
    conn.close()

然后，你就可以在任何测试文件中使用db_connection这个fixture了，而不需要在每个测试文件中都导入它。

# test_user.py
def test_register_user_success(db_connection):
    # 使用 db_connection fixture 提供的数据库连接
    cursor = db_connection.cursor()

    # 执行测试逻辑
    # ...

总结：fixture是pytest的灵魂

总而言之，pytest的fixture是测试依赖注入的利器，它可以帮助你编写更加优雅、可维护、可读性强的测试代码。 掌握fixture的使用方法，是成为pytest大师的必经之路。

希望今天的讲座能够帮助你更好地理解和使用pytest的fixture，让你的测试代码飞起来！ 各位，下课！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注