Merge pull request #19 from Promptly-Technologies-LLC/18-add-a-test-suite

Starter unit test suite

Author: chriscarrollsmith

main.py

@@ -11,7 +11,8 @@
 from sqlmodel import Session
 from routers import authentication, organization, role, user
 from utils.auth import get_authenticated_user, get_optional_user, NeedsNewTokens, get_user_from_reset_token, PasswordValidationError
-from utils.db import User, get_session
+from utils.models import User
+from utils.db import get_session, set_up_db
 
 
 logger = logging.getLogger("uvicorn.error")
@@ -21,6 +22,7 @@
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     # Optional startup logic
+    set_up_db(drop=False)
     yield
     # Optional shutdown logic
 
@@ -63,9 +65,9 @@ async def needs_new_tokens_handler(request: Request, exc: NeedsNewTokens):
 @app.exception_handler(PasswordValidationError)
 async def password_validation_exception_handler(request: Request, exc: PasswordValidationError):
     return templates.TemplateResponse(
+        request,
         "errors/validation_error.html",
         {
-            "request": request,
             "status_code": 422,
             "errors": {"error": exc.detail}
         },
@@ -91,9 +93,9 @@ async def validation_exception_handler(request: Request, exc: RequestValidationE
         errors[field_name] = error["msg"]
 
     return templates.TemplateResponse(
+        request,
         "errors/validation_error.html",
         {
-            "request": request,
             "status_code": 422,
             "errors": errors
         },
@@ -109,8 +111,9 @@ async def http_exception_handler(request: Request, exc: StarletteHTTPException):
         raise exc
 
     return templates.TemplateResponse(
+        request,
         "errors/error.html",
-        {"request": request, "status_code": exc.status_code, "detail": exc.detail},
+        {"status_code": exc.status_code, "detail": exc.detail},
         status_code=exc.status_code,
     )
 
@@ -122,9 +125,9 @@ async def general_exception_handler(request: Request, exc: Exception):
     logger.error(f"Unhandled exception: {exc}", exc_info=True)
 
     return templates.TemplateResponse(
+        request,
         "errors/error.html",
         {
-            "request": request,
             "status_code": 500,
             "detail": "Internal Server Error"
         },
@@ -150,7 +153,7 @@ async def read_home(
 ):
     if params["user"]:
         return RedirectResponse(url="/dashboard", status_code=302)
-    return templates.TemplateResponse("index.html", params)
+    return templates.TemplateResponse(params["request"], "index.html", params)
 
 
 @app.get("/login")
@@ -159,7 +162,7 @@ async def read_login(
 ):
     if params["user"]:
         return RedirectResponse(url="/dashboard", status_code=302)
-    return templates.TemplateResponse("authentication/login.html", params)
+    return templates.TemplateResponse(params["request"], "authentication/login.html", params)
 
 
 @app.get("/register")
@@ -168,7 +171,7 @@ async def read_register(
 ):
     if params["user"]:
         return RedirectResponse(url="/dashboard", status_code=302)
-    return templates.TemplateResponse("authentication/register.html", params)
+    return templates.TemplateResponse(params["request"], "authentication/register.html", params)
 
 
 @app.get("/forgot_password")
@@ -180,22 +183,22 @@ async def read_forgot_password(
         return RedirectResponse(url="/dashboard", status_code=302)
     params["show_form"] = show_form
 
-    return templates.TemplateResponse("authentication/forgot_password.html", params)
+    return templates.TemplateResponse(params["request"], "authentication/forgot_password.html", params)
 
 
 @app.get("/about")
 async def read_about(params: dict = Depends(common_unauthenticated_parameters)):
-    return templates.TemplateResponse("about.html", params)
+    return templates.TemplateResponse(params["request"], "about.html", params)
 
 
 @app.get("/privacy_policy")
 async def read_privacy_policy(params: dict = Depends(common_unauthenticated_parameters)):
-    return templates.TemplateResponse("privacy_policy.html", params)
+    return templates.TemplateResponse(params["request"], "privacy_policy.html", params)
 
 
 @app.get("/terms_of_service")
 async def read_terms_of_service(params: dict = Depends(common_unauthenticated_parameters)):
-    return templates.TemplateResponse("terms_of_service.html", params)
+    return templates.TemplateResponse(params["request"], "terms_of_service.html", params)
 
 
 @app.get("/reset_password")
@@ -214,7 +217,7 @@ async def read_reset_password(
     params["email"] = email
     params["token"] = token
 
-    return templates.TemplateResponse("authentication/reset_password.html", params)
+    return templates.TemplateResponse(params["request"], "authentication/reset_password.html", params)
 
 
 # -- Authenticated Routes --
@@ -236,7 +239,7 @@ async def read_dashboard(
 ):
     if not params["user"]:
         return RedirectResponse(url="/login", status_code=status.HTTP_302_FOUND)
-    return templates.TemplateResponse("dashboard/index.html", params)
+    return templates.TemplateResponse(params["request"], "dashboard/index.html", params)
 
 
 @app.get("/profile")
@@ -246,7 +249,7 @@ async def read_profile(
     if not params["user"]:
         # Changed to 302
         return RedirectResponse(url="/login", status_code=status.HTTP_302_FOUND)
-    return templates.TemplateResponse("users/profile.html", params)
+    return templates.TemplateResponse(params["request"], "users/profile.html", params)
 
 
 # -- Include Routers --

poetry.lock

@@ -13,7 +13,7 @@ pyjwt = "^2.10.0"
 jinja2 = "^3.1.4"
 uvicorn = "^0.32.0"
 psycopg2 = "^2.9.10"
-pydantic = "^2.9.2"
+pydantic = {extras = ["email"], version = "^2.9.2"}
 python-multipart = "^0.0.17"
 python-dotenv = "^1.0.1"
 resend = "^2.4.0"
@@ -27,6 +27,7 @@ quarto = "^0.1.0"
 mypy = "^1.11.2"
 jupyter = "^1.1.1"
 notebook = "^7.2.2"
+pytest = "^8.3.3"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -6,7 +6,7 @@
 from fastapi.responses import RedirectResponse
 from pydantic import BaseModel, EmailStr, ConfigDict
 from sqlmodel import Session, select
-from utils.db import User
+from utils.models import User
 from utils.auth import (
     get_session,
     get_user_from_reset_token,

routers/authentication.py

@@ -3,7 +3,8 @@
 from fastapi.responses import RedirectResponse
 from pydantic import BaseModel, ConfigDict
 from sqlmodel import Session, select
-from utils.db import Organization, get_session
+from utils.db import get_session
+from utils.models import Organization
 from datetime import datetime
 
 logger = getLogger("uvicorn.error")

routers/organization.py

@@ -4,8 +4,9 @@
 from fastapi import APIRouter, Depends, HTTPException, Form
 from fastapi.responses import RedirectResponse
 from pydantic import BaseModel, ConfigDict
-from sqlmodel import Session, select, delete
-from utils.db import Role, RolePermissionLink, ValidPermissions, get_session, utc_time
+from sqlmodel import Session, select
+from utils.db import get_session
+from utils.models import Role, RolePermissionLink, ValidPermissions, utc_time
 
 logger = getLogger("uvicorn.error")
 

routers/role.py

@@ -2,7 +2,7 @@
 from fastapi.responses import RedirectResponse
 from pydantic import BaseModel, EmailStr
 from sqlmodel import Session
-from utils.db import User
+from utils.models import User
 from utils.auth import get_session, get_authenticated_user, verify_password
 
 router = APIRouter(prefix="/user", tags=["user"])

routers/user.py

@@ -0,0 +1,51 @@
+import pytest
+from sqlmodel import create_engine, Session, delete
+from utils.db import get_connection_url, set_up_db, tear_down_db
+from utils.models import User, PasswordResetToken
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+@pytest.fixture(scope="session")
+def engine():
+    """
+    Create a new SQLModel engine for the test database.
+    Use an in-memory SQLite database for testing.
+    """
+    engine = create_engine(
+        get_connection_url()
+    )
+    return engine
+
+
+@pytest.fixture(scope="session", autouse=True)
+def set_up_database(engine):
+    """
+    Set up the test database before running the test suite.
+    Drop all tables and recreate them to ensure a clean state.
+    """
+    set_up_db(drop=True)
+    yield
+    tear_down_db()
+
+
+@pytest.fixture
+def session(engine):
+    """
+    Provide a session for database operations in tests.
+    """
+    with Session(engine) as session:
+        yield session
+
+
+@pytest.fixture(autouse=True)
+def clean_db(session: Session):
+    """
+    Cleans up the database tables before each test.
+    """
+    # Exempt from mypy until SQLModel overload properly supports delete()
+    session.exec(delete(PasswordResetToken))  # type: ignore
+    session.exec(delete(User))  # type: ignore
+
+    session.commit()