feat: adding tests

Author: wjohnsto

.dockerignore

@@ -1,7 +1,6 @@
-# Python
 __pycache__
 *.pyc
-.mypy_cache
+.*_cache
 .coverage
 htmlcov
 .venv

.gitignore

@@ -1,8 +1,7 @@
 # Python
 __pycache__
 *.pyc
-.mypy_cache
-.ruff_cache
+.*_cache
 .coverage
 htmlcov
 .venv

Dockerfile

@@ -26,7 +26,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
 ENV PYTHONPATH=/app
 
 COPY ./pyproject.toml ./uv.lock /app/
-COPY ./app /app/app
+COPY ./src /app/src/
 
 # Sync the project
 # Ref: https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
@@ -37,5 +37,5 @@ ENV PORT 8080
 
 EXPOSE ${PORT}
 
-CMD ["sh", "-c", "fastapi run --port ${PORT} app/main.py"]
+CMD ["sh", "-c", "fastapi run --port ${PORT} src/app/main.py"]
 

Makefile

@@ -2,22 +2,25 @@ install:
 	@uv sync --all-extras
 
 dev: install
-	@fastapi dev app/main.py
+	@fastapi dev src/app/main.py
 
 serve: install
-	@fastapi run app/main.py
+	@fastapi run src/app/main.py
+
+test:
+	@pytest -rxP
 
 docker:
 	@docker compose up -d
 
 format: install
-	@ruff check app --fix
-	@ruff format app
+	@ruff check src/app --fix
+	@ruff format src/app
 
 lint: install
-	@mypy app
-	@ruff check app
-	@ruff format app --check
+	@mypy src/app
+	@ruff check src/app
+	@ruff format src/app --check
 
 lock: install
 	@uv lock

__test__/conftest.py

@@ -0,0 +1,10 @@
+import pytest
+
+from pytest_asyncio import is_async_test
+
+
+def pytest_collection_modifyitems(items):
+    pytest_asyncio_tests = (item for item in items if is_async_test(item))
+    session_scope_marker = pytest.mark.asyncio(loop_scope="session")
+    for async_test in pytest_asyncio_tests:
+        async_test.add_marker(session_scope_marker, append=False)

__test__/todos_test.py

@@ -0,0 +1,55 @@
+import asyncio
+import pytest
+from app.redis import redis
+from app.components.todos.store import TodoStatus, TodoStore
+
+todos = TodoStore(redis)
+
+@pytest.fixture(autouse=True)
+async def run_around_each():
+    await todos.initialize()
+    yield
+    await todos.delete_all()
+    await todos.drop_index()
+
+async def test_crud_for_single_todo():
+    created_todo = await todos.create(None, "Take out the trash")
+    todo_id = created_todo.id
+
+    assert created_todo.value.name == "Take out the trash"
+    assert created_todo.value.status == "todo"
+
+    read_todo = await todos.one(todo_id)
+
+    assert created_todo.value.name == read_todo.name
+    assert created_todo.value.status == read_todo.status
+
+    updated_todo = await todos.update(todo_id, TodoStatus.in_progress)
+
+    assert updated_todo.name == read_todo.name
+    assert updated_todo.status == TodoStatus.in_progress
+    assert updated_todo.updated_date > updated_todo.created_date
+    assert updated_todo.updated_date > read_todo.updated_date
+
+    await todos.delete(todo_id)
+
+
+async def test_crud_for_multiple_todos():
+    all_todo_names = [
+      "Take out the trash",
+      "Vacuum downstairs",
+      "Fold the laundry",
+    ]
+
+    coros = []
+
+    for todo in all_todo_names:
+        coros.append(todos.create(None, todo))
+    await asyncio.gather(*coros)
+
+    all_todos = await todos.all()
+
+    assert all_todos.total == 3
+
+    for todo in all_todos.documents:
+        assert todo.value.name in all_todo_names

pyproject.toml

@@ -24,6 +24,12 @@ dependencies = [
     "redis[hiredis]>=5.2.1",
 ]
 
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.24.0",
+]
+
 [project.urls]
 Repository = "https://github.com/redis-developer/redis-starter-python.git"
 "Bug Tracker" = "https://github.com/redis-developer/redis-starter-python/issues"
@@ -34,8 +40,14 @@ dev = [
     "ruff<1.0.0,>=0.2.2",
 ]
 
+[tool.pytest.ini_options]
+pythonpath = "src"
+asyncio_default_fixture_loop_scope = "session"
+asyncio_mode = "auto"
+
 [tool.mypy]
 strict = true
+disallow_untyped_calls = false
 exclude = ["venv", ".venv"]
 
 [tool.ruff]

app/__init__.py renamed to src/app/__init__.py

@@ -1,13 +1,15 @@
 from typing import AsyncIterator, Never
+
 from fastapi import APIRouter, FastAPI
 from fastapi.concurrency import asynccontextmanager
 from pydantic import BaseModel
 
+from app.components.todos.store import Todo, TodoDocument, Todos, TodoStatus, TodoStore
 from app.redis import redis
-from app.components.todos.store import Todo, TodoDocument, TodoStatus, TodoStore, Todos
 
 todos = TodoStore(redis)
 
+
 @asynccontextmanager
 async def lifespan(_: FastAPI) -> AsyncIterator[Never]:
     # before
@@ -16,35 +18,44 @@ async def lifespan(_: FastAPI) -> AsyncIterator[Never]:
     # after
     return
 
+
 router = APIRouter(lifespan=lifespan)
 
+
 @router.get("/", tags=["todos"])
 async def all() -> Todos:
     return await todos.all()
 
+
 @router.get("/search", tags=["todos"])
 async def search(name: str | None = None, status: TodoStatus | None = None) -> Todos:
     return await todos.search(name, status)
 
+
 @router.get("/{id}", tags=["todos"])
 async def one(id: str) -> Todo:
     return await todos.one(id)
 
+
 class CreateTodo(BaseModel):
     id: str | None = None
     name: str
 
+
 @router.post("/", tags=["todos"])
 async def create(todo: CreateTodo) -> TodoDocument:
     return await todos.create(todo.id, todo.name)
 
+
 class UpdateTodo(BaseModel):
     status: TodoStatus
 
+
 @router.patch("/{id}", tags=["todos"])
 async def update(id: str, todo: UpdateTodo) -> Todo:
     return await todos.update(id, todo.status)
 
+
 @router.delete("/{id}", tags=["todos"])
 async def delete(id: str) -> None:
     return await todos.delete(id)