Merge pull request #333 from p1c2u/feature/response-headers-contrib-tests

Response headers support in contrib

Author: p1c2u

openapi_core/contrib/django/compat.py

@@ -4,12 +4,18 @@
 )
 
 
-def get_headers(req):
+def get_request_headers(req):
     # in Django 1 headers is not defined
     return req.headers if hasattr(req, 'headers') else \
         HttpHeaders(req.META)
 
 
+def get_response_headers(resp):
+    # in Django 2 headers is not defined
+    return resp.headers if hasattr(resp, 'headers') else \
+        dict(resp._headers.values())
+
+
 def get_current_scheme_host(req):
     # in Django 1 _current_scheme_host is not defined
     return req._current_scheme_host if hasattr(req, '_current_scheme_host') \

openapi_core/contrib/django/requests.py

@@ -4,7 +4,7 @@
 from six.moves.urllib.parse import urljoin
 
 from openapi_core.contrib.django.compat import (
-    get_headers, get_current_scheme_host,
+    get_request_headers, get_current_scheme_host,
 )
 from openapi_core.validation.request.datatypes import (
     RequestParameters, OpenAPIRequest,
@@ -39,7 +39,7 @@ def create(cls, request):
             path_pattern = '/' + route
 
         path = request.resolver_match and request.resolver_match.kwargs or {}
-        headers = get_headers(request)
+        headers = get_request_headers(request)
         parameters = RequestParameters(
             path=path,
             query=request.GET,

openapi_core/contrib/django/responses.py

@@ -1,4 +1,5 @@
 """OpenAPI core contrib django responses module"""
+from openapi_core.contrib.django.compat import get_response_headers
 from openapi_core.validation.response.datatypes import OpenAPIResponse
 
 
@@ -7,8 +8,10 @@ class DjangoOpenAPIResponseFactory(object):
     @classmethod
     def create(cls, response):
         mimetype = response["Content-Type"]
+        headers = get_response_headers(response)
         return OpenAPIResponse(
             data=response.content,
             status_code=response.status_code,
+            headers=headers.items(),
             mimetype=mimetype,
         )

openapi_core/contrib/falcon/responses.py

@@ -19,5 +19,6 @@ def create(cls, response):
         return OpenAPIResponse(
             data=data,
             status_code=status_code,
+            headers=response.headers,
             mimetype=mimetype,
         )

openapi_core/contrib/flask/responses.py

@@ -9,5 +9,6 @@ def create(cls, response):
         return OpenAPIResponse(
             data=response.data,
             status_code=response._status_code,
+            headers=response.headers,
             mimetype=response.mimetype,
         )

openapi_core/contrib/requests/responses.py

@@ -7,8 +7,10 @@ class RequestsOpenAPIResponseFactory(object):
     @classmethod
     def create(cls, response):
         mimetype = response.headers.get('Content-Type')
+        headers = dict(response.headers)
         return OpenAPIResponse(
             data=response.content,
             status_code=response.status_code,
+            headers=headers,
             mimetype=mimetype,
         )

tests/integration/contrib/django/data/djangoproject/testapp/views.py

@@ -30,6 +30,7 @@ def get(self, request, pk):
             "test": "test_val",
         }
         django_response = JsonResponse(response_dict)
+        django_response['X-Rate-Limit'] = '12'
 
         openapi_response = DjangoOpenAPIResponse(django_response)
         validator = ResponseValidator(spec)

tests/integration/contrib/django/data/openapi.yaml

@@ -17,6 +17,12 @@ paths:
                     type: string
                 required:
                   - test
+          headers:
+            X-Rate-Limit:
+              description: Rate limit
+              schema:
+                type: integer
+              required: true
       parameters:
         - required: true
           in: path

tests/integration/contrib/falcon/conftest.py

@@ -40,11 +40,13 @@ def create_request(
 @pytest.fixture
 def response_factory(environ_factory):
     def create_response(
-            data, status_code=200, content_type='application/json'):
+            data, status_code=200, headers=None,
+            content_type='application/json'):
         options = ResponseOptions()
         resp = Response(options)
         resp.body = data
         resp.content_type = content_type
         resp.status = HTTP_200
+        resp.set_headers(headers or {})
         return resp
     return create_response

tests/integration/contrib/falcon/data/v3.0/falcon_factory.yaml

@@ -32,6 +32,12 @@ paths:
                 properties:
                   data:
                     type: string
+          headers:
+            X-Rate-Limit:
+              description: Rate limit
+              schema:
+                type: integer
+              required: true
         default:
           description: Return errors.
           content: