build: update build scripts and CI

Author: ChristianBeilschmidt

.github/workflows/ci.yml

@@ -19,13 +19,10 @@ jobs:
         permissions:
             contents: read
 
-        defaults:
-            run:
-                working-directory: ./backend
-        
         steps:
             - name: Checkout code
               uses: actions/checkout@v6
+            - uses: extractions/setup-just@v3
             - name: Init rustup toolchain
               run: rustup show
             - name: setup rust build cache
@@ -41,20 +38,81 @@ jobs:
                 # Default: empty
                 key: ci_test_
             - name: Rustfmt
-              run: ./lint.sh rustfmt
+              run: just lint-backend-rustfmt
             - name: Clippy
-              run: ./lint.sh clippy
+              run: just lint-backend-clippy
             - name: SQLFluff
-              run: ./lint.sh sqlfluff
+              run: just lint-backend-sqlfluff
             - name: Start PostgreSQL
               run: |
                 service postgresql start
                 psql postgres://geoengine:geoengine@localhost -c "CREATE DATABASE biois;"
             - name: Diesel Check
-              run: ./lint.sh diesel_cli --with-install
+              run: |
+                just install-diesel-cli
+                just lint-backend-diesel-cli
               env:
                 DATABASE_URL: postgres://geoengine:geoengine@localhost/biois
 
+    lint-api-client:
+        name: Lint API Client
+
+        runs-on: ubuntu-24.04
+        container: quay.io/geoengine/devcontainer:latest
+
+        permissions:
+            contents: read
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v6
+            - uses: extractions/setup-just@v3
+            - name: Start PostgreSQL
+              run: |
+                service postgresql start
+                psql postgres://geoengine:geoengine@localhost -c "CREATE DATABASE biois;"
+            - name: Install Java (OpenAPI Generator requires Java to run)
+              run: |
+                # deleted in devcontainer image, but required by java installer
+                mkdir -p /usr/share/man/man1
+                apt-get update
+                apt-get install -y openjdk-21-jre-headless
+            - name: Lint OpenAPI specification
+              run: |
+                just lint-openapi-spec
+            - name: Idempotency of OpenAPI doc generation
+              run: |
+                just generate-openapi-spec
+                just check-no-changes-in-git-repo
+            - name: Idempotency of API client code generation
+              run: |
+                just build-api-client
+                just check-no-changes-in-git-repo
+            - name: Check API client for build errors
+              run: just lint-api-client
+
+    lint-frontend:
+        name: Lint Frontend
+
+        runs-on: ubuntu-24.04
+        container: quay.io/geoengine/devcontainer:latest
+
+        permissions:
+            contents: read
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v6
+            - uses: extractions/setup-just@v3
+            - name: Install dependencies
+              run: |
+                just install-api-client-deps
+                just install-frontend-deps
+            - name: Code Format
+              run: just lint-frontend-fmt
+            - name: Lints
+              run: just lint-frontend-code
+
     test-backend:
         name: Test Backend
 
@@ -67,13 +125,10 @@ jobs:
         outputs:
             coverage-artifact-id: ${{ steps.upload-artifact.outputs.artifact-id }}
 
-        defaults:
-            run:
-                working-directory: ./backend
-        
         steps:
             - name: Checkout code
               uses: actions/checkout@v6
+            - uses: extractions/setup-just@v3
             - name: Init rustup toolchain
               run: rustup show
 
@@ -95,13 +150,8 @@ jobs:
                 key: ci_test_
             - name: Test
               run: |
-                cargo install --locked cargo-llvm-cov
-
-                cargo llvm-cov \
-                    --locked \
-                    --all-features \
-                    --lcov \
-                    --output-path /lcov.info
+                just install-llvm-cov
+                just test-backend-with-coverage "/lcov.info"
             - id: upload-artifact
               uses: actions/upload-artifact@v6
               with:
@@ -110,6 +160,41 @@ jobs:
                 compression-level: 9
                 retention-days: 1
                 if-no-files-found: error
