2012-06-08 00:08:47 +08:00
|
|
|
from __future__ import unicode_literals
|
|
|
|
|
2012-02-01 04:36:11 +08:00
|
|
|
import difflib
|
2013-02-01 01:56:26 +08:00
|
|
|
import errno
|
2012-04-30 01:58:00 +08:00
|
|
|
import json
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
import os
|
2013-06-02 01:24:46 +08:00
|
|
|
import posixpath
|
2013-09-22 21:55:09 +08:00
|
|
|
import socket
|
2010-10-12 11:33:19 +08:00
|
|
|
import sys
|
2013-07-01 20:22:27 +08:00
|
|
|
import threading
|
|
|
|
import unittest
|
2014-04-05 14:04:46 +08:00
|
|
|
import warnings
|
2015-01-28 20:35:27 +08:00
|
|
|
from collections import Counter
|
2015-07-31 03:00:24 +08:00
|
|
|
from contextlib import contextmanager
|
2015-01-28 20:35:27 +08:00
|
|
|
from copy import copy
|
|
|
|
from functools import wraps
|
2013-07-01 20:22:27 +08:00
|
|
|
from unittest.util import safe_repr
|
2007-09-04 08:50:06 +08:00
|
|
|
|
2013-12-24 19:25:17 +08:00
|
|
|
from django.apps import apps
|
2011-07-13 17:35:51 +08:00
|
|
|
from django.conf import settings
|
2007-08-16 14:06:55 +08:00
|
|
|
from django.core import mail
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.core.exceptions import ImproperlyConfigured, ValidationError
|
2015-02-06 18:38:22 +08:00
|
|
|
from django.core.files import locks
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.core.handlers.wsgi import WSGIHandler, get_path_info
|
2007-08-16 14:06:55 +08:00
|
|
|
from django.core.management import call_command
|
2012-07-25 04:24:16 +08:00
|
|
|
from django.core.management.color import no_style
|
2015-02-28 23:02:20 +08:00
|
|
|
from django.core.management.sql import emit_post_migrate_signal
|
2013-09-22 21:55:09 +08:00
|
|
|
from django.core.servers.basehttp import WSGIRequestHandler, WSGIServer
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.db import DEFAULT_DB_ALIAS, connection, connections, transaction
|
2011-08-23 10:32:37 +08:00
|
|
|
from django.forms.fields import CharField
|
2008-07-19 22:46:55 +08:00
|
|
|
from django.http import QueryDict
|
2007-05-05 11:03:33 +08:00
|
|
|
from django.test.client import Client
|
2012-02-01 04:36:11 +08:00
|
|
|
from django.test.html import HTMLParseError, parse_html
|
2013-12-23 07:10:53 +08:00
|
|
|
from django.test.signals import setting_changed, template_rendered
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.test.utils import (
|
|
|
|
CaptureQueriesContext, ContextList, compare_xml, modify_settings,
|
|
|
|
override_settings,
|
|
|
|
)
|
|
|
|
from django.utils import six
|
2015-06-11 04:57:51 +08:00
|
|
|
from django.utils.decorators import classproperty
|
2015-08-19 00:07:13 +08:00
|
|
|
from django.utils.deprecation import RemovedInDjango20Warning
|
2012-08-29 02:59:56 +08:00
|
|
|
from django.utils.encoding import force_text
|
2015-01-28 20:35:27 +08:00
|
|
|
from django.utils.six.moves.urllib.parse import (
|
|
|
|
unquote, urlparse, urlsplit, urlunsplit,
|
|
|
|
)
|
2013-09-06 03:38:59 +08:00
|
|
|
from django.utils.six.moves.urllib.request import url2pathname
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
from django.views.static import serve
|
2010-10-11 20:55:17 +08:00
|
|
|
|
2013-05-28 04:41:39 +08:00
|
|
|
__all__ = ('TestCase', 'TransactionTestCase',
|
2011-08-13 08:42:08 +08:00
|
|
|
'SimpleTestCase', 'skipIfDBFeature', 'skipUnlessDBFeature')
|
2007-05-05 11:03:33 +08:00
|
|
|
|
2013-03-02 04:29:39 +08:00
|
|
|
|
2007-09-04 07:14:51 +08:00
|
|
|
def to_list(value):
|
|
|
|
"""
|
|
|
|
Puts value into a list if it's not already one.
|
|
|
|
Returns an empty list if value is None.
|
|
|
|
"""
|
|
|
|
if value is None:
|
|
|
|
value = []
|
|
|
|
elif not isinstance(value, list):
|
|
|
|
value = [value]
|
|
|
|
return value
|
|
|
|
|
2014-11-11 04:41:35 +08:00
|
|
|
|
2012-02-01 04:36:11 +08:00
|
|
|
def assert_and_parse_html(self, html, user_msg, msg):
|
|
|
|
try:
|
|
|
|
dom = parse_html(html)
|
2012-04-29 00:09:37 +08:00
|
|
|
except HTMLParseError as e:
|
2012-06-08 00:08:47 +08:00
|
|
|
standardMsg = '%s\n%s' % (msg, e.msg)
|
2012-02-01 04:36:11 +08:00
|
|
|
self.fail(self._formatMessage(user_msg, standardMsg))
|
|
|
|
return dom
|
|
|
|
|
|
|
|
|
2013-03-02 04:29:39 +08:00
|
|
|
class _AssertNumQueriesContext(CaptureQueriesContext):
|
2010-10-12 11:33:19 +08:00
|
|
|
def __init__(self, test_case, num, connection):
|
|
|
|
self.test_case = test_case
|
|
|
|
self.num = num
|
2013-03-02 04:29:39 +08:00
|
|
|
super(_AssertNumQueriesContext, self).__init__(connection)
|
2010-10-12 11:33:19 +08:00
|
|
|
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
2013-03-17 17:26:27 +08:00
|
|
|
super(_AssertNumQueriesContext, self).__exit__(exc_type, exc_value, traceback)
|
2010-10-12 11:33:19 +08:00
|
|
|
if exc_type is not None:
|
|
|
|
return
|
2013-03-02 04:29:39 +08:00
|
|
|
executed = len(self)
|
2010-10-12 11:33:19 +08:00
|
|
|
self.test_case.assertEqual(
|
2013-12-09 07:07:04 +08:00
|
|
|
executed, self.num,
|
|
|
|
"%d queries executed, %d expected\nCaptured queries were:\n%s" % (
|
|
|
|
executed, self.num,
|
|
|
|
'\n'.join(
|
|
|
|
query['sql'] for query in self.captured_queries
|
|
|
|
)
|
2010-10-12 11:33:19 +08:00
|
|
|
)
|
|
|
|
)
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2012-02-01 03:23:09 +08:00
|
|
|
class _AssertTemplateUsedContext(object):
|
|
|
|
def __init__(self, test_case, template_name):
|
|
|
|
self.test_case = test_case
|
|
|
|
self.template_name = template_name
|
|
|
|
self.rendered_templates = []
|
|
|
|
self.rendered_template_names = []
|
|
|
|
self.context = ContextList()
|
|
|
|
|
|
|
|
def on_template_render(self, sender, signal, template, context, **kwargs):
|
|
|
|
self.rendered_templates.append(template)
|
|
|
|
self.rendered_template_names.append(template.name)
|
|
|
|
self.context.append(copy(context))
|
|
|
|
|
|
|
|
def test(self):
|
|
|
|
return self.template_name in self.rendered_template_names
|
|
|
|
|
|
|
|
def message(self):
|
2012-06-08 00:08:47 +08:00
|
|
|
return '%s was not rendered.' % self.template_name
|
2012-02-01 03:23:09 +08:00
|
|
|
|
|
|
|
def __enter__(self):
|
|
|
|
template_rendered.connect(self.on_template_render)
|
|
|
|
return self
|
|
|
|
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
|
|
template_rendered.disconnect(self.on_template_render)
|
|
|
|
if exc_type is not None:
|
|
|
|
return
|
2010-10-12 11:33:19 +08:00
|
|
|
|
2012-02-01 03:23:09 +08:00
|
|
|
if not self.test():
|
|
|
|
message = self.message()
|
|
|
|
if len(self.rendered_templates) == 0:
|
2012-06-08 00:08:47 +08:00
|
|
|
message += ' No template was rendered.'
|
2012-02-01 03:23:09 +08:00
|
|
|
else:
|
2012-06-08 00:08:47 +08:00
|
|
|
message += ' Following templates were rendered: %s' % (
|
2012-02-01 03:23:09 +08:00
|
|
|
', '.join(self.rendered_template_names))
|
|
|
|
self.test_case.fail(message)
|
|
|
|
|
|
|
|
|
|
|
|
class _AssertTemplateNotUsedContext(_AssertTemplateUsedContext):
|
|
|
|
def test(self):
|
|
|
|
return self.template_name not in self.rendered_template_names
|
|
|
|
|
|
|
|
def message(self):
|
2012-06-08 00:08:47 +08:00
|
|
|
return '%s was rendered.' % self.template_name
|
2012-02-01 03:23:09 +08:00
|
|
|
|
|
|
|
|
2015-04-17 04:19:30 +08:00
|
|
|
class _CursorFailure(object):
|
|
|
|
def __init__(self, cls_name, wrapped):
|
|
|
|
self.cls_name = cls_name
|
|
|
|
self.wrapped = wrapped
|
|
|
|
|
|
|
|
def __call__(self):
|
|
|
|
raise AssertionError(
|
|
|
|
"Database queries aren't allowed in SimpleTestCase. "
|
|
|
|
"Either use TestCase or TransactionTestCase to ensure proper test isolation or "
|
|
|
|
"set %s.allow_database_queries to True to silence this failure." % self.cls_name
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2013-07-01 20:22:27 +08:00
|
|
|
class SimpleTestCase(unittest.TestCase):
|
2013-02-01 01:56:26 +08:00
|
|
|
|
2013-05-19 06:04:34 +08:00
|
|
|
# The class we'll use for the test client self.client.
|
|
|
|
# Can be overridden in derived classes.
|
|
|
|
client_class = Client
|
2013-12-23 19:39:19 +08:00
|
|
|
_overridden_settings = None
|
|
|
|
_modified_settings = None
|
2013-05-19 06:04:34 +08:00
|
|
|
|
2015-04-17 04:19:30 +08:00
|
|
|
# Tests shouldn't be allowed to query the database since
|
|
|
|
# this base class doesn't enforce any isolation.
|
|
|
|
allow_database_queries = False
|
|
|
|
|
2014-10-19 02:03:10 +08:00
|
|
|
@classmethod
|
|
|
|
def setUpClass(cls):
|
2015-02-06 04:26:54 +08:00
|
|
|
super(SimpleTestCase, cls).setUpClass()
|
2014-10-19 02:03:10 +08:00
|
|
|
if cls._overridden_settings:
|
|
|
|
cls._cls_overridden_context = override_settings(**cls._overridden_settings)
|
|
|
|
cls._cls_overridden_context.enable()
|
|
|
|
if cls._modified_settings:
|
|
|
|
cls._cls_modified_context = modify_settings(cls._modified_settings)
|
|
|
|
cls._cls_modified_context.enable()
|
2015-04-17 04:19:30 +08:00
|
|
|
if not cls.allow_database_queries:
|
|
|
|
for alias in connections:
|
|
|
|
connection = connections[alias]
|
|
|
|
connection.cursor = _CursorFailure(cls.__name__, connection.cursor)
|
2014-10-19 02:03:10 +08:00
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def tearDownClass(cls):
|
2015-04-17 04:19:30 +08:00
|
|
|
if not cls.allow_database_queries:
|
|
|
|
for alias in connections:
|
|
|
|
connection = connections[alias]
|
|
|
|
connection.cursor = connection.cursor.wrapped
|
2014-10-19 02:03:10 +08:00
|
|
|
if hasattr(cls, '_cls_modified_context'):
|
|
|
|
cls._cls_modified_context.disable()
|
|
|
|
delattr(cls, '_cls_modified_context')
|
|
|
|
if hasattr(cls, '_cls_overridden_context'):
|
|
|
|
cls._cls_overridden_context.disable()
|
|
|
|
delattr(cls, '_cls_overridden_context')
|
2015-02-06 04:26:54 +08:00
|
|
|
super(SimpleTestCase, cls).tearDownClass()
|
2014-10-19 02:03:10 +08:00
|
|
|
|
2012-11-25 06:47:41 +08:00
|
|
|
def __call__(self, result=None):
|
|
|
|
"""
|
|
|
|
Wrapper around default __call__ method to perform common Django test
|
|
|
|
set up. This means that user-defined Test Cases aren't required to
|
|
|
|
include a call to super().setUp().
|
|
|
|
"""
|
|
|
|
testMethod = getattr(self, self._testMethodName)
|
|
|
|
skipped = (getattr(self.__class__, "__unittest_skip__", False) or
|
|
|
|
getattr(testMethod, "__unittest_skip__", False))
|
|
|
|
|
|
|
|
if not skipped:
|
|
|
|
try:
|
|
|
|
self._pre_setup()
|
|
|
|
except Exception:
|
|
|
|
result.addError(self, sys.exc_info())
|
|
|
|
return
|
|
|
|
super(SimpleTestCase, self).__call__(result)
|
|
|
|
if not skipped:
|
|
|
|
try:
|
|
|
|
self._post_teardown()
|
|
|
|
except Exception:
|
|
|
|
result.addError(self, sys.exc_info())
|
|
|
|
return
|
|
|
|
|
|
|
|
def _pre_setup(self):
|
2013-05-19 06:04:34 +08:00
|
|
|
"""Performs any pre-test setup. This includes:
|
|
|
|
|
2013-06-12 04:56:09 +08:00
|
|
|
* Creating a test client.
|
|
|
|
* If the class has a 'urls' attribute, replace ROOT_URLCONF with it.
|
|
|
|
* Clearing the mail test outbox.
|
2013-05-19 06:04:34 +08:00
|
|
|
"""
|
|
|
|
self.client = self.client_class()
|
|
|
|
mail.outbox = []
|
|
|
|
|
2012-11-25 06:47:41 +08:00
|
|
|
def _post_teardown(self):
|
2015-08-19 00:07:13 +08:00
|
|
|
"""Perform any post-test things."""
|
|
|
|
pass
|
2012-11-25 06:47:41 +08:00
|
|
|
|
2011-08-13 08:42:08 +08:00
|
|
|
def settings(self, **kwargs):
|
|
|
|
"""
|
2014-04-27 01:18:45 +08:00
|
|
|
A context manager that temporarily sets a setting and reverts to the original value when exiting the context.
|
2011-08-13 08:42:08 +08:00
|
|
|
"""
|
|
|
|
return override_settings(**kwargs)
|
|
|
|
|
2013-12-23 19:39:19 +08:00
|
|
|
def modify_settings(self, **kwargs):
|
|
|
|
"""
|
|
|
|
A context manager that temporarily applies changes a list setting and
|
|
|
|
reverts back to the original value when exiting the context.
|
|
|
|
"""
|
|
|
|
return modify_settings(**kwargs)
|
|
|
|
|
2007-09-04 08:50:06 +08:00
|
|
|
def assertRedirects(self, response, expected_url, status_code=302,
|
2013-09-08 05:13:57 +08:00
|
|
|
target_status_code=200, host=None, msg_prefix='',
|
|
|
|
fetch_redirect_response=True):
|
2007-09-04 08:50:06 +08:00
|
|
|
"""Asserts that a response redirected to a specific URL, and that the
|
2007-05-05 11:03:33 +08:00
|
|
|
redirect URL can be loaded.
|
2007-09-04 08:50:06 +08:00
|
|
|
|
|
|
|
Note that assertRedirects won't work for external links since it uses
|
2013-09-08 05:13:57 +08:00
|
|
|
TestClient to do a request (use fetch_redirect_response=False to check
|
2014-03-31 19:01:13 +08:00
|
|
|
such links without fetching them).
|
2007-05-05 11:03:33 +08:00
|
|
|
"""
|
2015-03-14 06:40:14 +08:00
|
|
|
if host is not None:
|
|
|
|
warnings.warn(
|
|
|
|
"The host argument is deprecated and no longer used by assertRedirects",
|
2015-06-23 01:54:35 +08:00
|
|
|
RemovedInDjango20Warning, stacklevel=2
|
2015-03-14 06:40:14 +08:00
|
|
|
)
|
|
|
|
|
2010-01-22 23:02:02 +08:00
|
|
|
if msg_prefix:
|
|
|
|
msg_prefix += ": "
|
|
|
|
|
2009-02-27 21:14:59 +08:00
|
|
|
if hasattr(response, 'redirect_chain'):
|
|
|
|
# The request was a followed redirect
|
2010-12-04 15:28:12 +08:00
|
|
|
self.assertTrue(len(response.redirect_chain) > 0,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Response didn't redirect as expected: Response"
|
|
|
|
" code was %d (expected %d)" %
|
|
|
|
(response.status_code, status_code))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
|
|
|
self.assertEqual(response.redirect_chain[0][1], status_code,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Initial response didn't redirect as expected:"
|
|
|
|
" Response code was %d (expected %d)" %
|
|
|
|
(response.redirect_chain[0][1], status_code))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
|
|
|
url, status_code = response.redirect_chain[-1]
|
2013-10-29 03:34:09 +08:00
|
|
|
scheme, netloc, path, query, fragment = urlsplit(url)
|
2009-02-27 21:14:59 +08:00
|
|
|
|
|
|
|
self.assertEqual(response.status_code, target_status_code,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Response didn't redirect as expected: Final"
|
|
|
|
" Response code was %d (expected %d)" %
|
|
|
|
(response.status_code, target_status_code))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
|
|
|
else:
|
|
|
|
# Not a followed redirect
|
|
|
|
self.assertEqual(response.status_code, status_code,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Response didn't redirect as expected: Response"
|
|
|
|
" code was %d (expected %d)" %
|
|
|
|
(response.status_code, status_code))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
2013-02-13 16:55:43 +08:00
|
|
|
url = response.url
|
2009-02-27 21:14:59 +08:00
|
|
|
scheme, netloc, path, query, fragment = urlsplit(url)
|
|
|
|
|
2013-09-08 05:13:57 +08:00
|
|
|
if fetch_redirect_response:
|
2013-10-29 03:34:09 +08:00
|
|
|
redirect_response = response.client.get(path, QueryDict(query),
|
|
|
|
secure=(scheme == 'https'))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
2013-09-08 05:13:57 +08:00
|
|
|
# Get the redirection page, using the same client that was used
|
|
|
|
# to obtain the original response.
|
|
|
|
self.assertEqual(redirect_response.status_code, target_status_code,
|
|
|
|
msg_prefix + "Couldn't retrieve redirection page '%s':"
|
|
|
|
" response code was %d (expected %d)" %
|
|
|
|
(path, redirect_response.status_code, target_status_code))
|
2009-02-27 21:14:59 +08:00
|
|
|
|
2015-03-14 06:40:14 +08:00
|
|
|
if url != expected_url:
|
|
|
|
# For temporary backwards compatibility, try to compare with a relative url
|
|
|
|
e_scheme, e_netloc, e_path, e_query, e_fragment = urlsplit(expected_url)
|
|
|
|
relative_url = urlunsplit(('', '', e_path, e_query, e_fragment))
|
|
|
|
if url == relative_url:
|
|
|
|
warnings.warn(
|
|
|
|
"assertRedirects had to strip the scheme and domain from the "
|
|
|
|
"expected URL, as it was always added automatically to URLs "
|
|
|
|
"before Django 1.9. Please update your expected URLs by "
|
|
|
|
"removing the scheme and domain.",
|
2015-06-23 01:54:35 +08:00
|
|
|
RemovedInDjango20Warning, stacklevel=2)
|
2015-03-14 06:40:14 +08:00
|
|
|
expected_url = relative_url
|
2009-02-27 21:14:59 +08:00
|
|
|
|
2007-09-04 08:50:06 +08:00
|
|
|
self.assertEqual(url, expected_url,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Response redirected to '%s', expected '%s'" %
|
|
|
|
(url, expected_url))
|
2007-09-04 08:50:06 +08:00
|
|
|
|
2013-08-23 01:54:26 +08:00
|
|
|
def _assert_contains(self, response, text, status_code, msg_prefix, html):
|
2011-10-22 17:15:50 +08:00
|
|
|
# If the response supports deferred rendering and hasn't been rendered
|
|
|
|
# yet, then ensure that it does get rendered before proceeding further.
|
|
|
|
if (hasattr(response, 'render') and callable(response.render)
|
2013-11-26 17:43:46 +08:00
|
|
|
and not response.is_rendered):
|
2011-10-22 17:15:50 +08:00
|
|
|
response.render()
|
|
|
|
|
2010-01-22 23:02:02 +08:00
|
|
|
if msg_prefix:
|
|
|
|
msg_prefix += ": "
|
|
|
|
|
2007-05-10 19:27:59 +08:00
|
|
|
self.assertEqual(response.status_code, status_code,
|
2010-08-07 00:54:17 +08:00
|
|
|
msg_prefix + "Couldn't retrieve content: Response code was %d"
|
2010-01-22 23:02:02 +08:00
|
|
|
" (expected %d)" % (response.status_code, status_code))
|
2013-04-11 16:36:12 +08:00
|
|
|
|
2012-10-24 17:33:56 +08:00
|
|
|
if response.streaming:
|
|
|
|
content = b''.join(response.streaming_content)
|
|
|
|
else:
|
|
|
|
content = response.content
|
2013-04-11 16:36:12 +08:00
|
|
|
if not isinstance(text, bytes) or html:
|
2013-11-17 01:54:12 +08:00
|
|
|
text = force_text(text, encoding=response.charset)
|
|
|
|
content = content.decode(response.charset)
|
2013-04-13 02:00:49 +08:00
|
|
|
text_repr = "'%s'" % text
|
|
|
|
else:
|
|
|
|
text_repr = repr(text)
|
2012-02-01 04:36:11 +08:00
|
|
|
if html:
|
|
|
|
content = assert_and_parse_html(self, content, None,
|
2012-06-08 00:08:47 +08:00
|
|
|
"Response's content is not valid HTML:")
|
2012-08-14 18:19:17 +08:00
|
|
|
text = assert_and_parse_html(self, text, None,
|
2012-06-08 00:08:47 +08:00
|
|
|
"Second argument is not valid HTML:")
|
2012-08-14 18:19:17 +08:00
|
|
|
real_count = content.count(text)
|
2013-08-23 01:54:26 +08:00
|
|
|
return (text_repr, real_count, msg_prefix)
|
|
|
|
|
|
|
|
def assertContains(self, response, text, count=None, status_code=200,
|
|
|
|
msg_prefix='', html=False):
|
|
|
|
"""
|
|
|
|
Asserts that a response indicates that some content was retrieved
|
|
|
|
successfully, (i.e., the HTTP status code was as expected), and that
|
|
|
|
``text`` occurs ``count`` times in the content of the response.
|
|
|
|
If ``count`` is None, the count doesn't matter - the assertion is true
|
|
|
|
if the text occurs at least once in the response.
|
|
|
|
"""
|
|
|
|
text_repr, real_count, msg_prefix = self._assert_contains(
|
|
|
|
response, text, status_code, msg_prefix, html)
|
|
|
|
|
2007-07-21 12:36:28 +08:00
|
|
|
if count is not None:
|
2007-07-20 22:32:20 +08:00
|
|
|
self.assertEqual(real_count, count,
|
2013-04-13 02:00:49 +08:00
|
|
|
msg_prefix + "Found %d instances of %s in response"
|
|
|
|
" (expected %d)" % (real_count, text_repr, count))
|
2007-07-20 22:32:20 +08:00
|
|
|
else:
|
2010-11-06 08:43:20 +08:00
|
|
|
self.assertTrue(real_count != 0,
|
2013-04-13 02:00:49 +08:00
|
|
|
msg_prefix + "Couldn't find %s in response" % text_repr)
|
2007-09-04 08:50:06 +08:00
|
|
|
|
2010-01-22 23:02:02 +08:00
|
|
|
def assertNotContains(self, response, text, status_code=200,
|
2012-02-01 04:36:11 +08:00
|
|
|
msg_prefix='', html=False):
|
2008-06-06 21:50:02 +08:00
|
|
|
"""
|
2010-08-07 00:54:17 +08:00
|
|
|
Asserts that a response indicates that some content was retrieved
|
2008-06-06 21:50:02 +08:00
|
|
|
successfully, (i.e., the HTTP status code was as expected), and that
|
|
|
|
``text`` doesn't occurs in the content of the response.
|
|
|
|
"""
|
2013-08-23 01:54:26 +08:00
|
|
|
text_repr, real_count, msg_prefix = self._assert_contains(
|
|
|
|
response, text, status_code, msg_prefix, html)
|
2011-10-22 17:15:50 +08:00
|
|
|
|
2013-08-23 01:54:26 +08:00
|
|
|
self.assertEqual(real_count, 0,
|
|
|
|
msg_prefix + "Response should not contain %s" % text_repr)
|
2008-06-06 21:50:02 +08:00
|
|
|
|
2010-01-22 23:02:02 +08:00
|
|
|
def assertFormError(self, response, form, field, errors, msg_prefix=''):
|
2007-09-04 08:50:06 +08:00
|
|
|
"""
|
|
|
|
Asserts that a form used to render the response has a specific field
|
|
|
|
error.
|
|
|
|
"""
|
2010-01-22 23:02:02 +08:00
|
|
|
if msg_prefix:
|
|
|
|
msg_prefix += ": "
|
|
|
|
|
2007-09-04 07:14:51 +08:00
|
|
|
# Put context(s) into a list to simplify processing.
|
2007-09-04 08:50:06 +08:00
|
|
|
contexts = to_list(response.context)
|
2007-09-04 07:14:51 +08:00
|
|
|
if not contexts:
|
2010-02-13 19:59:09 +08:00
|
|
|
self.fail(msg_prefix + "Response did not use any contexts to "
|
2010-01-22 23:02:02 +08:00
|
|
|
"render the response")
|
2007-05-07 20:34:18 +08:00
|
|
|
|
2007-09-04 07:14:51 +08:00
|
|
|
# Put error(s) into a list to simplify processing.
|
|
|
|
errors = to_list(errors)
|
2007-09-04 08:50:06 +08:00
|
|
|
|
2007-05-07 20:34:18 +08:00
|
|
|
# Search all contexts for the error.
|
|
|
|
found_form = False
|
2013-10-27 01:50:40 +08:00
|
|
|
for i, context in enumerate(contexts):
|
2007-09-04 08:50:06 +08:00
|
|
|
if form not in context:
|
|
|
|
continue
|
|
|
|
found_form = True
|
|
|
|
for err in errors:
|
|
|
|
if field:
|
|
|
|
if field in context[form].errors:
|
|
|
|
field_errors = context[form].errors[field]
|
2010-12-04 15:28:12 +08:00
|
|
|
self.assertTrue(err in field_errors,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "The field '%s' on form '%s' in"
|
|
|
|
" context %d does not contain the error '%s'"
|
|
|
|
" (actual errors: %s)" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(field, form, i, err, repr(field_errors)))
|
2007-09-04 08:50:06 +08:00
|
|
|
elif field in context[form].fields:
|
2010-01-22 23:02:02 +08:00
|
|
|
self.fail(msg_prefix + "The field '%s' on form '%s'"
|
|
|
|
" in context %d contains no errors" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(field, form, i))
|
2007-05-10 21:48:18 +08:00
|
|
|
else:
|
2010-01-22 23:02:02 +08:00
|
|
|
self.fail(msg_prefix + "The form '%s' in context %d"
|
|
|
|
" does not contain the field '%s'" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(form, i, field))
|
2007-09-04 08:50:06 +08:00
|
|
|
else:
|
|
|
|
non_field_errors = context[form].non_field_errors()
|
2010-12-04 15:28:12 +08:00
|
|
|
self.assertTrue(err in non_field_errors,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "The form '%s' in context %d does not"
|
|
|
|
" contain the non-field error '%s'"
|
|
|
|
" (actual errors: %s)" %
|
2007-09-04 08:50:06 +08:00
|
|
|
(form, i, err, non_field_errors))
|
2007-05-07 20:34:18 +08:00
|
|
|
if not found_form:
|
2010-01-22 23:02:02 +08:00
|
|
|
self.fail(msg_prefix + "The form '%s' was not used to render the"
|
|
|
|
" response" % form)
|
2007-09-04 08:50:06 +08:00
|
|
|
|
2013-02-09 07:45:26 +08:00
|
|
|
def assertFormsetError(self, response, formset, form_index, field, errors,
|
|
|
|
msg_prefix=''):
|
|
|
|
"""
|
|
|
|
Asserts that a formset used to render the response has a specific error.
|
|
|
|
|
|
|
|
For field errors, specify the ``form_index`` and the ``field``.
|
|
|
|
For non-field errors, specify the ``form_index`` and the ``field`` as
|
|
|
|
None.
|
|
|
|
For non-form errors, specify ``form_index`` as None and the ``field``
|
|
|
|
as None.
|
|
|
|
"""
|
|
|
|
# Add punctuation to msg_prefix
|
|
|
|
if msg_prefix:
|
|
|
|
msg_prefix += ": "
|
|
|
|
|
|
|
|
# Put context(s) into a list to simplify processing.
|
|
|
|
contexts = to_list(response.context)
|
|
|
|
if not contexts:
|
|
|
|
self.fail(msg_prefix + 'Response did not use any contexts to '
|
|
|
|
'render the response')
|
|
|
|
|
|
|
|
# Put error(s) into a list to simplify processing.
|
|
|
|
errors = to_list(errors)
|
|
|
|
|
|
|
|
# Search all contexts for the error.
|
|
|
|
found_formset = False
|
|
|
|
for i, context in enumerate(contexts):
|
|
|
|
if formset not in context:
|
|
|
|
continue
|
|
|
|
found_formset = True
|
|
|
|
for err in errors:
|
|
|
|
if field is not None:
|
|
|
|
if field in context[formset].forms[form_index].errors:
|
|
|
|
field_errors = context[formset].forms[form_index].errors[field]
|
|
|
|
self.assertTrue(err in field_errors,
|
|
|
|
msg_prefix + "The field '%s' on formset '%s', "
|
|
|
|
"form %d in context %d does not contain the "
|
|
|
|
"error '%s' (actual errors: %s)" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(field, formset, form_index, i, err,
|
|
|
|
repr(field_errors)))
|
2013-02-09 07:45:26 +08:00
|
|
|
elif field in context[formset].forms[form_index].fields:
|
|
|
|
self.fail(msg_prefix + "The field '%s' "
|
|
|
|
"on formset '%s', form %d in "
|
|
|
|
"context %d contains no errors" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(field, formset, form_index, i))
|
2013-02-09 07:45:26 +08:00
|
|
|
else:
|
|
|
|
self.fail(msg_prefix + "The formset '%s', form %d in "
|
2013-12-13 04:23:24 +08:00
|
|
|
"context %d does not contain the field '%s'" %
|
|
|
|
(formset, form_index, i, field))
|
2013-02-09 07:45:26 +08:00
|
|
|
elif form_index is not None:
|
|
|
|
non_field_errors = context[formset].forms[form_index].non_field_errors()
|
|
|
|
self.assertFalse(len(non_field_errors) == 0,
|
2013-12-13 04:23:24 +08:00
|
|
|
msg_prefix + "The formset '%s', form %d in "
|
|
|
|
"context %d does not contain any non-field "
|
|
|
|
"errors." % (formset, form_index, i))
|
2013-02-09 07:45:26 +08:00
|
|
|
self.assertTrue(err in non_field_errors,
|
|
|
|
msg_prefix + "The formset '%s', form %d "
|
|
|
|
"in context %d does not contain the "
|
|
|
|
"non-field error '%s' "
|
|
|
|
"(actual errors: %s)" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(formset, form_index, i, err,
|
|
|
|
repr(non_field_errors)))
|
2013-02-09 07:45:26 +08:00
|
|
|
else:
|
|
|
|
non_form_errors = context[formset].non_form_errors()
|
|
|
|
self.assertFalse(len(non_form_errors) == 0,
|
|
|
|
msg_prefix + "The formset '%s' in "
|
|
|
|
"context %d does not contain any "
|
|
|
|
"non-form errors." % (formset, i))
|
|
|
|
self.assertTrue(err in non_form_errors,
|
|
|
|
msg_prefix + "The formset '%s' in context "
|
|
|
|
"%d does not contain the "
|
|
|
|
"non-form error '%s' (actual errors: %s)" %
|
2013-12-13 04:23:24 +08:00
|
|
|
(formset, i, err, repr(non_form_errors)))
|
2013-02-09 07:45:26 +08:00
|
|
|
if not found_formset:
|
|
|
|
self.fail(msg_prefix + "The formset '%s' was not used to render "
|
|
|
|
"the response" % formset)
|
|
|
|
|
2013-08-23 01:54:26 +08:00
|
|
|
def _assert_template_used(self, response, template_name, msg_prefix):
|
|
|
|
|
2012-02-01 03:23:09 +08:00
|
|
|
if response is None and template_name is None:
|
2012-06-08 00:08:47 +08:00
|
|
|
raise TypeError('response and/or template_name argument must be provided')
|
2012-02-01 03:23:09 +08:00
|
|
|
|
2010-01-22 23:02:02 +08:00
|
|
|
if msg_prefix:
|
|
|
|
msg_prefix += ": "
|
|
|
|
|
2014-10-12 00:53:29 +08:00
|
|
|
if template_name is not None and response is not None and not hasattr(response, 'templates'):
|
|
|
|
raise ValueError(
|
|
|
|
"assertTemplateUsed() and assertTemplateNotUsed() are only "
|
|
|
|
"usable on responses fetched using the Django test Client."
|
|
|
|
)
|
|
|
|
|
2012-02-01 03:23:09 +08:00
|
|
|
if not hasattr(response, 'templates') or (response is None and template_name):
|
|
|
|
if response:
|
|
|
|
template_name = response
|
|
|
|
response = None
|
2013-08-23 01:54:26 +08:00
|
|
|
# use this template with context manager
|
|
|
|
return template_name, None, msg_prefix
|
2012-02-01 03:23:09 +08:00
|
|
|
|
2013-11-04 23:50:14 +08:00
|
|
|
template_names = [t.name for t in response.templates if t.name is not
|
|
|
|
None]
|
2013-08-23 01:54:26 +08:00
|
|
|
return None, template_names, msg_prefix
|
|
|
|
|
2014-04-15 03:13:49 +08:00
|
|
|
def assertTemplateUsed(self, response=None, template_name=None, msg_prefix='', count=None):
|
2013-08-23 01:54:26 +08:00
|
|
|
"""
|
|
|
|
Asserts that the template with the provided name was used in rendering
|
|
|
|
the response. Also usable as context manager.
|
|
|
|
"""
|
|
|
|
context_mgr_template, template_names, msg_prefix = self._assert_template_used(
|
|
|
|
response, template_name, msg_prefix)
|
|
|
|
|
|
|
|
if context_mgr_template:
|
|
|
|
# Use assertTemplateUsed as context manager.
|
|
|
|
return _AssertTemplateUsedContext(self, context_mgr_template)
|
|
|
|
|
2007-09-04 07:14:51 +08:00
|
|
|
if not template_names:
|
2010-01-22 23:02:02 +08:00
|
|
|
self.fail(msg_prefix + "No templates used to render the response")
|
2010-12-04 15:28:12 +08:00
|
|
|
self.assertTrue(template_name in template_names,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Template '%s' was not a template used to render"
|
|
|
|
" the response. Actual template(s) used: %s" %
|
2012-06-08 00:08:47 +08:00
|
|
|
(template_name, ', '.join(template_names)))
|
2007-05-07 20:34:18 +08:00
|
|
|
|
2014-04-15 03:13:49 +08:00
|
|
|
if count is not None:
|
|
|
|
self.assertEqual(template_names.count(template_name), count,
|
|
|
|
msg_prefix + "Template '%s' was expected to be rendered %d "
|
|
|
|
"time(s) but was actually rendered %d time(s)." %
|
|
|
|
(template_name, count, template_names.count(template_name)))
|
|
|
|
|
2012-02-01 03:23:09 +08:00
|
|
|
def assertTemplateNotUsed(self, response=None, template_name=None, msg_prefix=''):
|
2007-09-04 08:50:06 +08:00
|
|
|
"""
|
|
|
|
Asserts that the template with the provided name was NOT used in
|
2012-02-04 04:45:45 +08:00
|
|
|
rendering the response. Also usable as context manager.
|
2007-09-04 08:50:06 +08:00
|
|
|
"""
|
2012-02-01 03:23:09 +08:00
|
|
|
|
2013-08-23 01:54:26 +08:00
|
|
|
context_mgr_template, template_names, msg_prefix = self._assert_template_used(
|
|
|
|
response, template_name, msg_prefix)
|
2010-01-22 23:02:02 +08:00
|
|
|
|
2013-08-23 01:54:26 +08:00
|
|
|
if context_mgr_template:
|
|
|
|
# Use assertTemplateNotUsed as context manager.
|
|
|
|
return _AssertTemplateNotUsedContext(self, context_mgr_template)
|
2012-02-01 03:23:09 +08:00
|
|
|
|
2010-12-04 15:28:12 +08:00
|
|
|
self.assertFalse(template_name in template_names,
|
2010-01-22 23:02:02 +08:00
|
|
|
msg_prefix + "Template '%s' was used unexpectedly in rendering"
|
|
|
|
" the response" % template_name)
|
2009-01-16 10:30:22 +08:00
|
|
|
|
2015-07-31 03:00:24 +08:00
|
|
|
@contextmanager
|
|
|
|
def _assert_raises_message_cm(self, expected_exception, expected_message):
|
|
|
|
with self.assertRaises(expected_exception) as cm:
|
|
|
|
yield cm
|
|
|
|
self.assertIn(expected_message, str(cm.exception))
|
|
|
|
|
2015-05-10 07:13:05 +08:00
|
|
|
def assertRaisesMessage(self, expected_exception, expected_message, *args, **kwargs):
|
2013-05-19 06:04:34 +08:00
|
|
|
"""
|
2015-07-31 03:00:24 +08:00
|
|
|
Asserts that expected_message is found in the the message of a raised
|
|
|
|
exception.
|
2013-05-19 06:04:34 +08:00
|
|
|
|
|
|
|
Args:
|
|
|
|
expected_exception: Exception class expected to be raised.
|
|
|
|
expected_message: expected error message string value.
|
2015-05-10 07:13:05 +08:00
|
|
|
args: Function to be called and extra positional args.
|
2013-05-19 06:04:34 +08:00
|
|
|
kwargs: Extra kwargs.
|
|
|
|
"""
|
2015-05-18 07:09:30 +08:00
|
|
|
# callable_obj was a documented kwarg in Django 1.8 and older.
|
|
|
|
callable_obj = kwargs.pop('callable_obj', None)
|
|
|
|
if callable_obj:
|
2015-07-29 23:12:07 +08:00
|
|
|
warnings.warn(
|
|
|
|
'The callable_obj kwarg is deprecated. Pass the callable '
|
|
|
|
'as a positional argument instead.', RemovedInDjango20Warning
|
|
|
|
)
|
2015-07-31 03:00:24 +08:00
|
|
|
elif len(args):
|
|
|
|
callable_obj = args[0]
|
|
|
|
args = args[1:]
|
|
|
|
|
|
|
|
cm = self._assert_raises_message_cm(expected_exception, expected_message)
|
|
|
|
# Assertion used in context manager fashion.
|
|
|
|
if callable_obj is None:
|
|
|
|
return cm
|
|
|
|
# Assertion was passed a callable.
|
|
|
|
with cm:
|
|
|
|
callable_obj(*args, **kwargs)
|
2013-05-19 06:04:34 +08:00
|
|
|
|
|
|
|
def assertFieldOutput(self, fieldclass, valid, invalid, field_args=None,
|
|
|
|
field_kwargs=None, empty_value=''):
|
|
|
|
"""
|
|
|
|
Asserts that a form field behaves correctly with various inputs.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
fieldclass: the class of the field to be tested.
|
|
|
|
valid: a dictionary mapping valid inputs to their expected
|
|
|
|
cleaned values.
|
|
|
|
invalid: a dictionary mapping invalid inputs to one or more
|
|
|
|
raised error messages.
|
|
|
|
field_args: the args passed to instantiate the field
|
|
|
|
field_kwargs: the kwargs passed to instantiate the field
|
|
|
|
empty_value: the expected clean output for inputs in empty_values
|
|
|
|
"""
|
|
|
|
if field_args is None:
|
|
|
|
field_args = []
|
|
|
|
if field_kwargs is None:
|
|
|
|
field_kwargs = {}
|
|
|
|
required = fieldclass(*field_args, **field_kwargs)
|
|
|
|
optional = fieldclass(*field_args,
|
|
|
|
**dict(field_kwargs, required=False))
|
|
|
|
# test valid inputs
|
|
|
|
for input, output in valid.items():
|
|
|
|
self.assertEqual(required.clean(input), output)
|
|
|
|
self.assertEqual(optional.clean(input), output)
|
|
|
|
# test invalid inputs
|
|
|
|
for input, errors in invalid.items():
|
|
|
|
with self.assertRaises(ValidationError) as context_manager:
|
|
|
|
required.clean(input)
|
|
|
|
self.assertEqual(context_manager.exception.messages, errors)
|
|
|
|
|
|
|
|
with self.assertRaises(ValidationError) as context_manager:
|
|
|
|
optional.clean(input)
|
|
|
|
self.assertEqual(context_manager.exception.messages, errors)
|
|
|
|
# test required inputs
|
|
|
|
error_required = [force_text(required.error_messages['required'])]
|
|
|
|
for e in required.empty_values:
|
|
|
|
with self.assertRaises(ValidationError) as context_manager:
|
|
|
|
required.clean(e)
|
|
|
|
self.assertEqual(context_manager.exception.messages,
|
|
|
|
error_required)
|
|
|
|
self.assertEqual(optional.clean(e), empty_value)
|
|
|
|
# test that max_length and min_length are always accepted
|
|
|
|
if issubclass(fieldclass, CharField):
|
2013-10-27 01:50:40 +08:00
|
|
|
field_kwargs.update({'min_length': 2, 'max_length': 20})
|
2014-04-10 04:20:22 +08:00
|
|
|
self.assertIsInstance(fieldclass(*field_args, **field_kwargs),
|
|
|
|
fieldclass)
|
2013-05-19 06:04:34 +08:00
|
|
|
|
|
|
|
def assertHTMLEqual(self, html1, html2, msg=None):
|
|
|
|
"""
|
|
|
|
Asserts that two HTML snippets are semantically the same.
|
|
|
|
Whitespace in most cases is ignored, and attribute ordering is not
|
|
|
|
significant. The passed-in arguments must be valid HTML.
|
|
|
|
"""
|
|
|
|
dom1 = assert_and_parse_html(self, html1, msg,
|
|
|
|
'First argument is not valid HTML:')
|
|
|
|
dom2 = assert_and_parse_html(self, html2, msg,
|
|
|
|
'Second argument is not valid HTML:')
|
|
|
|
|
|
|
|
if dom1 != dom2:
|
|
|
|
standardMsg = '%s != %s' % (
|
|
|
|
safe_repr(dom1, True), safe_repr(dom2, True))
|
|
|
|
diff = ('\n' + '\n'.join(difflib.ndiff(
|
|
|
|
six.text_type(dom1).splitlines(),
|
|
|
|
six.text_type(dom2).splitlines())))
|
|
|
|
standardMsg = self._truncateMessage(standardMsg, diff)
|
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
|
|
|
|
def assertHTMLNotEqual(self, html1, html2, msg=None):
|
|
|
|
"""Asserts that two HTML snippets are not semantically equivalent."""
|
|
|
|
dom1 = assert_and_parse_html(self, html1, msg,
|
|
|
|
'First argument is not valid HTML:')
|
|
|
|
dom2 = assert_and_parse_html(self, html2, msg,
|
|
|
|
'Second argument is not valid HTML:')
|
|
|
|
|
|
|
|
if dom1 == dom2:
|
|
|
|
standardMsg = '%s == %s' % (
|
|
|
|
safe_repr(dom1, True), safe_repr(dom2, True))
|
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
|
|
|
|
def assertInHTML(self, needle, haystack, count=None, msg_prefix=''):
|
|
|
|
needle = assert_and_parse_html(self, needle, None,
|
|
|
|
'First argument is not valid HTML:')
|
|
|
|
haystack = assert_and_parse_html(self, haystack, None,
|
|
|
|
'Second argument is not valid HTML:')
|
|
|
|
real_count = haystack.count(needle)
|
|
|
|
if count is not None:
|
|
|
|
self.assertEqual(real_count, count,
|
|
|
|
msg_prefix + "Found %d instances of '%s' in response"
|
|
|
|
" (expected %d)" % (real_count, needle, count))
|
|
|
|
else:
|
|
|
|
self.assertTrue(real_count != 0,
|
|
|
|
msg_prefix + "Couldn't find '%s' in response" % needle)
|
|
|
|
|
|
|
|
def assertJSONEqual(self, raw, expected_data, msg=None):
|
2014-04-17 17:44:30 +08:00
|
|
|
"""
|
|
|
|
Asserts that the JSON fragments raw and expected_data are equal.
|
|
|
|
Usual JSON non-significant whitespace rules apply as the heavyweight
|
|
|
|
is delegated to the json library.
|
|
|
|
"""
|
2013-05-19 06:04:34 +08:00
|
|
|
try:
|
|
|
|
data = json.loads(raw)
|
|
|
|
except ValueError:
|
|
|
|
self.fail("First argument is not valid JSON: %r" % raw)
|
|
|
|
if isinstance(expected_data, six.string_types):
|
|
|
|
try:
|
|
|
|
expected_data = json.loads(expected_data)
|
|
|
|
except ValueError:
|
|
|
|
self.fail("Second argument is not valid JSON: %r" % expected_data)
|
|
|
|
self.assertEqual(data, expected_data, msg=msg)
|
|
|
|
|
2014-04-17 17:44:30 +08:00
|
|
|
def assertJSONNotEqual(self, raw, expected_data, msg=None):
|
|
|
|
"""
|
|
|
|
Asserts that the JSON fragments raw and expected_data are not equal.
|
|
|
|
Usual JSON non-significant whitespace rules apply as the heavyweight
|
|
|
|
is delegated to the json library.
|
|
|
|
"""
|
|
|
|
try:
|
|
|
|
data = json.loads(raw)
|
|
|
|
except ValueError:
|
|
|
|
self.fail("First argument is not valid JSON: %r" % raw)
|
|
|
|
if isinstance(expected_data, six.string_types):
|
|
|
|
try:
|
|
|
|
expected_data = json.loads(expected_data)
|
|
|
|
except ValueError:
|
|
|
|
self.fail("Second argument is not valid JSON: %r" % expected_data)
|
|
|
|
self.assertNotEqual(data, expected_data, msg=msg)
|
|
|
|
|
2013-05-19 06:04:34 +08:00
|
|
|
def assertXMLEqual(self, xml1, xml2, msg=None):
|
|
|
|
"""
|
|
|
|
Asserts that two XML snippets are semantically the same.
|
|
|
|
Whitespace in most cases is ignored, and attribute ordering is not
|
|
|
|
significant. The passed-in arguments must be valid XML.
|
|
|
|
"""
|
|
|
|
try:
|
|
|
|
result = compare_xml(xml1, xml2)
|
|
|
|
except Exception as e:
|
|
|
|
standardMsg = 'First or second argument is not valid XML\n%s' % e
|
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
else:
|
|
|
|
if not result:
|
|
|
|
standardMsg = '%s != %s' % (safe_repr(xml1, True), safe_repr(xml2, True))
|
2015-08-03 04:07:31 +08:00
|
|
|
diff = ('\n' + '\n'.join(
|
|
|
|
difflib.ndiff(
|
|
|
|
six.text_type(xml1).splitlines(),
|
|
|
|
six.text_type(xml2).splitlines(),
|
|
|
|
)
|
|
|
|
))
|
|
|
|
standardMsg = self._truncateMessage(standardMsg, diff)
|
2013-05-19 06:04:34 +08:00
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
|
|
|
|
def assertXMLNotEqual(self, xml1, xml2, msg=None):
|
|
|
|
"""
|
|
|
|
Asserts that two XML snippets are not semantically equivalent.
|
|
|
|
Whitespace in most cases is ignored, and attribute ordering is not
|
|
|
|
significant. The passed-in arguments must be valid XML.
|
|
|
|
"""
|
|
|
|
try:
|
|
|
|
result = compare_xml(xml1, xml2)
|
|
|
|
except Exception as e:
|
|
|
|
standardMsg = 'First or second argument is not valid XML\n%s' % e
|
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
else:
|
|
|
|
if result:
|
|
|
|
standardMsg = '%s == %s' % (safe_repr(xml1, True), safe_repr(xml2, True))
|
|
|
|
self.fail(self._formatMessage(msg, standardMsg))
|
|
|
|
|
|
|
|
|
|
|
|
class TransactionTestCase(SimpleTestCase):
|
|
|
|
|
|
|
|
# Subclasses can ask for resetting of auto increment sequence before each
|
|
|
|
# test case
|
|
|
|
reset_sequences = False
|
|
|
|
|
2013-06-04 14:13:36 +08:00
|
|
|
# Subclasses can enable only a subset of apps for faster tests
|
|
|
|
available_apps = None
|
|
|
|
|
2013-09-11 21:20:15 +08:00
|
|
|
# Subclasses can define fixtures which will be automatically installed.
|
|
|
|
fixtures = None
|
|
|
|
|
2014-06-09 10:30:15 +08:00
|
|
|
# If transactions aren't available, Django will serialize the database
|
|
|
|
# contents into a fixture during setup and flush and reload them
|
|
|
|
# during teardown (as flush does not restore data from migrations).
|
|
|
|
# This can be slow; this flag allows enabling on a per-case basis.
|
|
|
|
serialized_rollback = False
|
|
|
|
|
2015-04-17 04:19:30 +08:00
|
|
|
# Since tests will be wrapped in a transaction, or serialized if they
|
|
|
|
# are not available, we allow queries to be run.
|
|
|
|
allow_database_queries = True
|
|
|
|
|
2013-05-19 06:04:34 +08:00
|
|
|
def _pre_setup(self):
|
|
|
|
"""Performs any pre-test setup. This includes:
|
|
|
|
|
2013-06-12 04:56:09 +08:00
|
|
|
* If the class has an 'available_apps' attribute, restricting the app
|
2013-12-24 19:25:17 +08:00
|
|
|
registry to these applications, then firing post_migrate -- it must
|
|
|
|
run with the correct set of applications for the test case.
|
2013-06-12 04:56:09 +08:00
|
|
|
* If the class has a 'fixtures' attribute, installing these fixtures.
|
2013-05-19 06:04:34 +08:00
|
|
|
"""
|
|
|
|
super(TransactionTestCase, self)._pre_setup()
|
2013-06-04 14:13:36 +08:00
|
|
|
if self.available_apps is not None:
|
2013-12-24 19:25:17 +08:00
|
|
|
apps.set_available_apps(self.available_apps)
|
2013-12-23 07:10:53 +08:00
|
|
|
setting_changed.send(sender=settings._wrapped.__class__,
|
|
|
|
setting='INSTALLED_APPS',
|
|
|
|
value=self.available_apps,
|
|
|
|
enter=True)
|
2013-06-12 04:56:09 +08:00
|
|
|
for db_name in self._databases_names(include_mirrors=False):
|
2015-02-28 23:02:20 +08:00
|
|
|
emit_post_migrate_signal(verbosity=0, interactive=False, db=db_name)
|
2013-06-04 14:13:36 +08:00
|
|
|
try:
|
|
|
|
self._fixture_setup()
|
|
|
|
except Exception:
|
|
|
|
if self.available_apps is not None:
|
2013-12-24 19:25:17 +08:00
|
|
|
apps.unset_available_apps()
|
2013-12-23 07:10:53 +08:00
|
|
|
setting_changed.send(sender=settings._wrapped.__class__,
|
|
|
|
setting='INSTALLED_APPS',
|
|
|
|
value=settings.INSTALLED_APPS,
|
|
|
|
enter=False)
|
|
|
|
|
2013-06-04 14:13:36 +08:00
|
|
|
raise
|
2013-05-19 06:04:34 +08:00
|
|
|
|
2014-10-19 05:01:13 +08:00
|
|
|
@classmethod
|
|
|
|
def _databases_names(cls, include_mirrors=True):
|
2013-05-19 06:04:34 +08:00
|
|
|
# If the test case has a multi_db=True flag, act on all databases,
|
|
|
|
# including mirrors or not. Otherwise, just on the default DB.
|
2014-10-19 05:01:13 +08:00
|
|
|
if getattr(cls, 'multi_db', False):
|
2013-05-19 06:04:34 +08:00
|
|
|
return [alias for alias in connections
|
2014-01-20 08:45:29 +08:00
|
|
|
if include_mirrors or not connections[alias].settings_dict['TEST']['MIRROR']]
|
2013-05-19 06:04:34 +08:00
|
|
|
else:
|
|
|
|
return [DEFAULT_DB_ALIAS]
|
|
|
|
|
|
|
|
def _reset_sequences(self, db_name):
|
|
|
|
conn = connections[db_name]
|
|
|
|
if conn.features.supports_sequence_reset:
|
2013-09-22 20:01:57 +08:00
|
|
|
sql_list = conn.ops.sequence_reset_by_name_sql(
|
2013-10-20 07:33:10 +08:00
|
|
|
no_style(), conn.introspection.sequence_list())
|
2013-05-19 06:04:34 +08:00
|
|
|
if sql_list:
|
2014-03-21 21:21:43 +08:00
|
|
|
with transaction.atomic(using=db_name):
|
2013-05-19 06:04:34 +08:00
|
|
|
cursor = conn.cursor()
|
|
|
|
for sql in sql_list:
|
|
|
|
cursor.execute(sql)
|
|
|
|
|
|
|
|
def _fixture_setup(self):
|
|
|
|
for db_name in self._databases_names(include_mirrors=False):
|
|
|
|
# Reset sequences
|
|
|
|
if self.reset_sequences:
|
|
|
|
self._reset_sequences(db_name)
|
|
|
|
|
2014-06-09 10:30:15 +08:00
|
|
|
# If we need to provide replica initial data from migrated apps,
|
|
|
|
# then do so.
|
|
|
|
if self.serialized_rollback and hasattr(connections[db_name], "_test_serialized_contents"):
|
|
|
|
if self.available_apps is not None:
|
|
|
|
apps.unset_available_apps()
|
|
|
|
connections[db_name].creation.deserialize_db_from_string(
|
|
|
|
connections[db_name]._test_serialized_contents
|
|
|
|
)
|
|
|
|
if self.available_apps is not None:
|
|
|
|
apps.set_available_apps(self.available_apps)
|
|
|
|
|
2013-09-11 21:20:15 +08:00
|
|
|
if self.fixtures:
|
2013-05-19 06:04:34 +08:00
|
|
|
# We have to use this slightly awkward syntax due to the fact
|
|
|
|
# that we're using *args and **kwargs together.
|
|
|
|
call_command('loaddata', *self.fixtures,
|
2014-10-20 03:25:09 +08:00
|
|
|
**{'verbosity': 0, 'database': db_name})
|
2013-05-19 06:04:34 +08:00
|
|
|
|
2014-10-19 05:01:13 +08:00
|
|
|
def _should_reload_connections(self):
|
|
|
|
return True
|
|
|
|
|
2013-05-19 06:04:34 +08:00
|
|
|
def _post_teardown(self):
|
|
|
|
"""Performs any post-test things. This includes:
|
|
|
|
|
2013-06-12 04:56:09 +08:00
|
|
|
* Flushing the contents of the database, to leave a clean slate. If
|
2013-07-30 18:52:52 +08:00
|
|
|
the class has an 'available_apps' attribute, post_migrate isn't fired.
|
2013-06-12 04:56:09 +08:00
|
|
|
* Force-closing the connection, so the next test gets a clean cursor.
|
2013-05-19 06:04:34 +08:00
|
|
|
"""
|
2013-06-04 14:13:36 +08:00
|
|
|
try:
|
|
|
|
self._fixture_teardown()
|
|
|
|
super(TransactionTestCase, self)._post_teardown()
|
2014-10-19 05:01:13 +08:00
|
|
|
if self._should_reload_connections():
|
|
|
|
# Some DB cursors include SQL statements as part of cursor
|
|
|
|
# creation. If you have a test that does a rollback, the effect
|
|
|
|
# of these statements is lost, which can affect the operation of
|
|
|
|
# tests (e.g., losing a timezone setting causing objects to be
|
|
|
|
# created with the wrong time). To make sure this doesn't
|
|
|
|
# happen, get a clean connection at the start of every test.
|
|
|
|
for conn in connections.all():
|
|
|
|
conn.close()
|
2013-06-04 14:13:36 +08:00
|
|
|
finally:
|
2013-12-23 07:10:53 +08:00
|
|
|
if self.available_apps is not None:
|
2013-12-24 19:25:17 +08:00
|
|
|
apps.unset_available_apps()
|
2013-12-23 07:10:53 +08:00
|
|
|
setting_changed.send(sender=settings._wrapped.__class__,
|
|
|
|
setting='INSTALLED_APPS',
|
|
|
|
value=settings.INSTALLED_APPS,
|
|
|
|
enter=False)
|
2013-05-19 06:04:34 +08:00
|
|
|
|
|
|
|
def _fixture_teardown(self):
|
2013-07-30 18:52:52 +08:00
|
|
|
# Allow TRUNCATE ... CASCADE and don't emit the post_migrate signal
|
2013-06-12 04:56:09 +08:00
|
|
|
# when flushing only a subset of the apps
|
2013-05-19 06:04:34 +08:00
|
|
|
for db_name in self._databases_names(include_mirrors=False):
|
2014-06-09 10:30:15 +08:00
|
|
|
# Flush the database
|
2015-04-14 22:43:57 +08:00
|
|
|
inhibit_post_migrate = (
|
|
|
|
self.available_apps is not None
|
|
|
|
or (
|
|
|
|
# Inhibit the post_migrate signal when using serialized
|
|
|
|
# rollback to avoid trying to recreate the serialized data.
|
|
|
|
self.serialized_rollback and
|
|
|
|
hasattr(connections[db_name], '_test_serialized_contents')
|
|
|
|
)
|
|
|
|
)
|
2013-06-04 14:13:36 +08:00
|
|
|
call_command('flush', verbosity=0, interactive=False,
|
2014-10-20 03:25:09 +08:00
|
|
|
database=db_name, reset_sequences=False,
|
2013-06-12 04:56:09 +08:00
|
|
|
allow_cascade=self.available_apps is not None,
|
2015-04-14 22:43:57 +08:00
|
|
|
inhibit_post_migrate=inhibit_post_migrate)
|
2013-05-19 06:04:34 +08:00
|
|
|
|
2014-02-10 18:18:20 +08:00
|
|
|
def assertQuerysetEqual(self, qs, values, transform=repr, ordered=True, msg=None):
|
2012-08-08 22:37:10 +08:00
|
|
|
items = six.moves.map(transform, qs)
|
2011-08-23 11:38:18 +08:00
|
|
|
if not ordered:
|
2014-09-29 23:17:44 +08:00
|
|
|
return self.assertEqual(Counter(items), Counter(values), msg=msg)
|
2012-12-13 19:33:11 +08:00
|
|
|
values = list(values)
|
|
|
|
# For example qs.iterator() could be passed as qs, but it does not
|
|
|
|
# have 'ordered' attribute.
|
|
|
|
if len(values) > 1 and hasattr(qs, 'ordered') and not qs.ordered:
|
|
|
|
raise ValueError("Trying to compare non-ordered queryset "
|
|
|
|
"against more than one ordered values")
|
2014-02-10 18:18:20 +08:00
|
|
|
return self.assertEqual(list(items), values, msg=msg)
|
2010-05-28 19:15:36 +08:00
|
|
|
|
2010-10-12 11:33:19 +08:00
|
|
|
def assertNumQueries(self, num, func=None, *args, **kwargs):
|
|
|
|
using = kwargs.pop("using", DEFAULT_DB_ALIAS)
|
2011-08-23 10:32:37 +08:00
|
|
|
conn = connections[using]
|
2010-10-12 11:33:19 +08:00
|
|
|
|
2011-08-23 10:32:37 +08:00
|
|
|
context = _AssertNumQueriesContext(self, num, conn)
|
2010-10-12 11:33:19 +08:00
|
|
|
if func is None:
|
|
|
|
return context
|
|
|
|
|
2011-03-28 13:58:43 +08:00
|
|
|
with context:
|
2010-10-12 11:33:19 +08:00
|
|
|
func(*args, **kwargs)
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2009-12-22 23:18:51 +08:00
|
|
|
def connections_support_transactions():
|
|
|
|
"""
|
2011-03-28 10:11:19 +08:00
|
|
|
Returns True if all connections support transactions.
|
2009-12-22 23:18:51 +08:00
|
|
|
"""
|
2011-10-05 20:50:44 +08:00
|
|
|
return all(conn.features.supports_transactions
|
|
|
|
for conn in connections.all())
|
2009-12-22 23:18:51 +08:00
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2009-01-16 10:30:22 +08:00
|
|
|
class TestCase(TransactionTestCase):
|
|
|
|
"""
|
2014-10-19 05:01:13 +08:00
|
|
|
Similar to TransactionTestCase, but uses `transaction.atomic()` to achieve
|
|
|
|
test isolation.
|
|
|
|
|
2015-11-03 17:55:10 +08:00
|
|
|
In most situations, TestCase should be preferred to TransactionTestCase as
|
2014-10-19 05:01:13 +08:00
|
|
|
it allows faster execution. However, there are some situations where using
|
|
|
|
TransactionTestCase might be necessary (e.g. testing some transactional
|
|
|
|
behavior).
|
|
|
|
|
|
|
|
On database backends with no transaction support, TestCase behaves as
|
|
|
|
TransactionTestCase.
|
2009-01-16 10:30:22 +08:00
|
|
|
"""
|
2014-12-04 21:05:59 +08:00
|
|
|
@classmethod
|
|
|
|
def _enter_atomics(cls):
|
|
|
|
"""Helper method to open atomic blocks for multiple databases"""
|
|
|
|
atomics = {}
|
|
|
|
for db_name in cls._databases_names():
|
|
|
|
atomics[db_name] = transaction.atomic(using=db_name)
|
|
|
|
atomics[db_name].__enter__()
|
|
|
|
return atomics
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def _rollback_atomics(cls, atomics):
|
|
|
|
"""Rollback atomic blocks opened through the previous method"""
|
|
|
|
for db_name in reversed(cls._databases_names()):
|
|
|
|
transaction.set_rollback(True, using=db_name)
|
|
|
|
atomics[db_name].__exit__(None, None, None)
|
2009-01-16 10:30:22 +08:00
|
|
|
|
2014-10-19 05:01:13 +08:00
|
|
|
@classmethod
|
|
|
|
def setUpClass(cls):
|
|
|
|
super(TestCase, cls).setUpClass()
|
|
|
|
if not connections_support_transactions():
|
|
|
|
return
|
2014-12-04 21:05:59 +08:00
|
|
|
cls.cls_atomics = cls._enter_atomics()
|
|
|
|
|
|
|
|
if cls.fixtures:
|
|
|
|
for db_name in cls._databases_names(include_mirrors=False):
|
|
|
|
try:
|
|
|
|
call_command('loaddata', *cls.fixtures, **{
|
|
|
|
'verbosity': 0,
|
|
|
|
'commit': False,
|
|
|
|
'database': db_name,
|
|
|
|
})
|
|
|
|
except Exception:
|
|
|
|
cls._rollback_atomics(cls.cls_atomics)
|
|
|
|
raise
|
2015-07-27 00:42:21 +08:00
|
|
|
try:
|
|
|
|
cls.setUpTestData()
|
|
|
|
except Exception:
|
|
|
|
cls._rollback_atomics(cls.cls_atomics)
|
|
|
|
raise
|
2014-10-19 05:01:13 +08:00
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def tearDownClass(cls):
|
|
|
|
if connections_support_transactions():
|
2014-12-04 21:05:59 +08:00
|
|
|
cls._rollback_atomics(cls.cls_atomics)
|
2014-10-19 05:01:13 +08:00
|
|
|
for conn in connections.all():
|
|
|
|
conn.close()
|
|
|
|
super(TestCase, cls).tearDownClass()
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def setUpTestData(cls):
|
|
|
|
"""Load initial data for the TestCase"""
|
|
|
|
pass
|
|
|
|
|
|
|
|
def _should_reload_connections(self):
|
|
|
|
if connections_support_transactions():
|
|
|
|
return False
|
|
|
|
return super(TestCase, self)._should_reload_connections()
|
|
|
|
|
2009-01-16 10:30:22 +08:00
|
|
|
def _fixture_setup(self):
|
2009-12-22 23:18:51 +08:00
|
|
|
if not connections_support_transactions():
|
2014-10-19 05:01:13 +08:00
|
|
|
# If the backend does not support transactions, we should reload
|
|
|
|
# class data before each test
|
|
|
|
self.setUpTestData()
|
2009-01-16 10:30:22 +08:00
|
|
|
return super(TestCase, self)._fixture_setup()
|
2009-02-27 21:14:59 +08:00
|
|
|
|
2012-07-25 04:24:16 +08:00
|
|
|
assert not self.reset_sequences, 'reset_sequences cannot be used on TestCase instances'
|
2014-12-04 21:05:59 +08:00
|
|
|
self.atomics = self._enter_atomics()
|
2009-01-16 10:30:22 +08:00
|
|
|
|
|
|
|
def _fixture_teardown(self):
|
2009-12-22 23:18:51 +08:00
|
|
|
if not connections_support_transactions():
|
2009-01-16 10:30:22 +08:00
|
|
|
return super(TestCase, self)._fixture_teardown()
|
2014-12-04 21:05:59 +08:00
|
|
|
self._rollback_atomics(self.atomics)
|
2009-12-22 23:18:51 +08:00
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2013-07-20 02:30:14 +08:00
|
|
|
class CheckCondition(object):
|
|
|
|
"""Descriptor class for deferred condition checking"""
|
|
|
|
def __init__(self, cond_func):
|
|
|
|
self.cond_func = cond_func
|
|
|
|
|
2015-10-26 23:31:16 +08:00
|
|
|
def __get__(self, instance, cls=None):
|
2013-07-20 02:30:14 +08:00
|
|
|
return self.cond_func()
|
|
|
|
|
|
|
|
|
2010-10-11 20:55:17 +08:00
|
|
|
def _deferredSkip(condition, reason):
|
2010-10-17 12:26:47 +08:00
|
|
|
def decorator(test_func):
|
2011-10-05 20:50:44 +08:00
|
|
|
if not (isinstance(test_func, type) and
|
2013-07-20 02:30:14 +08:00
|
|
|
issubclass(test_func, unittest.TestCase)):
|
2010-10-17 12:26:47 +08:00
|
|
|
@wraps(test_func)
|
2010-10-11 20:55:17 +08:00
|
|
|
def skip_wrapper(*args, **kwargs):
|
|
|
|
if condition():
|
2013-07-01 20:22:27 +08:00
|
|
|
raise unittest.SkipTest(reason)
|
2010-10-17 12:26:47 +08:00
|
|
|
return test_func(*args, **kwargs)
|
2010-10-11 20:55:17 +08:00
|
|
|
test_item = skip_wrapper
|
2010-10-17 12:26:47 +08:00
|
|
|
else:
|
2013-07-20 02:30:14 +08:00
|
|
|
# Assume a class is decorated
|
2010-10-17 12:26:47 +08:00
|
|
|
test_item = test_func
|
2013-07-20 02:30:14 +08:00
|
|
|
test_item.__unittest_skip__ = CheckCondition(condition)
|
2010-10-11 20:55:17 +08:00
|
|
|
test_item.__unittest_skip_why__ = reason
|
|
|
|
return test_item
|
|
|
|
return decorator
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2014-08-24 00:01:33 +08:00
|
|
|
def skipIfDBFeature(*features):
|
2011-10-05 20:50:44 +08:00
|
|
|
"""
|
2014-08-24 00:01:33 +08:00
|
|
|
Skip a test if a database has at least one of the named features.
|
2011-10-05 20:50:44 +08:00
|
|
|
"""
|
2014-08-24 00:01:33 +08:00
|
|
|
return _deferredSkip(
|
|
|
|
lambda: any(getattr(connection.features, feature, False) for feature in features),
|
|
|
|
"Database has feature(s) %s" % ", ".join(features)
|
|
|
|
)
|
2010-10-11 20:55:17 +08:00
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
2014-08-24 00:01:33 +08:00
|
|
|
def skipUnlessDBFeature(*features):
|
2011-10-05 20:50:44 +08:00
|
|
|
"""
|
2014-08-24 00:01:33 +08:00
|
|
|
Skip a test unless a database has all the named features.
|
2011-10-05 20:50:44 +08:00
|
|
|
"""
|
2014-08-24 00:01:33 +08:00
|
|
|
return _deferredSkip(
|
|
|
|
lambda: not all(getattr(connection.features, feature, False) for feature in features),
|
|
|
|
"Database doesn't support feature(s): %s" % ", ".join(features)
|
|
|
|
)
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
|
|
|
|
2015-03-27 04:54:43 +08:00
|
|
|
def skipUnlessAnyDBFeature(*features):
|
|
|
|
"""
|
|
|
|
Skip a test unless a database has any of the named features.
|
|
|
|
"""
|
|
|
|
return _deferredSkip(
|
|
|
|
lambda: not any(getattr(connection.features, feature, False) for feature in features),
|
|
|
|
"Database doesn't support any of the feature(s): %s" % ", ".join(features)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
class QuietWSGIRequestHandler(WSGIRequestHandler):
|
|
|
|
"""
|
|
|
|
Just a regular WSGIRequestHandler except it doesn't log to the standard
|
|
|
|
output any of the requests received, so as to not clutter the output for
|
|
|
|
the tests' results.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def log_message(*args):
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
2013-06-02 01:24:46 +08:00
|
|
|
class FSFilesHandler(WSGIHandler):
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
"""
|
2013-06-02 01:24:46 +08:00
|
|
|
WSGI middleware that intercepts calls to a directory, as defined by one of
|
|
|
|
the *_ROOT settings, and serves those files, publishing them under *_URL.
|
|
|
|
"""
|
|
|
|
def __init__(self, application):
|
|
|
|
self.application = application
|
|
|
|
self.base_url = urlparse(self.get_base_url())
|
|
|
|
super(FSFilesHandler, self).__init__()
|
|
|
|
|
|
|
|
def _should_handle(self, path):
|
|
|
|
"""
|
|
|
|
Checks if the path should be handled. Ignores the path if:
|
|
|
|
|
|
|
|
* the host is provided as part of the base_url
|
|
|
|
* the request's path isn't under the media path (or equal)
|
|
|
|
"""
|
|
|
|
return path.startswith(self.base_url[2]) and not self.base_url[1]
|
|
|
|
|
|
|
|
def file_path(self, url):
|
|
|
|
"""
|
|
|
|
Returns the relative path to the file on disk for the given URL.
|
|
|
|
"""
|
|
|
|
relative_url = url[len(self.base_url[2]):]
|
|
|
|
return url2pathname(relative_url)
|
|
|
|
|
|
|
|
def get_response(self, request):
|
|
|
|
from django.http import Http404
|
|
|
|
|
|
|
|
if self._should_handle(request.path):
|
|
|
|
try:
|
|
|
|
return self.serve(request)
|
|
|
|
except Http404:
|
|
|
|
pass
|
|
|
|
return super(FSFilesHandler, self).get_response(request)
|
|
|
|
|
|
|
|
def serve(self, request):
|
|
|
|
os_rel_path = self.file_path(request.path)
|
2013-09-28 08:45:25 +08:00
|
|
|
os_rel_path = posixpath.normpath(unquote(os_rel_path))
|
|
|
|
# Emulate behavior of django.contrib.staticfiles.views.serve() when it
|
|
|
|
# invokes staticfiles' finders functionality.
|
|
|
|
# TODO: Modify if/when that internal API is refactored
|
|
|
|
final_rel_path = os_rel_path.replace('\\', '/').lstrip('/')
|
2013-06-02 01:24:46 +08:00
|
|
|
return serve(request, final_rel_path, document_root=self.get_base_dir())
|
|
|
|
|
|
|
|
def __call__(self, environ, start_response):
|
|
|
|
if not self._should_handle(get_path_info(environ)):
|
|
|
|
return self.application(environ, start_response)
|
|
|
|
return super(FSFilesHandler, self).__call__(environ, start_response)
|
|
|
|
|
|
|
|
|
|
|
|
class _StaticFilesHandler(FSFilesHandler):
|
|
|
|
"""
|
|
|
|
Handler for serving static files. A private class that is meant to be used
|
|
|
|
solely as a convenience by LiveServerThread.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def get_base_dir(self):
|
|
|
|
return settings.STATIC_ROOT
|
|
|
|
|
|
|
|
def get_base_url(self):
|
|
|
|
return settings.STATIC_URL
|
|
|
|
|
|
|
|
|
|
|
|
class _MediaFilesHandler(FSFilesHandler):
|
|
|
|
"""
|
|
|
|
Handler for serving the media files. A private class that is meant to be
|
|
|
|
used solely as a convenience by LiveServerThread.
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
"""
|
|
|
|
|
|
|
|
def get_base_dir(self):
|
|
|
|
return settings.MEDIA_ROOT
|
|
|
|
|
|
|
|
def get_base_url(self):
|
|
|
|
return settings.MEDIA_URL
|
|
|
|
|
|
|
|
|
|
|
|
class LiveServerThread(threading.Thread):
|
|
|
|
"""
|
|
|
|
Thread for running a live http server while the tests are running.
|
|
|
|
"""
|
|
|
|
|
2013-06-02 01:24:46 +08:00
|
|
|
def __init__(self, host, possible_ports, static_handler, connections_override=None):
|
2011-12-30 04:22:13 +08:00
|
|
|
self.host = host
|
|
|
|
self.port = None
|
|
|
|
self.possible_ports = possible_ports
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
self.is_ready = threading.Event()
|
|
|
|
self.error = None
|
2013-06-02 01:24:46 +08:00
|
|
|
self.static_handler = static_handler
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
self.connections_override = connections_override
|
|
|
|
super(LiveServerThread, self).__init__()
|
|
|
|
|
|
|
|
def run(self):
|
|
|
|
"""
|
|
|
|
Sets up the live server and databases, and then loops over handling
|
|
|
|
http requests.
|
|
|
|
"""
|
|
|
|
if self.connections_override:
|
|
|
|
# Override this thread's database connections with the ones
|
|
|
|
# provided by the main thread.
|
|
|
|
for alias, conn in self.connections_override.items():
|
|
|
|
connections[alias] = conn
|
|
|
|
try:
|
|
|
|
# Create the handler for serving static and media files
|
2013-06-02 01:24:46 +08:00
|
|
|
handler = self.static_handler(_MediaFilesHandler(WSGIHandler()))
|
2011-12-30 04:22:13 +08:00
|
|
|
|
|
|
|
# Go through the list of possible ports, hoping that we can find
|
|
|
|
# one that is free to use for the WSGI server.
|
|
|
|
for index, port in enumerate(self.possible_ports):
|
|
|
|
try:
|
2015-08-30 20:27:38 +08:00
|
|
|
self.httpd = self._create_server(port)
|
2013-09-22 21:55:09 +08:00
|
|
|
except socket.error as e:
|
2011-12-30 04:22:13 +08:00
|
|
|
if (index + 1 < len(self.possible_ports) and
|
2013-11-26 17:43:46 +08:00
|
|
|
e.errno == errno.EADDRINUSE):
|
2011-12-30 04:22:13 +08:00
|
|
|
# This port is already in use, so we go on and try with
|
|
|
|
# the next one in the list.
|
|
|
|
continue
|
|
|
|
else:
|
|
|
|
# Either none of the given ports are free or the error
|
|
|
|
# is something else than "Address already in use". So
|
|
|
|
# we let that error bubble up to the main thread.
|
|
|
|
raise
|
|
|
|
else:
|
|
|
|
# A free port was found.
|
|
|
|
self.port = port
|
|
|
|
break
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
self.httpd.set_app(handler)
|
|
|
|
self.is_ready.set()
|
|
|
|
self.httpd.serve_forever()
|
2012-04-29 00:09:37 +08:00
|
|
|
except Exception as e:
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
self.error = e
|
|
|
|
self.is_ready.set()
|
|
|
|
|
2015-08-30 20:27:38 +08:00
|
|
|
def _create_server(self, port):
|
2015-12-30 20:23:50 +08:00
|
|
|
return WSGIServer((self.host, port), QuietWSGIRequestHandler, allow_reuse_address=False)
|
2015-08-30 20:27:38 +08:00
|
|
|
|
2013-10-02 21:27:38 +08:00
|
|
|
def terminate(self):
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
if hasattr(self, 'httpd'):
|
|
|
|
# Stop the WSGI server
|
|
|
|
self.httpd.shutdown()
|
|
|
|
self.httpd.server_close()
|
|
|
|
|
|
|
|
|
|
|
|
class LiveServerTestCase(TransactionTestCase):
|
|
|
|
"""
|
|
|
|
Does basically the same as TransactionTestCase but also launches a live
|
|
|
|
http server in a separate thread so that the tests may use another testing
|
|
|
|
framework, such as Selenium for example, instead of the built-in dummy
|
|
|
|
client.
|
|
|
|
Note that it inherits from TransactionTestCase instead of TestCase because
|
|
|
|
the threads do not share the same transactions (unless if using in-memory
|
|
|
|
sqlite) and each thread needs to commit all their transactions so that the
|
|
|
|
other thread can see the changes.
|
|
|
|
"""
|
|
|
|
|
2013-06-02 01:24:46 +08:00
|
|
|
static_handler = _StaticFilesHandler
|
|
|
|
|
2015-06-11 04:57:51 +08:00
|
|
|
@classproperty
|
|
|
|
def live_server_url(cls):
|
2011-12-30 04:22:13 +08:00
|
|
|
return 'http://%s:%s' % (
|
2015-06-11 04:57:51 +08:00
|
|
|
cls.server_thread.host, cls.server_thread.port)
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def setUpClass(cls):
|
2014-10-19 02:03:10 +08:00
|
|
|
super(LiveServerTestCase, cls).setUpClass()
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
connections_override = {}
|
|
|
|
for conn in connections.all():
|
|
|
|
# If using in-memory sqlite databases, pass the connections to
|
|
|
|
# the server thread.
|
2014-12-04 07:17:59 +08:00
|
|
|
if conn.vendor == 'sqlite' and conn.is_in_memory_db(conn.settings_dict['NAME']):
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
# Explicitly enable thread-shareability for this connection
|
|
|
|
conn.allow_thread_sharing = True
|
|
|
|
connections_override[conn.alias] = conn
|
|
|
|
|
|
|
|
# Launch the live server's thread
|
2011-12-30 04:22:13 +08:00
|
|
|
specified_address = os.environ.get(
|
2015-02-06 06:02:10 +08:00
|
|
|
'DJANGO_LIVE_TEST_SERVER_ADDRESS', 'localhost:8081-8179')
|
2011-12-30 04:22:13 +08:00
|
|
|
|
|
|
|
# The specified ports may be of the form '8000-8010,8080,9200-9300'
|
|
|
|
# i.e. a comma-separated list of ports or ranges of ports, so we break
|
|
|
|
# it down into a detailed list of all possible ports.
|
|
|
|
possible_ports = []
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
try:
|
2011-12-30 04:22:13 +08:00
|
|
|
host, port_ranges = specified_address.split(':')
|
|
|
|
for port_range in port_ranges.split(','):
|
|
|
|
# A port range can be of either form: '8000' or '8000-8010'.
|
2012-08-15 17:11:55 +08:00
|
|
|
extremes = list(map(int, port_range.split('-')))
|
2011-12-30 04:22:13 +08:00
|
|
|
assert len(extremes) in [1, 2]
|
|
|
|
if len(extremes) == 1:
|
|
|
|
# Port range of the form '8000'
|
|
|
|
possible_ports.append(extremes[0])
|
|
|
|
else:
|
|
|
|
# Port range of the form '8000-8010'
|
|
|
|
for port in range(extremes[0], extremes[1] + 1):
|
|
|
|
possible_ports.append(port)
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
except Exception:
|
2013-03-19 13:04:59 +08:00
|
|
|
msg = 'Invalid address ("%s") for live server.' % specified_address
|
|
|
|
six.reraise(ImproperlyConfigured, ImproperlyConfigured(msg), sys.exc_info()[2])
|
2015-08-30 20:27:38 +08:00
|
|
|
cls.server_thread = cls._create_server_thread(host, possible_ports, connections_override)
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
cls.server_thread.daemon = True
|
|
|
|
cls.server_thread.start()
|
|
|
|
|
|
|
|
# Wait for the live server to be ready
|
|
|
|
cls.server_thread.is_ready.wait()
|
|
|
|
if cls.server_thread.error:
|
Final attempt to solve sporadic test failures.
tearDownClass is not called if setUpClass throws an exception, in our case
this means that LiveServerTestCase leaks LiveServerThread sockets if the
test happens to be skipped later on, and AdminSeleniumWebDriverTestCase
doesn't close it's already open browser window. To prevent this leakage
we catch errors where needed and manually call _tearDownClassInternal.
_tearDownClassInternal should be written as defensively as possible since
it is not allowed to make any assumptions on how far setUpClass got.
This patch should fix the sporadic "Address already in use"-errors on jenkins
and also the "This code isn't under transaction management"-error for sqlite
(also just on jenkins).
After discussion with koniiiik, jezdez, kmtracey, tos9, lifeless, nedbat and
voidspace it was decided that this is the safest approach (thanks to everyone
for their comments and help). Manually calling tearDownClass was shut down
cause we don't know how our users override our classes.
This is a private and very specialized API on purpose and should not be used
without a strong reason!
This patch partially reverts the earlier attempts to fix those issues,
namely:
2fa0dd73b18f55d0fdd1c1d54b1d18031bfcf1ed and
3c5775d36f7e431d9691829a78580873111cb714
Final note: If this patch breaks in a later version of Django, please be
very careful on how you fix it, you might not see test failures locally.
That said, this patch hopefully doesn't produce even more failures.
2013-09-17 22:28:20 +08:00
|
|
|
# Clean up behind ourselves, since tearDownClass won't get called in
|
|
|
|
# case of errors.
|
|
|
|
cls._tearDownClassInternal()
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
raise cls.server_thread.error
|
|
|
|
|
2015-08-30 20:27:38 +08:00
|
|
|
@classmethod
|
|
|
|
def _create_server_thread(cls, host, possible_ports, connections_override):
|
|
|
|
return LiveServerThread(
|
|
|
|
host,
|
|
|
|
possible_ports,
|
|
|
|
cls.static_handler,
|
|
|
|
connections_override=connections_override,
|
|
|
|
)
|
|
|
|
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
@classmethod
|
Final attempt to solve sporadic test failures.
tearDownClass is not called if setUpClass throws an exception, in our case
this means that LiveServerTestCase leaks LiveServerThread sockets if the
test happens to be skipped later on, and AdminSeleniumWebDriverTestCase
doesn't close it's already open browser window. To prevent this leakage
we catch errors where needed and manually call _tearDownClassInternal.
_tearDownClassInternal should be written as defensively as possible since
it is not allowed to make any assumptions on how far setUpClass got.
This patch should fix the sporadic "Address already in use"-errors on jenkins
and also the "This code isn't under transaction management"-error for sqlite
(also just on jenkins).
After discussion with koniiiik, jezdez, kmtracey, tos9, lifeless, nedbat and
voidspace it was decided that this is the safest approach (thanks to everyone
for their comments and help). Manually calling tearDownClass was shut down
cause we don't know how our users override our classes.
This is a private and very specialized API on purpose and should not be used
without a strong reason!
This patch partially reverts the earlier attempts to fix those issues,
namely:
2fa0dd73b18f55d0fdd1c1d54b1d18031bfcf1ed and
3c5775d36f7e431d9691829a78580873111cb714
Final note: If this patch breaks in a later version of Django, please be
very careful on how you fix it, you might not see test failures locally.
That said, this patch hopefully doesn't produce even more failures.
2013-09-17 22:28:20 +08:00
|
|
|
def _tearDownClassInternal(cls):
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
# There may not be a 'server_thread' attribute if setUpClass() for some
|
|
|
|
# reasons has raised an exception.
|
|
|
|
if hasattr(cls, 'server_thread'):
|
|
|
|
# Terminate the live server's thread
|
2013-10-02 21:27:38 +08:00
|
|
|
cls.server_thread.terminate()
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
cls.server_thread.join()
|
2012-07-22 07:16:47 +08:00
|
|
|
|
2014-12-04 07:17:59 +08:00
|
|
|
# Restore sqlite in-memory database connections' non-shareability
|
2012-07-22 07:16:47 +08:00
|
|
|
for conn in connections.all():
|
2014-12-04 07:17:59 +08:00
|
|
|
if conn.vendor == 'sqlite' and conn.is_in_memory_db(conn.settings_dict['NAME']):
|
2012-07-22 07:16:47 +08:00
|
|
|
conn.allow_thread_sharing = False
|
|
|
|
|
Final attempt to solve sporadic test failures.
tearDownClass is not called if setUpClass throws an exception, in our case
this means that LiveServerTestCase leaks LiveServerThread sockets if the
test happens to be skipped later on, and AdminSeleniumWebDriverTestCase
doesn't close it's already open browser window. To prevent this leakage
we catch errors where needed and manually call _tearDownClassInternal.
_tearDownClassInternal should be written as defensively as possible since
it is not allowed to make any assumptions on how far setUpClass got.
This patch should fix the sporadic "Address already in use"-errors on jenkins
and also the "This code isn't under transaction management"-error for sqlite
(also just on jenkins).
After discussion with koniiiik, jezdez, kmtracey, tos9, lifeless, nedbat and
voidspace it was decided that this is the safest approach (thanks to everyone
for their comments and help). Manually calling tearDownClass was shut down
cause we don't know how our users override our classes.
This is a private and very specialized API on purpose and should not be used
without a strong reason!
This patch partially reverts the earlier attempts to fix those issues,
namely:
2fa0dd73b18f55d0fdd1c1d54b1d18031bfcf1ed and
3c5775d36f7e431d9691829a78580873111cb714
Final note: If this patch breaks in a later version of Django, please be
very careful on how you fix it, you might not see test failures locally.
That said, this patch hopefully doesn't produce even more failures.
2013-09-17 22:28:20 +08:00
|
|
|
@classmethod
|
|
|
|
def tearDownClass(cls):
|
|
|
|
cls._tearDownClassInternal()
|
Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 16:33:58 +08:00
|
|
|
super(LiveServerTestCase, cls).tearDownClass()
|
2015-02-06 18:38:22 +08:00
|
|
|
|
|
|
|
|
|
|
|
class SerializeMixin(object):
|
|
|
|
"""
|
|
|
|
Mixin to enforce serialization of TestCases that share a common resource.
|
|
|
|
|
|
|
|
Define a common 'lockfile' for each set of TestCases to serialize. This
|
|
|
|
file must exist on the filesystem.
|
|
|
|
|
|
|
|
Place it early in the MRO in order to isolate setUpClass / tearDownClass.
|
|
|
|
"""
|
|
|
|
|
|
|
|
lockfile = None
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def setUpClass(cls):
|
|
|
|
if cls.lockfile is None:
|
|
|
|
raise ValueError(
|
|
|
|
"{}.lockfile isn't set. Set it to a unique value "
|
|
|
|
"in the base class.".format(cls.__name__))
|
|
|
|
cls._lockfile = open(cls.lockfile)
|
|
|
|
locks.lock(cls._lockfile, locks.LOCK_EX)
|
|
|
|
super(SerializeMixin, cls).setUpClass()
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def tearDownClass(cls):
|
|
|
|
super(SerializeMixin, cls).tearDownClass()
|
|
|
|
cls._lockfile.close()
|