在基于pytest框架编写Python测试脚本的过程中,很多场景需要重复执行相同的前置操作,比如初始化测试环境、创建数据库连接、准备测试账号等。如果每一个测试文件都单独编写这些逻辑,不仅会产生大量冗余代码,后续修改逻辑时还需要逐个文件调整,维护成本会不断升高。将通用fixture封装到公共模块,是解决这个问题的常用方案。
fixture的基础特性
fixture是pytest框架提供的核心功能之一,用于在测试执行前后完成固定的准备或清理操作。它的作用范围可以灵活控制,既可以在单个测试函数内生效,也可以在模块、会话级别生效。我们可以通过@pytest.fixture装饰器定义fixture,然后通过参数注入的方式在测试函数中使用。
基础的fixture定义示例如下:
import pytest
# 定义一个简单的fixture,返回测试用的用户名
@pytest.fixture
def get_test_username():
return "test_user_001"
# 测试函数通过参数注入使用fixture
def test_username(get_test_username):
assert get_test_username == "test_user_001"
封装通用fixture到公共模块的步骤
第一步:创建公共模块存放通用fixture
首先在项目的测试目录下创建一个公共模块文件,比如命名为common_fixtures.py,所有通用的fixture都放在这个文件中。例如我们需要一个初始化数据库连接的通用fixture,以及准备测试用户数据的fixture,都可以放在这个文件里。
公共模块common_fixtures.py的示例内容如下:
import pytest
import pymysql
# 会话级别的fixture,整个测试会话只执行一次数据库连接初始化
@pytest.fixture(scope="session")
def init_db_connection():
# 建立数据库连接,实际使用时替换为真实的数据库配置
conn = pymysql.connect(
host="127.0.0.1",
port=3306,
user="test_user",
password="test_password",
database="test_db"
)
yield conn
# 测试结束后关闭连接
conn.close()
# 模块级别的fixture,每个测试模块执行一次,返回测试用户数据
@pytest.fixture(scope="module")
def get_test_user_data():
return {
"user_id": 1001,
"username": "common_test_user",
"email": "test@ipipp.com"
}
第二步:配置pytest识别公共模块
要让pytest能够自动识别公共模块里的fixture,需要在项目的测试根目录下创建conftest.py文件,在文件中导入公共模块的fixture。conftest.py是pytest的配置文件,放在测试目录下会被自动加载,不需要额外导入。
conftest.py的内容如下:
import pytest from .common_fixtures import init_db_connection, get_test_user_data # 将公共模块的fixture注册到pytest中,方便其他测试文件调用 pytest.register_fixture(init_db_connection) pytest.register_fixture(get_test_user_data)
第三步:在测试文件中调用通用fixture
完成上述配置后,所有测试文件都可以直接通过参数注入的方式使用公共模块的fixture,不需要再单独定义。比如我们有一个测试用户相关功能的文件test_user.py,可以这样使用:
# 测试用户查询功能的脚本
def test_query_user(init_db_connection, get_test_user_data):
# 使用公共fixture提供的数据库连接
cursor = init_db_connection.cursor()
# 使用公共fixture提供的测试用户数据
user_id = get_test_user_data.get("user_id")
cursor.execute("SELECT username FROM user WHERE id = %s", (user_id,))
result = cursor.fetchone()
assert result is not None
cursor.close()
# 测试用户更新功能的脚本
def test_update_user(init_db_connection, get_test_user_data):
cursor = init_db_connection.cursor()
user_id = get_test_user_data.get("user_id")
new_name = "updated_test_user"
cursor.execute("UPDATE user SET username = %s WHERE id = %s", (new_name, user_id))
init_db_connection.commit()
cursor.execute("SELECT username FROM user WHERE id = %s", (user_id,))
result = cursor.fetchone()
assert result[0] == new_name
cursor.close()
封装时的注意事项
- 合理设置fixture的scope参数,会话级别适合数据库连接、浏览器驱动等资源初始化,函数级别适合每次测试都需要重新生成的临时数据。
- 如果fixture需要接收参数,可以通过
params参数设置参数列表,pytest会自动为每一个参数执行一次测试。 - 公共模块里的fixture命名要清晰,避免和其他测试文件的局部fixture重名,重名时局部fixture会优先被调用。
- fixture中如果有清理操作,要放在
yield之后,确保无论测试是否通过,清理逻辑都会执行。
优势总结
将通用fixture封装到公共模块后,测试脚本的冗余代码会减少百分之七十以上,后续如果数据库配置或者测试用户数据需要修改,只需要调整公共模块的内容,所有引用该fixture的测试脚本都会自动生效,大幅降低了维护成本。同时不同测试人员编写脚本时可以直接复用已有的fixture,也能提升团队的整体测试开发效率。