Response binary format support

python-openapi · Nov 1, 2023 · 9925e1b · 9925e1b
1 parent ffb17a7
commit 9925e1b
Show file tree

Hide file tree

Showing 19 changed files with 67 additions and 71 deletions.
diff --git a/openapi_core/contrib/aiohttp/responses.py b/openapi_core/contrib/aiohttp/responses.py
@@ -13,13 +13,13 @@ def __init__(self, response: web.Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         if self.response.body is None:
-            return ""
+            return b""
         if isinstance(self.response.body, bytes):
-            return self.response.body.decode("utf-8")
+            return self.response.body
         assert isinstance(self.response.body, str)
-        return self.response.body
+        return self.response.body.encode("utf-8")
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/contrib/django/responses.py b/openapi_core/contrib/django/responses.py
@@ -1,20 +1,28 @@
 """OpenAPI core contrib django responses module"""
+from itertools import tee
+
 from django.http.response import HttpResponse
+from django.http.response import StreamingHttpResponse
 from werkzeug.datastructures import Headers
 
 
 class DjangoOpenAPIResponse:
     def __init__(self, response: HttpResponse):
-        if not isinstance(response, HttpResponse):
+        if not isinstance(response, (HttpResponse, StreamingHttpResponse)):
             raise TypeError(
-                f"'response' argument is not type of {HttpResponse}"
+                f"'response' argument is not type of {HttpResponse} or {StreamingHttpResponse}"
             )
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
+        if isinstance(self.response, StreamingHttpResponse):
+            resp_iter1, resp_iter2 = tee(self.response._iterator)
+            self.response.streaming_content = resp_iter1
+            content = b"".join(map(self.response.make_bytes, resp_iter2))
+            return content
         assert isinstance(self.response.content, bytes)
-        return self.response.content.decode("utf-8")
+        return self.response.content
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/contrib/falcon/responses.py b/openapi_core/contrib/falcon/responses.py
@@ -10,11 +10,11 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         if self.response.text is None:
-            return ""
+            return b""
         assert isinstance(self.response.text, str)
-        return self.response.text
+        return self.response.text.encode("utf-8")
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/contrib/requests/responses.py b/openapi_core/contrib/requests/responses.py
@@ -10,9 +10,9 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         assert isinstance(self.response.content, bytes)
-        return self.response.content.decode("utf-8")
+        return self.response.content
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/contrib/starlette/responses.py b/openapi_core/contrib/starlette/responses.py
@@ -10,11 +10,11 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
+    def data(self) -> bytes:
         if isinstance(self.response.body, bytes):
-            return self.response.body.decode("utf-8")
+            return self.response.body
         assert isinstance(self.response.body, str)
-        return self.response.body
+        return self.response.body.encode("utf-8")
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/contrib/werkzeug/responses.py b/openapi_core/contrib/werkzeug/responses.py
@@ -10,8 +10,8 @@ def __init__(self, response: Response):
         self.response = response
 
     @property
-    def data(self) -> str:
-        return self.response.get_data(as_text=True)
+    def data(self) -> bytes:
+        return self.response.get_data(as_text=False)
 
     @property
     def status_code(self) -> int:

diff --git a/openapi_core/protocols.py b/openapi_core/protocols.py
@@ -120,7 +120,7 @@ class Response(Protocol):
     """
 
     @property
-    def data(self) -> str:
+    def data(self) -> Optional[bytes]:
         ...
 
     @property

diff --git a/openapi_core/testing/responses.py b/openapi_core/testing/responses.py
@@ -9,7 +9,7 @@
 class MockResponse:
     def __init__(
         self,
-        data: str,
+        data: bytes,
         status_code: int = 200,
         headers: Optional[Dict[str, Any]] = None,
         content_type: str = "application/json",

diff --git a/tests/integration/contrib/aiohttp/test_aiohttp_project.py b/tests/integration/contrib/aiohttp/test_aiohttp_project.py
@@ -38,10 +38,6 @@ def api_key_encoded(self):
 
 
 class TestPetPhotoView(BaseTestPetstore):
-    @pytest.mark.xfail(
-        reason="response binary format not supported",
-        strict=True,
-    )
     async def test_get_valid(self, client, data_gif):
         headers = {
             "Authorization": "Basic testuser",

diff --git a/tests/integration/contrib/django/test_django_project.py b/tests/integration/contrib/django/test_django_project.py
@@ -398,10 +398,6 @@ def test_get_skip_response_validation(self, client):
 
 
 class TestPetPhotoView(BaseTestDjangoProject):
-    @pytest.mark.xfail(
-        reason="response binary format not supported",
-        strict=True,
-    )
     def test_get_valid(self, client, data_gif):
         headers = {
             "HTTP_AUTHORIZATION": "Basic testuser",

diff --git a/tests/integration/contrib/requests/test_requests_validation.py b/tests/integration/contrib/requests/test_requests_validation.py
@@ -165,10 +165,6 @@ def request_unmarshaller(self, spec):
     def response_unmarshaller(self, spec):
         return V30ResponseUnmarshaller(spec)
 
-    @pytest.mark.xfail(
-        reason="response binary format not supported",
-        strict=True,
-    )
     @responses.activate
     def test_response_binary_valid(self, response_unmarshaller, data_gif):
         responses.add(

diff --git a/tests/integration/test_petstore.py b/tests/integration/test_petstore.py
@@ -123,7 +123,7 @@ def test_get_pets(self, spec):
         data_json = {
             "data": [],
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         headers = {
             "Content-Type": "application/json",
             "x-next": "next-url",
@@ -185,7 +185,7 @@ def test_get_pets_response(self, spec):
                 }
             ],
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -286,7 +286,7 @@ def test_get_pets_invalid_response(self, spec, response_unmarshaller):
                 }
             ],
         }
-        response_data = json.dumps(response_data_json)
+        response_data = json.dumps(response_data_json).encode()
         response = MockResponse(response_data)
 
         with pytest.raises(InvalidData) as exc_info:
@@ -349,7 +349,7 @@ def test_get_pets_ids_param(self, spec):
         data_json = {
             "data": [],
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -398,7 +398,7 @@ def test_get_pets_tags_param(self, spec):
         data_json = {
             "data": [],
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1267,7 +1267,7 @@ def test_post_pets_raises_invalid_server_error(self, spec):
                 },
             },
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         with pytest.raises(ServerNotFound):
@@ -1362,7 +1362,7 @@ def test_get_pet(self, spec):
                 },
             },
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1413,7 +1413,7 @@ def test_get_pet_not_found(self, spec):
             "message": message,
             "rootCause": rootCause,
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data, status_code=404)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1492,7 +1492,7 @@ def test_get_tags(self, spec):
         assert result.body is None
 
         data_json = ["cats", "birds"]
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1637,7 +1637,7 @@ def test_post_tags_additional_properties(self, spec):
             "rootCause": rootCause,
             "additionalinfo": additionalinfo,
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data, status_code=404)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1694,7 +1694,7 @@ def test_post_tags_created_now(self, spec):
             "rootCause": "Tag already exist",
             "additionalinfo": "Tag Dog already exist",
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data, status_code=404)
 
         response_result = unmarshal_response(request, response, spec=spec)
@@ -1753,7 +1753,7 @@ def test_post_tags_created_datetime(self, spec):
             "rootCause": rootCause,
             "additionalinfo": additionalinfo,
         }
-        response_data = json.dumps(response_data_json)
+        response_data = json.dumps(response_data_json).encode()
         response = MockResponse(response_data, status_code=404)
 
         result = unmarshal_response(
@@ -1827,7 +1827,7 @@ def test_post_tags_urlencoded(self, spec):
             "rootCause": rootCause,
             "additionalinfo": additionalinfo,
         }
-        response_data = json.dumps(response_data_json)
+        response_data = json.dumps(response_data_json).encode()
         response = MockResponse(response_data, status_code=404)
 
         result = unmarshal_response(
@@ -1898,7 +1898,7 @@ def test_post_tags_created_invalid_type(self, spec):
             "rootCause": rootCause,
             "additionalinfo": additionalinfo,
         }
-        data = json.dumps(data_json)
+        data = json.dumps(data_json).encode()
         response = MockResponse(data, status_code=404)
 
         response_result = unmarshal_response(request, response, spec=spec)

diff --git a/tests/integration/unmarshalling/test_read_only_write_only.py b/tests/integration/unmarshalling/test_read_only_write_only.py
@@ -55,7 +55,7 @@ def test_read_only_property_response(self, response_unmarshaller):
                 "id": 10,
                 "name": "Pedro",
             }
-        )
+        ).encode()
 
         request = MockRequest(host_url="", method="POST", path="/users")
 

diff --git a/tests/integration/unmarshalling/test_response_unmarshaller.py b/tests/integration/unmarshalling/test_response_unmarshaller.py
@@ -39,7 +39,7 @@ def response_unmarshaller(self, spec):
 
     def test_invalid_server(self, response_unmarshaller):
         request = MockRequest("http://petstore.invalid.net/v1", "get", "/")
-        response = MockResponse("Not Found", status_code=404)
+        response = MockResponse(b"Not Found", status_code=404)
 
         result = response_unmarshaller.unmarshal(request, response)
 
@@ -50,7 +50,7 @@ def test_invalid_server(self, response_unmarshaller):
 
     def test_invalid_operation(self, response_unmarshaller):
         request = MockRequest(self.host_url, "patch", "/v1/pets")
-        response = MockResponse("Not Found", status_code=404)
+        response = MockResponse(b"Not Found", status_code=404)
 
         result = response_unmarshaller.unmarshal(request, response)
 
@@ -61,7 +61,7 @@ def test_invalid_operation(self, response_unmarshaller):
 
     def test_invalid_response(self, response_unmarshaller):
         request = MockRequest(self.host_url, "get", "/v1/pets")
-        response = MockResponse("Not Found", status_code=409)
+        response = MockResponse(b"Not Found", status_code=409)
 
         result = response_unmarshaller.unmarshal(request, response)
 
@@ -72,7 +72,7 @@ def test_invalid_response(self, response_unmarshaller):
 
     def test_invalid_content_type(self, response_unmarshaller):
         request = MockRequest(self.host_url, "get", "/v1/pets")
-        response = MockResponse("Not Found", content_type="text/csv")
+        response = MockResponse(b"Not Found", content_type="text/csv")
 
         result = response_unmarshaller.unmarshal(request, response)
 
@@ -93,20 +93,20 @@ def test_missing_body(self, response_unmarshaller):
 
     def test_invalid_media_type(self, response_unmarshaller):
         request = MockRequest(self.host_url, "get", "/v1/pets")
-        response = MockResponse("abcde")
+        response = MockResponse(b"abcde")
 
         result = response_unmarshaller.unmarshal(request, response)
 
         assert result.errors == [DataValidationError()]
         assert result.errors[0].__cause__ == MediaTypeDeserializeError(
-            mimetype="application/json", value="abcde"
+            mimetype="application/json", value=b"abcde"
         )
         assert result.data is None
         assert result.headers == {}
 
     def test_invalid_media_type_value(self, response_unmarshaller):
         request = MockRequest(self.host_url, "get", "/v1/pets")
-        response = MockResponse("{}")
+        response = MockResponse(b"{}")
 
         result = response_unmarshaller.unmarshal(request, response)
 
@@ -154,7 +154,7 @@ def test_invalid_header(self, response_unmarshaller):
                 },
             ],
         }
-        response_data = json.dumps(response_json)
+        response_data = json.dumps(response_json).encode()
         headers = {
             "x-delete-confirm": "true",
             "x-delete-date": "today",
@@ -181,7 +181,7 @@ def test_get_pets(self, response_unmarshaller):
                 },
             ],
         }
-        response_data = json.dumps(response_json)
+        response_data = json.dumps(response_json).encode()
         response = MockResponse(response_data)
 
         result = response_unmarshaller.unmarshal(request, response)