多次调用方法的 Python Mock 对象

Question

我正在测试一个类，它具有另一个类的依赖项（该类的实例被传递给 CUT 的 init 方法）。我想使用 Python Mock 库来模拟这个类。

我所拥有的是这样的：

mockobj = Mock(spec=MyDependencyClass)
mockobj.methodfromdepclass.return_value = "the value I want the mock to return"
assertTrue(mockobj.methodfromdepclass(42), "the value I want the mock to return")

cutobj = ClassUnderTest(mockobj)

这很好，但是“methodfromdepclass”是一个参数化方法，因此我想创建一个模拟对象，其中根据传递给 methodfromdepclass 的参数，它返回不同的值。

我想要这种参数化行为的原因是我想创建包含不同值的 ClassUnderTest 的多个实例（这些值是由从模拟对象返回的值生成的）。

有点像我在想的（这当然行不通）：

mockobj = Mock(spec=MyDependencyClass)
mockobj.methodfromdepclass.ifcalledwith(42).return_value = "you called me with arg 42"
mockobj.methodfromdepclass.ifcalledwith(99).return_value = "you called me with arg 99"

assertTrue(mockobj.methodfromdepclass(42), "you called me with arg 42")
assertTrue(mockobj.methodfromdepclass(99), "you called me with arg 99")

cutinst1 = ClassUnderTest(mockobj, 42)
cutinst2 = ClassUnderTest(mockobj, 99)

# now cutinst1 & cutinst2 contain different values

我如何实现这种“ifcalledwith”类型的语义？

Answer 1

尝试副作用

def my_side_effect(*args, **kwargs):
    if args[0] == 42:
        return "Called with 42"
    elif args[0] == 43:
        return "Called with 43"
    elif kwargs['foo'] == 7:
        return "Foo is seven"

mockobj.mockmethod.side_effect = my_side_effect

Answer 2

更甜蜜一点：

mockobj.method.side_effect = lambda x: {123: 100, 234: 10000}[x]

或对于多个参数：

mockobj.method.side_effect = lambda *x: {(123, 234): 100, (234, 345): 10000}[x]

或使用默认值：

mockobj.method.side_effect = lambda x: {123: 100, 234: 10000}.get(x, 20000)

或两者的组合：

mockobj.method.side_effect = lambda *x: {(123, 234): 100, (234, 345): 10000}.get(x, 20000)

我们愉快地前进。

Answer 3

我在进行自己的测试时遇到了这个问题。如果您不关心捕获对 methodfromdepclass() 的调用，而只是需要它返回某些内容，那么以下内容可能就足够了：

def makeFakeMethod(mapping={}):
    def fakeMethod(inputParam):
        return mapping[inputParam] if inputParam in mapping else MagicMock()
    return fakeMethod

mapping = {42:"Called with 42", 59:"Called with 59"}
mockobj.methodfromdepclass = makeFakeMethod(mapping)

这是一个参数化版本：

def makeFakeMethod():
    def fakeMethod(param):
        return "Called with " + str(param)
    return fakeMethod

Answer 4

如此处所示，除了在 unittest.mock.Mock 你也可以使用 @mock.patch.object 和 new_callable，它允许您使用模拟对象修补对象的属性。

假设一个模块 my_module.py 使用 pandas 从数据库中读取数据，我们想通过模拟 pd.read_sql_table 方法来测试这个模块（它以 table_name 作为参数）。

您可以做的是（在您的测试中）创建一个 db_mock 方法，该方法根据提供的参数返回不同的对象：

def db_mock(**kwargs):
    if kwargs['table_name'] == 'table_1':
        # return some DataFrame
    elif kwargs['table_name'] == 'table_2':
        # return some other DataFrame

然后在您的测试函数中执行以下操作：

import my_module as my_module_imported

@mock.patch.object(my_module_imported.pd, "read_sql_table", new_callable=lambda: db_mock)
def test_my_module(mock_read_sql_table):
    # You can now test any methods from `my_module`, e.g. `foo` and any call this 
    # method does to `read_sql_table` will be mocked by `db_mock`, e.g.
    ret = my_module_imported.foo(table_name='table_1')
    # `ret` is some DataFrame returned by `db_mock`

Answer 5

您可以使用 Side Effect + Dict Dispatch Pattern 来获得更干净的代码：

例如（使用异步，忽略非异步情况下的未来对象）

@pytest.fixture()
def mock_fixture(mocker):

    # dict to switch results from diferent results
    target_function_args_x_results = {
        'foo': 'result_1',
        'bar': 'result_2',
        'xyz': 'result_3',
    }


    def function_mock_side_effect(*args, **kwargs):
        future = asyncio.Future()
        argument_received = args[0] # ex: ... my_function('foo')
        mock_result = target_function_args_x_results.get(argument_received, {}) # Dict Dispatch Pattern
        future.set_result(mock_result)

        return future

    mocker.patch("src.app.my_module.my_target_function",
                 side_effect=function_mock_side_effect)