Fix event endpoint tests and typing

Author: febus982

http_app/routes/events.py

@@ -1,7 +1,8 @@
 import typing
-from typing import Any, Dict, List
+from typing import Dict, List
 
 from fastapi import APIRouter, Body, Header, HTTPException
+from fastapi.openapi.models import Example
 from pydantic import BaseModel
 
 from domains.books.events import BookCreatedV1
@@ -23,7 +24,7 @@ def _event_registry() -> Dict[str, typing.Type[BaseModel]]:
     }
 
 
-def _event_schema_examples() -> dict[str, dict[str, Any]]:
+def _event_schema_examples() -> dict[str, Example]:
     missing_example_message = (
         "No example has been added to this event but you can"
         " still explore the event schema. (Ask the developer"
@@ -32,11 +33,11 @@ def _event_schema_examples() -> dict[str, dict[str, Any]]:
     )
 
     return {
-        k: {
-            "value": getattr(v, "model_config", {})
+        k: Example(
+            value=getattr(v, "model_config", {})
             .get("json_schema_extra", {})
             .get("examples", [missing_example_message])[0]
-        }
+        )
         for k, v in _event_registry().items()
     }
 
@@ -85,6 +86,5 @@ async def submit_event(
         "application/cloudevents+json; charset=UTF-8"
     ] = Header(),
 ) -> None:
-    # A better approach than if/else should be used when we have multiple event types
-    if isinstance(event_data, BookCreatedV1):
-        await BookService().book_created_event_handler(event_data.data.book_id)
+    # Some routing will be necessary when multiple event types will be supported
+    await BookService().book_created_event_handler(event_data.data.book_id)

tests/http_app/routes/test_events.py

@@ -1,7 +1,8 @@
-from unittest.mock import patch
+from unittest.mock import AsyncMock, MagicMock, patch
 
 from httpx import AsyncClient
 
+from domains.books import service
 from domains.books.events import BookCreatedV1
 from domains.common.cloudevent_base import BaseEvent
 
@@ -39,12 +40,16 @@ async def test_event_returns_204(testapp):
     fake_event = BookCreatedV1(
         data={"book_id": 0, "title": "string", "author_name": "string"},
     )
-    async with AsyncClient(app=testapp, base_url="http://test") as ac:
-        response = await ac.post(
-            "/events",
-            headers={"content-type": "application/cloudevents+json; charset=UTF-8"},
-            content=fake_event.model_dump_json(),
-        )
+    svc = MagicMock(autospec=service.BookService)
+    svc.book_created_event_handler = AsyncMock(return_value=None)
+    with patch("domains.books.service.BookService.__new__", return_value=svc):
+        async with AsyncClient(app=testapp, base_url="http://test") as ac:
+            response = await ac.post(
+                "/events",
+                headers={"content-type": "application/cloudevents+json; charset=UTF-8"},
+                content=fake_event.model_dump_json(),
+            )
+    svc.book_created_event_handler.assert_called_once()
     assert response.status_code == 204