自动化测试 pytest 中 scope 限制 fixture使用范围！

news2024/9/20 0:03:30

导读

fixture 是 pytest 中一个非常重要的模块，可以让代码更加简洁。

fixture 的 autouse 为 True 可以自动化加载 fixture。

如果不想每条用例执行前都运行初始化方法(可能多个fixture)怎么办？可不可以只运行一次初始化方法？

答：可以使用 scope 。

举例

要先创建一个文件：conftest.py，编写代码：

import pytest

data = {}


@pytest.fixture(scope="session")
def add():
    """相加"""
    return 5 + 8


@pytest.fixture(scope="session")
def multiply():
    """相乘"""
    return 5 * 8


@pytest.fixture(scope="session", autouse=True)
def init_data():
    """初始化数据"""
    print(f"start init_data: {data}")
    data["a"] = 5
    data["b"] = 8
    data["c"] = 13
    data["d"] = 40
    data["e"] = 53
    data["f"] = 520


@pytest.fixture(scope="session", autouse=True)
def init_data2(add, multiply):
    """初始化数据"""
    print(f"start init_data2: {data}")
    data["e"] = add * multiply
    data["f"] = add + multiply

这里注意：init_data2 引用了 add 和 multiply 这两个fixture，所以这两个 fixture 都需要加上:

@pytest.fixture(scope="session")

如果不加上，就会报错：ScopeMismatch: You tried to access the function scoped fixture add with a session scoped request object。

这是因为 init_data2 的作用域是 session，而 add 和 multiply 的作用域是 function。所以要在同级上才能使用。

新建测试文件：test_fixtures_scope.py, 编写测试代码：

from conftest import data


def test_first_fixture():
    # Act
    print(f"a={data['a']}")
    print(f"b={data['b']}")
    print(f"a + b={data['c']}")
    print(f"a * b={data['d']}")

    # Assert
    assert data['c'] == data['a'] + data['b']


def test_second_fixture():
    print(f"add * multiply={data['e']}")
    print(f"add + multiply={data['f']}")

    # Assert
    assert data['e'] != data['f']

测试

正确使用：

$ pytest -sv test_fixtures_scope.py
================================== test session starts ===================================
platform darwin -- Python 3.12.0, pytest-8.2.2, pluggy-1.5.0 -- /Users/hope/PythonVirtualenv/pytest-sample/bin/python
cachedir: .pytest_cache
rootdir: /Users/hope/PycharmProjects/pytest-sample
collected 2 items

test_fixtures_scope.py::test_first_fixture start init_data: {}
start init_data2: {'a': 5, 'b': 8, 'c': 13, 'd': 40, 'e': 53, 'f': 520}
a=5
b=8
a + b=13
a * b=40
PASSED
test_fixtures_scope.py::test_second_fixture add * multiply=520
add + multiply=53
PASSED

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

可以看到这行日志只运行了一次：

start init_data: {}
start init_data2: {'a': 5, 'b': 8, 'c': 13, 'd': 40, 'e': 53, 'f': 520}

当两个fixture不在同一作用域：

$ pytest -sv test_fixtures_scope.py
================================== test session starts ===================================
platform darwin -- Python 3.12.0, pytest-8.2.2, pluggy-1.5.0 -- /Users/hope/PythonVirtualenv/pytest-sample/bin/python
cachedir: .pytest_cache
rootdir: /Users/hope/PycharmProjects/pytest-sample
collected 2 items

test_fixtures_scope.py::test_first_fixture ERROR
test_fixtures_scope.py::test_second_fixture ERROR

========================================= ERRORS =========================================
__________________________ ERROR at setup of test_first_fixture __________________________
ScopeMismatch: You tried to access the function scoped fixture add with a session scoped request object. Requesting fixture stack:
conftest.py:18:  def init_data(add, multiply)
Requested fixture:
conftest.py:6:  def add()
_________________________ ERROR at setup of test_second_fixture __________________________
ScopeMismatch: You tried to access the function scoped fixture add with a session scoped request object. Requesting fixture stack:
conftest.py:18:  def init_data(add, multiply)
Requested fixture:
conftest.py:6:  def add()
================================ short test summary info =================================
ERROR test_fixtures_scope.py::test_first_fixture - Failed: ScopeMismatch: You tried to access the function scoped fixture add with a ses...
ERROR test_fixtures_scope.py::test_second_fixture - Failed: ScopeMismatch: You tried to access the function scoped fixture add with a ses...
=================================== 2 errors in 0.02s ====================================