在 django 中对 FileField 进行单元测试的干净方法是什么？

Question

我有一个带有 FileField 的模型。我想对其进行单元测试。 django 测试框架有很好的方法来管理数据库和电子邮件。 FileFields 有类似的东西吗？

我如何确保单元测试不会污染真正的应用程序？

提前致谢

PS：我的问题几乎是 使用测试装置的 Django test FileField 但它没有公认的答案。只是想再次询问这个主题是否有新内容。

Answer 1

Django 提供了一个很好的方法来做到这一点 - 使用 SimpleUploadedFile 或 TemporaryUploadedFile。如果您需要存储的只是一些哨兵数据，那么 SimpleUploadedFile 通常是更简单的选择：

from django.core.files.uploadedfile import SimpleUploadedFile

my_model.file_field = SimpleUploadedFile(
    "best_file_eva.txt",
    b"these are the file contents!"   # note the b in front of the string [bytes]
)

这是 django 的神奇功能之一，但不会在文档中显示:)。然而，它被引用这里 并在此处实现。

限制

请注意，您只能将 bytes 放入 SimpleUploadedFile 中，因为它是在幕后使用 BytesIO 实现的。如果您需要更真实的、类似文件的行为，您可以使用 TemporaryUploadedFile。

对于 Python 2

如果您被困在 python 2 上，请跳过内容中的 b 前缀：

my_model.file_field = SimpleUploadedFile(
    "best_file_eva.txt",
    "these are the file contents!" # no b
)

Answer 2

有几种方法可以解决这个问题，但它们都很丑陋，因为单元测试应该是隔离的，但文件都是关于持久更改的。

我的单元测试不在具有生产数据的系统上运行，因此每次运行后使用 git reset --hard 之类的东西重置上传目录很容易。从某些方面来说，这种方法是最好的，因为它不涉及任何代码更改，并且只要您从良好的测试数据开始，就保证可以工作。

如果在测试模型的保存方法后实际上不需要对该文件执行任何操作，我建议使用 python 的优秀 模拟库 来完全伪造 File 实例（即类似于 mock_file = Mock(spec=django.core.files.File); mock_file .read.return_value =“假文件内容”），这样您就可以完全避免更改文件处理逻辑。 Mock 库有多种方法全局修补 Django 的 File 类 在测试方法中，就像这样简单会得到。

如果您需要一个真实的文件（即作为测试的一部分，使用外部脚本进行处理等），您可以使用类似于 Mirko 示例的内容并创建一个 文件对象 确保将其存储在适当的位置后 - 以下是三种方法：

• 进行测试 settings.MEDIA_ROOT 指向临时目录（请参阅 Python tempfile< /a> 模块的 mkdtemp 函数）。只要您有一个单独的 STATIC_ROOT 之类的东西，用于作为源代码一部分的媒体文件，这种方法就可以正常工作。
• 使用自定义 存储管理器
• 在每个 File 实例上手动设置文件路径或者有一个自定义 upload_to 函数指向测试设置/拆卸过程清除的某个位置，例如 MEDIA_ROOT 下的测试子目录。

编辑：模拟对象库是Python 3.3版本中的新功能。对于较旧的 python 版本，请检查 Michael Foord 的版本

Answer 3

我通常使用 doctest 测试模型中的文件字段，

>>> from django.core.files import File
>>> s = SimpleModel()
>>> s.audio_file = File(open("media/testfiles/testaudio.wav"))
>>> s.save()
>>> ...
>>> s.delete()

如果需要，我还会使用测试客户端测试文件上传。

至于固定装置，我只需在修改固定装置中的路径后将所需的文件复制到测试文件夹中即可。

例如，

在包含文件字段指向名为“audio”的目录的模型的装置中，将“audio”：“audio/audio.wav”替换为“audio”：“audio/test/audio.wav”。
现在您所要做的就是将测试文件夹以及必要的文件复制到测试设置中的“音频”中，然后在拆卸中将其删除。

这不是我认为的最干净的方式，但这就是我所做的。

Answer 4

如果您只想创建一个需要 FileField 的对象并且不想使用此字段，那么您只需传递任何（现有或不存在）相对路径，如下所示：

example_object = models.ExampleModel({'file': "foo.bar"})
example_object.save()

然后就可以使用了。

Answer 5

我想最简单的方法是使用 ContentFile 类：

file = ContentFile('text', 'name')
my_model = MyModel()
my_model.file = file
my_model.save()

Answer 6

有一些方法可以模拟存储。

阅读 django 源代码后，以下是我的实现，以避免将文件上传到 s3，无论使用默认存储还是在文件字段或图像字段中分配存储。

from unittest.mock import patch
from django.db.models.fields.files import FileField, FieldFile, ImageField, ImageFieldFile
from django.core.files.storage import FileSystemStorage
from rest_framework.test import APITestCase


class CustomFileSystemStorage(FileSystemStorage):
    def url(self, *args, **kwargs):
        return self.path(*args, **kwargs)


class CustomFieldFile(FieldFile):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.storage = CustomFileSystemStorage()
        
        
class CustomImageFieldFile(ImageFieldFile):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.storage = CustomFileSystemStorage()


class PatchMeta(type):
    """A metaclass to patch all inherited classes."""

    def __new__(meta, name, bases, attrs):
        cls = type.__new__(meta, name, bases, attrs)
        cls = patch.object(ImageField, 'attr_class', CustomImageFieldFile)(cls)
        cls = patch.object(FileField, 'attr_class', CustomFieldFile)(cls)
        return cls


class CustomBaseTestCase(APITestCase, metaclass=PatchMeta):
    """You can inherit this class to do any testcase for mocking storage"""
    pass

通过继承CustomBaseTestCase类，您可以更改存储以避免将文件上传到任何服务器