chore: add checks for schema changes (#1992)

* chore: add pre-commit check for API schema sync

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

* chore: add pre-commit checks to CI workflow

This removes code duplication and makes the CI checks
consistent with the development environment.

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

* fixup! chore: add pre-commit checks to CI workflow

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

* fixup! chore: add pre-commit check for API schema sync

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

---------

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

Author: mentonin

.github/workflows/ci.yaml

@@ -44,13 +44,15 @@ jobs:
         run: pnpm install --frozen-lockfile
         working-directory: ./dashboard
 
-  lint-js:
-    if: github.event.pull_request.draft != true
-    needs: setup-node
+  pre-commit-checks:
     runs-on: ubuntu-latest
-    timeout-minutes: 5
+    needs: setup-node
+    timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: 3.12
 
       - name: Fetch node_modules
         uses: actions/cache@v4
@@ -68,9 +70,15 @@ jobs:
         with:
           node-version-file: './dashboard/.nvmrc'
 
-      - name: Run eslint
-        run: pnpm lint-staged
-        working-directory: ./dashboard
+      - name: Cache Pre-Commit Hooks
+        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Setup pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files --show-diff-on-failure
 
   build-front:
     if: github.event.pull_request.draft != true
@@ -104,7 +112,7 @@ jobs:
         run: pnpm build
         working-directory: ./dashboard
 
-  lint-and-unit-test-django:
+  unit-test-django:
     if: github.event.pull_request.draft != true
     runs-on: ubuntu-latest
     timeout-minutes: 3
@@ -114,14 +122,6 @@ jobs:
       - name: Setup Backend
         uses: ./.github/actions/setup-backend
 
-      - name: Check Lint
-        run: poetry run ruff check .
-        working-directory: ./backend
-
-      - name: Check Format
-        run: poetry run ruff format --check .
-        working-directory: ./backend
-
       - name: Run unit tests with coverage
         run: |
           poetry run pytest -m unit --cov=kernelCI_app --cov=kernelCI_cache --cov-report=term-missing
@@ -183,7 +183,7 @@ jobs:
     if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
     runs-on: ubuntu-latest
     needs:
-      - lint-and-unit-test-django
+      - unit-test-django
       - integration-test-django
     permissions:
       contents: write
@@ -220,7 +220,7 @@ jobs:
 
   # Call job in a a split file
   call-deploy-staging:
-    needs: [lint-js, build-front, lint-and-unit-test-django, integration-test-django]
+    needs: [pre-commit-checks, build-front, unit-test-django, integration-test-django]
     # This 'if' ensures it only runs on pushes to main (the production requirement)
     if: github.event_name == 'push' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
     uses: ./.github/workflows/deploy-staging.yaml

.pre-commit-config.yaml

@@ -74,3 +74,25 @@ repos:
           - --
         language: system
         always_run: true
+
+      - id: api-schema
+        name: API schema is up-to-date
+        entry: |
+          python -c '
+          import os, subprocess, sys;
+          os.chdir("backend")
+          subprocess.run(["poetry", "install"], capture_output=True)
+          spectacular = subprocess.run(["poetry", "run", "python", "manage.py", "spectacular"], capture_output=True, text=True)
+          new_schema = spectacular.stdout
+          with open("schema.yml") as f:
+              old_schema = f.read()
+          if new_schema != old_schema:
+              print("Schema is not up-to-date. Run \"python manage.py spectacular --file schema.yml\" to regenerate it")
+              sys.exit(1)
+          '
+        files: 'backend/(.*\.py|schema.yml)'
+        pass_filenames: false
+        language: python
+        language_version: '3.12'
+        additional_dependencies: [poetry]
+        stages: [pre-commit]