Ticket #4476: 4476_follow_redirects.diff

django/test/client.py

@@ -1 +1 @@
-import datetime
-import sys
-from cStringIO import StringIO
-
+, urlsplit
-from django.conf import settings
-from django.contrib.auth import authenticate, login
-from django.core.handlers.base import BaseHandler
-from django.core.handlers.wsgi import WSGIRequest
-from django.core.signals import got_request_exception
-from django.dispatch import dispatcher
-
+, QueryDict
-from django.template import TemplateDoesNotExist
-from django.test import signals
-from django.utils.functional import curry
@@ -205 +205 @@
-
-        return response
-
-
+follow=True, 
-        "Request a response from the server using GET."
-        r = {
-            'CONTENT_LENGTH':  None,
@@ -216 +216 @@
-        }
-        r.update(extra)
-
-
+
+
+
+
-
-
+follow=True, 
-        "Request a response from the server using POST."
-
-        if content_type is MULTIPART_CONTENT:
@@ -235 +238 @@
-        }
-        r.update(extra)
-
-
+
+
+
+
-
-    def login(self, **credentials):
-        """Set the Client to appear as if it has sucessfully logged into a site.
@@ -276 +282 @@
-        session = __import__(settings.SESSION_ENGINE, {}, {}, ['']).SessionStore()
-        session.delete(session_key=self.cookies['sessionid'].value)
-        self.cookies = SimpleCookie()
+
+    def _handle_redirects(self, response):
+        "Follows any redirects by requesting responses from the server using GET."
+
+        response.redirect_chain = []
+        while response.status_code in (301, 302, 303, 307):
+            url = response['Location']
+            scheme, netloc, path, query, fragment = urlsplit(url)
+
+            local_redirect_chain = response.redirect_chain
+            local_redirect_chain.append((url, response.status_code))
+
+            # The test client doesn't handle external links, 
+            # but since the situation is simulated in test_client,
+            # we fake things here by ignoring the netloc portion of the
+            # redirected URL.
+            response = self.get(path, QueryDict(query), follow=False)
+            response.redirect_chain = local_redirect_chain
+
+            # prevent any loops
+            if response.redirect_chain[-1] in response.redirect_chain[0:-1]:
+                break
+
+        return response

django/test/testcases.py

@@ -2 +2 @@
-import unittest
-from urlparse import urlsplit, urlunsplit
-
-from django.http import QueryDict
-from django.db import transaction
-from django.core import mail
-from django.core.management import call_command
@@ -74 +73 @@
-        super(TestCase, self).__call__(result)
-
-    def assertRedirects(self, response, expected_url, status_code=302,
-
+, redirect_level=-1
-        """Asserts that a response redirected to a specific URL, and that the
-        redirect URL can be loaded.
-
-        Note that assertRedirects won't work for external links since it uses
-        TestClient to do a request.
+        
+        Note that assertRedirects only works properly if follow was set to true
+        in the request.
-        """
-
+
+
+
+
+
+
+
+
+
-            ("Response didn't redirect as expected: Response code was %d"
-
-
-
+
+
-        e_scheme, e_netloc, e_path, e_query, e_fragment = urlsplit(expected_url)
-        if not (e_scheme or e_netloc):
-            expected_url = urlunsplit(('http', host or 'testserver', e_path,
-                    e_query, e_fragment))
-
-
+redirect_
+redirect_
-
-
-
-
-
+
-            ("Couldn't retrieve redirection page '%s': response code was %d"
-             " (expected %d)") %
-path, redirect_
+redirect_url, 
-
-    def assertContains(self, response, text, count=None, status_code=200):
-        """

docs/testing.txt

