是否可以防止模块/全局类变量为单元测试创​​建实例？

Question

我需要为模块编写测试用例

to_be_tested.py

from module_x import X

_x = X() # creating X instance in test environment will raise error

#.....

在测试用例中，

from unittest import TestCase, mock

class Test1(TestCase):

    @mock.patch('...to_be_tested._x')
    @mock.patch('...to_be_tested.X.func1')
    def test_1(self, mock_func1, mock_x):
        ...

但是，这不会阻止import 创建实例。这是一种解决方法并为模块编写测试用例吗？或者它是一种将to_be_tested 重构为可测试的方法？

如果检测到测试环境，也许写to_be_tested.py，只写_x = None？

Answer 1

X 在全局级别的实例化似乎有问题，但我没有完整的情况，所以我不能明确地说“不要那样做”。如果您可以重构它，以便根据需要或类似的方式创建 X() 实例，那将是理想的。

也就是说，这是一种防止module_x 在测试期间被导入的方法。我的假设是 X() 在整个 module_x 模块中使用，因此该模块中实际上不需要任何东西，您只想模拟它。

import sys
import unittest

from unittest import TestCase, mock

class Test1(TestCase):

    @classmethod
    def setUpClass(cls):
        sys.modules['module_x'] = mock.Mock()

    @mock.patch('to_be_tested._x')
    @mock.patch('to_be_tested.X.func1')
    def test_1(self, mock_func1, mock_x):
        from to_be_tested import _x
        print(_x)

您可以看到 _x 现在是一个模拟，但请注意，您不能在测试之外进行导入（就像大多数导入一样，在测试模块的顶部），因为 sys.modules['module_x'] 没有'还没有被替换掉。

Answer 2

一种可能性是使用环境变量保护_x 的创建，以便您可以在测试模式下禁用其初始化。例如，

import os
from module import X

_x = None
if 'TEST' not in os.environ:
    _x = X()

现在，您只需确保在导入 to_be_tested 之前在您的环境中设置了 TEST。您可能会在测试运行程序中执行此操作，但也可以直接在您的测试模块中执行。

from unittest import TestCase, mock
import os


os.environ['TEST'] = ''

import to_be_tested

class Test1(TestCase):
    ...