Fixed #5888 -- Added methods to the test client to support HEAD, PUT, DELETE

and OPTIONS support. Thanks Scott Barr and Leah Culver.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9188 bcc190cf-cafb-0310-a4f2-bffc1f526a37

AUTHORS

@@ -47,6 +47,7 @@ answer newbie questions, and generally made Django that much better:
     Niran Babalola <niran@niran.org>
     Morten Bagai <m@bagai.com>
     Mikaël Barbero <mikael.barbero nospam at nospam free.fr>
+    Scott Barr <scott@divisionbyzero.com.au>
     Jiri Barton
     Ned Batchelder <http://www.nedbatchelder.com/>
     batiste@dosimple.ch

django/test/client.py

@@ -284,6 +284,69 @@ class Client(object):
 
         return self.request(**r)
 
+    def head(self, path, data={}, **extra):
+        """
+        Request a response from the server using HEAD.
+        """
+        r = {
+            'CONTENT_LENGTH':  None,
+            'CONTENT_TYPE':    'text/html; charset=utf-8',
+            'PATH_INFO':       urllib.unquote(path),
+            'QUERY_STRING':    urlencode(data, doseq=True),
+            'REQUEST_METHOD': 'HEAD',
+        }
+        r.update(extra)
+
+        return self.request(**r)
+
+    def options(self, path, data={}, **extra):
+        """
+        Request a response from the server using OPTIONS.
+        """
+        r = {
+            'CONTENT_LENGTH':  None,
+            'CONTENT_TYPE':    None,
+            'PATH_INFO':       urllib.unquote(path),
+            'QUERY_STRING':    urlencode(data, doseq=True),
+            'REQUEST_METHOD': 'OPTIONS',
+        }
+        r.update(extra)
+
+        return self.request(**r)
+
+    def put(self, path, data={}, content_type=MULTIPART_CONTENT, **extra):
+        """
+        Send a resource to the server using PUT.
+        """
+        if content_type is MULTIPART_CONTENT:
+            post_data = encode_multipart(BOUNDARY, data)
+        else:
+            post_data = data
+        r = {
+            'CONTENT_LENGTH': len(post_data),
+            'CONTENT_TYPE':   content_type,
+            'PATH_INFO':      urllib.unquote(path),
+            'REQUEST_METHOD': 'PUT',
+            'wsgi.input':     FakePayload(post_data),
+        }
+        r.update(extra)
+
+        return self.request(**r)
+
+    def delete(self, path, data={}, **extra):
+        """
+        Send a DELETE request to the server.
+        """
+        r = {
+            'CONTENT_LENGTH':  None,
+            'CONTENT_TYPE':    None,
+            'PATH_INFO':       urllib.unquote(path),
+            'REQUEST_METHOD': 'DELETE',
+            }
+        r.update(extra)
+
+        return self.request(**r)
+
     def login(self, **credentials):
         """
         Sets the Client to appear as if it has successfully logged into a site.

docs/topics/testing.txt

@@ -544,6 +544,36 @@ arguments at time of construction:
         Note that you should manually close the file after it has been provided
         to ``post()``.
 
+    .. method:: Client.head(path, data={})
+
+        .. versionadded:: development
+
+        Makes a HEAD request on the provided ``path`` and returns a ``Response``
+        object. Useful for testing RESTful interfaces. Acts just like
+        :meth:`Client.get` except it does not return a message body.
+
+    .. method:: Client.options(path, data={})
+
+        .. versionadded:: development
+
+        Makes an OPTIONS request on the provided ``path`` and returns a
+        ``Response`` object. Useful for testing RESTful interfaces.
+
+    .. method:: Client.put(path, data={}, content_type=MULTIPART_CONTENT)
+
+        .. versionadded:: development
+
+        Makes an PUT request on the provided ``path`` and returns a
+        ``Response`` object. Useful for testing RESTful interfaces. Acts just
+        like :meth:`Client.put` except with the PUT request method.
+
+    .. method:: Client.delete(path)
+
+        .. versionadded:: development
+
+        Makes an DELETE request on the provided ``path`` and returns a
+        ``Response`` object. Useful for testing RESTful interfaces.
+
     .. method:: Client.login(**credentials)
 
         .. versionadded:: 1.0

tests/regressiontests/test_client_regress/models.py

@@ -383,3 +383,41 @@ class SessionTests(TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.content, 'YES')
 
+class RequestMethodTests(TestCase):
+    def test_get(self):
+        "Request a view via request method GET"
+        response = self.client.get('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, 'request method: GET')
+
+    def test_post(self):
+        "Request a view via request method POST"
+        response = self.client.post('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, 'request method: POST')
+
+    def test_head(self):
+        "Request a view via request method HEAD"
+        response = self.client.head('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        # A HEAD request doesn't return any content.
+        self.assertNotEqual(response.content, 'request method: HEAD')
+        self.assertEqual(response.content, '')
+
+    def test_options(self):
+        "Request a view via request method OPTIONS"
+        response = self.client.options('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, 'request method: OPTIONS')
+
+    def test_put(self):
+        "Request a view via request method PUT"
+        response = self.client.put('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, 'request method: PUT')
+
+    def test_delete(self):
+        "Request a view via request method DELETE"
+        response = self.client.delete('/test_client_regress/request_methods/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, 'request method: DELETE')

tests/regressiontests/test_client_regress/urls.py

@@ -9,4 +9,5 @@ urlpatterns = patterns('',
     (r'^login_protected_redirect_view/$', views.login_protected_redirect_view),
     (r'^set_session/$', views.set_session_view),
     (r'^check_session/$', views.check_session_view),
+    (r'^request_methods/$', views.request_methods_view),
 )

tests/regressiontests/test_client_regress/views.py

@@ -43,3 +43,7 @@ def set_session_view(request):
 def check_session_view(request):
     "A view that reads a session variable"
     return HttpResponse(request.session.get('session_var', 'NO'))
+
+def request_methods_view(request):
+    "A view that responds with the request method"
+    return HttpResponse('request method: %s' % request.method)