ci: move mypy and unit tests

moves mypy and unit tests from pre commit to CI workflows

Author: mariuswinger

.github/workflows/linting-and-checks.yaml

@@ -0,0 +1,85 @@
+name: "Test"
+on:
+  # Workflow dispatch is used for manual triggers
+  workflow_dispatch:
+  # Workflow call is used for called from another workflow
+  workflow_call:
+    secrets:
+      CR_SECRET:
+        description: "Secret to authenticate if using an other container registry than Github"
+        required: false
+
+env:
+  IMAGE_REGISTRY: ghcr.io
+  REGISTRY_USER: $GITHUB_ACTOR
+  API_IMAGE: ghcr.io/equinor/template-fastapi-react/api
+  WEB_IMAGE: ghcr.io/equinor/template-fastapi-react/web
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    name: "pre-commit"
+    steps:
+      - name: "Setup: checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup: add python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: "Run: pre-commit"
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files
+
+  mypy:
+    runs-on: ubuntu-latest
+    name: "mypy static type checking"
+    defaults:
+      run:
+        working-directory: ./api
+    steps:
+      - name: "Setup: checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup: add python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: "Setup: add venv"
+        run: |
+          pip install poetry
+          poetry config virtualenvs.in-project true
+          poetry install
+
+      - name: "Run: mypy"
+        run: mypy src
+
+  typescript-compile:
+    runs-on: ubuntu-latest
+    name: "typescript compilation"
+    defaults:
+      run:
+        working-directory: ./web
+    steps:
+      - name: "Setup: check out repository"
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            .github
+            web
+
+      - name: "Setup: add node"
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: web/yarn.lock
+
+      - name: "Setup: yarn install"
+        run: yarn install
+
+      - name: "Run: compile"
+        run: yarn compile

.github/workflows/on-pull-request.yaml

@@ -4,5 +4,10 @@ on:
     types: [opened, reopened, synchronize]
 
 jobs:
+  linting-and-checks:
+    name: "Linting and checks"
+    uses: ./.github/workflows/linting-and-checks.yaml
+
   tests:
+    name: "Tests"
     uses: ./.github/workflows/tests.yaml

.github/workflows/on-push-main-branch.yaml

@@ -8,20 +8,28 @@ on:
       - "CHANGELOG.md"
 
 jobs:
+  linting-and-checks:
+    name: "Linting and checks"
+    uses: ./.github/workflows/linting-and-checks.yaml
+
   tests:
+    name: "Tests"
     uses: ./.github/workflows/tests.yaml
 
   generate-changelog:
     needs: tests
+    name: "Generate changelog"
     uses: ./.github/workflows/generate-changelog.yaml
   docs:
     needs: generate-changelog
+    name: "Build and publish docs"
     uses: ./.github/workflows/publish-docs.yaml
     with:
       message: "Warning: This is the development version."
 
   publish-latest:
     needs: tests
+    name: "Publish dev docker images"
     uses: ./.github/workflows/publish-image.yaml
     with:
       image-tags: latest
@@ -35,11 +43,13 @@ jobs:
 
   release-please:
     needs: tests
+    name: "Create or update release PR"
     uses: ./.github/workflows/create-release-pr.yaml
 
   publish-staging:
     needs: release-please
     if: ${{ needs.release-please.outputs.release_created }}
+    name: "Publish staging docker images"
     uses: ./.github/workflows/publish-image.yaml
     with:
       image-tags: ${{ needs.release-please.outputs.tag_name }}

.github/workflows/tests.yaml

@@ -16,30 +16,23 @@ env:
   WEB_IMAGE: ghcr.io/equinor/template-fastapi-react/web
 
 jobs:
-  pre-commit:
+  api-unit-tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install pre-commit
-        run: pip install pre-commit
+      - name: Login to image registry
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login $IMAGE_REGISTRY -u $GITHUB_ACTOR --password-stdin
 
-      - name: Set up venv
+      - name: Build API image
         run: |
-          pip install poetry
-          poetry config virtualenvs.in-project true
-          cd api
-          poetry install
+          docker pull $API_IMAGE
+          docker build --target development --tag api-development ./api # TODO: --cache-from $API_IMAGE
 
-      - name: Run pre-commit
-        run: pre-commit run --all-files
+      - name: Pytest Unit tests
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm api pytest --unit
 
-  test-api:
+  api-integration-tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -59,7 +52,7 @@ jobs:
       - name: Pytest Integration tests
         run: docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm api pytest --integration
 
-  test-web:
+  web-tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -76,7 +69,7 @@ jobs:
         if: ${{ false }} # disable for now as they do not currently work
         run: docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm web yarn test
 
-  test-docs:
+  docs-tests:
     name: test-docs
     runs-on: ubuntu-latest
 

.pre-commit-config.yaml

@@ -69,34 +69,6 @@ repos:
         additional_dependencies: ["@biomejs/biome@1.9.4"]
         args: ["--config-path", "web"]
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
-    hooks:
-      - id: mypy
-        name: "Lint: python type checking (mypy)"
-        args: [--config-file=api/pyproject.toml]
-        exclude: tests/
-        additional_dependencies:
-          - types-cachetools
-          - types-requests
-          - types-ujson
-          - types-toml
-          - types-click
-          - types-python-jose
-          - pymongo
-          - pydantic
-          - fastapi
-
-  # The path to the venv python interpreter differ between linux and windows. An if/else is used to find it on either.
-  - repo: local
-    hooks:
-      - id: pytest
-        name: "Tests: python unit tests"
-        entry: sh -c "cd ./api/src/ && poetry run pytest ./tests/"
-        language: system
-        pass_filenames: false
-        always_run: true
-
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:

web/package.json

@@ -6,6 +6,7 @@
     "start": "vite",
     "build": "tsc && vite build",
     "serve": "vite preview",
+    "compile": "tsc --noEmit",
     "generate": "openapi -i http://localhost:5000/openapi.json -o './src/api/generated' -c axios",
     "test": "vitest",
     "lint": "biome check --write --no-errors-on-unmatched"