Django 使用测试装置测试 FileField

Question

我正在尝试为某些具有 FileField 的模型构建测试。模型如下：

class SolutionFile(models.Model):
    '''
    A file from a solution.
    '''
    solution = models.ForeignKey(Solution)
    file = models.FileField(upload_to=make_solution_file_path)

我遇到了两个问题：

1. 使用./manage.py dumpdata将数据保存到fixture时，文件内容没有保存，只保存了文件名固定装置。虽然我发现这是预期的行为，因为文件内容未保存到数据库中，但我想以某种方式在测试夹具中包含此信息。

2. 我有一个用于上传文件的测试用例，如下所示：

   def test_post_solution_file（自身）：
       导入临时文件
       导入操作系统
       文件名 = tempfile.mkstemp()[1]
       f = 打开（文件名，'w'）
       f.write('这些是文件内容')
       f.close()
       f = 打开（文件名，'r'）
       post_data = {'文件': f}
       响应 = self.client.post(self.solution.get_absolute_url()+'add_solution_file/', post_data,
                                   遵循=真）
       f.close()
       os.remove(文件名)
       self.assertTemplateUsed（响应，'tests/solution_detail.html'）
       self.assertContains(响应, os.path.basename(文件名))
   

虽然此测试工作得很好，但完成后它会将上传的文件保留在媒体目录中。当然，删除可以在tearDown()中处理，但我想知道Django是否有另一种方法来处理这个问题。

我想到的一种解决方案是使用不同的媒体文件夹进行测试，该文件夹必须与测试装置保持同步。运行测试时，有什么方法可以在 settings.py 中指定另一个媒体目录？我可以包含某种转储数据的挂钩，以便它同步媒体文件夹中的文件吗？

那么，是否有一种更 Pythonic 或 Django 特定的方法来处理涉及文件的单元测试？

Answer 1

Django 提供了一种在 FileFields 上编写测试的好方法，而无需在实际文件系统中进行修改 - 使用 SimpleUploadedFile。

from django.core.files.uploadedfile import SimpleUploadedFile

my_model.file_field = SimpleUploadedFile('best_file_eva.txt', b'these are the contents of the txt file')

这是 django 的神奇功能之一，但在文档中却没有出现:)。然而，它被引用这里。

Answer 2

您可以使用 @override_settings() 装饰器覆盖测试的 MEDIA_ROOT 设置如文档所述：

from django.test import override_settings


@override_settings(MEDIA_ROOT='/tmp/django_test')
def test_post_solution_file(self):
  # your code here

Answer 3

我之前为整个图库应用程序编写过单元测试，对我来说效果好的方法是使用 python tempfile 和 Shutil 模块在临时目录中创建测试文件的副本，然后将它们全部删除。

以下示例不工作/不完整，但应该让您走上正确的道路：

import os, shutil, tempfile

PATH_TEMP = tempfile.mkdtemp(dir=os.path.join(MY_PATH, 'temp'))

def make_objects():
    filenames = os.listdir(TEST_FILES_DIR)

    if not os.access(PATH_TEMP, os.F_OK):
        os.makedirs(PATH_TEMP)

    for filename in filenames:
        name, extension = os.path.splitext(filename)
        new = os.path.join(PATH_TEMP, filename)
        shutil.copyfile(os.path.join(TEST_FILES_DIR, filename), new)

        #Do something with the files/FileField here

def remove_objects():
    shutil.rmtree(PATH_TEMP)

我在单元测试的 setUp() 和 TeaDown() 方法中运行这些方法，效果非常好！您已经获得了文件的干净副本来测试可重用且可预测的文件字段。

Answer 4

使用 pytest 和 pytest-django，我在 conftest.py 文件中使用它：

import tempfile
import shutil
from pytest_django.lazy_django import skip_if_no_django
from pytest_django.fixtures import SettingsWrapper


@pytest.fixture(scope='session')
#@pytest.yield_fixture()
def settings():
    """A Django settings object which restores changes after the testrun"""
    skip_if_no_django()

    wrapper = SettingsWrapper()
    yield wrapper
    wrapper.finalize()


@pytest.fixture(autouse=True, scope='session')
def media_root(settings):
    tmp_dir = tempfile.mkdtemp()
    settings.MEDIA_ROOT = tmp_dir
    yield settings.MEDIA_ROOT
    shutil.rmtree(tmp_dir)


@pytest.fixture(scope='session')
def django_db_setup(media_root, django_db_setup):
    print('inject_after')

可能会有所帮助：

1. https://dev.funkwhale.audio/funkwhale/funkwhale/blob/de777764da0c0e9fe66d0bb76317679be964588b/api/tests/conftest.py
2. https://framagit.org/ideascube/ideascube/blob/master/conftest.py
3. < a href="https://stackoverflow.com/a/56177770/5305401">https://stackoverflow.com/a/56177770/5305401

Answer 5

这就是我为测试所做的。上传文件后，它应该最终出现在我的组织模型对象的照片属性中：

    import tempfile
    filename = tempfile.mkstemp()[1]
    f = open(filename, 'w')
    f.write('These are the file contents')
    f.close()
    f = open(filename, 'r')
    post_data = {'file': f}
    response = self.client.post("/org/%d/photo" % new_org_data["id"], post_data)
    f.close()
    self.assertEqual(response.status_code, 200)

    ## Check the file
    ## org is where the file should end up
    org = models.Organization.objects.get(pk=new_org_data["id"])
    self.assertEqual("These are the file contents", org.photo.file.read())

    ## Remove the file
    import os
    os.remove(org.photo.path)