ci: split unit and integration tests

Closes #1402

Author: MarceloRobert

.github/actions/setup-backend/action.yaml

@@ -0,0 +1,19 @@
+name: Shared setup backend
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'
+
+    - name: Install Poetry
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+      shell: bash
+
+    - name: Install dependencies
+      working-directory: ./backend
+      run: poetry install
+      shell: bash

.github/workflows/ci.yaml

@@ -104,27 +104,15 @@ jobs:
         run: pnpm build
         working-directory: ./dashboard
 
-  build-django:
+  lint-and-unit-test-django:
     if: github.event.pull_request.draft != true
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 3
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.12'
-
-      - name: Install Poetry
-        run: |
-          python -m pip install --upgrade pip
-          pip install poetry
+      - uses: actions/checkout@v4
 
-      - name: Install dependencies
-        run: poetry install
-        working-directory: ./backend
+      - name: Setup Backend
+        uses: ./.github/actions/setup-backend
 
       - name: Lint
         run: poetry run flake8
@@ -134,6 +122,20 @@ jobs:
         run: poetry run black --check .
         working-directory: ./backend
 
+      - name: Run unit tests
+        run: poetry run pytest -m unit
+        working-directory: ./backend
+
+  integration-test-django:
+    if: github.event.pull_request.draft != true
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Backend
+        uses: ./.github/actions/setup-backend
+
       - name: Configure credentials variables
         run: |
           echo -n "${{ secrets.PG_JSON }}" | base64 --decode > application_default_credentials.json
@@ -160,11 +162,11 @@ jobs:
                 break
             fi
             echo "Waiting for backend to be ready... $i"
-            sleep 10
+            sleep 5
           done
 
-      - name: Run tests
-        run: poetry run pytest --run-all
+      - name: Run integration tests
+        run: poetry run pytest -m "integration" --run-all
         working-directory: ./backend
 
       - name: Clean containers
@@ -176,7 +178,8 @@ jobs:
     needs:
       - lint-js
       - build-front
-      - build-django
+      - lint-and-unit-test-django
+      - integration-test-django
     steps:
       - name: Configure staging host authenticity
         run: |

backend/conftest.py

@@ -1,4 +1,36 @@
+from pytest import Item
+
+TEST_MARKERS = ["unit", "integration"]
+
+
 def pytest_addoption(parser):
     parser.addoption(
         "--run-all", action="store_true", default=False, help="run all test cases"
     )
+
+
+def pytest_collection_modifyitems(items: list[Item]):
+    for item in items:
+        parent_folder = item.path.parent.name.lower()
+
+        matched_markers = [marker for marker in TEST_MARKERS if marker in parent_folder]
+        match len(matched_markers):
+            case 0:
+                raise Exception(
+                    """Test %s must have a type.
+                    Place the test in a folder whose name contains 'unit' or 'integration'."""
+                    % item.name
+                )
+            case 1:
+                item.add_marker(matched_markers[0])
+            case _:
+                raise Exception(
+                    """Test %s can only be of a single type (one of %s),
+                        but found multiple markers (%s) at folder %s"""
+                    % (
+                        item.name,
+                        TEST_MARKERS,
+                        matched_markers,
+                        parent_folder,
+                    )
+                )

backend/pyproject.toml

@@ -36,6 +36,10 @@ pytest-rerunfailures = "^15.0"
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "kernelCI.settings"
 addopts = "-n 4 --dist loadscope --reruns 4 -x"
+markers = [
+    "unit: marks tests as unit tests (fast, no external dependencies)",
+    "integration: marks tests as integration tests (slow, connects to the database)"
+]
 
 [build-system]
 requires = ["poetry-core"]