Python pytest 测试用例之 fixture

pytest 提供的 fixture 实现 unittest 中 setup/teardown 功能，可以在每次执行case之前初始化数据。

不同点是，fixture 可以只在执行某几个特定 case 前运行，只需要在运行 case 前调用即可。比 setup/teardown 使用起来更灵活。

1.fixture scope 作用范围

先看下 fixture 函数的定义：

def fixture(scope="function", params=None, autouse=False, ids=None, name=None):
    """
    :arg scope:    可选四组参数：function（默认）、calss、module、package/session

    :arg params:   一个可选的参数列表，它将导致多个参数调用fixture函数和所有测试使用它。

    :arg autouse:  如果为True，则fixture func将为所有测试激活可以看到它。如果为False(默认值)，则需要显式激活fixture。

    :arg ids:      每个参数对应的字符串id列表，因此它们是测试id的一部分。如果没有提供id，它们将从参数中自动生成。

    :arg name:     fixture的名称。 这默认为装饰函数的名称。 如果fixture在定义它的同一模块中使用，夹具的功能名称将被请求夹具的功能arg遮蔽; 解决这个问题的一种方法是将装饰函数命名 “fixture_ <fixturename>”然后使用”@ pytest.fixture（name ='<fixturename>'）”。
    """

重点说下 scope 四组参数的意义：

• function：每个方法（函数）都会执行一次。
• class：每个类都会执行一次。类中有多个方法调用，只在第一个方法调用时执行。
• module：一个 .py 文件执行一次。一个.py 文件可能包含多个类和方法。
• package/session：多个文件调用一次，可以跨 .py 文件。

在所需要调用的函数前面加个装饰器 @pytest.fixture()。举一个简单的例子：

# coding=utf-8
import pytest

@pytest.fixture(scope='function')
def login():
    print("登录")

def test_1():
    print('测试用例1')

def test_2(login):
    print('测试用例2')


if __name__ =="__main__":
    pytest.main(['test_sample.py','-s'])

执行结果：

test_sample.py 
测试用例1
.
登录
测试用例2
.

============================== 2 passed in 0.07s ==============================

2.yield

我们刚刚实现了在每个用例之前执行初始化操作，那么用例执行完之后如需要 清除数据（或还原）操作，可以使用 yield 来实现。

# coding=utf-8
import pytest

@pytest.fixture(scope='function')
def login():
    print("登录")
    yield
    print("注销登录")

def test_1():
    print('测试用例1')

def test_2(login):
    print('测试用例2')

if __name__ =="__main__":
    pytest.main(['test_sample.py','-s'])

执行结果：

test_sample.py 
测试用例1
.
登录
测试用例2
.注销登录

============================== 2 passed in 0.08s ==============================

3.conftest

上面的案例都是写在同一个.py 文件内的。倘若有多个.py 文件需要调用 login() 方法，就必须把 login() 方法写在外面，这里引用了conftest.py 配置文件。

test_xxx.py 测试文件中无需 import conftest，pytest 会自动搜索同级目录中的 conftest.py 文件。

conftest.py 与 测试文件 目录层级关系

test_*.py
conftest.py

示例

# 新建conftest.py，和 test_sample.py 同级目录
import pytest

@pytest.fixture(scope='function')
def login():
    print("登录")


# test_sample.py 代码如下
import pytest

def test_1():
    print('测试用例1')

def test_2(login):
    print('测试用例2')

if __name__ =="__main__":
    pytest.main(['test_sample.py','-s'])

执行结果：

test_sample.py 
测试用例1
.
登录
测试用例2
.

============================== 2 passed in 0.01s ==============================