RequestFactory与测试客户端共享相同的API。但是,RequestFactory不是像浏览器一样工作,而是提供一种方法来生成可用作任何视图的第一个参数的请求实例。这意味着您可以像测试任何其他函数一样测试视图函数 - 作为一个黑盒子,具有完全已知的输入,测试特定的输出。
RequestFactory的API是测试客户端API的一个稍微受限的子集:
以下是使用请求工厂的简单单元测试:
from django.contrib.auth.models import AnonymousUser, User
from django.test import TestCase, RequestFactory
from .views import my_view
class SimpleTest(TestCase):
def setUp(self):
# Every test needs access to the request factory.
self.factory = RequestFactory()
self.user = User.objects.create_user(
username='jacob', email='jacob@…', password='top_secret')
def test_details(self):
# Create an instance of a GET request.
request = self.factory.get('/customer/details')
# Recall that middleware are not supported. You can simulate a
# logged-in user by setting request.user manually.
request.user = self.user
# Or you can simulate an anonymous user by setting request.user to
# an AnonymousUser instance.
request.user = AnonymousUser()
# Test my_view() as if it were deployed at /customer/details
response = my_view(request)
self.assertEqual(response.status_code, 200)
如果您使用主/副本(由某些数据库称为主/从属)测试多数据库配置,则创建测试数据库的这种策略会出现问题。创建测试数据库时,不会有任何复制,因此,在主节点上创建的数据将不会在副本上看到。
为了弥补这一点,Django允许您定义数据库是测试镜像。考虑以下(简化)示例数据库配置:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'myproject',
'HOST': 'dbprimary',
# ... plus some other settings
},
'replica': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'myproject',
'HOST': 'dbreplica',
'TEST_MIRROR': 'default'
# ... plus some other settings
}
}
In this setup, we have two database servers: dbprimary, described by the database alias default, and dbreplica described by the alias replica. 如您所料,dbreplica已由数据库管理员配置为dbprimary的只读副本,因此在正常活动中,对default将显示在replica上。
如果Django创建了两个独立的测试数据库,这将破坏任何期望复制发生的测试。但是,replica数据库已配置为测试镜像(使用TEST_MIRROR设置),表示在测试下,replica default的镜像。
配置测试环境时,replica的测试版本将不会创建。相反,到replica的连接将被重定向到指向default。因此,对default的写入将出现在replica上 - 但是因为它们实际上是同一个数据库,而不是因为两个数据库之间存在数据复制。
默认情况下,Django将假定所有数据库都依赖于default数据库,因此,始终首先创建default数据库。但是,不能保证测试设置中任何其他数据库的创建顺序。
如果数据库配置需要特定的创建顺序,则可以使用TEST_DEPENDENCIES设置指定存在的依赖关系。考虑以下(简化)示例数据库配置:
DATABASES = {
'default': {
# ... db settings
'TEST_DEPENDENCIES': ['diamonds']
},
'diamonds': {
# ... db settings
'TEST_DEPENDENCIES': []
},
'clubs': {
# ... db settings
'TEST_DEPENDENCIES': ['diamonds']
},
'spades': {
# ... db settings
'TEST_DEPENDENCIES': ['diamonds','hearts']
},
'hearts': {
# ... db settings
'TEST_DEPENDENCIES': ['diamonds','clubs']
}
}
在此配置下,将首先创建diamonds数据库,因为它是唯一没有依赖关系的数据库别名。接下来将创建default和clubs别名(虽然不保证创建此对的顺序);那么hearts;和最后spades。
如果在TEST_DEPENDENCIES定义中有任何循环依赖性,则会引发ImproperlyConfigured异常。
警告
此属性是专用API。它可以在未来没有弃用期的情况下更改或删除,例如以适应应用程序加载的更改。
它用于优化Django自己的测试套件,其中包含数百个模型,但在不同应用程序中的模型之间没有关系。
默认情况下,available_apps设置为None。每次测试后,Django调用flush以重置数据库状态。这将清空所有表并发出post_migrate信号,该信号会为每个模型重新创建一个内容类型和三个权限。此操作与模型的数量成比例地变得昂贵。
将available_apps设置为应用程序列表指示Django表现为只有这些应用程序中的模型可用。TransactionTestCase的行为更改如下:
由于数据库未完全刷新,如果测试创建不包含在available_apps中的模型实例,则它们将泄漏,并且可能导致无关的测试失败。注意使用会话的测试;默认会话引擎将它们存储在数据库中。
由于冲洗数据库后不会发出post_migrate,因此在TransactionTestCase之后的状态与TestCase后的状态不同:由侦听器创建的行post_migrate。考虑order in which tests are executed,这不是问题,只要给定测试套件中的TransactionTestCase声明available_apps没有一个。
available_apps在Django自己的测试套件中是必需的。
在TransactionTestCase上设置reset_sequences = True测试运行:
class TestsThatDependsOnPrimaryKeySequences(TransactionTestCase):
reset_sequences = True
def test_animal_pk(self):
lion = Animal.objects.create(name="lion", sound="roar")
# lion.pk is guaranteed to always be 1
self.assertEqual(lion.pk, 1)
除非明确测试主键序列号,否则建议不要在测试中硬编码主键值。
使用reset_sequences = True会降低测试速度,因为主键重置是一个相对昂贵的数据库操作。
如果您正在编写reusable application,您可能需要使用Django测试运行器来运行自己的测试套件,从而从Django测试基础架构中受益。
通常的做法是应用程序代码旁边的tests目录,具有以下结构:
runtests.py
polls/
__init__.py
models.py
...
tests/
__init__.py
models.py
test_settings.py
tests.py
让我们来看看一些这些文件:
#!/usr/bin/env python
import os
import sys
import django
from django.conf import settings
from django.test.utils import get_runner
if __name__ == "__main__":
os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.test_settings'
django.setup()
TestRunner = get_runner(settings)
test_runner = TestRunner()
failures = test_runner.run_tests(["tests"])
sys.exit(bool(failures))
这是您调用以运行测试套件的脚本。它设置Django环境,创建测试数据库并运行测试。
为了清楚起见,此示例仅包含使用Django测试运行器所需的最低限度。您可能需要添加用于控制详细程度的命令行选项,传递特定测试标签以运行等。
SECRET_KEY = 'fake-key'
INSTALLED_APPS = [
"tests",
]
此文件包含运行应用测试所需的Django settings。
同样,这是一个最小的例子;您的测试可能需要额外的设置才能运行。
由于在运行测试时,测试包包含在INSTALLED_APPS中,因此您可以在其models.py文件中定义纯测试模型。
显然,unittest不是唯一的Python测试框架。虽然Django不为替代框架提供显式支持,但它提供了一种方法来调用为替代框架构建的测试,就像他们是正常的Django测试一样。
当您运行./ manage.py 测试时,Django会查看TEST_RUNNER设置来确定要做什么。默认情况下,TEST_RUNNER指向'django.test.runner.DiscoverRunner'。这个类定义了默认的Django测试行为。这种行为包括:
如果您在该类中定义了自己的测试运行器类并指向TEST_RUNNER,则Django将在您运行./ manage.py 测试时运行测试。这样,可以使用可以从Python代码执行的任何测试框架,或者修改Django测试执行过程以满足您可能遇到的任何测试需求。
测试运行器是定义run_tests()方法的类。Django附带一个定义默认Django测试行为的DiscoverRunner类。此类定义了run_tests()入口点,以及run_tests()用来设置,执行和删除测试套件的其他方法。
DiscoverRunner将在符合pattern的任何文件中搜索测试。
top_level可用于指定包含顶级Python模块的目录。通常Django可以自动计算出来,所以没有必要指定这个选项。如果指定,通常应该是包含您的manage.py文件的目录。
verbosity确定将打印到控制台的通知和调试信息量;0为无输出,1为正常输出,2为详细输出。
如果interactive是True,则测试套件有权在执行测试套件时询问用户指示。此行为的一个示例是请求删除现有测试数据库的权限。如果interactive是False,则测试套件必须能够在没有任何手动干预的情况下运行。
如果failfast为True,则在检测到第一个测试失败后,测试套件将停止运行。
如果keepdb是True,测试套件将使用现有数据库,或者如果需要,创建一个。如果False,将创建一个新数据库,提示用户删除现有的数据(如果存在)。
如果reverse是True,测试用例将按相反的顺序执行。这可能有助于调试未正确隔离且具有副作用的测试。使用此选项时,将保留Grouping by test class。
如果debug_sql为True,失败的测试用例将输出记录到django.db.backends logger的SQL查询以及回溯。如果verbosity是2,则输出所有测试中的查询。
Django可以不时地通过添加新的参数来扩展测试运行器的能力。**kwargs声明允许此扩展。如果您子类化DiscoverRunner或编写自己的测试运行器,请确保接受**kwargs。
您的测试运行程序还可以定义其他命令行选项。Create or override an add_arguments(cls, parser) class method and add custom arguments by calling parser.add_argument() inside the method, so that the test command will be able to use those arguments.
以前,您必须向子类化测试运行器提供option_list属性,以向test命令可以使用的命令行选项列表中添加选项。
添加了keepdb,reverse和debug_sql参数。
用于构建测试套件的类。默认情况下,它设置为unittest.TestSuite。如果您希望实现不同的收集测试的逻辑,这可以被覆盖。
这是用于执行单独测试和格式化结果的低级测试运行器的类。默认情况下,它设置为unittest.TextTestRunner。尽管在命名约定中存在不幸的相似性,但这不是与DiscoverRunner相同类型的类,它涵盖了更广泛的职责。您可以覆盖此属性以修改运行和报告测试的方式。
这是加载测试的类,无论是从TestCases或模块或其他方式,并将它们捆绑到测试套件中为跑步者执行。默认情况下,它设置为unittest.defaultTestLoader。如果您的测试将以不寻常的方式加载,您可以覆盖此属性。
这是optparse选项的元组,它将被送入管理命令的OptionParser以解析参数。有关更多详细信息,请参阅Python的optparse模块的文档。
自1.8版起已弃用:您现在应该覆盖add_arguments()类方法以添加由test管理命令接受的自定义参数。
运行测试套件。
test_labels允许您指定要运行的测试并支持多种格式(有关支持的格式的列表,请参阅DiscoverRunner.build_suite())。
extra_tests是要添加到测试运行程序执行的套件中的额外TestCase实例的列表。除了在test_labels中列出的模块中发现的那些测试之外,还运行这些额外的测试。
此方法应返回失败的测试数。
覆盖此类方法以添加由test管理命令接受的自定义参数。请参见argparse.ArgumentParser.add_argument()有关将参数添加到解析器的详细信息。
通过调用setup_test_environment()并将DEBUG设置为False来设置测试环境。
构造与提供的测试标签匹配的测试套件。
test_labels是描述要运行的测试的字符串列表。测试标签可以采用以下四种形式之一:
如果test_labels的值为None,则测试运行器将在名称与其pattern匹配的当前目录下的所有文件中搜索测试以上)。
extra_tests是要添加到测试运行程序执行的套件中的额外TestCase实例的列表。除了在test_labels中列出的模块中发现的那些测试之外,还运行这些额外的测试。
返回准备运行的TestSuite实例。
创建测试数据库。
返回一个数据结构,提供足够的详细信息来撤销已做的更改。在测试结束时,此数据将提供给teardown_databases()函数。
为了帮助创建自己的测试运行器,Django在django.test.utils模块中提供了一些实用程序方法。
数据库后端的创建模块还提供了一些在测试期间可用的实用程序。
创建新的测试数据库,并对其运行migrate。
verbosity具有与run_tests()中相同的行为。
autoclobber描述了如果发现与测试数据库具有相同名称的数据库,则会发生的行为:
serialize确定Django在运行测试之前是否将数据库序列化为内存中的JSON字符串(用于在没有事务的情况下在测试之间恢复数据库状态)。如果您没有任何具有serialized_rollback=True的测试类,您可以将其设置为False以加快创建时间。
keepdb确定测试运行是否应使用现有数据库,或创建一个新的数据库。如果True,则将使用或创建现有数据库(如果不存在)。如果False,将创建一个新数据库,提示用户删除现有的数据(如果存在)。
返回它创建的测试数据库的名称。
create_test_db()具有修改DATABASES中NAME的值的副作用,以匹配测试数据库的名称。
已添加serialize参数。
添加了keepdb参数。
销毁在DATABASES中名称为NAME的值的数据库,并将NAME设置为old_database_name的值。
verbosity参数与DiscoverRunner具有相同的行为。
如果keepdb参数为True,则与数据库的连接将关闭,但数据库不会被销毁。
添加了keepdb参数。
代码覆盖率描述了已经测试了多少源代码。它显示你的代码的哪些部分是由测试和哪些不是。它是测试应用程序的重要组成部分,因此强烈建议检查测试的覆盖率。
Django可以轻松地与coverage.py集成,这是一个用于测量Python程序代码覆盖率的工具。首先,安装coverage.py。接下来,从包含manage.py的项目文件夹中运行以下命令:
coverage run --source='.' manage.py test myapp
这将运行您的测试并收集项目中已执行文件的coverage数据。您可以通过键入以下命令查看此数据的报告:
coverage report
请注意,一些Django代码在运行测试时已执行,但由于传递给上一个命令的source标志,因此未在此处列出。
有关更多选项(如已注释的HTML列表,详细说明错过的行),请参阅coverage.py文档。
2015年5月13日