Question

是否有任何简单的机制来覆盖单元测试的Django设置？我在我的一个模型上有一个管理器，它返回特定数量的最新对象。它返回的对象数由NUM_LATEST设置定义。

如果有人要更改设置，这有可能使我的测试失败。如何覆盖setUp()上的设置，然后在tearDown()上恢复这些设置？如果那是不可能的，有什么方法可以修补方法或模拟设置吗？

编辑：以下是我的经理代码：

class LatestManager(models.Manager):
    """
    Returns a specific number of the most recent public Articles as defined by 
    the NEWS_LATEST_MAX setting.
    """
    def get_query_set(self):
        num_latest = getattr(settings, 'NEWS_NUM_LATEST', 10)
        return super(LatestManager, self).get_query_set().filter(is_public=True)[:num_latest]

管理员使用settings.NEWS_LATEST_MAX对查询集进行切片。如果设置不存在，getattr()仅用于提供默认值。

Answer 1

编辑：如果您想更改小个特定测试的设置，则此答案适用。

自Django 1.4以来，有一些方法可以在测试期间覆盖设置： https://docs.djangoproject.com/en/dev/topics/testing/tools/#overriding-settings

TestCase将有一个self.settings上下文管理器，并且还会有一个@override_settings装饰器，可以应用于测试方法或整个TestCase子类。

这些功能在Django 1.3中尚不存在。

如果要更改所有测试的设置，您需要创建一个单独的测试设置文件，该文件可以加载和覆盖主设置文件中的设置。在其他答案中有几种很好的方法;我已经看到了hspander's和dmitrii's方法的成功变体。

Answer 2

您可以对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值？如果您的测试例程触发了“其他东西”，那么我不确定任何数量的猴子修补都会保存测试而不会使测试本身的真实性失效。

Answer 3

更新：只有Django 1.3.x及更早版本需要以下解决方案。对于＆gt; 1.4，请参阅slinkp's answer。

如果您在测试中经常更改设置并使用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()

Answer 4

虽然在运行时覆盖设置配置可能会有所帮助，但在我看来，您应该创建一个单独的文件进行测试。这样可以节省大量的测试配置，这可以确保您永远不会做出不可逆转的事情（比如清理登台数据库）。

假设您的测试文件存在于＆＃39; my_project / test_settings.py＆＃39;，添加

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

Answer 5

运行测试时可以传递--settings选项

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

Answer 6

如果您的生产和测试环境配置之间没有很多差异，那么

getResourceWildcard非常棒。

在其他情况下，您最好只拥有不同的设置文件。在这种情况下，您的项目将如下所示：

@override_settings

因此，您需要在your_project your_app ... settings __init__.py base.py dev.py test.py production.py manage.py中设置大部分设置，然后在其他文件中，您需要从那里导入所有内容，并覆盖某些选项。以下是base.py文件的外观：

test.py

然后您需要在@MicroPyramid中指定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环境变量，然后您可以运行测试：

DJANGO_SETTINGS_MODULE

Answer 7

您甚至可以覆盖单个测试功能的设置。

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():

Answer 8

在尝试修复某些doctests时找到了这个...为了完整性，我想提一下，如果你在使用doctests时修改设置，你应该在导入任何其他内容之前进行修改......

>>> from django.conf import settings

>>> settings.SOME_SETTING = 20

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

Answer 9

我正在使用pytest。

我设法通过以下方式解决了这个问题：

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

Answer 10

我创建了一个新的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)

Answer 11

您可以通过以下方式覆盖测试中的设置：

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。

Answer 12

如果子目录（python程序包）中放置了多个测试文件，则可以基于sys.argv中'test'字符串存在的条件来覆盖所有这些文件的设置

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。

Answer 13

针对 pytest 用户。

最大的问题是：

override_settings不适用于pytest。
对Django的TestCase进行子类化将使其正常工作，但是您不能使用pytest固定装置。

解决方案是使用here中记录的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)

如何在Django中使用不同的设置进行单元测试？

13 个答案: