Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d252732d09 | ||
|
|
67bcdd1833 | ||
|
|
8100fa3d14 | ||
|
|
ae214f1731 | ||
|
|
10ba866f0e | ||
|
|
5e4b91c4e9 |
@@ -44,88 +44,3 @@ Keine Commits in dieser Session.
|
|||||||
Keine Änderungen ermittelbar.
|
Keine Änderungen ermittelbar.
|
||||||
|
|
||||||
---
|
---
|
||||||
## 2026-08-27 17:26 – 17:28 (1m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
- c895a67 core: initial Go module skeleton (config, db pool, tenant registry migration)
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitignore | 2 ++
|
|
||||||
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
|
||||||
- go.mod | 5 +++++
|
|
||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
|
||||||
- internal/db/db.go | 11 +++++++++++
|
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-27 17:28 – 17:29 (1m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
Keine Commits in dieser Session.
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitignore | 2 ++
|
|
||||||
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
|
||||||
- go.mod | 5 +++++
|
|
||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
|
||||||
- internal/db/db.go | 11 +++++++++++
|
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-27 17:31 – 17:31 (0m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
Keine Commits in dieser Session.
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitignore | 2 ++
|
|
||||||
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
|
||||||
- go.mod | 5 +++++
|
|
||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
|
||||||
- internal/db/db.go | 11 +++++++++++
|
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-27 17:36 – 17:36 (0m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
Keine Commits in dieser Session.
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitignore | 2 ++
|
|
||||||
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
|
||||||
- go.mod | 5 +++++
|
|
||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
|
||||||
- internal/db/db.go | 11 +++++++++++
|
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-27 17:36 – 17:37 (0m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
Keine Commits in dieser Session.
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- .gitignore | 2 ++
|
|
||||||
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
|
||||||
- go.mod | 5 +++++
|
|
||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
|
||||||
- internal/db/db.go | 11 +++++++++++
|
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
version: "2"
|
||||||
|
|
||||||
|
run:
|
||||||
|
timeout: 3m
|
||||||
|
|
||||||
|
linters:
|
||||||
|
default: none
|
||||||
|
enable:
|
||||||
|
- govet
|
||||||
|
- staticcheck
|
||||||
|
- errcheck
|
||||||
|
- unused
|
||||||
|
- ineffassign
|
||||||
|
|
||||||
|
formatters:
|
||||||
|
enable:
|
||||||
|
- gofmt
|
||||||
|
- goimports
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
.PHONY: build lint fmt test check
|
||||||
|
|
||||||
|
build:
|
||||||
|
go build ./...
|
||||||
|
|
||||||
|
lint:
|
||||||
|
golangci-lint run ./...
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
gofmt -l .
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "gofmt-Verstoesse gefunden, siehe oben" && exit 1)
|
||||||
|
|
||||||
|
test:
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
|
|
||||||
|
check: build
|
||||||
|
go vet ./...
|
||||||
|
golangci-lint run ./...
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# NEXARCH Archive
|
||||||
|
|
||||||
|
Zentrales, modulübergreifendes Modul für Aufbewahrung, WORM, Compliance und
|
||||||
|
Backup. Dieses Verzeichnis enthält bisher `internal/backup` (BAK-01,
|
||||||
|
Datenbank-Backup-Strategie) — weitere Bausteine folgen ticketweise.
|
||||||
|
|
||||||
|
## BAK-01: Datenbank-Backup
|
||||||
|
|
||||||
|
`cmd/backup-cli` — Aufrufpunkt für systemd-Timer (siehe
|
||||||
|
`../deploy/systemd/nexarch-archive-backup-*.timer`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export NEXARCH_BACKUP_PG_USER=nexarch_backup
|
||||||
|
export NEXARCH_BACKUP_PG_PASSWORD=...
|
||||||
|
export NEXARCH_BACKUP_DIR=/var/nexarch-archiv/backups/postgres # NICHT auf einem ephemeren Test-Dataset (siehe Betrieb)
|
||||||
|
export NEXARCH_BACKUP_KEEP_GENERATIONS=7 # optional, Default 7
|
||||||
|
|
||||||
|
backup-cli full # neue Vollsicherung + Verifikation
|
||||||
|
backup-cli incremental # inkrementelle Sicherung gegen die neueste Generation
|
||||||
|
backup-cli rotate # entfernt alle bis auf die neuesten N Generationen
|
||||||
|
```
|
||||||
|
|
||||||
|
Voraussetzung: die konfigurierte Postgres-Rolle braucht das
|
||||||
|
`REPLICATION`-Attribut (`pg_basebackup` nutzt eine
|
||||||
|
Replikationsverbindung), und `summarize_wal = on` muss serverseitig gesetzt
|
||||||
|
sein (PostgreSQL 17s natives inkrementelles Backup, keine WAL-Archivierung
|
||||||
|
nötig).
|
||||||
|
|
||||||
|
## BAK-02: Objekt-Storage-Backup
|
||||||
|
|
||||||
|
`cmd/objectbackup-cli` sichert einen lokalen Verzeichnisbaum (den
|
||||||
|
FDN-03-`LocalDriver`-Basisordner direkt, oder — für S3-gestützte
|
||||||
|
Deployments — einen vorgelagerten `rclone`-Spiegel) mit
|
||||||
|
[restic](https://restic.net) (Content-defined Chunking, verschlüsseltes
|
||||||
|
Repository, geprüftes Tooling statt Eigenbau):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export NEXARCH_OBJECTBACKUP_REPO_DIR=/var/nexarch-archiv/backups/objects
|
||||||
|
export NEXARCH_OBJECTBACKUP_PASSWORD=...
|
||||||
|
export NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS=30 # optional, Default 7
|
||||||
|
|
||||||
|
objectbackup-cli backup /var/nexarch-objects # Sicherung + Verifikation
|
||||||
|
objectbackup-cli check # vollständiges Lesen aller Datenblöcke
|
||||||
|
objectbackup-cli rotate # restic forget --keep-last N --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
## Betrieb: Backup-Zielverzeichnis
|
||||||
|
|
||||||
|
Backup-Ziele liegen unter `/var/nexarch-archiv/` (persistentes ZFS-Dataset,
|
||||||
|
`zfs/data/subvol-1131-disk-0` auf 192.168.1.131), NIEMALS unter
|
||||||
|
`/var/nexarch-test/` (ephemeres Dataset, wird von den `reset-test-env.sh`-
|
||||||
|
Skripten der anderen Module geleert). ZFS-seitige Snapshots/Replikation
|
||||||
|
dieses Datasets sind ein eigenständiges Infra-Runbook (siehe
|
||||||
|
`../../STORAGE-KONZEPT.md` Abschnitt 7), kein Ticket-Code — `zfs
|
||||||
|
dedup=on` bewusst NICHT setzen (hoher RAM-Bedarf), Deduplizierung läuft
|
||||||
|
ausschließlich App-seitig über restic.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make check # build + vet + lint + test, analog Core/DMS
|
||||||
|
```
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
// backup-cli ist der Aufrufpunkt für BAK-01, gedacht für systemd-Timer
|
||||||
|
// (siehe deploy/systemd/) — "automatisiert nach Zeitplan" (Akzeptanzkriterium
|
||||||
|
// 1) entsteht durch die Zeitplan-Definition im Timer-Unit, nicht durch
|
||||||
|
// einen eigenen In-Prozess-Scheduler (kein zusätzlicher Dauerprozess nötig,
|
||||||
|
// passt zur Produkt-DNA "kein Anwendungsserver mit unnötigem
|
||||||
|
// Ressourcenverbrauch").
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/backup"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadConfig() backup.Config {
|
||||||
|
cfg := backup.Config{
|
||||||
|
Host: os.Getenv("NEXARCH_BACKUP_PG_HOST"),
|
||||||
|
Port: os.Getenv("NEXARCH_BACKUP_PG_PORT"),
|
||||||
|
User: os.Getenv("NEXARCH_BACKUP_PG_USER"),
|
||||||
|
Password: os.Getenv("NEXARCH_BACKUP_PG_PASSWORD"),
|
||||||
|
BackupDir: os.Getenv("NEXARCH_BACKUP_DIR"),
|
||||||
|
}
|
||||||
|
if cfg.Host == "" {
|
||||||
|
cfg.Host = "localhost"
|
||||||
|
}
|
||||||
|
if cfg.Port == "" {
|
||||||
|
cfg.Port = "5432"
|
||||||
|
}
|
||||||
|
if cfg.User == "" || cfg.Password == "" || cfg.BackupDir == "" {
|
||||||
|
log.Fatal("NEXARCH_BACKUP_PG_USER, NEXARCH_BACKUP_PG_PASSWORD und NEXARCH_BACKUP_DIR muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func latestManifest(backupDir string) (string, error) {
|
||||||
|
generations, err := backup.ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if len(generations) == 0 {
|
||||||
|
return "", fmt.Errorf("keine vorhandene generation fuer inkrementelle sicherung gefunden - zuerst 'full' ausfuehren")
|
||||||
|
}
|
||||||
|
latest := generations[len(generations)-1]
|
||||||
|
full := backupDir + "/" + latest + "/" + backup.FullBackupDirName + "/" + backup.BackupManifestFile
|
||||||
|
if _, err := os.Stat(full); err == nil {
|
||||||
|
return full, nil
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("kein backup_manifest in der neuesten generation %q gefunden", latest)
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
log.Fatal("aufruf: backup-cli <full|incremental|verify|rotate> [args]")
|
||||||
|
}
|
||||||
|
cfg := loadConfig()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
switch os.Args[1] {
|
||||||
|
case "full":
|
||||||
|
genID := backup.NewGenerationID(time.Now())
|
||||||
|
manifest, err := backup.FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("vollsicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
dir := manifest[:len(manifest)-len("/"+backup.BackupManifestFile)]
|
||||||
|
if err := backup.Verify(dir); err != nil {
|
||||||
|
log.Fatalf("verifikation der vollsicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("vollsicherung %q erstellt und verifiziert: %s\n", genID, manifest)
|
||||||
|
|
||||||
|
case "incremental":
|
||||||
|
manifest, err := latestManifest(cfg.BackupDir)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
generations, _ := backup.ListGenerations(cfg.BackupDir)
|
||||||
|
genID := generations[len(generations)-1]
|
||||||
|
incID := backup.NewGenerationID(time.Now())
|
||||||
|
newManifest, err := backup.IncrementalBackup(ctx, cfg, genID, incID, manifest)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("inkrementelle sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
dir := newManifest[:len(newManifest)-len("/"+backup.BackupManifestFile)]
|
||||||
|
if err := backup.Verify(dir); err != nil {
|
||||||
|
log.Fatalf("verifikation der inkrementellen sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("inkrementelle sicherung %q erstellt und verifiziert: %s\n", incID, newManifest)
|
||||||
|
|
||||||
|
case "rotate":
|
||||||
|
keep := 7
|
||||||
|
if v := os.Getenv("NEXARCH_BACKUP_KEEP_GENERATIONS"); v != "" {
|
||||||
|
_, _ = fmt.Sscanf(v, "%d", &keep)
|
||||||
|
}
|
||||||
|
removed, err := backup.Rotate(cfg.BackupDir, keep)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("rotation abgeschlossen, %d generation(en) entfernt: %v\n", len(removed), removed)
|
||||||
|
|
||||||
|
default:
|
||||||
|
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
// objectbackup-cli ist der Aufrufpunkt für BAK-02, für systemd-Timer
|
||||||
|
// gedacht (siehe deploy/systemd/) — "automatisiert nach Zeitplan" entsteht
|
||||||
|
// durch die Timer-Definition, kein eigener Dauerprozess (dieselbe
|
||||||
|
// Begründung wie BAK-01 / cmd/backup-cli).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/objectbackup"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadConfig() objectbackup.Config {
|
||||||
|
cfg := objectbackup.Config{
|
||||||
|
RepoDir: os.Getenv("NEXARCH_OBJECTBACKUP_REPO_DIR"),
|
||||||
|
Password: os.Getenv("NEXARCH_OBJECTBACKUP_PASSWORD"),
|
||||||
|
}
|
||||||
|
if cfg.RepoDir == "" || cfg.Password == "" {
|
||||||
|
log.Fatal("NEXARCH_OBJECTBACKUP_REPO_DIR und NEXARCH_OBJECTBACKUP_PASSWORD muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
log.Fatal("aufruf: objectbackup-cli <backup <quellverzeichnis>|check|rotate>")
|
||||||
|
}
|
||||||
|
cfg := loadConfig()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := objectbackup.InitRepo(ctx, cfg); err != nil {
|
||||||
|
log.Fatalf("repository initialisieren: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch os.Args[1] {
|
||||||
|
case "backup":
|
||||||
|
if len(os.Args) < 3 {
|
||||||
|
log.Fatal("aufruf: objectbackup-cli backup <quellverzeichnis>")
|
||||||
|
}
|
||||||
|
summary, err := objectbackup.Backup(ctx, cfg, os.Args[2])
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
if err := objectbackup.Check(ctx, cfg, false); err != nil {
|
||||||
|
log.Fatalf("verifikation nach sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("sicherung %q erstellt und verifiziert (neu=%d geaendert=%d unveraendert=%d)\n",
|
||||||
|
summary.SnapshotID, summary.FilesNew, summary.FilesChanged, summary.FilesUnmodified)
|
||||||
|
|
||||||
|
case "check":
|
||||||
|
if err := objectbackup.Check(ctx, cfg, true); err != nil {
|
||||||
|
log.Fatalf("verifikation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Println("verifikation (mit vollstaendigem lesen) erfolgreich")
|
||||||
|
|
||||||
|
case "rotate":
|
||||||
|
keep := 7
|
||||||
|
if v := os.Getenv("NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS"); v != "" {
|
||||||
|
if n, err := strconv.Atoi(v); err == nil {
|
||||||
|
keep = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := objectbackup.Forget(ctx, cfg, keep); err != nil {
|
||||||
|
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Println("rotation abgeschlossen")
|
||||||
|
|
||||||
|
default:
|
||||||
|
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// reconcile-cli ist der Aufrufpunkt für BAK-05, für systemd-Timer gedacht
|
||||||
|
// (siehe deploy/systemd/) — "geplanter Abgleichs-Job" (Ticket-Vorgabe)
|
||||||
|
// entsteht durch die Timer-Definition, kein eigener Dauerprozess.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_RECONCILE_TENANT_DSN")
|
||||||
|
storageDir := os.Getenv("NEXARCH_RECONCILE_STORAGE_DIR")
|
||||||
|
if dsn == "" || storageDir == "" {
|
||||||
|
log.Fatal("NEXARCH_RECONCILE_TENANT_DSN und NEXARCH_RECONCILE_STORAGE_DIR muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := pgxpool.New(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("datenbankverbindung: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
dbEntries, err := reconcile.ListDBStorageKeys(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("datenbank-eintraege lesen: %v", err)
|
||||||
|
}
|
||||||
|
storageKeys, err := reconcile.ListStorageObjects(storageDir)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("objekt-storage durchlaufen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
report := reconcile.Reconcile(dbEntries, storageKeys)
|
||||||
|
|
||||||
|
encoder := json.NewEncoder(os.Stdout)
|
||||||
|
encoder.SetIndent("", " ")
|
||||||
|
if err := encoder.Encode(report); err != nil {
|
||||||
|
log.Fatalf("bericht ausgeben: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nicht-null-Exit-Code bei Abweichungen (Akzeptanzkriterium 3:
|
||||||
|
// Abweichungen werden BERICHTET, nicht automatisch behoben — der
|
||||||
|
// Exit-Code macht das fuer systemd/Monitoring sichtbar, OHNE selbst
|
||||||
|
// irgendetwas zu reparieren).
|
||||||
|
if !report.IsClean() {
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
// restore-cli ist der Aufrufpunkt fuer BAK-03: dokumentiertes,
|
||||||
|
// wiederholbares Restore-Verfahren fuer Datenbank (BAK-01) und
|
||||||
|
// Objekt-Storage (BAK-02). Kein systemd-Timer (Notfall-/Einzelfall-
|
||||||
|
// Werkzeug, kein Zeitplan) - manueller Aufruf mit expliziter Bestaetigung
|
||||||
|
// bei nicht-leerem Ziel.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/backup"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/objectbackup"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/restore"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
usage()
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
|
||||||
|
logPath := os.Getenv("NEXARCH_RESTORE_LOG")
|
||||||
|
if logPath == "" {
|
||||||
|
logPath = "/var/nexarch-archiv/restore.log"
|
||||||
|
}
|
||||||
|
|
||||||
|
switch os.Args[1] {
|
||||||
|
case "database":
|
||||||
|
runDatabase(logPath, os.Args[2:])
|
||||||
|
case "objects":
|
||||||
|
runObjects(logPath, os.Args[2:])
|
||||||
|
default:
|
||||||
|
usage()
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func usage() {
|
||||||
|
fmt.Fprintln(os.Stderr, "usage: restore-cli database [-force] <generation-id> <ziel-verzeichnis>")
|
||||||
|
fmt.Fprintln(os.Stderr, " restore-cli objects [-force] <snapshot-id> <ziel-verzeichnis>")
|
||||||
|
fmt.Fprintln(os.Stderr, "(Flag -force MUSS vor den Positionsargumenten stehen, Standardverhalten des Go-flag-Pakets)")
|
||||||
|
}
|
||||||
|
|
||||||
|
func runDatabase(logPath string, args []string) {
|
||||||
|
fs := flag.NewFlagSet("database", flag.ExitOnError)
|
||||||
|
force := fs.Bool("force", false, "bestehenden, nicht-leeren Inhalt im Zielverzeichnis ersetzen")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
if fs.NArg() != 2 {
|
||||||
|
usage()
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
generationID, target := fs.Arg(0), fs.Arg(1)
|
||||||
|
|
||||||
|
cfg := backup.Config{
|
||||||
|
Host: os.Getenv("NEXARCH_BACKUP_PG_HOST"),
|
||||||
|
Port: os.Getenv("NEXARCH_BACKUP_PG_PORT"),
|
||||||
|
User: os.Getenv("NEXARCH_BACKUP_PG_USER"),
|
||||||
|
Password: os.Getenv("NEXARCH_BACKUP_PG_PASSWORD"),
|
||||||
|
BackupDir: os.Getenv("NEXARCH_BACKUP_DIR"),
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
entry, err := restore.AtomicRestore(restore.KindDatabase, generationID, target, *force, logPath, func(tempDir string) error {
|
||||||
|
return backup.Restore(ctx, cfg, generationID, tempDir)
|
||||||
|
})
|
||||||
|
report(entry, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func runObjects(logPath string, args []string) {
|
||||||
|
fs := flag.NewFlagSet("objects", flag.ExitOnError)
|
||||||
|
force := fs.Bool("force", false, "bestehenden, nicht-leeren Inhalt im Zielverzeichnis ersetzen")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
if fs.NArg() != 2 {
|
||||||
|
usage()
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
snapshotID, target := fs.Arg(0), fs.Arg(1)
|
||||||
|
|
||||||
|
cfg := objectbackup.Config{
|
||||||
|
RepoDir: os.Getenv("NEXARCH_OBJECTBACKUP_REPO_DIR"),
|
||||||
|
Password: os.Getenv("NEXARCH_OBJECTBACKUP_PASSWORD"),
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
entry, err := restore.AtomicRestore(restore.KindObjects, snapshotID, target, *force, logPath, func(tempDir string) error {
|
||||||
|
return objectbackup.Restore(ctx, cfg, snapshotID, tempDir)
|
||||||
|
})
|
||||||
|
report(entry, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func report(entry restore.LogEntry, err error) {
|
||||||
|
fmt.Printf("restore %s: quelle=%s ziel=%s ergebnis=%s\n", entry.Kind, entry.Source, entry.Target, entry.Result)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("restore fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
// scrub-cli ist der Aufrufpunkt fuer BAK-08 (systemd-Timer, konfigurierbare
|
||||||
|
// Kadenz) — zieht eine Stichprobe existierender Objekte (BAK-05 als
|
||||||
|
// Existenz-Quelle), prueft deren Inhalt per SHA-256 gegen
|
||||||
|
// file_revisions.checksum_sha256, meldet Abweichungen (kein Auto-Repair)
|
||||||
|
// und schreibt den Befund-Zaehler fuer den OPS-05/OPS-03-Metrik-Export.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/scrub"
|
||||||
|
)
|
||||||
|
|
||||||
|
type finding struct {
|
||||||
|
StorageKey string `json:"storage_key"`
|
||||||
|
DocumentID string `json:"document_id"`
|
||||||
|
RevisionID string `json:"revision_id"`
|
||||||
|
Expected string `json:"expected_checksum"`
|
||||||
|
Actual string `json:"actual_checksum,omitempty"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type report struct {
|
||||||
|
GeneratedAt time.Time `json:"generated_at"`
|
||||||
|
Sampled int `json:"sampled"`
|
||||||
|
Findings []finding `json:"findings"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_SCRUB_TENANT_DSN")
|
||||||
|
storageDir := os.Getenv("NEXARCH_SCRUB_STORAGE_DIR")
|
||||||
|
if dsn == "" || storageDir == "" {
|
||||||
|
log.Fatal("NEXARCH_SCRUB_TENANT_DSN und NEXARCH_SCRUB_STORAGE_DIR muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
sampleSize := envInt("NEXARCH_SCRUB_SAMPLE_SIZE", 10)
|
||||||
|
cooldown := envDuration("NEXARCH_SCRUB_COOLDOWN", 24*time.Hour)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := pgxpool.New(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("datenbankverbindung: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
dbEntries, err := reconcile.ListDBStorageKeys(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("datenbank-eintraege lesen: %v", err)
|
||||||
|
}
|
||||||
|
storageKeys, err := reconcile.ListStorageObjects(storageDir)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("objekt-storage durchlaufen: %v", err)
|
||||||
|
}
|
||||||
|
rec := reconcile.Reconcile(dbEntries, storageKeys)
|
||||||
|
|
||||||
|
lastScrubbed, err := scrub.LoadLastScrubbed(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("scrub-zustand lesen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
now := time.Now().UTC()
|
||||||
|
candidates := scrub.Sample(rec.ExistingInStorage, lastScrubbed, cooldown, sampleSize, now)
|
||||||
|
|
||||||
|
keys := make([]string, 0, len(candidates))
|
||||||
|
for _, c := range candidates {
|
||||||
|
keys = append(keys, c.StorageKey)
|
||||||
|
}
|
||||||
|
expected, err := scrub.ExpectedChecksums(ctx, pool, keys)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("erwartete pruefsummen lesen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
rep := report{GeneratedAt: now, Sampled: len(candidates)}
|
||||||
|
for _, c := range candidates {
|
||||||
|
exp, known := expected[c.StorageKey]
|
||||||
|
if !known {
|
||||||
|
// Objekt in DB nicht (mehr) auffindbar - das ist BAK-05s
|
||||||
|
// Zustaendigkeit (existiert der Datenbankeintrag?), nicht
|
||||||
|
// dieses Jobs; ueberspringen ohne Markierung.
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
actual, readErr := scrub.ActualChecksum(storageDir, c.StorageKey)
|
||||||
|
ok := readErr == nil && actual == exp
|
||||||
|
if err := scrub.MarkScrubbed(ctx, pool, c.StorageKey, ok, now); err != nil {
|
||||||
|
log.Fatalf("scrub-zustand schreiben: %v", err)
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
f := finding{StorageKey: c.StorageKey, DocumentID: c.DocumentID, RevisionID: c.RevisionID, Expected: exp, Actual: actual}
|
||||||
|
if readErr != nil {
|
||||||
|
f.Error = readErr.Error()
|
||||||
|
}
|
||||||
|
rep.Findings = append(rep.Findings, f)
|
||||||
|
if err := scrub.RecordFinding(ctx, pool); err != nil {
|
||||||
|
log.Fatalf("befund-zaehler erhoehen: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
encoder := json.NewEncoder(os.Stdout)
|
||||||
|
encoder.SetIndent("", " ")
|
||||||
|
if err := encoder.Encode(rep); err != nil {
|
||||||
|
log.Fatalf("bericht ausgeben: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Befund wird gemeldet, nicht automatisch repariert (Akzeptanzkriterium
|
||||||
|
// 3) - der Exit-Code macht das fuer systemd/Monitoring sichtbar, ohne
|
||||||
|
// selbst etwas zu reparieren; die tatsaechliche Meldung an OPS-05
|
||||||
|
// laeuft ueber den separaten /metrics-Export (cmd/scrub-metrics), nicht
|
||||||
|
// ueber diesen Exit-Code.
|
||||||
|
if len(rep.Findings) > 0 {
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func envInt(name string, def int) int {
|
||||||
|
v := os.Getenv(name)
|
||||||
|
if v == "" {
|
||||||
|
return def
|
||||||
|
}
|
||||||
|
n, err := strconv.Atoi(v)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("%s: ungueltiger wert %q: %v", name, v, err)
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
func envDuration(name string, def time.Duration) time.Duration {
|
||||||
|
v := os.Getenv(name)
|
||||||
|
if v == "" {
|
||||||
|
return def
|
||||||
|
}
|
||||||
|
d, err := time.ParseDuration(v)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("%s: ungueltiger wert %q: %v", name, v, err)
|
||||||
|
}
|
||||||
|
return d
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
// scrub-metrics stellt BAK-08s Befund-Zaehler unter /metrics bereit — die
|
||||||
|
// OPS-05-Anbindung ist Pull-basiert (Core OPS-03 scrapt /metrics-URLs, kein
|
||||||
|
// Push-Mechanismus), daher braucht es einen eigenen, dauerhaft laufenden
|
||||||
|
// HTTP-Endpunkt getrennt vom Oneshot-scrub-cli (dessen Prozess nach jedem
|
||||||
|
// Lauf beendet ist und daher zum Scrape-Zeitpunkt nicht erreichbar waere).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/scrub"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_SCRUB_TENANT_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
log.Fatal("NEXARCH_SCRUB_TENANT_DSN muss gesetzt sein")
|
||||||
|
}
|
||||||
|
addr := os.Getenv("NEXARCH_SCRUB_METRICS_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8090"
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := pgxpool.New(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("datenbankverbindung: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/metrics", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
total, err := scrub.FindingsTotal(r.Context(), pool)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "text/plain; version=0.0.4")
|
||||||
|
// Counter (Akzeptanzkriterium/Nutzervorgabe: monoton steigend, kein
|
||||||
|
// Gauge) - kein Befund => Wert 0, kein Dauer-Alarm ("kein Befund
|
||||||
|
// bedeutet kein Alarm", nicht "kein Wert").
|
||||||
|
body := fmt.Sprintf(
|
||||||
|
"# HELP nexarch_archive_storage_integrity_failures_total Anzahl seit Einrichtung gefundener Pruefsummen-Abweichungen (BAK-08).\n"+
|
||||||
|
"# TYPE nexarch_archive_storage_integrity_failures_total counter\n"+
|
||||||
|
"nexarch_archive_storage_integrity_failures_total %d\n", total)
|
||||||
|
if _, err := w.Write([]byte(body)); err != nil {
|
||||||
|
log.Printf("scrub-metrics: antwort schreiben: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
log.Printf("scrub-metrics: listening on %s", addr)
|
||||||
|
if err := http.ListenAndServe(addr, mux); err != nil {
|
||||||
|
log.Fatalf("http server: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
# BAK-01 – Prüfprotokoll: Datenbank-Backup-Strategie
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen. Neues Modul-Verzeichnis `code/archive/`
|
||||||
|
(gleiches Monorepo-Muster wie `code/dms/`), eigenes Go-Modul
|
||||||
|
`gitea.perlbach24.de/scripte/nexarch/archive`.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: PostgreSQL-17-natives inkrementelles Backup
|
||||||
|
|
||||||
|
`pg_dump` kennt nur logische Vollsicherungen — "inkrementell" im Sinne des
|
||||||
|
Tickets erfordert das physische Backup-Verfahren. Gewählt: PostgreSQL 17s
|
||||||
|
natives `pg_basebackup --incremental` (WAL-Summarization), NICHT klassisches
|
||||||
|
WAL-Archiving (`archive_mode`), weil letzteres einen Neustart der
|
||||||
|
(geteilten, auch von Core/DMS-Tests genutzten) Postgres-Instanz auf
|
||||||
|
192.168.1.131 erfordert hätte. Stattdessen `summarize_wal = on` gesetzt —
|
||||||
|
nur ein `pg_reload_conf()`, kein Neustart, keine Unterbrechung laufender
|
||||||
|
Verbindungen (per Health-Check nach der Änderung bestätigt).
|
||||||
|
|
||||||
|
Voraussetzung geschaffen: Rolle `nexarch_backup` mit `REPLICATION`-Attribut
|
||||||
|
angelegt (Postgres verlangt eine Replikationsverbindung für
|
||||||
|
`pg_basebackup`), `pg_hba.conf` erlaubte lokale Replikationsverbindungen
|
||||||
|
bereits.
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/backup.FullBackup`/`IncrementalBackup` — rufen `pg_basebackup`
|
||||||
|
über `os/exec` auf, Ergebnis landet in einer Generationsstruktur
|
||||||
|
(`<BackupDir>/<Generation>/full/` bzw. `.../incremental/<ID>/`).
|
||||||
|
- `internal/backup.Verify` — öffnet `base.tar.gz` vollständig (gzip- UND
|
||||||
|
tar-Stream, jeder Eintrag bis zum Ende gelesen, nicht nur Kopfdaten) —
|
||||||
|
Akzeptanzkriterium 2: Verifikation auf Lesbarkeit, nicht nur Erstellung.
|
||||||
|
- `internal/backup.Rotate`/`ListGenerations` — Generationen sind nach
|
||||||
|
Zeitstempel-ID sortierbar, `Rotate` entfernt die ältesten bis auf `keep`
|
||||||
|
komplett (inklusive aller abhängigen Inkremente).
|
||||||
|
- `cmd/backup-cli` — `full`/`incremental`/`rotate`, aufgerufen von
|
||||||
|
systemd-Timern (`deploy/systemd/nexarch-archive-backup-*.timer`) —
|
||||||
|
"automatisiert nach Zeitplan" (Akzeptanzkriterium 1) entsteht durch die
|
||||||
|
Timer-Definition, kein zusätzlicher Dauerprozess nötig.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Sicherung gegen Testdatenbank erfolgreich erstellt und verifiziert | **bestanden** — `TestFullBackup_CreatesVerifiedBackup` gegen die echte Postgres-17-Instanz auf 192.168.1.131 (kein Mock), zusätzlich `TestIncrementalBackup_IsSmallerThanFull`: inkrementelle Sicherung real deutlich kleiner als Vollsicherung (167 KB vs. 16 MB bei der ersten manuellen Probe) — beweist echte inkrementelle Übertragung, nicht nur eine zweite Vollsicherung |
|
||||||
|
| 2 | Verifikation erkennt eine absichtlich beschädigte Sicherungsdatei | **bestanden** — `TestVerify_DetectsCorruptedFile`: 64 Bytes in der Mitte von `base.tar.gz` gekippt, `Verify` schlägt danach fehl (unbeschädigt zuvor erfolgreich) |
|
||||||
|
| 3 | Rotationsregel entfernt nachweislich nur die ältesten Generationen | **bestanden** — `TestRotate_RemovesOnlyOldestGenerations`: 5 Generationen, `keep=2`, exakt die 3 ältesten entfernt, die 2 neuesten nachweislich unangetastet |
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131 (nicht nur Testcode)
|
||||||
|
|
||||||
|
Anders als die zuletzt in DMS gefundenen "Baustein existiert, ist aber
|
||||||
|
nirgends verdrahtet"-Fälle (FDN-03/FDN-09 gegen Core) wurde hier die
|
||||||
|
komplette Kette tatsächlich installiert und ausgeführt:
|
||||||
|
|
||||||
|
- `backup-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-backup.env` mit den Verbindungsdaten (0600)
|
||||||
|
- 3 systemd-Timer installiert und aktiviert (`enable --now`):
|
||||||
|
Vollsicherung täglich 02:00 UTC, Inkrement stündlich, Rotation täglich
|
||||||
|
03:00 UTC (`systemctl list-timers` bestätigt alle drei scharf)
|
||||||
|
- Jeder der drei Dienste (`full`/`incremental`/`rotate`) einmal manuell über
|
||||||
|
`systemctl start` ausgelöst (nicht nur `go test` direkt) — alle drei mit
|
||||||
|
`status=0/SUCCESS`, Journal bestätigt inhaltlich korrekte Ausgabe
|
||||||
|
(Vollsicherung erstellt+verifiziert, Inkrement erstellt+verifiziert
|
||||||
|
gegen die richtige Vorgänger-Generation, Rotation lief ohne Fehler)
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 4/4 Tests ok, 0 Fehlschläge (echter Postgres 17, kein Mock)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Nachtrag (BAK-02-Sitzung): Backup-Zielverzeichnis korrigiert
|
||||||
|
|
||||||
|
`NEXARCH_BACKUP_DIR` zeigte ursprünglich auf `/var/backups/nexarch`
|
||||||
|
(Root-Dateisystem des Containers, kein dediziertes Dataset) — korrigiert auf
|
||||||
|
`/var/nexarch-archiv/backups/postgres` (persistentes ZFS-Dataset), siehe
|
||||||
|
`docs/BAK-02-PRUEFPROTOKOLL.md` Abschnitt „Korrektur an BAK-01" für Details.
|
||||||
|
Vollsicherung nach der Korrektur erneut über systemd ausgelöst, landet
|
||||||
|
nachweislich am neuen Ort.
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
real erfüllt — inklusive tatsächlicher systemd-Timer-Installation und
|
||||||
|
manuell ausgelöstem End-to-End-Lauf aller drei Dienste auf dem Testhost,
|
||||||
|
nicht nur isolierter Testcode.
|
||||||
|
|
||||||
|
## Nachtrag (BAK-03): Verify prüft jetzt auch pg_wal.tar.gz
|
||||||
|
|
||||||
|
Beim Bau von BAK-03s echtem Restore-Test fiel auf, dass `pg_basebackup`
|
||||||
|
(Standard-WAL-Methode `stream`) bei `-Ft -z` NEBEN `base.tar.gz` eine
|
||||||
|
zweite Archivdatei `pg_wal.tar.gz` erzeugt, die `Verify` bislang nie
|
||||||
|
geprüft hat — eine Sicherung mit beschädigtem WAL-Archiv wäre unbemerkt
|
||||||
|
nicht crash-konsistent wiederherstellbar gewesen. `Verify` prüft seither
|
||||||
|
beide Archive vollständig (siehe `BAK-03-PRUEFPROTOKOLL.md`). Das
|
||||||
|
Sicherungsverfahren selbst (Format, Ort, Rotation) bleibt unverändert.
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
# BAK-02 – Prüfprotokoll: Objekt-Storage-Backup/Snapshots
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: restic statt Eigenbau
|
||||||
|
|
||||||
|
Nutzerentscheidung: restic statt einer Neuimplementierung, weil restic alle
|
||||||
|
vier Akzeptanzkriterien mit ausgereiftem, breit geprüftem Tooling erfüllt
|
||||||
|
(Content-defined Chunking für Dedup, `check --read-data` für
|
||||||
|
Vollständigkeit, `forget --keep-last` für Rotation, Repository-Verschlüsselung
|
||||||
|
ab Werk). Installiert via `apt-get install restic` (Version 0.18.0).
|
||||||
|
|
||||||
|
Backup-Quelle ist ein lokaler Verzeichnisbaum — für den FDN-03-`LocalDriver`
|
||||||
|
direkt dessen Basisverzeichnis. Für S3-gestützte Produktions-Deployments
|
||||||
|
(Betriebsmodus 2/3 aus `STORAGE-KONZEPT.md` Abschnitt 6.2) wäre ein
|
||||||
|
vorgelagerter Sync-Schritt (z. B. `rclone`) nötig, um Bucket-Inhalte lokal
|
||||||
|
zu spiegeln, bevor restic sie sichert — restic sichert Dateibäume, keine
|
||||||
|
S3-Buckets direkt. Das bleibt hier bewusst unimplementiert (kein konkreter
|
||||||
|
S3-Produktionsbestand vorhanden, der das aktuell erfordert), aber
|
||||||
|
architektonisch vorgesehen und dokumentiert (`README.md`).
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/objectbackup.InitRepo` — idempotent, erkennt "bereits
|
||||||
|
initialisiert" am `restic init`-Fehlertext statt zu scheitern.
|
||||||
|
- `internal/objectbackup.Backup` — `restic backup --json`, parst die
|
||||||
|
`summary`-Zeile (mehrere JSON-Zeilen in der Ausgabe, gezielt die mit
|
||||||
|
`message_type=="summary"` gesucht).
|
||||||
|
- `internal/objectbackup.Check` — `restic check [--read-data]` (Akzeptanz-
|
||||||
|
kriterium 3: Vollständigkeitsprüfung).
|
||||||
|
- `internal/objectbackup.Forget` — `restic forget --keep-last N --prune`
|
||||||
|
(Rotation).
|
||||||
|
- `cmd/objectbackup-cli` — `backup <dir>`/`check`/`rotate`, aufgerufen von
|
||||||
|
systemd-Timern (stündlich/wöchentlich/täglich).
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Zweiter Sicherungslauf nach unverändertem Bestand überträgt keine Daten erneut | **bestanden** — `TestBackup_UnchangedSecondRunTransmitsNothingNew`: zweiter Lauf gegen unveränderten Bestand liefert `files_new=0`, `files_changed=0`, `files_unmodified=1` |
|
||||||
|
| 2 | Zwei identische Testdateien belegen nachweislich nur einmal Speicherplatz | **bestanden** — `TestBackup_DeduplicatesIdenticalContent`: zwei Dateien mit identischem Inhalt erzeugen `data_blobs=1`, nicht 2 — echter Dedup-Nachweis über restics Content-defined Chunking, nicht nur Namensvergleich |
|
||||||
|
| 3 | Vollständigkeitsprüfung erkennt ein fehlendes Objekt in der Sicherung | **bestanden** — `TestCheck_DetectsCorruptedPack`: ein Byte in einer echten Repository-Pack-Datei gekippt, `Check(readData=true)` schlägt danach fehl (unbeschädigt zuvor erfolgreich) — dieselbe Vorgehensweise wie die manuelle Recherche vor der Implementierung |
|
||||||
|
|
||||||
|
Zusätzlich (nicht explizit als Pflichtprüfung gefordert, aber Teil von
|
||||||
|
Akzeptanzkriterium 3 „lässt sich einzeln prüfen"): `TestForget_
|
||||||
|
KeepsOnlyRequestedSnapshotCount` — 3 Sicherungsläufe, `Forget(keepLast=1)`
|
||||||
|
reduziert auf genau 1 verbleibenden Snapshot.
|
||||||
|
|
||||||
|
## Korrektur an BAK-01 im selben Rutsch: Backup-Zielverzeichnis
|
||||||
|
|
||||||
|
Nutzerhinweis aufgegriffen: `NEXARCH_BACKUP_DIR` zeigte bei BAK-01
|
||||||
|
ursprünglich auf `/var/backups/nexarch` (Root-Dateisystem des LXC-
|
||||||
|
Containers, nicht auf einem der beiden dedizierten ZFS-Datasets). Korrigiert
|
||||||
|
auf `/var/nexarch-archiv/backups/postgres` (persistentes Dataset
|
||||||
|
`zfs/data/subvol-1131-disk-0`), NICHT `/var/nexarch-test/` (ephemeres
|
||||||
|
Dataset `ssd-rpool-data/swap/subvol-1131-disk-0`, wird von
|
||||||
|
`reset-test-env.sh`-Skripten anderer Module geleert). `objectbackup-cli`s
|
||||||
|
Repository liegt von Anfang an korrekt unter
|
||||||
|
`/var/nexarch-archiv/backups/objects`. Beide Pfade real auf
|
||||||
|
192.168.1.131 verifiziert (`df`/`mount` bestätigt ZFS-Dataset-Zuordnung),
|
||||||
|
BAK-01s Vollsicherung nach der Korrektur erneut über systemd ausgelöst und
|
||||||
|
bestätigt am neuen Ort gelandet.
|
||||||
|
|
||||||
|
ZFS-seitige Snapshot-/Replikations-Strategie für `nexarch/archiv` bleibt
|
||||||
|
bewusst außerhalb dieses Tickets (Infra-Runbook, siehe
|
||||||
|
`STORAGE-KONZEPT.md` Abschnitt 7 „Backup vs. Storage-Redundanz" sowie den
|
||||||
|
Hinweis, `zfs dedup=on` NICHT zu setzen — App-seitige Dedup über restic
|
||||||
|
genügt, ZFS-Dedup wäre auf dem 4-GB-Testhost ein Speicherrisiko).
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131
|
||||||
|
|
||||||
|
- `objectbackup-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-objectbackup.env` (0600)
|
||||||
|
- 3 systemd-Timer installiert und aktiviert: Sicherung stündlich (`:30`),
|
||||||
|
Vollständigkeitsprüfung wöchentlich (So. 04:00 UTC), Rotation täglich
|
||||||
|
(03:30 UTC) — `systemctl list-timers` bestätigt alle scharf
|
||||||
|
- Jeder der drei Dienste einmal über `systemctl start` ausgelöst, alle mit
|
||||||
|
`status=0/SUCCESS`; Journal bestätigt inhaltlich korrekte Ausgabe
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 2/2 Pakete mit Tests ok (internal/backup, internal/objectbackup), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
real gegen echtes restic-Tooling erfüllt. BAK-01-Pfadfehler im selben
|
||||||
|
Rutsch korrigiert und erneut end-to-end verifiziert.
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
# BAK-03 – Prüfprotokoll: Restore-Verfahren
|
||||||
|
|
||||||
|
Voraussetzungen BAK-01, BAK-02 – erledigt, siehe eigene Protokolle.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: Atomarität über Temp-Verzeichnis + Rename
|
||||||
|
|
||||||
|
`internal/restore.AtomicRestore` kennt weder Postgres noch restic —
|
||||||
|
reine Ablaufsteuerung: Wiederherstellung IMMER in ein frisches
|
||||||
|
temporäres Verzeichnis (nie direkt in das Ziel), Übernahme erst bei
|
||||||
|
Erfolg per `os.Rename` (selbes Dateisystem wie das Ziel, daher atomar).
|
||||||
|
Ist das Ziel nicht leer und keine Bestätigung (`-force`) gegeben, wird
|
||||||
|
NICHT einmal die Wiederherstellungsfunktion aufgerufen — Abbruch vor
|
||||||
|
jeder Berührung des Ziels (Akzeptanzkriterium 2). Jeder Aufruf — Erfolg,
|
||||||
|
Abbruch oder Fehler — erzeugt genau einen JSONL-Protokolleintrag
|
||||||
|
(Akzeptanzkriterium 3).
|
||||||
|
|
||||||
|
Die eigentliche Wiederherstellung bleibt in `internal/backup.Restore`
|
||||||
|
(Datenbank) und `internal/objectbackup.Restore` (Objekt-Storage) —
|
||||||
|
`internal/restore` orchestriert nur.
|
||||||
|
|
||||||
|
## Drei reale Defekte während der Implementierung gefunden und behoben
|
||||||
|
|
||||||
|
Alle drei erst durch den ECHTEN Restore-Test (Postgres-Instanz tatsächlich
|
||||||
|
gestartet, nicht nur Dateien verglichen) aufgedeckt:
|
||||||
|
|
||||||
|
1. **`pg_combinebackup` braucht Plain-Format, BAK-01 liefert Tar+Gzip.**
|
||||||
|
`Restore` extrahiert jetzt jede Sicherungsstufe zunächst in ein
|
||||||
|
temporäres Plain-Verzeichnis (inkl. `backup_manifest`-Kopie) und
|
||||||
|
speist erst DIESE in `pg_combinebackup`. BAK-01s Speicherformat selbst
|
||||||
|
unverändert (kleinere, leichter prüfbare Dateien).
|
||||||
|
2. **`pg_wal.tar.gz` wurde nie verifiziert oder wiederhergestellt.**
|
||||||
|
`pg_basebackup`s Standard-WAL-Methode (`stream`) erzeugt bei `-Ft -z`
|
||||||
|
eine ZWEITE Archivdatei neben `base.tar.gz` — ohne sie ist keine
|
||||||
|
crash-konsistente Wiederherstellung möglich (Postgres findet sonst
|
||||||
|
keinen gültigen Checkpoint). `backup.Verify` prüft jetzt BEIDE
|
||||||
|
Archive vollständig; `backup.Restore` extrahiert das WAL der ZULETZT
|
||||||
|
gezogenen Stufe (nicht aller Stufen) nach `pg_wal/` im
|
||||||
|
Wiederherstellungsziel. Ergänzung zu BAK-01s Prüfung, keine
|
||||||
|
Umstellung des Sicherungsverfahrens.
|
||||||
|
3. **Go-`exec`-Hänger bei `pg_ctl start`:** `pg_ctl` startet Postgres als
|
||||||
|
Hintergrundprozess, der die geerbten stdout/stderr-Pipes NICHT
|
||||||
|
schließt — `CombinedOutput()` (wartet auf Pipe-EOF) hängt sich
|
||||||
|
dadurch auf, obwohl `pg_ctl` selbst längst zurückgekehrt ist. Fix nur
|
||||||
|
im Testcode: echte Logdatei (`-l`) statt Pipe, Standard-`pg_ctl`-Muster.
|
||||||
|
|
||||||
|
Zusätzlich real (nicht Ticket-relevant, aber notiert): auf diesem
|
||||||
|
Debian-Postgres liegen `postgresql.conf`/`pg_hba.conf` NICHT in PGDATA
|
||||||
|
(sondern `/etc/postgresql/17/main/`) — ein echtes Restore-Runbook muss
|
||||||
|
diese Dateien separat mitführen/rekonstruieren, `pg_basebackup` sichert
|
||||||
|
sie nicht. Für den Testnachweis minimal nachgereicht, kein Produktcode.
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/restore.AtomicRestore` — Ablaufsteuerung, JSONL-Protokoll
|
||||||
|
(`Timestamp`, `Kind`, `Source`, `Target`, `Result`).
|
||||||
|
- `internal/backup.Restore` — `pg_combinebackup` gegen extrahierte
|
||||||
|
Plain-Verzeichnisse + WAL-Wiederherstellung der letzten Stufe.
|
||||||
|
- `internal/backup.extractTarGz` (in `verify.go`, neben der bestehenden
|
||||||
|
Tar/Gzip-Leselogik) — vollständige Extraktion, kein Kopf-only-Read.
|
||||||
|
- `internal/backup.Verify` — prüft jetzt `base.tar.gz` UND
|
||||||
|
`pg_wal.tar.gz` vollständig.
|
||||||
|
- `internal/objectbackup.Restore` — `restic restore --target`.
|
||||||
|
- `cmd/restore-cli` — `database`/`objects`-Unterbefehle, `-force`-Flag
|
||||||
|
(vor Positionsargumenten, Go-`flag`-Konvention), kein systemd-Timer
|
||||||
|
(Notfall-/Einzelfall-Werkzeug, kein Zeitplan).
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Restore auf leerem System vollständig und erfolgreich durchgeführt | **bestanden** — real: `TestRestore_CombinesIntoStartablePostgresInstance` (Postgres tatsächlich aus wiederhergestelltem Verzeichnis gestartet, `SELECT 1` über echte Verbindung beantwortet); zusätzlich real per `restore-cli database` auf 131 ausgeführt (PG_VERSION/base/pg_wal vorhanden, Exit 0); `TestRestore_RecoversRealContentFromSnapshot` (Objekt-Storage, echter Dateiinhalt verglichen) UND real per `restore-cli objects` auf 131 (echter restic-Snapshot wiederhergestellt) |
|
||||||
|
| 2 | Restore auf nicht-leeres Zielverzeichnis lässt bei Abbruch den ursprünglichen Inhalt unverändert | **bestanden** — `TestAtomicRestore_NonEmptyTargetWithoutForce_LeavesOriginalUntouched` (restoreFn wird nachweislich NIE aufgerufen) und `TestAtomicRestore_FailedRestoreFn_LeavesTargetUntouched`; real auf 131: `restore-cli database` gegen nicht-leeres Ziel ohne `-force` → Abbruch, bestehende Testdatei unverändert vorhanden |
|
||||||
|
| 3 | Protokolleintrag zum Restore ist vollständig und nachvollziehbar | **bestanden** — `TestAtomicRestore_LogsCompleteEntry` (Quelle, Ziel, Zeitpunkt, Ergebnis für Erfolgs- UND Abbruchfall in derselben Datei); real auf 131: `/tmp/restore-cli-test.log` zeigt alle vier realen Läufe (Abbruch, Fehler mangels PATH, Erfolg, Force-Überschreiben) korrekt protokolliert |
|
||||||
|
|
||||||
|
Zusätzlich: `TestAtomicRestore_EmptyTarget_Succeeds`,
|
||||||
|
`TestAtomicRestore_ForceOverwritesNonEmptyTarget` (bewusste Bestätigung
|
||||||
|
ersetzt bestehenden Inhalt real, alter Inhalt nachweislich weg, neuer da).
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131
|
||||||
|
|
||||||
|
- `restore-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- Kein systemd-Timer (bewusst — Notfall-/Einzelfall-Werkzeug)
|
||||||
|
- Vier reale CLI-Läufe durchgeführt und protokolliert: Abbruch bei
|
||||||
|
nicht-leerem Ziel ohne `-force`, Fehler mangels `pg_combinebackup` im
|
||||||
|
PATH (zeigt: Fehler wird korrekt erkannt UND protokolliert, kein
|
||||||
|
stiller Fehlschlag), erfolgreicher Restore einer echten Generation
|
||||||
|
(`20260829T222054Z`) in leeres Ziel, erfolgreiches Überschreiben mit
|
||||||
|
`-force`. Objekt-Storage-Restore real gegen echten restic-Snapshot
|
||||||
|
(`43da36bf`) — Inhalt (`.placeholder`-Datei) tatsächlich vorhanden.
|
||||||
|
- Alle Testartefakte (`/tmp/restore-*`, Testlog) nach Prüfung entfernt.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
```
|
||||||
|
|
||||||
|
`internal/restore`: 5/5 Tests (reine Funktionen, kein Setup nötig).
|
||||||
|
`internal/objectbackup`: `TestRestore_RecoversRealContentFromSnapshot`
|
||||||
|
bestanden (zusammen mit den bestehenden BAK-02-Tests).
|
||||||
|
`internal/backup`: `TestRestore_CombinesIntoStartablePostgresInstance`
|
||||||
|
bestanden — **Hinweis**: dieser eine Test läuft NICHT als root
|
||||||
|
(`pg_ctl: cannot be run as root`) und braucht `pg_combinebackup`/
|
||||||
|
`pg_ctl` im PATH (`/usr/lib/postgresql/17/bin` auf Debian, dort nicht
|
||||||
|
standardmäßig verlinkt) — daher separat als `postgres`-Systemnutzer mit
|
||||||
|
entsprechendem PATH ausgeführt, nicht Teil des root-`make check`-Laufs;
|
||||||
|
dort wird er mit klarer Meldung übersprungen (`pg_combinebackup nicht
|
||||||
|
installiert`), kein stiller Fehlschlag. Alle übrigen BAK-01-Tests
|
||||||
|
(inkl. der um `pg_wal.tar.gz` erweiterten `Verify`) liefen unverändert
|
||||||
|
grün im normalen `make check`-Lauf.
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
||||||
|
Pflichtprüfungen real erfüllt — beide Restore-Pfade (Datenbank,
|
||||||
|
Objekt-Storage) sowohl testgetrieben als auch manuell über `restore-cli`
|
||||||
|
auf echter Infrastruktur nachgewiesen. Drei während der Implementierung
|
||||||
|
gefundene reale Defekte (Tar-vs-Plain-Format, fehlende WAL-Sicherung/
|
||||||
|
-Verifikation, Go-exec-Pipe-Hänger) behoben und dokumentiert, nicht
|
||||||
|
stillschweigend umgangen.
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
# BAK-05 – Prüfprotokoll: Reconciliation / Konsistenzprüfung Storage vs. DB
|
||||||
|
|
||||||
|
Voraussetzung BAK-01, BAK-02 (Welle 1) – erledigt, siehe eigene Protokolle.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: reine Funktion + zwei Quell-Adapter
|
||||||
|
|
||||||
|
`internal/reconcile.Reconcile` ist eine reine Funktion ohne DB-/Storage-
|
||||||
|
Zugriff (leicht ohne echte Infrastruktur testbar), die Ein- und
|
||||||
|
Auslesen echter Systeme ist strikt in `sources.go` getrennt
|
||||||
|
(`ListDBStorageKeys` gegen echtes Postgres, `ListStorageObjects` gegen
|
||||||
|
echtes Dateisystem). Beide Seiten liefern nur SCHLÜSSEL – niemals Inhalt
|
||||||
|
– dadurch bleibt BAK-05 sauber getrennt von BAK-08 (Inhalts-/Prüfsummen-
|
||||||
|
verifikation, eigene Fehlerklasse, eigenes Ticket).
|
||||||
|
|
||||||
|
Report-Format bewusst deterministisch: alle drei Ergebnislisten
|
||||||
|
(`missing_in_storage`, `orphaned_in_storage`, `existing_in_storage`)
|
||||||
|
nach `storage_key` aufsteigend sortiert.
|
||||||
|
|
||||||
|
**Nachtrag (nach Rückfrage vor BAK-08-Start):** Der ursprüngliche Report
|
||||||
|
enthielt nur die beiden Abweichungslisten – keine Liste der bestätigt
|
||||||
|
existierenden Objekte. Für BAK-08 als Stichprobengrundlage reicht
|
||||||
|
"keine Abweichung" nicht, es braucht die tatsächliche, deterministisch
|
||||||
|
sortierte Liste. Ergänzt: `Report.ExistingInStorage` – DB-Eintrag UND
|
||||||
|
Storage-Objekt beide vorhanden, reine Existenzbestätigung (keine
|
||||||
|
Inhaltsprüfung, Scope-Trennung zu BAK-08 bleibt gewahrt), aufsteigend
|
||||||
|
nach `storage_key` sortiert. BAK-08 zieht seine Stichprobe daraus, ohne
|
||||||
|
selbst zu sortieren/filtern. Neuer Test
|
||||||
|
`TestReconcile_ExistingInStorageIsStableSamplingBasis` beweist Inhalt
|
||||||
|
und Sortierung. Real neu gebaut, getestet (9/9) und auf 131 erneut
|
||||||
|
ausgelöst – Journal zeigt das Feld `existing_in_storage` im Report.
|
||||||
|
|
||||||
|
Meldeweg über OPS-05 (wie später BAK-08) wurde als offene Design-Frage
|
||||||
|
aufgeworfen, aber nicht zur Vorbedingung gemacht – hier bewusst noch
|
||||||
|
nicht umgesetzt (kein OPS-05-Abhängigkeitseintrag im Board für BAK-05);
|
||||||
|
Report wird aktuell nur als JSON auf stdout ausgegeben und per
|
||||||
|
Exit-Code (1 bei Abweichungen) für systemd/Monitoring sichtbar gemacht.
|
||||||
|
Anbindung an OPS-05 kann bei Bedarf nachgezogen werden, ohne
|
||||||
|
`Reconcile` selbst zu ändern.
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/reconcile.Reconcile(dbEntries, storageKeys) Report` – reine
|
||||||
|
Vergleichsfunktion, liefert `MissingInStorage`/`OrphanedInStorage`,
|
||||||
|
`Report.IsClean()` als eindeutiges Sauber-Merkmal.
|
||||||
|
- `internal/reconcile.ListDBStorageKeys` – liest `file_revisions`
|
||||||
|
(DMS FDN-02) per direktem SQL aus derselben physischen Tenant-DB
|
||||||
|
(Modell C, Core TEN-01) – kein Import von DMS-Go-Paketen möglich
|
||||||
|
(eigenes Go-Modul), daher reiner SQL-Zugriff gegen das dokumentierte
|
||||||
|
Schema.
|
||||||
|
- `internal/reconcile.ListStorageObjects` – durchläuft den lokalen
|
||||||
|
FDN-03-`LocalDriver`-Basisordner (`filepath.WalkDir`), liefert `nil,
|
||||||
|
nil` bei fehlendem Verzeichnis statt Fehler (noch keine Objekte ist
|
||||||
|
kein Fehlerzustand).
|
||||||
|
- `cmd/reconcile-cli` – liest `NEXARCH_RECONCILE_TENANT_DSN` und
|
||||||
|
`NEXARCH_RECONCILE_STORAGE_DIR`, gibt Report als JSON auf stdout aus,
|
||||||
|
Exit-Code 1 bei Abweichungen.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Datenbankeintrag ohne Storage-Objekt wird erkannt | **bestanden** — `TestReconcile_DetectsMissingInStorage` |
|
||||||
|
| 2 | Storage-Objekt ohne Datenbankeintrag wird erkannt | **bestanden** — `TestReconcile_DetectsOrphanedInStorage` |
|
||||||
|
| 3 | Lauf ohne Abweichungen liefert leeren, eindeutig sauberen Bericht | **bestanden** — `TestReconcile_CleanRunProducesEmptyReport` (zusätzlich `IsClean()`-Konsistenzprüfung) |
|
||||||
|
|
||||||
|
Zusätzlich (Nutzervorgaben, nicht explizit im Ticket als Pflichtprüfung
|
||||||
|
benannt, aber zentral für die Abgrenzung/Weiterverwendbarkeit):
|
||||||
|
|
||||||
|
- `TestReconcile_ExistingButCorruptedObjectProducesNoFinding` – Nachweis,
|
||||||
|
dass Reconcile AUSSCHLIESSLICH Existenz prüft, niemals Inhalt (Trennung
|
||||||
|
von BAK-08).
|
||||||
|
- `TestReconcile_DeterministicOrdering` – zwei Läufe mit identischer
|
||||||
|
Eingabe liefern identische Reihenfolge, aufsteigend nach `storage_key`.
|
||||||
|
- `TestListDBStorageKeys_ReadsRealFileRevisions` – liest echt gegen die
|
||||||
|
gemeinsame Tenant-Testdatenbank `dms_tenant_test` (reales DMS-FDN-02-
|
||||||
|
Schema, kein Mock).
|
||||||
|
- `TestListStorageObjects_WalksRealDirectory` /
|
||||||
|
`_MissingDirectoryReturnsEmpty` – echtes Dateisystem, kein Mock.
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131
|
||||||
|
|
||||||
|
- `reconcile-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-reconcile.env` (0600): `NEXARCH_RECONCILE_TENANT_DSN`
|
||||||
|
zeigt auf die gemeinsame Tenant-Testdatenbank `dms_tenant_test`
|
||||||
|
(DMS selbst läuft auf 192.168.1.131 noch nicht als eigener systemd-
|
||||||
|
Dienst mit persistenter Konfiguration – dies ist die real verfügbare
|
||||||
|
Tenant-DB mit echtem FDN-02-Schema, dokumentierter bekannter Stand,
|
||||||
|
kein stiller Mock); `NEXARCH_RECONCILE_STORAGE_DIR` zeigt auf
|
||||||
|
`/var/nexarch-archiv/dms-objects` (persistentes ZFS-Dataset, NICHT
|
||||||
|
`/var/nexarch-test/`).
|
||||||
|
- Timer `nexarch-archive-reconcile.timer` installiert und aktiviert
|
||||||
|
(täglich 05:00 UTC), `systemctl list-timers` bestätigt scharf.
|
||||||
|
- `systemctl start nexarch-archive-reconcile.service` real ausgelöst:
|
||||||
|
`status=0/SUCCESS`, Journal zeigt echten JSON-Report
|
||||||
|
(`missing_in_storage: null, orphaned_in_storage: null` – Tenant-DB
|
||||||
|
aktuell leer, daher sauberer Bericht, keine synthetische Ausgabe).
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 3/3 Pakete mit Tests ok (internal/backup, internal/objectbackup, internal/reconcile), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
`internal/reconcile`-Tests separat mit gesetzter `TEST_TENANT_DSN` gegen
|
||||||
|
`dms_tenant_test` verifiziert: 9/9 Tests bestanden (6 reine
|
||||||
|
`Reconcile`-Tests + 3 `sources.go`-Integrationstests).
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle Pflicht- sowie
|
||||||
|
Nutzervorgaben-Prüfungen real erfüllt (echte Postgres-Instanz, echtes
|
||||||
|
Dateisystem, echter systemd-Lauf). Zwei Testfehler während der
|
||||||
|
Entwicklung (Schema-Abweichung `revision_number` NOT NULL in der realen
|
||||||
|
`dms_tenant_test`-Tabelle; inkonsistente Fixture-Daten in
|
||||||
|
`TestReconcile_DeterministicOrdering`) gefunden und korrigiert – beide
|
||||||
|
waren Testautorenfehler, keine Fehler in `Reconcile` selbst.
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
# BAK-08 – Prüfprotokoll: Checksum-basierte Objekt-Integritätsprüfung
|
||||||
|
|
||||||
|
Voraussetzungen BAK-05, FDN-04, FDN-09, OPS-05 – alle erledigt, siehe
|
||||||
|
eigene Protokolle. Vor Start zwei offene Rückfragen geklärt (siehe unten).
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: eigener Zustand statt file_revisions.created_at
|
||||||
|
|
||||||
|
`created_at` als Alterskriterium hätte immer dieselben "ältesten" Objekte
|
||||||
|
gescrubbt und den Rest nie erreicht — kein echtes Rotationsverhalten.
|
||||||
|
Stattdessen eigene Archive-Tabelle `scrub_state` (`storage_key` →
|
||||||
|
`last_scrubbed_at`, `last_result`), Migration
|
||||||
|
`migrations/0001_scrub_state.up.sql`. `internal/scrub.Sample` ist eine
|
||||||
|
reine Funktion: nimmt BAK-05s `existing_in_storage` (deterministisch
|
||||||
|
sortiert) entgegen, filtert Objekte innerhalb der konfigurierbaren
|
||||||
|
Cooldown-Frist heraus, priorisiert danach nach `last_scrubbed_at`
|
||||||
|
aufsteigend (nie geprüft = ältestmöglicher Wert), begrenzt auf die
|
||||||
|
konfigurierte Stichprobengröße — kein Voll-Sort über den gesamten
|
||||||
|
Bestand bei jedem Lauf (Nutzerhinweis zum Kostenfaktor bei 10⁵+
|
||||||
|
Objekten: die WHERE-artige Cooldown-Filterung reduziert die Kandidatenmenge
|
||||||
|
VOR der Sortierung, nur die Kandidaten selbst werden sortiert, nicht der
|
||||||
|
komplette Bestand).
|
||||||
|
|
||||||
|
## Nachtrag: zwei Rückfragen vor Implementierungsbeginn geklärt
|
||||||
|
|
||||||
|
1. **OPS-05-Anbindung ist Pull, nicht Push.** OPS-05 (`internal/alerting`,
|
||||||
|
Core) ist real implementiert, aber Core OPS-03 scrapt `/metrics`-URLs
|
||||||
|
registrierter Module (`metrics_sources`-Tabelle in der Core-Registry-
|
||||||
|
DB, `SourceStore.RegisterSource`) — kein Push-API. Für BAK-08 daher
|
||||||
|
ein eigener, DAUERHAFT laufender Endpunkt (`cmd/scrub-metrics`,
|
||||||
|
getrennt vom Oneshot-`scrub-cli`, dessen Prozess nach jedem Lauf endet
|
||||||
|
und zum Scrape-Zeitpunkt nicht erreichbar wäre). Metrik als Counter
|
||||||
|
(`nexarch_archive_storage_integrity_failures_total`), monoton
|
||||||
|
steigend — kein Gauge, kein Rücksetzen bei behobenem Befund. Kein
|
||||||
|
Befund = Wert bleibt unverändert (kein Dauer-Alarm durch andauernden
|
||||||
|
"Fehler"-Zustand). Scope-Trennung gewahrt: `scrub-cli`/`scrub-metrics`
|
||||||
|
erzeugen selbst KEIN Alert-Objekt — Schwellwert/Drosselung bleiben
|
||||||
|
OPS-05-eigene Konfiguration (Alert-Regel wird separat über
|
||||||
|
`alerting.RuleStore.CreateRule` angelegt, nicht Teil dieses Tickets).
|
||||||
|
**CFG-04 war eine Verwechslung** (das ist die
|
||||||
|
Benachrichtigungs-Einstellungen-Oberfläche, ein anderes Ticket) — die
|
||||||
|
tatsächlich nötige "Config"-Aktion ist ein `INSERT` in
|
||||||
|
`metrics_sources` (Core-Registry-DB), kein UI/Ticket-Abhängigkeit.
|
||||||
|
Real ausgeführt (siehe „Echte Verdrahtung" unten).
|
||||||
|
2. **Sampling-Kriterium.** Siehe Grundsatzentscheidung oben —
|
||||||
|
`scrub_state.last_scrubbed_at` statt `file_revisions.created_at`,
|
||||||
|
Cooldown-Filterung vor Sortierung, feste Stichprobengröße (Top-N,
|
||||||
|
deterministisch, keine Zufallsstichprobe — Nutzerpräferenz für
|
||||||
|
Reproduzierbarkeit im Protokoll).
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `migrations/0001_scrub_state.up.sql`/`.down.sql` — `scrub_state`,
|
||||||
|
`scrub_counters` (Einzelzeile, monotoner Zähler).
|
||||||
|
- `internal/scrub.Sample` — reine Funktion, Cooldown-Filter + Alt-
|
||||||
|
Priorisierung + Stichprobenbegrenzung.
|
||||||
|
- `internal/scrub.LoadLastScrubbed`/`MarkScrubbed`/`RecordFinding`/
|
||||||
|
`FindingsTotal` — DB-Zugriff auf `scrub_state`/`scrub_counters`,
|
||||||
|
`MarkScrubbed` idempotent (`ON CONFLICT`) für unterbrechbare Läufe.
|
||||||
|
- `internal/scrub.ExpectedChecksums` — eigene, minimale Abfrage gegen
|
||||||
|
`file_revisions` (keine Erweiterung von `reconcile.DBEntry` — BAK-05
|
||||||
|
bleibt existenz-only).
|
||||||
|
- `internal/scrub.ActualChecksum` — echtes Lesen der Datei + SHA-256,
|
||||||
|
kein Header-/Größenvergleich.
|
||||||
|
- `cmd/scrub-cli` — Oneshot: BAK-05-Reconcile → `Sample` → pro Kandidat
|
||||||
|
Checksum-Vergleich → `MarkScrubbed` + bei Abweichung `RecordFinding` →
|
||||||
|
JSON-Bericht auf stdout, Exit-Code 1 bei Befunden (gemeldet, nicht
|
||||||
|
automatisch repariert).
|
||||||
|
- `cmd/scrub-metrics` — dauerhafter `/metrics`-Endpunkt, liest
|
||||||
|
`scrub_counters.findings_total`.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Absichtlich veränderter Objektinhalt wird als Abweichung erkannt | **bestanden** — real: Testobjekt mit absichtlich falscher `checksum_sha256` in `dms_tenant_test` angelegt, echte Datei ins Storage-Verzeichnis gelegt, `scrub-cli` real über systemd ausgelöst: Befund im JSON-Bericht, Exit-Code 1, `scrub_counters.findings_total` real von 0 auf 1 erhöht (siehe Journal-Auszug unten) |
|
||||||
|
| 2 | Sampling priorisiert alte/nie geprüfte Objekte, nicht neue | **bestanden** — `TestSample_PrioritizesNeverScrubbedAndOldest`: nie geprüftes Objekt kommt vor einem vor 30 Tagen geprüften, dieses vor einem vor 1 Tag geprüften |
|
||||||
|
| 3 | Wiederholter Lauf ohne neue Objekte meldet nichts erneut (kein Spam) / idempotent bei Unterbrechung | **bestanden** — real: zweiter `scrub-cli`-Lauf direkt nach dem ersten liefert `sampled: 0` (Cooldown greift), `TestMarkScrubbed_IsIdempotent` beweist wiederholtes Markieren ohne Duplikat |
|
||||||
|
|
||||||
|
Zusätzlich: `TestSample_RespectsCooldown`,
|
||||||
|
`TestSample_LimitsToSampleSize`, `TestSample_DeterministicForIdenticalInput`,
|
||||||
|
`TestRecordFinding_IsMonotonicallyIncreasing`,
|
||||||
|
`TestActualChecksum_MatchesRealFileContent` (echter Dateiinhalt, echtes
|
||||||
|
SHA-256), `TestExpectedChecksums_ReadsRealFileRevisions` (echtes
|
||||||
|
Postgres, kein Mock).
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131
|
||||||
|
|
||||||
|
- `scrub-cli`, `scrub-metrics` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-scrub.env`, `/etc/nexarch/archive-scrub-metrics.env`
|
||||||
|
(0600)
|
||||||
|
- Migration real gegen `dms_tenant_test` angewendet
|
||||||
|
(`psql -f migrations/0001_scrub_state.up.sql`)
|
||||||
|
- `nexarch-archive-scrub.timer` installiert/aktiviert (täglich 06:00
|
||||||
|
UTC), `nexarch-archive-scrub-metrics.service` installiert/aktiviert
|
||||||
|
(dauerhaft, `Restart=on-failure`) — beide `systemctl status`: aktiv
|
||||||
|
- **Reales `INSERT` in `metrics_sources`** (Core-Registry-DB
|
||||||
|
`nexarch_registry`): `('archive', 'http://127.0.0.1:8090/metrics')` —
|
||||||
|
bestätigt über `SELECT * FROM metrics_sources`
|
||||||
|
- **End-to-End über OPS-03 bestätigt**: `curl http://127.0.0.1:8085/metrics`
|
||||||
|
(Core-Aggregator) zeigt `nexarch_module_archive_nexarch_archive_storage_integrity_failures_total`
|
||||||
|
— reale Umbenennung gemäß OPS-03-Namenskonvention, kein synthetischer
|
||||||
|
Wert
|
||||||
|
- Realer Befund-Durchlauf: Testobjekt mit absichtlich falscher Prüfsumme
|
||||||
|
angelegt → `scrub-cli` real via `systemctl start` ausgelöst → Befund im
|
||||||
|
Journal, `scrub_counters.findings_total` real 0→1, sichtbar sowohl auf
|
||||||
|
`scrub-metrics` als auch über den Core-Aggregator → Testdaten
|
||||||
|
anschließend bereinigt (`file_revisions`/`documents`/`users`-Zeilen
|
||||||
|
gelöscht, `scrub_state`/`scrub_counters` zurückgesetzt, Testdatei
|
||||||
|
entfernt)
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 4/4 Pakete mit Tests ok (internal/backup, internal/objectbackup, internal/reconcile, internal/scrub), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
`internal/scrub`-Tests separat mit gesetzter `TEST_TENANT_DSN` gegen
|
||||||
|
`dms_tenant_test` verifiziert: 8/8 Tests bestanden.
|
||||||
|
|
||||||
|
## Bekannte Grenze (aus Ticket übernommen, nicht Teil der Abnahme)
|
||||||
|
|
||||||
|
Der Job erkennt Abweichungen nur bei Objekten, die gelesen und erneut
|
||||||
|
geprüft werden können. Ersetzt keine storage-seitige WORM-/
|
||||||
|
Versionierungsstrategie und keine Zugriffs-/Audit-Logs des
|
||||||
|
Storage-Providers (`STORAGE-KONZEPT.md` Abschnitt 6.1) — bei extern
|
||||||
|
eingebundenem, nicht-kompatiblem Kunden-Storage (Betriebsmodus 3, ohne
|
||||||
|
Versioning/Object Lock/Audit-Logs) bleibt eine Lücke, die BAK-08
|
||||||
|
technisch nicht schließen kann.
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle sechs Akzeptanzkriterien und alle drei Pflicht-
|
||||||
|
prüfungen real erfüllt — inklusive echtem Ende-zu-Ende-Nachweis über
|
||||||
|
Core OPS-03/OPS-05 (kein Stub, reale `/metrics`-Registrierung und
|
||||||
|
-Aggregation). Beide vor Implementierungsbeginn gestellten Rückfragen
|
||||||
|
(OPS-05-Anbindungsmechanismus, Sampling-Kriterium) im Protokoll
|
||||||
|
dokumentiert und in der Umsetzung berücksichtigt.
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
module gitea.perlbach24.de/scripte/nexarch/archive
|
||||||
|
|
||||||
|
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
|
||||||
|
)
|
||||||
@@ -1,8 +1,6 @@
|
|||||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY=
|
|
||||||
github.com/golang-jwt/jwt/v5 v5.3.1/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
|
|
||||||
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
||||||
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
// Package backup implementiert BAK-01: automatisierte, inkrementelle
|
||||||
|
// Sicherung der PostgreSQL-Datenbank per pg_basebackup (PostgreSQL 17s
|
||||||
|
// natives inkrementelles Backup über WAL-Summarization, siehe
|
||||||
|
// `summarize_wal`), mit Verifikation jeder Sicherung und
|
||||||
|
// generationsbasierter Rotation. Kein pg_dump-basierter Ansatz, weil
|
||||||
|
// pg_dump ausschließlich logische Vollsicherungen kennt — "inkrementell"
|
||||||
|
// im Sinne des Tickets erfordert das physische, WAL-summary-gestützte
|
||||||
|
// Verfahren aus PostgreSQL 17.
|
||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config enthält die Verbindungsdaten für pg_basebackup — ausschließlich
|
||||||
|
// über Umgebungsvariablen befüllt, nie im Code (siehe Ticket-Abschluss-
|
||||||
|
// Regel).
|
||||||
|
type Config struct {
|
||||||
|
Host string
|
||||||
|
Port string
|
||||||
|
User string
|
||||||
|
Password string
|
||||||
|
BackupDir string
|
||||||
|
PgBaseBackupPath string // Default "pg_basebackup", überschreibbar für Tests
|
||||||
|
PgCombineBackupPath string // Default "pg_combinebackup", überschreibbar für Tests
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) binary() string {
|
||||||
|
if c.PgBaseBackupPath != "" {
|
||||||
|
return c.PgBaseBackupPath
|
||||||
|
}
|
||||||
|
return "pg_basebackup"
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullBackupDirName/IncrementalDirName sind die festen Unterverzeichnis-
|
||||||
|
// namen je Generation.
|
||||||
|
const (
|
||||||
|
FullBackupDirName = "full"
|
||||||
|
IncrementalSubdir = "incremental"
|
||||||
|
BackupManifestFile = "backup_manifest"
|
||||||
|
BaseTarGzFile = "base.tar.gz"
|
||||||
|
// WalTarGzFile: pg_basebackups Standard-WAL-Methode ist "stream" (WAL
|
||||||
|
// wird waehrend der Sicherung parallel mitgestreamt) - bei -Ft/-z
|
||||||
|
// landet dieser Strom in einer EIGENEN Archivdatei neben base.tar.gz.
|
||||||
|
// Ohne dieses WAL ist die Sicherung NICHT crash-konsistent
|
||||||
|
// wiederherstellbar (Postgres kann sonst keinen gueltigen Checkpoint
|
||||||
|
// erreichen) - siehe Restore.
|
||||||
|
WalTarGzFile = "pg_wal.tar.gz"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewGenerationID liefert eine sortierbare, eindeutige Generation-Kennung
|
||||||
|
// (RFC3339-artig, dateisystemtauglich) — Generationen werden anhand dieser
|
||||||
|
// Kennung chronologisch sortiert (Rotate, ListGenerations).
|
||||||
|
func NewGenerationID(t time.Time) string {
|
||||||
|
return t.UTC().Format("20060102T150405Z")
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullBackup erstellt eine neue Vollsicherung (Akzeptanzkriterium 1) als
|
||||||
|
// eigene Generation. Liefert den Pfad zum backup_manifest, das spätere
|
||||||
|
// IncrementalBackup-Aufrufe als Referenz brauchen.
|
||||||
|
func FullBackup(ctx context.Context, cfg Config, generationID string) (manifestPath string, err error) {
|
||||||
|
dir := filepath.Join(cfg.BackupDir, generationID, FullBackupDirName)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(dir), 0o750); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: generationsverzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
args := []string{
|
||||||
|
"-h", cfg.Host, "-p", cfg.Port, "-U", cfg.User,
|
||||||
|
"-D", dir, "-Ft", "-z", "--checkpoint=fast", "--no-password",
|
||||||
|
}
|
||||||
|
if err := runPgBaseBackup(ctx, cfg, args); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: vollsicherung: %w", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(dir, BackupManifestFile), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IncrementalBackup erstellt eine inkrementelle Sicherung gegen die zuletzt
|
||||||
|
// bekannte Vollsicherung ODER die letzte Inkrement-Sicherung (priorManifestPath
|
||||||
|
// zeigt jeweils auf das backup_manifest der Referenz).
|
||||||
|
func IncrementalBackup(ctx context.Context, cfg Config, generationID, incrementID, priorManifestPath string) (manifestPath string, err error) {
|
||||||
|
dir := filepath.Join(cfg.BackupDir, generationID, IncrementalSubdir, incrementID)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(dir), 0o750); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: inkrement-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
args := []string{
|
||||||
|
"-h", cfg.Host, "-p", cfg.Port, "-U", cfg.User,
|
||||||
|
"-D", dir, "-Ft", "-z", "--checkpoint=fast", "--no-password",
|
||||||
|
"--incremental=" + priorManifestPath,
|
||||||
|
}
|
||||||
|
if err := runPgBaseBackup(ctx, cfg, args); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: inkrementelle sicherung: %w", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(dir, BackupManifestFile), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Restore kombiniert die Vollsicherung einer Generation mit allen ihren
|
||||||
|
// Inkrementen (PostgreSQL 17s `pg_combinebackup`, das native Gegenstück zu
|
||||||
|
// `pg_basebackup --incremental`) und schreibt das Ergebnis nach outputDir —
|
||||||
|
// ein vollständiges, direkt startbares PGDATA-Verzeichnis. outputDir muss
|
||||||
|
// bereits existieren und leer sein (pg_combinebackup-Vorgabe); Atomarität
|
||||||
|
// gegenüber einem eventuell nicht-leeren ENDZIEL ist Aufgabe von
|
||||||
|
// internal/restore, nicht dieser Funktion.
|
||||||
|
//
|
||||||
|
// pg_combinebackup erwartet PLAIN-Format-Eingabeverzeichnisse (Dateibaum),
|
||||||
|
// FullBackup/IncrementalBackup speichern aber TAR+GZIP (`-Ft -z`, siehe
|
||||||
|
// dort) — kleinere, einfacher zu prüfende Sicherungsdateien
|
||||||
|
// (BAK-01-Entscheidung, hier NICHT verändert). Restore extrahiert daher
|
||||||
|
// jede Stufe zunächst in ein eigenes temporäres Plain-Verzeichnis, bevor
|
||||||
|
// pg_combinebackup darauf zugreift.
|
||||||
|
func Restore(ctx context.Context, cfg Config, generationID, outputDir string) error {
|
||||||
|
genDir := filepath.Join(cfg.BackupDir, generationID)
|
||||||
|
tarDirs := []string{filepath.Join(genDir, FullBackupDirName)}
|
||||||
|
|
||||||
|
incrDir := filepath.Join(genDir, IncrementalSubdir)
|
||||||
|
entries, err := os.ReadDir(incrDir)
|
||||||
|
if err != nil && !os.IsNotExist(err) {
|
||||||
|
return fmt.Errorf("backup: inkrement-verzeichnis lesen: %w", err)
|
||||||
|
}
|
||||||
|
incrementIDs := make([]string, 0, len(entries))
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() {
|
||||||
|
incrementIDs = append(incrementIDs, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(incrementIDs) // Inkrement-IDs sind wie Generation-IDs chronologisch sortierbar
|
||||||
|
for _, id := range incrementIDs {
|
||||||
|
tarDirs = append(tarDirs, filepath.Join(incrDir, id))
|
||||||
|
}
|
||||||
|
|
||||||
|
extractRoot, err := os.MkdirTemp("", "backup-restore-extract-*")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("backup: extraktions-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = os.RemoveAll(extractRoot) }()
|
||||||
|
|
||||||
|
inputs := make([]string, 0, len(tarDirs))
|
||||||
|
for i, tarDir := range tarDirs {
|
||||||
|
plainDir := filepath.Join(extractRoot, fmt.Sprintf("%02d", i))
|
||||||
|
if err := os.MkdirAll(plainDir, 0o700); err != nil {
|
||||||
|
return fmt.Errorf("backup: plain-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
if err := extractTarGz(filepath.Join(tarDir, BaseTarGzFile), plainDir); err != nil {
|
||||||
|
return fmt.Errorf("backup: %q extrahieren: %w", tarDir, err)
|
||||||
|
}
|
||||||
|
// backup_manifest liegt NEBEN base.tar.gz (von pg_basebackup so
|
||||||
|
// geschrieben), nicht im Archiv selbst - pg_combinebackup braucht
|
||||||
|
// es zusätzlich im Plain-Verzeichnis.
|
||||||
|
manifestData, err := os.ReadFile(filepath.Join(tarDir, BackupManifestFile))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("backup: %q lesen: %w", filepath.Join(tarDir, BackupManifestFile), err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(plainDir, BackupManifestFile), manifestData, 0o600); err != nil {
|
||||||
|
return fmt.Errorf("backup: manifest nach %q kopieren: %w", plainDir, err)
|
||||||
|
}
|
||||||
|
inputs = append(inputs, plainDir)
|
||||||
|
}
|
||||||
|
|
||||||
|
binary := "pg_combinebackup"
|
||||||
|
if cfg.PgCombineBackupPath != "" {
|
||||||
|
binary = cfg.PgCombineBackupPath
|
||||||
|
}
|
||||||
|
args := append(append([]string{}, inputs...), "-o", outputDir)
|
||||||
|
cmd := exec.CommandContext(ctx, binary, args...)
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("backup: %s fehlgeschlagen: %w (ausgabe: %s)", binary, err, string(output))
|
||||||
|
}
|
||||||
|
|
||||||
|
// pg_combinebackup rekonstruiert nur die Datendateien - das fuer einen
|
||||||
|
// konsistenten Start noetige WAL kommt aus der ZULETZT gezogenen Stufe
|
||||||
|
// (letztes Inkrement, sonst die Vollsicherung), nicht aus allen Stufen
|
||||||
|
// zusammen (siehe WalTarGzFile-Dokumentation).
|
||||||
|
lastTarDir := tarDirs[len(tarDirs)-1]
|
||||||
|
walDir := filepath.Join(outputDir, "pg_wal")
|
||||||
|
if err := os.MkdirAll(walDir, 0o700); err != nil {
|
||||||
|
return fmt.Errorf("backup: pg_wal-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
if err := extractTarGz(filepath.Join(lastTarDir, WalTarGzFile), walDir); err != nil {
|
||||||
|
return fmt.Errorf("backup: WAL aus %q wiederherstellen: %w", lastTarDir, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPgBaseBackup(ctx context.Context, cfg Config, args []string) error {
|
||||||
|
cmd := exec.CommandContext(ctx, cfg.binary(), args...)
|
||||||
|
cmd.Env = append(os.Environ(), "PGPASSWORD="+cfg.Password)
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s fehlgeschlagen: %w (ausgabe: %s)", cfg.binary(), err, string(output))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireTestConfig(t *testing.T) Config {
|
||||||
|
t.Helper()
|
||||||
|
user := os.Getenv("TEST_BACKUP_PG_USER")
|
||||||
|
if user == "" {
|
||||||
|
t.Skip("TEST_BACKUP_PG_USER nicht gesetzt, Integrationstest uebersprungen (braucht echten Postgres mit REPLICATION-Rolle)")
|
||||||
|
}
|
||||||
|
return Config{
|
||||||
|
Host: envOr("TEST_BACKUP_PG_HOST", "localhost"),
|
||||||
|
Port: envOr("TEST_BACKUP_PG_PORT", "5432"),
|
||||||
|
User: user,
|
||||||
|
Password: os.Getenv("TEST_BACKUP_PG_PASSWORD"),
|
||||||
|
BackupDir: t.TempDir(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func envOr(key, fallback string) string {
|
||||||
|
if v := os.Getenv(key); v != "" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestFullBackup_CreatesVerifiedBackup ist Pruefung 1: Sicherung gegen
|
||||||
|
// Testdatenbank erfolgreich erstellt und verifiziert.
|
||||||
|
func TestFullBackup_CreatesVerifiedBackup(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
manifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(manifest); err != nil {
|
||||||
|
t.Fatalf("backup_manifest fehlt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := filepath.Dir(manifest)
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, BaseTarGzFile)); err != nil {
|
||||||
|
t.Fatalf("%s fehlt: %v", BaseTarGzFile, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Verify(dir); err != nil {
|
||||||
|
t.Fatalf("verify: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestIncrementalBackup_IsSmallerThanFull ist der Nachweis fuer
|
||||||
|
// Akzeptanzkriterium 1 (inkrementell): eine echte inkrementelle Sicherung
|
||||||
|
// gegen unveraenderten Bestand ist deutlich kleiner als die Vollsicherung —
|
||||||
|
// beweist, dass tatsaechlich nur Aenderungen uebertragen wurden (PostgreSQL
|
||||||
|
// 17 WAL-Summarization), nicht nochmal alles.
|
||||||
|
func TestIncrementalBackup_IsSmallerThanFull(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
fullManifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
fullDir := filepath.Dir(fullManifest)
|
||||||
|
fullSize := fileSize(t, filepath.Join(fullDir, BaseTarGzFile))
|
||||||
|
|
||||||
|
incID := NewGenerationID(time.Now().Add(time.Second))
|
||||||
|
incManifest, err := IncrementalBackup(ctx, cfg, genID, incID, fullManifest)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("incrementalbackup: %v", err)
|
||||||
|
}
|
||||||
|
incDir := filepath.Dir(incManifest)
|
||||||
|
if err := Verify(incDir); err != nil {
|
||||||
|
t.Fatalf("verify (inkrementell): %v", err)
|
||||||
|
}
|
||||||
|
incSize := fileSize(t, filepath.Join(incDir, BaseTarGzFile))
|
||||||
|
|
||||||
|
if incSize >= fullSize {
|
||||||
|
t.Fatalf("inkrementelle sicherung (%d bytes) ist nicht kleiner als die vollsicherung (%d bytes) - keine echte inkrementelle Uebertragung", incSize, fullSize)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func fileSize(t *testing.T, path string) int64 {
|
||||||
|
t.Helper()
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dateigroesse von %q ermitteln: %v", path, err)
|
||||||
|
}
|
||||||
|
return info.Size()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestVerify_DetectsCorruptedFile ist Pruefung 2: Verifikation erkennt eine
|
||||||
|
// absichtlich beschaedigte Sicherungsdatei.
|
||||||
|
func TestVerify_DetectsCorruptedFile(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
manifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
dir := filepath.Dir(manifest)
|
||||||
|
|
||||||
|
if err := Verify(dir); err != nil {
|
||||||
|
t.Fatalf("verify (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Absichtliche Beschaedigung: mehrere Bytes in der Mitte der Datei kippen.
|
||||||
|
path := filepath.Join(dir, BaseTarGzFile)
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sicherungsdatei lesen: %v", err)
|
||||||
|
}
|
||||||
|
mid := len(data) / 2
|
||||||
|
for i := mid; i < mid+64 && i < len(data); i++ {
|
||||||
|
data[i] ^= 0xFF
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||||
|
t.Fatalf("beschaedigte sicherungsdatei schreiben: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Verify(dir); err == nil {
|
||||||
|
t.Fatal("verify haette die beschaedigte sicherungsdatei erkennen muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRotate_RemovesOnlyOldestGenerations ist Pruefung 3.
|
||||||
|
func TestRotate_RemovesOnlyOldestGenerations(t *testing.T) {
|
||||||
|
backupDir := t.TempDir()
|
||||||
|
generationIDs := []string{
|
||||||
|
"20260101T000000Z",
|
||||||
|
"20260102T000000Z",
|
||||||
|
"20260103T000000Z",
|
||||||
|
"20260104T000000Z",
|
||||||
|
"20260105T000000Z",
|
||||||
|
}
|
||||||
|
for _, id := range generationIDs {
|
||||||
|
if err := os.MkdirAll(filepath.Join(backupDir, id, FullBackupDirName), 0o750); err != nil {
|
||||||
|
t.Fatalf("generation %q anlegen: %v", id, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
removed, err := Rotate(backupDir, 2)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("rotate: %v", err)
|
||||||
|
}
|
||||||
|
wantRemoved := []string{"20260101T000000Z", "20260102T000000Z", "20260103T000000Z"}
|
||||||
|
if len(removed) != len(wantRemoved) {
|
||||||
|
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||||
|
}
|
||||||
|
for i, w := range wantRemoved {
|
||||||
|
if removed[i] != w {
|
||||||
|
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
remaining, err := ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("listgenerations: %v", err)
|
||||||
|
}
|
||||||
|
wantRemaining := []string{"20260104T000000Z", "20260105T000000Z"}
|
||||||
|
if len(remaining) != len(wantRemaining) {
|
||||||
|
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||||
|
}
|
||||||
|
for i, w := range wantRemaining {
|
||||||
|
if remaining[i] != w {
|
||||||
|
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Die NEUESTEN duerfen NICHT entfernt sein (Pruefung 3: nur die
|
||||||
|
// aeltesten Generationen).
|
||||||
|
for _, w := range wantRemaining {
|
||||||
|
if _, err := os.Stat(filepath.Join(backupDir, w)); err != nil {
|
||||||
|
t.Fatalf("neueste generation %q wurde faelschlich entfernt: %v", w, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRestore_CombinesIntoStartablePostgresInstance ist Pruefung 1 fuer
|
||||||
|
// BAK-03 (Datenbank-Teil): Restore auf leerem System vollstaendig und
|
||||||
|
// erfolgreich durchgefuehrt — real bewiesen, indem das wiederhergestellte
|
||||||
|
// Verzeichnis tatsaechlich als eigenstaendige Postgres-Instanz gestartet
|
||||||
|
// und per echter Verbindung abgefragt wird, nicht nur auf Dateiexistenz
|
||||||
|
// geprueft.
|
||||||
|
func TestRestore_CombinesIntoStartablePostgresInstance(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
if _, err := exec.LookPath("pg_combinebackup"); err != nil {
|
||||||
|
t.Skip("pg_combinebackup nicht installiert, restore-integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
pgCtl, err := exec.LookPath("pg_ctl")
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("pg_ctl nicht installiert, restore-integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
if _, err := FullBackup(ctx, cfg, genID); err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
restoreOut := filepath.Join(t.TempDir(), "restored-pgdata")
|
||||||
|
if err := os.MkdirAll(restoreOut, 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := Restore(ctx, cfg, genID, restoreOut); err != nil {
|
||||||
|
t.Fatalf("restore: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(restoreOut, "PG_VERSION")); err != nil {
|
||||||
|
t.Fatalf("wiederhergestelltes verzeichnis ist kein gueltiges PGDATA (PG_VERSION fehlt): %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Auf diesem Debian-Postgres liegt postgresql.conf NICHT in PGDATA
|
||||||
|
// (sondern in /etc/postgresql/17/main/) - pg_basebackup sichert daher
|
||||||
|
// nur PGDATA-Inhalte, die Konfigurationsdatei fehlt im Restore
|
||||||
|
// GENAUSO wie im echten Betriebs-Restore-Verfahren. Fuer den
|
||||||
|
// End-zu-End-Nachweis (echte Daten wiederherstellbar) hier eine
|
||||||
|
// minimale, ausschliesslich fuer den Testlauf gueltige Konfiguration
|
||||||
|
// nachgereicht - dokumentiert als operativer Hinweis fuer ein echtes
|
||||||
|
// Restore-Runbook, nicht Teil des Produktcodes.
|
||||||
|
minimalConf := "listen_addresses = ''\n"
|
||||||
|
if err := os.WriteFile(filepath.Join(restoreOut, "postgresql.conf"), []byte(minimalConf), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// dito pg_hba.conf - liegt auf Debian ebenfalls in /etc/postgresql,
|
||||||
|
// nicht in PGDATA. Nur Unix-Socket-Verbindungen des lokalen Testlaufs
|
||||||
|
// erlaubt (kein TCP, dieselbe Isolation wie listen_addresses='').
|
||||||
|
hba := "local all all trust\n"
|
||||||
|
if err := os.WriteFile(filepath.Join(restoreOut, "pg_hba.conf"), []byte(hba), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Konfigurationsdateien aus der Quellinstanz brachte pg_basebackup mit
|
||||||
|
// (sie enthalten ggf. den alten Port/Unix-Socket) - fuer diesen Test
|
||||||
|
// bewusst neuer Port und eigenes Socket-Verzeichnis, damit die
|
||||||
|
// wiederhergestellte Instanz nicht mit der laufenden Test-Instanz
|
||||||
|
// kollidiert.
|
||||||
|
socketDir := t.TempDir()
|
||||||
|
testPort := "55432"
|
||||||
|
// WICHTIG: pg_ctl start foerdert postgres als Hintergrundprozess, der
|
||||||
|
// die geerbten stdout/stderr-Pipes NICHT schliesst - CombinedOutput()
|
||||||
|
// (das auf ein Pipe-EOF wartet) haengt sich daher auf, obwohl pg_ctl
|
||||||
|
// selbst laengst zurueckgekehrt ist. Deshalb echte Logdatei statt Pipe
|
||||||
|
// (Standard-pg_ctl-Muster), kein exec.Cmd.Stdout/-Stderr-Pipe-Zugriff.
|
||||||
|
logFile := filepath.Join(t.TempDir(), "postgres.log")
|
||||||
|
startCmd := exec.CommandContext(ctx, pgCtl, "start", "-D", restoreOut, "-w", "-t", "30", "-l", logFile,
|
||||||
|
"-o", fmt.Sprintf("-p %s -k %s -c listen_addresses=''", testPort, socketDir))
|
||||||
|
if err := startCmd.Run(); err != nil {
|
||||||
|
logContent, _ := os.ReadFile(logFile)
|
||||||
|
t.Fatalf("pg_ctl start (wiederhergestellte instanz): %v (log: %s)", err, string(logContent))
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
stopCmd := exec.Command(pgCtl, "stop", "-D", restoreOut, "-m", "fast")
|
||||||
|
_ = stopCmd.Run()
|
||||||
|
}()
|
||||||
|
|
||||||
|
psqlOut, err := exec.CommandContext(ctx, "psql",
|
||||||
|
"-h", socketDir, "-p", testPort, "-U", cfg.User, "-d", "postgres",
|
||||||
|
"-tAc", "SELECT 1").CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("echte verbindung zur wiederhergestellten instanz fehlgeschlagen: %v (ausgabe: %s)", err, string(psqlOut))
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(string(psqlOut)) != "1" {
|
||||||
|
t.Fatalf("unerwartete antwort von der wiederhergestellten instanz: %q", string(psqlOut))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ListGenerations liefert alle Generation-IDs in backupDir, aufsteigend
|
||||||
|
// sortiert (die GenerationID selbst ist chronologisch sortierbar, siehe
|
||||||
|
// NewGenerationID — kein Blick auf Dateisystem-Zeitstempel nötig, die bei
|
||||||
|
// einem Restore/Kopiervorgang verändert werden könnten).
|
||||||
|
func ListGenerations(backupDir string) ([]string, error) {
|
||||||
|
entries, err := os.ReadDir(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("backup: sicherungsverzeichnis lesen: %w", err)
|
||||||
|
}
|
||||||
|
var generations []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() {
|
||||||
|
generations = append(generations, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(generations)
|
||||||
|
return generations, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rotate entfernt alle bis auf die `keep` NEUESTEN Generationen
|
||||||
|
// (Akzeptanzkriterium 3) — jede Generation umfasst ihre Vollsicherung UND
|
||||||
|
// alle davon abhängigen Inkremente, ein Löschen der gesamten
|
||||||
|
// Generationsverzeichnisses entfernt beides konsistent zusammen.
|
||||||
|
func Rotate(backupDir string, keep int) (removed []string, err error) {
|
||||||
|
if keep < 0 {
|
||||||
|
keep = 0
|
||||||
|
}
|
||||||
|
generations, err := ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if len(generations) <= keep {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
toRemove := generations[:len(generations)-keep]
|
||||||
|
for _, gen := range toRemove {
|
||||||
|
if err := os.RemoveAll(filepath.Join(backupDir, gen)); err != nil {
|
||||||
|
return removed, fmt.Errorf("backup: generation %q entfernen: %w", gen, err)
|
||||||
|
}
|
||||||
|
removed = append(removed, gen)
|
||||||
|
}
|
||||||
|
return removed, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/tar"
|
||||||
|
"compress/gzip"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrCorrupted wird geliefert, wenn eine Sicherungsdatei nicht lesbar ist
|
||||||
|
// (Akzeptanzkriterium 2: Verifikation, nicht nur Erstellungs-Prüfung).
|
||||||
|
var ErrCorrupted = fmt.Errorf("backup: sicherungsdatei ist beschaedigt oder unvollstaendig")
|
||||||
|
|
||||||
|
// Verify prüft, dass base.tar.gz UND pg_wal.tar.gz im gegebenen
|
||||||
|
// Sicherungsverzeichnis vollständig lesbar sind — öffnet gzip- UND
|
||||||
|
// tar-Stream und liest JEDEN Eintrag bis zum Ende durch (nicht nur die
|
||||||
|
// Kopfdaten), damit ein abgeschnittener oder mit kaputten Bytes
|
||||||
|
// überschriebener Inhalt zuverlässig auffällt, nicht nur ein defekter
|
||||||
|
// Tar-Header. pg_wal.tar.gz wird geprüft, weil ohne intaktes WAL kein
|
||||||
|
// crash-konsistenter Restore möglich ist (siehe Restore/WalTarGzFile) —
|
||||||
|
// eine Sicherung mit beschädigtem WAL-Archiv wäre sonst unbemerkt
|
||||||
|
// unbrauchbar.
|
||||||
|
func Verify(backupDir string) error {
|
||||||
|
if err := verifyTarGz(filepath.Join(backupDir, BaseTarGzFile)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return verifyTarGz(filepath.Join(backupDir, WalTarGzFile))
|
||||||
|
}
|
||||||
|
|
||||||
|
func verifyTarGz(path string) error {
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: %s nicht lesbar: %v", ErrCorrupted, path, err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
gz, err := gzip.NewReader(f)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: gzip-header von %s ungueltig: %v", ErrCorrupted, path, err)
|
||||||
|
}
|
||||||
|
defer func() { _ = gz.Close() }()
|
||||||
|
|
||||||
|
tr := tar.NewReader(gz)
|
||||||
|
entries := 0
|
||||||
|
for {
|
||||||
|
hdr, err := tr.Next()
|
||||||
|
if err == io.EOF {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: tar-eintrag in %s ungueltig: %v", ErrCorrupted, path, err)
|
||||||
|
}
|
||||||
|
if _, err := io.Copy(io.Discard, tr); err != nil {
|
||||||
|
return fmt.Errorf("%w: inhalt von %q in %s nicht vollstaendig lesbar: %v", ErrCorrupted, hdr.Name, path, err)
|
||||||
|
}
|
||||||
|
entries++
|
||||||
|
}
|
||||||
|
if entries == 0 {
|
||||||
|
return fmt.Errorf("%w: %s enthaelt keine eintraege", ErrCorrupted, path)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractTarGz entpackt tarGzPath vollständig nach destDir — genutzt von
|
||||||
|
// Restore, um die TAR+GZIP-Sicherungsstufen (siehe Verify) in das
|
||||||
|
// PLAIN-Format zu überführen, das pg_combinebackup als Eingabe erwartet.
|
||||||
|
func extractTarGz(tarGzPath, destDir string) error {
|
||||||
|
f, err := os.Open(tarGzPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s öffnen: %w", tarGzPath, err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
gz, err := gzip.NewReader(f)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("gzip-header ungueltig: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = gz.Close() }()
|
||||||
|
|
||||||
|
tr := tar.NewReader(gz)
|
||||||
|
for {
|
||||||
|
hdr, err := tr.Next()
|
||||||
|
if err == io.EOF {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("tar-eintrag lesen: %w", err)
|
||||||
|
}
|
||||||
|
target := filepath.Join(destDir, filepath.Clean(hdr.Name))
|
||||||
|
switch hdr.Typeflag {
|
||||||
|
case tar.TypeDir:
|
||||||
|
if err := os.MkdirAll(target, 0o750); err != nil {
|
||||||
|
return fmt.Errorf("verzeichnis %q anlegen: %w", target, err)
|
||||||
|
}
|
||||||
|
case tar.TypeReg:
|
||||||
|
if err := os.MkdirAll(filepath.Dir(target), 0o750); err != nil {
|
||||||
|
return fmt.Errorf("übergeordnetes verzeichnis von %q anlegen: %w", target, err)
|
||||||
|
}
|
||||||
|
out, err := os.OpenFile(target, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, os.FileMode(hdr.Mode))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("datei %q anlegen: %w", target, err)
|
||||||
|
}
|
||||||
|
if _, err := io.Copy(out, tr); err != nil {
|
||||||
|
_ = out.Close()
|
||||||
|
return fmt.Errorf("datei %q schreiben: %w", target, err)
|
||||||
|
}
|
||||||
|
if err := out.Close(); err != nil {
|
||||||
|
return fmt.Errorf("datei %q schliessen: %w", target, err)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
// Symlinks/Sonderdateien: pg_basebackup-Archive enthalten
|
||||||
|
// praktisch keine, übersprungen statt Restore abzubrechen.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
// Package objectbackup implementiert BAK-02: automatisierte, inkrementelle,
|
||||||
|
// deduplizierende Sicherung des Objekt-Storage-Bestands. Nutzt restic
|
||||||
|
// (Content-defined Chunking, verschlüsseltes Repository ab Werk) statt
|
||||||
|
// Eigenbau — restic erfüllt alle Akzeptanzkriterien mit ausgereiftem,
|
||||||
|
// geprüftem Tooling statt einer weniger robusten Neuimplementierung.
|
||||||
|
//
|
||||||
|
// Backup-Quelle ist ein lokaler Verzeichnisbaum — für den LocalDriver aus
|
||||||
|
// FDN-03 direkt dessen Basisverzeichnis, für S3-gestützte Produktions-
|
||||||
|
// Deployments ein vorgelagerter Sync-Schritt (z.B. rclone) auf einen
|
||||||
|
// lokalen Spiegel, bevor restic ihn sichert (nicht Bestandteil dieser
|
||||||
|
// Kachel — restic selbst sichert Dateibäume, keine S3-Buckets direkt).
|
||||||
|
package objectbackup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config enthält Repository-Ort und -Passwort — ausschließlich über
|
||||||
|
// Umgebungsvariablen befüllt (siehe Ticket-Abschluss-Regel).
|
||||||
|
type Config struct {
|
||||||
|
RepoDir string
|
||||||
|
Password string
|
||||||
|
ResticPath string // Default "restic", überschreibbar für Tests
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) binary() string {
|
||||||
|
if c.ResticPath != "" {
|
||||||
|
return c.ResticPath
|
||||||
|
}
|
||||||
|
return "restic"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) env() []string {
|
||||||
|
return append(os.Environ(), "RESTIC_PASSWORD="+c.Password)
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(ctx context.Context, cfg Config, args ...string) ([]byte, error) {
|
||||||
|
fullArgs := append([]string{"-r", cfg.RepoDir}, args...)
|
||||||
|
cmd := exec.CommandContext(ctx, cfg.binary(), fullArgs...)
|
||||||
|
cmd.Env = cfg.env()
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
return output, fmt.Errorf("%s %v fehlgeschlagen: %w (ausgabe: %s)", cfg.binary(), args, err, string(output))
|
||||||
|
}
|
||||||
|
return output, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InitRepo legt ein neues restic-Repository an, falls es noch nicht
|
||||||
|
// existiert — idempotent, ein bereits initialisiertes Repository ist kein
|
||||||
|
// Fehler (Wiederholte Aufrufe durch systemd-Timer nach einem Neustart
|
||||||
|
// dürfen nicht fehlschlagen).
|
||||||
|
func InitRepo(ctx context.Context, cfg Config) error {
|
||||||
|
output, err := run(ctx, cfg, "init")
|
||||||
|
if err != nil {
|
||||||
|
if strings.Contains(string(output), "config file already exists") {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("objectbackup: repository initialisieren: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BackupSummary ist der geparste "summary"-Datensatz aus `restic backup --json`.
|
||||||
|
type BackupSummary struct {
|
||||||
|
SnapshotID string `json:"snapshot_id"`
|
||||||
|
FilesNew int `json:"files_new"`
|
||||||
|
FilesChanged int `json:"files_changed"`
|
||||||
|
FilesUnmodified int `json:"files_unmodified"`
|
||||||
|
DataBlobs int `json:"data_blobs"`
|
||||||
|
TotalBytes int64 `json:"total_bytes_processed"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Backup sichert sourceDir inkrementell (Akzeptanzkriterium 1: unveränderte
|
||||||
|
// Objekte werden nicht erneut übertragen — restics Content-defined
|
||||||
|
// Chunking erkennt das automatisch, kein manueller Änderungsabgleich
|
||||||
|
// nötig).
|
||||||
|
func Backup(ctx context.Context, cfg Config, sourceDir string) (BackupSummary, error) {
|
||||||
|
output, err := run(ctx, cfg, "backup", sourceDir, "--json")
|
||||||
|
if err != nil {
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: sicherung: %w", err)
|
||||||
|
}
|
||||||
|
return parseSummary(output)
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSummary sucht in der zeilenweisen JSON-Ausgabe von `restic backup
|
||||||
|
// --json` (mehrere Fortschritts-/Statuszeilen, GENAU EINE mit
|
||||||
|
// message_type=="summary") die Zusammenfassung.
|
||||||
|
func parseSummary(output []byte) (BackupSummary, error) {
|
||||||
|
lines := strings.Split(strings.TrimSpace(string(output)), "\n")
|
||||||
|
for i := len(lines) - 1; i >= 0; i-- {
|
||||||
|
var probe struct {
|
||||||
|
MessageType string `json:"message_type"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal([]byte(lines[i]), &probe); err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if probe.MessageType == "summary" {
|
||||||
|
var summary BackupSummary
|
||||||
|
if err := json.Unmarshal([]byte(lines[i]), &summary); err != nil {
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: summary-zeile dekodieren: %w", err)
|
||||||
|
}
|
||||||
|
return summary, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: keine summary-zeile in der restic-ausgabe gefunden")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check prüft die Vollständigkeit/Lesbarkeit des Repository
|
||||||
|
// (Akzeptanzkriterium 3 / Pflichtprüfung: Vollständigkeitsprüfung erkennt
|
||||||
|
// fehlendes/beschädigtes Objekt). readData=true liest jeden gespeicherten
|
||||||
|
// Datenblock tatsächlich (teurer, aber die einzige Prüfung, die
|
||||||
|
// Bit-Rot in bereits gespeicherten Paketen erkennt — ohne readData prüft
|
||||||
|
// restic nur Struktur/Indizes, nicht den tatsächlichen Blockinhalt).
|
||||||
|
func Check(ctx context.Context, cfg Config, readData bool) error {
|
||||||
|
args := []string{"check"}
|
||||||
|
if readData {
|
||||||
|
args = append(args, "--read-data")
|
||||||
|
}
|
||||||
|
if _, err := run(ctx, cfg, args...); err != nil {
|
||||||
|
return fmt.Errorf("objectbackup: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forget entfernt alte Snapshots nach Rotationsregel und gibt den davon
|
||||||
|
// belegten Speicherplatz frei (--prune) — restics Äquivalent zu
|
||||||
|
// BAK-01s Rotate.
|
||||||
|
func Forget(ctx context.Context, cfg Config, keepLast int) error {
|
||||||
|
if _, err := run(ctx, cfg, "forget", "--keep-last", fmt.Sprintf("%d", keepLast), "--prune"); err != nil {
|
||||||
|
return fmt.Errorf("objectbackup: rotation: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Restore stellt snapshotID nach targetDir wieder her (`restic restore`).
|
||||||
|
// targetDir muss bereits existieren; Atomarität gegenüber einem eventuell
|
||||||
|
// nicht-leeren ENDZIEL ist Aufgabe von internal/restore, nicht dieser
|
||||||
|
// Funktion (dieselbe Aufgabenteilung wie backup.Restore).
|
||||||
|
func Restore(ctx context.Context, cfg Config, snapshotID, targetDir string) error {
|
||||||
|
if _, err := run(ctx, cfg, "restore", snapshotID, "--target", targetDir); err != nil {
|
||||||
|
return fmt.Errorf("objectbackup: wiederherstellung: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type snapshotEntry struct {
|
||||||
|
ShortID string `json:"short_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SnapshotCount liefert die Anzahl vorhandener Snapshots — für Tests und
|
||||||
|
// Statusabfragen.
|
||||||
|
func SnapshotCount(ctx context.Context, cfg Config) (int, error) {
|
||||||
|
output, err := run(ctx, cfg, "snapshots", "--json")
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("objectbackup: snapshots auflisten: %w", err)
|
||||||
|
}
|
||||||
|
var snapshots []snapshotEntry
|
||||||
|
if err := json.Unmarshal(output, &snapshots); err != nil {
|
||||||
|
return 0, fmt.Errorf("objectbackup: snapshot-liste dekodieren: %w", err)
|
||||||
|
}
|
||||||
|
return len(snapshots), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
package objectbackup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireRestic(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
if _, err := exec.LookPath("restic"); err != nil {
|
||||||
|
t.Skip("restic nicht installiert, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupTest(t *testing.T) Config {
|
||||||
|
t.Helper()
|
||||||
|
requireRestic(t)
|
||||||
|
cfg := Config{RepoDir: filepath.Join(t.TempDir(), "repo"), Password: "test-passwort-fuer-objectbackup"}
|
||||||
|
if err := InitRepo(context.Background(), cfg); err != nil {
|
||||||
|
t.Fatalf("initrepo: %v", err)
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeFile(t *testing.T, dir, name, content string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, name), []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatalf("testdatei %q schreiben: %v", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBackup_UnchangedSecondRunTransmitsNothingNew ist Pruefung 1:
|
||||||
|
// zweiter Sicherungslauf nach unveraendertem Bestand ueberraegt keine
|
||||||
|
// Daten erneut.
|
||||||
|
func TestBackup_UnchangedSecondRunTransmitsNothingNew(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
writeFile(t, sourceDir, "dokument.pdf", "unveraenderter inhalt")
|
||||||
|
|
||||||
|
first, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("erste sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if first.FilesNew != 1 {
|
||||||
|
t.Fatalf("erste sicherung: files_new = %d, want 1", first.FilesNew)
|
||||||
|
}
|
||||||
|
|
||||||
|
second, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("zweite sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if second.FilesNew != 0 || second.FilesChanged != 0 {
|
||||||
|
t.Fatalf("zweite sicherung (unveraendert): files_new=%d files_changed=%d, want beide 0", second.FilesNew, second.FilesChanged)
|
||||||
|
}
|
||||||
|
if second.FilesUnmodified != 1 {
|
||||||
|
t.Fatalf("zweite sicherung: files_unmodified = %d, want 1", second.FilesUnmodified)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBackup_DeduplicatesIdenticalContent ist Pruefung 2: zwei identische
|
||||||
|
// Testdateien belegen nachweislich nur einmal Speicherplatz.
|
||||||
|
func TestBackup_DeduplicatesIdenticalContent(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
content := "exakt identischer inhalt in beiden dateien fuer den dedup-nachweis"
|
||||||
|
writeFile(t, sourceDir, "original.pdf", content)
|
||||||
|
writeFile(t, sourceDir, "kopie.pdf", content)
|
||||||
|
|
||||||
|
summary, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if summary.FilesNew != 2 {
|
||||||
|
t.Fatalf("erwartet 2 neue dateien, habe %d", summary.FilesNew)
|
||||||
|
}
|
||||||
|
// Zwei Dateien mit IDENTISCHEM Inhalt duerfen nur EINEN data_blob
|
||||||
|
// erzeugen - das ist der Dedup-Nachweis (Akzeptanzkriterium 2).
|
||||||
|
if summary.DataBlobs != 1 {
|
||||||
|
t.Fatalf("data_blobs = %d, want 1 (zwei identische dateien haetten nur einen blob erzeugen duerfen - keine dedup)", summary.DataBlobs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCheck_DetectsCorruptedPack ist Pruefung 3: Vollstaendigkeitspruefung
|
||||||
|
// erkennt ein beschaedigtes/fehlendes Objekt in der Sicherung.
|
||||||
|
func TestCheck_DetectsCorruptedPack(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
writeFile(t, sourceDir, "wichtig.pdf", "inhalt, der spaeter absichtlich beschaedigt wird")
|
||||||
|
|
||||||
|
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||||
|
t.Fatalf("sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if err := Check(ctx, cfg, true); err != nil {
|
||||||
|
t.Fatalf("check (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Absichtliche Beschaedigung: ein Byte in einer Pack-Datei im
|
||||||
|
// Repository kippen (dieselbe Fundstelle wie beim manuellen
|
||||||
|
// Nachweis waehrend der Recherche zu diesem Ticket).
|
||||||
|
packDir := filepath.Join(cfg.RepoDir, "data")
|
||||||
|
corrupted := false
|
||||||
|
if err := filepath.Walk(packDir, func(path string, info os.FileInfo, err error) error {
|
||||||
|
if err != nil || info.IsDir() || corrupted {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(data) < 20 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
data[10] ^= 0xFF
|
||||||
|
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
corrupted = true
|
||||||
|
return nil
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatalf("pack-datei beschaedigen: %v", err)
|
||||||
|
}
|
||||||
|
if !corrupted {
|
||||||
|
t.Fatal("keine pack-datei zum beschaedigen gefunden - testaufbau fehlerhaft")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Check(ctx, cfg, true); err == nil {
|
||||||
|
t.Fatal("check haette die beschaedigte pack-datei erkennen muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestForget_KeepsOnlyRequestedSnapshotCount prueft die Rotation.
|
||||||
|
func TestForget_KeepsOnlyRequestedSnapshotCount(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
writeFile(t, sourceDir, "f.txt", "version "+string(rune('a'+i)))
|
||||||
|
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||||
|
t.Fatalf("sicherung %d: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
before, err := SnapshotCount(ctx, cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("snapshotcount (vorher): %v", err)
|
||||||
|
}
|
||||||
|
if before != 3 {
|
||||||
|
t.Fatalf("erwartet 3 snapshots vor rotation, habe %d", before)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Forget(ctx, cfg, 1); err != nil {
|
||||||
|
t.Fatalf("forget: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
after, err := SnapshotCount(ctx, cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("snapshotcount (nachher): %v", err)
|
||||||
|
}
|
||||||
|
if after != 1 {
|
||||||
|
t.Fatalf("erwartet 1 snapshot nach rotation (keep-last 1), habe %d", after)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
package objectbackup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRestore_RecoversRealContentFromSnapshot ist Pruefung 1 fuer BAK-03
|
||||||
|
// (Objekt-Storage-Teil): Restore auf leerem Zielverzeichnis vollstaendig
|
||||||
|
// erfolgreich, real gegen restic geprueft, Dateiinhalt tatsaechlich
|
||||||
|
// verglichen (kein Bloss-Existenz-Check).
|
||||||
|
func TestRestore_RecoversRealContentFromSnapshot(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
content := []byte("original objektinhalt fuer restore-test")
|
||||||
|
if err := os.WriteFile(filepath.Join(sourceDir, "objekt.txt"), content, 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
summary, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("backup: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
targetDir := t.TempDir()
|
||||||
|
if err := Restore(ctx, cfg, summary.SnapshotID, targetDir); err != nil {
|
||||||
|
t.Fatalf("restore: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
restoredPath := filepath.Join(targetDir, sourceDir, "objekt.txt")
|
||||||
|
got, err := os.ReadFile(restoredPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("wiederhergestellte datei lesen (%s): %v", restoredPath, err)
|
||||||
|
}
|
||||||
|
if string(got) != string(content) {
|
||||||
|
t.Fatalf("wiederhergestellter inhalt = %q, want %q", got, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
// Package reconcile implementiert BAK-05: periodischer Abgleich, ob jeder
|
||||||
|
// in der Datenbank referenzierte Objekt-Storage-Eintrag tatsächlich
|
||||||
|
// existiert und umgekehrt. Prüft AUSSCHLIESSLICH Existenz — niemals
|
||||||
|
// Inhalt (das ist Archive BAK-08, eine eigene Fehlerklasse, bewusst nicht
|
||||||
|
// hier mit hineingezogen, siehe reconcile_test.go
|
||||||
|
// TestReconcile_ExistingButCorruptedObjectProducesNoFinding).
|
||||||
|
package reconcile
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Finding ist EIN Abweichungsfund — entweder ein Datenbankeintrag ohne
|
||||||
|
// Storage-Objekt oder umgekehrt.
|
||||||
|
type Finding struct {
|
||||||
|
StorageKey string `json:"storage_key"`
|
||||||
|
DocumentID string `json:"document_id,omitempty"`
|
||||||
|
RevisionID string `json:"revision_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Report ist das Ergebnis EINES Abgleichslaufs (Akzeptanzkriterium 3:
|
||||||
|
// Abweichungen werden BERICHTET, nicht automatisch behoben — Report ist
|
||||||
|
// reine Information, keine Reparaturfunktion existiert in diesem Paket).
|
||||||
|
//
|
||||||
|
// Beide Listen sind nach StorageKey aufsteigend sortiert — bei gleicher
|
||||||
|
// Eingabe liefert Reconcile IMMER dieselbe Reihenfolge (deterministisch),
|
||||||
|
// damit ein nachgelagerter Verbraucher (Archive BAK-08: zieht seine
|
||||||
|
// Stichprobe aus der Liste der EXISTIERENDEN Objekte) sich auf eine
|
||||||
|
// stabile Sortierung verlassen kann, statt bei jedem Lauf neu zu
|
||||||
|
// filtern/sortieren.
|
||||||
|
type Report struct {
|
||||||
|
GeneratedAt time.Time `json:"generated_at"`
|
||||||
|
// MissingInStorage: Datenbankeintrag vorhanden, Objekt im Storage fehlt
|
||||||
|
// (Akzeptanzkriterium 1).
|
||||||
|
MissingInStorage []Finding `json:"missing_in_storage"`
|
||||||
|
// OrphanedInStorage: Objekt im Storage vorhanden, kein Datenbankeintrag
|
||||||
|
// (Akzeptanzkriterium 2).
|
||||||
|
OrphanedInStorage []Finding `json:"orphaned_in_storage"`
|
||||||
|
// ExistingInStorage: Datenbankeintrag UND Storage-Objekt beide
|
||||||
|
// vorhanden — reine Existenzbestätigung, KEINE Inhaltsprüfung. Dient
|
||||||
|
// Archive BAK-08 als stabile, deterministisch sortierte
|
||||||
|
// Stichprobengrundlage (nach StorageKey aufsteigend, siehe Report-
|
||||||
|
// Dokumentation oben) — BAK-08 muss dafür selbst nicht mehr
|
||||||
|
// sortieren/filtern.
|
||||||
|
ExistingInStorage []Finding `json:"existing_in_storage"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsClean liefert true, wenn der Lauf keine Abweichungen fand (Pflicht-
|
||||||
|
// prüfung 3: "Lauf ohne Abweichungen liefert einen leeren, eindeutig als
|
||||||
|
// sauber erkennbaren Bericht" — IsClean ist genau dieses eindeutige
|
||||||
|
// Erkennungsmerkmal, statt dass ein Aufrufer beide Listen selbst auf
|
||||||
|
// Leere prüfen muss).
|
||||||
|
func (r Report) IsClean() bool {
|
||||||
|
return len(r.MissingInStorage) == 0 && len(r.OrphanedInStorage) == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// DBEntry ist ein Datenbankeintrag, wie ihn ListDBStorageKeys liefert.
|
||||||
|
type DBEntry struct {
|
||||||
|
StorageKey string
|
||||||
|
DocumentID string
|
||||||
|
RevisionID string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reconcile vergleicht dbEntries (aus file_revisions.storage_key, DMS
|
||||||
|
// FDN-02) gegen storageKeys (tatsächlich im Objekt-Storage vorhandene
|
||||||
|
// Schlüssel, z.B. per Verzeichnis-Walk des FDN-03-LocalDriver-
|
||||||
|
// Basisverzeichnisses) und liefert die Abweichungen in beide Richtungen.
|
||||||
|
// Reine Funktion — kein Datenbank-/Storage-Zugriff hier, dadurch ohne
|
||||||
|
// echte Infrastruktur testbar (siehe reconcile_test.go).
|
||||||
|
func Reconcile(dbEntries []DBEntry, storageKeys []string) Report {
|
||||||
|
storageSet := make(map[string]bool, len(storageKeys))
|
||||||
|
for _, k := range storageKeys {
|
||||||
|
storageSet[k] = true
|
||||||
|
}
|
||||||
|
dbSet := make(map[string]DBEntry, len(dbEntries))
|
||||||
|
for _, e := range dbEntries {
|
||||||
|
dbSet[e.StorageKey] = e
|
||||||
|
}
|
||||||
|
|
||||||
|
var missing, existing []Finding
|
||||||
|
for _, e := range dbEntries {
|
||||||
|
if !storageSet[e.StorageKey] {
|
||||||
|
missing = append(missing, Finding(e))
|
||||||
|
} else {
|
||||||
|
existing = append(existing, Finding(e))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var orphaned []Finding
|
||||||
|
for _, k := range storageKeys {
|
||||||
|
if _, ok := dbSet[k]; !ok {
|
||||||
|
orphaned = append(orphaned, Finding{StorageKey: k})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.Slice(missing, func(i, j int) bool { return missing[i].StorageKey < missing[j].StorageKey })
|
||||||
|
sort.Slice(orphaned, func(i, j int) bool { return orphaned[i].StorageKey < orphaned[j].StorageKey })
|
||||||
|
sort.Slice(existing, func(i, j int) bool { return existing[i].StorageKey < existing[j].StorageKey })
|
||||||
|
|
||||||
|
return Report{
|
||||||
|
GeneratedAt: time.Now().UTC(),
|
||||||
|
MissingInStorage: missing,
|
||||||
|
OrphanedInStorage: orphaned,
|
||||||
|
ExistingInStorage: existing,
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,169 @@
|
|||||||
|
package reconcile
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
// TestReconcile_DetectsMissingInStorage ist Akzeptanzkriterium 1 / Pruefung
|
||||||
|
// 1: ein Datenbankeintrag ohne zugehoeriges Objekt im Storage wird erkannt.
|
||||||
|
func TestReconcile_DetectsMissingInStorage(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/d2/revisions/r1", DocumentID: "d2", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
storage := []string{"documents/d1/revisions/r1"} // d2/r1 fehlt absichtlich
|
||||||
|
|
||||||
|
report := Reconcile(db, storage)
|
||||||
|
|
||||||
|
if len(report.MissingInStorage) != 1 {
|
||||||
|
t.Fatalf("erwartet 1 fund in missing_in_storage, habe %d: %+v", len(report.MissingInStorage), report.MissingInStorage)
|
||||||
|
}
|
||||||
|
if report.MissingInStorage[0].StorageKey != "documents/d2/revisions/r1" {
|
||||||
|
t.Fatalf("unerwarteter fund: %+v", report.MissingInStorage[0])
|
||||||
|
}
|
||||||
|
if len(report.OrphanedInStorage) != 0 {
|
||||||
|
t.Fatalf("erwartet 0 funde in orphaned_in_storage, habe %d", len(report.OrphanedInStorage))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReconcile_DetectsOrphanedInStorage ist Akzeptanzkriterium 2 /
|
||||||
|
// Pruefung 2: ein Storage-Objekt ohne Datenbankeintrag wird erkannt.
|
||||||
|
func TestReconcile_DetectsOrphanedInStorage(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
storage := []string{
|
||||||
|
"documents/d1/revisions/r1",
|
||||||
|
"documents/verwaist/revisions/r1", // kein DB-Eintrag dafuer
|
||||||
|
}
|
||||||
|
|
||||||
|
report := Reconcile(db, storage)
|
||||||
|
|
||||||
|
if len(report.OrphanedInStorage) != 1 {
|
||||||
|
t.Fatalf("erwartet 1 fund in orphaned_in_storage, habe %d: %+v", len(report.OrphanedInStorage), report.OrphanedInStorage)
|
||||||
|
}
|
||||||
|
if report.OrphanedInStorage[0].StorageKey != "documents/verwaist/revisions/r1" {
|
||||||
|
t.Fatalf("unerwarteter fund: %+v", report.OrphanedInStorage[0])
|
||||||
|
}
|
||||||
|
if len(report.MissingInStorage) != 0 {
|
||||||
|
t.Fatalf("erwartet 0 funde in missing_in_storage, habe %d", len(report.MissingInStorage))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReconcile_CleanRunProducesEmptyReport ist Pruefung 3: Lauf ohne
|
||||||
|
// Abweichungen liefert einen leeren, eindeutig als sauber erkennbaren
|
||||||
|
// Bericht.
|
||||||
|
func TestReconcile_CleanRunProducesEmptyReport(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/d2/revisions/r1", DocumentID: "d2", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
storage := []string{"documents/d1/revisions/r1", "documents/d2/revisions/r1"}
|
||||||
|
|
||||||
|
report := Reconcile(db, storage)
|
||||||
|
|
||||||
|
if !report.IsClean() {
|
||||||
|
t.Fatalf("erwartet sauberen bericht, habe missing=%v orphaned=%v", report.MissingInStorage, report.OrphanedInStorage)
|
||||||
|
}
|
||||||
|
if len(report.MissingInStorage) != 0 || len(report.OrphanedInStorage) != 0 {
|
||||||
|
t.Fatal("IsClean()==true, aber listen sind nicht leer - widerspruch")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReconcile_ExistingButCorruptedObjectProducesNoFinding ist der
|
||||||
|
// Nachweis, dass BAK-05 AUSSCHLIESSLICH Existenz prueft, niemals Inhalt
|
||||||
|
// (die Fehlerklasse "existiert, aber Inhalt beschaedigt" ist Archive
|
||||||
|
// BAK-08, bewusst nicht hier) — Reconcile bekommt nur SCHLUESSEL, hat gar
|
||||||
|
// keine Moeglichkeit, auf Inhalt zuzugreifen; dieser Test dokumentiert die
|
||||||
|
// Absicht explizit, damit sie nicht versehentlich spaeter aufgeweicht wird.
|
||||||
|
func TestReconcile_ExistingButCorruptedObjectProducesNoFinding(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
// "korruptes" Objekt hier rein simuliert durch denselben Schluessel -
|
||||||
|
// Reconcile kennt und prueft keinen Inhalt, nur den Schluessel selbst.
|
||||||
|
storage := []string{"documents/d1/revisions/r1"}
|
||||||
|
|
||||||
|
report := Reconcile(db, storage)
|
||||||
|
|
||||||
|
if !report.IsClean() {
|
||||||
|
t.Fatalf("ein existierendes (wenn auch inhaltlich korruptes) objekt haette KEINEN befund ausloesen duerfen, habe: %+v", report)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReconcile_ExistingInStorageIsStableSamplingBasis ist der Nachweis,
|
||||||
|
// dass Reconcile eine deterministisch sortierte Liste ALLER bestaetigt
|
||||||
|
// existierenden Objekte liefert (DB-Eintrag UND Storage-Objekt vorhanden)
|
||||||
|
// - dies ist die Stichprobengrundlage, die Archive BAK-08 weiterverwendet,
|
||||||
|
// ohne selbst neu zu sortieren/filtern.
|
||||||
|
func TestReconcile_ExistingInStorageIsStableSamplingBasis(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/z/revisions/r1", DocumentID: "z", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/a/revisions/r1", DocumentID: "a", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/fehlt/revisions/r1", DocumentID: "fehlt", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
storage := []string{
|
||||||
|
"documents/z/revisions/r1",
|
||||||
|
"documents/a/revisions/r1",
|
||||||
|
}
|
||||||
|
|
||||||
|
report := Reconcile(db, storage)
|
||||||
|
|
||||||
|
want := []string{"documents/a/revisions/r1", "documents/z/revisions/r1"}
|
||||||
|
if len(report.ExistingInStorage) != len(want) {
|
||||||
|
t.Fatalf("erwartet %d bestaetigt existierende objekte, habe %d: %+v", len(want), len(report.ExistingInStorage), report.ExistingInStorage)
|
||||||
|
}
|
||||||
|
for i, w := range want {
|
||||||
|
if report.ExistingInStorage[i].StorageKey != w {
|
||||||
|
t.Fatalf("sortierreihenfolge falsch: %v, want beginnend mit %v", report.ExistingInStorage, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(report.MissingInStorage) != 1 || report.MissingInStorage[0].StorageKey != "documents/fehlt/revisions/r1" {
|
||||||
|
t.Fatalf("missing_in_storage unerwartet: %+v", report.MissingInStorage)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReconcile_DeterministicOrdering ist der Nachweis fuer die
|
||||||
|
// Stabilitaets-Anforderung: gleiche Eingabe liefert bei mehreren Laeufen
|
||||||
|
// IMMER dieselbe Reihenfolge (Voraussetzung dafuer, dass Archive BAK-08
|
||||||
|
// die Liste der existierenden Objekte stabil weiterverarbeiten kann, ohne
|
||||||
|
// selbst neu zu sortieren/filtern).
|
||||||
|
func TestReconcile_DeterministicOrdering(t *testing.T) {
|
||||||
|
db := []DBEntry{
|
||||||
|
{StorageKey: "documents/z/revisions/r1", DocumentID: "z", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/a/revisions/r1", DocumentID: "a", RevisionID: "r1"},
|
||||||
|
{StorageKey: "documents/m/revisions/r1", DocumentID: "m", RevisionID: "r1"},
|
||||||
|
}
|
||||||
|
storage := []string{
|
||||||
|
"documents/a/revisions/r1", // deckt genau den DB-Eintrag "a" ab
|
||||||
|
"documents/y/revisions/r1",
|
||||||
|
"documents/n/revisions/r1",
|
||||||
|
}
|
||||||
|
|
||||||
|
first := Reconcile(db, storage)
|
||||||
|
second := Reconcile(db, storage)
|
||||||
|
|
||||||
|
if len(first.MissingInStorage) != len(second.MissingInStorage) {
|
||||||
|
t.Fatal("unterschiedliche anzahl funde zwischen zwei laeufen mit identischer eingabe")
|
||||||
|
}
|
||||||
|
for i := range first.MissingInStorage {
|
||||||
|
if first.MissingInStorage[i].StorageKey != second.MissingInStorage[i].StorageKey {
|
||||||
|
t.Fatalf("reihenfolge in missing_in_storage nicht deterministisch: lauf1[%d]=%q lauf2[%d]=%q",
|
||||||
|
i, first.MissingInStorage[i].StorageKey, i, second.MissingInStorage[i].StorageKey)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for i := range first.OrphanedInStorage {
|
||||||
|
if first.OrphanedInStorage[i].StorageKey != second.OrphanedInStorage[i].StorageKey {
|
||||||
|
t.Fatalf("reihenfolge in orphaned_in_storage nicht deterministisch: lauf1[%d]=%q lauf2[%d]=%q",
|
||||||
|
i, first.OrphanedInStorage[i].StorageKey, i, second.OrphanedInStorage[i].StorageKey)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Aufsteigend sortiert (a < m < z), nicht Einfuegereihenfolge.
|
||||||
|
wantOrder := []string{"documents/m/revisions/r1", "documents/z/revisions/r1"}
|
||||||
|
if len(first.MissingInStorage) != len(wantOrder) {
|
||||||
|
t.Fatalf("erwartet %d funde, habe %d", len(wantOrder), len(first.MissingInStorage))
|
||||||
|
}
|
||||||
|
for i, w := range wantOrder {
|
||||||
|
if first.MissingInStorage[i].StorageKey != w {
|
||||||
|
t.Fatalf("sortierreihenfolge falsch: %v, want beginnend mit %v", first.MissingInStorage, wantOrder)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
package reconcile
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ListDBStorageKeys liest alle storage_key-Werte aus file_revisions
|
||||||
|
// (DMS FDN-02) — Archive liest direkt aus derselben physischen
|
||||||
|
// Tenant-Datenbank (Modell C, Core TEN-01), OHNE DMS-Go-Pakete zu
|
||||||
|
// importieren (Archive ist ein eigenes Go-Modul) — reiner SQL-Zugriff
|
||||||
|
// gegen das dokumentierte Schema, sortiert nach storage_key für
|
||||||
|
// deterministische Reconcile-Ergebnisse.
|
||||||
|
func ListDBStorageKeys(ctx context.Context, pool *pgxpool.Pool) ([]DBEntry, error) {
|
||||||
|
rows, err := pool.Query(ctx, `
|
||||||
|
SELECT storage_key, document_id, id FROM file_revisions ORDER BY storage_key
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("reconcile: file_revisions abfragen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var entries []DBEntry
|
||||||
|
for rows.Next() {
|
||||||
|
var e DBEntry
|
||||||
|
if err := rows.Scan(&e.StorageKey, &e.DocumentID, &e.RevisionID); err != nil {
|
||||||
|
return nil, fmt.Errorf("reconcile: file_revisions-zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
entries = append(entries, e)
|
||||||
|
}
|
||||||
|
return entries, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListStorageObjects durchläuft den lokalen FDN-03-LocalDriver-
|
||||||
|
// Basisordner und liefert alle vorhandenen Objektschlüssel (Pfad relativ
|
||||||
|
// zu baseDir, mit "/" als Trenner — dasselbe Format wie
|
||||||
|
// storage.ObjectKey aus FDN-03), sortiert.
|
||||||
|
func ListStorageObjects(baseDir string) ([]string, error) {
|
||||||
|
var keys []string
|
||||||
|
err := filepath.WalkDir(baseDir, func(path string, d os.DirEntry, err error) error {
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if d.IsDir() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
rel, err := filepath.Rel(baseDir, path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
keys = append(keys, filepath.ToSlash(rel))
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("reconcile: objekt-storage durchlaufen: %w", err)
|
||||||
|
}
|
||||||
|
return keys, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package reconcile
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireTestPool(t *testing.T) *pgxpool.Pool {
|
||||||
|
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() })
|
||||||
|
|
||||||
|
// Minimalschema, das exakt DMS FDN-02s file_revisions-Spalten spiegelt
|
||||||
|
// (Archive kann DMS' internal/-Pakete als eigenes Go-Modul nicht
|
||||||
|
// importieren, daher hier als Testfixture kopiert statt real migriert).
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
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,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS documents (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), title TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id), created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS file_revisions (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
storage_key TEXT NOT NULL, checksum_sha256 TEXT NOT NULL, size_bytes BIGINT NOT NULL,
|
||||||
|
mime_type TEXT NOT NULL, revision_number INTEGER NOT NULL, created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_, _ = pool.Exec(context.Background(), `TRUNCATE file_revisions, documents, users CASCADE`)
|
||||||
|
})
|
||||||
|
return pool
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestListDBStorageKeys_ReadsRealFileRevisions ist der Nachweis, dass
|
||||||
|
// ListDBStorageKeys tatsaechlich gegen eine echte Postgres-Instanz mit
|
||||||
|
// DMS-FDN-02-Schema liest — kein Mock.
|
||||||
|
func TestListDBStorageKeys_ReadsRealFileRevisions(t *testing.T) {
|
||||||
|
pool := requireTestPool(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
var userID, docID string
|
||||||
|
if err := pool.QueryRow(ctx, `INSERT INTO users (email, name) VALUES ('reconcile-test@example.test', 'Test') RETURNING id`).Scan(&userID); err != nil {
|
||||||
|
t.Fatalf("testbenutzer anlegen: %v", err)
|
||||||
|
}
|
||||||
|
if err := pool.QueryRow(ctx, `INSERT INTO documents (title, created_by) VALUES ('doc', $1) RETURNING id`, userID).Scan(&docID); err != nil {
|
||||||
|
t.Fatalf("testdokument anlegen: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO file_revisions (document_id, storage_key, checksum_sha256, size_bytes, mime_type, revision_number, created_by)
|
||||||
|
VALUES ($1, 'documents/x/revisions/1', 'abc', 10, 'text/plain', 1, $2)
|
||||||
|
`, docID, userID); err != nil {
|
||||||
|
t.Fatalf("testrevision anlegen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
entries, err := ListDBStorageKeys(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("listdbstoragekeys: %v", err)
|
||||||
|
}
|
||||||
|
if len(entries) != 1 {
|
||||||
|
t.Fatalf("erwartet 1 eintrag, habe %d", len(entries))
|
||||||
|
}
|
||||||
|
if entries[0].StorageKey != "documents/x/revisions/1" {
|
||||||
|
t.Fatalf("storage_key = %q, want %q", entries[0].StorageKey, "documents/x/revisions/1")
|
||||||
|
}
|
||||||
|
if entries[0].DocumentID != docID {
|
||||||
|
t.Fatalf("document_id = %q, want %q", entries[0].DocumentID, docID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestListStorageObjects_WalksRealDirectory ist der Nachweis, dass
|
||||||
|
// ListStorageObjects tatsaechlich das Dateisystem durchlaeuft.
|
||||||
|
func TestListStorageObjects_WalksRealDirectory(t *testing.T) {
|
||||||
|
baseDir := t.TempDir()
|
||||||
|
mustWriteFile(t, filepath.Join(baseDir, "documents", "d1", "revisions", "r1"), "inhalt")
|
||||||
|
mustWriteFile(t, filepath.Join(baseDir, "documents", "d2", "revisions", "r1"), "inhalt")
|
||||||
|
|
||||||
|
keys, err := ListStorageObjects(baseDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("liststorageobjects: %v", err)
|
||||||
|
}
|
||||||
|
if len(keys) != 2 {
|
||||||
|
t.Fatalf("erwartet 2 objektschluessel, habe %d: %v", len(keys), keys)
|
||||||
|
}
|
||||||
|
want := []string{"documents/d1/revisions/r1", "documents/d2/revisions/r1"}
|
||||||
|
for i, w := range want {
|
||||||
|
if keys[i] != w {
|
||||||
|
t.Fatalf("schluessel[%d] = %q, want %q (voll: %v)", i, keys[i], w, keys)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestListStorageObjects_MissingDirectoryReturnsEmpty prueft das
|
||||||
|
// Verhalten, wenn das Basisverzeichnis (noch) gar nicht existiert -
|
||||||
|
// sollte als "keine Objekte", nicht als Fehler behandelt werden.
|
||||||
|
func TestListStorageObjects_MissingDirectoryReturnsEmpty(t *testing.T) {
|
||||||
|
keys, err := ListStorageObjects("/pfad/der/nicht/existiert/fuer/diesen/test")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("erwartet keinen fehler bei fehlendem verzeichnis, habe: %v", err)
|
||||||
|
}
|
||||||
|
if len(keys) != 0 {
|
||||||
|
t.Fatalf("erwartet 0 schluessel, habe %d", len(keys))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func mustWriteFile(t *testing.T, path, content string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
t.Fatalf("verzeichnis anlegen: %v", err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatalf("datei schreiben: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
// Package restore implementiert BAK-03: dokumentiertes, wiederholbares
|
||||||
|
// Restore-Verfahren für Datenbank (BAK-01) und Objekt-Storage (BAK-02).
|
||||||
|
// Enthält NUR die gemeinsame Ablauflogik (Atomarität über Temp-Verzeichnis,
|
||||||
|
// Protokollierung) — die eigentliche Wiederherstellung bleibt in den
|
||||||
|
// jeweiligen Paketen (backup.Restore, objectbackup.Restore), damit
|
||||||
|
// internal/restore nicht weiß, WIE eine Sicherung gelesen wird, nur WANN
|
||||||
|
// und WIE SICHER sie an ihren Zielort darf.
|
||||||
|
package restore
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Kind unterscheidet die beiden Restore-Arten im Protokoll.
|
||||||
|
type Kind string
|
||||||
|
|
||||||
|
const (
|
||||||
|
KindDatabase Kind = "database"
|
||||||
|
KindObjects Kind = "objects"
|
||||||
|
)
|
||||||
|
|
||||||
|
// LogEntry ist EIN Protokolleintrag (Akzeptanzkriterium 3: Quelle,
|
||||||
|
// Zeitpunkt, Ergebnis).
|
||||||
|
type LogEntry struct {
|
||||||
|
Timestamp time.Time `json:"timestamp"`
|
||||||
|
Kind Kind `json:"kind"`
|
||||||
|
Source string `json:"source"` // Generation-ID oder Snapshot-ID
|
||||||
|
Target string `json:"target"`
|
||||||
|
Result string `json:"result"` // "ok", "abgebrochen: ...", "fehlgeschlagen: ..."
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrTargetNotEmpty wird zurückgegeben, wenn targetDir bereits Inhalt hat
|
||||||
|
// und force nicht gesetzt ist — Akzeptanzkriterium 2: bestehender Inhalt
|
||||||
|
// bleibt unangetastet, solange der Vorgang nicht bestätigt wird.
|
||||||
|
var ErrTargetNotEmpty = fmt.Errorf("restore: zielverzeichnis ist nicht leer, restore ohne bestätigung (force) abgebrochen")
|
||||||
|
|
||||||
|
// AtomicRestore führt restoreFn gegen ein FRISCHES temporäres Verzeichnis
|
||||||
|
// aus (niemals direkt gegen target) und übernimmt es erst bei Erfolg —
|
||||||
|
// entweder wenn target leer ist, oder wenn force=true (bewusste
|
||||||
|
// Bestätigung, bestehenden Inhalt zu überschreiben). Bei jedem Fehler
|
||||||
|
// oder abgelehnter Bestätigung bleibt target garantiert unverändert
|
||||||
|
// (Akzeptanzkriterium 2), das temporäre Verzeichnis wird aufgeräumt.
|
||||||
|
// Jeder Aufruf – erfolgreich oder nicht – erzeugt genau einen
|
||||||
|
// Protokolleintrag in logPath (Akzeptanzkriterium 3).
|
||||||
|
func AtomicRestore(kind Kind, source, target string, force bool, logPath string, restoreFn func(tempDir string) error) (LogEntry, error) {
|
||||||
|
entry := LogEntry{Timestamp: time.Now().UTC(), Kind: kind, Source: source, Target: target}
|
||||||
|
|
||||||
|
empty, err := dirIsEmptyOrMissing(target)
|
||||||
|
if err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, err
|
||||||
|
}
|
||||||
|
if !empty && !force {
|
||||||
|
entry.Result = "abgebrochen: " + ErrTargetNotEmpty.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, ErrTargetNotEmpty
|
||||||
|
}
|
||||||
|
|
||||||
|
parent := filepath.Dir(filepath.Clean(target))
|
||||||
|
tempDir, err := os.MkdirTemp(parent, ".restore-tmp-*")
|
||||||
|
if err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: temp-verzeichnis anlegen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, fmt.Errorf("restore: temp-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = os.RemoveAll(tempDir) }() // no-op nach erfolgreichem Rename (Verzeichnis existiert dann nicht mehr)
|
||||||
|
|
||||||
|
if err := restoreFn(tempDir); err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, fmt.Errorf("restore: wiederherstellung: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !empty {
|
||||||
|
// force=true, bewusste Bestätigung: alter Inhalt wird ERST JETZT
|
||||||
|
// entfernt, nachdem restoreFn bereits erfolgreich in tempDir
|
||||||
|
// abgeschlossen hat — ein Fehlschlag oben hätte target nie berührt.
|
||||||
|
if err := os.RemoveAll(target); err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: altes ziel entfernen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, fmt.Errorf("restore: altes ziel entfernen: %w", err)
|
||||||
|
}
|
||||||
|
} else if err := os.MkdirAll(parent, 0o750); err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: übergeordnetes verzeichnis anlegen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, fmt.Errorf("restore: übergeordnetes verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := os.Rename(tempDir, target); err != nil {
|
||||||
|
entry.Result = "fehlgeschlagen: umbenennen: " + err.Error()
|
||||||
|
_ = appendLog(logPath, entry)
|
||||||
|
return entry, fmt.Errorf("restore: temp-verzeichnis nach ziel umbenennen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
entry.Result = "ok"
|
||||||
|
if err := appendLog(logPath, entry); err != nil {
|
||||||
|
return entry, fmt.Errorf("restore: protokoll schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return entry, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func dirIsEmptyOrMissing(dir string) (bool, error) {
|
||||||
|
entries, err := os.ReadDir(dir)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
return false, fmt.Errorf("zielverzeichnis lesen: %w", err)
|
||||||
|
}
|
||||||
|
return len(entries) == 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func appendLog(logPath string, entry LogEntry) error {
|
||||||
|
f, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o600)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("protokolldatei öffnen: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
line, err := json.Marshal(entry)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("protokolleintrag kodieren: %w", err)
|
||||||
|
}
|
||||||
|
if _, err := f.Write(append(line, '\n')); err != nil {
|
||||||
|
return fmt.Errorf("protokolleintrag schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,181 @@
|
|||||||
|
package restore
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func readLog(t *testing.T, path string) []LogEntry {
|
||||||
|
t.Helper()
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("protokolldatei lesen: %v", err)
|
||||||
|
}
|
||||||
|
var entries []LogEntry
|
||||||
|
for _, line := range splitLines(data) {
|
||||||
|
if len(line) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var e LogEntry
|
||||||
|
if err := json.Unmarshal(line, &e); err != nil {
|
||||||
|
t.Fatalf("protokollzeile dekodieren: %v (%s)", err, line)
|
||||||
|
}
|
||||||
|
entries = append(entries, e)
|
||||||
|
}
|
||||||
|
return entries
|
||||||
|
}
|
||||||
|
|
||||||
|
func splitLines(data []byte) [][]byte {
|
||||||
|
var out [][]byte
|
||||||
|
start := 0
|
||||||
|
for i, b := range data {
|
||||||
|
if b == '\n' {
|
||||||
|
out = append(out, data[start:i])
|
||||||
|
start = i + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAtomicRestore_EmptyTarget_Succeeds ist Pruefung 1: Restore auf
|
||||||
|
// leerem (nicht vorhandenem) Ziel vollstaendig erfolgreich.
|
||||||
|
func TestAtomicRestore_EmptyTarget_Succeeds(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
target := filepath.Join(root, "ziel")
|
||||||
|
logPath := filepath.Join(root, "restore.log")
|
||||||
|
|
||||||
|
entry, err := AtomicRestore(KindDatabase, "gen-1", target, false, logPath, func(tempDir string) error {
|
||||||
|
return os.WriteFile(filepath.Join(tempDir, "marker"), []byte("wiederhergestellt"), 0o600)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("atomicRestore: %v", err)
|
||||||
|
}
|
||||||
|
if entry.Result != "ok" {
|
||||||
|
t.Fatalf("result = %q, want ok", entry.Result)
|
||||||
|
}
|
||||||
|
content, err := os.ReadFile(filepath.Join(target, "marker"))
|
||||||
|
if err != nil || string(content) != "wiederhergestellt" {
|
||||||
|
t.Fatalf("ziel nicht korrekt befuellt: %v %q", err, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAtomicRestore_NonEmptyTargetWithoutForce_LeavesOriginalUntouched ist
|
||||||
|
// Pruefung 2: Restore auf nicht-leeres Zielverzeichnis laesst bei Abbruch
|
||||||
|
// (keine Bestaetigung) den urspruenglichen Inhalt unveraendert.
|
||||||
|
func TestAtomicRestore_NonEmptyTargetWithoutForce_LeavesOriginalUntouched(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
target := filepath.Join(root, "ziel")
|
||||||
|
logPath := filepath.Join(root, "restore.log")
|
||||||
|
if err := os.MkdirAll(target, 0o750); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(target, "bestehend"), []byte("original"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
restoreFnCalled := false
|
||||||
|
_, err := AtomicRestore(KindObjects, "snap-1", target, false, logPath, func(tempDir string) error {
|
||||||
|
restoreFnCalled = true
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != ErrTargetNotEmpty {
|
||||||
|
t.Fatalf("erwartet ErrTargetNotEmpty, habe: %v", err)
|
||||||
|
}
|
||||||
|
if restoreFnCalled {
|
||||||
|
t.Fatal("restoreFn haette bei nicht-leerem ziel ohne force NIE aufgerufen werden duerfen")
|
||||||
|
}
|
||||||
|
content, err := os.ReadFile(filepath.Join(target, "bestehend"))
|
||||||
|
if err != nil || string(content) != "original" {
|
||||||
|
t.Fatalf("urspruenglicher inhalt veraendert: %v %q", err, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAtomicRestore_FailedRestoreFn_LeavesTargetUntouched ist Nachweis,
|
||||||
|
// dass ein Fehler WAEHREND der Wiederherstellung (in tempDir) das
|
||||||
|
// bestehende Ziel nicht beschaedigt, weil erst nach Erfolg umbenannt wird.
|
||||||
|
func TestAtomicRestore_FailedRestoreFn_LeavesTargetUntouched(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
target := filepath.Join(root, "ziel")
|
||||||
|
logPath := filepath.Join(root, "restore.log")
|
||||||
|
if err := os.MkdirAll(target, 0o750); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(target, "bestehend"), []byte("original"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := AtomicRestore(KindDatabase, "gen-2", target, true, logPath, func(tempDir string) error {
|
||||||
|
return os.ErrInvalid // simuliert fehlgeschlagene wiederherstellung
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("erwartet fehler")
|
||||||
|
}
|
||||||
|
content, err := os.ReadFile(filepath.Join(target, "bestehend"))
|
||||||
|
if err != nil || string(content) != "original" {
|
||||||
|
t.Fatalf("ziel bei fehlgeschlagenem restoreFn veraendert: %v %q", err, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAtomicRestore_ForceOverwritesNonEmptyTarget ist Nachweis, dass eine
|
||||||
|
// BEWUSSTE Bestaetigung (force) bestehenden Inhalt ersetzen darf.
|
||||||
|
func TestAtomicRestore_ForceOverwritesNonEmptyTarget(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
target := filepath.Join(root, "ziel")
|
||||||
|
logPath := filepath.Join(root, "restore.log")
|
||||||
|
if err := os.MkdirAll(target, 0o750); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(target, "alt"), []byte("alt"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := AtomicRestore(KindObjects, "snap-2", target, true, logPath, func(tempDir string) error {
|
||||||
|
return os.WriteFile(filepath.Join(tempDir, "neu"), []byte("neu"), 0o600)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("atomicRestore mit force: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(target, "alt")); !os.IsNotExist(err) {
|
||||||
|
t.Fatal("alter inhalt haette nach force-restore ersetzt sein muessen")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(target, "neu")); err != nil {
|
||||||
|
t.Fatalf("neuer inhalt fehlt: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAtomicRestore_LogsCompleteEntry ist Pruefung 3: Protokolleintrag
|
||||||
|
// ist vollstaendig und nachvollziehbar (Quelle, Zeitpunkt, Ergebnis) -
|
||||||
|
// sowohl fuer Erfolg als auch fuer Abbruch, in derselben Datei.
|
||||||
|
func TestAtomicRestore_LogsCompleteEntry(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
logPath := filepath.Join(root, "restore.log")
|
||||||
|
|
||||||
|
okTarget := filepath.Join(root, "ok-ziel")
|
||||||
|
if _, err := AtomicRestore(KindDatabase, "gen-3", okTarget, false, logPath, func(tempDir string) error {
|
||||||
|
return os.WriteFile(filepath.Join(tempDir, "x"), []byte("x"), 0o600)
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatalf("erfolgreicher restore: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
blockedTarget := filepath.Join(root, "blockiert-ziel")
|
||||||
|
if err := os.MkdirAll(blockedTarget, 0o750); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(blockedTarget, "bestehend"), []byte("y"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, _ = AtomicRestore(KindObjects, "snap-3", blockedTarget, false, logPath, func(tempDir string) error { return nil })
|
||||||
|
|
||||||
|
entries := readLog(t, logPath)
|
||||||
|
if len(entries) != 2 {
|
||||||
|
t.Fatalf("erwartet 2 protokolleintraege, habe %d: %+v", len(entries), entries)
|
||||||
|
}
|
||||||
|
if entries[0].Source != "gen-3" || entries[0].Kind != KindDatabase || entries[0].Result != "ok" || entries[0].Timestamp.IsZero() {
|
||||||
|
t.Fatalf("erster eintrag unvollstaendig: %+v", entries[0])
|
||||||
|
}
|
||||||
|
if entries[1].Source != "snap-3" || entries[1].Kind != KindObjects || entries[1].Result == "" || entries[1].Timestamp.IsZero() {
|
||||||
|
t.Fatalf("zweiter eintrag unvollstaendig: %+v", entries[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ExpectedChecksums liest file_revisions.checksum_sha256 fuer genau die
|
||||||
|
// uebergebenen storage_keys — bewusst eine eigene, minimale Abfrage statt
|
||||||
|
// Erweiterung von reconcile.DBEntry (BAK-05 bleibt existenz-only, keine
|
||||||
|
// Kopplung an Inhaltspruefungs-Bedarf von BAK-08).
|
||||||
|
func ExpectedChecksums(ctx context.Context, pool *pgxpool.Pool, storageKeys []string) (map[string]string, error) {
|
||||||
|
if len(storageKeys) == 0 {
|
||||||
|
return map[string]string{}, nil
|
||||||
|
}
|
||||||
|
rows, err := pool.Query(ctx, `
|
||||||
|
SELECT storage_key, checksum_sha256 FROM file_revisions WHERE storage_key = ANY($1)
|
||||||
|
`, storageKeys)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("scrub: erwartete pruefsummen lesen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
out := make(map[string]string, len(storageKeys))
|
||||||
|
for rows.Next() {
|
||||||
|
var key, checksum string
|
||||||
|
if err := rows.Scan(&key, &checksum); err != nil {
|
||||||
|
return nil, fmt.Errorf("scrub: pruefsummen-zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
out[key] = checksum
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ActualChecksum liest die Datei unter baseDir/storageKey vollstaendig
|
||||||
|
// und berechnet ihren SHA-256 — echte Inhaltspruefung, kein
|
||||||
|
// Header-/Groessenvergleich (dieselbe Disziplin wie BAK-01s Verify).
|
||||||
|
func ActualChecksum(baseDir, storageKey string) (string, error) {
|
||||||
|
f, err := os.Open(filepath.Join(baseDir, filepath.FromSlash(storageKey)))
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("scrub: objekt lesen: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
h := sha256.New()
|
||||||
|
if _, err := io.Copy(h, f); err != nil {
|
||||||
|
return "", fmt.Errorf("scrub: objekt hashen: %w", err)
|
||||||
|
}
|
||||||
|
return hex.EncodeToString(h.Sum(nil)), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireFileRevisionsFixture(t *testing.T) (pool *pgxpool.Pool, userID, docID string) {
|
||||||
|
t.Helper()
|
||||||
|
p := requireTestPool(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
if _, err := p.Exec(ctx, `
|
||||||
|
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,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS documents (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), title TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id), created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS file_revisions (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
storage_key TEXT NOT NULL, checksum_sha256 TEXT NOT NULL, size_bytes BIGINT NOT NULL,
|
||||||
|
mime_type TEXT NOT NULL, revision_number INTEGER NOT NULL, created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("file_revisions-fixture: %v", err)
|
||||||
|
}
|
||||||
|
var uid string
|
||||||
|
if err := p.QueryRow(ctx, `INSERT INTO users (email, name) VALUES ('scrub-test@example.test', 'Test') RETURNING id`).Scan(&uid); err != nil {
|
||||||
|
t.Fatalf("testbenutzer anlegen: %v", err)
|
||||||
|
}
|
||||||
|
var did string
|
||||||
|
if err := p.QueryRow(ctx, `INSERT INTO documents (title, created_by) VALUES ('doc', $1) RETURNING id`, uid).Scan(&did); err != nil {
|
||||||
|
t.Fatalf("testdokument anlegen: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { _, _ = p.Exec(context.Background(), `TRUNCATE file_revisions, documents, users CASCADE`) })
|
||||||
|
return p, uid, did
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestActualChecksum_MatchesRealFileContent ist Nachweis, dass
|
||||||
|
// ActualChecksum tatsaechlich den Dateiinhalt liest und hasht (kein
|
||||||
|
// Header-/Groessenvergleich).
|
||||||
|
func TestActualChecksum_MatchesRealFileContent(t *testing.T) {
|
||||||
|
baseDir := t.TempDir()
|
||||||
|
content := []byte("echter dateiinhalt fuer scrub-test")
|
||||||
|
path := filepath.Join(baseDir, "documents", "x", "revisions", "1")
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, content, 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := ActualChecksum(baseDir, "documents/x/revisions/1")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("actualChecksum: %v", err)
|
||||||
|
}
|
||||||
|
sum := sha256.Sum256(content)
|
||||||
|
want := hex.EncodeToString(sum[:])
|
||||||
|
if got != want {
|
||||||
|
t.Fatalf("checksum = %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestExpectedChecksums_ReadsRealFileRevisions ist Nachweis gegen echtes
|
||||||
|
// Postgres, kein Mock.
|
||||||
|
func TestExpectedChecksums_ReadsRealFileRevisions(t *testing.T) {
|
||||||
|
pool, uid, did := requireFileRevisionsFixture(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO file_revisions (document_id, storage_key, checksum_sha256, size_bytes, mime_type, revision_number, created_by)
|
||||||
|
VALUES ($1, 'documents/x/revisions/1', 'abc123', 10, 'text/plain', 1, $2)
|
||||||
|
`, did, uid); err != nil {
|
||||||
|
t.Fatalf("testrevision anlegen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := ExpectedChecksums(ctx, pool, []string{"documents/x/revisions/1", "documents/fehlt/revisions/1"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expectedChecksums: %v", err)
|
||||||
|
}
|
||||||
|
if len(got) != 1 || got["documents/x/revisions/1"] != "abc123" {
|
||||||
|
t.Fatalf("unerwartetes ergebnis: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
// Package scrub implementiert BAK-08: periodische, checksummenbasierte
|
||||||
|
// Integritaetspruefung einer Stichprobe existierender Objekte. Baut auf
|
||||||
|
// BAK-05 (internal/reconcile) auf, das die deterministisch sortierte
|
||||||
|
// Liste bestaetigt existierender Objekte liefert (existenz-only) — scrub
|
||||||
|
// fuegt die INHALTSPRUEFUNG hinzu, die BAK-05 bewusst ausspart.
|
||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Candidate ist ein fuer den aktuellen Lauf ausgewaehltes Objekt.
|
||||||
|
type Candidate struct {
|
||||||
|
StorageKey string
|
||||||
|
DocumentID string
|
||||||
|
RevisionID string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sample waehlt aus existing (BAK-05s existing_in_storage, bereits nach
|
||||||
|
// StorageKey sortiert) die naechste Stichprobe: Objekte, die noch nie
|
||||||
|
// oder vor mehr als cooldown geprueft wurden (last_scrubbed via
|
||||||
|
// storage_key -> last_scrubbed_at aus scrub_state), begrenzt auf
|
||||||
|
// sampleSize. Reine Funktion, deterministisch bei gleicher Eingabe (fixe
|
||||||
|
// Reihenfolge von existing, kein Zufall) — Akzeptanzkriterium
|
||||||
|
// "Sampling priorisiert alte, unveraenderte Objekte": ein nie/am
|
||||||
|
// laengsten nicht geprueftes Objekt hat KEINEN last_scrubbed-Eintrag oder
|
||||||
|
// den aeltesten, beides erscheint zuerst in "existing", das seinerseits
|
||||||
|
// nach StorageKey sortiert ist — daher wird zusaetzlich vor der
|
||||||
|
// Groessenbegrenzung nach last_scrubbed_at aufsteigend sortiert (nie
|
||||||
|
// geprueft = aeltestmoeglicher Wert), damit tatsaechlich das am laengsten
|
||||||
|
// nicht verifizierte Objekt zuerst drankommt, nicht nur alphabetisch nach
|
||||||
|
// Schluessel.
|
||||||
|
func Sample(existing []reconcile.Finding, lastScrubbed map[string]time.Time, cooldown time.Duration, sampleSize int, now time.Time) []Candidate {
|
||||||
|
type scored struct {
|
||||||
|
f reconcile.Finding
|
||||||
|
last time.Time
|
||||||
|
}
|
||||||
|
var due []scored
|
||||||
|
for _, f := range existing {
|
||||||
|
last, ok := lastScrubbed[f.StorageKey]
|
||||||
|
if ok && now.Sub(last) < cooldown {
|
||||||
|
continue // erst kuerzlich geprueft, ueberspringen
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
last = time.Time{} // nie geprueft = aeltestmoeglicher Wert, kommt zuerst
|
||||||
|
}
|
||||||
|
due = append(due, scored{f: f, last: last})
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.SliceStable(due, func(i, j int) bool {
|
||||||
|
if !due[i].last.Equal(due[j].last) {
|
||||||
|
return due[i].last.Before(due[j].last)
|
||||||
|
}
|
||||||
|
return due[i].f.StorageKey < due[j].f.StorageKey // Tie-Break deterministisch
|
||||||
|
})
|
||||||
|
|
||||||
|
if sampleSize >= 0 && len(due) > sampleSize {
|
||||||
|
due = due[:sampleSize]
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]Candidate, 0, len(due))
|
||||||
|
for _, d := range due {
|
||||||
|
out = append(out, Candidate{StorageKey: d.f.StorageKey, DocumentID: d.f.DocumentID, RevisionID: d.f.RevisionID})
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||||
|
)
|
||||||
|
|
||||||
|
var now = time.Date(2026, 8, 29, 12, 0, 0, 0, time.UTC)
|
||||||
|
|
||||||
|
// TestSample_PrioritizesNeverScrubbedAndOldest ist der Nachweis fuer das
|
||||||
|
// GoBD-Akzeptanzkriterium: nie geprueft ODER am laengsten nicht geprueft
|
||||||
|
// kommt zuerst, nicht bloss alphabetisch nach StorageKey.
|
||||||
|
func TestSample_PrioritizesNeverScrubbedAndOldest(t *testing.T) {
|
||||||
|
existing := []reconcile.Finding{
|
||||||
|
{StorageKey: "documents/a/revisions/r1"}, // vor 1 tag geprueft
|
||||||
|
{StorageKey: "documents/b/revisions/r1"}, // nie geprueft
|
||||||
|
{StorageKey: "documents/c/revisions/r1"}, // vor 30 tagen geprueft (aeltest)
|
||||||
|
}
|
||||||
|
lastScrubbed := map[string]time.Time{
|
||||||
|
"documents/a/revisions/r1": now.Add(-24 * time.Hour),
|
||||||
|
"documents/c/revisions/r1": now.Add(-30 * 24 * time.Hour),
|
||||||
|
}
|
||||||
|
|
||||||
|
got := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||||
|
|
||||||
|
if len(got) != 2 {
|
||||||
|
t.Fatalf("erwartet 2 kandidaten, habe %d: %+v", len(got), got)
|
||||||
|
}
|
||||||
|
// "nie geprueft" (b) zaehlt als aeltestmoeglich, kommt vor "vor 30 tagen" (c).
|
||||||
|
if got[0].StorageKey != "documents/b/revisions/r1" || got[1].StorageKey != "documents/c/revisions/r1" {
|
||||||
|
t.Fatalf("falsche prioritaet, want [b, c], habe %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSample_RespectsCooldown ist der Nachweis, dass kuerzlich gepruefte
|
||||||
|
// Objekte NICHT erneut ausgewaehlt werden — sonst wuerde dieselbe Gruppe
|
||||||
|
// dauernd gescrubbt (genau der Fehler, den die Alt-Priorisierung
|
||||||
|
// verhindern soll).
|
||||||
|
func TestSample_RespectsCooldown(t *testing.T) {
|
||||||
|
existing := []reconcile.Finding{
|
||||||
|
{StorageKey: "documents/a/revisions/r1"},
|
||||||
|
{StorageKey: "documents/b/revisions/r1"},
|
||||||
|
}
|
||||||
|
lastScrubbed := map[string]time.Time{
|
||||||
|
"documents/a/revisions/r1": now.Add(-1 * time.Hour), // innerhalb cooldown
|
||||||
|
}
|
||||||
|
|
||||||
|
got := Sample(existing, lastScrubbed, 24*time.Hour, 10, now)
|
||||||
|
|
||||||
|
if len(got) != 1 || got[0].StorageKey != "documents/b/revisions/r1" {
|
||||||
|
t.Fatalf("erwartet nur b (a innerhalb cooldown), habe %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSample_LimitsToSampleSize ist der Nachweis, dass die
|
||||||
|
// Stichprobengroesse tatsaechlich begrenzt (kein Voll-Scrub jeden Lauf).
|
||||||
|
func TestSample_LimitsToSampleSize(t *testing.T) {
|
||||||
|
existing := []reconcile.Finding{
|
||||||
|
{StorageKey: "documents/a/revisions/r1"},
|
||||||
|
{StorageKey: "documents/b/revisions/r1"},
|
||||||
|
{StorageKey: "documents/c/revisions/r1"},
|
||||||
|
}
|
||||||
|
|
||||||
|
got := Sample(existing, map[string]time.Time{}, time.Hour, 1, now)
|
||||||
|
|
||||||
|
if len(got) != 1 {
|
||||||
|
t.Fatalf("erwartet genau 1 kandidat, habe %d", len(got))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSample_DeterministicForIdenticalInput ist der Nachweis, dass zwei
|
||||||
|
// Laeufe mit identischer Eingabe dieselbe Reihenfolge liefern (kein
|
||||||
|
// Zufall im Sampling).
|
||||||
|
func TestSample_DeterministicForIdenticalInput(t *testing.T) {
|
||||||
|
existing := []reconcile.Finding{
|
||||||
|
{StorageKey: "documents/a/revisions/r1"},
|
||||||
|
{StorageKey: "documents/b/revisions/r1"},
|
||||||
|
{StorageKey: "documents/c/revisions/r1"},
|
||||||
|
}
|
||||||
|
lastScrubbed := map[string]time.Time{}
|
||||||
|
|
||||||
|
first := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||||
|
second := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||||
|
|
||||||
|
if len(first) != len(second) {
|
||||||
|
t.Fatal("unterschiedliche anzahl zwischen zwei laeufen mit identischer eingabe")
|
||||||
|
}
|
||||||
|
for i := range first {
|
||||||
|
if first[i].StorageKey != second[i].StorageKey {
|
||||||
|
t.Fatalf("reihenfolge nicht deterministisch: lauf1=%+v lauf2=%+v", first, second)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// LoadLastScrubbed liefert je storage_key den Zeitpunkt der letzten
|
||||||
|
// Pruefung — Grundlage fuer Sample's Cooldown-Filter.
|
||||||
|
func LoadLastScrubbed(ctx context.Context, pool *pgxpool.Pool) (map[string]time.Time, error) {
|
||||||
|
rows, err := pool.Query(ctx, `SELECT storage_key, last_scrubbed_at FROM scrub_state`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("scrub: scrub_state lesen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
out := make(map[string]time.Time)
|
||||||
|
for rows.Next() {
|
||||||
|
var key string
|
||||||
|
var ts time.Time
|
||||||
|
if err := rows.Scan(&key, &ts); err != nil {
|
||||||
|
return nil, fmt.Errorf("scrub: scrub_state-zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
out[key] = ts
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkScrubbed vermerkt Ergebnis und Zeitpunkt der Pruefung eines
|
||||||
|
// Objekts — idempotent (ON CONFLICT), damit ein unterbrochener und neu
|
||||||
|
// gestarteter Lauf keinen inkonsistenten Zustand hinterlaesst
|
||||||
|
// (Akzeptanzkriterium: Lauf ist unterbrechbar ohne inkonsistenten
|
||||||
|
// Zustand).
|
||||||
|
func MarkScrubbed(ctx context.Context, pool *pgxpool.Pool, storageKey string, ok bool, at time.Time) error {
|
||||||
|
result := "ok"
|
||||||
|
if !ok {
|
||||||
|
result = "failed"
|
||||||
|
}
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO scrub_state (storage_key, last_scrubbed_at, last_result)
|
||||||
|
VALUES ($1, $2, $3)
|
||||||
|
ON CONFLICT (storage_key) DO UPDATE SET last_scrubbed_at = $2, last_result = $3
|
||||||
|
`, storageKey, at, result)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("scrub: scrub_state schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RecordFinding erhoeht den monoton steigenden Befund-Zaehler
|
||||||
|
// (scrub_counters.findings_total) um genau 1 — als gueltiger Prometheus-
|
||||||
|
// Counter darf dieser Wert nur steigen, niemals sinken, auch wenn ein
|
||||||
|
// Befund spaeter behoben wird.
|
||||||
|
func RecordFinding(ctx context.Context, pool *pgxpool.Pool) error {
|
||||||
|
_, err := pool.Exec(ctx, `UPDATE scrub_counters SET findings_total = findings_total + 1 WHERE id = 1`)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("scrub: befund-zaehler erhoehen: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FindingsTotal liest den aktuellen Zaehlerstand — genutzt vom
|
||||||
|
// /metrics-Endpunkt (cmd/scrub-metrics).
|
||||||
|
func FindingsTotal(ctx context.Context, pool *pgxpool.Pool) (int64, error) {
|
||||||
|
var total int64
|
||||||
|
err := pool.QueryRow(ctx, `SELECT findings_total FROM scrub_counters WHERE id = 1`).Scan(&total)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("scrub: befund-zaehler lesen: %w", err)
|
||||||
|
}
|
||||||
|
return total, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package scrub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireTestPool(t *testing.T) *pgxpool.Pool {
|
||||||
|
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, `
|
||||||
|
CREATE TABLE IF NOT EXISTS scrub_state (
|
||||||
|
storage_key TEXT PRIMARY KEY, last_scrubbed_at TIMESTAMPTZ NOT NULL,
|
||||||
|
last_result TEXT NOT NULL CHECK (last_result IN ('ok', 'failed'))
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS scrub_counters (
|
||||||
|
id INTEGER PRIMARY KEY DEFAULT 1 CHECK (id = 1), findings_total BIGINT NOT NULL DEFAULT 0
|
||||||
|
);
|
||||||
|
INSERT INTO scrub_counters (id, findings_total) VALUES (1, 0) ON CONFLICT (id) DO NOTHING;
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_, _ = pool.Exec(context.Background(), `TRUNCATE scrub_state; UPDATE scrub_counters SET findings_total = 0 WHERE id = 1`)
|
||||||
|
})
|
||||||
|
return pool
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMarkScrubbed_IsIdempotent ist Nachweis fuer "Lauf ist idempotent und
|
||||||
|
// unterbrechbar ohne inkonsistenten Zustand": derselbe storage_key kann
|
||||||
|
// beliebig oft neu markiert werden, es entsteht kein Duplikat/Fehler.
|
||||||
|
func TestMarkScrubbed_IsIdempotent(t *testing.T) {
|
||||||
|
pool := requireTestPool(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "documents/x/revisions/1"
|
||||||
|
|
||||||
|
if err := MarkScrubbed(ctx, pool, key, true, time.Now().UTC()); err != nil {
|
||||||
|
t.Fatalf("erster markScrubbed: %v", err)
|
||||||
|
}
|
||||||
|
second := time.Now().UTC().Add(time.Hour)
|
||||||
|
if err := MarkScrubbed(ctx, pool, key, false, second); err != nil {
|
||||||
|
t.Fatalf("zweiter markScrubbed (ueberschreibt): %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
last, err := LoadLastScrubbed(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("loadLastScrubbed: %v", err)
|
||||||
|
}
|
||||||
|
if len(last) != 1 {
|
||||||
|
t.Fatalf("erwartet genau 1 eintrag (kein duplikat), habe %d", len(last))
|
||||||
|
}
|
||||||
|
// Postgres timestamptz rundet auf Mikrosekunden, Go time.Time hat
|
||||||
|
// Nanosekunden-Praezision - Vergleich daher auf Mikrosekunden gerundet.
|
||||||
|
if !last[key].Truncate(time.Microsecond).Equal(second.Truncate(time.Microsecond)) {
|
||||||
|
t.Fatalf("last_scrubbed_at nicht ueberschrieben: %v, want %v", last[key], second)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRecordFinding_IsMonotonicallyIncreasing ist Nachweis, dass der
|
||||||
|
// Zaehler ein gueltiger Prometheus-Counter ist (steigt nur, sinkt nie).
|
||||||
|
func TestRecordFinding_IsMonotonicallyIncreasing(t *testing.T) {
|
||||||
|
pool := requireTestPool(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
if err := RecordFinding(ctx, pool); err != nil {
|
||||||
|
t.Fatalf("recordFinding: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
total, err := FindingsTotal(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("findingsTotal: %v", err)
|
||||||
|
}
|
||||||
|
if total != 3 {
|
||||||
|
t.Fatalf("erwartet 3, habe %d", total)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
DROP TABLE IF EXISTS scrub_counters;
|
||||||
|
DROP TABLE IF EXISTS scrub_state;
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
-- BAK-08: Zustand des Integritaets-Scrub-Jobs. Getrennt von file_revisions
|
||||||
|
-- (DMS-Eigentum, nur lesend zugegriffen) und getrennt von BAK-05s
|
||||||
|
-- reconcile-Paket (existenz-only, keine Inhaltspruefung) — eigener,
|
||||||
|
-- Archive-eigener Zustand ueber ZULETZT geprueften Zeitpunkt je Objekt,
|
||||||
|
-- damit Sampling rotiert statt dieselben "aeltesten" Objekte auf ewig
|
||||||
|
-- erneut zu ziehen.
|
||||||
|
CREATE TABLE IF NOT EXISTS scrub_state (
|
||||||
|
storage_key TEXT PRIMARY KEY,
|
||||||
|
last_scrubbed_at TIMESTAMPTZ NOT NULL,
|
||||||
|
last_result TEXT NOT NULL CHECK (last_result IN ('ok', 'failed'))
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Einzelne Zeile, monoton steigender Zaehler fuer den OPS-05/OPS-03-
|
||||||
|
-- Metrik-Export (Counter, nie ruecksetzbar — ein behobener Befund darf den
|
||||||
|
-- Zaehler nicht wieder senken, sonst waere es kein gueltiger Prometheus-
|
||||||
|
-- Counter mehr).
|
||||||
|
CREATE TABLE IF NOT EXISTS scrub_counters (
|
||||||
|
id INTEGER PRIMARY KEY DEFAULT 1 CHECK (id = 1),
|
||||||
|
findings_total BIGINT NOT NULL DEFAULT 0
|
||||||
|
);
|
||||||
|
INSERT INTO scrub_counters (id, findings_total) VALUES (1, 0) ON CONFLICT (id) DO NOTHING;
|
||||||
+3
-18
@@ -7,7 +7,6 @@ import (
|
|||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/config"
|
"gitea.perlbach24.de/scripte/nexarch/internal/config"
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/tenant"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
@@ -16,30 +15,16 @@ func main() {
|
|||||||
log.Fatalf("config: %v", err)
|
log.Fatalf("config: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx := context.Background()
|
pool, err := db.Connect(context.Background(), cfg.RegistryDSN)
|
||||||
|
|
||||||
registryPool, err := db.Connect(ctx, cfg.RegistryDSN)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("registry db: %v", err)
|
log.Fatalf("db: %v", err)
|
||||||
}
|
}
|
||||||
defer registryPool.Close()
|
defer pool.Close()
|
||||||
|
|
||||||
adminPool, err := db.Connect(ctx, cfg.AdminDSN)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("admin db: %v", err)
|
|
||||||
}
|
|
||||||
defer adminPool.Close()
|
|
||||||
|
|
||||||
registry := tenant.NewRegistry(registryPool)
|
|
||||||
provisioner := tenant.NewProvisioner(adminPool, registry, cfg.TenantDSNTemplate)
|
|
||||||
tenantHandler := tenant.NewHandler(provisioner)
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
mux := http.NewServeMux()
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
})
|
})
|
||||||
// Vorlaeufiger Pfad ohne Versionierung/Auth — wird mit API-01/IAM-01 abgeloest.
|
|
||||||
mux.HandleFunc("/internal/tenants", tenantHandler.CreateTenant)
|
|
||||||
|
|
||||||
log.Printf("nexarch-core listening on %s", cfg.ListenAddr)
|
log.Printf("nexarch-core listening on %s", cfg.ListenAddr)
|
||||||
if err := http.ListenAndServe(cfg.ListenAddr, mux); err != nil {
|
if err := http.ListenAndServe(cfg.ListenAddr, mux); err != nil {
|
||||||
|
|||||||
@@ -1,70 +0,0 @@
|
|||||||
// resync-api ist der Aufrufpunkt fuer API-11: startet den bereits
|
|
||||||
// fertigen internal/resync.Handler (API-06) als eigenstaendigen
|
|
||||||
// HTTP-Dienst. REINES WIRING — keine Aenderung an internal/resync/,
|
|
||||||
// internal/audit/, internal/usage/ oder internal/moduleregistry/.
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
"os"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/audit"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/moduleregistry"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/resync"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/usage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// auditAdapter erfüllt resync.AuditRecorder über den bestehenden
|
|
||||||
// audit.Log-Schreibpfad — kein neuer Audit-Code, nur Signatur-Anpassung
|
|
||||||
// (audit.Log.Record nimmt ein Event-Struct, resync.AuditRecorder einzelne
|
|
||||||
// Felder).
|
|
||||||
type auditAdapter struct{ log *audit.Log }
|
|
||||||
|
|
||||||
func (a auditAdapter) Record(ctx context.Context, tenantSlug, actor, action, target string, metadata map[string]any, occurredAt time.Time) error {
|
|
||||||
return a.log.Record(ctx, audit.Event{
|
|
||||||
TenantSlug: tenantSlug, Actor: actor, Action: action, Target: target,
|
|
||||||
Metadata: metadata, OccurredAt: occurredAt,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
registryDSN := os.Getenv("NEXARCH_RESYNC_REGISTRY_DSN")
|
|
||||||
if registryDSN == "" {
|
|
||||||
log.Fatal("NEXARCH_RESYNC_REGISTRY_DSN muss gesetzt sein")
|
|
||||||
}
|
|
||||||
addr := os.Getenv("NEXARCH_RESYNC_API_LISTEN_ADDR")
|
|
||||||
if addr == "" {
|
|
||||||
addr = "127.0.0.1:8098"
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
pool, err := pgxpool.New(ctx, registryDSN)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("datenbankverbindung: %v", err)
|
|
||||||
}
|
|
||||||
defer pool.Close()
|
|
||||||
|
|
||||||
flagStore := flag.NewStore(pool)
|
|
||||||
flagService := flag.NewService(flagStore, 30*time.Second)
|
|
||||||
registry := moduleregistry.NewRegistry(pool, flagService)
|
|
||||||
auditLog := audit.NewLog(pool)
|
|
||||||
usageStore := usage.NewStore(pool)
|
|
||||||
|
|
||||||
handler := resync.NewHandler(registry, auditAdapter{log: auditLog}, usageStore)
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/internal/resync/audit", handler.AuditHandler)
|
|
||||||
mux.HandleFunc("/internal/resync/usage", handler.UsageHandler)
|
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
|
|
||||||
log.Printf("resync-api: listening on %s", addr)
|
|
||||||
if err := http.ListenAndServe(addr, mux); err != nil {
|
|
||||||
log.Fatalf("http server: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Datenbank-Vollsicherung (BAK-01)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli full
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Datenbank-Vollsicherung (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 02:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Datenbank-Inkrementalsicherung (BAK-01)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli incremental
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Datenbank-Inkrementalsicherung (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* *:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Sicherungsgenerationen-Rotation (BAK-01)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli rotate
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Sicherungsgenerationen-Rotation (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 03:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli backup __OBJECT_SOURCE_DIR__
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Sicherung (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* *:30:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung Vollstaendigkeitspruefung (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli check
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Woechentlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Vollstaendigkeitspruefung (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=Sun *-*-* 04:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung Rotation (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli rotate
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Rotation (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 03:30:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Konsistenzpruefung Storage vs. DB (BAK-05)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-reconcile.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/reconcile-cli
|
||||||
|
StandardOutput=journal
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Konsistenzpruefung (BAK-05)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 05:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - /metrics-Export fuer BAK-08 (dauerhaft, Pull-Modell fuer OPS-03)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-scrub-metrics.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/scrub-metrics
|
||||||
|
Restart=on-failure
|
||||||
|
StandardOutput=journal
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Checksummen-Integritaetspruefung Stichprobe (BAK-08)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-scrub.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/scrub-cli
|
||||||
|
StandardOutput=journal
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Zeitplan fuer NEXARCH Archive Checksummen-Stichprobe (BAK-08)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 06:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=NEXARCH Core - Wiederanlauf-Nachsynchronisierung (API-06/API-11)
|
|
||||||
After=network.target postgresql.service
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=nexarch
|
|
||||||
EnvironmentFile=/etc/nexarch/resync-api.env
|
|
||||||
ExecStart=__INSTALL_DIR__/bin/resync-api
|
|
||||||
Restart=on-failure
|
|
||||||
StandardOutput=journal
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
# API-11 – Prüfprotokoll: Wiederanlauf-Nachsynchronisierungs-Endpunkt starten (API-06 als laufender Dienst)
|
|
||||||
|
|
||||||
Voraussetzung API-06 – bereits Fertig, hier UNVERÄNDERT.
|
|
||||||
|
|
||||||
## Reines Wiring, keine neue Logik
|
|
||||||
|
|
||||||
`git diff --stat internal/resync/ internal/audit/ internal/usage/ internal/moduleregistry/`
|
|
||||||
liefert KEINEN Diff gegenüber den jeweiligen Ticket-Ständen. `API-11`
|
|
||||||
fügt ausschließlich `cmd/resync-api/main.go` hinzu — inklusive eines
|
|
||||||
kleinen `auditAdapter`, der `resync.AuditRecorder` (einzelne Felder)
|
|
||||||
auf `audit.Log.Record` (Event-Struct) abbildet. Das ist reine
|
|
||||||
Signatur-Anpassung, keine neue Geschäftslogik.
|
|
||||||
|
|
||||||
## Root Cause (dokumentiert)
|
|
||||||
|
|
||||||
`cmd/core/main.go` ist seit TEN-01 minimal geblieben (nur `/healthz`,
|
|
||||||
`/internal/tenants`) — kein späteres Ticket (RBAC-02, CFG-02, API-06,
|
|
||||||
...) wurde je dort zentral eingehängt. Jedes Modul entstand auf einer
|
|
||||||
eigenen, unabhängigen Feature-Branch-Kette. API-11 folgt dem in dieser
|
|
||||||
Session etablierten Muster (RBAC-06, CFG-05, RET-09): ein eigener,
|
|
||||||
kleiner HTTP-Dienst statt eines zentralen `cmd/core`-Umbaus.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `cmd/resync-api/main.go` – startet `internal/resync.Handler` mit
|
|
||||||
echten Produktions-Implementierungen: `moduleregistry.Registry`
|
|
||||||
(Auth), `audit.Log` (über `auditAdapter`), `usage.Store`.
|
|
||||||
- `deploy/systemd/nexarch-resync-api.service.tmpl`.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Dienst startet und bleibt stabil (systemctl status aktiv) | **bestanden** – real auf 131: `nexarch-resync-api.service` aktiv, `Restart=on-failure` |
|
|
||||||
| 2 | Realer POST /internal/resync/usage von einem externen Testclient gegen den laufenden Dienst liefert die erwartete Verarbeitung | **bestanden** – real per `curl`: mit echtem, über `moduleregistry.Registry.Provision` ausgestelltem Service-Credential (`X-Nexarch-Client-Id`/`X-Nexarch-Client-Secret`) liefert der Aufruf `{"applied":1}`, `usage_counters` zeigt real den erhöhten Zähler; mit falschem Credential 401. Testdaten (Modul, Credential, Zähler-Zeile) anschließend entfernt |
|
|
||||||
| 3 | Code-Review: keine Änderung an internal/resync/ selbst, nur main.go+systemd neu | **bestanden** – `git diff --stat` bestätigt: `internal/resync/`, `internal/audit/`, `internal/usage/`, `internal/moduleregistry/` unverändert gegenüber ihren jeweiligen Ticket-Ständen |
|
|
||||||
|
|
||||||
## Echte Verdrahtung auf 192.168.1.131
|
|
||||||
|
|
||||||
- `resync-api` gebaut nach `/opt/nexarch-core/bin/`,
|
|
||||||
`/etc/nexarch/resync-api.env` (0600), `nexarch-resync-api.service`
|
|
||||||
installiert/aktiviert.
|
|
||||||
- Reale Rechtevergabe-Lücke gefunden und behoben (gleiches Muster wie
|
|
||||||
bei den vorherigen Wrapper-Diensten): `modules`, `module_credentials`,
|
|
||||||
`audit_events`, `feature_flags`, `usage_counters`,
|
|
||||||
`resync_audit_buffer`, `resync_usage_buffer` gehörten `postgres`,
|
|
||||||
`nexarch_core` hatte keine Rechte — `GRANT` nachgezogen und über
|
|
||||||
`information_schema.role_table_grants` verifiziert, bevor der
|
|
||||||
End-zu-Ende-Test erneut lief.
|
|
||||||
- Zusätzliche reale Erkenntnis: `usage_counters.tenant_id` ist `UUID`,
|
|
||||||
nicht der Tenant-Slug (String) — beim ersten Testversuch mit `"acme"`
|
|
||||||
scheiterte der Insert intern, `UsageHandler` meldete `applied:0` statt
|
|
||||||
eines Fehlers (stiller Fehlschlag pro Delta, so von API-06 selbst so
|
|
||||||
entworfen: "Aufrufer entfernt aus seinem Puffer nur bestätigt
|
|
||||||
übernommene Deltas" — kein API-11-Defekt, sondern korrektes,
|
|
||||||
bestehendes API-06-Verhalten). Mit echter UUID als `tenant_slug`-Wert
|
|
||||||
lieferte der Aufruf real `applied:1`.
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./cmd/resync-api/... -> 0 issues
|
|
||||||
```
|
|
||||||
|
|
||||||
Keine neuen Go-Tests nötig (kein neuer Fachcode außer main.go/Adapter,
|
|
||||||
die eigentliche Logik ist bereits durch API-06s eigene Tests
|
|
||||||
abgedeckt).
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** API-06 ist jetzt ein real laufender, über systemd
|
|
||||||
verwalteter Dienst. Modul-Clients wie DMS' `storage.HTTPUsageReporter`
|
|
||||||
(RET-06/DOC-16-Umfeld) können sich jetzt real gegen einen laufenden
|
|
||||||
Endpunkt verdrahten, statt gegen unverdrahteten Go-Code zu testen.
|
|
||||||
@@ -2,16 +2,4 @@ module gitea.perlbach24.de/scripte/nexarch
|
|||||||
|
|
||||||
go 1.22
|
go 1.22
|
||||||
|
|
||||||
require (
|
require github.com/jackc/pgx/v5 v5.6.0
|
||||||
github.com/golang-jwt/jwt/v5 v5.3.1
|
|
||||||
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
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,96 +0,0 @@
|
|||||||
// Package audit implementiert Core AUD-01: das zentrale, vom allgemeinen
|
|
||||||
// Anwendungs-Log getrennte Audit-Datenmodell fuer sicherheits- und
|
|
||||||
// compliancerelevante Ereignisse (wer, was, wann, an welchem Tenant).
|
|
||||||
// Unveraenderlichkeit (Append-only) ist AUD-02, Export/Filter-API ist AUD-03
|
|
||||||
// — dieses Paket liefert nur das Datenmodell und den EINEN zentralen
|
|
||||||
// Schreibpfad (Akzeptanzkriterium 3).
|
|
||||||
package audit
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// SystemTenant ist der reservierte Tenant-Bezug fuer mandantenuebergreifende
|
|
||||||
// Ereignisse (z.B. Superadmin-Aktionen) — es gibt bewusst KEINEN Weg, ein
|
|
||||||
// Ereignis ganz ohne Tenant-Bezug zu schreiben (Akzeptanzkriterium 2).
|
|
||||||
const SystemTenant = "system"
|
|
||||||
|
|
||||||
var ErrMissingTenant = errors.New("audit: tenant_slug darf nicht leer sein")
|
|
||||||
var ErrMissingActor = errors.New("audit: actor darf nicht leer sein")
|
|
||||||
var ErrMissingAction = errors.New("audit: action darf nicht leer sein")
|
|
||||||
|
|
||||||
// Event ist ein strukturiertes Audit-Ereignis (Akzeptanzkriterium 1: Akteur,
|
|
||||||
// Aktion, Zielobjekt, Zeitpunkt, Tenant).
|
|
||||||
type Event struct {
|
|
||||||
TenantSlug string
|
|
||||||
Actor string
|
|
||||||
Action string
|
|
||||||
Target string
|
|
||||||
Metadata map[string]any
|
|
||||||
OccurredAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log ist der EINE zentrale Schreibpfad fuer Audit-Ereignisse — es gibt
|
|
||||||
// bewusst keine zweite Schreibmoeglichkeit, damit kein Handler versehentlich
|
|
||||||
// direkt in audit_events schreibt und dabei die Validierung umgeht
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
type Log struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewLog(pool *pgxpool.Pool) *Log {
|
|
||||||
return &Log{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Record persistiert genau einen Audit-Eintrag. Fehlender Tenant-Bezug wird
|
|
||||||
// bereits hier abgewiesen (klarer Fehler statt Constraint-Verletzung im
|
|
||||||
// Normalfall) — die Datenbank-CHECK-Constraint aus der Migration ist die
|
|
||||||
// zweite, unumgehbare Verteidigungslinie (Akzeptanzkriterium 2 / Pruefung 2).
|
|
||||||
func (l *Log) Record(ctx context.Context, e Event) error {
|
|
||||||
if e.TenantSlug == "" {
|
|
||||||
return ErrMissingTenant
|
|
||||||
}
|
|
||||||
if e.Actor == "" {
|
|
||||||
return ErrMissingActor
|
|
||||||
}
|
|
||||||
if e.Action == "" {
|
|
||||||
return ErrMissingAction
|
|
||||||
}
|
|
||||||
if e.Metadata == nil {
|
|
||||||
e.Metadata = map[string]any{}
|
|
||||||
}
|
|
||||||
metadataJSON, err := json.Marshal(e.Metadata)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("metadaten serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
if e.OccurredAt.IsZero() {
|
|
||||||
e.OccurredAt = time.Now()
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = l.pool.Exec(ctx, `
|
|
||||||
INSERT INTO audit_events (occurred_at, tenant_slug, actor, action, target, metadata)
|
|
||||||
VALUES ($1, $2, $3, $4, $5, $6)
|
|
||||||
`, e.OccurredAt, e.TenantSlug, e.Actor, e.Action, e.Target, metadataJSON)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("audit-ereignis schreiben: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// CountByTenant ist eine schlanke Lesehilfe fuer Tests/Diagnose — die
|
|
||||||
// eigentliche Filter-/Export-API ist AUD-03, hier bewusst nicht vorgezogen.
|
|
||||||
func (l *Log) CountByTenant(ctx context.Context, tenantSlug string) (int, error) {
|
|
||||||
var n int
|
|
||||||
if err := l.pool.QueryRow(ctx, `
|
|
||||||
SELECT count(*) FROM audit_events WHERE tenant_slug = $1
|
|
||||||
`, tenantSlug).Scan(&n); err != nil {
|
|
||||||
return 0, fmt.Errorf("audit-ereignisse zaehlen: %w", err)
|
|
||||||
}
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
package audit
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupAuditTest(t *testing.T) (*Log, *pgxpool.Pool, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS audit_events (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
|
||||||
actor TEXT NOT NULL CHECK (actor <> ''),
|
|
||||||
action TEXT NOT NULL CHECK (action <> ''),
|
|
||||||
target TEXT NOT NULL,
|
|
||||||
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
|
||||||
)`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM audit_events WHERE tenant_slug LIKE 'test\_%' ESCAPE '\' OR tenant_slug = $1`, SystemTenant)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return NewLog(pool), pool, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 1: ein sicherheitsrelevanter Vorgang
|
|
||||||
// (hier: fehlgeschlagener Login) erzeugt zuverlaessig genau einen Eintrag.
|
|
||||||
func TestRecord_PersistsExactlyOneEventPerSecurityIncident(t *testing.T) {
|
|
||||||
log, pool, cleanup := setupAuditTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
err := log.Record(ctx, Event{
|
|
||||||
TenantSlug: "test_acme",
|
|
||||||
Actor: "alice@example.com",
|
|
||||||
Action: "iam.login_failed",
|
|
||||||
Target: "user:alice@example.com",
|
|
||||||
Metadata: map[string]any{"reason": "falsches passwort"},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("record: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
count, err := log.CountByTenant(ctx, "test_acme")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("count: %v", err)
|
|
||||||
}
|
|
||||||
if count != 1 {
|
|
||||||
t.Fatalf("erwartet genau 1 audit-eintrag, habe %d", count)
|
|
||||||
}
|
|
||||||
|
|
||||||
var actor, action, target string
|
|
||||||
if err := pool.QueryRow(ctx, `
|
|
||||||
SELECT actor, action, target FROM audit_events WHERE tenant_slug = 'test_acme'
|
|
||||||
`).Scan(&actor, &action, &target); err != nil {
|
|
||||||
t.Fatalf("eintrag lesen: %v", err)
|
|
||||||
}
|
|
||||||
if actor != "alice@example.com" || action != "iam.login_failed" || target != "user:alice@example.com" {
|
|
||||||
t.Fatalf("eintrag unerwartet: actor=%q action=%q target=%q", actor, action, target)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2 (App-Ebene): fehlender Tenant-Bezug wird
|
|
||||||
// bereits vom zentralen Schreibpfad abgewiesen.
|
|
||||||
func TestRecord_RejectsMissingTenant(t *testing.T) {
|
|
||||||
log, _, cleanup := setupAuditTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
err := log.Record(ctx, Event{TenantSlug: "", Actor: "alice", Action: "irgendwas"})
|
|
||||||
if !errors.Is(err, ErrMissingTenant) {
|
|
||||||
t.Fatalf("erwartet ErrMissingTenant, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2 (DB-Ebene): selbst ein direkter INSERT,
|
|
||||||
// der Log.Record umgeht, wird durch die CHECK-Constraint verhindert — der
|
|
||||||
// Schutz haengt nicht allein von der Go-Validierung ab.
|
|
||||||
func TestConstraint_RejectsMissingTenantAtDatabaseLevel(t *testing.T) {
|
|
||||||
_, pool, cleanup := setupAuditTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
_, err := pool.Exec(ctx, `
|
|
||||||
INSERT INTO audit_events (tenant_slug, actor, action, target)
|
|
||||||
VALUES ('', 'alice', 'irgendwas', 'ziel')
|
|
||||||
`)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("erwartet fehler durch CHECK-constraint bei leerem tenant_slug, habe nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRecord_RejectsMissingActorAndAction(t *testing.T) {
|
|
||||||
log, _, cleanup := setupAuditTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "", Action: "x"}); !errors.Is(err, ErrMissingActor) {
|
|
||||||
t.Fatalf("erwartet ErrMissingActor, habe %v", err)
|
|
||||||
}
|
|
||||||
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "alice", Action: ""}); !errors.Is(err, ErrMissingAction) {
|
|
||||||
t.Fatalf("erwartet ErrMissingAction, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRecord_SystemTenantForCrossTenantEvents(t *testing.T) {
|
|
||||||
log, _, cleanup := setupAuditTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := log.Record(ctx, Event{TenantSlug: SystemTenant, Actor: "superadmin", Action: "tenant.provisioned", Target: "tenant:acme"}); err != nil {
|
|
||||||
t.Fatalf("record mit SystemTenant: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -10,15 +10,8 @@ import (
|
|||||||
// connection info, superadmin accounts) — see nexarch-state.json
|
// connection info, superadmin accounts) — see nexarch-state.json
|
||||||
// multi_tenancy: Modell C (physisch getrennte DB pro Mandant).
|
// multi_tenancy: Modell C (physisch getrennte DB pro Mandant).
|
||||||
type Config struct {
|
type Config struct {
|
||||||
ListenAddr string
|
ListenAddr string
|
||||||
// RegistryDSN verbindet zur Control-Plane-Registry-Datenbank.
|
|
||||||
RegistryDSN string
|
RegistryDSN string
|
||||||
// AdminDSN verbindet zur Wartungsdatenbank (z.B. "postgres") und wird nur
|
|
||||||
// fuer CREATE/DROP DATABASE beim Tenant-Provisioning verwendet.
|
|
||||||
AdminDSN string
|
|
||||||
// TenantDSNTemplate enthaelt genau ein "%s" als Platzhalter fuer den
|
|
||||||
// Datenbanknamen einer neu provisionierten Tenant-Datenbank.
|
|
||||||
TenantDSNTemplate string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func Load() (Config, error) {
|
func Load() (Config, error) {
|
||||||
@@ -27,25 +20,10 @@ func Load() (Config, error) {
|
|||||||
return Config{}, fmt.Errorf("NEXARCH_REGISTRY_DSN not set")
|
return Config{}, fmt.Errorf("NEXARCH_REGISTRY_DSN not set")
|
||||||
}
|
}
|
||||||
|
|
||||||
adminDSN := os.Getenv("NEXARCH_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
return Config{}, fmt.Errorf("NEXARCH_ADMIN_DSN not set")
|
|
||||||
}
|
|
||||||
|
|
||||||
dsnTemplate := os.Getenv("NEXARCH_TENANT_DSN_TEMPLATE")
|
|
||||||
if dsnTemplate == "" {
|
|
||||||
return Config{}, fmt.Errorf("NEXARCH_TENANT_DSN_TEMPLATE not set")
|
|
||||||
}
|
|
||||||
|
|
||||||
addr := os.Getenv("NEXARCH_LISTEN_ADDR")
|
addr := os.Getenv("NEXARCH_LISTEN_ADDR")
|
||||||
if addr == "" {
|
if addr == "" {
|
||||||
addr = ":8080"
|
addr = ":8080"
|
||||||
}
|
}
|
||||||
|
|
||||||
return Config{
|
return Config{ListenAddr: addr, RegistryDSN: dsn}, nil
|
||||||
ListenAddr: addr,
|
|
||||||
RegistryDSN: dsn,
|
|
||||||
AdminDSN: adminDSN,
|
|
||||||
TenantDSNTemplate: dsnTemplate,
|
|
||||||
}, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
// Package flag implementiert Core LIC-02: einen Feature-Flag-Dienst mit
|
|
||||||
// Strategien (global an/aus, Prozentsatz, Tenant-Zielgruppe) als Kernfunktion
|
|
||||||
// des Core-Dienstes selbst — keine zusaetzliche Infrastruktur (Unleash-Server
|
|
||||||
// + eigene DB), siehe "bewusst vermeiden" im LIC-02-Ticket.
|
|
||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"hash/fnv"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrNotFound = errors.New("flag: nicht gefunden")
|
|
||||||
|
|
||||||
// Flag ist die zentrale Definition — Auswertung (Evaluate) ist bewusst davon
|
|
||||||
// getrennt (Unleash-Prinzip: Flag-Verwaltung vs. Flag-Auswertung).
|
|
||||||
type Flag struct {
|
|
||||||
Key string
|
|
||||||
Enabled bool
|
|
||||||
RolloutPercentage int
|
|
||||||
TargetTenantSlugs []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store ist die Verwaltungsseite (Admin): Flags definieren/lesen.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) Set(ctx context.Context, f Flag) error {
|
|
||||||
if f.TargetTenantSlugs == nil {
|
|
||||||
f.TargetTenantSlugs = []string{} // pgx uebertraegt ein nil-Slice sonst als SQL NULL statt leerem Array.
|
|
||||||
}
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO feature_flags (key, enabled, rollout_percentage, target_tenant_slugs, updated_at)
|
|
||||||
VALUES ($1, $2, $3, $4, now())
|
|
||||||
ON CONFLICT (key) DO UPDATE SET
|
|
||||||
enabled = $2, rollout_percentage = $3, target_tenant_slugs = $4, updated_at = now()
|
|
||||||
`, f.Key, f.Enabled, f.RolloutPercentage, f.TargetTenantSlugs)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("flag speichern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) Get(ctx context.Context, key string) (Flag, error) {
|
|
||||||
var f Flag
|
|
||||||
row := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT key, enabled, rollout_percentage, target_tenant_slugs
|
|
||||||
FROM feature_flags WHERE key = $1
|
|
||||||
`, key)
|
|
||||||
if err := row.Scan(&f.Key, &f.Enabled, &f.RolloutPercentage, &f.TargetTenantSlugs); err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Flag{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return Flag{}, fmt.Errorf("flag lesen: %w", err)
|
|
||||||
}
|
|
||||||
return f, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// evaluate wendet die Strategien in fester Reihenfolge an: globaler
|
|
||||||
// An/Aus-Schalter zuerst, dann Tenant-Zielgruppe, dann Prozentsatz-Rollout.
|
|
||||||
// Ein unbekannter/nicht getroffener Fall ergibt false — Fail-Safe-Default,
|
|
||||||
// kein Feature wird versehentlich aktiv.
|
|
||||||
func evaluate(f Flag, tenantSlug string) bool {
|
|
||||||
if f.Enabled {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
for _, target := range f.TargetTenantSlugs {
|
|
||||||
if target == tenantSlug {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if f.RolloutPercentage > 0 {
|
|
||||||
h := fnv.New32a()
|
|
||||||
_, _ = h.Write([]byte(f.Key + "|" + tenantSlug))
|
|
||||||
return int(h.Sum32()%100) < f.RolloutPercentage
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestEvaluate_GlobalEnabled(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", Enabled: true}
|
|
||||||
if !evaluate(f, "irgendein-tenant") {
|
|
||||||
t.Fatal("global aktiviertes flag sollte fuer jeden tenant true liefern")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Zielgruppen-Strategie.
|
|
||||||
func TestEvaluate_TargetTenantStrategy(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", Enabled: false, TargetTenantSlugs: []string{"acme"}}
|
|
||||||
if !evaluate(f, "acme") {
|
|
||||||
t.Fatal("erwartet true fuer tenant in zielgruppe")
|
|
||||||
}
|
|
||||||
if evaluate(f, "globex") {
|
|
||||||
t.Fatal("erwartet false fuer tenant ausserhalb der zielgruppe")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluate_RolloutPercentageBoundaries(t *testing.T) {
|
|
||||||
full := Flag{Key: "k", RolloutPercentage: 100}
|
|
||||||
if !evaluate(full, "beliebiger-tenant-1") || !evaluate(full, "beliebiger-tenant-2") {
|
|
||||||
t.Fatal("100% rollout sollte immer true liefern")
|
|
||||||
}
|
|
||||||
|
|
||||||
none := Flag{Key: "k", RolloutPercentage: 0}
|
|
||||||
if evaluate(none, "beliebiger-tenant") {
|
|
||||||
t.Fatal("0% rollout ohne enabled/zielgruppe sollte false liefern")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluate_RolloutIsDeterministicPerTenant(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", RolloutPercentage: 50}
|
|
||||||
first := evaluate(f, "stabiler-tenant")
|
|
||||||
for i := 0; i < 5; i++ {
|
|
||||||
if evaluate(f, "stabiler-tenant") != first {
|
|
||||||
t.Fatal("rollout-auswertung sollte fuer denselben tenant/key stabil sein")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultCacheTTL ist die dokumentierte Cache-Invalidierungszeit
|
|
||||||
// (Akzeptanzkriterium 2/3): eine Aenderung wirkt spaetestens nach dieser
|
|
||||||
// Zeit auf allen Core-Instanzen, ohne dass ein Dienst neu gestartet werden
|
|
||||||
// muss (Akzeptanzkriterium 3).
|
|
||||||
const DefaultCacheTTL = 5 * time.Second
|
|
||||||
|
|
||||||
type cacheEntry struct {
|
|
||||||
flag Flag
|
|
||||||
expiresAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service ist die Auswertungsseite (SDK/Client-Analogon zu Unleash) mit
|
|
||||||
// lokalem TTL-Cache. Bewusst getrennt von Store (Verwaltung).
|
|
||||||
type Service struct {
|
|
||||||
store *Store
|
|
||||||
ttl time.Duration
|
|
||||||
|
|
||||||
mu sync.RWMutex
|
|
||||||
cache map[string]cacheEntry
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(store *Store, ttl time.Duration) *Service {
|
|
||||||
if ttl <= 0 {
|
|
||||||
ttl = DefaultCacheTTL
|
|
||||||
}
|
|
||||||
return &Service{store: store, ttl: ttl, cache: make(map[string]cacheEntry)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsEnabled wertet ein Flag fuer einen Tenant aus. Liefert IMMER einen
|
|
||||||
// bool ohne Fehlerwert — ein nicht erreichbarer Flag-Dienst darf abhaengige
|
|
||||||
// Aufrufer nicht zum Absturz bringen oder zu Fehlerbehandlungscode zwingen,
|
|
||||||
// der leicht vergessen wird (Akzeptanzkriterium 3 / Pruefung 3: dokumentiertes
|
|
||||||
// Fallback-Verhalten = false, ggf. aus dem zuletzt bekannten Zwischenspeicher).
|
|
||||||
func (s *Service) IsEnabled(ctx context.Context, tenantSlug, key string) bool {
|
|
||||||
f, ok := s.resolve(ctx, key)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return evaluate(f, tenantSlug)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Service) resolve(ctx context.Context, key string) (Flag, bool) {
|
|
||||||
s.mu.RLock()
|
|
||||||
entry, exists := s.cache[key]
|
|
||||||
fresh := exists && time.Now().Before(entry.expiresAt)
|
|
||||||
s.mu.RUnlock()
|
|
||||||
if fresh {
|
|
||||||
return entry.flag, true
|
|
||||||
}
|
|
||||||
|
|
||||||
f, err := s.store.Get(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
if exists {
|
|
||||||
slog.Warn("feature-flag-dienst nicht erreichbar, nutze zwischengespeicherten stand",
|
|
||||||
"flag_key", key, "error", err)
|
|
||||||
return entry.flag, true
|
|
||||||
}
|
|
||||||
slog.Warn("feature-flag-dienst nicht erreichbar, kein zwischengespeicherter stand vorhanden, fallback: deaktiviert",
|
|
||||||
"flag_key", key, "error", err)
|
|
||||||
return Flag{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
s.mu.Lock()
|
|
||||||
s.cache[key] = cacheEntry{flag: f, expiresAt: time.Now().Add(s.ttl)}
|
|
||||||
s.mu.Unlock()
|
|
||||||
return f, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Invalidate erzwingt beim naechsten IsEnabled-Aufruf ein sofortiges Neuladen
|
|
||||||
// aus der Datenbank statt auf den TTL-Ablauf zu warten — wird nach Store.Set
|
|
||||||
// auf derselben Instanz aufgerufen, damit der Schreiber die eigene Aenderung
|
|
||||||
// ohne Wartezeit sieht. Andere Core-Instanzen sehen sie spaetestens nach
|
|
||||||
// DefaultCacheTTL (siehe Akzeptanzkriterium 3).
|
|
||||||
func (s *Service) Invalidate(key string) {
|
|
||||||
s.mu.Lock()
|
|
||||||
delete(s.cache, key)
|
|
||||||
s.mu.Unlock()
|
|
||||||
}
|
|
||||||
@@ -1,179 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupFlagStoreTest(t *testing.T) (*Store, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS feature_flags (
|
|
||||||
key TEXT PRIMARY KEY,
|
|
||||||
enabled BOOLEAN NOT NULL DEFAULT false,
|
|
||||||
rollout_percentage INT NOT NULL DEFAULT 0,
|
|
||||||
target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
)`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM feature_flags WHERE key LIKE 'test\_%' ESCAPE '\'`)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return NewStore(pool), cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Zielgruppen-Strategie liefert im Test
|
|
||||||
// die erwartete Auswertung.
|
|
||||||
func TestService_TargetTenantStrategy(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_target_flag", TargetTenantSlugs: []string{"acme"}}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_target_flag") {
|
|
||||||
t.Fatal("erwartet true fuer tenant in zielgruppe")
|
|
||||||
}
|
|
||||||
if svc.IsEnabled(ctx, "globex", "test_target_flag") {
|
|
||||||
t.Fatal("erwartet false fuer tenant ausserhalb der zielgruppe")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + 3 + Pruefung 1: Flag-Aenderung wirkt innerhalb der
|
|
||||||
// dokumentierten Cache-Invalidierungszeit, automatisiert gemessen.
|
|
||||||
func TestService_CacheInvalidationTiming(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const ttl = 150 * time.Millisecond
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_ttl_flag", Enabled: false}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, ttl)
|
|
||||||
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
t.Fatal("erwartet false vor der aenderung")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Aenderung "auf einer anderen instanz" simulieren: direkt ueber den
|
|
||||||
// Store, ohne svc.Invalidate aufzurufen.
|
|
||||||
changedAt := time.Now()
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_ttl_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sofort danach sollte der Cache noch den alten Stand liefern.
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
t.Fatal("cache haette den alten (false) stand liefern sollen, direkt nach der aenderung")
|
|
||||||
}
|
|
||||||
|
|
||||||
deadline := changedAt.Add(ttl + 100*time.Millisecond)
|
|
||||||
for time.Now().Before(deadline) {
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
elapsed := time.Since(changedAt)
|
|
||||||
t.Logf("aenderung wurde nach %s wirksam (ziel: innerhalb %s + toleranz)", elapsed, ttl)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
}
|
|
||||||
t.Fatalf("aenderung wurde nicht innerhalb von %s wirksam", deadline.Sub(changedAt))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestService_InvalidateForcesImmediateRefresh(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_invalidate_flag", Enabled: false}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour) // lange TTL, damit Invalidate den unterschied macht
|
|
||||||
_ = svc.IsEnabled(ctx, "acme", "test_invalidate_flag")
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_invalidate_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc.Invalidate("test_invalidate_flag")
|
|
||||||
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_invalidate_flag") {
|
|
||||||
t.Fatal("erwartet sofort sichtbaren neuen stand nach Invalidate")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: Ausfall des Flag-Dienstes fuehrt zu
|
|
||||||
// dokumentiertem Fallback-Verhalten, nicht zum Absturz.
|
|
||||||
func TestService_FallsBackOnStoreFailure(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_fallback_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
|
|
||||||
// Cache vorwaermen, waehrend die DB noch erreichbar ist.
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet true bei funktionierender db")
|
|
||||||
}
|
|
||||||
|
|
||||||
brokenPool, err := pgxpool.New(ctx, "postgresql://nonexistent-host-fuer-test:5432/x?connect_timeout=1")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("broken pool erstellen (sollte nicht sofort verbinden): %v", err)
|
|
||||||
}
|
|
||||||
brokenStore := NewStore(brokenPool)
|
|
||||||
|
|
||||||
svcWithCache := NewService(brokenStore, time.Nanosecond) // TTL sofort abgelaufen, erzwingt reload-versuch
|
|
||||||
svcWithCache.mu.Lock()
|
|
||||||
svcWithCache.cache["test_fallback_flag"] = cacheEntry{
|
|
||||||
flag: Flag{Key: "test_fallback_flag", Enabled: true},
|
|
||||||
expiresAt: time.Now().Add(-time.Hour), // bereits abgelaufen
|
|
||||||
}
|
|
||||||
svcWithCache.mu.Unlock()
|
|
||||||
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("IsEnabled hat gepanict statt einen fallback zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if !svcWithCache.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet fallback auf zwischengespeicherten (true) stand bei db-ausfall")
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Voellig frischer Dienst ohne jeglichen cache + kaputte db -> sicherer
|
|
||||||
// default false, kein absturz.
|
|
||||||
freshSvc := NewService(brokenStore, time.Hour)
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("IsEnabled hat gepanict: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if freshSvc.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet fail-safe false ohne cache und mit kaputter db")
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
// Package license implementiert Core LIC-01: Lizenzmodell je Tenant (Plan,
|
|
||||||
// Modul-Umfang, Laufzeit) und die kryptographische Pruefung signierter
|
|
||||||
// Lizenzschluessel. Feature-Flag-AUSWERTUNG zur Laufzeit (LIC-02) und die
|
|
||||||
// Verwaltungsoberflaeche (LIC-04) sind ausdruecklich nicht Teil dieses Pakets
|
|
||||||
// — hier geht es nur um Ausstellung/Validierung/Persistenz (Unleash-Vorbild:
|
|
||||||
// klare Trennung Flag-Verwaltung vs. Flag-Auswertung).
|
|
||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/ed25519"
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrInvalidSignature = errors.New("license: signatur ungueltig")
|
|
||||||
ErrMalformedKey = errors.New("license: lizenzschluessel hat ungueltiges format")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Payload ist der signierte Lizenzinhalt (Akzeptanzkriterium 3: Plan,
|
|
||||||
// Modul-Liste, Laufzeit).
|
|
||||||
type Payload struct {
|
|
||||||
TenantSlug string `json:"tenant_slug"`
|
|
||||||
Plan string `json:"plan"`
|
|
||||||
Modules []string `json:"modules"`
|
|
||||||
IssuedAt time.Time `json:"issued_at"`
|
|
||||||
ValidUntil time.Time `json:"valid_until"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issuer stellt signierte Lizenzschluessel aus. Haelt den PRIVATEN
|
|
||||||
// Ed25519-Schluessel — lebt in der Praxis beim Lizenzgeber, nicht im
|
|
||||||
// laufenden Core-Prozess (der nur den Validator mit dem oeffentlichen
|
|
||||||
// Schluessel braucht).
|
|
||||||
type Issuer struct {
|
|
||||||
priv ed25519.PrivateKey
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewIssuer(priv ed25519.PrivateKey) *Issuer {
|
|
||||||
return &Issuer{priv: priv}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issue liefert den Lizenzschluessel im Format base64(payload-json) "." base64(signatur).
|
|
||||||
func (i *Issuer) Issue(payload Payload) (string, error) {
|
|
||||||
raw, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("payload serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
sig := ed25519.Sign(i.priv, raw)
|
|
||||||
|
|
||||||
return base64.RawURLEncoding.EncodeToString(raw) + "." + base64.RawURLEncoding.EncodeToString(sig), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validator prueft Lizenzschluessel gegen den OEFFENTLICHEN Ed25519-Schluessel
|
|
||||||
// — das ist alles, was der laufende Core-Prozess kennen muss.
|
|
||||||
type Validator struct {
|
|
||||||
pub ed25519.PublicKey
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewValidator(pub ed25519.PublicKey) *Validator {
|
|
||||||
return &Validator{pub: pub}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse prueft die Signatur (Akzeptanzkriterium 1 / Pruefung 1) und liefert
|
|
||||||
// bei Erfolg den entschluesselten Payload. Ein manipulierter Schluessel wird
|
|
||||||
// hier zuverlaessig erkannt, unabhaengig davon, ob die Laufzeit noch gueltig
|
|
||||||
// waere — Signaturpruefung und Ablaufpruefung sind bewusst getrennt
|
|
||||||
// (Signatur bei Einspielen, Ablauf bei jeder Nutzung, siehe Store.RequireActive).
|
|
||||||
func (v *Validator) Parse(key string) (Payload, error) {
|
|
||||||
rawPart, sigPart, ok := splitOnce(key, '.')
|
|
||||||
if !ok {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
|
|
||||||
raw, err := base64.RawURLEncoding.DecodeString(rawPart)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
sig, err := base64.RawURLEncoding.DecodeString(sigPart)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
|
|
||||||
if !ed25519.Verify(v.pub, raw, sig) {
|
|
||||||
return Payload{}, ErrInvalidSignature
|
|
||||||
}
|
|
||||||
|
|
||||||
var p Payload
|
|
||||||
if err := json.Unmarshal(raw, &p); err != nil {
|
|
||||||
// Signatur war gueltig, aber Payload nicht mehr parsebar — sollte bei
|
|
||||||
// unveraenderten Schluesseln nie vorkommen, trotzdem kein Panic.
|
|
||||||
return Payload{}, fmt.Errorf("%w: payload nicht lesbar", ErrMalformedKey)
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func splitOnce(s string, sep byte) (before, after string, ok bool) {
|
|
||||||
for i := 0; i < len(s); i++ {
|
|
||||||
if s[i] == sep {
|
|
||||||
return s[:i], s[i+1:], true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return "", "", false
|
|
||||||
}
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func testKeyPair(t *testing.T) (ed25519.PublicKey, ed25519.PrivateKey) {
|
|
||||||
t.Helper()
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("schluesselpaar erzeugen: %v", err)
|
|
||||||
}
|
|
||||||
return pub, priv
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssueAndParse_RoundTrip(t *testing.T) {
|
|
||||||
pub, priv := testKeyPair(t)
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
payload := Payload{
|
|
||||||
TenantSlug: "acme",
|
|
||||||
Plan: "pro",
|
|
||||||
Modules: []string{"dms", "mail"},
|
|
||||||
IssuedAt: time.Now().Truncate(time.Second),
|
|
||||||
ValidUntil: time.Now().Add(365 * 24 * time.Hour).Truncate(time.Second),
|
|
||||||
}
|
|
||||||
|
|
||||||
key, err := issuer.Issue(payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := validator.Parse(key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if got.TenantSlug != payload.TenantSlug || got.Plan != payload.Plan || len(got.Modules) != 2 {
|
|
||||||
t.Fatalf("payload nach parse unerwartet: %+v", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 1: manipulierter Schluessel wird zuverlaessig erkannt.
|
|
||||||
func TestParse_RejectsTamperedKey(t *testing.T) {
|
|
||||||
pub, priv := testKeyPair(t)
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
key, err := issuer.Issue(Payload{TenantSlug: "acme", Plan: "pro", ValidUntil: time.Now().Add(time.Hour)})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ein Zeichen im signierten Teil aendern.
|
|
||||||
tampered := []byte(key)
|
|
||||||
changed := false
|
|
||||||
for i, c := range tampered {
|
|
||||||
if c != '.' {
|
|
||||||
if c == 'A' {
|
|
||||||
tampered[i] = 'B'
|
|
||||||
} else {
|
|
||||||
tampered[i] = 'A'
|
|
||||||
}
|
|
||||||
changed = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !changed {
|
|
||||||
t.Fatal("testaufbau fehlerhaft: nichts zum manipulieren gefunden")
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := validator.Parse(string(tampered)); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParse_RejectsWrongKeyPair(t *testing.T) {
|
|
||||||
_, priv := testKeyPair(t)
|
|
||||||
otherPub, _ := testKeyPair(t)
|
|
||||||
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(otherPub) // falscher oeffentlicher Schluessel
|
|
||||||
|
|
||||||
key, err := issuer.Issue(Payload{TenantSlug: "acme", Plan: "pro"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := validator.Parse(key); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParse_RejectsMalformedKey(t *testing.T) {
|
|
||||||
pub, _ := testKeyPair(t)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
cases := []string{"", "keine-punkt-trennung", "!!!.!!!"}
|
|
||||||
for _, c := range cases {
|
|
||||||
if _, err := validator.Parse(c); !errors.Is(err, ErrMalformedKey) {
|
|
||||||
t.Fatalf("Parse(%q): erwartet ErrMalformedKey, habe %v", c, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrNoLicense = errors.New("license: kein lizenzdatensatz fuer diesen tenant")
|
|
||||||
ErrLicenseExpired = errors.New("license: lizenz abgelaufen")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Store persistiert den Lizenzumfang je Tenant in der Control-Plane-Registry
|
|
||||||
// (siehe internal/tenant.Registry — dieselbe Datenbank, aber ein eigener,
|
|
||||||
// unabhaengiger Store, um internal/tenant nicht um lizenzfremde Belange zu
|
|
||||||
// erweitern).
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
validator *Validator
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool, validator *Validator) *Store {
|
|
||||||
return &Store{pool: pool, validator: validator}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Install prueft die Signatur des Lizenzschluessels (Akzeptanzkriterium 1)
|
|
||||||
// und ersetzt den bisherigen Lizenzdatensatz des Tenants vollstaendig. Ein
|
|
||||||
// bereits abgelaufener, aber korrekt signierter Schluessel wird trotzdem
|
|
||||||
// gespeichert — der Ablauf wird erst bei der Nutzung (RequireActive)
|
|
||||||
// bewertet, nicht beim Einspielen.
|
|
||||||
func (s *Store) Install(ctx context.Context, tenantID, licenseKey string) (Payload, error) {
|
|
||||||
payload, err := s.validator.Parse(licenseKey)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO tenant_licenses (tenant_id, plan, modules, issued_at, valid_until, raw_key, installed_at)
|
|
||||||
VALUES ($1, $2, $3, $4, $5, $6, now())
|
|
||||||
ON CONFLICT (tenant_id) DO UPDATE SET
|
|
||||||
plan = $2, modules = $3, issued_at = $4, valid_until = $5, raw_key = $6, installed_at = now()
|
|
||||||
`, tenantID, payload.Plan, payload.Modules, payload.IssuedAt, payload.ValidUntil, licenseKey)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, fmt.Errorf("lizenz speichern: %w", err)
|
|
||||||
}
|
|
||||||
return payload, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) get(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
var p Payload
|
|
||||||
row := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT plan, modules, issued_at, valid_until
|
|
||||||
FROM tenant_licenses WHERE tenant_id = $1
|
|
||||||
`, tenantID)
|
|
||||||
if err := row.Scan(&p.Plan, &p.Modules, &p.IssuedAt, &p.ValidUntil); err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Payload{}, ErrNoLicense
|
|
||||||
}
|
|
||||||
return Payload{}, fmt.Errorf("lizenz lesen: %w", err)
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Status liefert den persistierten Lizenzumfang unabhaengig vom Ablauf
|
|
||||||
// (Akzeptanzkriterium 3: Plan, Modul-Liste, Laufzeit abfragbar).
|
|
||||||
func (s *Store) Status(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
return s.get(ctx, tenantID)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireActive liefert den Lizenzumfang NUR, wenn die Lizenz noch nicht
|
|
||||||
// abgelaufen ist — sonst ErrLicenseExpired statt eines harten Fehlers/Panics
|
|
||||||
// (Akzeptanzkriterium 2: definierter eingeschraenkter Zustand). Aufrufende
|
|
||||||
// Module (LIC-02/03) entscheiden, was "eingeschraenkt" konkret bedeutet.
|
|
||||||
func (s *Store) RequireActive(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
p, err := s.get(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, err
|
|
||||||
}
|
|
||||||
if time.Now().After(p.ValidUntil) {
|
|
||||||
return Payload{}, ErrLicenseExpired
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStoreTest(t *testing.T) (*Store, *Issuer, string, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS tenants (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
slug TEXT NOT NULL UNIQUE,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
db_name TEXT NOT NULL UNIQUE,
|
|
||||||
db_dsn TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS tenant_licenses (
|
|
||||||
tenant_id UUID PRIMARY KEY REFERENCES tenants(id),
|
|
||||||
plan TEXT NOT NULL,
|
|
||||||
modules TEXT[] NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL,
|
|
||||||
valid_until TIMESTAMPTZ NOT NULL,
|
|
||||||
raw_key TEXT NOT NULL,
|
|
||||||
installed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var tenantID string
|
|
||||||
if err := pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO tenants (slug, name, db_name, db_dsn)
|
|
||||||
VALUES ('lic_test_tenant', 'Lic Test', 'tenant_lic_test', 'unused')
|
|
||||||
RETURNING id
|
|
||||||
`).Scan(&tenantID); err != nil {
|
|
||||||
t.Fatalf("test-tenant anlegen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("schluesselpaar: %v", err)
|
|
||||||
}
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
store := NewStore(pool, NewValidator(pub))
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenant_licenses WHERE tenant_id = $1`, tenantID)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenants WHERE id = $1`, tenantID)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return store, issuer, tenantID, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3: Lizenzumfang persistiert und abfragbar.
|
|
||||||
func TestStore_InstallAndStatus(t *testing.T) {
|
|
||||||
store, issuer, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
payload := Payload{
|
|
||||||
TenantSlug: "lic_test_tenant",
|
|
||||||
Plan: "enterprise",
|
|
||||||
Modules: []string{"dms", "mail", "archive"},
|
|
||||||
IssuedAt: time.Now().Truncate(time.Second),
|
|
||||||
ValidUntil: time.Now().Add(30 * 24 * time.Hour).Truncate(time.Second),
|
|
||||||
}
|
|
||||||
key, err := issuer.Issue(payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); err != nil {
|
|
||||||
t.Fatalf("install: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
status, err := store.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("status: %v", err)
|
|
||||||
}
|
|
||||||
if status.Plan != "enterprise" || len(status.Modules) != 3 {
|
|
||||||
t.Fatalf("status unerwartet: %+v", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_InstallRejectsInvalidSignature(t *testing.T) {
|
|
||||||
store, _, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
_, otherPriv, _ := ed25519.GenerateKey(nil)
|
|
||||||
foreignIssuer := NewIssuer(otherPriv) // signiert mit falschem schluessel
|
|
||||||
|
|
||||||
key, err := foreignIssuer.Issue(Payload{TenantSlug: "lic_test_tenant", Plan: "pro", ValidUntil: time.Now().Add(time.Hour)})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2: abgelaufene Lizenz fuehrt zu definiertem
|
|
||||||
// eingeschraenktem Zustand (ErrLicenseExpired), nicht zu einem Absturz.
|
|
||||||
func TestStore_RequireActive_DetectsExpiry(t *testing.T) {
|
|
||||||
store, issuer, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
expired := Payload{
|
|
||||||
TenantSlug: "lic_test_tenant",
|
|
||||||
Plan: "pro",
|
|
||||||
Modules: []string{"dms"},
|
|
||||||
IssuedAt: time.Now().Add(-48 * time.Hour),
|
|
||||||
ValidUntil: time.Now().Add(-24 * time.Hour), // bereits abgelaufen
|
|
||||||
}
|
|
||||||
key, err := issuer.Issue(expired)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Einspielen einer bereits abgelaufenen, aber korrekt signierten Lizenz
|
|
||||||
// muss funktionieren (Ablauf wird erst bei Nutzung bewertet).
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); err != nil {
|
|
||||||
t.Fatalf("install sollte trotz ablauf funktionieren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("RequireActive hat gepanict statt einen fehler zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if _, err := store.RequireActive(ctx, tenantID); !errors.Is(err, ErrLicenseExpired) {
|
|
||||||
t.Fatalf("erwartet ErrLicenseExpired, habe %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Aber der Umfang bleibt weiterhin abfragbar (Status, im Unterschied zu RequireActive).
|
|
||||||
status, err := store.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("status sollte trotz ablauf funktionieren: %v", err)
|
|
||||||
}
|
|
||||||
if status.Plan != "pro" {
|
|
||||||
t.Fatalf("status unerwartet: %+v", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_RequireActive_NoLicense(t *testing.T) {
|
|
||||||
store, _, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.RequireActive(ctx, tenantID); !errors.Is(err, ErrNoLicense) {
|
|
||||||
t.Fatalf("erwartet ErrNoLicense, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
package moduleregistry
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/rand"
|
|
||||||
"crypto/sha256"
|
|
||||||
"crypto/subtle"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrModuleNotRegistered = errors.New("moduleregistry: modul muss vor provisionierung registriert sein")
|
|
||||||
ErrInvalidCredential = errors.New("moduleregistry: ungueltiges oder fehlendes service-credential")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Provision stellt ein Service-Credential (Client-ID + Secret) fuer eine
|
|
||||||
// Modul-Instanz aus (Akzeptanzkriterium 4). Das Secret wird NUR beim
|
|
||||||
// Ausstellen im Klartext zurueckgegeben, gespeichert wird ausschliesslich
|
|
||||||
// dessen SHA-256-Hash.
|
|
||||||
func (r *Registry) Provision(ctx context.Context, moduleName string) (clientID, secret string, err error) {
|
|
||||||
if _, err := r.Get(ctx, moduleName); err != nil {
|
|
||||||
if errors.Is(err, ErrModuleNotFound) {
|
|
||||||
return "", "", ErrModuleNotRegistered
|
|
||||||
}
|
|
||||||
return "", "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
clientID, err = randomToken(16)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", fmt.Errorf("client-id erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
secret, err = randomToken(32)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", fmt.Errorf("secret erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
hash := hashSecret(secret)
|
|
||||||
|
|
||||||
_, err = r.pool.Exec(ctx, `
|
|
||||||
INSERT INTO module_credentials (module_name, client_id, secret_hash, issued_at)
|
|
||||||
VALUES ($1, $2, $3, now())
|
|
||||||
ON CONFLICT (module_name) DO UPDATE SET client_id = $2, secret_hash = $3, issued_at = now()
|
|
||||||
`, moduleName, clientID, hash)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", fmt.Errorf("credential speichern: %w", err)
|
|
||||||
}
|
|
||||||
return clientID, secret, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Authenticate prueft ein Service-Credential timing-safe (Referenzmuster
|
|
||||||
// siehe AUD-02) — Aufrufe ohne gueltiges Credential werden abgelehnt
|
|
||||||
// (Akzeptanzkriterium 4 / Pruefung 4).
|
|
||||||
func (r *Registry) Authenticate(ctx context.Context, clientID, secret string) (moduleName string, ok bool, err error) {
|
|
||||||
if clientID == "" || secret == "" {
|
|
||||||
return "", false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var storedHash []byte
|
|
||||||
err = r.pool.QueryRow(ctx, `
|
|
||||||
SELECT module_name, secret_hash FROM module_credentials WHERE client_id = $1
|
|
||||||
`, clientID).Scan(&moduleName, &storedHash)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return "", false, nil
|
|
||||||
}
|
|
||||||
return "", false, fmt.Errorf("credential lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !timingSafeEqual(hashSecret(secret), storedHash) {
|
|
||||||
return "", false, nil
|
|
||||||
}
|
|
||||||
return moduleName, true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func randomToken(n int) (string, error) {
|
|
||||||
buf := make([]byte, n)
|
|
||||||
if _, err := rand.Read(buf); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return hex.EncodeToString(buf), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func hashSecret(secret string) []byte {
|
|
||||||
sum := sha256.Sum256([]byte(secret))
|
|
||||||
return sum[:]
|
|
||||||
}
|
|
||||||
|
|
||||||
// timingSafeEqual folgt derselben Referenzimplementierung wie AUD-02
|
|
||||||
// (subtle.ConstantTimeCompare) — projektweite Konvention fuer jeden
|
|
||||||
// sicherheitsrelevanten Vergleich.
|
|
||||||
func timingSafeEqual(a, b []byte) bool {
|
|
||||||
if len(a) != len(b) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return subtle.ConstantTimeCompare(a, b) == 1
|
|
||||||
}
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
package moduleregistry
|
|
||||||
|
|
||||||
import "net/http"
|
|
||||||
|
|
||||||
// RequireActiveModule weist Anfragen an ein nicht aktiviertes Modul ZENTRAL
|
|
||||||
// ab, bevor der eigentliche Modul-Handler erreicht wird (Akzeptanzkriterium 2 /
|
|
||||||
// Pruefung 1) — Casbin-Prinzip: Durchsetzung als Middleware statt verstreuter
|
|
||||||
// Pruefungen in jedem Handler. tenantSlug/moduleName werden hier ueber
|
|
||||||
// Query-Parameter gelesen (echte Extraktion aus JWT/Tenant-Kontext ist
|
|
||||||
// API-05/TEN-06, nicht Teil dieser Kachel).
|
|
||||||
func (r *Registry) RequireActiveModule(moduleName string, next http.HandlerFunc) http.HandlerFunc {
|
|
||||||
return func(w http.ResponseWriter, req *http.Request) {
|
|
||||||
tenantSlug := req.URL.Query().Get("tenant")
|
|
||||||
active, err := r.IsActive(req.Context(), tenantSlug, moduleName)
|
|
||||||
if err != nil {
|
|
||||||
http.Error(w, "aktivierungspruefung fehlgeschlagen", http.StatusInternalServerError)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !active {
|
|
||||||
http.Error(w, "modul nicht aktiviert", http.StatusForbidden)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
next(w, req)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireServiceCredential authentifiziert eine Modul-Instanz ueber ihr
|
|
||||||
// Service-Credential (X-Client-Id/X-Client-Secret-Header) BEVOR der
|
|
||||||
// eigentliche Handler erreicht wird (Akzeptanzkriterium 4 / Pruefung 4).
|
|
||||||
func (r *Registry) RequireServiceCredential(next http.HandlerFunc) http.HandlerFunc {
|
|
||||||
return func(w http.ResponseWriter, req *http.Request) {
|
|
||||||
clientID := req.Header.Get("X-Client-Id")
|
|
||||||
secret := req.Header.Get("X-Client-Secret")
|
|
||||||
|
|
||||||
_, ok, err := r.Authenticate(req.Context(), clientID, secret)
|
|
||||||
if err != nil {
|
|
||||||
http.Error(w, "authentifizierung fehlgeschlagen", http.StatusInternalServerError)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !ok {
|
|
||||||
http.Error(w, ErrInvalidCredential.Error(), http.StatusUnauthorized)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
next(w, req)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
// Package moduleregistry implementiert Core API-02: die Registry, in der
|
|
||||||
// sich Fachmodule (DMS, Mail, weitere) mit Metadaten eintragen, gekoppelt an
|
|
||||||
// die Aktivierungspruefung aus LIC-02 (Feature-Flags). Zusaetzlich
|
|
||||||
// authentifiziert die Registry Modul-Instanzen selbst ueber ein bei
|
|
||||||
// Provisionierung ausgestelltes Service-Credential.
|
|
||||||
package moduleregistry
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrMissingName = errors.New("moduleregistry: name darf nicht leer sein")
|
|
||||||
ErrMissingVersion = errors.New("moduleregistry: version darf nicht leer sein")
|
|
||||||
ErrModuleNotFound = errors.New("moduleregistry: modul nicht registriert")
|
|
||||||
)
|
|
||||||
|
|
||||||
type Module struct {
|
|
||||||
Name string
|
|
||||||
Version string
|
|
||||||
RequiredFlags []string
|
|
||||||
}
|
|
||||||
|
|
||||||
type Registry struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
flags *flag.Service
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRegistry(pool *pgxpool.Pool, flags *flag.Service) *Registry {
|
|
||||||
return &Registry{pool: pool, flags: flags}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register traegt ein Modul mit Name, Version und benoetigten Feature-Flags
|
|
||||||
// ein (Akzeptanzkriterium 1). Fehlende Pflichtangaben werden abgewiesen
|
|
||||||
// (Akzeptanzkriterium 1 / Pruefung 2). Erneutes Register desselben Namens
|
|
||||||
// aktualisiert Version/Flags (Redeploy-Fall).
|
|
||||||
func (r *Registry) Register(ctx context.Context, name, version string, requiredFlags []string) (Module, error) {
|
|
||||||
if name == "" {
|
|
||||||
return Module{}, ErrMissingName
|
|
||||||
}
|
|
||||||
if version == "" {
|
|
||||||
return Module{}, ErrMissingVersion
|
|
||||||
}
|
|
||||||
if requiredFlags == nil {
|
|
||||||
requiredFlags = []string{}
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := r.pool.Exec(ctx, `
|
|
||||||
INSERT INTO modules (name, version, required_flags, registered_at)
|
|
||||||
VALUES ($1, $2, $3, now())
|
|
||||||
ON CONFLICT (name) DO UPDATE SET version = $2, required_flags = $3, registered_at = now()
|
|
||||||
`, name, version, requiredFlags)
|
|
||||||
if err != nil {
|
|
||||||
return Module{}, fmt.Errorf("modul registrieren: %w", err)
|
|
||||||
}
|
|
||||||
return Module{Name: name, Version: version, RequiredFlags: requiredFlags}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Registry) Get(ctx context.Context, name string) (Module, error) {
|
|
||||||
var m Module
|
|
||||||
m.Name = name
|
|
||||||
err := r.pool.QueryRow(ctx, `
|
|
||||||
SELECT version, required_flags FROM modules WHERE name = $1
|
|
||||||
`, name).Scan(&m.Version, &m.RequiredFlags)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Module{}, ErrModuleNotFound
|
|
||||||
}
|
|
||||||
return Module{}, fmt.Errorf("modul lesen: %w", err)
|
|
||||||
}
|
|
||||||
return m, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// List liefert alle registrierten Module (Akzeptanzkriterium 3: ueber API
|
|
||||||
// abfragbar, z.B. fuer Statusseite/Lizenzoberflaeche).
|
|
||||||
func (r *Registry) List(ctx context.Context) ([]Module, error) {
|
|
||||||
rows, err := r.pool.Query(ctx, `SELECT name, version, required_flags FROM modules ORDER BY name`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("module auflisten: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []Module
|
|
||||||
for rows.Next() {
|
|
||||||
var m Module
|
|
||||||
if err := rows.Scan(&m.Name, &m.Version, &m.RequiredFlags); err != nil {
|
|
||||||
return nil, fmt.Errorf("modul lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, m)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsActive prueft, ob ein registriertes Modul fuer einen Tenant aktiviert
|
|
||||||
// ist: registriert UND alle benoetigten Feature-Flags sind fuer diesen
|
|
||||||
// Tenant aktiv (Akzeptanzkriterium 2). Ein nicht registriertes Modul gilt
|
|
||||||
// immer als nicht aktiv.
|
|
||||||
func (r *Registry) IsActive(ctx context.Context, tenantSlug, moduleName string) (bool, error) {
|
|
||||||
m, err := r.Get(ctx, moduleName)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, ErrModuleNotFound) {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
return false, err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, flagKey := range m.RequiredFlags {
|
|
||||||
if !r.flags.IsEnabled(ctx, tenantSlug, flagKey) {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
@@ -1,304 +0,0 @@
|
|||||||
package moduleregistry
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*Registry, *flag.Store, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS feature_flags (
|
|
||||||
key TEXT PRIMARY KEY, enabled BOOLEAN NOT NULL DEFAULT false,
|
|
||||||
rollout_percentage INT NOT NULL DEFAULT 0, target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS modules (
|
|
||||||
name TEXT PRIMARY KEY, version TEXT NOT NULL CHECK (version <> ''),
|
|
||||||
required_flags TEXT[] NOT NULL DEFAULT '{}', registered_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS module_credentials (
|
|
||||||
module_name TEXT PRIMARY KEY REFERENCES modules(name),
|
|
||||||
client_id TEXT NOT NULL UNIQUE, secret_hash BYTEA NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
flagStore := flag.NewStore(pool)
|
|
||||||
// Kurze TTL, damit Tests, die den Flag-Store direkt aendern (an
|
|
||||||
// Registry.IsActive vorbei), den neuen Stand ohne manuelles Invalidate
|
|
||||||
// zuverlaessig sehen.
|
|
||||||
flagService := flag.NewService(flagStore, 10*time.Millisecond)
|
|
||||||
registry := NewRegistry(pool, flagService)
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return registry, flagStore, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func uniqueModuleName(t *testing.T) string {
|
|
||||||
return fmt.Sprintf("dms_%d", time.Now().UnixNano())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: fehlende Pflichtangaben abgewiesen.
|
|
||||||
func TestRegister_RejectsMissingFields(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := registry.Register(ctx, "", "1.0", nil); !errors.Is(err, ErrMissingName) {
|
|
||||||
t.Fatalf("erwartet ErrMissingName, habe %v", err)
|
|
||||||
}
|
|
||||||
if _, err := registry.Register(ctx, "dms", "", nil); !errors.Is(err, ErrMissingVersion) {
|
|
||||||
t.Fatalf("erwartet ErrMissingVersion, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRegister_AndGet(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
name := uniqueModuleName(t)
|
|
||||||
|
|
||||||
m, err := registry.Register(ctx, name, "1.2.0", []string{"dms_enabled"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("register: %v", err)
|
|
||||||
}
|
|
||||||
if m.Version != "1.2.0" || len(m.RequiredFlags) != 1 {
|
|
||||||
t.Fatalf("unerwartet: %+v", m)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := registry.Get(ctx, name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
if got.Version != "1.2.0" {
|
|
||||||
t.Fatalf("get version = %q", got.Version)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + 3 + Pruefung 3: konsistente Daten nach
|
|
||||||
// Aktivierung/Deaktivierung eines Moduls.
|
|
||||||
func TestIsActive_ReflectsFlagStateConsistently(t *testing.T) {
|
|
||||||
registry, flagStore, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
name := uniqueModuleName(t)
|
|
||||||
flagKey := name + "_enabled"
|
|
||||||
|
|
||||||
if _, err := registry.Register(ctx, name, "1.0", []string{flagKey}); err != nil {
|
|
||||||
t.Fatalf("register: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
active, err := registry.IsActive(ctx, "acme", name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("is active (vor flag): %v", err)
|
|
||||||
}
|
|
||||||
if active {
|
|
||||||
t.Fatal("erwartet nicht aktiv, solange flag nicht gesetzt ist")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("flag setzen: %v", err)
|
|
||||||
}
|
|
||||||
time.Sleep(20 * time.Millisecond) // TTL abwarten
|
|
||||||
|
|
||||||
active, err = registry.IsActive(ctx, "acme", name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("is active (nach flag an): %v", err)
|
|
||||||
}
|
|
||||||
if !active {
|
|
||||||
t.Fatal("erwartet aktiv, nachdem flag aktiviert wurde")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: false}); err != nil {
|
|
||||||
t.Fatalf("flag zuruecksetzen: %v", err)
|
|
||||||
}
|
|
||||||
time.Sleep(20 * time.Millisecond) // TTL abwarten
|
|
||||||
active, err = registry.IsActive(ctx, "acme", name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("is active (nach flag aus): %v", err)
|
|
||||||
}
|
|
||||||
if active {
|
|
||||||
t.Fatal("erwartet wieder nicht aktiv, nachdem flag deaktiviert wurde")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsActive_UnregisteredModuleIsNeverActive(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
active, err := registry.IsActive(ctx, "acme", "nie-registriert")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("is active: %v", err)
|
|
||||||
}
|
|
||||||
if active {
|
|
||||||
t.Fatal("unregistriertes modul darf nie aktiv sein")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: Anfrage an deaktiviertes Modul wird
|
|
||||||
// zentral abgewiesen, BEVOR die Modul-Logik erreicht wird.
|
|
||||||
func TestRequireActiveModule_BlocksBeforeHandler(t *testing.T) {
|
|
||||||
registry, flagStore, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
name := uniqueModuleName(t)
|
|
||||||
flagKey := name + "_enabled"
|
|
||||||
|
|
||||||
if _, err := registry.Register(ctx, name, "1.0", []string{flagKey}); err != nil {
|
|
||||||
t.Fatalf("register: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
handlerReached := false
|
|
||||||
handler := registry.RequireActiveModule(name, func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
handlerReached = true
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
})
|
|
||||||
|
|
||||||
req := httptest.NewRequest(http.MethodGet, "/modul?tenant=acme", nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
handler(rec, req)
|
|
||||||
if rec.Code != http.StatusForbidden {
|
|
||||||
t.Fatalf("status = %d, want 403", rec.Code)
|
|
||||||
}
|
|
||||||
if handlerReached {
|
|
||||||
t.Fatal("handler haette bei deaktiviertem modul NICHT erreicht werden duerfen")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("flag setzen: %v", err)
|
|
||||||
}
|
|
||||||
req2 := httptest.NewRequest(http.MethodGet, "/modul?tenant=acme", nil)
|
|
||||||
rec2 := httptest.NewRecorder()
|
|
||||||
handler(rec2, req2)
|
|
||||||
if rec2.Code != http.StatusOK {
|
|
||||||
t.Fatalf("status nach aktivierung = %d, want 200", rec2.Code)
|
|
||||||
}
|
|
||||||
if !handlerReached {
|
|
||||||
t.Fatal("handler haette bei aktiviertem modul erreicht werden muessen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 4 + Pruefung 4: gueltiges/ungueltiges Service-Credential.
|
|
||||||
func TestProvisionAndAuthenticate(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
name := uniqueModuleName(t)
|
|
||||||
|
|
||||||
if _, err := registry.Register(ctx, name, "1.0", nil); err != nil {
|
|
||||||
t.Fatalf("register: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
clientID, secret, err := registry.Provision(ctx, name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("provision: %v", err)
|
|
||||||
}
|
|
||||||
if clientID == "" || secret == "" {
|
|
||||||
t.Fatal("erwartet nicht-leere client-id/secret")
|
|
||||||
}
|
|
||||||
|
|
||||||
moduleName, ok, err := registry.Authenticate(ctx, clientID, secret)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("authenticate (korrekt): %v", err)
|
|
||||||
}
|
|
||||||
if !ok || moduleName != name {
|
|
||||||
t.Fatalf("erwartet erfolgreiche authentifizierung fuer %q, habe ok=%v moduleName=%q", name, ok, moduleName)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, ok, err = registry.Authenticate(ctx, clientID, "falsches-secret")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("authenticate (falsch): %v", err)
|
|
||||||
}
|
|
||||||
if ok {
|
|
||||||
t.Fatal("erwartet fehlschlag bei falschem secret")
|
|
||||||
}
|
|
||||||
|
|
||||||
_, ok, err = registry.Authenticate(ctx, "unbekannte-client-id", secret)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("authenticate (unbekannt): %v", err)
|
|
||||||
}
|
|
||||||
if ok {
|
|
||||||
t.Fatal("erwartet fehlschlag bei unbekannter client-id")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestProvision_RequiresRegisteredModule(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, _, err := registry.Provision(ctx, "nie-registriert"); !errors.Is(err, ErrModuleNotRegistered) {
|
|
||||||
t.Fatalf("erwartet ErrModuleNotRegistered, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRequireServiceCredential_RejectsInvalidAcceptsValid(t *testing.T) {
|
|
||||||
registry, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
name := uniqueModuleName(t)
|
|
||||||
|
|
||||||
if _, err := registry.Register(ctx, name, "1.0", nil); err != nil {
|
|
||||||
t.Fatalf("register: %v", err)
|
|
||||||
}
|
|
||||||
clientID, secret, err := registry.Provision(ctx, name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("provision: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
handler := registry.RequireServiceCredential(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
})
|
|
||||||
|
|
||||||
// Fehlendes Credential.
|
|
||||||
req := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
handler(rec, req)
|
|
||||||
if rec.Code != http.StatusUnauthorized {
|
|
||||||
t.Fatalf("ohne credential: status = %d, want 401", rec.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Falsches Secret.
|
|
||||||
req2 := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
|
||||||
req2.Header.Set("X-Client-Id", clientID)
|
|
||||||
req2.Header.Set("X-Client-Secret", "falsch")
|
|
||||||
rec2 := httptest.NewRecorder()
|
|
||||||
handler(rec2, req2)
|
|
||||||
if rec2.Code != http.StatusUnauthorized {
|
|
||||||
t.Fatalf("falsches secret: status = %d, want 401", rec2.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Gueltiges Credential.
|
|
||||||
req3 := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
|
||||||
req3.Header.Set("X-Client-Id", clientID)
|
|
||||||
req3.Header.Set("X-Client-Secret", secret)
|
|
||||||
rec3 := httptest.NewRecorder()
|
|
||||||
handler(rec3, req3)
|
|
||||||
if rec3.Code != http.StatusOK {
|
|
||||||
t.Fatalf("gueltiges credential: status = %d, want 200", rec3.Code)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,97 +0,0 @@
|
|||||||
package moduletrust
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// StaleCache ist der generische Rechte-/Feature-Flag-Cache-Kontrakt
|
|
||||||
// (Akzeptanzkriterium 2): TTL-basiert, mit explizitem, benanntem Verhalten
|
|
||||||
// bei abgelaufenem Cache waehrend Core nicht erreichbar ist.
|
|
||||||
//
|
|
||||||
// - Get: FAIL-OPEN fuer Lesevorgaenge. Schlaegt der Refresh fehl, aber es
|
|
||||||
// gibt bereits einen (wenn auch abgelaufenen) Stand, wird dieser mit
|
|
||||||
// stale=true zurueckgegeben — Begruendung: ein bereits authentifiziertes
|
|
||||||
// Modul soll mit dem letztbekannten Stand weiterarbeiten koennen statt
|
|
||||||
// hart zu blockieren (siehe "Bekannte Fehler vermeiden" im Ticket).
|
|
||||||
// Existiert noch nie ein Stand, gibt es keinen sinnvollen Fallback —
|
|
||||||
// dann liefert auch Get einen Fehler.
|
|
||||||
// - RequireFresh: FAIL-CLOSED fuer sicherheitskritische Aktionen (z.B.
|
|
||||||
// ein komplett NEUER Login). Nutzt NIEMALS einen zwischengespeicherten
|
|
||||||
// Stand, ruft immer frisch ab — Begruendung: eine neue Vertrauens-
|
|
||||||
// entscheidung darf nicht auf veralteten Daten beruhen, auch wenn das
|
|
||||||
// bedeutet, dass die Aktion bei Core-Ausfall sichtbar fehlschlaegt statt
|
|
||||||
// unsicher "irgendwie" durchgelassen zu werden.
|
|
||||||
//
|
|
||||||
// LIC-02 (internal/flag.Service) implementiert bereits denselben Kontrakt
|
|
||||||
// fuer Feature-Flags — StaleCache verallgemeinert dasselbe Muster fuer
|
|
||||||
// JWT-Signaturschluessel, damit beide Faelle derselben dokumentierten
|
|
||||||
// Policy folgen.
|
|
||||||
type StaleCache[T any] struct {
|
|
||||||
mu sync.RWMutex
|
|
||||||
value T
|
|
||||||
hasValue bool
|
|
||||||
fetchedAt time.Time
|
|
||||||
ttl time.Duration
|
|
||||||
fetch func(ctx context.Context) (T, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStaleCache[T any](ttl time.Duration, fetch func(ctx context.Context) (T, error)) *StaleCache[T] {
|
|
||||||
return &StaleCache[T]{ttl: ttl, fetch: fetch}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den Cache-Wert. FAIL-OPEN: bei Refresh-Fehler wird ein
|
|
||||||
// vorhandener, ggf. abgelaufener Stand zurueckgegeben (stale=true).
|
|
||||||
func (c *StaleCache[T]) Get(ctx context.Context) (value T, stale bool, err error) {
|
|
||||||
c.mu.RLock()
|
|
||||||
fresh := c.hasValue && time.Since(c.fetchedAt) < c.ttl
|
|
||||||
if fresh {
|
|
||||||
v := c.value
|
|
||||||
c.mu.RUnlock()
|
|
||||||
return v, false, nil
|
|
||||||
}
|
|
||||||
c.mu.RUnlock()
|
|
||||||
|
|
||||||
newVal, fetchErr := c.fetch(ctx)
|
|
||||||
if fetchErr == nil {
|
|
||||||
c.mu.Lock()
|
|
||||||
c.value, c.hasValue, c.fetchedAt = newVal, true, time.Now()
|
|
||||||
c.mu.Unlock()
|
|
||||||
return newVal, false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
c.mu.RLock()
|
|
||||||
defer c.mu.RUnlock()
|
|
||||||
if c.hasValue {
|
|
||||||
return c.value, true, nil
|
|
||||||
}
|
|
||||||
var zero T
|
|
||||||
return zero, false, fmt.Errorf("cache leer und refresh fehlgeschlagen: %w", fetchErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Invalidate erzwingt beim naechsten Get-Aufruf einen sofortigen Refresh
|
|
||||||
// statt auf den TTL-Ablauf zu warten (API-06, Akzeptanzkriterium 1: ein
|
|
||||||
// Health-Check-getriggerter Wiederanlauf soll den Cache SOFORT aktualisieren,
|
|
||||||
// nicht die reguläre TTL abwarten) — rein additiv, aendert nichts an
|
|
||||||
// Get/RequireFresh (dasselbe Muster wie internal/flag.Service.Invalidate).
|
|
||||||
func (c *StaleCache[T]) Invalidate() {
|
|
||||||
c.mu.Lock()
|
|
||||||
c.hasValue = false
|
|
||||||
c.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireFresh ruft IMMER frisch ab (FAIL-CLOSED) — fuer sicherheitskritische
|
|
||||||
// Aktionen, die niemals auf einem zwischengespeicherten Stand basieren duerfen.
|
|
||||||
func (c *StaleCache[T]) RequireFresh(ctx context.Context) (T, error) {
|
|
||||||
v, err := c.fetch(ctx)
|
|
||||||
if err != nil {
|
|
||||||
var zero T
|
|
||||||
return zero, fmt.Errorf("core nicht erreichbar, sicherheitskritische aktion abgelehnt: %w", err)
|
|
||||||
}
|
|
||||||
c.mu.Lock()
|
|
||||||
c.value, c.hasValue, c.fetchedAt = v, true, time.Now()
|
|
||||||
c.mu.Unlock()
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
package moduletrust
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/golang-jwt/jwt/v5"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Claims struct {
|
|
||||||
Subject string `json:"sub"`
|
|
||||||
TenantSlug string `json:"tenant"`
|
|
||||||
jwt.RegisteredClaims
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issue signiert ein Token mit dem aktuellen Signierschluessel und traegt
|
|
||||||
// dessen KID im JWT-Header ein — der Verifier auf Modulseite waehlt darueber
|
|
||||||
// den passenden oeffentlichen Schluessel aus PublicKeySet() aus.
|
|
||||||
func (m *KeyManager) Issue(subject, tenantSlug string, ttl time.Duration) (string, error) {
|
|
||||||
key, err := m.SigningKey()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
now := time.Now()
|
|
||||||
claims := Claims{
|
|
||||||
Subject: subject,
|
|
||||||
TenantSlug: tenantSlug,
|
|
||||||
RegisteredClaims: jwt.RegisteredClaims{
|
|
||||||
IssuedAt: jwt.NewNumericDate(now),
|
|
||||||
ExpiresAt: jwt.NewNumericDate(now.Add(ttl)),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
token := jwt.NewWithClaims(jwt.SigningMethodEdDSA, claims)
|
|
||||||
token.Header["kid"] = key.KID
|
|
||||||
return token.SignedString(key.Private)
|
|
||||||
}
|
|
||||||
|
|
||||||
type jwksResponse struct {
|
|
||||||
Keys []jwksKey `json:"keys"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type jwksKey struct {
|
|
||||||
Kid string `json:"kid"`
|
|
||||||
PublicKey string `json:"public_key"` // base64 (raw Ed25519, 32 Byte)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServeJWKS liefert alle bekannten oeffentlichen Schluessel als JSON —
|
|
||||||
// Module fragen dies periodisch ab (nicht pro Request), siehe Verifier.
|
|
||||||
func (m *KeyManager) ServeJWKS(w http.ResponseWriter, r *http.Request) {
|
|
||||||
set := m.PublicKeySet()
|
|
||||||
resp := jwksResponse{Keys: make([]jwksKey, 0, len(set))}
|
|
||||||
for kid, pub := range set {
|
|
||||||
resp.Keys = append(resp.Keys, jwksKey{Kid: kid, PublicKey: base64.StdEncoding.EncodeToString(pub)})
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_ = json.NewEncoder(w).Encode(resp)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseJWKS dekodiert die JSON-Antwort von ServeJWKS zurueck in kid->PublicKey
|
|
||||||
// — Hilfsfunktion fuer Module, die JWKS per HTTP abrufen.
|
|
||||||
func ParseJWKS(data []byte) (map[string][]byte, error) {
|
|
||||||
var resp jwksResponse
|
|
||||||
if err := json.Unmarshal(data, &resp); err != nil {
|
|
||||||
return nil, fmt.Errorf("jwks parsen: %w", err)
|
|
||||||
}
|
|
||||||
out := make(map[string][]byte, len(resp.Keys))
|
|
||||||
for _, k := range resp.Keys {
|
|
||||||
raw, err := base64.StdEncoding.DecodeString(k.PublicKey)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("oeffentlichen schluessel %q dekodieren: %w", k.Kid, err)
|
|
||||||
}
|
|
||||||
out[k.Kid] = raw
|
|
||||||
}
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
// Package moduletrust implementiert Core API-05: asymmetrische JWT-Signatur
|
|
||||||
// mit Schluesselverteilung (JWKS), damit DMS/Mail/Archive/Workflow JWTs
|
|
||||||
// LOKAL verifizieren koennen, ohne pro Aufruf einen synchronen Request an
|
|
||||||
// Core zu stellen — Core darf Fundament sein, ohne zum Flaschenhals zu
|
|
||||||
// werden (siehe Entscheidungsverlauf "Vertrauensstellung Core<->Module" in
|
|
||||||
// nexarch-state.json). IAM-02s HS256-Session-Cookie (Browser-Login) bleibt
|
|
||||||
// unangetastet — dies ist ein zusaetzlicher, getrennter Vertrauensmechanismus
|
|
||||||
// fuer Modul-zu-Modul/Modul-zu-Core-Aufrufe.
|
|
||||||
package moduletrust
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/ed25519"
|
|
||||||
"crypto/rand"
|
|
||||||
"encoding/hex"
|
|
||||||
"fmt"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
type KeyPair struct {
|
|
||||||
KID string
|
|
||||||
Private ed25519.PrivateKey
|
|
||||||
Public ed25519.PublicKey
|
|
||||||
}
|
|
||||||
|
|
||||||
// KeyManager haelt ALLE noch gueltigen Schluesselpaare — nicht nur das
|
|
||||||
// aktuell signierende. Rotate erzeugt ein neues Paar und behaelt die alten
|
|
||||||
// fuer die Verifikation bereits ausgestellter Tokens (Akzeptanzkriterium 3:
|
|
||||||
// Rotation ohne Ausfallzeit fuer andere Module).
|
|
||||||
type KeyManager struct {
|
|
||||||
mu sync.RWMutex
|
|
||||||
keys []KeyPair // aeltestes zuerst, neuestes zuletzt
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewKeyManager() (*KeyManager, error) {
|
|
||||||
m := &KeyManager{}
|
|
||||||
if _, err := m.Rotate(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return m, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rotate erzeugt ein neues Ed25519-Schluesselpaar mit eigener KID und macht
|
|
||||||
// es zum aktuellen Signierschluessel. Aeltere Schluessel bleiben in
|
|
||||||
// PublicKeySet() erhalten, damit bereits ausgestellte Tokens weiterhin
|
|
||||||
// verifizierbar sind.
|
|
||||||
func (m *KeyManager) Rotate() (KeyPair, error) {
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
return KeyPair{}, fmt.Errorf("schluesselpaar erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
kidBytes := make([]byte, 8)
|
|
||||||
if _, err := rand.Read(kidBytes); err != nil {
|
|
||||||
return KeyPair{}, fmt.Errorf("kid erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
kp := KeyPair{KID: hex.EncodeToString(kidBytes), Private: priv, Public: pub}
|
|
||||||
|
|
||||||
m.mu.Lock()
|
|
||||||
m.keys = append(m.keys, kp)
|
|
||||||
m.mu.Unlock()
|
|
||||||
return kp, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// SigningKey liefert den aktuellen (neuesten) Schluessel zum Signieren neuer Tokens.
|
|
||||||
func (m *KeyManager) SigningKey() (KeyPair, error) {
|
|
||||||
m.mu.RLock()
|
|
||||||
defer m.mu.RUnlock()
|
|
||||||
if len(m.keys) == 0 {
|
|
||||||
return KeyPair{}, fmt.Errorf("moduletrust: kein schluessel vorhanden")
|
|
||||||
}
|
|
||||||
return m.keys[len(m.keys)-1], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// PublicKeySet liefert ALLE bekannten oeffentlichen Schluessel (kid ->
|
|
||||||
// public key) — die Grundlage fuer den JWKS-Endpunkt.
|
|
||||||
func (m *KeyManager) PublicKeySet() map[string]ed25519.PublicKey {
|
|
||||||
m.mu.RLock()
|
|
||||||
defer m.mu.RUnlock()
|
|
||||||
out := make(map[string]ed25519.PublicKey, len(m.keys))
|
|
||||||
for _, k := range m.keys {
|
|
||||||
out[k.KID] = k.Public
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
@@ -1,214 +0,0 @@
|
|||||||
package moduletrust
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestIssueAndVerify_RoundTrip(t *testing.T) {
|
|
||||||
km, err := NewKeyManager()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new key manager: %v", err)
|
|
||||||
}
|
|
||||||
token, err := km.Issue("user-1", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
v := NewVerifier(time.Hour, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
return km.PublicKeySet(), nil
|
|
||||||
})
|
|
||||||
claims, err := v.Verify(context.Background(), token)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("verify: %v", err)
|
|
||||||
}
|
|
||||||
if claims.Subject != "user-1" || claims.TenantSlug != "acme" {
|
|
||||||
t.Fatalf("claims unerwartet: %+v", claims)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1: Verifikation lokal, kein Request pro Aufruf.
|
|
||||||
func TestVerify_DoesNotFetchPerCall(t *testing.T) {
|
|
||||||
km, err := NewKeyManager()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new key manager: %v", err)
|
|
||||||
}
|
|
||||||
token, err := km.Issue("user-1", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var mu sync.Mutex
|
|
||||||
fetchCalls := 0
|
|
||||||
v := NewVerifier(time.Hour, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
mu.Lock()
|
|
||||||
fetchCalls++
|
|
||||||
mu.Unlock()
|
|
||||||
return km.PublicKeySet(), nil
|
|
||||||
})
|
|
||||||
|
|
||||||
for i := 0; i < 10; i++ {
|
|
||||||
if _, err := v.Verify(context.Background(), token); err != nil {
|
|
||||||
t.Fatalf("verify %d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
if fetchCalls != 1 {
|
|
||||||
t.Fatalf("erwartet genau 1 fetch fuer 10 Verify-Aufrufe innerhalb der TTL, habe %d", fetchCalls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: Core simuliert nicht erreichbar,
|
|
||||||
// bereits authentifizierte Nutzer bleiben funktionsfaehig (Fail-Open mit
|
|
||||||
// letztbekanntem Schluesselstand).
|
|
||||||
func TestVerify_FailsOpenWhenCoreUnreachableButStaleKeysExist(t *testing.T) {
|
|
||||||
km, err := NewKeyManager()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new key manager: %v", err)
|
|
||||||
}
|
|
||||||
token, err := km.Issue("user-1", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
coreDown := false
|
|
||||||
v := NewVerifier(30*time.Millisecond, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
if coreDown {
|
|
||||||
return nil, errors.New("core nicht erreichbar (simuliert)")
|
|
||||||
}
|
|
||||||
return km.PublicKeySet(), nil
|
|
||||||
})
|
|
||||||
|
|
||||||
// Cache vorwaermen, waehrend Core noch erreichbar ist.
|
|
||||||
if _, err := v.Verify(context.Background(), token); err != nil {
|
|
||||||
t.Fatalf("verify (warm): %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Core abschalten" und TTL ablaufen lassen.
|
|
||||||
coreDown = true
|
|
||||||
time.Sleep(50 * time.Millisecond)
|
|
||||||
|
|
||||||
if _, err := v.Verify(context.Background(), token); err != nil {
|
|
||||||
t.Fatalf("verify sollte trotz core-ausfall mit letztbekanntem stand funktionieren: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2: neue sicherheitskritische Aktionen
|
|
||||||
// (z.B. neuer Login) schlagen bei Core-Ausfall klar fehl statt unsicher
|
|
||||||
// durchgelassen zu werden — auch wenn ein (aelterer) Cache-Stand existiert.
|
|
||||||
func TestRequireFreshKeys_FailsClosedWhenCoreUnreachable(t *testing.T) {
|
|
||||||
km, err := NewKeyManager()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new key manager: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
coreDown := false
|
|
||||||
v := NewVerifier(time.Hour, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
if coreDown {
|
|
||||||
return nil, errors.New("core nicht erreichbar (simuliert)")
|
|
||||||
}
|
|
||||||
return km.PublicKeySet(), nil
|
|
||||||
})
|
|
||||||
|
|
||||||
// Cache vorwaermen (existiert jetzt ein "veralteter" gueltiger Stand).
|
|
||||||
if _, _, err := v.cache.Get(context.Background()); err != nil {
|
|
||||||
t.Fatalf("warm cache: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
coreDown = true
|
|
||||||
if err := v.RequireFreshKeys(context.Background()); err == nil {
|
|
||||||
t.Fatal("erwartet fehler (fail-closed) bei core-ausfall, habe nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: Schluesselrotation ohne Ausfallzeit —
|
|
||||||
// ein bereits ausgestelltes Token bleibt nach Rotation weiterhin
|
|
||||||
// verifizierbar, ein zweites (simuliertes) Modul bekommt beide Schluessel.
|
|
||||||
func TestRotate_NoDowntimeForAlreadyIssuedTokens(t *testing.T) {
|
|
||||||
km, err := NewKeyManager()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new key manager: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
oldToken, err := km.Issue("user-1", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue (alt): %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := km.Rotate(); err != nil {
|
|
||||||
t.Fatalf("rotate: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
newToken, err := km.Issue("user-2", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue (neu): %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Simuliertes zweites Modul: fragt den vollstaendigen Schluesselsatz ab.
|
|
||||||
moduleB := NewVerifier(time.Hour, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
return km.PublicKeySet(), nil
|
|
||||||
})
|
|
||||||
|
|
||||||
if _, err := moduleB.Verify(context.Background(), oldToken); err != nil {
|
|
||||||
t.Fatalf("altes token sollte nach rotation weiterhin gueltig sein: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := moduleB.Verify(context.Background(), newToken); err != nil {
|
|
||||||
t.Fatalf("neues token sollte gueltig sein: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestVerify_RejectsUnknownKid(t *testing.T) {
|
|
||||||
km1, _ := NewKeyManager()
|
|
||||||
km2, _ := NewKeyManager() // komplett anderer, unbekannter schluessel
|
|
||||||
|
|
||||||
token, err := km1.Issue("user-1", "acme", time.Hour)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
v := NewVerifier(time.Hour, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
return km2.PublicKeySet(), nil // kennt km1s schluessel nicht
|
|
||||||
})
|
|
||||||
if _, err := v.Verify(context.Background(), token); !errors.Is(err, ErrInvalidToken) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidToken, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestJWKSRoundTrip(t *testing.T) {
|
|
||||||
km, _ := NewKeyManager()
|
|
||||||
km.Rotate()
|
|
||||||
|
|
||||||
var buf []byte
|
|
||||||
rec := &captureWriter{}
|
|
||||||
km.ServeJWKS(rec, nil)
|
|
||||||
buf = rec.body
|
|
||||||
|
|
||||||
parsed, err := ParseJWKS(buf)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse jwks: %v", err)
|
|
||||||
}
|
|
||||||
if len(parsed) != len(km.PublicKeySet()) {
|
|
||||||
t.Fatalf("erwartet %d schluessel, habe %d", len(km.PublicKeySet()), len(parsed))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type captureWriter struct {
|
|
||||||
body []byte
|
|
||||||
header http.Header
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *captureWriter) Header() http.Header {
|
|
||||||
if w.header == nil {
|
|
||||||
w.header = http.Header{}
|
|
||||||
}
|
|
||||||
return w.header
|
|
||||||
}
|
|
||||||
func (w *captureWriter) Write(p []byte) (int, error) { w.body = append(w.body, p...); return len(p), nil }
|
|
||||||
func (w *captureWriter) WriteHeader(statusCode int) {}
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
package moduletrust
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/golang-jwt/jwt/v5"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrInvalidToken = errors.New("moduletrust: ungueltiges token")
|
|
||||||
|
|
||||||
// KeyFetchFunc holt den aktuellen Schluesselsatz von Core (z.B. per HTTP-GET
|
|
||||||
// auf ServeJWKS + ParseJWKS). Wird vom Verifier nur bei abgelaufener TTL
|
|
||||||
// aufgerufen — NICHT bei jeder Verify()-Anfrage (Akzeptanzkriterium 1).
|
|
||||||
type KeyFetchFunc func(ctx context.Context) (map[string]ed25519.PublicKey, error)
|
|
||||||
|
|
||||||
// Verifier ist die Modulseite von API-05: verifiziert JWTs LOKAL gegen einen
|
|
||||||
// per StaleCache zwischengespeicherten Schluesselsatz, ohne pro Aufruf einen
|
|
||||||
// synchronen Request an Core zu stellen.
|
|
||||||
type Verifier struct {
|
|
||||||
cache *StaleCache[map[string]ed25519.PublicKey]
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewVerifier(ttl time.Duration, fetch KeyFetchFunc) *Verifier {
|
|
||||||
return &Verifier{cache: NewStaleCache(ttl, func(ctx context.Context) (map[string]ed25519.PublicKey, error) {
|
|
||||||
return fetch(ctx)
|
|
||||||
})}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verify prueft die Signatur LOKAL gegen den (ggf. abgelaufenen, aber
|
|
||||||
// vorhandenen) Schluesselsatz — FAIL-OPEN fuer bereits ausgestellte Tokens
|
|
||||||
// (Akzeptanzkriterium 2): ist Core nicht erreichbar, aber ein alter
|
|
||||||
// Schluesselsatz bekannt, wird damit weiter verifiziert.
|
|
||||||
func (v *Verifier) Verify(ctx context.Context, tokenString string) (*Claims, error) {
|
|
||||||
keys, _, err := v.cache.Get(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
claims := &Claims{}
|
|
||||||
token, err := jwt.ParseWithClaims(tokenString, claims, func(t *jwt.Token) (interface{}, error) {
|
|
||||||
if _, ok := t.Method.(*jwt.SigningMethodEd25519); !ok {
|
|
||||||
return nil, ErrInvalidToken
|
|
||||||
}
|
|
||||||
kid, _ := t.Header["kid"].(string)
|
|
||||||
pub, ok := keys[kid]
|
|
||||||
if !ok {
|
|
||||||
return nil, ErrInvalidToken
|
|
||||||
}
|
|
||||||
return pub, nil
|
|
||||||
})
|
|
||||||
if err != nil || !token.Valid {
|
|
||||||
return nil, ErrInvalidToken
|
|
||||||
}
|
|
||||||
return claims, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireFreshKeys ruft IMMER frisch von Core ab (FAIL-CLOSED) — fuer
|
|
||||||
// sicherheitskritische Aktionen wie einen komplett neuen Login
|
|
||||||
// (Akzeptanzkriterium 2): schlaegt klar fehl, wenn Core nicht erreichbar
|
|
||||||
// ist, statt auf einem veralteten Schluesselsatz zu vertrauen.
|
|
||||||
func (v *Verifier) RequireFreshKeys(ctx context.Context) error {
|
|
||||||
_, err := v.cache.RequireFresh(ctx)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
@@ -1,155 +0,0 @@
|
|||||||
// Package resync implementiert Core API-06: Wiederanlauf & Nachsynchro-
|
|
||||||
// nisierung nach einem Core-Ausfall.
|
|
||||||
//
|
|
||||||
// - Ein Modul puffert Audit-Events und Nutzungszaehler-Deltas LOKAL in
|
|
||||||
// Postgres (NICHT im Speicher — siehe "Bekannte Fehler vermeiden" im
|
|
||||||
// Ticket: ein erneuter Ausfall waehrend der Nachlieferung darf keine
|
|
||||||
// Daten verlieren, eine In-Memory-Queue wuerde das riskieren).
|
|
||||||
// - Ein Health-Check-getriggerter Worker erkennt die Core-Wiedererreich-
|
|
||||||
// barkeit SOFORT (nicht erst nach TTL-Ablauf, siehe StaleCache.Invalidate)
|
|
||||||
// und liefert die gepufferten Daten in ORIGINALER Reihenfolge, authenti-
|
|
||||||
// fiziert ueber das Service-Credential aus API-02
|
|
||||||
// (internal/moduleregistry.Registry.Authenticate).
|
|
||||||
//
|
|
||||||
// Dieses Paket dupliziert weder internal/audit (AUD-01) noch internal/usage
|
|
||||||
// (LIC-03) — es liefert nur den Puffer- und Nachlieferungs-Mechanismus
|
|
||||||
// DAVOR bzw. DANACH.
|
|
||||||
package resync
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// BufferedAuditEvent ist ein lokal gepuffertes Audit-Ereignis. Seq
|
|
||||||
// garantiert die Wiederherstellung der urspruenglichen Reihenfolge
|
|
||||||
// (Akzeptanzkriterium 2) unabhaengig von eventuellen Uhrzeit-Ungenauigkeiten.
|
|
||||||
type BufferedAuditEvent struct {
|
|
||||||
ID int64
|
|
||||||
Seq int64
|
|
||||||
TenantSlug string
|
|
||||||
Actor string
|
|
||||||
Action string
|
|
||||||
Target string
|
|
||||||
Metadata map[string]any
|
|
||||||
CreatedAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// BufferedUsageDelta ist ein lokal gepuffertes Nutzungszaehler-Inkrement.
|
|
||||||
type BufferedUsageDelta struct {
|
|
||||||
ID int64
|
|
||||||
Seq int64
|
|
||||||
TenantSlug string
|
|
||||||
Metric string
|
|
||||||
Delta int64
|
|
||||||
CreatedAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Buffer ist die lokale, persistente Pufferqueue eines Moduls.
|
|
||||||
type Buffer struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewBuffer(pool *pgxpool.Pool) *Buffer {
|
|
||||||
return &Buffer{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnqueueAuditEvent puffert EIN Audit-Ereignis lokal — wird von einem
|
|
||||||
// Fachmodul aufgerufen, wenn Core gerade nicht erreichbar ist (die
|
|
||||||
// Erkennung "Core erreichbar oder nicht" ist NICHT Teil dieses Aufrufs,
|
|
||||||
// siehe Worker).
|
|
||||||
func (b *Buffer) EnqueueAuditEvent(ctx context.Context, tenantSlug, actor, action, target string, metadata map[string]any) error {
|
|
||||||
if metadata == nil {
|
|
||||||
metadata = map[string]any{}
|
|
||||||
}
|
|
||||||
metadataJSON, err := json.Marshal(metadata)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("metadata serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
_, err = b.pool.Exec(ctx, `
|
|
||||||
INSERT INTO resync_audit_buffer (tenant_slug, actor, action, target, metadata)
|
|
||||||
VALUES ($1, $2, $3, $4, $5)
|
|
||||||
`, tenantSlug, actor, action, target, metadataJSON)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("audit-ereignis puffern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnqueueUsageDelta puffert EIN Nutzungszaehler-Inkrement lokal.
|
|
||||||
func (b *Buffer) EnqueueUsageDelta(ctx context.Context, tenantSlug, metric string, delta int64) error {
|
|
||||||
_, err := b.pool.Exec(ctx, `
|
|
||||||
INSERT INTO resync_usage_buffer (tenant_slug, metric, delta)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
`, tenantSlug, metric, delta)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("nutzungsdelta puffern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// PendingAuditEvents liefert ALLE noch nicht zugestellten Audit-Events in
|
|
||||||
// ORIGINALER Reihenfolge (Akzeptanzkriterium 2 / Pruefung 1).
|
|
||||||
func (b *Buffer) PendingAuditEvents(ctx context.Context) ([]BufferedAuditEvent, error) {
|
|
||||||
rows, err := b.pool.Query(ctx, `
|
|
||||||
SELECT id, seq, tenant_slug, actor, action, target, metadata, created_at
|
|
||||||
FROM resync_audit_buffer ORDER BY seq
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("gepufferte audit-events abfragen: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []BufferedAuditEvent
|
|
||||||
for rows.Next() {
|
|
||||||
var e BufferedAuditEvent
|
|
||||||
var metadataJSON []byte
|
|
||||||
if err := rows.Scan(&e.ID, &e.Seq, &e.TenantSlug, &e.Actor, &e.Action, &e.Target, &metadataJSON, &e.CreatedAt); err != nil {
|
|
||||||
return nil, fmt.Errorf("gepuffertes audit-event lesen: %w", err)
|
|
||||||
}
|
|
||||||
_ = json.Unmarshal(metadataJSON, &e.Metadata)
|
|
||||||
out = append(out, e)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// PendingUsageDeltas liefert ALLE noch nicht zugestellten Nutzungsdeltas.
|
|
||||||
func (b *Buffer) PendingUsageDeltas(ctx context.Context) ([]BufferedUsageDelta, error) {
|
|
||||||
rows, err := b.pool.Query(ctx, `
|
|
||||||
SELECT id, seq, tenant_slug, metric, delta, created_at
|
|
||||||
FROM resync_usage_buffer ORDER BY seq
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("gepufferte nutzungsdeltas abfragen: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []BufferedUsageDelta
|
|
||||||
for rows.Next() {
|
|
||||||
var d BufferedUsageDelta
|
|
||||||
if err := rows.Scan(&d.ID, &d.Seq, &d.TenantSlug, &d.Metric, &d.Delta, &d.CreatedAt); err != nil {
|
|
||||||
return nil, fmt.Errorf("gepuffertes nutzungsdelta lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, d)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// RemoveAuditEvent entfernt EIN Audit-Event aus dem Puffer — wird NUR nach
|
|
||||||
// von Core BESTAETIGTER Zustellung aufgerufen (Akzeptanzkriterium 2/3: erst
|
|
||||||
// entfernen, wenn sicher zugestellt, sonst bleibt es fuer den naechsten
|
|
||||||
// Versuch erhalten — kein Datenverlust bei erneutem Ausfall waehrend der
|
|
||||||
// Nachlieferung).
|
|
||||||
func (b *Buffer) RemoveAuditEvent(ctx context.Context, id int64) error {
|
|
||||||
_, err := b.pool.Exec(ctx, `DELETE FROM resync_audit_buffer WHERE id = $1`, id)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *Buffer) RemoveUsageDelta(ctx context.Context, id int64) error {
|
|
||||||
_, err := b.pool.Exec(ctx, `DELETE FROM resync_usage_buffer WHERE id = $1`, id)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
package resync
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AuditRecorder ist die schmale Schnittstelle, ueber die Core empfangene
|
|
||||||
// Audit-Events tatsaechlich persistiert. In Produktion durch internal/audit
|
|
||||||
// (AUD-01, nicht Abhaengigkeit dieser Kachel) implementiert — dieses Paket
|
|
||||||
// dupliziert dessen Validierungs-/Speicherlogik NICHT, sondern ruft sie nur
|
|
||||||
// auf. Die Events werden vom Aufrufer sequenziell in PendingAuditEvents-
|
|
||||||
// Reihenfolge uebergeben (Akzeptanzkriterium 2).
|
|
||||||
type AuditRecorder interface {
|
|
||||||
Record(ctx context.Context, tenantSlug, actor, action, target string, metadata map[string]any, occurredAt time.Time) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// UsageIncrementer ist die schmale Schnittstelle zu Core's Nutzungszaehler
|
|
||||||
// (in Produktion internal/usage, LIC-03 — nicht Abhaengigkeit dieser
|
|
||||||
// Kachel). Jedes gepufferte Delta wird GENAU EINMAL angewendet.
|
|
||||||
type UsageIncrementer interface {
|
|
||||||
Increment(ctx context.Context, tenantSlug, metric string, delta int64) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// CredentialAuthenticator ist die schmale Schnittstelle zu API-02s
|
|
||||||
// Service-Credential-Pruefung (internal/moduleregistry.Registry.Authenticate).
|
|
||||||
type CredentialAuthenticator interface {
|
|
||||||
Authenticate(ctx context.Context, clientID, secret string) (moduleName string, ok bool, err error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handler nimmt nachgelieferte Audit-Events/Nutzungsdeltas auf der
|
|
||||||
// Core-Seite entgegen — authentifiziert ueber dasselbe Service-Credential
|
|
||||||
// wie jeder andere Modul-Core-Aufruf (Akzeptanzkriterium 2/3, "authentifiziert
|
|
||||||
// ueber das in API-02 definierte Service-Credential").
|
|
||||||
type Handler struct {
|
|
||||||
auth CredentialAuthenticator
|
|
||||||
audit AuditRecorder
|
|
||||||
usage UsageIncrementer
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHandler(auth CredentialAuthenticator, audit AuditRecorder, usage UsageIncrementer) *Handler {
|
|
||||||
return &Handler{auth: auth, audit: audit, usage: usage}
|
|
||||||
}
|
|
||||||
|
|
||||||
type credentialHeader struct {
|
|
||||||
ClientID string `json:"client_id"`
|
|
||||||
Secret string `json:"secret"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *Handler) authenticate(w http.ResponseWriter, r *http.Request) bool {
|
|
||||||
clientID := r.Header.Get("X-Nexarch-Client-Id")
|
|
||||||
secret := r.Header.Get("X-Nexarch-Client-Secret")
|
|
||||||
_, ok, err := h.auth.Authenticate(r.Context(), clientID, secret)
|
|
||||||
if err != nil || !ok {
|
|
||||||
http.Error(w, "ungueltiges service-credential", http.StatusUnauthorized)
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
type auditEventDTO struct {
|
|
||||||
TenantSlug string `json:"tenant_slug"`
|
|
||||||
Actor string `json:"actor"`
|
|
||||||
Action string `json:"action"`
|
|
||||||
Target string `json:"target"`
|
|
||||||
Metadata map[string]any `json:"metadata"`
|
|
||||||
OccurredAt time.Time `json:"occurred_at"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// AuditHandler nimmt EINE Liste gepufferter Audit-Events entgegen und
|
|
||||||
// schreibt sie SEQUENZIELL in der gegebenen Reihenfolge fort
|
|
||||||
// (Akzeptanzkriterium 2 / Pruefung 1: Vollstaendigkeit + Reihenfolge).
|
|
||||||
// Bricht die Verarbeitung bei einem Fehler ab und meldet, wie viele Events
|
|
||||||
// bereits sicher geschrieben wurden — der Aufrufer (Worker) entfernt aus
|
|
||||||
// seinem lokalen Puffer NUR die bestaetigt geschriebenen Events.
|
|
||||||
func (h *Handler) AuditHandler(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if !h.authenticate(w, r) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var events []auditEventDTO
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&events); err != nil {
|
|
||||||
http.Error(w, "ungueltiger anfrage-koerper", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
written := 0
|
|
||||||
for _, e := range events {
|
|
||||||
if err := h.audit.Record(r.Context(), e.TenantSlug, e.Actor, e.Action, e.Target, e.Metadata, e.OccurredAt); err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
written++
|
|
||||||
}
|
|
||||||
|
|
||||||
writeJSON(w, map[string]int{"written": written})
|
|
||||||
}
|
|
||||||
|
|
||||||
type usageDeltaDTO struct {
|
|
||||||
TenantSlug string `json:"tenant_slug"`
|
|
||||||
Metric string `json:"metric"`
|
|
||||||
Delta int64 `json:"delta"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// UsageHandler wendet JEDES gepufferte Delta GENAU EINMAL an
|
|
||||||
// (Akzeptanzkriterium 3 / Pruefung 2: keine Doppelzaehlung) — der Aufrufer
|
|
||||||
// entfernt aus seinem lokalen Puffer nur die bestaetigt uebernommenen Deltas.
|
|
||||||
func (h *Handler) UsageHandler(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if !h.authenticate(w, r) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var deltas []usageDeltaDTO
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&deltas); err != nil {
|
|
||||||
http.Error(w, "ungueltiger anfrage-koerper", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
applied := 0
|
|
||||||
for _, d := range deltas {
|
|
||||||
if err := h.usage.Increment(r.Context(), d.TenantSlug, d.Metric, d.Delta); err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
applied++
|
|
||||||
}
|
|
||||||
|
|
||||||
writeJSON(w, map[string]int{"applied": applied})
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeJSON(w http.ResponseWriter, body any) {
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_ = json.NewEncoder(w).Encode(body)
|
|
||||||
}
|
|
||||||
@@ -1,320 +0,0 @@
|
|||||||
package resync
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/moduleregistry"
|
|
||||||
)
|
|
||||||
|
|
||||||
// fakeAudit steht fuer internal/audit.Log (AUD-01, nicht Abhaengigkeit
|
|
||||||
// dieser Kachel) — zeichnet Aufrufe in Empfangsreihenfolge auf, damit
|
|
||||||
// Vollstaendigkeit UND Reihenfolge geprueft werden koennen.
|
|
||||||
type fakeAudit struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
events []auditEventDTO
|
|
||||||
failAt int // -1 = nie fehlschlagen; sonst: ab diesem Index (0-basiert) schlaegt Record fehl
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeAudit) Record(ctx context.Context, tenantSlug, actor, action, target string, metadata map[string]any, occurredAt time.Time) error {
|
|
||||||
f.mu.Lock()
|
|
||||||
defer f.mu.Unlock()
|
|
||||||
if f.failAt >= 0 && len(f.events) == f.failAt {
|
|
||||||
return fmt.Errorf("simulierter core-ausfall waehrend der nachlieferung")
|
|
||||||
}
|
|
||||||
f.events = append(f.events, auditEventDTO{TenantSlug: tenantSlug, Actor: actor, Action: action, Target: target, Metadata: metadata, OccurredAt: occurredAt})
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fakeUsage steht fuer internal/usage.Store (LIC-03, nicht Abhaengigkeit
|
|
||||||
// dieser Kachel) — summiert Deltas wie der echte Store.
|
|
||||||
type fakeUsage struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
totals map[string]int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func newFakeUsage() *fakeUsage { return &fakeUsage{totals: map[string]int64{}} }
|
|
||||||
|
|
||||||
func (f *fakeUsage) Increment(ctx context.Context, tenantSlug, metric string, delta int64) error {
|
|
||||||
f.mu.Lock()
|
|
||||||
defer f.mu.Unlock()
|
|
||||||
f.totals[tenantSlug+"|"+metric] += delta
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*Buffer, *pgxpool.Pool, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS resync_audit_buffer (
|
|
||||||
id BIGSERIAL PRIMARY KEY, seq BIGSERIAL, tenant_slug TEXT NOT NULL, actor TEXT NOT NULL,
|
|
||||||
action TEXT NOT NULL, target TEXT NOT NULL DEFAULT '', metadata JSONB NOT NULL DEFAULT '{}',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS resync_usage_buffer (
|
|
||||||
id BIGSERIAL PRIMARY KEY, seq BIGSERIAL, tenant_slug TEXT NOT NULL, metric TEXT NOT NULL,
|
|
||||||
delta BIGINT NOT NULL, created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS feature_flags (
|
|
||||||
key TEXT PRIMARY KEY, enabled BOOLEAN NOT NULL DEFAULT false,
|
|
||||||
rollout_percentage INT NOT NULL DEFAULT 0, target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS modules (
|
|
||||||
name TEXT PRIMARY KEY, version TEXT NOT NULL CHECK (version <> ''),
|
|
||||||
required_flags TEXT[] NOT NULL DEFAULT '{}', registered_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS module_credentials (
|
|
||||||
module_name TEXT PRIMARY KEY REFERENCES modules(name),
|
|
||||||
client_id TEXT NOT NULL UNIQUE, secret_hash BYTEA NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return NewBuffer(pool), pool, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func uniqueModuleName() string {
|
|
||||||
return fmt.Sprintf("resync-test-%d", time.Now().UnixNano())
|
|
||||||
}
|
|
||||||
|
|
||||||
// setupModuleCredential registriert ein echtes Modul + Service-Credential
|
|
||||||
// ueber internal/moduleregistry (API-02) — dieselbe Authentifizierung wird
|
|
||||||
// vom Handler tatsaechlich geprueft, kein Mock.
|
|
||||||
func setupModuleCredential(t *testing.T, pool *pgxpool.Pool) (registry *moduleregistry.Registry, clientID, secret string) {
|
|
||||||
t.Helper()
|
|
||||||
ctx := context.Background()
|
|
||||||
flagService := flag.NewService(flag.NewStore(pool), 10*time.Millisecond)
|
|
||||||
registry = moduleregistry.NewRegistry(pool, flagService)
|
|
||||||
name := uniqueModuleName()
|
|
||||||
if _, err := registry.Register(ctx, name, "1.0.0", nil); err != nil {
|
|
||||||
t.Fatalf("modul registrieren: %v", err)
|
|
||||||
}
|
|
||||||
clientID, secret, err := registry.Provision(ctx, name)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("credential provisionieren: %v", err)
|
|
||||||
}
|
|
||||||
return registry, clientID, secret
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: waehrend eines simulierten Ausfalls
|
|
||||||
// lokal gepufferte Audit-Events sind nach Wiederanlauf vollstaendig und in
|
|
||||||
// korrekter Reihenfolge in Core's Audit-Log vorhanden.
|
|
||||||
func TestFlushAll_DeliversBufferedAuditEventsCompleteAndInOrder(t *testing.T) {
|
|
||||||
buffer, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
registry, clientID, secret := setupModuleCredential(t, pool)
|
|
||||||
|
|
||||||
tenantSlug := "acme"
|
|
||||||
// Ereignisse "waehrend core down" lokal puffern.
|
|
||||||
actions := []string{"login", "upload", "delete", "logout"}
|
|
||||||
for _, action := range actions {
|
|
||||||
if err := buffer.EnqueueAuditEvent(ctx, tenantSlug, "user-1", action, "res-1", nil); err != nil {
|
|
||||||
t.Fatalf("enqueue %s: %v", action, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
audit := &fakeAudit{failAt: -1}
|
|
||||||
usage := newFakeUsage()
|
|
||||||
handler := NewHandler(registry, audit, usage)
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/internal/resync/audit", handler.AuditHandler)
|
|
||||||
mux.HandleFunc("/internal/resync/usage", handler.UsageHandler)
|
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
server := httptest.NewServer(mux)
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewCoreClient(server.URL, clientID, secret)
|
|
||||||
worker := NewWorker(buffer, client)
|
|
||||||
|
|
||||||
if err := worker.FlushAll(ctx); err != nil {
|
|
||||||
t.Fatalf("flushall: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
audit.mu.Lock()
|
|
||||||
defer audit.mu.Unlock()
|
|
||||||
if len(audit.events) != len(actions) {
|
|
||||||
t.Fatalf("erwartet %d zugestellte events, habe %d", len(actions), len(audit.events))
|
|
||||||
}
|
|
||||||
for i, e := range audit.events {
|
|
||||||
if e.Action != actions[i] {
|
|
||||||
t.Fatalf("reihenfolge falsch: position %d = %q, want %q", i, e.Action, actions[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Puffer muss nach bestaetigter Zustellung leer sein.
|
|
||||||
remaining, err := buffer.PendingAuditEvents(ctx)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pending: %v", err)
|
|
||||||
}
|
|
||||||
if len(remaining) != 0 {
|
|
||||||
t.Fatalf("erwartet leeren puffer nach bestaetigter zustellung, habe %d verbleibende", len(remaining))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Bekannter-Fehler-Praevention: bricht die Zustellung waehrend der
|
|
||||||
// Nachlieferung erneut ab (Core faellt wieder aus), bleiben die NICHT
|
|
||||||
// bestaetigten Events sicher im Puffer erhalten statt verloren zu gehen.
|
|
||||||
func TestFlushAll_KeepsUnconfirmedEventsInBufferOnPartialFailure(t *testing.T) {
|
|
||||||
buffer, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
registry, clientID, secret := setupModuleCredential(t, pool)
|
|
||||||
|
|
||||||
for i := 0; i < 5; i++ {
|
|
||||||
if err := buffer.EnqueueAuditEvent(ctx, "acme", "user-1", fmt.Sprintf("action-%d", i), "", nil); err != nil {
|
|
||||||
t.Fatalf("enqueue %d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Core-Fake schlaegt AB dem 3. Event fehl -> simuliert erneuten Ausfall
|
|
||||||
// mitten in der Nachlieferung.
|
|
||||||
audit := &fakeAudit{failAt: 3}
|
|
||||||
handler := NewHandler(registry, audit, newFakeUsage())
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/internal/resync/audit", handler.AuditHandler)
|
|
||||||
mux.HandleFunc("/internal/resync/usage", handler.UsageHandler)
|
|
||||||
server := httptest.NewServer(mux)
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewCoreClient(server.URL, clientID, secret)
|
|
||||||
worker := NewWorker(buffer, client)
|
|
||||||
|
|
||||||
if err := worker.FlushAll(ctx); err == nil {
|
|
||||||
t.Fatal("erwartet fehler, da core nur teilweise bestaetigt hat")
|
|
||||||
}
|
|
||||||
|
|
||||||
remaining, err := buffer.PendingAuditEvents(ctx)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pending: %v", err)
|
|
||||||
}
|
|
||||||
if len(remaining) != 2 {
|
|
||||||
t.Fatalf("erwartet 2 verbleibende (nicht bestaetigte) events im puffer, habe %d", len(remaining))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 2: Nutzungszaehler-Differenz aus der
|
|
||||||
// Ausfallzeit wird korrekt nachgebucht, ein wiederholter (fehlerhafter)
|
|
||||||
// Flush-Versuch fuehrt NICHT zu Doppelzaehlung, weil bereits bestaetigte
|
|
||||||
// Deltas aus dem Puffer entfernt sind.
|
|
||||||
func TestFlushAll_AppliesUsageDeltasWithoutDoubleCounting(t *testing.T) {
|
|
||||||
buffer, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
registry, clientID, secret := setupModuleCredential(t, pool)
|
|
||||||
|
|
||||||
deltas := []int64{3, 5, 2}
|
|
||||||
var want int64
|
|
||||||
for _, d := range deltas {
|
|
||||||
want += d
|
|
||||||
if err := buffer.EnqueueUsageDelta(ctx, "acme", "api_calls", d); err != nil {
|
|
||||||
t.Fatalf("enqueue delta %d: %v", d, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
usage := newFakeUsage()
|
|
||||||
handler := NewHandler(registry, &fakeAudit{failAt: -1}, usage)
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/internal/resync/audit", handler.AuditHandler)
|
|
||||||
mux.HandleFunc("/internal/resync/usage", handler.UsageHandler)
|
|
||||||
server := httptest.NewServer(mux)
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewCoreClient(server.URL, clientID, secret)
|
|
||||||
worker := NewWorker(buffer, client)
|
|
||||||
|
|
||||||
if err := worker.FlushAll(ctx); err != nil {
|
|
||||||
t.Fatalf("flushall 1: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
usage.mu.Lock()
|
|
||||||
got := usage.totals["acme|api_calls"]
|
|
||||||
usage.mu.Unlock()
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("nutzungsstand nach nachbuchung = %d, want %d", got, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ein zweiter Flush-Versuch (z.B. redundanter Retry) darf NICHTS mehr
|
|
||||||
// nachbuchen, da der Puffer bereits geleert wurde.
|
|
||||||
if err := worker.FlushAll(ctx); err != nil {
|
|
||||||
t.Fatalf("flushall 2: %v", err)
|
|
||||||
}
|
|
||||||
usage.mu.Lock()
|
|
||||||
got2 := usage.totals["acme|api_calls"]
|
|
||||||
usage.mu.Unlock()
|
|
||||||
if got2 != want {
|
|
||||||
t.Fatalf("nutzungsstand nach redundantem zweiten flush = %d, want unveraendert %d (keine doppelzaehlung)", got2, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 3: bei erkannter Core-Wiedererreichbarkeit
|
|
||||||
// wird der Cache SOFORT invalidiert (naechster Zugriff refetcht), nicht
|
|
||||||
// erst nach TTL-Ablauf — Latenz wird gemessen und liegt weit unter einer
|
|
||||||
// langen TTL.
|
|
||||||
func TestCheckAndSync_InvalidatesCacheImmediatelyOnRecovery(t *testing.T) {
|
|
||||||
buffer, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
registry, clientID, secret := setupModuleCredential(t, pool)
|
|
||||||
_ = registry
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
server := httptest.NewServer(mux)
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewCoreClient(server.URL, clientID, secret)
|
|
||||||
worker := NewWorker(buffer, client)
|
|
||||||
|
|
||||||
invalidated := false
|
|
||||||
var mu sync.Mutex
|
|
||||||
worker.OnReachable(func() {
|
|
||||||
mu.Lock()
|
|
||||||
invalidated = true
|
|
||||||
mu.Unlock()
|
|
||||||
})
|
|
||||||
|
|
||||||
start := time.Now()
|
|
||||||
becameReachable, err := worker.CheckAndSync(context.Background())
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("checkandsync: %v", err)
|
|
||||||
}
|
|
||||||
if !becameReachable {
|
|
||||||
t.Fatal("erwartet erkannten uebergang zu 'erreichbar' beim ersten erfolgreichen check")
|
|
||||||
}
|
|
||||||
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
if !invalidated {
|
|
||||||
t.Fatal("erwartet sofortigen cache-invalidierungs-callback bei core-wiedererreichbarkeit")
|
|
||||||
}
|
|
||||||
// Zielwert: deutlich unter einer typischen TTL (z.B. 5s beim
|
|
||||||
// Feature-Flag-Cache, LIC-02) — hier im Millisekundenbereich, da rein
|
|
||||||
// lokal ohne Netzwerk-Overhead.
|
|
||||||
if elapsed > time.Second {
|
|
||||||
t.Fatalf("cache-invalidierung brauchte %s, erwartet deutlich unter 1s", elapsed)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,220 +0,0 @@
|
|||||||
package resync
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// CoreClient ist der modul-seitige HTTP-Client fuer die Nachlieferung,
|
|
||||||
// authentifiziert ueber dasselbe Service-Credential wie jeder andere
|
|
||||||
// Modul-Core-Aufruf (API-02).
|
|
||||||
type CoreClient struct {
|
|
||||||
BaseURL string
|
|
||||||
ClientID string
|
|
||||||
Secret string
|
|
||||||
HTTP *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewCoreClient(baseURL, clientID, secret string) *CoreClient {
|
|
||||||
return &CoreClient{BaseURL: baseURL, ClientID: clientID, Secret: secret, HTTP: &http.Client{Timeout: 5 * time.Second}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *CoreClient) post(ctx context.Context, path string, body any) (*http.Response, error) {
|
|
||||||
payload, err := json.Marshal(body)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("payload serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, c.BaseURL+path, bytes.NewReader(payload))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
req.Header.Set("X-Nexarch-Client-Id", c.ClientID)
|
|
||||||
req.Header.Set("X-Nexarch-Client-Secret", c.Secret)
|
|
||||||
return c.HTTP.Do(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
// HealthCheck prueft, ob Core erreichbar ist — dieselbe Konvention wie
|
|
||||||
// internal/health (OPS-01): HTTP 200 auf einem Health-Endpunkt.
|
|
||||||
func (c *CoreClient) HealthCheck(ctx context.Context) bool {
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, c.BaseURL+"/healthz", nil)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
resp, err := c.HTTP.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
return resp.StatusCode == http.StatusOK
|
|
||||||
}
|
|
||||||
|
|
||||||
// Worker erkennt Core-Wiedererreichbarkeit und stoesst DANN sofort
|
|
||||||
// (Akzeptanzkriterium 1) sowohl registrierte Cache-Invalidierungen als auch
|
|
||||||
// das Nachliefern des lokalen Puffers an.
|
|
||||||
type Worker struct {
|
|
||||||
buffer *Buffer
|
|
||||||
client *CoreClient
|
|
||||||
onReachable []func()
|
|
||||||
wasDown bool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewWorker(buffer *Buffer, client *CoreClient) *Worker {
|
|
||||||
return &Worker{buffer: buffer, client: client, wasDown: true} // Start pessimistisch: erster erfolgreicher Check zaehlt als "Wiedererreichbarkeit".
|
|
||||||
}
|
|
||||||
|
|
||||||
// OnReachable registriert einen Callback, der bei jeder erkannten
|
|
||||||
// Core-Wiedererreichbarkeit sofort ausgefuehrt wird — z.B.
|
|
||||||
// moduletrust.StaleCache[T].Invalidate, damit der naechste Zugriff sofort
|
|
||||||
// neu abruft statt auf TTL-Ablauf zu warten (Akzeptanzkriterium 1).
|
|
||||||
func (w *Worker) OnReachable(fn func()) {
|
|
||||||
w.onReachable = append(w.onReachable, fn)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CheckAndSync fuehrt EINEN Zyklus aus: Erreichbarkeit pruefen, bei
|
|
||||||
// erkanntem UEBERGANG "nicht erreichbar -> erreichbar" sofort die
|
|
||||||
// registrierten Callbacks ausloesen und den Puffer nachliefern. Gibt
|
|
||||||
// zurueck, ob ein Wiederanlauf in diesem Aufruf erkannt wurde (fuer
|
|
||||||
// Latenzmessung in Tests, Pruefung 3).
|
|
||||||
func (w *Worker) CheckAndSync(ctx context.Context) (becameReachable bool, err error) {
|
|
||||||
reachable := w.client.HealthCheck(ctx)
|
|
||||||
if !reachable {
|
|
||||||
w.wasDown = true
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
justRecovered := w.wasDown
|
|
||||||
w.wasDown = false
|
|
||||||
if !justRecovered {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, fn := range w.onReachable {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := w.FlushAll(ctx); err != nil {
|
|
||||||
return true, err
|
|
||||||
}
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// FlushAll liefert ZUERST alle gepufferten Audit-Events (in Reihenfolge),
|
|
||||||
// DANN alle gepufferten Nutzungsdeltas nach. Jedes Element wird aus dem
|
|
||||||
// lokalen Puffer NUR entfernt, wenn Core es bestaetigt hat — bricht die
|
|
||||||
// Uebertragung vorzeitig ab (Core faellt waehrend der Nachlieferung erneut
|
|
||||||
// aus), bleibt der Rest sicher im Postgres-Puffer erhalten
|
|
||||||
// (Akzeptanzkriterium 2/3, "Bekannte Fehler vermeiden").
|
|
||||||
func (w *Worker) FlushAll(ctx context.Context) error {
|
|
||||||
if err := w.flushAuditEvents(ctx); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return w.flushUsageDeltas(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Worker) flushAuditEvents(ctx context.Context) error {
|
|
||||||
events, err := w.buffer.PendingAuditEvents(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if len(events) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
dtos := make([]auditEventDTO, len(events))
|
|
||||||
for i, e := range events {
|
|
||||||
dtos[i] = auditEventDTO{
|
|
||||||
TenantSlug: e.TenantSlug, Actor: e.Actor, Action: e.Action, Target: e.Target,
|
|
||||||
Metadata: e.Metadata, OccurredAt: e.CreatedAt,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
resp, err := w.client.post(ctx, "/internal/resync/audit", dtos)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("audit-nachlieferung: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
return fmt.Errorf("audit-nachlieferung: unerwarteter status %d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
var ack struct {
|
|
||||||
Written int `json:"written"`
|
|
||||||
}
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(&ack); err != nil {
|
|
||||||
return fmt.Errorf("audit-bestaetigung lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NUR die von Core bestaetigt geschriebenen Events entfernen — sie sind
|
|
||||||
// nach PendingAuditEvents-Reihenfolge sortiert, die ersten `Written`
|
|
||||||
// Eintraege entsprechen also genau den bestaetigten.
|
|
||||||
for i := 0; i < ack.Written; i++ {
|
|
||||||
if err := w.buffer.RemoveAuditEvent(ctx, events[i].ID); err != nil {
|
|
||||||
return fmt.Errorf("bestaetigtes audit-event aus puffer entfernen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ack.Written < len(events) {
|
|
||||||
return fmt.Errorf("core hat nur %d von %d audit-events bestaetigt", ack.Written, len(events))
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Worker) flushUsageDeltas(ctx context.Context) error {
|
|
||||||
deltas, err := w.buffer.PendingUsageDeltas(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if len(deltas) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
dtos := make([]usageDeltaDTO, len(deltas))
|
|
||||||
for i, d := range deltas {
|
|
||||||
dtos[i] = usageDeltaDTO{TenantSlug: d.TenantSlug, Metric: d.Metric, Delta: d.Delta}
|
|
||||||
}
|
|
||||||
|
|
||||||
resp, err := w.client.post(ctx, "/internal/resync/usage", dtos)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("nutzungs-nachlieferung: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
return fmt.Errorf("nutzungs-nachlieferung: unerwarteter status %d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
var ack struct {
|
|
||||||
Applied int `json:"applied"`
|
|
||||||
}
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(&ack); err != nil {
|
|
||||||
return fmt.Errorf("nutzungs-bestaetigung lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := 0; i < ack.Applied; i++ {
|
|
||||||
if err := w.buffer.RemoveUsageDelta(ctx, deltas[i].ID); err != nil {
|
|
||||||
return fmt.Errorf("bestaetigtes nutzungsdelta aus puffer entfernen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ack.Applied < len(deltas) {
|
|
||||||
return fmt.Errorf("core hat nur %d von %d nutzungsdeltas bestaetigt", ack.Applied, len(deltas))
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run fuehrt CheckAndSync in festen Abstaenden aus — die "kurze, definierte
|
|
||||||
// Zeitspanne" aus Akzeptanzkriterium 1 ist dieses Poll-Intervall.
|
|
||||||
func (w *Worker) Run(ctx context.Context, interval time.Duration) {
|
|
||||||
ticker := time.NewTicker(interval)
|
|
||||||
defer ticker.Stop()
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-ticker.C:
|
|
||||||
_, _ = w.CheckAndSync(ctx)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
package tenant
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Handler ist eine schlanke Vorbereitung der Schnittstelle fuer API-01
|
|
||||||
// (REST-API-Grundgerüst & Versionierung) und TEN-02 (Self-Service-Onboarding).
|
|
||||||
// Auth/Rate-Limiting/Versionierung selbst sind ausdruecklich nicht Teil von
|
|
||||||
// TEN-01 und werden dort nachgezogen.
|
|
||||||
type Handler struct {
|
|
||||||
provisioner *Provisioner
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHandler(p *Provisioner) *Handler {
|
|
||||||
return &Handler{provisioner: p}
|
|
||||||
}
|
|
||||||
|
|
||||||
type createTenantRequest struct {
|
|
||||||
Slug string `json:"slug"`
|
|
||||||
Name string `json:"name"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *Handler) CreateTenant(w http.ResponseWriter, r *http.Request) {
|
|
||||||
var req createTenantRequest
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
|
||||||
http.Error(w, "ungueltige Anfrage", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
t, err := h.provisioner.Provision(r.Context(), req.Slug, req.Name)
|
|
||||||
if err != nil {
|
|
||||||
if err == ErrInvalidSlug {
|
|
||||||
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
http.Error(w, "tenant konnte nicht angelegt werden", http.StatusInternalServerError)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
w.WriteHeader(http.StatusCreated)
|
|
||||||
_ = json.NewEncoder(w).Encode(t)
|
|
||||||
}
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
package tenant
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Provisioner legt fuer jeden neuen Mandanten eine vollstaendig isolierte
|
|
||||||
// PostgreSQL-Datenbank an und registriert sie transaktional in der Registry
|
|
||||||
// (Akzeptanzkriterium 2). Zwei Mandanten-Datenbanken sind danach auf
|
|
||||||
// Infrastrukturebene komplett getrennt (Akzeptanzkriterium 3).
|
|
||||||
type Provisioner struct {
|
|
||||||
// adminPool ist mit der Wartungsdatenbank (z. B. "postgres") verbunden
|
|
||||||
// und wird ausschliesslich fuer CREATE/DROP DATABASE verwendet, da diese
|
|
||||||
// Befehle in PostgreSQL nicht in einer Transaktion laufen koennen.
|
|
||||||
adminPool *pgxpool.Pool
|
|
||||||
registry *Registry
|
|
||||||
// dsnTemplate enthaelt genau ein "%s" als Platzhalter fuer den
|
|
||||||
// Datenbanknamen, z. B. "postgresql://user:pass@host:5432/%s?sslmode=disable".
|
|
||||||
dsnTemplate string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewProvisioner(adminPool *pgxpool.Pool, registry *Registry, dsnTemplate string) *Provisioner {
|
|
||||||
return &Provisioner{adminPool: adminPool, registry: registry, dsnTemplate: dsnTemplate}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Provision legt die Tenant-Datenbank an und registriert sie. Schlaegt die
|
|
||||||
// Registrierung fehl, wird die bereits angelegte Datenbank wieder entfernt,
|
|
||||||
// damit kein verwaister, unregistrierter Tenant zurueckbleibt.
|
|
||||||
func (p *Provisioner) Provision(ctx context.Context, slug, name string) (Tenant, error) {
|
|
||||||
if err := ValidateSlug(slug); err != nil {
|
|
||||||
return Tenant{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
dbName := dbNameForSlug(slug)
|
|
||||||
|
|
||||||
// CREATE DATABASE erlaubt keine Parameter-Platzhalter; slug ist durch
|
|
||||||
// ValidateSlug bereits auf [a-z0-9_] beschraenkt, Injektion ausgeschlossen.
|
|
||||||
if _, err := p.adminPool.Exec(ctx, fmt.Sprintf(`CREATE DATABASE %q`, dbName)); err != nil {
|
|
||||||
return Tenant{}, fmt.Errorf("tenant-datenbank anlegen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t := Tenant{
|
|
||||||
Slug: slug,
|
|
||||||
Name: name,
|
|
||||||
DBName: dbName,
|
|
||||||
DBDSN: fmt.Sprintf(p.dsnTemplate, dbName),
|
|
||||||
Status: StatusActive,
|
|
||||||
}
|
|
||||||
|
|
||||||
tx, err := p.registry.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
p.rollbackDatabase(ctx, dbName)
|
|
||||||
return Tenant{}, fmt.Errorf("registry-transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
created, err := p.registry.insertTx(ctx, tx, t)
|
|
||||||
if err != nil {
|
|
||||||
_ = tx.Rollback(ctx)
|
|
||||||
p.rollbackDatabase(ctx, dbName)
|
|
||||||
return Tenant{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
p.rollbackDatabase(ctx, dbName)
|
|
||||||
return Tenant{}, fmt.Errorf("registry-transaktion committen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return created, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// rollbackDatabase entfernt eine bereits angelegte Tenant-Datenbank, wenn die
|
|
||||||
// Registrierung fehlschlug, damit Provisioning insgesamt atomar wirkt.
|
|
||||||
func (p *Provisioner) rollbackDatabase(ctx context.Context, dbName string) {
|
|
||||||
_, _ = p.adminPool.Exec(ctx, fmt.Sprintf(`DROP DATABASE IF EXISTS %q`, dbName))
|
|
||||||
}
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
package tenant
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Integrationstest fuer Akzeptanzkriterien 2 und 3. Benoetigt eine echte
|
|
||||||
// Postgres-Instanz und wird ohne TEST_ADMIN_DSN uebersprungen, nicht als
|
|
||||||
// fehlgeschlagen gewertet — siehe Pruefungen-Ergebnis im PR.
|
|
||||||
//
|
|
||||||
// TEST_ADMIN_DSN muss auf die Wartungsdatenbank zeigen, z. B.:
|
|
||||||
//
|
|
||||||
// postgresql://postgres:postgres@localhost:5432/postgres?sslmode=disable
|
|
||||||
func TestProvision_CreatesIsolatedDatabases(t *testing.T) {
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
adminPool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("admin pool: %v", err)
|
|
||||||
}
|
|
||||||
defer adminPool.Close()
|
|
||||||
|
|
||||||
registryPool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("registry pool: %v", err)
|
|
||||||
}
|
|
||||||
defer registryPool.Close()
|
|
||||||
|
|
||||||
if _, err := registryPool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS tenants (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
slug TEXT NOT NULL UNIQUE,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
db_name TEXT NOT NULL UNIQUE,
|
|
||||||
db_dsn TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
)`); err != nil {
|
|
||||||
t.Fatalf("registry-schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
dsnTemplate := strings.Replace(adminDSN, "/postgres?", "/%s?", 1)
|
|
||||||
registry := NewRegistry(registryPool)
|
|
||||||
provisioner := NewProvisioner(adminPool, registry, dsnTemplate)
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = registryPool.Exec(ctx, `DELETE FROM tenants WHERE slug IN ('acme','globex')`)
|
|
||||||
_, _ = adminPool.Exec(ctx, `DROP DATABASE IF EXISTS tenant_acme`)
|
|
||||||
_, _ = adminPool.Exec(ctx, `DROP DATABASE IF EXISTS tenant_globex`)
|
|
||||||
})
|
|
||||||
|
|
||||||
tenantA, err := provisioner.Provision(ctx, "acme", "Acme GmbH")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("provision acme: %v", err)
|
|
||||||
}
|
|
||||||
tenantB, err := provisioner.Provision(ctx, "globex", "Globex AG")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("provision globex: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if tenantA.DBName == tenantB.DBName {
|
|
||||||
t.Fatalf("erwartet unterschiedliche db_name, beide sind %q", tenantA.DBName)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 / Pruefung 3: In der Datenbank von Tenant A existiert
|
|
||||||
// keine Verbindungsmoeglichkeit zu Tenant B, weil beide physisch getrennte
|
|
||||||
// Datenbanken sind, statt sich auf einen Query-Filter zu verlassen.
|
|
||||||
poolA, err := pgxpool.New(ctx, tenantA.DBDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("connect tenant a: %v", err)
|
|
||||||
}
|
|
||||||
defer poolA.Close()
|
|
||||||
|
|
||||||
var globexVisible bool
|
|
||||||
err = poolA.QueryRow(ctx, `
|
|
||||||
SELECT EXISTS (
|
|
||||||
SELECT 1 FROM pg_catalog.pg_database WHERE datname = $1
|
|
||||||
)
|
|
||||||
`, tenantB.DBName).Scan(&globexVisible)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pruefung tenant-trennung: %v", err)
|
|
||||||
}
|
|
||||||
// pg_database ist clusterweit sichtbar (Existenz der DB), aber die
|
|
||||||
// eigentliche Pruefung ist: aus poolA (verbunden mit tenant_acme) ist keine
|
|
||||||
// Tabelle/Zeile aus tenant_globex erreichbar, da current_database() getrennt ist.
|
|
||||||
var currentDB string
|
|
||||||
if err := poolA.QueryRow(ctx, `SELECT current_database()`).Scan(¤tDB); err != nil {
|
|
||||||
t.Fatalf("current_database: %v", err)
|
|
||||||
}
|
|
||||||
if currentDB != tenantA.DBName {
|
|
||||||
t.Fatalf("current_database() = %q, want %q — keine physische Trennung", currentDB, tenantA.DBName)
|
|
||||||
}
|
|
||||||
if currentDB == tenantB.DBName {
|
|
||||||
t.Fatalf("tenant a verbindung zeigt auf tenant b datenbank")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
package tenant
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Registry kapselt den Zugriff auf die Control-Plane-Registry-Datenbank.
|
|
||||||
// Sie enthaelt ausschliesslich Tenant-Metadaten (Akzeptanzkriterium 1) —
|
|
||||||
// niemals Geschaeftsdaten eines Mandanten.
|
|
||||||
type Registry struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRegistry(pool *pgxpool.Pool) *Registry {
|
|
||||||
return &Registry{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// insertTx schreibt den Tenant-Datensatz innerhalb einer laufenden Transaktion,
|
|
||||||
// damit Provisioner.Provision DB-Anlage und Registrierung atomar behandeln kann.
|
|
||||||
func (r *Registry) insertTx(ctx context.Context, tx pgx.Tx, t Tenant) (Tenant, error) {
|
|
||||||
row := tx.QueryRow(ctx, `
|
|
||||||
INSERT INTO tenants (slug, name, db_name, db_dsn, status)
|
|
||||||
VALUES ($1, $2, $3, $4, $5)
|
|
||||||
RETURNING id, created_at
|
|
||||||
`, t.Slug, t.Name, t.DBName, t.DBDSN, t.Status)
|
|
||||||
|
|
||||||
if err := row.Scan(&t.ID, &t.CreatedAt); err != nil {
|
|
||||||
return Tenant{}, fmt.Errorf("tenant registrieren: %w", err)
|
|
||||||
}
|
|
||||||
return t, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Registry) GetBySlug(ctx context.Context, slug string) (Tenant, error) {
|
|
||||||
var t Tenant
|
|
||||||
row := r.pool.QueryRow(ctx, `
|
|
||||||
SELECT id, slug, name, db_name, db_dsn, status, created_at
|
|
||||||
FROM tenants WHERE slug = $1
|
|
||||||
`, slug)
|
|
||||||
|
|
||||||
if err := row.Scan(&t.ID, &t.Slug, &t.Name, &t.DBName, &t.DBDSN, &t.Status, &t.CreatedAt); err != nil {
|
|
||||||
return Tenant{}, fmt.Errorf("tenant laden: %w", err)
|
|
||||||
}
|
|
||||||
return t, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Registry) List(ctx context.Context) ([]Tenant, error) {
|
|
||||||
rows, err := r.pool.Query(ctx, `
|
|
||||||
SELECT id, slug, name, db_name, db_dsn, status, created_at
|
|
||||||
FROM tenants ORDER BY created_at
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("tenants auflisten: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []Tenant
|
|
||||||
for rows.Next() {
|
|
||||||
var t Tenant
|
|
||||||
if err := rows.Scan(&t.ID, &t.Slug, &t.Name, &t.DBName, &t.DBDSN, &t.Status, &t.CreatedAt); err != nil {
|
|
||||||
return nil, fmt.Errorf("tenant lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, t)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
// Package tenant implements Core TEN-01: die Control-Plane-Registry und die
|
|
||||||
// Provisioning-Routine fuer physisch getrennte Mandanten-Datenbanken (Modell C).
|
|
||||||
package tenant
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"regexp"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Status string
|
|
||||||
|
|
||||||
const (
|
|
||||||
StatusActive Status = "active"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Tenant struct {
|
|
||||||
ID string
|
|
||||||
Slug string
|
|
||||||
Name string
|
|
||||||
DBName string
|
|
||||||
DBDSN string
|
|
||||||
Status Status
|
|
||||||
CreatedAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// slugPattern erzwingt sichere, als SQL-Identifier verwendbare Slugs, damit
|
|
||||||
// der Datenbankname niemals aus unkontrolliertem Nutzereingabe-Text gebaut wird.
|
|
||||||
var slugPattern = regexp.MustCompile(`^[a-z][a-z0-9_]{1,48}$`)
|
|
||||||
|
|
||||||
var ErrInvalidSlug = errors.New("tenant: slug muss mit Kleinbuchstaben beginnen und darf nur [a-z0-9_] enthalten (2-49 Zeichen)")
|
|
||||||
|
|
||||||
func ValidateSlug(slug string) error {
|
|
||||||
if !slugPattern.MatchString(slug) {
|
|
||||||
return ErrInvalidSlug
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func dbNameForSlug(slug string) string {
|
|
||||||
return "tenant_" + slug
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
package tenant
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestValidateSlug(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
slug string
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{"acme", false},
|
|
||||||
{"acme_gmbh", false},
|
|
||||||
{"a1", false},
|
|
||||||
{"", true},
|
|
||||||
{"a", true},
|
|
||||||
{"1acme", true},
|
|
||||||
{"Acme", true},
|
|
||||||
{"acme-gmbh", true},
|
|
||||||
{"acme;drop table tenants", true},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, c := range cases {
|
|
||||||
err := ValidateSlug(c.slug)
|
|
||||||
if (err != nil) != c.wantErr {
|
|
||||||
t.Errorf("ValidateSlug(%q) error = %v, wantErr %v", c.slug, err, c.wantErr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDBNameForSlug(t *testing.T) {
|
|
||||||
got := dbNameForSlug("acme")
|
|
||||||
want := "tenant_acme"
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("dbNameForSlug() = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AggregateFunc berechnet/aktualisiert Zaehlerstaende aus einer autoritativen
|
|
||||||
// Quelle (z.B. "zaehle Zeilen in einer Modul-Tabelle") — die konkrete Quelle
|
|
||||||
// haengt vom jeweiligen Modul ab und ist nicht Teil dieser Kachel. Das
|
|
||||||
// Aggregations-Grundgerüst selbst (periodischer Trigger) ist es.
|
|
||||||
type AggregateFunc func(ctx context.Context) error
|
|
||||||
|
|
||||||
// RunPeriodicAggregation ruft aggregate in festen Abstaenden auf, bis ctx
|
|
||||||
// beendet wird — dieselbe In-Prozess-Worker-Goroutine-Konvention wie
|
|
||||||
// internal/tenant.Lifecycle.RunSweeper (Akzeptanzkriterium 1: "periodisch
|
|
||||||
// aggregiert").
|
|
||||||
func RunPeriodicAggregation(ctx context.Context, interval time.Duration, aggregate AggregateFunc) {
|
|
||||||
ticker := time.NewTicker(interval)
|
|
||||||
defer ticker.Stop()
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-ticker.C:
|
|
||||||
if err := aggregate(ctx); err != nil {
|
|
||||||
slog.Error("nutzungszaehler-aggregation fehlgeschlagen", "error", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
// Package usage implementiert Core LIC-03: Nutzungszaehler je Tenant
|
|
||||||
// (Benutzeranzahl, Speicherverbrauch, API-Aufrufe, ...) und die Pruefung
|
|
||||||
// gegen konfigurierte Quotas. Quotas sind Konfiguration (Tabellenzeile), kein
|
|
||||||
// Hardcode — Zitadel/Unleash-Vorbild.
|
|
||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrNoQuota = errors.New("usage: keine quota fuer diese metrik konfiguriert")
|
|
||||||
|
|
||||||
// Status ist die definierte Reaktion einer Quota-Pruefung (Akzeptanzkriterium 2).
|
|
||||||
type Status string
|
|
||||||
|
|
||||||
const (
|
|
||||||
StatusOK Status = "ok"
|
|
||||||
StatusWarning Status = "warning" // Schwelle (80%) erreicht, aber noch nicht ueberschritten
|
|
||||||
StatusExceeded Status = "exceeded" // Quota ueberschritten — neue Ressourcen sollten gesperrt werden
|
|
||||||
)
|
|
||||||
|
|
||||||
// warningThreshold liegt bei 80% der Quota.
|
|
||||||
const warningThreshold = 0.8
|
|
||||||
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Increment erhoeht einen Zaehler ATOMAR ueber ein einziges SQL-Statement
|
|
||||||
// (UPSERT mit value = value + delta) statt Read-Modify-Write in Go — das
|
|
||||||
// haelt Zaehlerstaende bei parallelen Schreibzugriffen konsistent
|
|
||||||
// (Akzeptanzkriterium 1 / Pruefung 2), ohne eine Anwendungs-Transaktion mit
|
|
||||||
// Lock zu brauchen.
|
|
||||||
func (s *Store) Increment(ctx context.Context, tenantID, metric string, delta int64) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO usage_counters (tenant_id, metric, value, updated_at)
|
|
||||||
VALUES ($1, $2, $3, now())
|
|
||||||
ON CONFLICT (tenant_id, metric) DO UPDATE
|
|
||||||
SET value = usage_counters.value + $3, updated_at = now()
|
|
||||||
`, tenantID, metric, delta)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("zaehler erhoehen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den aktuellen Zaehlerstand — 0, wenn noch nie erhoeht wurde.
|
|
||||||
// Der Wert ist strikt tenant-gescoped (Akzeptanzkriterium 3 / Pruefung 3).
|
|
||||||
func (s *Store) Get(ctx context.Context, tenantID, metric string) (int64, error) {
|
|
||||||
var value int64
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT value FROM usage_counters WHERE tenant_id = $1 AND metric = $2
|
|
||||||
`, tenantID, metric).Scan(&value)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("zaehler lesen: %w", err)
|
|
||||||
}
|
|
||||||
return value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetQuota legt die Obergrenze fuer (tenantID, metric) fest — Konfiguration,
|
|
||||||
// kein Hardcode.
|
|
||||||
func (s *Store) SetQuota(ctx context.Context, tenantID, metric string, limit int64) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO usage_quotas (tenant_id, metric, limit_value)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
ON CONFLICT (tenant_id, metric) DO UPDATE SET limit_value = $3
|
|
||||||
`, tenantID, metric, limit)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("quota setzen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) GetQuota(ctx context.Context, tenantID, metric string) (int64, error) {
|
|
||||||
var limit int64
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT limit_value FROM usage_quotas WHERE tenant_id = $1 AND metric = $2
|
|
||||||
`, tenantID, metric).Scan(&limit)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return 0, ErrNoQuota
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("quota lesen: %w", err)
|
|
||||||
}
|
|
||||||
return limit, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check liefert Zaehlerstand, konfigurierte Quota und die daraus abgeleitete
|
|
||||||
// Reaktion (Akzeptanzkriterium 2 / Pruefung 1). Ist keine Quota konfiguriert,
|
|
||||||
// gilt die Metrik als unbegrenzt (StatusOK).
|
|
||||||
func (s *Store) Check(ctx context.Context, tenantID, metric string) (value, limit int64, status Status, err error) {
|
|
||||||
value, err = s.Get(ctx, tenantID, metric)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
limit, err = s.GetQuota(ctx, tenantID, metric)
|
|
||||||
if errors.Is(err, ErrNoQuota) {
|
|
||||||
return value, 0, StatusOK, nil
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case value > limit:
|
|
||||||
return value, limit, StatusExceeded, nil
|
|
||||||
case limit > 0 && float64(value) >= warningThreshold*float64(limit):
|
|
||||||
return value, limit, StatusWarning, nil
|
|
||||||
default:
|
|
||||||
return value, limit, StatusOK, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reaction wird aufgerufen, wenn Check einen Nicht-OK-Status liefert
|
|
||||||
// (Akzeptanzkriterium 2: "definierte Reaktion").
|
|
||||||
type Reaction func(ctx context.Context, tenantID, metric string, value, limit int64, status Status)
|
|
||||||
|
|
||||||
// Enforce fuehrt Check aus und ruft react auf, wenn der Status nicht OK ist —
|
|
||||||
// die konkrete "Sperre neuer Ressourcen"/Benachrichtigung liegt beim
|
|
||||||
// Aufrufer (z.B. TEN-02 vor dem Anlegen eines neuen Benutzers), Enforce
|
|
||||||
// garantiert nur, dass die Reaktion zuverlaessig ausgeloest wird.
|
|
||||||
func (s *Store) Enforce(ctx context.Context, tenantID, metric string, react Reaction) (Status, error) {
|
|
||||||
value, limit, status, err := s.Check(ctx, tenantID, metric)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if status != StatusOK && react != nil {
|
|
||||||
react(ctx, tenantID, metric, value, limit, status)
|
|
||||||
}
|
|
||||||
return status, nil
|
|
||||||
}
|
|
||||||
@@ -1,206 +0,0 @@
|
|||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*Store, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_counters (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, value BIGINT NOT NULL DEFAULT 0,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(), PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_quotas (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, limit_value BIGINT NOT NULL,
|
|
||||||
PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return NewStore(pool), cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTenantID() string {
|
|
||||||
return fmt.Sprintf("00000000-0000-0000-0000-%012d", time.Now().UnixNano()%1e12)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Aggregationsjob liefert bei parallelen
|
|
||||||
// Schreibzugriffen konsistente Zaehlerstaende.
|
|
||||||
func TestIncrement_ConsistentUnderConcurrentWrites(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
const goroutines = 50
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < goroutines; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
if err := store.Increment(ctx, tenant, "api_calls", 1); err != nil {
|
|
||||||
t.Errorf("increment: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
value, err := store.Get(ctx, tenant, "api_calls")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
if value != goroutines {
|
|
||||||
t.Fatalf("erwartet %d, habe %d (hinweis auf lost update unter nebenlaeufigkeit)", goroutines, value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: Zaehlerstand eines Tenants beeinflusst
|
|
||||||
// nicht den eines anderen.
|
|
||||||
func TestIncrement_IsolatedBetweenTenants(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenantA, tenantB := newTenantID(), newTenantID()
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenantA, "users", 5); err != nil {
|
|
||||||
t.Fatalf("increment a: %v", err)
|
|
||||||
}
|
|
||||||
if err := store.Increment(ctx, tenantB, "users", 1); err != nil {
|
|
||||||
t.Fatalf("increment b: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
valA, err := store.Get(ctx, tenantA, "users")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get a: %v", err)
|
|
||||||
}
|
|
||||||
valB, err := store.Get(ctx, tenantB, "users")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get b: %v", err)
|
|
||||||
}
|
|
||||||
if valA != 5 || valB != 1 {
|
|
||||||
t.Fatalf("erwartet a=5 b=1, habe a=%d b=%d", valA, valB)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: Quota-Ueberschreitung wird automatisiert
|
|
||||||
// erkannt und die definierte Reaktion ausgeloest.
|
|
||||||
func TestEnforce_TriggersReactionOnExceeded(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.SetQuota(ctx, tenant, "users", 10); err != nil {
|
|
||||||
t.Fatalf("set quota: %v", err)
|
|
||||||
}
|
|
||||||
if err := store.Increment(ctx, tenant, "users", 11); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var reacted bool
|
|
||||||
var gotStatus Status
|
|
||||||
status, err := store.Enforce(ctx, tenant, "users", func(ctx context.Context, tenantID, metric string, value, limit int64, status Status) {
|
|
||||||
reacted = true
|
|
||||||
gotStatus = status
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enforce: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusExceeded {
|
|
||||||
t.Fatalf("erwartet StatusExceeded, habe %q", status)
|
|
||||||
}
|
|
||||||
if !reacted || gotStatus != StatusExceeded {
|
|
||||||
t.Fatal("erwartet ausgeloeste reaktion mit StatusExceeded")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheck_WarningThresholdAndOK(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.SetQuota(ctx, tenant, "storage_mb", 100); err != nil {
|
|
||||||
t.Fatalf("set quota: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "storage_mb", 50); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err := store.Check(ctx, tenant, "storage_mb")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusOK {
|
|
||||||
t.Fatalf("bei 50%% erwartet StatusOK, habe %q", status)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "storage_mb", 35); err != nil { // insgesamt 85%
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err = store.Check(ctx, tenant, "storage_mb")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusWarning {
|
|
||||||
t.Fatalf("bei 85%% erwartet StatusWarning, habe %q", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheck_NoQuotaMeansUnlimited(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "api_calls", 1_000_000); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err := store.Check(ctx, tenant, "api_calls")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusOK {
|
|
||||||
t.Fatalf("ohne konfigurierte quota erwartet StatusOK, habe %q", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunPeriodicAggregation_CallsRepeatedly(t *testing.T) {
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 120*time.Millisecond)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
var mu sync.Mutex
|
|
||||||
calls := 0
|
|
||||||
RunPeriodicAggregation(ctx, 20*time.Millisecond, func(ctx context.Context) error {
|
|
||||||
mu.Lock()
|
|
||||||
calls++
|
|
||||||
mu.Unlock()
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
if calls < 3 {
|
|
||||||
t.Fatalf("erwartet mehrfache aufrufe innerhalb von 120ms bei 20ms interval, habe %d", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS tenants;
|
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
-- Control-plane registry: tenant list + connection info (Modell C).
|
||||||
|
-- Core TEN-01 (siehe core-kanban).
|
||||||
|
CREATE TABLE tenants (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
slug TEXT NOT NULL UNIQUE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
db_dsn TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active',
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
-- Control-plane registry: Tenant-Liste + Verbindungsinformationen (Modell C).
|
|
||||||
-- Enthaelt AUSSCHLIESSLICH Tenant-Metadaten, keine Geschaeftsdaten eines Mandanten.
|
|
||||||
-- Core TEN-01 (siehe core-kanban/tickets/TEN-01.md).
|
|
||||||
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
|
||||||
|
|
||||||
CREATE TABLE tenants (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
slug TEXT NOT NULL UNIQUE,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
db_name TEXT NOT NULL UNIQUE,
|
|
||||||
db_dsn TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS audit_events;
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
-- Zentrales Audit-Log-Modell (AUD-01, siehe core-kanban/tickets/AUD-01.md).
|
|
||||||
-- Getrennt vom allgemeinen Anwendungs-Log (Akzeptanzkriterium 2): eigene
|
|
||||||
-- Tabelle, eigenes Paket (internal/audit), kein Log-Framework.
|
|
||||||
-- tenant_slug ist NOT NULL + darf nicht leer sein (Akzeptanzkriterium 2 /
|
|
||||||
-- Pruefung 2) — mandantenuebergreifende Ereignisse nutzen den reservierten
|
|
||||||
-- Wert 'system', niemals NULL oder leeren String.
|
|
||||||
CREATE TABLE audit_events (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
|
||||||
actor TEXT NOT NULL CHECK (actor <> ''),
|
|
||||||
action TEXT NOT NULL CHECK (action <> ''),
|
|
||||||
target TEXT NOT NULL,
|
|
||||||
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE INDEX audit_events_tenant_slug_idx ON audit_events (tenant_slug, occurred_at);
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS feature_flags;
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user