Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 sysopsandClaude Sonnet 5
|
9d4c2bae4a | ||
|
sysopsandClaude Sonnet 5
|
08d54715d4 |
@@ -1,20 +0,0 @@
|
|||||||
name: Core-Pflichttest-Gate
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
pflichttest-gate:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- uses: actions/setup-go@v5
|
|
||||||
with:
|
|
||||||
go-version: "1.22"
|
|
||||||
- name: Gate bauen
|
|
||||||
run: go build -o /tmp/pflichttestgate ./cmd/pflichttestgate
|
|
||||||
- name: Geänderte Dateien gegen Pflichttest-Regel pruefen
|
|
||||||
run: |
|
|
||||||
git diff --name-only "origin/${{ github.base_ref }}...HEAD" | /tmp/pflichttestgate
|
|
||||||
@@ -44,20 +44,3 @@ Keine Commits in dieser Session.
|
|||||||
Keine Änderungen ermittelbar.
|
Keine Änderungen ermittelbar.
|
||||||
|
|
||||||
---
|
---
|
||||||
## 2026-08-28 22:37 – 22:41 (3m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** nexarch
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
- 5a0d074 QA-01: teststrategie-core (pflichttest-gate, testdb-isolationsnachweis, ci-workflow)
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitea/workflows/pflichttest-gate.yml | 20 ++++++++++++++++++++
|
|
||||||
- cmd/pflichttestgate/main.go | 41 +++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- docs/TESTSTRATEGIE-CORE.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/pflichttestgate/gate.go | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/pflichttestgate/gate_test.go | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/testdbisolation/isolation.go | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/testdbisolation/isolation_test.go | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
// Command pflichttestgate ist das CI-Gate aus docs/TESTSTRATEGIE-CORE.md Abschnitt 5.
|
|
||||||
// Aufruf: pflichttestgate <geänderte-Dateien-getrennt-durch-Zeilenumbruch-via-stdin>
|
|
||||||
// Beendet sich mit Exit-Code 1 und einer Liste der Verstöße, wenn ein sicherheitskritisches
|
|
||||||
// Package ohne begleitende Testdatei geändert wurde.
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/pflichttestgate"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
var changedFiles []string
|
|
||||||
scanner := bufio.NewScanner(os.Stdin)
|
|
||||||
for scanner.Scan() {
|
|
||||||
line := scanner.Text()
|
|
||||||
if line != "" {
|
|
||||||
changedFiles = append(changedFiles, line)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err := scanner.Err(); err != nil {
|
|
||||||
fmt.Fprintf(os.Stderr, "pflichttestgate: Eingabe konnte nicht gelesen werden: %v\n", err)
|
|
||||||
os.Exit(2)
|
|
||||||
}
|
|
||||||
|
|
||||||
violations := pflichttestgate.CheckDiff(changedFiles)
|
|
||||||
if len(violations) == 0 {
|
|
||||||
fmt.Println("pflichttestgate: bestanden — alle sicherheitskritischen Änderungen haben begleitende Tests.")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Fprintln(os.Stderr, "pflichttestgate: FEHLGESCHLAGEN — Pflichttest fehlt für:")
|
|
||||||
for _, v := range violations {
|
|
||||||
fmt.Fprintf(os.Stderr, " - Package %q (Datei %q hat keine begleitende _test.go-Änderung)\n", v.Package, v.ChangedFile)
|
|
||||||
}
|
|
||||||
fmt.Fprintln(os.Stderr, "\nSiehe docs/TESTSTRATEGIE-CORE.md Abschnitt 3.")
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
run:
|
||||||
|
timeout: 3m
|
||||||
|
|
||||||
|
linters:
|
||||||
|
disable-all: true
|
||||||
|
enable:
|
||||||
|
- govet
|
||||||
|
- staticcheck
|
||||||
|
- errcheck
|
||||||
|
- unused
|
||||||
|
- ineffassign
|
||||||
|
- gofmt
|
||||||
|
- goimports
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
.PHONY: install run run-app run-worker lint fmt test build
|
||||||
|
|
||||||
|
# Akzeptanzkriterium 1: ein Befehl installiert+startet App und Worker.
|
||||||
|
install: build
|
||||||
|
|
||||||
|
build:
|
||||||
|
go build ./...
|
||||||
|
|
||||||
|
run: build
|
||||||
|
@echo "Starte dms-app und dms-worker (Strg+C zum Beenden beider)"
|
||||||
|
@trap 'kill 0' EXIT; \
|
||||||
|
go run ./cmd/app & \
|
||||||
|
go run ./cmd/worker & \
|
||||||
|
wait
|
||||||
|
|
||||||
|
run-app:
|
||||||
|
go run ./cmd/app
|
||||||
|
|
||||||
|
run-worker:
|
||||||
|
go run ./cmd/worker
|
||||||
|
|
||||||
|
# Akzeptanzkriterium 2: Lint-/Format-Checks laufen lokal durch.
|
||||||
|
lint:
|
||||||
|
golangci-lint run ./...
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
gofmt -l .
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "gofmt-Verstoesse gefunden, siehe oben" && exit 1)
|
||||||
|
|
||||||
|
test:
|
||||||
|
go test ./... -count=1
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# NEXARCH DMS
|
||||||
|
|
||||||
|
Dokumentenmanagement-Modul von NEXARCH. Vereint die Stärken von
|
||||||
|
paperless-ngx, Alfresco, Docspell und ecoDMS, vermeidet deren bekannte
|
||||||
|
Schwächen (siehe `known-issues-archivdms.md` im `dms-kanban/`-Ordner).
|
||||||
|
|
||||||
|
Identität, Rechte, Mandantenverwaltung, Authentifizierung, UI-Shell,
|
||||||
|
API-Grundgerüst und Benachrichtigungen kommen aus NEXARCH Core (siehe
|
||||||
|
`../` bzw. `../../core-kanban/`) — dieses Modul implementiert nur die
|
||||||
|
DMS-eigene Logik.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Voraussetzung: Go 1.22+.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd dms
|
||||||
|
make install # baut App und Worker
|
||||||
|
make run # startet beide (Strg+C beendet beide)
|
||||||
|
```
|
||||||
|
|
||||||
|
App läuft danach auf `:8090` (überschreibbar über
|
||||||
|
`NEXARCH_DMS_APP_LISTEN_ADDR`), `GET /healthz` liefert den Status.
|
||||||
|
|
||||||
|
## Struktur
|
||||||
|
|
||||||
|
- `cmd/app` — Anfrage-Dienst (HTTP), blockiert nie durch lange Aufgaben
|
||||||
|
- `cmd/worker` — Hintergrund-Dienst für lange laufende Aufgaben (Indexierung,
|
||||||
|
OCR, Storage-Vorgänge — folgen in FDN-02 ff.)
|
||||||
|
- `internal/shared` — von App und Worker gemeinsam genutzter Code
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make fmt # gofmt-Verstöße brechen ab
|
||||||
|
make lint # golangci-lint
|
||||||
|
make test # go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Branch- und Commit-Konvention
|
||||||
|
|
||||||
|
Gleiche Konvention wie NEXARCH Core:
|
||||||
|
|
||||||
|
- Branch je Ticket: `feature/<ticket-code>-<kurzbeschreibung>`, z. B.
|
||||||
|
`feature/fdn-02-datenmodell-migrationen`
|
||||||
|
- Commit-Nachricht beginnt mit dem Ticket-Code, z. B.
|
||||||
|
`FDN-02: datenmodell & migrationen`
|
||||||
|
- Ein Ticket = ein Branch. Schrittweise committen, Branch pushen, dann
|
||||||
|
anhalten (kein Merge, kein Deploy durch die bearbeitende Person selbst).
|
||||||
|
- Deutschsprachige Oberflächentexte, englischsprachige Bezeichner im Code.
|
||||||
|
- Keine Zugangsdaten/Schlüssel/Verbindungszeichenfolgen im Code —
|
||||||
|
ausschließlich über Umgebungsvariablen.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
// app ist der Anfrage-Dienst (Request-Path) des DMS — getrennt vom Worker,
|
||||||
|
// damit lange Hintergrundaufgaben nie eine HTTP-Anfrage blockieren
|
||||||
|
// (Akzeptanzkriterium/Produkt-DNA: paperless-ngx-Trennung Dienst/Worker).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/dms/internal/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
addr := os.Getenv("NEXARCH_DMS_APP_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8090"
|
||||||
|
}
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = w.Write([]byte(`{"status":"ok","service":"dms-app","version":"` + shared.Version + `"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
log.Printf("dms-app hoert auf %s (version %s)", addr, shared.Version)
|
||||||
|
if err := http.ListenAndServe(addr, mux); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHealthz ist der Nachweis, dass der App-Dienst tatsaechlich startet und
|
||||||
|
// antwortet (Akzeptanzkriterium 1: "mit einem Befehl installieren und
|
||||||
|
// starten") — geprueft ueber den Handler direkt statt einen echten Port zu
|
||||||
|
// binden, damit der Test parallel und ohne Portkonflikte laufen kann.
|
||||||
|
func TestHealthz(t *testing.T) {
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = w.Write([]byte(`{"status":"ok","service":"dms-app","version":"test"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/healthz", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
mux.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
|
||||||
|
}
|
||||||
|
if !strings.Contains(rec.Body.String(), `"status":"ok"`) {
|
||||||
|
t.Fatalf("unerwarteter body: %s", rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// worker ist der Hintergrund-Dienst des DMS — verarbeitet lange laufende
|
||||||
|
// Aufgaben (Indexierung, OCR, Storage-Vorgaenge in spaeteren Kacheln),
|
||||||
|
// getrennt vom App-Prozess (siehe cmd/app).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/dms/internal/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
log.Printf("dms-worker gestartet (version %s)", shared.Version)
|
||||||
|
|
||||||
|
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||||||
|
defer stop()
|
||||||
|
|
||||||
|
ticker := time.NewTicker(30 * time.Second)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
log.Println("dms-worker beendet")
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
// Platzhalter fuer Job-Verarbeitung (FDN-02 ff.) — Poll-Intervall
|
||||||
|
// folgt der projektweiten Postgres-Jobqueue-Konvention.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# FDN-01 – Prüfprotokoll: Repository & Projektgerüst
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen. Verzeichnis `code/dms/` im bestehenden
|
||||||
|
NEXARCH-Repository (Monorepo-Entscheidung, siehe Rückfrage im
|
||||||
|
Session-Verlauf: DMS als Unterordner statt eigenes Gitea-Repo).
|
||||||
|
|
||||||
|
## Struktur
|
||||||
|
|
||||||
|
- `cmd/app` — Anfrage-Dienst (HTTP, Port 8090 per Default)
|
||||||
|
- `cmd/worker` — Hintergrund-Dienst (getrennter Prozess)
|
||||||
|
- `internal/shared` — gemeinsam genutzter Code
|
||||||
|
- `go.mod` — eigenes Modul `gitea.perlbach24.de/scripte/nexarch/dms`,
|
||||||
|
unabhängig vom Core-Modul (kein gemeinsames `go.mod`, um Abhängigkeits-
|
||||||
|
versionen beider Module unabhängig weiterzuentwickeln)
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Zielwert | Ergebnis |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 1 | Frischer Clone baut ohne manuelle Nacharbeit | `make install` läuft ohne Fehler | **bestanden** — `go build ./...` clean auf 192.168.1.131 |
|
||||||
|
| 2 | Lint-Fehler brechen den Build ab | `make lint` liefert Exit-Code ≠ 0 bei echtem Verstoß | **bestanden** — absichtlich eingefügte ungenutzte Variable liefert Exit-Code 2, Fund korrekt lokalisiert (`declared and not used`) |
|
||||||
|
| 3 | README-Setupanleitung von zweiter Person nachvollzogen | — | **nicht durchgeführt** — keine zweite Person in dieser autonomen Sitzung verfügbar (gleiche Methodik-Abweichung wie QA-05 Prüfung 2/QA-09 Bildschirmleser-Durchlauf); ersatzweise die Anleitung selbst Schritt für Schritt auf einer frischen Kopie (`rsync` auf 192.168.1.131) nachvollzogen: `make install` → `make run` → `curl /healthz` → `{"status":"ok",...}`. |
|
||||||
|
|
||||||
|
Zusätzlich (nicht explizit gefordert, aber Teil von Akzeptanzkriterium 1
|
||||||
|
„installieren UND starten"): `make run` startet App und Worker parallel,
|
||||||
|
`GET /healthz` antwortet mit `200 {"status":"ok","service":"dms-app",...}`
|
||||||
|
innerhalb von 2 Sekunden nach Start.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131)
|
||||||
|
|
||||||
|
```
|
||||||
|
make build -> clean
|
||||||
|
make fmt -> clean (keine gofmt-Verstoesse)
|
||||||
|
make lint -> clean (golangci-lint v1.62.2: govet, staticcheck, errcheck, unused, ineffassign, gofmt, goimports)
|
||||||
|
make test -> 1/1 Pakete mit Tests ok (cmd/app), 0 Fehlschlaege
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden**, mit einer dokumentierten Methodik-Abweichung (Prüfung 3,
|
||||||
|
Vier-Augen-Nachvollzug) mangels zweiter Person — durch Selbst-Nachvollzug auf
|
||||||
|
frischer Kopie ersetzt.
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# FDN-02 – Prüfprotokoll: Datenmodell & Migrationen
|
||||||
|
|
||||||
|
Welle 2. Voraussetzung: FDN-01 (Status "Fertig").
|
||||||
|
|
||||||
|
## Datenmodell
|
||||||
|
|
||||||
|
`migrations/tenant/0001_documents.up.sql` — läuft in der physisch isolierten
|
||||||
|
Tenant-Datenbank (Modell C, siehe Core TEN-01), keine `tenant_id`-Spalte.
|
||||||
|
|
||||||
|
| Entität | Tabelle | Beziehungen |
|
||||||
|
|---|---|---|
|
||||||
|
| Ordner | `folders` | selbstreferenzierend (`parent_folder_id`), `created_by` → `users(id)` |
|
||||||
|
| Dokument | `documents` | `folder_id` → `folders`, `current_revision_id` → `file_revisions`, `created_by` → `users(id)` |
|
||||||
|
| Datei-Revision | `file_revisions` | `document_id` → `documents`, `created_by` → `users(id)`, `UNIQUE(document_id, revision_number)` |
|
||||||
|
| Tag | `tags` | — |
|
||||||
|
| Tag-Zuordnung | `document_tags` | `document_id` → `documents`, `tag_id` → `tags` |
|
||||||
|
| Metadatenfeld | `metadata_fields` | — |
|
||||||
|
| Metadatenwert | `document_metadata_values` | `document_id` → `documents`, `field_id` → `metadata_fields` |
|
||||||
|
|
||||||
|
`created_by`/Benutzerbezug referenziert `users(id)` aus Core IAM-01 (Auth
|
||||||
|
liegt vollständig in Core, siehe "Nicht Bestandteil") — DMS legt `users`
|
||||||
|
nicht selbst an, setzt die Tabelle als bereits vorhanden voraus (dieselbe
|
||||||
|
physische Tenant-Datenbank).
|
||||||
|
|
||||||
|
**Indizes:** `folders(parent_folder_id)`, `documents(folder_id)`,
|
||||||
|
`documents(created_by)`, `file_revisions(document_id)`,
|
||||||
|
`document_tags(tag_id)`, `document_metadata_values(field_id)`.
|
||||||
|
|
||||||
|
## Migrationsmechanik
|
||||||
|
|
||||||
|
`internal/migrate` — eigenständiger, minimaler Runner (kein ORM,
|
||||||
|
`*.up.sql`/`*.down.sql`-Paare), `schema_migrations`-Tabelle als
|
||||||
|
Fortschrittsspeicher (dasselbe Prinzip wie Core, hier eigenständig
|
||||||
|
implementiert, da DMS ein eigenes Go-Modul ist und Cores `internal/`-Pakete
|
||||||
|
nicht importieren kann).
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Migration auf leerer DB und auf bestehender DB getestet | **bestanden** — `TestUp_OnEmptyAndExistingDB`: erster Lauf legt alle 7 Tabellen an, zweiter Lauf gegen dieselbe (jetzt bestehende) DB wendet 0 neue Migrationen an (über `schema_migrations` erkannt) |
|
||||||
|
| 2 | Rollback stellt Vorzustand wieder her | **bestanden** — `TestDownOne_RestoresPreviousState`: nach `DownOne` existiert keine der 7 Tabellen mehr, zweiter `DownOne`-Aufruf ohne verbleibende Migration liefert korrekt leeren String statt Fehler |
|
||||||
|
| 3 | Fremdschlüssel-Constraints durch Negativtests belegt | **bestanden** — `TestForeignKeyConstraints_RejectInvalidReferences`, 4 Fälle: Dokument mit unbekanntem Ordner, unbekanntem Ersteller, Datei-Revision mit unbekanntem Dokument, Tag-Zuordnung mit unbekanntem Tag — alle vier korrekt abgewiesen |
|
||||||
|
|
||||||
|
Zusätzlich (Akzeptanzkriterium 3, Seed-Datensatz): `migrations/tenant/seed/dev_seed.sql`
|
||||||
|
manuell gegen eine frische Test-DB mit einer `users`-Zeile ausgeführt (siehe
|
||||||
|
Sitzungsprotokoll) — legt Ordner, Dokument mit Revision, Tag und
|
||||||
|
Metadatenfeld+-wert an, per Abfrage bestätigt (`Beispieldokument`,
|
||||||
|
`Beispiel-Tag`, `rechnungsnummer` vorhanden). Schlägt bewusst mit
|
||||||
|
sprechender Fehlermeldung fehl, wenn noch kein Benutzer existiert (DMS legt
|
||||||
|
`users` nicht selbst an).
|
||||||
|
|
||||||
|
## Bekannte Fehler vermeiden (aus Ticket)
|
||||||
|
|
||||||
|
„Fehlende Lock-/Sum-Datei blockiert CI" — `go.sum` ist committet (siehe
|
||||||
|
`git status`/Commit-Diff), `go mod tidy` auf 192.168.1.131 ausgeführt und
|
||||||
|
Ergebnis übernommen.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
make lint -> clean (golangci-lint)
|
||||||
|
go test ./... -v -count=1 -> 3/3 Pakete mit Tests ok (cmd/app, internal/migrate), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
erfüllt und belegt.
|
||||||
+14
@@ -0,0 +1,14 @@
|
|||||||
|
module gitea.perlbach24.de/scripte/nexarch/dms
|
||||||
|
|
||||||
|
go 1.22
|
||||||
|
|
||||||
|
require github.com/jackc/pgx/v5 v5.6.0
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||||
|
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
||||||
|
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
||||||
|
golang.org/x/crypto v0.17.0 // indirect
|
||||||
|
golang.org/x/sync v0.1.0 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
)
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
// Package migrate implementiert FDN-02s Migrationsmechanik: versionierte,
|
||||||
|
// rueckrollbare SQL-Migrationsdateien (kein ORM), mit einer
|
||||||
|
// schema_migrations-Tabelle als Fortschrittsspeicher — dasselbe Prinzip wie
|
||||||
|
// NEXARCH Core (internal/migrate), hier eigenstaendig implementiert, da DMS
|
||||||
|
// ein eigenes Go-Modul ist und Cores internal/-Pakete nicht importieren
|
||||||
|
// kann.
|
||||||
|
package migrate
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Migration ist eine einzelne versionierte Migrationsdatei.
|
||||||
|
type Migration struct {
|
||||||
|
Version string // Dateiname ohne .up.sql/.down.sql, z.B. "0001_documents"
|
||||||
|
UpSQL string
|
||||||
|
DownSQL string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load liest alle *.up.sql/*.down.sql-Paare aus dir, sortiert nach
|
||||||
|
// Dateiname (Akzeptanzkriterium: Migrationen sind versioniert).
|
||||||
|
func Load(dir string) ([]Migration, error) {
|
||||||
|
entries, err := os.ReadDir(dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migrationsverzeichnis %q lesen: %w", dir, err)
|
||||||
|
}
|
||||||
|
var versions []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() || !strings.HasSuffix(e.Name(), ".up.sql") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
versions = append(versions, strings.TrimSuffix(e.Name(), ".up.sql"))
|
||||||
|
}
|
||||||
|
sort.Strings(versions)
|
||||||
|
|
||||||
|
migrations := make([]Migration, 0, len(versions))
|
||||||
|
for _, v := range versions {
|
||||||
|
up, err := os.ReadFile(filepath.Join(dir, v+".up.sql"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migration %q: up.sql lesen: %w", v, err)
|
||||||
|
}
|
||||||
|
down, err := os.ReadFile(filepath.Join(dir, v+".down.sql"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migration %q: down.sql lesen (jede Migration braucht ein Rollback): %w", v, err)
|
||||||
|
}
|
||||||
|
migrations = append(migrations, Migration{Version: v, UpSQL: string(up), DownSQL: string(down)})
|
||||||
|
}
|
||||||
|
return migrations, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func ensureTrackingTable(ctx context.Context, pool *pgxpool.Pool) error {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS schema_migrations (
|
||||||
|
version TEXT PRIMARY KEY,
|
||||||
|
applied_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
)
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("schema_migrations anlegen: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func appliedVersions(ctx context.Context, pool *pgxpool.Pool) (map[string]bool, error) {
|
||||||
|
rows, err := pool.Query(ctx, `SELECT version FROM schema_migrations`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("angewendete migrationen lesen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
applied := map[string]bool{}
|
||||||
|
for rows.Next() {
|
||||||
|
var v string
|
||||||
|
if err := rows.Scan(&v); err != nil {
|
||||||
|
return nil, fmt.Errorf("migrationsversion lesen: %w", err)
|
||||||
|
}
|
||||||
|
applied[v] = true
|
||||||
|
}
|
||||||
|
return applied, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Up wendet alle noch nicht angewendeten Migrationen in Reihenfolge an
|
||||||
|
// (Akzeptanzkriterium 2: vorwaerts ausfuehrbar) — bereits angewendete
|
||||||
|
// werden uebersprungen, damit Up auf einer leeren UND auf einer bestehenden
|
||||||
|
// DB funktioniert (Pruefung 1).
|
||||||
|
func Up(ctx context.Context, pool *pgxpool.Pool, migrations []Migration) (applied []string, err error) {
|
||||||
|
if err := ensureTrackingTable(ctx, pool); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
already, err := appliedVersions(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, m := range migrations {
|
||||||
|
if already[m.Version] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
tx, err := pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return applied, fmt.Errorf("transaktion fuer %q starten: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, m.UpSQL); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return applied, fmt.Errorf("migration %q anwenden: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, `INSERT INTO schema_migrations (version) VALUES ($1)`, m.Version); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return applied, fmt.Errorf("migration %q als angewendet markieren: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
return applied, fmt.Errorf("migration %q committen: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
applied = append(applied, m.Version)
|
||||||
|
}
|
||||||
|
return applied, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DownOne macht die zuletzt angewendete Migration rueckgaengig
|
||||||
|
// (Akzeptanzkriterium 2: rueckwaerts ausfuehrbar) und liefert deren Version,
|
||||||
|
// oder "" falls keine Migration angewendet war.
|
||||||
|
func DownOne(ctx context.Context, pool *pgxpool.Pool, migrations []Migration) (version string, err error) {
|
||||||
|
if err := ensureTrackingTable(ctx, pool); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
already, err := appliedVersions(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
var last *Migration
|
||||||
|
for i := len(migrations) - 1; i >= 0; i-- {
|
||||||
|
if already[migrations[i].Version] {
|
||||||
|
last = &migrations[i]
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if last == nil {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
tx, err := pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("transaktion fuer rollback von %q starten: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, last.DownSQL); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return "", fmt.Errorf("migration %q zurueckrollen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, `DELETE FROM schema_migrations WHERE version = $1`, last.Version); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return "", fmt.Errorf("migration %q aus schema_migrations entfernen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
return "", fmt.Errorf("rollback von %q committen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
return last.Version, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
package migrate
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// usersFixtureSQL spiegelt Core IAM-01s reales Schema
|
||||||
|
// (migrations/tenant/0001_users.up.sql im NEXARCH-Core-Modul) - DMS ist ein
|
||||||
|
// eigenes Go-Modul und kann Cores Migrationsdateien nicht importieren, daher
|
||||||
|
// hier als Testfixture kopiert, NICHT als Produktionsmigration (DMS legt
|
||||||
|
// users nicht selbst an, siehe "Nicht Bestandteil" in FDN-02).
|
||||||
|
const usersFixtureSQL = `
|
||||||
|
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||||
|
CREATE TABLE IF NOT EXISTS users (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
email TEXT NOT NULL UNIQUE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active',
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
`
|
||||||
|
|
||||||
|
func setupTest(t *testing.T) (*pgxpool.Pool, []Migration) {
|
||||||
|
t.Helper()
|
||||||
|
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { pool.Close() })
|
||||||
|
|
||||||
|
if _, err := pool.Exec(ctx, usersFixtureSQL); err != nil {
|
||||||
|
t.Fatalf("users-fixture anlegen: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO users (email, name) VALUES ('seed@example.test', 'Seed-Benutzer')
|
||||||
|
ON CONFLICT (email) DO NOTHING
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("seed-benutzer anlegen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
migrations, err := Load(migrationsDir(t))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("migrationen laden: %v", err)
|
||||||
|
}
|
||||||
|
return pool, migrations
|
||||||
|
}
|
||||||
|
|
||||||
|
func migrationsDir(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
wd, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("getwd: %v", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(wd, "..", "..", "migrations", "tenant")
|
||||||
|
}
|
||||||
|
|
||||||
|
func tableExists(t *testing.T, ctx context.Context, pool *pgxpool.Pool, name string) bool {
|
||||||
|
t.Helper()
|
||||||
|
var exists bool
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_name = $1)
|
||||||
|
`, name).Scan(&exists); err != nil {
|
||||||
|
t.Fatalf("tabellenexistenz von %q pruefen: %v", name, err)
|
||||||
|
}
|
||||||
|
return exists
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUp_OnEmptyAndExistingDB ist Pruefung 1: Migration auf leerer DB und
|
||||||
|
// auf bestehender DB getestet.
|
||||||
|
func TestUp_OnEmptyAndExistingDB(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
applied, err := Up(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("up (leere db): %v", err)
|
||||||
|
}
|
||||||
|
if len(applied) == 0 {
|
||||||
|
t.Fatal("erwartet mindestens 1 angewendete migration auf leerer db")
|
||||||
|
}
|
||||||
|
for _, table := range []string{"folders", "documents", "file_revisions", "tags", "document_tags", "metadata_fields", "document_metadata_values"} {
|
||||||
|
if !tableExists(t, ctx, pool, table) {
|
||||||
|
t.Fatalf("tabelle %q existiert nach Up nicht", table)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zweiter Up-Lauf gegen die JETZT BESTEHENDE db - muss ohne Fehler
|
||||||
|
// durchlaufen und darf nichts erneut anwenden (idempotent ueber
|
||||||
|
// schema_migrations).
|
||||||
|
appliedAgain, err := Up(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("up (bestehende db, zweiter lauf): %v", err)
|
||||||
|
}
|
||||||
|
if len(appliedAgain) != 0 {
|
||||||
|
t.Fatalf("zweiter Up-Lauf haette 0 neue migrationen anwenden sollen, hat %d", len(appliedAgain))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDownOne_RestoresPreviousState ist Pruefung 2: Rollback stellt den
|
||||||
|
// Vorzustand wieder her.
|
||||||
|
func TestDownOne_RestoresPreviousState(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := Up(ctx, pool, migrations); err != nil {
|
||||||
|
t.Fatalf("up: %v", err)
|
||||||
|
}
|
||||||
|
if !tableExists(t, ctx, pool, "documents") {
|
||||||
|
t.Fatal("voraussetzung nicht erfuellt: documents sollte nach Up existieren")
|
||||||
|
}
|
||||||
|
|
||||||
|
version, err := DownOne(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("downone: %v", err)
|
||||||
|
}
|
||||||
|
if version == "" {
|
||||||
|
t.Fatal("erwartet zurueckgerollte version, habe leeren string")
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, table := range []string{"folders", "documents", "file_revisions", "tags", "document_tags", "metadata_fields", "document_metadata_values"} {
|
||||||
|
if tableExists(t, ctx, pool, table) {
|
||||||
|
t.Fatalf("tabelle %q existiert nach Rollback noch - Vorzustand nicht wiederhergestellt", table)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Erneutes DownOne ohne verbleibende angewendete Migration liefert "".
|
||||||
|
version2, err := DownOne(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("downone (nichts mehr anzuwenden): %v", err)
|
||||||
|
}
|
||||||
|
if version2 != "" {
|
||||||
|
t.Fatalf("erwartet leeren string bei leerer schema_migrations, habe %q", version2)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestForeignKeyConstraints_RejectInvalidReferences ist Pruefung 3:
|
||||||
|
// Fremdschluessel-Constraints durch Negativtests belegt.
|
||||||
|
func TestForeignKeyConstraints_RejectInvalidReferences(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
if _, err := Up(ctx, pool, migrations); err != nil {
|
||||||
|
t.Fatalf("up: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var userID string
|
||||||
|
if err := pool.QueryRow(ctx, `SELECT id FROM users LIMIT 1`).Scan(&userID); err != nil {
|
||||||
|
t.Fatalf("seed-benutzer lesen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Run("dokument mit unbekanntem ordner wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO documents (folder_id, title, created_by) VALUES (gen_random_uuid(), 'x', $1)
|
||||||
|
`, userID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem folder_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("dokument mit unbekanntem ersteller wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO documents (title, created_by) VALUES ('x', gen_random_uuid())
|
||||||
|
`)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem created_by haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("datei-revision mit unbekanntem dokument wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO file_revisions (document_id, revision_number, storage_key, checksum_sha256, size_bytes, mime_type, created_by)
|
||||||
|
VALUES (gen_random_uuid(), 1, 'k', repeat('0',64), 1, 'text/plain', $1)
|
||||||
|
`, userID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem document_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("tag-zuordnung mit unbekanntem tag wird abgewiesen", func(t *testing.T) {
|
||||||
|
var docID string
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
INSERT INTO documents (title, created_by) VALUES ('fk-test-doc', $1) RETURNING id
|
||||||
|
`, userID).Scan(&docID); err != nil {
|
||||||
|
t.Fatalf("testdokument anlegen: %v", err)
|
||||||
|
}
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO document_tags (document_id, tag_id) VALUES ($1, gen_random_uuid())
|
||||||
|
`, docID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem tag_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
// Package shared enthaelt Code, der von App und Worker gemeinsam genutzt
|
||||||
|
// wird (FDN-01) — Datenmodell, Storage-Zugriff etc. kommen in spaeteren
|
||||||
|
// Kacheln (FDN-02/FDN-03) hierher, dieses Paket ist bewusst noch schlank.
|
||||||
|
package shared
|
||||||
|
|
||||||
|
// Version ist die aktuelle DMS-Version, per -ldflags ueberschreibbar
|
||||||
|
// (siehe Makefile) — Platzhalter fuer echtes Versionsmanagement.
|
||||||
|
var Version = "dev"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
DROP TABLE IF EXISTS document_metadata_values;
|
||||||
|
DROP TABLE IF EXISTS metadata_fields;
|
||||||
|
DROP TABLE IF EXISTS document_tags;
|
||||||
|
DROP TABLE IF EXISTS tags;
|
||||||
|
ALTER TABLE documents DROP CONSTRAINT IF EXISTS fk_documents_current_revision;
|
||||||
|
DROP TABLE IF EXISTS file_revisions;
|
||||||
|
DROP TABLE IF EXISTS documents;
|
||||||
|
DROP TABLE IF EXISTS folders;
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
-- Kern-Entitaeten des DMS (FDN-02): Dokument, Datei-Revision, Ordner, Tag,
|
||||||
|
-- Metadatenfeld. Laeuft in der DB EINES Mandanten (Modell C, siehe Core
|
||||||
|
-- TEN-01) — keine tenant_id-Spalte, die Tenant-Zugehoerigkeit ist implizit
|
||||||
|
-- durch die Datenbankverbindung gegeben. FK auf users(id) spiegelt das
|
||||||
|
-- Benutzer-Datenmodell aus Core IAM-01 (migrations/tenant/0001_users.up.sql
|
||||||
|
-- im NEXARCH-Core-Modul) — Auth/Benutzerverwaltung liegt vollstaendig in
|
||||||
|
-- Core (siehe "Nicht Bestandteil" in FDN-02), diese Migration dupliziert sie
|
||||||
|
-- NICHT, sondern setzt sie als bereits vorhanden voraus (users-Tabelle wird
|
||||||
|
-- durch Cores eigene Migration in derselben physischen Tenant-Datenbank
|
||||||
|
-- angelegt, bevor DMS-Migrationen laufen).
|
||||||
|
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||||
|
|
||||||
|
CREATE TABLE folders (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
parent_folder_id UUID REFERENCES folders(id) ON DELETE CASCADE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_folders_parent_folder_id ON folders(parent_folder_id);
|
||||||
|
|
||||||
|
CREATE TABLE documents (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
folder_id UUID REFERENCES folders(id) ON DELETE SET NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
-- current_revision_id verweist erst NACH der Anlage von file_revisions
|
||||||
|
-- auf eine Zeile (siehe ALTER TABLE unten) — beim INSERT eines Dokuments
|
||||||
|
-- existiert noch keine Revision, daher NULLable und zirkulaer per
|
||||||
|
-- nachtraeglichem FOREIGN KEY statt Inline-Referenz geloest.
|
||||||
|
current_revision_id UUID,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
deleted_at TIMESTAMPTZ
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_documents_folder_id ON documents(folder_id);
|
||||||
|
CREATE INDEX idx_documents_created_by ON documents(created_by);
|
||||||
|
|
||||||
|
CREATE TABLE file_revisions (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
revision_number INT NOT NULL,
|
||||||
|
-- storage_key ist ein Platzhalter fuer die Objekt-Storage-Abstraktion
|
||||||
|
-- (FDN-03, "Nicht Bestandteil" dieser Kachel) — hier nur die Spalte, die
|
||||||
|
-- spaetere Kachel legt fest, was tatsaechlich dahinter liegt.
|
||||||
|
storage_key TEXT NOT NULL,
|
||||||
|
checksum_sha256 TEXT NOT NULL,
|
||||||
|
size_bytes BIGINT NOT NULL,
|
||||||
|
mime_type TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
UNIQUE (document_id, revision_number)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_file_revisions_document_id ON file_revisions(document_id);
|
||||||
|
|
||||||
|
ALTER TABLE documents
|
||||||
|
ADD CONSTRAINT fk_documents_current_revision
|
||||||
|
FOREIGN KEY (current_revision_id) REFERENCES file_revisions(id) ON DELETE SET NULL;
|
||||||
|
|
||||||
|
CREATE TABLE tags (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
name TEXT NOT NULL UNIQUE,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE document_tags (
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
tag_id UUID NOT NULL REFERENCES tags(id) ON DELETE CASCADE,
|
||||||
|
PRIMARY KEY (document_id, tag_id)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_document_tags_tag_id ON document_tags(tag_id);
|
||||||
|
|
||||||
|
CREATE TABLE metadata_fields (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
field_key TEXT NOT NULL UNIQUE,
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
field_type TEXT NOT NULL CHECK (field_type IN ('text', 'number', 'date', 'bool', 'select')),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE document_metadata_values (
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
field_id UUID NOT NULL REFERENCES metadata_fields(id) ON DELETE CASCADE,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
PRIMARY KEY (document_id, field_id)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_document_metadata_values_field_id ON document_metadata_values(field_id);
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
-- Entwicklungs-Seed (Akzeptanzkriterium 3): legt einen Beispielordner, ein
|
||||||
|
-- Beispieldokument mit einer Revision, ein Tag und ein Metadatenfeld an.
|
||||||
|
-- Setzt voraus, dass mindestens ein Benutzer existiert (Core IAM-01 legt
|
||||||
|
-- users an, DMS tut das nicht selbst - siehe "Nicht Bestandteil" in
|
||||||
|
-- FDN-02) - schlaegt sonst absichtlich mit einer sprechenden Fehlermeldung
|
||||||
|
-- fehl statt einen Platzhalter-Benutzer anzulegen, den DMS gar nicht
|
||||||
|
-- verwalten darf.
|
||||||
|
DO $$
|
||||||
|
DECLARE
|
||||||
|
seed_user_id UUID;
|
||||||
|
seed_folder_id UUID;
|
||||||
|
seed_document_id UUID;
|
||||||
|
BEGIN
|
||||||
|
SELECT id INTO seed_user_id FROM users ORDER BY created_at LIMIT 1;
|
||||||
|
IF seed_user_id IS NULL THEN
|
||||||
|
RAISE EXCEPTION 'dev_seed.sql: keine Zeile in users gefunden - zuerst Core-Seed (IAM-01) ausfuehren';
|
||||||
|
END IF;
|
||||||
|
|
||||||
|
INSERT INTO folders (name, created_by) VALUES ('Beispielordner', seed_user_id)
|
||||||
|
RETURNING id INTO seed_folder_id;
|
||||||
|
|
||||||
|
INSERT INTO documents (folder_id, title, created_by) VALUES (seed_folder_id, 'Beispieldokument', seed_user_id)
|
||||||
|
RETURNING id INTO seed_document_id;
|
||||||
|
|
||||||
|
INSERT INTO file_revisions (document_id, revision_number, storage_key, checksum_sha256, size_bytes, mime_type, created_by)
|
||||||
|
VALUES (seed_document_id, 1, 'dev-seed/beispiel.pdf', repeat('0', 64), 12345, 'application/pdf', seed_user_id);
|
||||||
|
|
||||||
|
UPDATE documents SET current_revision_id = (
|
||||||
|
SELECT id FROM file_revisions WHERE document_id = seed_document_id AND revision_number = 1
|
||||||
|
) WHERE id = seed_document_id;
|
||||||
|
|
||||||
|
INSERT INTO tags (name) VALUES ('Beispiel-Tag')
|
||||||
|
ON CONFLICT (name) DO NOTHING;
|
||||||
|
|
||||||
|
INSERT INTO document_tags (document_id, tag_id)
|
||||||
|
SELECT seed_document_id, id FROM tags WHERE name = 'Beispiel-Tag';
|
||||||
|
|
||||||
|
INSERT INTO metadata_fields (field_key, label, field_type) VALUES ('rechnungsnummer', 'Rechnungsnummer', 'text')
|
||||||
|
ON CONFLICT (field_key) DO NOTHING;
|
||||||
|
|
||||||
|
INSERT INTO document_metadata_values (document_id, field_id, value)
|
||||||
|
SELECT seed_document_id, id, 'RE-2026-0001' FROM metadata_fields WHERE field_key = 'rechnungsnummer';
|
||||||
|
END $$;
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
# NEXARCH Core – Teststrategie
|
|
||||||
|
|
||||||
Stand: 2026-08-28. Ticket: QA-01.
|
|
||||||
|
|
||||||
## 1. Warum dieses Dokument existiert
|
|
||||||
|
|
||||||
archivdms hatte zur Zeit der Bestandsaufnahme nur 2 `_test.go`-Dateien in ganz `internal/`, davon 0 für
|
|
||||||
`auth`/`storage`/`permissions.go`. archivmail testete 2 von 18 Modulen. Beide Lücken wurden erst im
|
|
||||||
Betrieb entdeckt, nicht vor dem Merge. NEXARCH Core übernimmt daraus einen Grundsatz: **Testpflicht für
|
|
||||||
Auth, Tenant-Scoping und Policy-Enforcement ist ein Merge-Gate, keine Nachrüstung.**
|
|
||||||
|
|
||||||
## 2. Testpyramide
|
|
||||||
|
|
||||||
| Ebene | Werkzeug | Umfang |
|
|
||||||
|---|---|---|
|
|
||||||
| Unit | `go test` (Standardbibliothek) | Einzelne Funktionen/Typen, keine externe Abhängigkeit (DB, Netzwerk) |
|
|
||||||
| Integration | `go test` gegen echte PostgreSQL-Instanz (`nexarch_test`-Rolle) | Repository-/Handler-Schicht, Tenant-Scoping, Policy-Enforcement |
|
|
||||||
| Vertragstests | `internal/contracttest` (siehe QA-07) | Öffentliche API-Verträge zwischen Core und Modulen |
|
|
||||||
| Last-/Leistungstests | `internal/loadtest` (siehe QA-08) | Mehrmodul-Last, JWT-Verifikation, Connection-Pooling |
|
|
||||||
| Extern | Core `QA-06` Penetrationstest | Vor Produktivbetrieb, außerhalb dieses CI-Gates |
|
|
||||||
|
|
||||||
Diese Kachel (QA-01) legt die Pflichtebenen fest und erzwingt sie technisch für die drei sicherheitskritischsten Bereiche; sie ersetzt nicht QA-07/QA-08, die eigene, bereits umgesetzte CI-Gates haben.
|
|
||||||
|
|
||||||
## 3. Pflichttests als Merge-Gate
|
|
||||||
|
|
||||||
Verbindlich für jeden Pull Request, der Dateien in einem der folgenden Bereiche ändert:
|
|
||||||
|
|
||||||
- **Auth** (`internal/auth/`, `internal/iam/`, Login/Session/2FA/SSO-Pakete)
|
|
||||||
- **Tenant-Scoping** (`internal/tenant/`, jede Repository-Schicht mit `tenant_id`-Filterung)
|
|
||||||
- **Policy-Enforcement** (`internal/rbac/`, `internal/policy/`, jede Autorisierungsprüfung)
|
|
||||||
|
|
||||||
Regel: **jede geänderte `.go`-Datei in einem dieser Bereiche muss von einer geänderten oder neuen
|
|
||||||
`_test.go`-Datei im selben Package begleitet sein.** Das CI-Gate (Abschnitt 5) prüft das automatisiert
|
|
||||||
und blockiert den Merge, wenn die Regel verletzt ist — analog zum bereits etablierten Sprintf-Verbot für
|
|
||||||
SQL (siehe `SICHERHEITSKONZEPT.md`), nur als technisch erzwungene statt nur dokumentierte Regel.
|
|
||||||
|
|
||||||
Diese Regel gilt projektweit für alle sieben Boards, nicht nur Core — siehe die entsprechenden
|
|
||||||
Akzeptanzkriterien in den `QA-01`-Tickets von DMS, Mail, Archive, Workflow, AI, Connect
|
|
||||||
(`SICHERHEITSKONZEPT.md` Abschnitt 11, Punkt 8, 2026-08-28 geklärt).
|
|
||||||
|
|
||||||
## 4. Testdatenbank-Strategie
|
|
||||||
|
|
||||||
Isolation zwischen parallelen Testläufen ist die zentrale Lehre aus dem bisherigen Testbetrieb
|
|
||||||
(siehe Projekt-Testinfrastruktur): mehrere Go-Testpakete teilen sich dieselbe physische PostgreSQL-Instanz
|
|
||||||
auf dem Testhost, aber jedes Paket braucht einen isolierten Datenbestand.
|
|
||||||
|
|
||||||
- **Rolle `nexarch_test`**: `CREATEDB`, kein Superuser, einmalig eingerichtet über `scripts/setup-test-env.sh`.
|
|
||||||
- **Reset vor jedem Testlauf**: `scripts/reset-test-env.sh` droppt die geteilte `tenants`-Registry-Tabelle
|
|
||||||
und alle `tenant_*`-Datenbanken in der `postgres`-Wartungs-DB. Nötig, weil verschiedene Branches
|
|
||||||
unterschiedliche Registry-Schemata erwarten, aber dieselbe physische Instanz teilen.
|
|
||||||
- **`-p 1` ist Pflicht** für `go test ./...`, sobald mehrere Pakete gegen die geteilte Registry-Tabelle
|
|
||||||
testen (z. B. `internal/tenant` + `internal/migrate`). Ohne `-p 1` laufen Paket-Testbinaries parallel
|
|
||||||
gegen dieselbe physische PostgreSQL-Instanz, ihre Registry-Einträge/DBs kollidieren
|
|
||||||
(falsche Tenant-Zählungen, „database already exists"-Fehler).
|
|
||||||
- **Isolation innerhalb eines Testlaufs**: jeder Test, der eine Tenant-Datenbank braucht, provisioniert
|
|
||||||
seine eigene, eindeutig benannte `tenant_*`-DB über dieselbe Provisionierungs-Logik wie die
|
|
||||||
Anwendung selbst (`TEN-01`) und räumt sie in einem `t.Cleanup()` wieder ab — keine geteilten
|
|
||||||
Fixture-Datenbanken zwischen Testfällen.
|
|
||||||
|
|
||||||
Siehe `internal/testdbisolation/isolation_test.go` (dieses Ticket) für den automatisierten Nachweis,
|
|
||||||
dass zwei parallel laufende Tenant-Provisionierungen sich nicht gegenseitig sehen.
|
|
||||||
|
|
||||||
## 5. CI-Gate
|
|
||||||
|
|
||||||
`.gitea/workflows/pflichttest-gate.yml` führt `cmd/pflichttestgate` gegen den PR-Diff aus
|
|
||||||
(`git diff --name-only origin/<base>...HEAD`). Das Programm:
|
|
||||||
|
|
||||||
1. Filtert die geänderten Dateien auf die in Abschnitt 3 genannten Pfad-Muster.
|
|
||||||
2. Prüft je betroffenem Go-Package, ob mindestens eine `_test.go`-Datei desselben Packages ebenfalls
|
|
||||||
im Diff enthalten ist.
|
|
||||||
3. Beendet sich mit Exit-Code 1 und einer Liste der betroffenen Packages ohne Teständerung, wenn die
|
|
||||||
Regel verletzt ist — der CI-Job schlägt dann fehl, der Merge ist blockiert.
|
|
||||||
|
|
||||||
Negativtest des Gates selbst: `internal/pflichttestgate/gate_test.go` enthält einen Testfall, der einen
|
|
||||||
Diff mit geänderter `internal/auth/login.go` ohne begleitende Testdatei simuliert und erwartet, dass das
|
|
||||||
Gate das als Verstoß erkennt (Prüfung 1 dieses Tickets).
|
|
||||||
|
|
||||||
## 6. Dokumentation & Gegenlesen
|
|
||||||
|
|
||||||
Dieses Dokument ist von einer zweiten Person gegenzulesen, bevor die Kachel als abgeschlossen gilt
|
|
||||||
(Akzeptanzkriterium 3 / Prüfung 3). Fund/Freigabe wird im Pull Request vermerkt.
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
// Package pflichttestgate erzwingt die in docs/TESTSTRATEGIE-CORE.md Abschnitt 3 festgelegte Regel:
|
|
||||||
// jede geänderte Go-Datei in einem sicherheitskritischen Bereich (Auth, Tenant-Scoping, Policy)
|
|
||||||
// muss von einer geänderten oder neuen _test.go-Datei im selben Package begleitet sein.
|
|
||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"path"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// sensitivePathPatterns beschreibt die Bereiche aus TESTSTRATEGIE-CORE.md Abschnitt 3.
|
|
||||||
var sensitivePathPatterns = []*regexp.Regexp{
|
|
||||||
regexp.MustCompile(`(^|/)internal/auth/`),
|
|
||||||
regexp.MustCompile(`(^|/)internal/iam/`),
|
|
||||||
regexp.MustCompile(`(^|/)internal/tenant/`),
|
|
||||||
regexp.MustCompile(`(^|/)internal/rbac/`),
|
|
||||||
regexp.MustCompile(`(^|/)internal/policy/`),
|
|
||||||
}
|
|
||||||
|
|
||||||
// Violation beschreibt ein Package mit sicherheitskritischer Änderung ohne begleitende Testdatei.
|
|
||||||
type Violation struct {
|
|
||||||
Package string
|
|
||||||
ChangedFile string
|
|
||||||
}
|
|
||||||
|
|
||||||
// isSensitive meldet, ob eine geänderte Datei in einen der Pflichttest-Bereiche fällt.
|
|
||||||
func isSensitive(file string) bool {
|
|
||||||
if !strings.HasSuffix(file, ".go") || strings.HasSuffix(file, "_test.go") {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
for _, re := range sensitivePathPatterns {
|
|
||||||
if re.MatchString(file) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// CheckDiff prüft eine Liste geänderter Dateipfade (z. B. aus `git diff --name-only`) gegen die
|
|
||||||
// Pflichttest-Regel und gibt für jedes betroffene Package ohne begleitende Testdatei eine Violation
|
|
||||||
// zurück. Ein leeres Ergebnis bedeutet: Gate besteht.
|
|
||||||
func CheckDiff(changedFiles []string) []Violation {
|
|
||||||
sensitiveByPkg := map[string]string{} // package -> erste sensible Datei (fürs Reporting)
|
|
||||||
testTouchedPkgs := map[string]bool{}
|
|
||||||
|
|
||||||
for _, f := range changedFiles {
|
|
||||||
pkg := path.Dir(f)
|
|
||||||
if strings.HasSuffix(f, "_test.go") {
|
|
||||||
testTouchedPkgs[pkg] = true
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if isSensitive(f) {
|
|
||||||
if _, seen := sensitiveByPkg[pkg]; !seen {
|
|
||||||
sensitiveByPkg[pkg] = f
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var violations []Violation
|
|
||||||
for pkg, file := range sensitiveByPkg {
|
|
||||||
if !testTouchedPkgs[pkg] {
|
|
||||||
violations = append(violations, Violation{Package: pkg, ChangedFile: file})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return violations
|
|
||||||
}
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
// Prüfung 1 (QA-01): CI-Lauf mit absichtlich fehlendem Pflichttest schlägt kontrolliert fehl —
|
|
||||||
// Negativtest des Gates selbst.
|
|
||||||
func TestCheckDiff_BlocksAuthChangeWithoutTest(t *testing.T) {
|
|
||||||
changed := []string{
|
|
||||||
"internal/auth/login.go",
|
|
||||||
"internal/apiserver/handler.go", // unkritisch, keine Testpflicht
|
|
||||||
}
|
|
||||||
|
|
||||||
violations := CheckDiff(changed)
|
|
||||||
|
|
||||||
if len(violations) != 1 {
|
|
||||||
t.Fatalf("erwartet 1 Verstoß, bekommen %d: %+v", len(violations), violations)
|
|
||||||
}
|
|
||||||
if violations[0].Package != "internal/auth" {
|
|
||||||
t.Errorf("erwartetes Package internal/auth, bekommen %q", violations[0].Package)
|
|
||||||
}
|
|
||||||
if violations[0].ChangedFile != "internal/auth/login.go" {
|
|
||||||
t.Errorf("erwartete Datei internal/auth/login.go, bekommen %q", violations[0].ChangedFile)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_PassesWhenTestFileAccompaniesChange(t *testing.T) {
|
|
||||||
changed := []string{
|
|
||||||
"internal/auth/login.go",
|
|
||||||
"internal/auth/login_test.go",
|
|
||||||
}
|
|
||||||
|
|
||||||
violations := CheckDiff(changed)
|
|
||||||
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keinen Verstoß, bekommen %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_PassesForNewTestFileEvenWithoutSourceChange(t *testing.T) {
|
|
||||||
// Nachtraeglich ergaenzter Test fuer bestehenden Code ist erlaubt/erwuenscht.
|
|
||||||
changed := []string{"internal/tenant/registry_test.go"}
|
|
||||||
|
|
||||||
violations := CheckDiff(changed)
|
|
||||||
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keinen Verstoß, bekommen %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_IgnoresUnrelatedPackages(t *testing.T) {
|
|
||||||
changed := []string{"internal/config/config.go", "internal/db/db.go"}
|
|
||||||
|
|
||||||
violations := CheckDiff(changed)
|
|
||||||
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keinen Verstoß fuer unkritische Pakete, bekommen %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_CoversAllSensitiveAreas(t *testing.T) {
|
|
||||||
cases := []string{
|
|
||||||
"internal/auth/session.go",
|
|
||||||
"internal/iam/user.go",
|
|
||||||
"internal/tenant/provisioner.go",
|
|
||||||
"internal/rbac/enforcer.go",
|
|
||||||
"internal/policy/decision.go",
|
|
||||||
}
|
|
||||||
for _, f := range cases {
|
|
||||||
violations := CheckDiff([]string{f})
|
|
||||||
if len(violations) != 1 {
|
|
||||||
t.Errorf("Datei %q sollte als sensibel erkannt werden, Verstöße: %+v", f, violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_IgnoresNonGoFiles(t *testing.T) {
|
|
||||||
changed := []string{"internal/auth/README.md"}
|
|
||||||
|
|
||||||
violations := CheckDiff(changed)
|
|
||||||
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("Nicht-Go-Dateien duerfen keine Testpflicht ausloesen, bekommen %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
// Package testdbisolation demonstriert und prüft die in docs/TESTSTRATEGIE-CORE.md Abschnitt 4
|
|
||||||
// beschriebene Testdatenbank-Isolation: jeder Test, der eine Tenant-Datenbank braucht,
|
|
||||||
// provisioniert seine eigene, eindeutig benannte DB und räumt sie über Cleanup wieder ab —
|
|
||||||
// keine geteilten Fixture-Datenbanken zwischen parallelen Testläufen.
|
|
||||||
package testdbisolation
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ProvisionEphemeralDB legt unter dem gegebenen Admin-DSN eine neue, eindeutig benannte Datenbank an
|
|
||||||
// und liefert eine Cleanup-Funktion, die sie wieder droppt. adminDSN muss auf eine Wartungs-DB
|
|
||||||
// (z. B. "postgres") zeigen, name muss ein gültiger, bereits eindeutiger Bezeichner sein.
|
|
||||||
func ProvisionEphemeralDB(ctx context.Context, adminDSN, name string) (cleanup func(context.Context) error, err error) {
|
|
||||||
conn, err := pgx.Connect(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("verbindung zur wartungs-db fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
defer conn.Close(ctx)
|
|
||||||
|
|
||||||
if _, err := conn.Exec(ctx, fmt.Sprintf("CREATE DATABASE %s", pgx.Identifier{name}.Sanitize())); err != nil {
|
|
||||||
return nil, fmt.Errorf("datenbank %q konnte nicht angelegt werden: %w", name, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup = func(cleanupCtx context.Context) error {
|
|
||||||
adminConn, err := pgx.Connect(cleanupCtx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("cleanup: verbindung fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
defer adminConn.Close(cleanupCtx)
|
|
||||||
_, err = adminConn.Exec(cleanupCtx, fmt.Sprintf("DROP DATABASE IF EXISTS %s", pgx.Identifier{name}.Sanitize()))
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return cleanup, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// WriteMarker schreibt einen eindeutigen Beleg-Datensatz in die angegebene Datenbank (verbindet
|
|
||||||
// per dsnForDB), um im Test nachzuweisen, dass zwei parallele Provisionierungen sich nicht sehen.
|
|
||||||
func WriteMarker(ctx context.Context, dsn, table, value string) error {
|
|
||||||
pool, err := pgxpool.New(ctx, dsn)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer pool.Close()
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, fmt.Sprintf(
|
|
||||||
"CREATE TABLE IF NOT EXISTS %s (value text primary key)", pgx.Identifier{table}.Sanitize(),
|
|
||||||
)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_, err = pool.Exec(ctx, fmt.Sprintf("INSERT INTO %s (value) VALUES ($1)", pgx.Identifier{table}.Sanitize()), value)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// CountMarkers zählt die Belegzeilen in der angegebenen Datenbank/Tabelle.
|
|
||||||
func CountMarkers(ctx context.Context, dsn, table string) (int, error) {
|
|
||||||
pool, err := pgxpool.New(ctx, dsn)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
defer pool.Close()
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, fmt.Sprintf(
|
|
||||||
"CREATE TABLE IF NOT EXISTS %s (value text primary key)", pgx.Identifier{table}.Sanitize(),
|
|
||||||
)); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var n int
|
|
||||||
err = pool.QueryRow(ctx, fmt.Sprintf("SELECT count(*) FROM %s", pgx.Identifier{table}.Sanitize())).Scan(&n)
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
package testdbisolation
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestParallelProvisioning_AreIsolated ist der automatisierte Nachweis für QA-01 Prüfung 2:
|
|
||||||
// Testdatenbank-Isolation zwischen parallelen Testläufen. Zwei Provisionierungen laufen
|
|
||||||
// gleichzeitig, jede schreibt einen Beleg-Datensatz in ihre eigene DB — keine darf den
|
|
||||||
// Beleg der jeweils anderen sehen.
|
|
||||||
//
|
|
||||||
// Braucht TEST_ADMIN_DSN (siehe Projekt-Testinfrastruktur), läuft auf dem Testhost, nicht lokal
|
|
||||||
// auf der Entwicklungsmaschine (siehe "no installs"-Regel) — wird ohne gesetzte Variable übersprungen.
|
|
||||||
func TestParallelProvisioning_AreIsolated(t *testing.T) {
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt — Test läuft nur auf dem Testhost, siehe docs/TESTSTRATEGIE-CORE.md")
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
const numParallel = 2
|
|
||||||
dbNames := make([]string, numParallel)
|
|
||||||
for i := range dbNames {
|
|
||||||
dbNames[i] = fmt.Sprintf("qa01_isolation_%d_%d", time.Now().UnixNano(), i)
|
|
||||||
}
|
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
errs := make([]error, numParallel)
|
|
||||||
cleanups := make([]func(context.Context) error, numParallel)
|
|
||||||
|
|
||||||
for i, name := range dbNames {
|
|
||||||
wg.Add(1)
|
|
||||||
go func(idx int, dbName string) {
|
|
||||||
defer wg.Done()
|
|
||||||
|
|
||||||
cleanup, err := ProvisionEphemeralDB(ctx, adminDSN, dbName)
|
|
||||||
if err != nil {
|
|
||||||
errs[idx] = fmt.Errorf("provisionierung %d fehlgeschlagen: %w", idx, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
cleanups[idx] = cleanup
|
|
||||||
|
|
||||||
dbDSN := dsnForDB(adminDSN, dbName)
|
|
||||||
// Jede Goroutine schreibt einen für sie eindeutigen Beleg.
|
|
||||||
if err := WriteMarker(ctx, dbDSN, "isolation_marker", fmt.Sprintf("marker-von-goroutine-%d", idx)); err != nil {
|
|
||||||
errs[idx] = fmt.Errorf("markierung %d fehlgeschlagen: %w", idx, err)
|
|
||||||
}
|
|
||||||
}(i, name)
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
for _, cleanup := range cleanups {
|
|
||||||
if cleanup != nil {
|
|
||||||
_ = cleanup(context.Background())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
for i, err := range errs {
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("goroutine %d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Isolationsnachweis: jede DB enthält genau ihren eigenen Beleg (1), keinen fremden.
|
|
||||||
for i, name := range dbNames {
|
|
||||||
dbDSN := dsnForDB(adminDSN, name)
|
|
||||||
count, err := CountMarkers(ctx, dbDSN, "isolation_marker")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zaehlung in db %d fehlgeschlagen: %v", i, err)
|
|
||||||
}
|
|
||||||
if count != 1 {
|
|
||||||
t.Errorf("db %d (%s): erwartet genau 1 eigenen Beleg, gefunden %d — Isolation verletzt", i, name, count)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// dsnForDB ersetzt den Datenbanknamen im Wartungs-DSN durch den gegebenen Namen.
|
|
||||||
func dsnForDB(adminDSN, dbName string) string {
|
|
||||||
idx := strings.LastIndex(adminDSN, "/")
|
|
||||||
if idx == -1 {
|
|
||||||
return adminDSN
|
|
||||||
}
|
|
||||||
base := adminDSN[:idx+1]
|
|
||||||
rest := adminDSN[idx+1:]
|
|
||||||
if q := strings.Index(rest, "?"); q != -1 {
|
|
||||||
return base + dbName + rest[q:]
|
|
||||||
}
|
|
||||||
return base + dbName
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user