在 Python 中调用模拟方法的类的测试实例

Question

我正在模拟一个类的方法，并想测试调用该方法的类的实例，以测试我的函数的创建部分是否按预期工作。

在我的特殊情况下， do_stuff尝试将bar_instance写入 Excel 文件，我不希望发生这种情况，即

def create_instance(*args):
 return Bar(*args)

class Bar():
 def __init__(self, *args):
  self.args = args
 def do_stuff(self):
  pass

def foo(*args):
 bar_instance = create_instance(*args)
 bar_instance.do_stuff()

然后在测试文件中

from unittest import TestCase
from unittest.mock import patch
from path.to.file import foo

class TestFoo(TestCase):
 @patch('path.to.file.Bar.do_stuff')
 def test_foo(self, mock_do_stuff):
  test_args = [1]
  _ = foo(*test_args)
  # Test here the instance of `Bar` that `mock_do_stuff` was called from
  # Something like
  actual_args = list(bar_instance.args)
  self.assertEqual(test_args, actual_args)

在foo(*test_args)运行后，我在测试函数中放置了一个中断，但是从访问它被调用的Bar实例的foo(*test_args)不到任何方法，并且有点卡住了。 我不想在代码中进一步模拟Bar ，因为我想确保正在创建正确的Bar实例。

Answer 1

在您的代码示例中，可能需要测试三件事：函数create_instance 、类Bar和函数foo 。 我了解您的测试代码，因此您希望确保函数foo在create_instance返回的实例上调用 do_stuff 。

由于原始create_instance函数可以控制创建的实例，因此您的问题的解决方案是模拟create_instance以便您的测试获得对移交给 foo 的对象的控制权：

import unittest
from unittest import TestCase
from unittest.mock import patch, MagicMock
from SO_60624698 import foo

class TestFoo(TestCase):
   @patch('SO_60624698.create_instance')
   def test_foo_calls_do_stuff_on_proper_instance (
         self, create_instance_mock ):
      # Setup
      Bar_mock = MagicMock()
      create_instance_mock.return_value = Bar_mock
      # Exercise
      foo(1, 2, 3) # args are irrelevant
      # Verify
      Bar_mock.do_stuff.assert_called()

if __name__ == '__main__':
   unittest.main()

此外，您可能还想测试foo将参数正确传递给create_instance 。 这可以作为单独的测试来实现：

...
   @patch('SO_60624698.create_instance')
   def test_foo_passes_arguments_to_create_instance (
         self, create_instance_mock ):
      # Setup
      create_instance_mock.return_value = MagicMock()
      # Exercise
      foo(1, 22, 333)
      # Verify
      create_instance_mock.assert_called_with(1, 22, 333)

当然，为了完成对象生成的整个测试，您可以直接测试create_instance ，方法是调用它并检查返回的Bar实例是否正确使用了它的参数来构建Bar实例。

Answer 2

当patch返回Mock 的一个实例（或者实际上是 MagicMock，但它从其基础 - Mock 继承相关方法）时，您可以使用assert_called_with方法，它应该可以解决问题。 请注意，此方法对args / kwargs敏感 - 您必须断言完全相同的调用。

另一个注意事项：在这里使用patch.object而不是patch可能是更好的做法