6. pytest的fixture风格的前后置

前言

• pytest提供了更加灵活的前后置，通过@pytest.fixture(scope="")来定义不同范围的前后置

1. 如何声明和调用fixture

• 声明: 使用@pytest.fixture标识的函数即可作为fixture使用
• 调用: fixture和测试函数都可以调用，只要在函数的入参中直接使用fixture的函数名称即可
  • 代码示例中 outer调用了order和inner，就是fixture调用fixture的例子
  • 代码示例中 test_order调用了order和outer，就是测试函数调用fixture的例子
• 使用@pytest.mark.usefixtures("fixture_name") 装饰测试函数调用,需要注意的是该方法无法获取fixture的返回值

import pytest


@pytest.fixture
def order():
    return []


@pytest.fixture(autouse=True)
def outer(order, inner):
    order.append("outer")


class TestOne:
    @pytest.fixture
    def inner(self, order):
        order.append("one")

    def test_order(self, order, outer):
        assert order == ["one", "outer"]

• 熟悉代码的同学可能已经发现上述代码不对，outer定义的范围内inner未定义，理论上调用不同才对，但我们执行代码是正常。因为pytest的执行逻辑是以用例为中心的，顺序应该是先加载用例脚本内容，当加载到测试函数时，执行test_order，发现它需要order函数，于是去调order， 调用结束后调用outer, 而在test_order调用outer时，inner已经被加载了，所以outer可以顺利的调用到inner
• 看下执行结果

(venv) C:\测试文件夹\project\python\pytest_demo\fixture>pytest -sv test_fixture.py
======================================================= test session starts ========================================================
platform win32 -- Python 3.6.8, pytest-6.2.4, py-1.10.0, pluggy-0.13.1 -- c:\program files (x86)\python36-32\python.exe
cachedir: .pytest_cache
rootdir: C:\测试文件夹\project\python\pytest_demo, configfile: pytest.ini
collected 1 item                                                                                                                    

test_fixture.py::TestOne::test_order PASSED

======================================================== 1 passed in 0.01s =========================================================

2. 调用顺序

• fixture的调用顺序取决于3个因素
  • 范围：首先执行更高作用域的fixture，从大到小分别为: ["session", "package", "module", "class", "function"]
  • 依赖：当一个夹具请求另一个夹具时，首先执行另一个夹具。例如fixture_a请求fixture_b，fixture_b会先执行，因为a依赖于b它，没有它就不能运行。即使a不需要b的结果，它仍然需要先请求b
  • 自动使用：@pytest.fixture(autouse=True)时为自动使用，同一作用域(scope)内的自动使用的fixture优先使用。需要注意的是，如果fixture_a是自动使用且其依赖于不自动使用的fixture_b时，fixture_b也会变为自动使用，且其作为fixture_a的依赖会比fixture_a提前执行。这也是符合调用依赖的描述的

2.1 范围和依赖

• 先看范围的执行代码和依赖的执行顺序

# content of test_scope_dep.py
import pytest


@pytest.fixture(scope="session")
def order():
    return []


@pytest.fixture
def func(order):
    order.append("function")


@pytest.fixture(scope="class")
def cls(order):
    order.append("class")


@pytest.fixture(scope="module")
def mod(order):
    order.append("module")


@pytest.fixture(scope="package")
def pack(order):
    order.append("package")


@pytest.fixture(scope="session")
def sess(order):
    order.append("session")


class TestClass:
    def test_order(self, func, cls, mod, pack, sess, order):
        assert order == ["session", "package", "module", "class", "function"]

• 执行看结果, order和sess作用域都是session,但sess其依赖于order,故order先执行
• 其余的不同作用域的则按照顺序执行 session > package > module > class > function

(venv) C:\测试文件夹\project\python\pytest_demo\fixture>pytest -sv test_scope_dep.py
======================================================= test session starts ========================================================
platform win32 -- Python 3.6.8, pytest-6.2.4, py-1.10.0, pluggy-0.13.1 -- c:\program files (x86)\python36-32\python.exe
cachedir: .pytest_cache
rootdir: C:\测试文件夹\project\python\pytest_demo, configfile: pytest.ini
collected 1 item                                                                                                                    

test_scope_dep.py::TestClass::test_order PASSED

======================================================== 1 passed in 0.01s =========================================================

2.2. 自动使用

• 先看代码

@pytest.fixture
def order():
    return []


@pytest.fixture
def a(order):
    order.append("a")


@pytest.fixture
def b(a, order):
    order.append("b")


@pytest.fixture(autouse=True)
def c(order):
    order.append("c")


def test_order(b, order):
    assert order == ["c", "a", "b"]

• 执行看结果, 所有fixture的作用域都是function,

• 在测试时仅调用了b, 但因为c是自动使用，故c先执行

• c依赖于order, 所以是先调用了order再在列表中添加'c'

