Как провести модульное тестирование с разными настройками в Django?

РЕДАКТИРОВАТЬ: этот ответ применим, если вы хотите изменить настройки для небольшого количества конкретных тестов.

Начиная с Django 1.4, есть способы переопределить настройки во время тестов: https://docs.djangoproject.com/en/dev/topics/testing/tools/#overriding-settings

В TestCase будет менеджер контекста self.settings, а также декоратор @override_settings, который можно применить либо к тестовому методу, либо ко всему подклассу TestCase.

Эти функции еще не существовали в Django 1.3.

Если вы хотите изменить настройки для всех ваших тестов, вам нужно создать отдельный файл настроек для теста, который может загружать и переопределять настройки из основного файла настроек. В других ответах есть несколько хороших подходов к этому; Я видел успешные варианты как hspander, так и подходит дмитрий.

Вы можете делать с подклассом UnitTest все, что захотите, включая настройку и чтение свойств экземпляра:

from django.conf import settings

class MyTest(unittest.TestCase):
   def setUp(self):
       self.old_setting = settings.NUM_LATEST
       settings.NUM_LATEST = 5 # value tested against in the TestCase

   def tearDown(self):
       settings.NUM_LATEST = self.old_setting

Однако, поскольку тестовые примеры django выполняются в однопоточном режиме, мне любопытно, что еще может изменять значение NUM_LATEST? Если это «что-то еще» вызвано вашей процедурой тестирования, то я не уверен, что какое-либо количество исправлений обезьяны спасет тест, не лишая достоверности самих тестов.

Вы можете передать опцию --settings при запуске тестов

python manage.py test --settings=mysite.settings_local

Хотя переопределение конфигурации параметров во время выполнения может помочь, на мой взгляд, вам следует создать отдельный файл для тестирования. Это экономит много конфигурации для тестирования и гарантирует, что вы никогда не сделаете что-то необратимое (например, очистку промежуточной базы данных).

Скажите, что ваш тестовый файл существует в 'my_project/test_settings.py', добавьте

settings = 'my_project.test_settings' if 'test' in sys.argv else 'my_project.settings'

в вашем файле manage.py. Это гарантирует, что при запуске python manage.py test вы будете использовать только test_settings. Если вы используете какой-либо другой клиент для тестирования, такой как pytest, вы можете легко добавить его в pytest.ini.

Обновление: приведенное ниже решение требуется только для Django 1.3.x и более ранних версий. Для > 1.4 см. ответ slinkp.

Если вы часто меняете настройки в своих тестах и ​​используете Python ≥2.5, это также удобно:

from contextlib import contextmanager

class SettingDoesNotExist:
    pass

@contextmanager
def patch_settings(**kwargs):
    from django.conf import settings
    old_settings = []
    for key, new_value in kwargs.items():
        old_value = getattr(settings, key, SettingDoesNotExist)
        old_settings.append((key, old_value))
        setattr(settings, key, new_value)
    yield
    for key, old_value in old_settings:
        if old_value is SettingDoesNotExist:
            delattr(settings, key)
        else:
            setattr(settings, key, old_value)

Затем вы можете сделать:

with patch_settings(MY_SETTING='my value', OTHER_SETTING='other value'):
    do_my_tests()

@override_settings отлично подходит, если у вас не так много различий между конфигурациями рабочей среды и среды тестирования.

В противном случае вам лучше иметь другие файлы настроек. В этом случае ваш проект будет выглядеть так:

your_project
    your_app
        ...
    settings
        __init__.py
        base.py
        dev.py
        test.py
        production.py
    manage.py

Таким образом, вам нужно иметь большую часть ваших настроек в base.py, а затем в других файлах, вам нужно импортировать все оттуда и переопределить некоторые параметры. Вот как будет выглядеть ваш файл test.py:

from .base import *

DEBUG = False

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'app_db_test'
    }
}

PASSWORD_HASHERS = (
    'django.contrib.auth.hashers.MD5PasswordHasher',
)

LOGGING = {}

