Pytest（四）使用fixture

发表于 | 分类于

pytest的fixtures是使pytest在其他测试框架之上脱颖而出的独特核心功能之一，也是许多人使用pytest的原因。在pytest中，fixture指的是一种分离出“测试准备工作”和“测试结束收尾工作的代码的机制。

创建fixture

给函数增加一个@pytest.fixture()装饰器，pytest就会把该函数作为一个fixture。如果测试函数的形参中填写了fixture，pytest就会在测试函数运行之前调用这些fixtures。fixture可以用来执行通用的工作，也可以return数据给测试函数。

1
2
3
4
5
6
7
8
import pytest

@pytest.fixture()
def func():
    return 1

def test_func(func):
    assert func == 0

如上，test_func函数形参中传入了名为func的fixture。pytest会在module中查找名为func的函数。如果在module中找不到fixture，还会在conftest.py中寻找。

通过confest.py共享fixtures

我们可以把fixture放在独立的文件中。但是，想要让所有的测试函数都能使用conftest.py中的fixtures，则需要把文件放在所有测试函数文件的最上层目录。

尽管conftest.py是一个module，但是不要手动import它。它会被pytest自动识别并当作一个本地plugin。（关于插件的内容后面进一步学习）目前，只要把conftest.py想象成一个使得我们可以在目录下放置所有测试函数使用的fixture的地方即可。

用fixture实现setup和teardown功能

许多测试用例都有setup和teardown的部分，即测试环境准备和环境清理。通过在fixture中使用yield关键字，可以很方便的实现setup和teardown。

1
2
3
4
5
6
7
8
9
10
11
12
import pytest

@pytest.fixture()
def fixture_func():
    print("start")
    yield
    print("end")


def test_func(fixture_func):
    assert 1

yield前面的部分，是setup部分，会在测试函数前运行。yield后面的部分，是teardown部分，会在测试函数后运行。

使用–step-show跟踪fixture执行

在运行pytest时，添加--setup-show选项后，能够在输出中观看到fixture执行过程。

1
2
3
4
5
6
7
8
9
10
11
12
13
>pytest --setup-show test_fixture.py

=================================== test session starts ====================================
platform win32 -- Python 3.7.0, pytest-5.1.2, py-1.8.0, pluggy-0.13.0
rootdir: E:\pytestLearning\pytest-Learning
collected 1 item                                                                            

test_fixture.py
        SETUP    F fixture_func
        test_fixture.py::test_func (fixtures used: fixture_func).
        TEARDOWN F fixture_func

==================================== 1 passed in 0.04s =====================================

如上，显示了fixtures的调用过程。 SETUP和TAEADOWN调用了fixture_func。 S表示session域的fixture、M表示module域的fixture、F表示function域的fixture、C表示class`域的fixture。

使用fixture提供测试数据

fixture很适合用来提供测试数据。fixture可以return任何数据类型。测试函数使用fixture函数名就能使用return的数据。

1
2
3
4
5
6
7
8
9
import pytest

@pytest.fixture()
def func1():
    return 1

def test_func(func1):
    assert func1 == 1  # func1的值为1，断言通过

fixture的嵌套

fixture函数的入参也可以填写fixture`，这出现了嵌套调用fixture的情况。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import pytest

@pytest.fixture()
def func1():
    print("func1")

@pytest.fixture()  # func2:[func1]
def func2(func1):
    print("func2")
    return "func2"

@pytest.fixture()  # func3:[func2]
def func3(func2):
    print("func3")
    return "func3"

def test_func(func2, func3): # test_func:[func2,func3]
    assert func2 == "hello"

运行结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
>pytest --setup-show test_fixture.py

test_fixture.py::test_func
        SETUP    F func1
        SETUP    F func2 (fixtures used: func1)
        SETUP    F func3 (fixtures used: func2)
        test_fixture.py::test_func (fixtures used: func1, func2, func3)FAILED
        TEARDOWN F func3
        TEARDOWN F func2
        TEARDOWN F func1

