Add GH Actions build workflow for backend (#77)

Author: tomvothecoder

.github/workflows/build.yml

@@ -0,0 +1,155 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  backend:
+    name: Backend checks
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: simboard
+          POSTGRES_PASSWORD: simboard
+          POSTGRES_DB: simboard
+        options: >-
+          --health-cmd="pg_isready -U simboard -d simboard"
+          --health-interval=5s
+          --health-timeout=5s
+          --health-retries=5
+
+    env:
+      # --------------------------------------------------
+      # Execution context
+      # --------------------------------------------------
+      CI: "true"
+      APP_ENV: test
+
+      # --------------------------------------------------
+      # General
+      # --------------------------------------------------
+      ENV: test
+      ENVIRONMENT: test
+      DOMAIN: localhost
+      STACK_NAME: simboard
+      PORT: 8000
+
+      # --------------------------------------------------
+      # Frontend (required by backend config)
+      # --------------------------------------------------
+      FRONTEND_ORIGIN: https://127.0.0.1:5173
+      FRONTEND_AUTH_REDIRECT_URL: https://127.0.0.1:5173/auth/callback
+
+      # --------------------------------------------------
+      # Database
+      # --------------------------------------------------
+      DATABASE_URL: postgresql+psycopg://simboard:simboard@localhost:5432/simboard
+      TEST_DATABASE_URL: postgresql+psycopg://simboard:simboard@localhost:5432/simboard_test
+
+      # --------------------------------------------------
+      # GitHub OAuth (dummy values for CI)
+      # --------------------------------------------------
+      GITHUB_CLIENT_ID: dummy
+      GITHUB_CLIENT_SECRET: dummy
+      GITHUB_REDIRECT_URL: http://localhost/api/auth/github/callback
+      GITHUB_STATE_SECRET_KEY: dummy
+
+      # --------------------------------------------------
+      # Cookie config
+      # --------------------------------------------------
+      COOKIE_NAME: simboard_auth
+      COOKIE_SECURE: "false"
+      COOKIE_HTTPONLY: "true"
+      COOKIE_SAMESITE: lax
+      COOKIE_MAX_AGE: "3600"
+
+    steps:
+      # -------------------------
+      # Skip duplicate runs
+      # -------------------------
+      - name: Skip duplicate runs
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          github_token: ${{ github.token }}
+          skip_after_successful_duplicate: true
+          cancel_others: true
+
+      # -------------------------
+      # Checkout
+      # -------------------------
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # -------------------------
+      # Python
+      # -------------------------
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      # -------------------------
+      # Install uv
+      # -------------------------
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      # -------------------------
+      # Cache uv + dependencies
+      # -------------------------
+      - name: Cache uv
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/uv
+            backend/.venv
+          key: uv-${{ runner.os }}-${{ hashFiles('backend/uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-
+
+      # -------------------------
+      # Install backend deps
+      # -------------------------
+      - name: Install backend dependencies
+        working-directory: backend
+        run: |
+          uv venv .venv
+          uv sync --all-groups
+
+      # -------------------------
+      # Cache pre-commit
+      # -------------------------
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            pre-commit-${{ runner.os }}-
+
+      # -------------------------
+      # Run pre-commit
+      # -------------------------
+      - name: Run pre-commit
+        working-directory: backend
+        run: |
+          uv run pre-commit run --all-files
+
+      # -------------------------
+      # Run pytest
+      # -------------------------
+      - name: Run pytest
+        working-directory: backend
+        run: |
+          uv run pytest

.pre-commit-config.yaml

@@ -22,6 +22,17 @@ repos:
       - id: ruff-format
         files: ^backend/
 
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.2
+    hooks:
+      - id: mypy
+        name: mypy (type checking)
+        files: ^backend/.*\.py$
+        additional_dependencies:
+          - fastapi
+          - pydantic
+          - sqlalchemy
+
   # ------------------------
   # Frontend (Node / TS)
   # NOTE: Git hooks run in a non-interactive shell. Node tooling (pnpm) must be available on PATH.

backend/app/core/config.py

@@ -5,30 +5,47 @@
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
-def get_env_file(project_root: Path | None = None) -> str:
+def get_env_file(project_root: Path | None = None) -> str | None:
+    """Determine which environment-specific .env file to load.
+
+    Behavior:
+        - In CI (CI=true), rely solely on environment variables.
+        - Otherwise, require `.envs/<APP_ENV>/backend.env`.
+
+    This avoids brittle heuristics based on partial env var presence.
+
+    Parameters
+    ----------
+    project_root : Path or None, optional
+        The root directory of the project. If None, it is inferred from the file
+        location.
+
+    Returns
+    -------
+    str or None
+        The path to the environment file as a string, or None if running in CI.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the required environment file does not exist.
     """
-    Determine which environment-specific .env file to load.
+    # In CI, do not require an env file
+    if os.getenv("CI", "").lower() == "true":
+        return None
 
-    Uses APP_ENV to select one of:
-        * .envs/dev/backend.env
-        * .envs/dev_docker/backend.env
-        * .envs/prod/backend.env
-
-    Defaults to `.envs/dev/backend.env` when APP_ENV is not set.
-    Ignores any .example files.
-    """
     app_env = os.getenv("APP_ENV", "dev")
 
     if project_root is None:
         project_root = Path(__file__).resolve().parents[3]
 
     env_file = project_root / ".envs" / app_env / "backend.env"
 
-    if env_file.name.endswith(".example"):
-        raise FileNotFoundError("Refusing to load .example env files.")
-
     if not env_file.exists():
-        raise FileNotFoundError(f"Environment file '{env_file}' does not exist.")
+        raise FileNotFoundError(
+            f"Environment file '{env_file}' does not exist. "
+            "Create it or set CI=true to rely on environment variables."
+        )
 
     return str(env_file)
 

backend/app/scripts/seed.py

@@ -98,7 +98,7 @@ def create_dev_oauth_user(db: Session):
     print(f"✅ Created dummy user: {user.email}")
 
     # 3. Create the linked OAuthAccount
-    oauth: OAuthAccount = OAuthAccount(
+    oauth = OAuthAccount(
         user_id=user.id,
         oauth_name=provider,
         account_id="123456",  # fake GitHub user ID

backend/tests/core/test_config.py

@@ -5,6 +5,21 @@
 from app.core.config import get_env_file
 
 
+@pytest.fixture(autouse=True)
+def disable_ci(monkeypatch):
+    """
+    Ensure tests exercise *local development* behavior.
+
+    In CI, we intentionally set `CI=true`, which causes `get_env_file()`
+    to return None and rely solely on environment variables.
+
+    This test suite validates the *file-based* behavior used in local
+    development (i.e., resolving `.envs/<APP_ENV>/backend.env`), so we
+    explicitly unset `CI` here to avoid CI-specific code paths.
+    """
+    monkeypatch.delenv("CI", raising=False)
+
+
 class TestGetEnvFile:
     @pytest.fixture(autouse=True)
     def restore_env(self, monkeypatch):
@@ -37,7 +52,7 @@ def test_returns_dev_env_file_by_default(self, tmp_path, monkeypatch):
         (root / ".envs/dev/backend.env").write_text("OK")
         env_file = get_env_file(project_root=root)
 
-        assert env_file.endswith("dev/backend.env")
+        assert env_file.endswith("dev/backend.env")  # type: ignore[union-attr]
 
     def test_returns_dev_env_file_when_app_env_is_dev(self, tmp_path, monkeypatch):
         monkeypatch.setenv("APP_ENV", "dev")
@@ -46,7 +61,7 @@ def test_returns_dev_env_file_when_app_env_is_dev(self, tmp_path, monkeypatch):
         (root / ".envs/dev/backend.env").write_text("OK")
         env_file = get_env_file(project_root=root)
 
-        assert env_file.endswith("dev/backend.env")
+        assert env_file.endswith("dev/backend.env")  # type: ignore[union-attr]
 
     def test_returns_dev_docker_env_file_when_app_env_is_dev_docker(
         self, tmp_path, monkeypatch
@@ -55,9 +70,9 @@ def test_returns_dev_docker_env_file_when_app_env_is_dev_docker(
         root = tmp_path
         (root / ".envs/dev_docker").mkdir(parents=True)
         (root / ".envs/dev_docker/backend.env").write_text("OK")
-        env_file = get_env_file(project_root=root)
 
-        assert env_file.endswith("dev_docker/backend.env")
+        env_file = get_env_file(project_root=root)
+        assert env_file.endswith("dev_docker/backend.env")  # type: ignore[union-attr]
 
     def test_returns_prod_env_file_when_app_env_is_prod(self, tmp_path, monkeypatch):
         monkeypatch.setenv("APP_ENV", "prod")
@@ -66,7 +81,7 @@ def test_returns_prod_env_file_when_app_env_is_prod(self, tmp_path, monkeypatch)
         (root / ".envs/prod/backend.env").write_text("OK")
 
         env_file = get_env_file(project_root=root)
-        assert env_file.endswith("prod/backend.env")
+        assert env_file.endswith("prod/backend.env")  # type: ignore[union-attr]
 
     def test_raises_when_only_example_env_file_exists(self, tmp_path, monkeypatch):
         monkeypatch.setenv("APP_ENV", "dev")
@@ -84,16 +99,9 @@ def test_raises_when_env_file_does_not_exist(self, tmp_path, monkeypatch):
         with pytest.raises(FileNotFoundError):
             get_env_file(project_root=root)
 
-    def test_raises_when_env_file_is_missing_and_only_example_exists(
-        self, tmp_path, monkeypatch
-    ):
-        monkeypatch.setenv("APP_ENV", "dev")
+    def test_returns_none_if_environment_is_ci(self, tmp_path, monkeypatch):
+        monkeypatch.setenv("CI", "true")
         root = tmp_path
-        (root / ".envs/dev").mkdir(parents=True)
-        (root / ".envs/dev/backend.env.example").write_text("# example")
-        env_file = root / ".envs/dev/backend.env"
+        env_file = get_env_file(project_root=root)
 
-        if env_file.exists():
-            env_file.unlink()
-        with pytest.raises(FileNotFoundError):
-            get_env_file(project_root=root)
+        assert env_file is None

backend/tests/features/machine/test_api.py

@@ -35,7 +35,7 @@ def test_endpoint_succeeds_with_valid_payload(self, client):
             "notes": "Another test machine",
         }
 
-        res = client.post("/machines", json=payload)
+        res = client.post("/api/machines", json=payload)
 
         assert res.status_code == 201
         data = res.json()
@@ -93,7 +93,7 @@ def test_endpoint_raises_400_for_duplicate_name(self, client, db: Session):
             "notes": "Duplicate machine",
         }
 
-        res = client.post("/machines", json=payload)
+        res = client.post("/api/machines", json=payload)
         assert res.status_code == 400
         assert res.json()["detail"] == "Machine with this name already exists"
 
@@ -128,7 +128,7 @@ def test_endpoint_successfully_list_machines(self, client):
             "chrysalis",
         }
 
-        res = client.get("/machines")
+        res = client.get("/api/machines")
         assert res.status_code == 200
         data = res.json()
 
@@ -167,7 +167,7 @@ def test_endpoint_successfully_get_machine(self, client, db: Session):
         db.commit()
         db.refresh(expected)
 
-        res = client.get(f"/machines/{expected.id}")
+        res = client.get(f"/api/machines/{expected.id}")
         assert res.status_code == 200
 
         result_endpoint = res.json()
@@ -185,6 +185,6 @@ def test_function_raises_error_if_machine_not_found(self, db: Session):
     def test_endpoint_raises_404_if_machine_not_found(self, client):
         random_id = uuid4()
 
-        res = client.get(f"/machines/{random_id}")
+        res = client.get(f"/api/machines/{random_id}")
         assert res.status_code == 404
         assert res.json()["detail"] == "Machine not found"