Testumgebung und CI: ein Befehl mit Docker, Forgejo-Workflow (#96, #14)

- ops/test/run.sh: Compose mit Wegwerf-MariaDB (tmpfs) und Test-Image
  (Node 24, pnpm, mysqldump/gpg/age/rclone), Dummy-Schlüssel.
- ops/test/ci.sh: install --frozen-lockfile → build → Plattform-,
  Connector- und API-Tests; bricht beim ersten Fehler ab.
- .forgejo/workflows/ci.yml: gleicher Ablauf, braucht einen Runner (docker).
- API-Tests löschen kundencenter_test nur mit KC_TEST_DB_RESET=1.

Lokal verifiziert: 154 Tests grün.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Claude (KI) 2026-10-06 11:30:52 +02:00
parent 677186e3f3
commit 8eb8c54aab
7 changed files with 98 additions and 2 deletions

32
.forgejo/workflows/ci.yml Normal file
View file

@ -0,0 +1,32 @@
# CI für Forgejo Actions (#96). Läuft, sobald für die Forge ein Runner mit Label "docker" registriert ist.
# Gleicher Ablauf wie lokal mit ops/test/run.sh; rote Tests lassen den Lauf fehlschlagen.
name: CI
on:
push: { branches: [main] }
pull_request:
jobs:
test:
runs-on: docker
container: { image: node:24-bookworm }
services:
db:
image: mariadb:11.4
env: { MARIADB_ROOT_PASSWORD: testroot }
options: --health-cmd="healthcheck.sh --connect --innodb_initialized" --health-interval=2s --health-retries=30
env:
CI: "1"
KC_ENV_DIR: /nonexistent
KC_TEST_DB_RESET: "1"
DB_HOST: db
DB_PORT: "3306"
DB_NAME: kundencenter_test
DB_USER: root
DB_PASSWORD: testroot
KC_SECRET_KEY: dGVzdC1zY2hsdWVzc2VsLW51ci1mdWVyLWNpLTMyLWI=
LICENSE_PROGRAM_KEY: 00000000-0000-0000-0000-000000000000
steps:
- uses: https://code.forgejo.org/actions/checkout@v4
- name: Werkzeuge (mysqldump, gpg, age, rclone)
run: apt-get update && apt-get install -y --no-install-recommends mariadb-client gnupg age rclone openssh-client && corepack enable && corepack prepare pnpm@10.14.0 --activate
- name: Installieren, bauen, testen
run: bash ops/test/ci.sh

View file

@ -102,5 +102,16 @@ API-Module liegen in `apps/api/src/modules/<name>` und implementieren `KcModule`
Neue Anbieter kommen als Connector unter `packages/connector-*` hinzu (`docs/connector-vertrag.md`).
## Tests
`cd apps/api && pnpm test` – Integrationstests gegen eine **separate** Datenbank `kundencenter_test` (wird bei jedem Lauf
neu erstellt). Abgedeckt: Login, Sperre, CSRF, 2FA-Pflicht, Sitzungen, Kundenanlage, Mandantentrennung, Rechte, Audit-Kette.
Ein Befehl, nur Docker nötig (frischer Checkout, Dummy-Schlüssel, Wegwerf-MariaDB im RAM – nie die Produktivdatenbank):
```bash
ops/test/run.sh
```
Ablauf (`ops/test/ci.sh`, identisch in der CI unter `.forgejo/workflows/ci.yml`): `pnpm install --frozen-lockfile` →
`pnpm build` (vor den Tests, weil die Pakete über `dist/` aufgelöst werden) → Plattform-, Connector- und API-Tests.
Die API-Integrationstests legen die Datenbank `kundencenter_test` bei jedem Lauf neu an und starten nur mit
`KC_TEST_DB_RESET=1` (in der Testumgebung gesetzt) – auf einem Produktivhost brechen sie daher sofort ab.
Abgedeckt u. a.: Login, Sperre, CSRF, 2FA-Pflicht, Sitzungen, Kundenanlage, Mandantentrennung, Rechte, Audit-Kette,
Rechnungen (inkl. Nebenläufigkeit), Migrationen (Sperre/Wiederanlauf), Lizenzgrenzen und -signatur, IMAP-Zuordnung.
Noch offen: Browser-/Barrierefreiheitstests der Weboberfläche (Playwright/axe) und Worker-Tests mit echtem IMAP/Discord.

View file

@ -5,6 +5,8 @@ import '../src/core/config.js';
/** Legt eine frische Testdatenbank an (niemals die produktive) und wendet alle Migrationen an. */
export default async function setup() {
// Schutz gegen versehentlichen Start auf einem Produktivhost: die Testdatenbank wird gelöscht und neu angelegt.
if (process.env.KC_TEST_DB_RESET !== '1') throw new Error('API-Tests löschen die Datenbank kundencenter_test. Nur in der isolierten Testumgebung starten (ops/test/run.sh) oder KC_TEST_DB_RESET=1 bewusst setzen.');
const base = { host: process.env.DB_HOST ?? '127.0.0.1', user: process.env.DB_USER!, password: process.env.DB_PASSWORD! };
const admin = await mysql.createConnection(base);
await admin.query('DROP DATABASE IF EXISTS kundencenter_test');

7
ops/test/Dockerfile Normal file
View file

@ -0,0 +1,7 @@
# Test-Image für CI und lokale Testläufe: Node 24 + pnpm + die Werkzeuge, die Backup/Restore aufrufen
# (mysqldump/mysql, gpg, age, tar). Enthält keinen Code und keine Geheimnisse – das Repo wird eingebunden.
FROM node:24-bookworm
RUN apt-get update \
&& apt-get install -y --no-install-recommends mariadb-client gnupg age rclone openssh-client \
&& rm -rf /var/lib/apt/lists/* \
&& corepack enable && corepack prepare pnpm@10.14.0 --activate

9
ops/test/ci.sh Executable file
View file

@ -0,0 +1,9 @@
#!/usr/bin/env bash
# Kompletter Prüflauf wie in der CI: Installation aus dem Lockfile, Build (vor Tests – Pakete werden über dist/
# aufgelöst), dann alle Testsuiten. Bricht beim ersten Fehler ab.
set -euo pipefail
pnpm install --frozen-lockfile
pnpm build
pnpm --filter @kc/platform test
pnpm --filter "./packages/connector-*" test
pnpm --filter @kc/api test

29
ops/test/compose.yml Normal file
View file

@ -0,0 +1,29 @@
# Isolierte Testumgebung (#96): wegwerfbare MariaDB im RAM + Test-Container mit eingebundenem Repo.
# Keine echten Geheimnisse, keine Verbindung zu Produktivdatenbank oder Anbietern.
# Start: ops/test/run.sh (oder: docker compose -f ops/test/compose.yml run --rm tests)
name: kc-test
services:
db:
image: mariadb:11.4
environment: { MARIADB_ROOT_PASSWORD: testroot }
command: ["--character-set-server=utf8mb4", "--collation-server=utf8mb4_unicode_ci"]
tmpfs: [/var/lib/mysql]
healthcheck: { test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"], interval: 2s, timeout: 5s, retries: 30 }
tests:
build: .
depends_on: { db: { condition: service_healthy } }
working_dir: /w
volumes: ["../..:/w"]
environment:
CI: "1"
KC_ENV_DIR: /nonexistent
KC_TEST_DB_RESET: "1"
DB_HOST: db
DB_PORT: "3306"
DB_NAME: kundencenter_test
DB_USER: root
DB_PASSWORD: testroot
# Dummy-Schlüssel (32 Byte, base64) – nur für Tests
KC_SECRET_KEY: dGVzdC1zY2hsdWVzc2VsLW51ci1mdWVyLWNpLTMyLWI=
LICENSE_PROGRAM_KEY: 00000000-0000-0000-0000-000000000000
command: ["bash", "ops/test/ci.sh"]

6
ops/test/run.sh Executable file
View file

@ -0,0 +1,6 @@
#!/usr/bin/env bash
# Lokaler Testlauf in Docker (nichts auf dem Host nötig außer Docker). Räumt die Wegwerf-Datenbank danach ab.
set -euo pipefail
cd "$(dirname "$0")"
trap 'docker compose -f compose.yml down -v >/dev/null 2>&1' EXIT
docker compose -f compose.yml run --rm --build tests "$@"