Pytest的Fixture使用
概述
Pytest中的Fixture可以使得测试代码高度复用,同时对资源进行安全的管理,以及在复杂的测试场景用进行灵活的组合。
概念
- Fixture:可重用的函数,用
@pytest.fixture
来进行装饰,用于为测试提供数据、环境或者服务 - 作用域:控制Fixture的生命周期,默认是
function
,可设置为class
、module
、session
、package
- 依赖注入:通过测试函数的参数列表,自动获取Fixture的实例,无需手动调用
一、基础用法
我们来创建一个demo
import pytest
import psycopg2#连接数据库
def create_db_connection():return psycopg2.connect(dbname="mydatabase",user="myuser",password="mypassword",host="localhost",port="5432")# 定义一个fixture,用于创建数据库连接
@pytest.fixture
def database_connection():conn = create_db_connection() # 初始化资源yield conn # 测试使用阶段conn.close() # 清理资源# 测试函数,使用fixture获取数据库连接
def test_query_data(database_connection): # 通过参数注入result = database_connection.execute("SELECT * FROM users")assert len(result) > 0
通过这个demo,实现了定义fixture来进行数据库连接并且进行关闭数据库的操作,在测试函数里,用参数注入来进行调用即可。在后面如果需要使用数据库,可以直接继续复用,同时保证了每次都关闭数据库的行为,来达到资源清理,防止下次访问时出错。
二、yield的作用
在上述的例子当中,出现了一个yield,这个yield是干什么的呢?它在里面充当了一个资源管理的角色,以下是它的一个 主要功能作用:
- 初始化:yield之前的代码用于创建测试需要的资源(数据库连接,文件,API等),上述代码中的连接数据库操作
- 资源提供:yield返回的值(上述demo中的conn),将资源传递给测试函数
- 清理:yield之后的代码用于资源清理(上述demo中的conn.close()),在测试函数使用完成后会执行该操作
通过yield,我们可以保证在测试无论是否成功的情况下,都会执行清理操作,在进行数据库操作或者文件处理时,可以让资源清理不占用,让后续的测试可以继续进行。
注意:一个Fixture只能有一个yield
三、Fixture的作用域
Fixture中的scope参数指定作用域,分别是:
1、 function
每个测试函数运行前初始化,结束后清理
适用场景:需要完全隔离的独立资源,如临时文件,数据库事务等
2、class
每个测试类中只初始化一次,类内所有方法共享同一实例,类里只初始化一次
适用场景:类内共享资源,如数据库连接,API客户端
3、module
每个测试模块(.py文件
)只初始化一次
适用场景:模块级的共享资源,如配置文件、全局缓存