Merge pull request #9 from alexcouper/alex/check-headers

Add support for testing headers.

Author: txels

abe/unittest.py

@@ -89,6 +89,24 @@ def assert_data_list_equal(self, data1, data2):
             )
             raise type(exceptions[0])(message)
 
+    def assert_headers_contain(self, response_data, spec_data):
+        """
+        response_data headers contain all headers defined in spec_data
+        """
+        for expected_header, expected_value in spec_data.items():
+            django_expected_header = (
+                'HTTP_' + expected_header.upper().replace('-', '_')
+            )
+            actual_val = response_data.get(
+                expected_header,
+                response_data.get(django_expected_header)
+            )
+            self.assertEqual(
+                expected_value, actual_val,
+                "Incorrect or missing value specified for "
+                "header {0}".format(expected_header)
+            )
+
     def assert_matches_sample(self, path, label, url, response):
         """
         Check a URL and response against a sample.
@@ -108,6 +126,11 @@ def assert_matches_sample(self, path, label, url, response):
         sample_response = sample.examples[label].response
 
         self.assertEqual(url, sample_request.url)
+        if 'headers' in sample_request:
+            self.assert_headers_contain(
+                response.request, sample_request.headers
+            )
+
         self.assertEqual(response.status_code, sample_response.status)
         if 'body' in sample_response:
             response_parsed = response.data

tests/test_assertions.py

@@ -37,3 +37,37 @@ def test_list_equality_ordering_nested_items(self):
                 AssertionError,
                 self.assert_data_list_equal, data1, data2
             )
+
+
+class TestAssertHeadersEqual(TestCase, AbeTestMixin):
+
+    def test_matches_django_test_format(self):
+        self.assert_headers_contain(
+            {'HTTP_THIS_CUSTOM_HEADER': 'Foo'},
+            {'This-Custom-Header': 'Foo'}
+        )
+
+    def test_matches_normal_header_format(self):
+        self.assert_headers_contain(
+            {'This-Custom-Header': 'Foo'},
+            {'This-Custom-Header': 'Foo'},
+        )
+
+    def test_matches_only_sample_defined_headers(self):
+        self.assert_headers_contain(
+            {'HTTP_THIS_CUSTOM_HEADER': 'Foo',
+             'HTTP_SOME_UNDEFINED_IN_SPEC_HEADER': 'Bar'},
+            {'This-Custom-Header': 'Foo'},
+        )
+
+    def test_requires_key_and_value_match(self):
+        with self.assertRaises(AssertionError):
+            self.assert_headers_contain(
+                {'HTTP_THIS_CUSTOM_HEADER': 'Bar'},
+                {'This-Custom-Header': 'Foo'},
+            )
+        with self.assertRaises(AssertionError):
+            self.assert_headers_contain(
+                {'HTTP_THIS_CUSTOM': 'Foo'},
+                {'This-Custom-Header': 'Foo'},
+            )