========================================= FAILURES =========================================
________________________________________ test_func _________________________________________

func2 = 'func2', func3 = 'func3'

    def test_func(func2, func3):
>       assert func2 == "hello"
E       AssertionError: assert 'func2' == 'hello'
E         - func2
E         + hello

test_fixture.py:24: AssertionError

指定fixture的域

pytest.fixture()有个参数叫做scope，用来控制fixture的作用级别。scope可选值为：

  • function：作用于每个函数。setup部分在每个函数前运行，teardown部分在每个函数后运行。scope默认为function。
  • class：作用于每个类。无论类中有多少个函数声明了该fixture，只运行一次。
  • module：作用于每个模块。无论一个模块中有多少个函数或方法声明了该fixture，只运行一次。
  • session：作用一次会话（pytest任务）。在一次pytest任务中，该fixture只在启动和结束时运行一次。

通过pytest.mark.usefixtures指定fixtures

通过前文，我们了解到，要使用fixtures，可以把fixture函数名写到函数的入参中。不过，还有另一种方法可以使用fixture。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import pytest


@pytest.fixture()
def fix_func1():
    print("setup1")
    yield
    print("teardown1")


@pytest.fixture()
def fix_func2():
    print("setup2")
    yield
    print("teardown2")


@pytest.mark.usefixtures("fix_func1", "fix_func2")
class TestClass1():

    def test_func1(self):
        assert 1

    def test_func2(self):
        assert 1 == 1

使用@pytest.mark.usefixtures()装饰器也可以给函数指定fixture。注意，usefixtures()函数里面填的不是函数名，而是函数名字符串。使用usefixtures()和直接在形参中填写fixtures的方式没有区别。但是，使用usefixtures()方式，测试函数不能获取fixture函数的return值。

当我们要给一个测试class中的所有测试方法使用相同的fixture，且不需要fixture的return值的时候，可以用@pytest.mark.usefixtures()。

通过autouse参数让测试函数默认使用fixture

pytest.fixture()有个autouse参数。这个参数决定一个fixture是否是默认被使用的。设置autouse=True则fixture默认被所有测试函数使用。autouse默认值为False。

1
2
3
4
5
6
7
8
9
10
11
import pytest


@pytest.fixture(autouse=True)
def fix_func1():
    return 1


def test_func1():
    assert 1 == fix_func1  # fix_func1 == <function fix_func1 at 0x0000024E5272C378>

使用pytest –setup-show 查看函数执行，发现SETUP和TEARDOWN都有fix_func1，但是断言是失败的，因为fix_func1的值不是1，而是一个函数对象。可能这是因为没有在test_func1函数的形参里定义fix_func1。

重命名fixture

pytest.fixture()有个name参数，可以让我们重命名fixture。

1
2
3
4
5
6
7
8
9
10
11
import pytest


@pytest.fixture(name="new_fix_func")
def fix_func():
    return 1


def test_func(new_fix_func):
    assert new_fix_func == 1  # assert pass

参数化fixture

之前学习了使用@pytest.mark.parameterize(name,values,ids)对测试函数进行参数化。其实fixture也可以实现参数化，需要用到@pytest.fixture()函数中的params参数。params参数接收一个list,list中的一项就存放一组参数化数据。使用了这个fixture的测试函数会执行len(list)次。

在fixture函数中使用request这个内置fixture，可以获取params中的参数化数据。注意是request.param，这里的param没有s。

1
2
3
4
5
6
7
8
@pytest.fixture(params=[1,2,3])
def func4(request):
    return request.param


def test_func3(func4):
    assert 1 == func4

使用pytest -v 运行上面的代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
>pytest -v .\test_fixture.py::test_func3

======================================================================= test session starts =======================================================================
platform win32 -- Python 3.7.0, pytest-5.1.2, py-1.8.0, pluggy-0.13.0 -- d:\python\python.exe
cachedir: .pytest_cache
rootdir: E:\pytestLearning\pytest-Learning
collected 3 items                                                                                                                                                  

