如何断言 pytest 中调用了猴子补丁？

Question

考虑以下因素：

class MockResponse:
    status_code = 200

    @staticmethod
    def json():
        return {'key': 'value'}
                                  # where api_session is a fixture
def test_api_session_get(monkeypatch, api_session) -> None:
    def mock_get(*args, **kwargs):
        return MockResponse()

    monkeypatch.setattr(requests.Session, 'get', mock_get)
    response = api_session.get('endpoint/') # My wrapper around requests.Session
    assert response.status_code == 200
    assert response.json() == {'key': 'value'}
    monkeypatch.assert_called_with(
        'endpoint/',
        headers={
            'user-agent': 'blah',
        },
    )

我如何断言我正在修补的

get

会被

'/endpoint'

和

headers

调用？当我现在运行测试时，我收到以下失败消息：

FAILED test/utility/test_api_session.py::test_api_session_get - AttributeError: 'MonkeyPatch' object has no attribute 'assert_called_with'

我在这里做错了什么？感谢所有提前回复的人。

Answer 1

要添加另一个使用 Monkeypatch 的响应，而不是“你不能使用 Monkeypatch”

由于 python 有闭包，这是我可怜的人用 Monkeypatch 做这样的事情的方法：

patch_called = False

def _fake_delete(keyname):
    nonlocal patch_called
    patch_called = True
    assert ...

monkeypatch.setattr("mymodule._delete", _fake_delete)
res = client.delete(f"/.../{delmeid}"). # this is a flask client
assert res.status_code == 200
assert patch_called

就您而言，由于我们正在通过修补 HTTP 服务器方法处理程序来执行类似的操作，因此您可以执行类似的操作（并不是说这很漂亮）：

param_called = None

def _fake_delete(param):
    nonlocal param_called
    patch_called = param
    assert ...

monkeypatch.setattr("mymodule._delete", _fake_delete)
res = client.delete(f"/.../{delmeid}")
assert res.status_code == 200
assert param_called == "whatever this should be"

Answer 2

您需要一个

Mock

对象来调用

assert_called_with

-

monkeypatch

不提供开箱即用的功能。您可以将

unittest.mock.patch

与

side_effect

结合使用来实现此目的：

from unittest import mock
import requests

...

@mock.patch('requests.Session.get')
def test_api_session_get(mocked, api_session) -> None:
    def mock_get(*args, **kwargs):
        return MockResponse()

    mocked.side_effect = mock_get
    response = api_session.get('endpoint/') 
    ...
    mocked.assert_called_with(
        'endpoint/',
        headers={
            'user-agent': 'blah',
        },
    )

仍然需要使用

side_effect

来获取模拟对象（在本例中为

mocked

类型），而不是仅仅在

MagickMock

中设置自己的对象，否则你将无法使用

patch

方法。

澄清一下

：当我写“monkeypatch 没有提供开箱即用的功能”时，这与 assert_called_... 方法的使用有关。这并不意味着您不能使用 Monkeypatch 来实现类似的功能，正如 Tommy 的答案中很好地显示的那样。