如何在pytest中全局修补?

时间:2016-08-04 11:18:12

标签: python tdd pytest python-mock

我的代码使用了pytest。示例代码结构如下所示。整个代码库是python-2.7

core/__init__.py
core/utils.py

#feature

core/feature/__init__.py
core/feature/service.py

#tests
core/feature/tests/__init__.py
core/feature/tests/test1.py
core/feature/tests/test2.py
core/feature/tests/test3.py
core/feature/tests/test4.py
core/feature/tests/test10.py

service.py看起来像这样:

from modules import stuff
from core.utils import Utility


class FeatureManager:
    # lots of other methods
    def execute(self, *args, **kwargs):
        self._execute_step1(*args, **kwargs)
        # some more code
        self._execute_step2(*args, **kwargs)
        utility = Utility()
        utility.doThings(args[0], kwargs['variable'])

feature/tests/*中的所有测试最终都使用core.feature.service.FeatureManager.execute函数。但是,在运行测试时,我不需要运行utility.doThings()。我需要它在生产应用程序运行时发生,但我不希望它在测试运行时发生。

我可以在core/feature/tests/test1.py

中执行此类操作
from mock import patch

class Test1:
   def test_1():
       with patch('core.feature.service.Utility') as MockedUtils:
           exectute_test_case_1()

这样可行。但是我刚刚在代码库中添加了Utility,我有300多个测试用例。我不想进入每个测试用例并写下这个with语句。

我可以编写一个conftest.py来设置一个os级环境变量,core.feature.service.FeatureManager.execute可以决定不执行utility.doThings,但我不知道这是否是一个干净的解决方案这个问题。

如果有人可以帮助我完成整个会话的全局补丁,我将不胜感激。我想在整个会话期间对全局with块进行全局操作。这件事的任何文章都会很棒。

TLDR:如何在运行pytests时创建会话范围的补丁?

2 个答案:

答案 0 :(得分:9)

我添加了一个名为core/feature/conftest.py的文件,看起来像这样

import logging
import pytest


@pytest.fixture(scope="session", autouse=True)
def default_session_fixture(request):
    """
    :type request: _pytest.python.SubRequest
    :return:
    """
    log.info("Patching core.feature.service")
    patched = mock.patch('core.feature.service.Utility')
    patched.__enter__()

    def unpatch():
        patched.__exit__()
        log.info("Patching complete. Unpatching")

    request.addfinalizer(unpatch)

这并不复杂。这就像在做

with mock.patch('core.feature.service.Utility') as patched:
    do_things()

但仅限于会话范围。

答案 1 :(得分:3)

针对类似用例(4.5 年后)在 currently accepted answer 上构建,使用 unittest.mock 的 patchyield 也有效:

from typing import Iterator
from unittest.mock import patch

import pytest


@pytest.fixture(scope="session", autouse=True)
def default_session_fixture() -> Iterator[None]:
    log.info("Patching core.feature.service")
    with patch("core.feature.service.Utility"):
        yield
    log.info("Patching complete. Unpatching")

旁边

我没有使用 autouse=True,而是使用 @pytest.mark.usefixtures("default_session_fixture") 逐个测试地将其集成到我的单元测试中。


版本

Python==3.8.6
pytest==6.2.2