+
+    test-frontend:
+        name: Test Frontend
+
+        runs-on: ubuntu-24.04
+        container: quay.io/geoengine/devcontainer:latest
+
+        permissions:
+            contents: read
+
+        outputs:
+            coverage-artifact-id: ${{ steps.upload-artifact.outputs.artifact-id }}
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v6
+            - uses: extractions/setup-just@v3
+            - name: Install dependencies
+              run: |
+                just install-api-client-deps
+                just install-frontend-deps
+            - name: Build
+              run: just build-frontend
+
+            - name: Test
+              run: just test-frontend
+
+            - id: upload-artifact
+              uses: actions/upload-artifact@v6
+              with:
+                name: lcov-report-frontend-${{ github.run_id }}-${{ github.run_attempt }}
+                path: frontend/coverage/BioIS/lcov.info
+                compression-level: 9
+                retention-days: 1
+                if-no-files-found: error
 
     upload-coverage:
         name: Upload Coverage Report
@@ -121,7 +206,7 @@ jobs:
 
         needs:
             - test-backend
-
+            - test-frontend
         steps:
             - name: Checkout code
               uses: actions/checkout@v6
@@ -133,6 +218,11 @@ jobs:
             - name: Modify lcov paths
               run: |
                 sed -i 's|SF:/__w/BioIS/BioIS/|SF:|' backend/lcov.info
+            - name: Download Frontend Coverage Report
+              uses: actions/download-artifact@v7
+              with:
+                artifact-ids: ${{ needs.test-frontend.outputs.coverage-artifact-id }}
+                path: frontend/
             - name: Upload coverage to Coveralls
               uses: coverallsapp/github-action@v2
               with:

.github/workflows/lint-pr-title.yml

@@ -0,0 +1,28 @@
+name: "Lint PR"
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+
+jobs:
+  title:
+    name: Title
+    if: github.event.action == 'opened' || github.event.changes.title.from
+    runs-on: ubuntu-latest
+    steps:
+      - uses: geo-engine/conventional-pr-title@v1
+        with:
+          types: |-
+            build
+            ci
+            docs
+            feat
+            fix
+            perf
+            refactor
+            test
+          scopes: |-
+            api-client
+            backend
+            frontend

api-client/config.yaml

@@ -1,5 +1,5 @@
-inputSpec: /local/openapi.json
-outputDir: /local/typescript
+inputSpec: ../openapi.json
+outputDir: typescript
 generatorName: typescript
 gitHost: github.com
 gitUserId: geo-engine

api-client/openapi.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.19.0"
+  }
+}

api-client/openapitools.json

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+"""
+Post-processing of generated code.
+"""
+
+from collections.abc import Generator, Callable
+from pathlib import Path
+from textwrap import dedent
+from typing import TypeAlias
+import logging
+
+
+FileModifier: TypeAlias = Callable[[list[str]], Generator[str, None, None]]
+INDENT = "    "
+
+
+def file_modifications() -> Generator[tuple[Path, FileModifier], None, None]:
+    yield Path("types/ObjectParamAPI.ts"), object_param_api_ts
+    yield Path("types/PromiseAPI.ts"), promise_api_ts
+
+
+def main():
+    logging.basicConfig(level=logging.INFO, format="[%(levelname)s] %(message)s")
+
+    subdir = Path("typescript")
+    for file_path, modify_fn in file_modifications():
+        logging.info(f"Modifying {file_path}…")
+
+        file_path = subdir / file_path
+
+        try:
+            with open(file_path, "r", encoding="utf-8") as f:
+                file_contents = f.readlines()
+
+            with open(file_path, "w", encoding="utf-8") as f:
+                for line in modify_fn(file_contents):
+                    f.write(line)
+        except Exception as e:
+            logging.error(f"Error modifying {file_path}: {e}")
+
+
+def object_param_api_ts(file_contents: list[str]) -> Generator[str, None, None]:
+    """Modify the ObjectParamAPI.ts file."""
+    for line in file_contents:
+        if dedent(line).startswith("public api("):
+            line = line.replace("public api(", "public api_(")
+        yield line
+
+
+def promise_api_ts(file_contents: list[str]) -> Generator[str, None, None]:
+    """Modify the PromiseAPI.ts file."""
+    for line in file_contents:
+        if dedent(line).startswith("public api("):
+            line = line.replace("public api(", "public api_(")
+        yield line
+
+
+if __name__ == "__main__":
+    main()