Merge pull request #3 from ljensen505/add-unittests

added unittests for the events controller

.github/workflows/client-build.yml

@@ -1,4 +1,4 @@
-name: build app
+name: react client build
 
 on:
   push:

.github/workflows/server-build.yml

@@ -1,4 +1,4 @@
-name: thegrapefruitsduo fastapi build
+name: fastapi build
 
 on:
   push:

server/README.md

@@ -28,10 +28,10 @@ To seed the mysql database:
 poetry run seed
 ```
 
-To retrieve a token for testing:
+Automated tests can be run with:
 
 ```bash
-poetry run token
+poetry run pytest
 ```
 
 To run the FastAPI app in development mode:

server/app/controllers/events.py

@@ -10,9 +10,9 @@ from app.models.event import Event, EventSeries, NewEventSeries
 
 
 class EventController(BaseController):
-    def __init__(self) -> None:
+    def __init__(self, eq=event_queries) -> None:
         super().__init__()
-        self.db: EventQueries = event_queries
+        self.db: EventQueries = eq
 
     def _all_series(self, data: list[dict]) -> list[EventSeries]:
         all_series: dict[str, EventSeries] = {}

server/pyproject.toml

@@ -29,7 +29,6 @@ pytest = "^8.1.1"
 [tool.poetry.scripts]
 dev = "app.scripts.run:main"
 seed = "app.scripts.seed:main"
-token = "app.scripts.token:main"
 
 
 [build-system]

server/tests/controllers/test_event_controller.py

@@ -0,0 +1,194 @@
+from datetime import datetime
+from unittest.mock import Mock
+
+import pytest
+from pydantic_core import Url
+
+from app.controllers.events import EventController
+from app.models.event import Event, EventSeries
+
+mock_queries = Mock()
+ec = EventController(eq=mock_queries)
+
+
+def test_type():
+    assert isinstance(ec, EventController)
+
+
+@pytest.mark.asyncio
+async def test_all_series_with_no_data():
+    async def select_all_series() -> list[dict]:
+        return []
+
+    mock_queries.select_all_series = select_all_series
+    result = await ec.get_all_series()
+    assert result == []
+
+
+@pytest.mark.asyncio
+async def test_all_series_with_basic_data():
+    async def select_all_series() -> list[dict]:
+        return [
+            {
+                "name": "Test Series",
+                "description": "Test Description",
+                "series_id": 1,
+                "poster_id": "abc123",
+            }
+        ]
+
+    mock_queries.select_all_series = select_all_series
+    result = await ec.get_all_series()
+    assert isinstance(result, list)
+    assert len(result) == 1
+    series = result[0]
+    assert isinstance(series, EventSeries)
+    assert series.name == "Test Series"
+    assert series.description == "Test Description"
+    assert series.series_id == 1
+    assert series.poster_id == "abc123"
+    assert series.events == []
+
+
+@pytest.mark.asyncio
+async def test_all_series_with_detailed_data():
+    series_id = 1
+    series_name = "The Grapefruits Duo Presents: Works for Horn and Piano"
+    series_description = "Pieces by Danzi, Gomez, Gounod, Grant, and Rusnak!"
+    poster_id = "The_Grapefruits_Present_qhng6y"
+    eventbrite_url = "https://www.eventbrite.com/e/the-grapefruits-duo-presents-works-for-horn-and-piano-tickets-1234567890"
+    medford = "Medford, OR"
+    newport_church = "First Presbyterian Church Newport"
+    eugene_church = "First Church of Christ, Scientist, Eugene"
+    map_url = "https://maps.app.goo.gl/hNfN8X5FBZLg8LDF8"
+
+    async def select_all_series() -> list[dict]:
+
+        row_1 = {
+            "series_id": series_id,
+            "name": series_name,
+            "description": series_description,
+            "poster_id": poster_id,
+            "event_id": 1,
+            "location": medford,
+            "time": "2024-05-31 19:00:00.000",
+            "ticket_url": eventbrite_url,
+        }
+        row_2 = {
+            "series_id": series_id,
+            "name": series_name,
+            "description": series_description,
+            "poster_id": poster_id,
+            "event_id": 2,
+            "location": newport_church,
+            "time": "2024-06-16 16:00:00.000",
+            "map_url": map_url,
+        }
+        row_3 = {
+            "series_id": series_id,
+            "name": series_name,
+            "description": series_description,
+            "poster_id": poster_id,
+            "event_id": 3,
+            "location": eugene_church,
+            "time": "2024-06-23 15:00:00.000",
+        }
+        return [
+            row_1,
+            row_2,
+            row_3,
+        ]
+
+    mock_queries.select_all_series = select_all_series
+    result = await ec.get_all_series()
+    assert isinstance(result, list)
+    assert len(result) == 1
+    series = result[0]
+    assert isinstance(series, EventSeries)
+    assert series.name == series_name
+    assert series.description == series_description
+    assert series.series_id == series_id
+    assert series.poster_id == poster_id
+    events = series.events
+    assert len(events) == 3
+
+    for e in events:
+        assert isinstance(e, Event)
+        assert e.location is not None
+        assert isinstance(e.time, datetime)
+        assert e.event_id is not None
+        if e.map_url is not None:
+            assert isinstance(e.map_url, Url)
+        if e.ticket_url is not None:
+            assert isinstance(e.ticket_url, Url)
+
+    e1, e2, e3 = events
+    assert e1.event_id == 1
+    assert e2.event_id == 2
+    assert e3.event_id == 3
+    assert e1.location == medford
+    assert e2.location == newport_church
+    assert e3.location == eugene_church
+    assert str(e1.ticket_url) == eventbrite_url
+    assert e2.ticket_url is None
+    assert e3.ticket_url is None
+    assert e1.map_url is None
+    assert str(e2.map_url) == map_url
+    assert e3.map_url is None
+    assert e1.time == datetime(2024, 5, 31, 19, 0)
+    assert e2.time == datetime(2024, 6, 16, 16, 0)
+    assert e3.time == datetime(2024, 6, 23, 15, 0)
+
+
+@pytest.mark.asyncio
+async def test_all_series_with_many_series():
+    async def select_all_series() -> list[dict]:
+        return [
+            {
+                "name": "Test Series",
+                "description": "Test Description",
+                "series_id": 1,
+                "poster_id": "abc123",
+            },
+            {
+                "name": "Test Series 2",
+                "description": "Test Description 2",
+                "series_id": 2,
+                "poster_id": "def456",
+            },
+            {
+                "name": "Test Series 3",
+                "description": "Test Description 3",
+                "series_id": 3,
+                "poster_id": "ghi789",
+            },
+        ]
+
+    mock_queries.select_all_series = select_all_series
+    result = await ec.get_all_series()
+    assert isinstance(result, list)
+    assert len(result) == 3
+    for series in result:
+        assert isinstance(series, EventSeries)
+        assert series.events == []
+
+
+@pytest.mark.asyncio
+async def test_all_series_with_error():
+    mock_log_error = Mock()
+    ec.log_error = mock_log_error
+
+    async def select_all_series() -> list[dict]:
+        # no series name
+        return [
+            {
+                "description": "Test Description",
+                "series_id": 1,
+                "poster_id": "abc123",
+            }
+        ]
+
+    mock_queries.select_all_series = select_all_series
+    with pytest.raises(Exception):
+        await ec.get_all_series()
+        Mock.assert_called_once(mock_log_error)

server/tests/test_app.py

@@ -1,9 +0,0 @@
-from fastapi.testclient import TestClient
-
-from app import app
-
-client = TestClient(app=app)
-
-
-def test_app():
-    assert isinstance(client, TestClient)