Django测试 - 在所有测试中修补对象

时间:2014-09-15 22:06:10

标签: python django unit-testing django-testing python-mock

我需要为我的测试创建某种MockMixin。它应该包括调用外部源的所有内容的模拟。 例如,每次我在管理面板中保存模型时,我都会调用一些远程URL。如果那样嘲笑和使用它会很好:

class ExampleTestCase(MockedTestCase):
    # tests

因此,每次我在管理员中保存模型时,例如在功能测试中,都应用此模拟而不是调用远程URL。

这实际上可行吗?我能够为1个特定测试做到这一点,这不是问题。但是有一些全局模拟更有用,因为我经常使用它。

3 个答案:

答案 0 :(得分:38)

根据mock documentation

  

Patch可以用作TestCase类装饰器。它的工作原理   在课堂上装饰每种测试方法。这减少了样板   当您的测试方法共享一个共同的补丁集时,代码。

这基本上意味着您可以创建一个基础测试类,其上应用了@patch装饰器,可以模拟外部调用,同时执行内部的每个测试方法。

此外,您可以分别在setUp()tearDown()方法中使用start() and stop()修补程序的方法:

class BaseTestCase(TestCase):
    def setUp(self):
        self.patcher = patch('mymodule.foo')
        self.mock_foo = self.patcher.start()

    def tearDown(self):
        self.patcher.stop()

答案 1 :(得分:21)

只需添加到alecxe's answer,如果您使用的是teardown(),那么according to the docs

  

您必须通过致电stop确保修补“撤消”。这可能比您想象的要简单,因为如果在setUp中引发异常,则不会调用tearDown

如果您的测试中出现异常,您的修补程序将无法撤消。更好的方法是在setUp()内拨打addCleanup()。然后你可以完全省略tearDown()方法。

class BaseTestCase(TestCase):
    def setUp(self):
        self.patcher = patch('mymodule.foo')
        self.mock_foo = self.patcher.start()
        self.addCleanup(self.patcher.stop) # add this line

答案 2 :(得分:1)

我最终创建了一个测试运行器来实现我的目的。我需要模拟文件存储,以使图像在测试时不会实际写入文件系统。在许多测试中都会调用images对象,因此打补丁每个类将不会是DRY。另外,我注意到模拟文件本身会在测试失败的情况下将其留在系统上。但是这种方法没有。

我在项目根目录中创建了文件runner.py

# runner.py
from unittest.mock import patch

from django.test.runner import DiscoverRunner

from myapp.factories import ImageFactory


class UnitTestRunner(DiscoverRunner):

    @patch('django.core.files.storage.FileSystemStorage.save')
    def run_tests(self, test_labels, mock_save, extra_tests=None, **kwargs):
        mock_save.return_value = ImageFactory.get_image()
        return super().run_tests(test_labels, extra_tests=None, **kwargs)

然后我将使用python manage.py tests --testrunner=runner.UnitTestRunner

运行测试

为清楚起见,ImageFactory.get_image方法是自定义方法

from django.core.files.base import ContentFile
from factory.django import DjangoModelFactory
from io import BytesIO
from PIL import Image as PilImage
from random import randint

class ImageFactory(DjangoModelFactory):

    @classmethod
    def get_image(cls, name='trial', extension='png', size=None):
        if size is None:
            width = randint(20, 1000)
            height = randint(20, 1000)
            size = (width, height)

        color = (256, 0, 0)

        file_obj = BytesIO()
        image = PilImage.new("RGBA", size=size, color=color)
        image.save(file_obj, extension)
        file_obj.seek(0)
        return ContentFile(file_obj.read(), f'{name}.{extension}')