• 然后调用b, b依赖于a,故先执行a,并在列表中添加元素'a'

• 最后执行b,并在列表中添加'b'

• 执行顺序 order > c > a > b

• 注意事项

  • 尽管order是其他fixture的依赖项被调用过，但是测试函数中依然要主动调用，不然是无法获取其返回值的。如果order是无返回值的fixture，则无需调用

• 看到此处，大家可能发现fixture到目前为止也仅仅是描述了前置的信息，那么如何处理teardown呢

3. fixture声明后置 -- yield关键字

# content of test_fixture_teardown.py
import pytest


@pytest.fixture
def yield_teardown():
    print('\n################  setup part ##############')
    yield True
    print('\n############## teardown part ##############')


def test_yield(yield_teardown):
    print('the case use yield_teardown result is {}'.format(yield_teardown))

• 在yield关键字前的代码为前置，yield后的代码为后置
• 执行看下结果，确实按照预期打印
• 需要注意的是，这种fixture写法中如果不需要返回值时,yield关键字后为空即可,但一定要有该关键字

(venv) C:\测试文件夹\project\python\pytest_demo\fixture>pytest -sv test_fixture_teardown.py
======================================================= test session starts ========================================================
platform win32 -- Python 3.6.8, pytest-6.2.4, py-1.10.0, pluggy-0.13.1 -- c:\program files (x86)\python36-32\python.exe
cachedir: .pytest_cache
rootdir: C:\测试文件夹\project\python\pytest_demo, configfile: pytest.ini
collected 1 item                                                                                                                    

test_fixture_teardown.py::test_yield
################  setup part ##############
the case use yield_teardown result is True
PASSED
############## teardown part ##############


======================================================== 1 passed in 0.01s =========================================================

4. 参数化fixture

• 假设一种集群测试场景，有两台主机上需要执行同样的用例，那么如果在每个用例上都去写两个参数是不是很麻烦。可不可以在fixture上完成参数化，让同一条用例根据fixture上的参数化执行两次。即通过fixture的参数化实现所有用例的多主机测试。下面以多个测试邮箱连接为例：

• 在fixture函数装饰器中增加params参数用于实现参数化

• 在fixture函数的形参列表中增加request(固定参数，不可修改)，用于接收params传入的参数列表

• 在fixture函数的内部调用request.param即可获得列表中的元素

# content of test_fixture_para.py
import pytest
import smtplib


@pytest.fixture(scope="module", params=["smtp.163.com", "smtp.126.com"])
def smtp_connection(request):
    smtp_connection = smtplib.SMTP(request.param, 25, timeout=5)
    yield smtp_connection
    print("\n ############### finalizing {}".format(smtp_connection))
    smtp_connection.close()


def test_fixture_param(smtp_connection):
    print('smtp_connection is {}'.format(smtp_connection))

• 执行一下用例

(venv) C:\测试文件夹\project\python\pytest_demo\fixture>pytest -sv test_fixture_para.py
======================================================= test session starts ========================================================
platform win32 -- Python 3.6.8, pytest-6.2.4, py-1.10.0, pluggy-0.13.1 -- c:\program files (x86)\python36-32\python.exe
cachedir: .pytest_cache
rootdir: C:\测试文件夹\project\python\pytest_demo, configfile: pytest.ini
collected 2 items                                                                                                                   

test_fixture_para.py::test_fixture_param[smtp.163.com] smtp_connection is 
PASSED
test_fixture_para.py::test_fixture_param[smtp.126.com]
 ############### finalizing 
smtp_connection is 
PASSED
 ############### finalizing 


======================================================== 2 passed in 0.69s =========================================================

• 假想一种接口测试的情况，通常web系统都需要的登录后进行测试，那么一般登录就会放到前置中，但是每个测试者或者每个测试场景中用户名和密码可能都不相同，那么能不能把用户、密码作为参数传给前置函数，并返回认证所需数据呢，用户名和密码这种多个数据就需要使用dict去传参，上代码

@pytest.fixture(params=[{'user': 'user1', 'passwd': '1'}, {'user': 'user2', 'passwd': '2'}])
def login(request):
    user = request.param['user']
    passwd = request.param['passwd']
    token = user + passwd
    return token


def test_login(login):
    print('\nthe token is {}'.format(login))

5. conftest.py: 跨多个文件共享fixture

• 写到这里有人就会问，这种前置只是在当前文件生效，但登录明显是公共的前置，怎么让其共享呢，name就需要使用conftest.py文件定义fixture
• 该文件用作为整个目录提供fixture的一种方式。在某个目录的conftest.py文件中定义的fixture可以被该包中的任何测试用例直接使用而无需导入它们（pytest 将自动发现它们）
• 每个目录都可以有自己的conftest.py,其共享范围为本目录到其所有的递归子目录