python - 我如何在我的 Django 应用程序中模拟一个到达外部服务的组件？

Question

我有一个方法可以连接到外部 API 并提取一些内容，然后执行一些逻辑并继续进行。问题是，在测试时，我不希望我的测试用例触发这个外部 API，但我确实希望它模拟响应。示例

def create_animals(candidate):
    if ExternalService.get_candidate_validity(candidate):
         print('Things are good, go ahead')
         #creates the animal objects etc....

但是 ExternalService.get_candidate_validity 访问了我想要模拟的 API。我知道我可以模拟这样的实例:

get_candidate_validity_value = {'response': True}
c = ExternalService('someparamsthatineed')
c.get_candidate_validity = MagicMock(return_value=get_candidate_validity_value)

但是我如何处理在我最终调用测试的方法中实例化类的情况？

Answer 1

如果你有一个 python 模块 animals.py 有这个:

def create_animals(candidate):
    if ExternalService.get_candidate_validity(candidate):
         print('Things are good, go ahead')
         #creates the animal objects etc....

您可以在 test_animals.py 中以这种方式模拟它

from mock import MagicMock  # or import mock from stdlib unittest in python 3

def test_create_animals():
    from path.to.animals import ExternalService, create_animals
    ExternalService.get_candidate_validity = MagicMock(return_value=True)
    animals = create_animals('foo')
    ExternalService.get_candidate_validity.assert_called_with('foo')

单元测试的最佳实践是以某种方式模拟所有外部服务，这样您就可以测试单元，即被测试的功能，而不是其他任何东西。

另一种方法是使用标准单元测试库中的补丁功能。

https://docs.python.org/3/library/unittest.mock.html#attaching-mocks-as-attributes

>>> with patch('animals.ExternalService') as MockClass:
...     MockClass.get_candidate_validity.return_value = 'foo'