Ticket #11077: test_combine_urlconfs_docs.patch

django/test/testcases.py

@@ -1 +1 @@
 import re
+import sys
+import imp
 import unittest
 from urlparse import urlsplit, urlunsplit
 from xml.dom.minidom import parseString, Node
@@ -13 +15 @@
 from django.test.client import Client
 from django.utils import simplejson
 from django.utils.encoding import smart_str
+from django.utils.importlib import import_module
 
 try:
     all
@@ -242 +245 @@
     def _urlconf_setup(self):
         if hasattr(self, 'urls'):
             self._old_root_urlconf = settings.ROOT_URLCONF
-            settings.ROOT_URLCONF = self.urls
+            if settings.TEST_COMBINE_URLCONFS:
+                # Put the module instance of self.urls into specified_urlconf
+                if not isinstance(self.urls, basestring):
+                    specified_urlconf = self.urls
+                else:
+                    specified_urlconf = import_module(self.urls)
+                # Choose between settings.TEST_COMBINE_URLCONFS_WITH and settings.ROOT_URLCONF
+                urls_to_combine = settings.TEST_COMBINE_URLCONFS_WITH or settings.ROOT_URLCONF
+                # Do the above action, this time with urls_to_combine
+                if not isinstance(urls_to_combine, basestring):
+                    extra_urlconf = urls_to_combine
+                else:
+                    extra_urlconf = import_module(urls_to_combine)
+                # Create a dynamic URLconf module that combines the urlpatterns
+                # of specified_urlconf and extra_urlconf
+                dynamic_urlconf_name = 'dynamic_urls'
+                dynamic_urlconf = imp.new_module(dynamic_urlconf_name)
+                dynamic_urlconf.urlpatterns = specified_urlconf.urlpatterns + \
+                        extra_urlconf.urlpatterns
+                # Also combine handler404 and 500, favoring specified_urlconf
+                handler404 = getattr(specified_urlconf, 'handler404', None) or \
+                        getattr(extra_urlconf, 'handler404', None)
+                if handler404:
+                    dynamic_urlconf.handler404 = handler404
+                handler500 = getattr(specified_urlconf, 'handler404', None) or \
+                        getattr(extra_urlconf, 'handler404', None)
+                if handler500:
+                    dynamic_urlconf.handler500 = handler500
+                # Add our dynamic_urlconf to sys.modules and set 
+                # settings.ROOT_URLCONF to it
+                sys.modules[dynamic_urlconf_name] = dynamic_urlconf
+                settings.ROOT_URLCONF = dynamic_urlconf
+            else:
+                settings.ROOT_URLCONF = self.urls
             clear_url_caches()
 
     def __call__(self, result=None):

django/conf/global_settings.py

@@ -501 +501 @@
 TEST_DATABASE_CHARSET = None
 TEST_DATABASE_COLLATION = None
 
+# If true, the testing framework will combine the URLconf instead of overwrite
+# it if a TestCase.urls is specified
+TEST_COMBINE_URLCONFS = False
+
+# The URLconf to be combined with the TestCase.urls setting. If None, the 
+# ROOT_URLCONF specified in settings.py will be used instead.
+TEST_COMBINE_URLCONFS_WITH = None
+
 ############
 # FIXTURES #
 ############

docs/topics/testing.txt

@@ -1054 +1054 @@
 This test case will use the contents of ``myapp.test_urls`` as the
 URLconf for the duration of the test case.
 
+The use of ``TestCase.urls`` has a downside, though. Since it overrides
+``ROOT_URLCONF``, your project's other urls will not be accessible. This is
+normally not a problem, but custom templates with reverses to external apps will
+cause the tests to raise ``NoReverseMatch`` exceptions. This problem can happen
+with :mod:`django.contrib.auth` and other apps that support custom templates and
+set ``TestCase.urls``. Custom templates that include a ``base.html`` with links to
+various places around the site are common sources of this problem.
+
+This situation can be fixed by combining the ``TestCase.urls`` with your
+project's ``ROOT_URLCONF``. You can also choose to combine a custom URLconf
+designed specifically for testing. See :setting:`TEST_COMBINE_URLCONFS` and
+:setting:`TEST_COMBINE_URLCONFS_WITH` for more information.
+
 .. _emptying-test-outbox:
 
 Multi-database support

docs/ref/settings.txt

@@ -1404 +1404 @@
 Output, as a string, that the template system should use for invalid (e.g.
 misspelled) variables. See :ref:`invalid-template-variables`..
 
+.. setting:: TEST_COMBINE_URLCONFS
+
+TEST_COMBINE_URLCONFS
+---------------------
+
+Default: ``False``
+
+If ``True``, the testing framework will combine the URLconf instead of overwrite
+it if a ``TestCase.urls`` is specified. The URLconf merged into the
+``TestCase.urls`` will be :setting:`ROOT_URLCONF` unless
+:setting:`TEST_COMBINE_URLCONFS_WITH` is set.
+
+This setting is useful for cases where apps like :mod:`django.contrib.auth` set
+``TestCase.urls`` to override the :setting:`ROOT_URLCONF` with a custom testing
+URLconf. This setting will fix the problem where custom templates with reverses
+to external apps cause the tests to fail with ``NoReverseMatch`` errors.
+
+.. setting:: TEST_COMBINE_URLCONFS_WITH
+
+TEST_COMBINE_URLCONFS_WITH
+--------------------------
+
+Default: ``None``
+
+The URLconf to be combined with the ``TestCase.urls`` setting if it is set. If
+``None``, the :setting:`ROOT_URLCONF` will be used instead. This setting will
+only be used if :setting:`TEST_COMBINE_URLCONFS` is ``True``. This can either be
+a string pointing to a module or an actual module, much like
+:setting:`ROOT_URLCONF`.
+
 .. setting:: TEST_RUNNER
 
 TEST_RUNNER