Merge pull request #53 from goodtune/assertResponseHeaders

Add assertResponseHeaders

docs/methods.rst

@@ -200,6 +200,22 @@ the chunk of HTML::
         self.get('hello-world')
         self.assertResponseNotContains('<p>Hello, Frank!</p>')
 
+assertResponseHeaders(headers, response=None)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sometimes your views or middleware will set custom headers::
+
+    def test_custom_headers(self):
+        self.get('my-url-name')
+        self.assertResponseHeaders({'X-Custom-Header': 'Foo'})
+        self.assertResponseHeaders({'X-Does-Not-Exist': None})
+
+You might also want to check standard headers::
+
+    def test_content_type(self):
+        self.get('my-json-view')
+        self.assertResponseHeaders({'Content-Type': 'application/json'})
+
 get\_check\_200(url\_name, \*args, \*\*kwargs)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

test_plus/test.py

@@ -343,6 +343,22 @@ def assertResponseNotContains(self, text, response=None, html=True, **kwargs):
         response = self._which_response(response)
         self.assertNotContains(response, text, html=html, **kwargs)
 
+    def assertResponseHeaders(self, headers, response=None):
+        """
+        Check that the headers in the response are as expected.
+
+        Only headers defined in `headers` are compared, other keys present on
+        the `response` will be ignored.
+
+        :param headers: Mapping of header names to expected values
+        :type headers: :class:`collections.Mapping`
+        :param response: Response to check headers against
+        :type response: :class:`django.http.response.HttpResponse`
+        """
+        response = self._which_response(response)
+        compare = {h: response.get(h) for h in headers}
+        self.assertEqual(compare, headers)
+
     def get_context(self, key):
         if self.last_response is not None:
             self.assertTrue(key in self.last_response.context)

test_project/test_app/tests.py

@@ -403,6 +403,13 @@ def test_assertresponsecontains(self):
         self.assertResponseContains('<p>Hello world</p>')
         self.assertResponseNotContains('<p>Hello Frank</p>')
 
+    def test_assert_response_headers(self):
+        self.get('view-headers')
+        self.assertResponseHeaders({'Content-Type': 'text/plain'})
+        self.assertResponseHeaders({'X-Custom': '1'})
+        self.assertResponseHeaders({'X-Custom': '1', 'X-Non-Existent': None})
+        self.assertResponseHeaders({'X-Non-Existent': None})
+
 
 class TestPlusCBViewTests(CBVTestCase):
 

test_project/test_app/urls.py

@@ -4,10 +4,10 @@
     from django.conf.urls.defaults import url, include
 
 from .views import (
-    data_1, data_5, needs_login, view_200, view_201, view_301, view_302,
-    view_400, view_401, view_403, view_404, view_405, view_410,
-    view_contains, view_context_with, view_context_without,
-    view_is_ajax, view_redirect, FormErrors
+    FormErrors, data_1, data_5, needs_login, view_200, view_201, view_301,
+    view_302, view_400, view_401, view_403, view_404, view_405, view_410,
+    view_contains, view_context_with, view_context_without, view_headers,
+    view_is_ajax, view_redirect,
 )
 
 urlpatterns = [
@@ -31,4 +31,5 @@
     url(r'^view/isajax/$', view_is_ajax, name='view-is-ajax'),
     url(r'^view/contains/$', view_contains, name='view-contains'),
     url(r'^view/form-errors/$', FormErrors.as_view(), name='form-errors'),
+    url(r'^view/headers/$', view_headers, name='view-headers'),
 ]

test_project/test_app/views.py

@@ -88,6 +88,12 @@ def view_contains(request):
     return render(request, 'test.html', {})
 
 
+def view_headers(request):
+    response = HttpResponse('', content_type='text/plain', status=200)
+    response['X-Custom'] = 1
+    return response
+
+
 # Class-based test views
 
 class CBView(generic.View):