理解模拟和副作用

Question

我刚开始学Python，虽然我明白测试的概念，但对于使用模拟对象（Mocked Objects）和副作用（side_effects）这块，我还是搞不太明白。

这是我的方法：

@retry(every=RETRY_EVERY, until=RETRY_UNTIL)
@unique()
@sessionized(0)
def record_click(session, queue, mailing_id, member_id, link_id, timestamp, user_agent):
    message = session.query(Message).get((mailing_id, member_id))
    mailing = session.query(Mailing).get(mailing_id)
    # More code here

这是我的测试：

@mock.patch("audience.jobs.EventProvider")
@mock.patch("audience.jobs.enqueue_webhook")
@mock.patch("logging.exception")
@mock.patch("audience.jobs.audience_queues")
@mock.patch("audience.jobs.Session")
@mock.patch("audience.jobs.DatabaseConnector")
def test_track_click_publishes_event_to_sns(self, DatabaseConnector, Session, audience_queues, logger, enqueue_webhook, EventProvider):
    message_mock = mock.Mock(account_id=77)
    message_mock.record_open.return_value = True
    mailing_mock = mock.Mock(mailing_id=123)
    mailing_mock.recipient_groups.return_value = [111]
    session_query = Session.return_value.query.return_value
    session_query.side_effect = lambda arg: message_mock if isinstance(arg, tuple) else mailing_mock

    result = jobs.record_click(
        888,
        9999,
        2048,
        datetime.datetime(1999, 12, 31, 23, 59, 59, 999999).isoformat(),
        "Mozilla/5.0")

    self.assertIsNone(result)
    self.assertListEqual(EventProvider.mock_calls, [
        mock.call(),
        mock.call().publish_link_clicked(
            headers={'User-Agent': 'Mozilla/5.0'},
            mailing_id=888,
            account_id=77,
            contact_id=9999,
            link_id=2048,
            group_ids=[111]
        )
    ])
    self.assertListEqual(logger.mock_calls, [])

我一直收到的错误是：

我本来希望看到的是
call().publish_link_clicked(group_ids=[111], account_id=77, **etc)

但是在单元测试中调用的是
call().publish_link_clicked(group_ids=<MagicMock name='Session().query().get().recipient_groups' id='4557662736'>, account_id=<MagicMock name='Session().query().get().account_id' id='4557652048'>, **etc)

我到底哪里做错了呢？

Answer 1

不要直接调用 Session() 或 query()；应该使用 Mock.return_value 属性 来遍历调用图：

Session.return_value.query.return_value.side_effect = lambda arg: message_mock if isinstance(arg, tuple) else mailing_mock

我通常会用中间变量来保存返回值：

session_query = Session.return_value.query.return_value
session_query.side_effect = lambda arg: message_mock if isinstance(arg, tuple) else mailing_mock

你还需要修补正确的 Session 类；这完全取决于你的代码是如何生成传给 record_click 的 session 参数的。想了解更多细节，可以查看 在哪里修补。如果 @sessionized 装饰器生成了这个参数，而它 不在 audience.jobs 模块中，那么你就没有在正确的地方进行修补。