在Python单元测试中修补多个方法的首选方法

时间:2015-03-28 15:35:41

标签: python unit-testing mocking

在测试单元测试中对第四种方法(_send_reply)的调用之前,我需要使用mock方法修补三种方法(_reset_watchdog_handle_set_watchdog_handle_command)我的。

通过查看mock软件包的文档,我可以通过以下几种方式解决这个问题:

patch.multiple作为装饰者

@patch.multiple(MBG120Simulator,
                _send_reply=DEFAULT,
                _reset_watchdog=DEFAULT,
                _handle_set_watchdog=DEFAULT,
                autospec=True)
def test_handle_command_too_short_v1(self,
                                     _send_reply,
                                     _reset_watchdog,
                                     _handle_set_watchdog):
    simulator = MBG120Simulator()
    simulator._handle_command('XA99')
    _send_reply.assert_called_once_with(simulator, 'X?')
    self.assertFalse(_reset_watchdog.called)
    self.assertFalse(_handle_set_watchdog.called)
    simulator.stop()

patch.multiple作为上下文管理器

def test_handle_command_too_short_v2(self):
    simulator = MBG120Simulator()

    with patch.multiple(simulator,
                        _send_reply=DEFAULT,
                        _reset_watchdog=DEFAULT,
                        _handle_set_watchdog=DEFAULT,
                        autospec=True) as mocks:
        simulator._handle_command('XA99')
        mocks['_send_reply'].assert_called_once_with('X?')
        self.assertFalse(mocks['_reset_watchdog'].called)
        self.assertFalse(mocks['_handle_set_watchdog'].called)
        simulator.stop()

有多个patch.object装饰

@patch.object(MBG120Simulator, '_send_reply', autospec=True)
@patch.object(MBG120Simulator, '_reset_watchdog', autospec=True)
@patch.object(MBG120Simulator, '_handle_set_watchdog', autospec=True)
def test_handle_command_too_short_v3(self,
                                     _handle_set_watchdog_mock,
                                     _reset_watchdog_mock,
                                     _send_reply_mock):
    simulator = MBG120Simulator()
    simulator._handle_command('XA99')
    _send_reply_mock.assert_called_once_with(simulator, 'X?')
    self.assertFalse(_reset_watchdog_mock.called)
    self.assertFalse(_handle_set_watchdog_mock.called)
    simulator.stop()

使用create_autospec

手动替换方法
def test_handle_command_too_short_v4(self):
    simulator = MBG120Simulator()

    # Mock some methods.
    simulator._send_reply = create_autospec(simulator._send_reply)
    simulator._reset_watchdog = create_autospec(simulator._reset_watchdog)
    simulator._handle_set_watchdog = create_autospec(simulator._handle_set_watchdog)

    # Exercise.
    simulator._handle_command('XA99')

    # Check.
    simulator._send_reply.assert_called_once_with('X?')
    self.assertFalse(simulator._reset_watchdog.called)
    self.assertFalse(simulator._handle_set_watchdog.called)

我个人认为最后一个是最清楚的,如果模拟方法的数量增长,不会导致可怕的长行。它还避免了将simulator作为第一个self)参数传递给assert_called_once_with

但我发现其中任何一个都不是特别好。特别是多patch.object方法,需要仔细匹配参数顺序与嵌套装饰。

是否有一些我错过的方法,或者是一种让它更具可读性的方法?当您需要在测试的实例/类上修补多个方法时,您会怎么做?

1 个答案:

答案 0 :(得分:6)

不,你没有错过任何与你提出的建议完全不同的东西。

关于可读性,我的品味是装饰师的方式,因为它从测试体中移除了嘲弄的东西......但它只是味道。

您是对的:如果您通过autospec=True修补方法的静态实例,则必须在assert_called_*系列检查方法中使用self。但是你的情况只是一个小类,因为你确切地知道你需要修补什么对象,而且你不需要补丁的其他上下文而不是测试方法。

你需要修补你的对象使用它来进行所有的测试:通常在测试中你不能在打电话之前让实例进行补丁,在这些情况下{@ 1}}不能使用:你可以只修补静态实例而不是方法。

如果您将实例传递给create_autospec方法而烦恼,请考虑使用ANY来破坏依赖关系。最后我写了数百个这样的测试,我从来没有对争论顺序有任何疑问。

我的测试标准方法是

assert_called_*
  • 修补超出了测试方法代码
  • 每个模拟都以@patch('mbgmodule.MBG120Simulator._send_reply', autospec=True) @patch('mbgmodule.MBG120Simulator._reset_watchdog', autospec=True) @patch('mbgmodule.MBG120Simulator._handle_set_watchdog', autospec=True) def test_handle_command_too_short(self,mock_handle_set_watchdog, mock_reset_watchdog, mock_send_reply): simulator = MBG120Simulator() simulator._handle_command('XA99') # You can use ANY instead simulator if you don't know it mock_send_reply.assert_called_once_with(simulator, 'X?') self.assertFalse(mock_reset_watchdog.called) self.assertFalse(mock_handle_set_watchdog_mock.called) simulator.stop() 前缀
  • 开头
  • 我更喜欢使用简单的mock_调用和绝对路径:它清楚而整洁你在做什么

最后:也许创建patch并停止simulatorsetUp()责任和测试应考虑修补某些方法并进行检查。

我希望答案很有用,但问题没有唯一有效的答案,因为可读性不是绝对的概念,而是取决于读者。此外,即使是关于一般情况的标题,问题的例子也是关于特定的问题类,你应该修补对象的方法进行测试。

<强> [编辑]

我对这个问题有一段时间了,我发现了什么困扰我:你正试图测试和感知私人方法。当发生这种情况时,首先要问的是为什么?答案很可能是因为这些方法应该是私人协作者的公共方法(that not my words)。

在新的场景中,您应该感知私人协作者,而您无法仅仅改变对象。您需要做的是修补其他一些类的静态实例。