Added unit testing with in-memory database and TestClient.

README.md

@@ -11,7 +11,7 @@ alembic upgrade head
 To run the uvicorn server, use the below code:
 
 ```shell
-uvicorn app.main:case_api --reload
+uvicorn app:case_api --reload
 ```
 
 # Migrations

alembic.ini

@@ -60,7 +60,7 @@ version_path_separator = os  # Use os.pathsep. Default configuration used for ne
 # are written from script.py.mako
 # output_encoding = utf-8
 
-sqlalchemy.url = sqlite:///database.db
+sqlalchemy.url = None
 
 
 [post_write_hooks]

app/__init__.py

@@ -0,0 +1,3 @@
+from app.main import create_app
+
+case_api = create_app()

app/db/__init__.py

@@ -0,0 +1,3 @@
+from app.db.database import engine
+
+db_engine = engine

app/db/database.py

@@ -1,5 +1,4 @@
-# One line of FastAPI imports here later 👈
-from sqlmodel import create_engine
+from sqlmodel import create_engine, Session
 import os
 
 cwd = os.getcwd()
@@ -9,3 +8,8 @@
 
 connect_args = {"check_same_thread": False}
 engine = create_engine(sqlite_url, echo=True, connect_args=connect_args)
+
+
+def get_session():
+    with Session(engine) as session:
+        yield session

app/main.py

@@ -2,14 +2,12 @@
 from .routers import case_information
 import os
 
-cwd = os.getcwd()
-os.chdir("./app")
-
 
 def create_app():
     app = FastAPI()
     app.include_router(case_information.router)
     return app
 
-
-case_api = create_app()
+if __name__ == "__main__":
+    cwd = os.getcwd()
+    os.chdir("./app")

app/migrations/env.py

@@ -1,6 +1,8 @@
 from logging.config import fileConfig
 
-from app.models.cases import Case  # noqa: F401
+# This imports all the models
+from app.models import *  # noqa: F401
+
 from sqlalchemy import engine_from_config
 from sqlalchemy import pool
 from sqlmodel import SQLModel
@@ -10,6 +12,7 @@
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
 config = context.config
+config.set_main_option('sqlalchemy.url', 'sqlite:///database.db')
 
 # Interpret the config file for Python logging.
 # This line sets up loggers basically.

app/models/__init__.py

@@ -1 +1 @@
-
+from .cases import Case

app/models/cases.py

@@ -1,4 +1,3 @@
-# One line of FastAPI imports here later 👈
 from sqlmodel import Field, SQLModel
 from datetime import datetime
 from .categories import Categories
@@ -10,13 +9,13 @@ class BaseCase(SQLModel):
 
 
 class Case(BaseCase, table=True):
-    id: int | None = Field(default=None, primary_key=True)
+    id: int = Field(default=None, primary_key=True)
     time: datetime
 
 
-class CaseCreate(BaseCase):
+class CaseRequest(BaseCase):
     pass
 
 
-class CaseRead(SQLModel):
+class CaseLookup(SQLModel):
     id: int

app/routers/case_information.py

@@ -1,8 +1,8 @@
-from fastapi import APIRouter, HTTPException
-from ..models.cases import CaseCreate, Case
+from fastapi import APIRouter, HTTPException, Depends
+from ..models.cases import CaseRequest, Case
 from datetime import datetime
 from sqlmodel import Session, select
-from app.db.database import engine
+from app.db.database import get_session
 import random
 
 router = APIRouter(
@@ -13,30 +13,27 @@
 
 
 @router.get("/{case_id}", tags=["cases"])
-async def read_case(case_id: str):
-    with Session(engine) as session:
-        case = session.get(Case, case_id)
-        if not case:
-            raise HTTPException(status_code=404, detail="Case not found")
-        return case
+async def read_case(case_id: str, session: Session = Depends(get_session),):
+    case = session.get(Case, case_id)
+    if not case:
+        raise HTTPException(status_code=404, detail="Case not found")
+    return case
 
 
 @router.get("/", tags=["cases"])
-async def read_all_cases():
-    with Session(engine) as session:
-        cases = session.exec(select(Case)).all()
-        return cases
+async def read_all_cases(session: Session = Depends(get_session)):
+    cases = session.exec(select(Case)).all()
+    return cases
 
 
 def generate_id():
     return str(random.randint(1, 100000))
 
 
 @router.post("/", tags=["cases"], response_model=Case)
-def create_case(request: CaseCreate):
-    with Session(engine) as session:
-        case = Case(category=request.category, time=datetime.now(), name=request.name, id=generate_id())
-        session.add(case)
-        session.commit()
-        session.refresh(case)
-        return case
+def create_case(request: CaseRequest, session: Session = Depends(get_session)):
+    case = Case(category=request.category, time=datetime.now(), name=request.name, id=generate_id())
+    session.add(case)
+    session.commit()
+    session.refresh(case)
+    return case

pyproject.toml

@@ -0,0 +1,5 @@
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore",
+    "default:::app",
+]

tests/cases/test_cases.py

@@ -0,0 +1,19 @@
+from fastapi.testclient import TestClient
+from sqlmodel import Session
+
+
+def test_create_case(client: TestClient, session: Session):
+    response = client.post(
+            "/cases/", json={"category": "Housing", "name": "John Doe"})
+    case = response.json()
+
+    assert response.status_code == 200
+    assert case["category"] == "Housing"
+    assert case["name"] == "John Doe"
+    assert case["id"] is not None
+
+
+def test_read_case(client: TestClient, session: Session):
+    response = client.post(
+            "/cases/", json={"category": "Housing", "name": "John Doe"})
+    case = response.json()

tests/conftest.py

@@ -0,0 +1,27 @@
+import pytest
+from sqlmodel import SQLModel, create_engine, Session, StaticPool
+from app import case_api
+from app.db.database import get_session
+from fastapi.testclient import TestClient
+
+
+@pytest.fixture(name="session")
+def session_fixture():
+    engine = create_engine(
+        "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
+    )
+    SQLModel.metadata.create_all(engine)
+    with Session(engine) as session:
+        yield session
+
+
+@pytest.fixture(name="client")
+def client_fixture(session: Session):
+    def get_session_override():
+        return session
+
+    case_api.dependency_overrides[get_session] = get_session_override
+
+    client = TestClient(case_api)
+    yield client
+    case_api.dependency_overrides.clear()