无法在pytest中使用pytest-mock同时验证构造和实例方法调用

Question

首先，我使用 pytest-mock 和 pytest 包来测试我正在开发的软件项目。

我遇到一种情况，我正在测试模块中的类并尝试模拟它从其__init__方法实例化的复合对象。当我这样做时，我能够断言该__init__方法被正确调用，但是当我尝试断言实例方法被调用时，我收到断言错误。

当我通过传递选项来调试 pytest 时，我通过检查对象的属性--pdb来验证它“没有”被调用，但是当我检查对象的属性时，我发现它实际上被调用了。MagicMock().method.calledMagicMock().method_calls

这是一个简单的例子来说明我的意思：

测试.py

import module

def test_Calling(mocker):
    mocker.patch('module.Called', autospec=True)

    module.Calling('argument')

    module.Called.assert_called_once_with('argument')
    module.Called.check_me.assert_called_once()

模块.py

class Calling(object):
    def __init__(self, argument):
        called_instance = Called(argument)
        called_instance.check_me()

class Called(object):
    def __init__(self, argument):
        pass

    def check_me(self):
        pass

这是 pytest/pdb 会话：

(venv) C:\pytest-issue>pytest --pdb test.py
============================= test session starts =============================
platform win32 -- Python 2.7.12, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
rootdir: C:\pytest-issue, inifile:
plugins: mock-1.5.0
collected 1 items

test.py F
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> traceback >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

mocker = <pytest_mock.MockFixture object at 0x000000000431B2E8>

    def test_Calling(mocker):
        mocker.patch('module.Called', autospec=True)

        module.Calling('argument')

        module.Called.assert_called_once_with('argument')
>       module.Called.check_me.assert_called_once()

test.py:9:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

_mock_self = <MagicMock name='Called.check_me' spec='instancemethod' id='70367608'>

    def assert_called_once(_mock_self):
        """assert that the mock was called only once.
        """
        self = _mock_self
        if not self.call_count == 1:
            msg = ("Expected '%s' to have been called once. Called %s times." %
                   (self._mock_name or 'mock', self.call_count))
>           raise AssertionError(msg)
E           AssertionError: Expected 'check_me' to have been called once. Called 0 times.

venv\lib\site-packages\mock\mock.py:915: AssertionError
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> entering PDB >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
> c:\pytest-issue\venv\lib\site-packages\mock\mock.py(915)assert_called_once()
-> raise AssertionError(msg)
(Pdb) up
> c:\pytest-issue\test.py(9)test_Calling()
-> module.Called.check_me.assert_called_once()
(Pdb) module.Called.method_calls
[call().check_me()]
(Pdb) module.Called.check_me.called
False

对于我的一生，我不确定我做错了什么。在这种情况下，我还需要断言吗.Called.method_calls？如果是这样，看起来我将不得不在测试中加入大量逻辑，这是不可取的。

Answer 1

所以，事实证明我对如何测试修补模块非常无知。

import module

def test_Calling(mocker):
    mock_Called = mocker.patch('module.Called')

    module.Calling('argument')

    mock_called.assert_has_calls([
        mocker.call('argument'),
        mocker.call().check_me()])

这里要考虑的重要事情是，您需要存储 mocker.patch 的返回值，因为这将提供对MagicMockover 中实例化和修补的对象的引用module.Called。接下来，当您希望测试是否正在调用实例方法时，您应该在实例assert_has_calls上使用该方法MagicMock，并向其call()传递反映所调用内容的参数。call()本身指的是调用__new__/__init__，并且call().method指的是针对实例方法进行的调用。

自从弄清楚这一点以来，我已经能够pytest-mock非常成功地使用该模块了。