Merge pull request #54 from nathanegillett/3354

Return XML error responses for upload API [RHELDST-3354]

exodus_gw/gateway.py

@@ -1,8 +1,26 @@
 from fastapi import Depends
+from fastapi.exception_handlers import http_exception_handler
+from starlette.exceptions import HTTPException as StarletteHTTPException
 
 from .app import app
 from .publish import create_publish_id
 from .auth import call_context, CallContext
+from .s3.util import xml_response
+
+
+@app.exception_handler(StarletteHTTPException)
+async def custom_http_exception_handler(request, exc):
+    # Override HTTPException to produce XML error responses for the
+    # given endpoints.
+
+    path = request.scope.get("path")
+
+    if path.startswith("/upload"):
+        return xml_response(
+            "Error", Code=exc.status_code, Message=exc.detail, Endpoint=path
+        )
+
+    return await http_exception_handler(request, exc)
 
 
 @app.get("/healthcheck", tags=["service"])

exodus_gw/s3/util.py

@@ -53,13 +53,19 @@ def xml_response(operation: str, **kwargs) -> Response:
     """
     root = Element(operation)
 
+    status_code = kwargs.get("Code", 200)
+
     for (key, value) in kwargs.items():
         child = SubElement(root, key)
         child.text = str(value)
 
     xml = io.BytesIO()
     ElementTree(root).write(xml, encoding="UTF-8", xml_declaration=True)
-    return Response(content=xml.getvalue(), media_type="application/xml")
+    return Response(
+        content=xml.getvalue(),
+        status_code=status_code,
+        media_type="application/xml",
+    )
 
 
 class RequestReader:

tests/test_exception_handler.py

@@ -0,0 +1,30 @@
+from fastapi import HTTPException
+
+import pytest
+import mock
+
+from exodus_gw.gateway import custom_http_exception_handler
+
+TEST_KEY = "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "endpoint, media_type",
+    [
+        ("/upload/foo/%s" % TEST_KEY, "xml"),
+        ("/foo/publish/%s" % TEST_KEY, "json"),
+        ("/healthcheck", "json"),
+        ("/whoami", "json"),
+    ],
+    ids=["upload", "publish", "healthcheck", "whoami"],
+)
+async def test_custom_http_exception_handler(endpoint, media_type):
+    # Verify that HTTPExceptions raised are handled according to endpoint.
+    # Expand list of endpoints as needed.
+
+    request = mock.Mock(scope={"path": endpoint})
+    err = HTTPException(status_code=600, detail="testing response")
+    response = await custom_http_exception_handler(request, err)
+
+    assert response.media_type == "application/%s" % media_type