test_fixture.py::test_func3[1] PASSED                                                                                                                        [ 33%]
test_fixture.py::test_func3[2] FAILED                                                                                                                        [ 66%]
test_fixture.py::test_func3[3] FAILED                                                                                                                        [100%]

============================================================================ FAILURES =============================================================================
__________________________________________________________________________ test_func3[2] __________________________________________________________________________

func4 = 2

    def test_func3(func4):
>       assert 1 == func4
E       assert 1 == 2
E         -1
E         +2

test_fixture.py:39: AssertionError
__________________________________________________________________________ test_func3[3] __________________________________________________________________________

func4 = 3

    def test_func3(func4):
>       assert 1 == func4
E       assert 1 == 3
E         -1
E         +3

test_fixture.py:39: AssertionError
=================================================================== 2 failed, 1 passed in 0.04s ===================================================================

可以看到，执行了三次测试函数。

另外，@pytest.fixture()类似@pytest.mark.parameterize()也有一个ids参数。作用也是一样的，可以参考之前的文章。补充一点，ids可以接受一个字符串list，也可以接受一个函数名。这个函数是将每组参数化数据对象，转化为字符串的函数。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class A(object):
    """
    参数化数据类
    """

    def __init__(self, n1, n2, n3):
        self.n1 = n1
        self.n2 = n2
        self.n3 = n3


a_list = [A(1, 1, 1), A(2, 2, 2), A(3, 3, 3)]  # 保存参数化数据的列表


def a_to_str(a):
    """
    将A对象转化为字符串的函数
    """
    return "A({},{},{})".format(a.n1, a.n2, a.n3)


@pytest.fixture(name="fix", autouse=True, scope="function", params=a_list, ids=a_to_str)
def fix_func(request):
    """fixture函数,作用域为函数域，默认使用此fixture,重命名为fix,参数化3组对象，返回每一组参数化数据对象,自定义每组参数化数据的id"""
    return request.param


def test_func(fix):
    """
    测试用例函数
    """
    assert fix.n1 == 1 and fix.n2 == 1 and fix.n3 == 1

运行上面的代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
> pytest -v .\test_fixture_ids.py

======================================================================= test session starts =======================================================================
platform win32 -- Python 3.7.0, pytest-5.1.2, py-1.8.0, pluggy-0.13.0 -- d:\python\python.exe
cachedir: .pytest_cache
rootdir: E:\pytestLearning\pytest-Learning
collected 3 items                                                                                                                                                  

test_fixture_ids.py::test_func[A(1,1,1)] PASSED                                                                                                              [ 33%]
test_fixture_ids.py::test_func[A(2,2,2)] FAILED                                                                                                              [ 66%]
test_fixture_ids.py::test_func[A(3,3,3)] FAILED                                                                                                              [100%]

============================================================================ FAILURES =============================================================================
_______________________________________________________________________ test_func[A(2,2,2)] _______________________________________________________________________

fix = <test_fixture_ids.A object at 0x0000025EDF517400>

    def test_func(fix):
        """
        测试用例函数
        """
>       assert fix.n1 == 1 and fix.n2 == 1 and fix.n3 == 1
E       assert (2 == 1
E         -2
E         +1)

test_fixture_ids.py:38: AssertionError
_______________________________________________________________________ test_func[A(3,3,3)] _______________________________________________________________________

fix = <test_fixture_ids.A object at 0x0000025EDF58E828>

    def test_func(fix):
        """
        测试用例函数
        """
>       assert fix.n1 == 1 and fix.n2 == 1 and fix.n3 == 1
E       assert (3 == 1
E         -3
E         +1)

test_fixture_ids.py:38: AssertionError
=================================================================== 2 failed, 1 passed in 0.11s ===================================================================

至此，我们学习完了pytest.fixture()的所有参数（name,scope,autouse,params,ids）~

两种参数化功能可以同时使用，效果是叠加的，M*N次。