И тогда вам нужно либо указать параметр --settings, как в ответе @MicroPyramid, либо указать переменную среды DJANGO_SETTINGS_MODULE, после чего вы можете запустить свои тесты:

export DJANGO_SETTINGS_MODULE=settings.test
python manage.py test 

Для пользователей pytest.

Самая большая проблема:

• override_settings не работает с pytest.
• Подкласс Django TestCase заставит его работать, но тогда вы не сможете использовать фикстуры pytest.

Решение состоит в том, чтобы использовать приспособление settings, задокументированное здесь.

Пример

def test_with_specific_settings(settings):
    settings.DEBUG = False
    settings.MIDDLEWARE = []
    ..

И если вам нужно обновить несколько полей

def override_settings(settings, kwargs):
    for k, v in kwargs.items():
        setattr(settings, k, v)


new_settings = dict(
    DEBUG=True,
    INSTALLED_APPS=[],
)


def test_with_specific_settings(settings):
    override_settings(settings, new_settings)

Вы можете переопределить настройку даже для одной тестовой функции.

from django.test import TestCase, override_settings

class SomeTestCase(TestCase):

    @override_settings(SOME_SETTING="some_value")
    def test_some_function():
        

или вы можете переопределить настройку для каждой функции в классе.

@override_settings(SOME_SETTING="some_value")
class SomeTestCase(TestCase):

    def test_some_function():
        

Обнаружил это, пытаясь исправить некоторые doctests... Для полноты картины я хочу отметить, что если вы собираетесь изменить настройки при использовании doctests, вы должны сделать это перед импортом чего-либо еще...

>>> from django.conf import settings

>>> settings.SOME_SETTING = 20

>>> # Your other imports
>>> from django.core.paginator import Paginator
>>> # etc

Я использую питест.

Мне удалось решить это следующим образом:

import django    
import app.setting
import modules.that.use.setting

# do some stuff with default setting
setting.VALUE = "some value"
django.setup()
import importlib
importlib.reload(app.settings)
importlib.reload(modules.that.use.setting)
# do some stuff with settings new value

Вы можете переопределить настройки в тесте следующим образом:

from django.test import TestCase, override_settings

test_settings = override_settings(
    DEFAULT_FILE_STORAGE='django.core.files.storage.FileSystemStorage',
    PASSWORD_HASHERS=(
        'django.contrib.auth.hashers.UnsaltedMD5PasswordHasher',
    )
)


@test_settings
class SomeTestCase(TestCase):
    """Your test cases in this class"""

И если вам нужны эти же настройки в другом файле, вы можете просто напрямую импортировать test_settings.

Я создал новый файл settings_test.py, который будет импортировать все из файла settings.py и изменять все, что отличается для целей тестирования. В моем случае я хотел использовать другую корзину облачного хранилища при тестировании.

settings_test.py:

from project1.settings import *
import os

CLOUD_STORAGE_BUCKET = 'bucket_name_for_testing'

manage.py:

def main():

    # use seperate settings.py for tests
    if 'test' in sys.argv:
        print('using settings_test.py')
        os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project1.settings_test')
    else:
        os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project1.settings')

    try:
        from django.core.management import execute_from_command_line
    except ImportError as exc:
        raise ImportError(
            "Couldn't import Django. Are you sure it's installed and "
            "available on your PYTHONPATH environment variable? Did you "
            "forget to activate a virtual environment?"
        ) from exc
    execute_from_command_line(sys.argv)

Если у вас есть несколько тестовых файлов, размещенных в подкаталоге (пакет Python), вы можете переопределить настройки для всех этих файлов в зависимости от наличия строки «тест» в sys.argv.

app
  tests
    __init__.py
    test_forms.py
    test_models.py

__init__.py:

import sys
from project import settings

if 'test' in sys.argv:
    NEW_SETTINGS = {
        'setting_name': value,
        'another_setting_name': another_value
    }
    settings.__dict__.update(NEW_SETTINGS)

Не лучший подход. Использовал его для смены брокера Celery с Redis на Memory.