我是否可以在不将此应用程序合并到项目中的情况下为我的可重用Django应用程序启动测试?
我的应用使用了某些模型,因此有必要提供(TEST_)DATABASE_*
设置。我应该在哪里存储它们以及我应该如何启动测试?
对于Django项目,我可以使用manage.py test
运行测试;当我在我的独立应用程序中使用django-admin.py test
时,我得到:
错误:无法导入设置, 因为环境变量 DJANGO_SETTINGS_MODULE未定义。
这里的最佳做法是什么?
答案 0 :(得分:44)
Django(> = 1.4)测试运行器的正确用法如下:
import django, sys
from django.conf import settings
settings.configure(DEBUG=True,
DATABASES={
'default': {
'ENGINE': 'django.db.backends.sqlite3',
}
},
ROOT_URLCONF='myapp.urls',
INSTALLED_APPS=('django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.admin',
'myapp',))
try:
# Django < 1.8
from django.test.simple import DjangoTestSuiteRunner
test_runner = DjangoTestSuiteRunner(verbosity=1)
except ImportError:
# Django >= 1.8
django.setup()
from django.test.runner import DiscoverRunner
test_runner = DiscoverRunner(verbosity=1)
failures = test_runner.run_tests(['myapp'])
if failures:
sys.exit(failures)
DjangoTestSuiteRunner和DiscoverRunner主要兼容接口。
有关详细信息,请参阅“定义测试运行器”文档:
答案 1 :(得分:18)
我已经结束了这样的解决方案(它受到了django投票中的解决方案的启发):
创建文件,例如。测试目录中的'runtests.py'包含:
import os, sys
from django.conf import settings
DIRNAME = os.path.dirname(__file__)
settings.configure(DEBUG = True,
DATABASE_ENGINE = 'sqlite3',
DATABASE_NAME = os.path.join(DIRNAME, 'database.db'),
INSTALLED_APPS = ('django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.admin',
'myapp',
'myapp.tests',))
from django.test.simple import run_tests
failures = run_tests(['myapp',], verbosity=1)
if failures:
sys.exit(failures)
它允许通过python runtests.py
命令运行测试。
它不需要安装依赖项(例如buildout),并且当app应用于更大的项目时,它不会损害测试运行。
答案 2 :(得分:10)
对于Django 1.7,它略有不同。假设您有以下内容
应用foo
的目录结构:
foo
|── docs
|── foo
│ ├── __init__.py
│ ├── models.py
│ ├── urls.py
│ └── views.py
└── tests
├── foo_models
│ ├── __init__.py
│ ├── ...
│ └── tests.py
├── foo_views
│ ├── __init__.py
│ ├── ...
│ └── tests.py
├── runtests.py
└── urls.py
Django项目本身就是如何构建测试的。
您希望使用以下命令在foo/tests/
中运行所有测试:
python3 runtests.py
您还希望能够从tests
的父目录运行命令,例如通过Tox或Invoke,就像python3 foo/tests/runtests.py
。
我在此处提供的解决方案非常可重复使用,只需要调整应用的名称foo
(如有必要,还可以调整其他应用)。他们不可以通过modify_settings安装,因为它会错过数据库设置。
需要以下文件:
<强> urls.py 强>
"""
This urlconf exists because Django expects ROOT_URLCONF to exist. URLs
should be added within the test folders, and use TestCase.urls to set them.
This helps the tests remain isolated.
"""
urlpatterns = []
<强> runtests.py 强>
#!/usr/bin/env python3
import glob
import os
import sys
import django
from django.conf import settings
from django.core.management import execute_from_command_line
BASE_DIR = os.path.abspath(os.path.dirname(__file__))
sys.path.append(os.path.abspath(os.path.join(BASE_DIR, '..')))
# Unfortunately, apps can not be installed via ``modify_settings``
# decorator, because it would miss the database setup.
CUSTOM_INSTALLED_APPS = (
'foo',
'django.contrib.admin',
)
ALWAYS_INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
)
ALWAYS_MIDDLEWARE_CLASSES = (
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
)
settings.configure(
SECRET_KEY="django_tests_secret_key",
DEBUG=False,
TEMPLATE_DEBUG=False,
ALLOWED_HOSTS=[],
INSTALLED_APPS=ALWAYS_INSTALLED_APPS + CUSTOM_INSTALLED_APPS,
MIDDLEWARE_CLASSES=ALWAYS_MIDDLEWARE_CLASSES,
ROOT_URLCONF='tests.urls',
DATABASES={
'default': {
'ENGINE': 'django.db.backends.sqlite3',
}
},
LANGUAGE_CODE='en-us',
TIME_ZONE='UTC',
USE_I18N=True,
USE_L10N=True,
USE_TZ=True,
STATIC_URL='/static/',
# Use a fast hasher to speed up tests.
PASSWORD_HASHERS=(
'django.contrib.auth.hashers.MD5PasswordHasher',
),
FIXTURE_DIRS=glob.glob(BASE_DIR + '/' + '*/fixtures/')
)
django.setup()
args = [sys.argv[0], 'test']
# Current module (``tests``) and its submodules.
test_cases = '.'
# Allow accessing test options from the command line.
offset = 1
try:
sys.argv[1]
except IndexError:
pass
else:
option = sys.argv[1].startswith('-')
if not option:
test_cases = sys.argv[1]
offset = 2
args.append(test_cases)
# ``verbosity`` can be overwritten from command line.
args.append('--verbosity=2')
args.extend(sys.argv[offset:])
execute_from_command_line(args)
部分设置是可选的;他们提高了速度或更现实的环境。
第二个参数指向当前目录。它使用feature of providing a path to a directory to discover tests below that directory。
答案 3 :(得分:5)
对于我的可重用应用程序(django-moderation),我使用buildout。我创建了example_project
,我在buildout中使用它来运行测试。我只是将我的应用置于example_project
。
当我想安装项目使用的所有依赖项并运行测试时,我只需要执行以下操作:
运行buildout:
仓/附加件
运行Django 1.1和Django 1.2的测试:
斌/测试-1.1 箱/测试-1.2
在这里您可以找到教程如何配置可重用的应用程序以使用buildout进行部署和测试运行:http://jacobian.org/writing/django-apps-with-buildout/
在这里,您将找到我在项目中使用的示例buildout配置:
http://github.com/dominno/django-moderation/blob/master//buildout.cfg
答案 4 :(得分:1)
在一个纯粹的 pytest 上下文中,为了提供足够的Django环境来为我的可重用应用程序运行测试,而不需要实际的Django项目,我需要以下部分:
<强> pytest.ini:强>
[pytest]
DJANGO_SETTINGS_MODULE = test_settings
python_files = tests.py test_*.py *_tests.py
<强> test_settings.py:强>
# You may need more or less than what's shown here - this is a skeleton:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
}
}
INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.messages',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.staticfiles',
'todo',
)
ROOT_URLCONF = 'base_urls'
TEMPLATES = [
{
'DIRS': ['path/to/your/templates'), ],
}
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
<强> base_urls.py:强>
"""
This urlconf exists so we can run tests without an actual
Django project (Django expects ROOT_URLCONF to exist.)
It is not used by installed instances of this app.
"""
from django.urls import include, path
urlpatterns = [
path('foo/', include('myapp.urls')),
]
<强>模板/ base.html文件:强>
如果您的任何测试都达到了实际视图,那么您应用的模板可能会扩展项目base.html
,因此该文件必须存在。就我而言,我刚刚创建了一个空文件templates/base.html
。
我现在可以从我的独立可重用应用程序目录运行pytest -x -v
,而不需要Django项目。
答案 5 :(得分:0)
我知道这是一个旧线程,但我发现如果您的可重用应用程序有一个文件“tests.py”,那么您可以在您的项目文件夹中创建一个tests.py,然后编写以下内容...
from reusableapp.tests import *
Django 将在您调用 'python manage.py test' 时运行这些测试