@@ -453 +453 @@
-
-Once you have a ``Client`` instance, you can call any of the following methods:
-
-
+, follow=True
-    Makes a GET request on the provided ``path`` and returns a ``Response``
-
+
+
-
-    The key-value pairs in the ``data`` dictionary are used to create a GET
-    data payload. For example::
@@ -467 +468 @@
-
-        /customers/details/?name=fred&age=7
-
-
+
+
+
+
+
+
+
+
+
+
-    Makes a POST request on the provided ``path`` and returns a ``Response``
-
+
+
-
-    The key-value pairs in the ``data`` dictionary are used to submit POST
-    data. For example::
@@ -501 +512 @@
-
-        {'choices': ('a', 'b', 'd')}
-
+    If any redirects occurred, the response will have a ``redirect_chain``
+    attribute containing tuples of the intermediate urls and status codes.
+    If you had an url ``/redirect_me/`` that redirected to ``/final/``, this is 
+    what you'd see:
+    
+        >>> response = c.post('/redirect_me/', {'data': 'test'})
+        >>> response.redirect_chain
+        [(u'/final/', 302)]
+
-    Submitting files is a special case. To POST a file, you need only provide
-    the file field name as a key, and a file handle to the file you wish to
-    upload as a value. For example::
@@ -834 +854 @@
-    Asserts that the template with the given name was *not* used in rendering
-    the response.
-
-
+, redirect_level=-1
-    Asserts that the response return a ``status_code`` redirect status,
-subsequent
+final
-    page was received with ``target_status_code``.
+    
+    If you're expecting multiple levels of redirects, you can specify to which 
+    ``redirect_level`` the ``expected_url`` and ``status_code`` are matched against.
+    A value of -1 checks against the last redirect in the chain.
-
-``assertTemplateUsed(response, template_name)``
-    Asserts that the template with the given name was used in rendering the

tests/modeltests/test_client/models.py

@@ -114 +114 @@
-
-    def test_redirect_to_strange_location(self):
-        "GET a URL that redirects to a non-200 page"
+        response = self.client.get('/test_client/redirect_to_bad_view/')
+
+        # Check that the response was a 404
+        self.assertRedirects(response, 'http://testserver/test_client/bad_view/', target_status_code=404)
+
+    def test_chained_redirects(self):
+        "GET a URL that redirects more than once"
-        response = self.client.get('/test_client/double_redirect_view/')
-
- response was a 302, and that
-# the attempt to get the redirection location returned 301 when retrieved
-permanent_redirect_view/', target_status_code=30
+re were two redirects, the first being a 302 and the second 301
+self.assertRedirects(response, 'http://testserver/test_client/permanent_redirect_view/', status_code=302, redirect_level=0)
+get_view/', status_code=301, redirect_level=
-
-    def test_notfound_response(self):
-        "GET a URL that responds as '404:Not Found'"

tests/modeltests/test_client/urls.py

@@ -9 +9 @@
-    (r'^redirect_view/$', views.redirect_view),
-    (r'^permanent_redirect_view/$', redirect_to, { 'url': '/test_client/get_view/' }),
-    (r'^double_redirect_view/$', views.double_redirect_view),
+    (r'^redirect_to_bad_view/$', views.redirect_to_bad_view),
+    (r'^infinite_redirect/$', views.redirect_to_self),
-    (r'^bad_view/$', views.bad_view),
-    (r'^form_view/$', views.form_view),
-    (r'^form_view_with_template/$', views.form_view_with_template),

tests/modeltests/test_client/views.py

@@ -60 +60 @@
-    "A view that redirects all requests to a redirection view"
-    return HttpResponseRedirect('/test_client/permanent_redirect_view/')
-
+def redirect_to_bad_view(request):
+    "A view that redirects all requests to 404 page"
+    return HttpResponseRedirect('/test_client/bad_view/')
+
+def redirect_to_self(request):
+    "A view that redirects to itself (bad thing!)"
+    return HttpResponseRedirect('/test_client/infinite_redirect/')
+
-def bad_view(request):
-    "A view that returns a 404 with some error content"
-    return HttpResponseNotFound('Not found!. This page contains some MAGIC content')

tests/regressiontests/test_client_regress/models.py

@@ -132 +132 @@
-
-    def test_target_page(self):
-        "An assertion is raised if the response redirect target cannot be retrieved as expected"
-double_redirect
+redirect_to_bad
-        try:
-301 code, not 200
-permanent_redirect
+404 code, not 200 (simulated case.)
+bad
-        except AssertionError, e:
-/test_client/permanent_redirect_view/': response code was 301
+http://testserver/test_client/bad_view/': response code was 404
-
+    def test_infinite_loop_redirect(self):
+        "An exception is raised if an URL contains a loop in the redirect chain"
+
+        # Check that the test client breaks out of infinite redirect loops
+        response = self.client.get('/test_client/infinite_redirect/')
+        try:
+            self.assertRedirects(response, 'http://testserver/test_client/infinite_redirect/')
+        except AssertionError, e:
+            self.assertEquals(str(e), "Couldn't retrieve redirection page 'http://testserver/test_client/infinite_redirect/': response code was 302 (expected 200)")
+
+        # For educational purposes: how to tell that you encountered a loop
+        self.assertTrue(response.redirect_chain[-1] in response.redirect_chain[0:-1])
+
-class AssertFormErrorTests(TestCase):
-    def test_unknown_form(self):
-        "An assertion is raised if the form name is unknown"