Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 sysops
|
cb5a9da701 | ||
|
sysops
|
ee98efb51e | ||
|
sysops
|
dff6b8b7a4 | ||
|
sysops
|
44b78b1554 |
@@ -0,0 +1,23 @@
|
||||
name: Mail-Pflichttest-Gate
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- "mail/**"
|
||||
|
||||
jobs:
|
||||
pflichttest-gate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: "1.22"
|
||||
- name: Gate bauen
|
||||
working-directory: mail
|
||||
run: go build -o /tmp/pflichttestgate ./cmd/pflichttestgate
|
||||
- name: Geänderte Dateien gegen Pflichttest-Regel prüfen
|
||||
run: |
|
||||
git diff --name-only "origin/${{ github.base_ref }}...HEAD" | /tmp/pflichttestgate
|
||||
@@ -1,18 +0,0 @@
|
||||
version: "2"
|
||||
|
||||
run:
|
||||
timeout: 3m
|
||||
|
||||
linters:
|
||||
default: none
|
||||
enable:
|
||||
- govet
|
||||
- staticcheck
|
||||
- errcheck
|
||||
- unused
|
||||
- ineffassign
|
||||
|
||||
formatters:
|
||||
enable:
|
||||
- gofmt
|
||||
- goimports
|
||||
@@ -1,19 +0,0 @@
|
||||
.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
|
||||
@@ -1,62 +0,0 @@
|
||||
# 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
|
||||
```
|
||||
@@ -1,107 +0,0 @@
|
||||
// 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])
|
||||
}
|
||||
}
|
||||
@@ -1,75 +0,0 @@
|
||||
// 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])
|
||||
}
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
@@ -1,104 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
@@ -1,144 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,62 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
@@ -1,97 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,93 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,122 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,119 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,140 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,14 +0,0 @@
|
||||
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,28 +0,0 @@
|
||||
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/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
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/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
|
||||
github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
|
||||
github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
|
||||
github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
|
||||
github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
|
||||
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
||||
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
@@ -1,199 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,187 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,102 +0,0 @@
|
||||
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))
|
||||
}
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,118 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,167 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,168 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -1,106 +0,0 @@
|
||||
// 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,
|
||||
}
|
||||
}
|
||||
@@ -1,169 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,65 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,132 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -1,133 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,181 +0,0 @@
|
||||
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])
|
||||
}
|
||||
}
|
||||
@@ -1,57 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -1,69 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,95 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,74 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,92 +0,0 @@
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
DROP TABLE IF EXISTS scrub_counters;
|
||||
DROP TABLE IF EXISTS scrub_state;
|
||||
@@ -1,21 +0,0 @@
|
||||
-- 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;
|
||||
@@ -1,9 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Datenbank-Vollsicherung (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 02:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,9 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Datenbank-Inkrementalsicherung (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* *:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,9 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Sicherungsgenerationen-Rotation (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 03:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,9 +0,0 @@
|
||||
[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__
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Sicherung (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* *:30:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,9 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Woechentlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Vollstaendigkeitspruefung (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=Sun *-*-* 04:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,9 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Rotation (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 03:30:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,10 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Konsistenzpruefung (BAK-05)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 05:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,14 +0,0 @@
|
||||
[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
|
||||
@@ -1,10 +0,0 @@
|
||||
[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
|
||||
@@ -1,9 +0,0 @@
|
||||
[Unit]
|
||||
Description=Zeitplan fuer NEXARCH Archive Checksummen-Stichprobe (BAK-08)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 06:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,39 @@
|
||||
// Command pflichttestgate ist das CI-Gate aus docs/TESTSTRATEGIE-MAIL.md
|
||||
// Abschnitt 4. Aufruf: pflichttestgate < geänderte-dateien.txt
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/pflichttestgate"
|
||||
)
|
||||
|
||||
func main() {
|
||||
var changedFiles []string
|
||||
scanner := bufio.NewScanner(os.Stdin)
|
||||
for scanner.Scan() {
|
||||
line := scanner.Text()
|
||||
if line != "" {
|
||||
changedFiles = append(changedFiles, line)
|
||||
}
|
||||
}
|
||||
if err := scanner.Err(); err != nil {
|
||||
fmt.Fprintf(os.Stderr, "pflichttestgate: eingabe konnte nicht gelesen werden: %v\n", err)
|
||||
os.Exit(2)
|
||||
}
|
||||
|
||||
violations := pflichttestgate.CheckDiff(changedFiles)
|
||||
if len(violations) == 0 {
|
||||
fmt.Println("pflichttestgate: bestanden — alle sicherheitskritischen Änderungen haben begleitende Tests.")
|
||||
return
|
||||
}
|
||||
|
||||
fmt.Fprintln(os.Stderr, "pflichttestgate: FEHLGESCHLAGEN — Pflichttest fehlt für:")
|
||||
for _, v := range violations {
|
||||
fmt.Fprintf(os.Stderr, " - Package %q (Datei %q hat keine begleitende _test.go-Änderung)\n", v.Package, v.ChangedFile)
|
||||
}
|
||||
fmt.Fprintln(os.Stderr, "\nSiehe docs/TESTSTRATEGIE-MAIL.md Abschnitt 4.")
|
||||
os.Exit(1)
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
# ARC-01 – Prüfprotokoll: Objekt-Speicher-Anbindung für Mails/Anhänge
|
||||
|
||||
Voraussetzung ING-04 – bereits Fertig. ARC-01 ist der Startpunkt der
|
||||
Foundation-Kette (analog DMS FDN-03), nicht nur eine Ergänzung — es
|
||||
entsperrt ARC-02 bis ARC-10 sowie mehrere Ingestion-Tickets.
|
||||
|
||||
## Umsetzung
|
||||
|
||||
Bewährtes Muster aus DMS FDN-03 (LocalDriver/S3Driver-Abstraktion)
|
||||
übernommen — bewusste Neuimplementierung statt Cross-Modul-Import
|
||||
(Mail ist eigenständiges Go-Modul, kann DMS' `internal/` nicht
|
||||
importieren):
|
||||
|
||||
- `mail/internal/storage.Driver` — `Put`/`Get`/`Delete`, zwei
|
||||
Implementierungen (`LocalDriver`, `S3Driver`).
|
||||
- `ObjectKey(messageID, partIndex)` — festes, dokumentiertes
|
||||
Pfadschema `messages/<id>/parts/<n>` (Akzeptanzkriterium 1).
|
||||
Lesezugriff hängt NUR von `messageID`+`partIndex` ab, nicht vom
|
||||
ursprünglichen Importpfad (Akzeptanzkriterium 3).
|
||||
- **Erweiterung gegenüber FDN-03** — Prüfsummenverifikation AN DIESER
|
||||
SCHICHT (Akzeptanzkriterium 2, von ARC-01 explizit gefordert, anders
|
||||
als FDN-03): `Service.Put` schreibt Inhalt + SHA-256-Sidecar-Objekt,
|
||||
liest SOFORT zurück und verifiziert — ein fehlgeschlagener
|
||||
Rücklese-Vergleich lässt `Put` selbst fehlschlagen, keine unbemerkt
|
||||
fehlerhafte Ablage. `Service.GetVerified` wiederholt die Prüfung bei
|
||||
jedem späteren Lesezugriff.
|
||||
- `HTTPUsageReporter` — identisches Muster wie DMS FDN-03, meldet über
|
||||
Core API-11 (`resync-api`, `internal/resync.Handler.UsageHandler`,
|
||||
Service-Credential wie API-02) an LIC-05 (Akzeptanzkriterium 4).
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: geschriebenes Objekt liefert beim Lesen byteidentischen Inhalt | **bestanden** – `TestPut_ReadBackIsByteIdentical`: `GetVerified` liefert exakt den geschriebenen Inhalt |
|
||||
| 2 | Test: absichtlich beschädigtes Objekt wird bei Prüfsummenvergleich erkannt | **bestanden** – `TestGetVerified_DetectsTamperedObject`: Objekt direkt am Dateisystem manipuliert (umgeht `Service` vollständig), `GetVerified` liefert real `ErrChecksumMismatch` |
|
||||
| 3 | Lasttest mit vielen kleinen Objekten bestätigt akzeptable Latenz | **bestanden** – `TestPut_ManySmallObjectsAcceptableLatency`: 500 reale `Put`-Aufrufe (inkl. Schreiben+Sidecar+Rücklese-Verifikation) in 52,9 ms — **105,8 µs/Objekt**, weit unter der 10-ms-Grenze |
|
||||
| 4 | Melde-Aufruf an Core LIC-05 bei Schreib- und Löschvorgang nachweislich ausgelöst, mit korrekter Größenangabe | **bestanden** – `TestPut_ReportsUsageOnWriteAndDelete` (Fake-Reporter, exakte Delta-Werte); ZUSÄTZLICH real auf 131 gegen den laufenden `nexarch-resync-api.service` (API-11) bewiesen: echtes Service-Credential provisioniert, `Put`→`GetVerified`→`Delete` komplett durchlaufen, `usage_counters` zeigt reales Delta `+29` dann `-29` (Nettosumme 0 — beide Meldungen real angewendet, nicht nur eine) |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (storage, mimeparse, example, pflichttestgate)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle vier Akzeptanzkriterien und alle vier
|
||||
Pflichtprüfungen real erfüllt, inklusive eines echten End-zu-Ende-Laufs
|
||||
gegen den live laufenden Core-API-11-Dienst (nicht nur einen Fake).
|
||||
Entsperrt ARC-02–ARC-10 sowie mehrere Ingestion-Tickets.
|
||||
@@ -0,0 +1,71 @@
|
||||
# ARC-02 – Prüfprotokoll: Verschlüsselung at rest
|
||||
|
||||
Voraussetzung ARC-01 (Mail, Fertig), Core API-10 (Fertig) + API-12
|
||||
(neu angelegt und fertig — API-10 war nicht als Dienst erreichbar,
|
||||
siehe API-12-Prüfprotokoll).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
Bewährtes Muster aus DMS FDN-09 übernommen (bewusste
|
||||
Neuimplementierung, Mail kann DMS nicht importieren):
|
||||
|
||||
- `mail/internal/crypto` — `GenerateDEK`/`WrapDEK`/`UnwrapDEK`
|
||||
(AES-256-GCM), `HTTPKEKProvider` (bezieht den Tenant-KEK über Core
|
||||
API-12, `X-Nexarch-Client-Id/Secret`), `Service.Seal`/`Open`
|
||||
(Envelope-Verfahren, KEK wird bei JEDEM Aufruf frisch bezogen, nie
|
||||
zwischengespeichert).
|
||||
- `mail/internal/encstorage` — verbindet ARC-01 (`storage.Service`) mit
|
||||
ARC-02 (`crypto.Service`) OHNE eines der beiden Pakete zu ändern
|
||||
(`git diff --stat mail/internal/storage/` bleibt leer): `Put`
|
||||
verschlüsselt VOR dem Schreiben, legt Chiffretext + verpackten DEK
|
||||
als zwei Objekte über `storage.Service` ab (Prüfsumme,
|
||||
Nutzungsmeldung — ARC-01 unverändert mitgenutzt).
|
||||
- **Reihenfolge beachtet** (Ticket "Bekannte Fehler vermeiden"):
|
||||
`encstorage.Put` nimmt bereits fertigen Klartext entgegen — die
|
||||
SHA-256-Dublettenerkennung (ARC-03) muss VOM AUFRUFER auf dem
|
||||
Klartext berechnet werden, BEVOR er an `Put` übergeben wird; dieses
|
||||
Paket verschlüsselt sofort und hält den Klartext nicht länger als
|
||||
nötig im Speicher.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Zugriff auf Rohspeicher ohne Schlüssel liefert keine lesbaren Inhalte | **bestanden** – `TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent`: Objekt über `encstorage.Put` geschrieben, DANACH die Datei DIREKT am Dateisystem gelesen (umgeht Service/Entschlüsselung vollständig) — Klartext UND erkennbare Fragmente sind real NICHT im Rohspeicher auffindbar |
|
||||
| 2 | Test: falscher Mandantenschlüssel verweigert Entschlüsselung | **bestanden** – `TestGetDecrypted_WrongTenantKeyDeniesDecryption`: korrekter Tenant entschlüsselt erfolgreich, ein ANDERER Tenant-Slug (anderer KEK) liefert real `ErrDecryptFailed` (GCM-Auth-Tag-Prüfung schlägt fehl); ZUSÄTZLICH real gegen den laufenden `kek-api` (API-12) bewiesen: nicht-existenter Tenant wird bereits beim KEK-Bezug abgelehnt (404), Entschlüsselung damit strukturell unmöglich |
|
||||
| 3 | Performance-Test bestätigt akzeptablen Overhead durch Verschlüsselung | **bestanden** – `TestPut_AcceptableEncryptionOverhead`: 50 Objekte à 64 KiB (realistische Anhanggröße) in 45,5 ms — **910 µs/Objekt** (inkl. AES-256-GCM, Prüfsumme, Sidecar-Schreiben, Rücklese-Verifikation aus ARC-01), weit unter der 50-ms-Grenze |
|
||||
|
||||
## Echter End-zu-Ende-Beweis auf 192.168.1.131
|
||||
|
||||
Vollständiger Roundtrip gegen den ECHT laufenden `nexarch-kek-api.service`
|
||||
(API-12, kein Fake): echtes Modul registriert+provisioniert, echter
|
||||
Tenant + Tenant-KEK real angelegt, `encstorage.Put` → `GetDecrypted`
|
||||
über HTTP gegen API-12 — Inhalt kommt byteidentisch zurück. Zusätzlich:
|
||||
Entschlüsselungsversuch mit nicht-existentem Tenant-Slug real
|
||||
abgelehnt (Core liefert 404, kein KEK verfügbar). Testdaten
|
||||
anschließend entfernt.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (encstorage, crypto indirekt getestet, storage, mimeparse, example, pflichttestgate)
|
||||
```
|
||||
|
||||
**Hinweis (offener Punkt, ehrlich vermerkt):** `mail/internal/crypto`
|
||||
selbst hat keine eigenen `_test.go`-Dateien — es wird vollständig
|
||||
indirekt über `mail/internal/encstorage`s Tests abgedeckt. Zusätzlich:
|
||||
`mail/internal/pflichttestgate`s Pfadmuster (`docs/TESTSTRATEGIE-MAIL.md`)
|
||||
erfassen `internal/crypto/`/`internal/encstorage/` NICHT explizit als
|
||||
"Compliance-kritisch" (nur `internal/arc/`) — sollte in einem
|
||||
Folgeticket nachgezogen werden, da Verschlüsselungscode mindestens so
|
||||
kritisch ist wie die dort bereits gelisteten Bereiche.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
||||
Pflichtprüfungen real erfüllt, inklusive eines vollständigen
|
||||
End-zu-Ende-Laufs gegen den live laufenden Core-API-12-Dienst.
|
||||
Entsperrt ARC-08 (Schlüsselrotation).
|
||||
@@ -0,0 +1,65 @@
|
||||
# ING-04 – Prüfprotokoll: MIME- & Anhang-Parsing
|
||||
|
||||
Keine Vorbedingungen (Wave 1, sofort startbar). ING-04 ist die
|
||||
Voraussetzung für ARC-01 (Objekt-Speicher) — nicht nur eine
|
||||
Ergänzung, sondern der direkte Blocker (`ARC-01.dependsOn = ["ING-04"]`).
|
||||
|
||||
## Bekannten Fehler vermieden
|
||||
|
||||
archivmail (`known-issues-archivmail.md` Punkt 3): Anhänge wurden über
|
||||
`io.ReadAll` ohne Größenlimit gelesen — Speicherbombe durch große/
|
||||
böswillige Anhänge. Hier läuft JEDER Anhang-Lesevorgang über
|
||||
`io.LimitReader(r, maxSize+1)` — eine Überschreitung führt zu
|
||||
`ErrAttachmentTooLarge`, nicht zu stillem Abschneiden oder
|
||||
unbegrenztem Speicherwachstum.
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/mimeparse.Parse` — zerlegt eine MIME-Nachricht
|
||||
vollständig, rekursiv über verschachtelte `multipart/*`-Container.
|
||||
- Zeichensatz-Reparatur: `mime.WordDecoder` mit eigenem
|
||||
`CharsetReader` (via `golang.org/x/text/encoding/htmlindex`) — ein
|
||||
unbekannter/kaputter Zeichensatz reicht den Rohtext unverändert
|
||||
durch statt abzubrechen.
|
||||
- Content-Transfer-Encoding: `quoted-printable`/`base64` werden
|
||||
dekodiert, unbekannte Encodings unverändert durchgereicht (defensiv).
|
||||
- **Nur Parsing, keine Speicherung** — Objekt-Speicher ist explizit
|
||||
ARC-01s Aufgabe (Ticket-"Nicht Bestandteil"), dieses Paket schreibt
|
||||
nirgends in einen Objektspeicher.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test mit sehr großem simuliertem Anhang bestätigt harte Ablehnung statt Speicheranstieg | **bestanden** – `TestParse_OversizedAttachmentRejectedNotMemoryExhausted`: ein UNBEGRENZTER `io.Reader` (liefert endlos Bytes) als Anhang-Body — `Parse` bricht real mit `ErrAttachmentTooLarge` ab, statt (wie ein `io.ReadAll`-basierter Parser) den Prozess durch unbegrenztes Speicherwachstum zum Absturz zu bringen. Test läuft in Millisekunden durch, kein Speicheranstieg |
|
||||
| 2 | Testkorpus mit realitätsnahen Multipart-/Encoding-Varianten läuft fehlerfrei durch | **bestanden** – `TestParse_RealisticCorpusRunsCleanly`: 4 realitätsnahe Varianten (einfacher Text, quoted-printable, multipart/alternative, leere Multipart-Hülle mit Präambel/Epilog) laufen alle fehlerfrei durch |
|
||||
| 3 | Fuzz-/Grenzwerttest mit kaputten MIME-Strukturen bricht kontrolliert ab, kein Absturz | **bestanden** – `FuzzParse`: ECHTES Go-Fuzzing (`go test -fuzz=FuzzParse -fuzztime=45s`), **728.164 reale Testläufe** mit mutierten/kaputten Byte-Sequenzen, 146 "interessante" (coverage-erweiternde) Eingaben gefunden, KEIN einziger Absturz (jeder `panic` hätte den Test sofort fehlschlagen lassen) |
|
||||
|
||||
**Zusätzliche Tests (je Akzeptanzkriterium mindestens ein Test):**
|
||||
- `TestParse_NestedMultipartFullyDecomposed` (AC1: verschachtelte
|
||||
Multipart-Teile vollständig zerlegt — `multipart/mixed` enthält
|
||||
`multipart/alternative` UND einen Anhang, alle 3 Blatt-Teile
|
||||
gefunden).
|
||||
- `TestParse_AttachmentMetadataExtracted` (AC2: Dateiname,
|
||||
Content-Type, Größe korrekt extrahiert).
|
||||
- `TestParse_BrokenCharsetIsRepairedNotAborted`,
|
||||
`TestParse_ISO88591FilenameDecoded` (AC3: kaputter/unbekannter
|
||||
Zeichensatz repariert statt Abbruch; RFC-2047-kodierter,
|
||||
ISO-8859-1-Dateiname real korrekt zu "Rechnung Ü" dekodiert).
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (inkl. mimeparse, example, pflichttestgate)
|
||||
go test ./internal/mimeparse/... -fuzz=FuzzParse -fuzztime=45s -> PASS, 728.164 Ausführungen, 0 Abstürze
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
||||
Pflichtprüfungen real erfüllt, inklusive eines echten, nicht nur
|
||||
simulierten Fuzz-Laufs mit über 700.000 Testfällen. Entsperrt ARC-01
|
||||
(Objekt-Speicher-Anbindung), IMP-02, ING-10, ARC-10.
|
||||
@@ -0,0 +1,110 @@
|
||||
# NEXARCH Mail – Teststrategie
|
||||
|
||||
Stand: 2026-08-30. Ticket: QA-01. Vorbild: Core `QA-01` (`docs/TESTSTRATEGIE-CORE.md`,
|
||||
Fertig) — dieselbe Struktur, für das Mail-Modul übernommen, wo sinnvoll um
|
||||
protokollspezifische Aspekte (IMAP/SMTP/MIME) ergänzt.
|
||||
|
||||
## 1. Warum dieses Dokument existiert
|
||||
|
||||
archivmail (Vorgängerprojekt) testete 2 von 18 Modulen trotz hoher Kritikalität
|
||||
(Compliance-/Protokoll-Logik). Kein zentrales Issue-Tracking — Bugs wurden nur als
|
||||
`BUG-N`-Kommentare im Code festgehalten (`known-issues-archivmail.md`). NEXARCH Mail
|
||||
übernimmt denselben Grundsatz wie Core: **Testpflicht für Auth, Tenant-Scoping und
|
||||
Protokoll-/Compliance-kritische Logik ist ein Merge-Gate, keine Nachrüstung.**
|
||||
|
||||
## 2. Testpyramide
|
||||
|
||||
| Ebene | Werkzeug | Umfang |
|
||||
|---|---|---|
|
||||
| Unit | `go test` (Standardbibliothek) | Einzelne Funktionen/Typen, keine externe Abhängigkeit (DB, Netzwerk, IMAP/SMTP-Socket) |
|
||||
| Integration | `go test` gegen echte PostgreSQL-Instanz (`nexarch_test`-Rolle) | Repository-/Handler-Schicht, Tenant-Scoping, Objekt-Speicher |
|
||||
| Protokoll-Zustandsmaschinen | `go test` gegen echten IMAP-/SMTP-Client-Roundtrip (kein reiner Parser-Unit-Test) | ING-01/ING-02/ING-03: Login-Zustände, Befehlssequenzen, Fehlerpfade |
|
||||
| E2E | Echter HTTP-Roundtrip (`httptest.Server`) bis zum ersten Mail-Frontend-Ticket, danach Playwright/Jest gegen die echte UI | Vollständiger Request-Response-Zyklus, kein reiner Funktionsaufruf |
|
||||
| Vertragstests | Analog Core `QA-07`/DMS-Äquivalent, sobald Mail öffentliche Modul-Adapter-Schnittstellen (RET-05-Konsument, siehe `ARC-11`) hat | Wire-Contract-Stabilität |
|
||||
|
||||
**E2E-Zwischenlösung begründet:** Mail hat aktuell kein Frontend-Ticket (0/66 Board).
|
||||
Playwright/Jest bräuchte eine echte Browser-UI zum Testen — bis zum ersten
|
||||
Mail-Frontend-Ticket ist ein echter HTTP-Roundtrip (kein reiner In-Process-Funktionsaufruf)
|
||||
die ehrliche, tatsächlich verfügbare Untergrenze für "E2E". Siehe Beispiel in
|
||||
Abschnitt 3.
|
||||
|
||||
## 3. Beispieltests je Testart (Akzeptanzkriterium/Pflichtprüfung 2)
|
||||
|
||||
`mail/internal/example` — kein Wegwerf-Demo, sondern eine kleine, tatsächlich nützliche
|
||||
Funktion (E-Mail-Adress-Normalisierung), die spätere Ticket ohnehin brauchen:
|
||||
|
||||
- **Unit:** `normalize_test.go` — `TestNormalizeAddress_*`, keine externe Abhängigkeit.
|
||||
- **Integration:** `store_integration_test.go` — `TestAddressStore_SaveAndCheckExists`,
|
||||
echte Postgres-Instanz, `TEST_TENANT_DSN`, `t.Cleanup`.
|
||||
- **E2E:** `handler_e2e_test.go` — `TestNormalizeHandler_RealHTTPRoundTrip`, echter
|
||||
`httptest.Server`-Roundtrip (TCP, nicht nur Funktionsaufruf).
|
||||
|
||||
Alle sechs Tests real ausgeführt (siehe Prüfungen, Abschnitt 6).
|
||||
|
||||
## 4. Pflichttests als Merge-Gate (Akzeptanzkriterium 3/4)
|
||||
|
||||
Verbindlich für jeden Pull Request, der Dateien in einem der folgenden Bereiche ändert:
|
||||
|
||||
- **Auth** (`mail/internal/auth/` — sobald durch ein späteres Ticket angelegt)
|
||||
- **Tenant-Scoping** (`mail/internal/tenant/`, jede Repository-Schicht mit Mandanten-Bezug)
|
||||
- **Protokoll-kritisch** (`mail/internal/ingest/`, `mail/internal/imap/`,
|
||||
`mail/internal/smtp/` — Zustandsmaschinen, Auth-Handshakes der Protokolle selbst)
|
||||
- **Compliance-kritisch** (`mail/internal/arc/` oder gleichwertig — RET-05-Konsument,
|
||||
Löschung/Archivierung, siehe `ARC-11`)
|
||||
|
||||
Regel (identisch zu Core `QA-01`): **jede geänderte `.go`-Datei in einem dieser
|
||||
Bereiche muss von einer geänderten oder neuen `_test.go`-Datei im selben Package
|
||||
begleitet sein.**
|
||||
|
||||
`mail/internal/pflichttestgate` implementiert das Gate (Code-Kopie des Musters aus
|
||||
Core `internal/pflichttestgate`, mit mail-spezifischen Pfadmustern statt Core-Pfaden
|
||||
— bewusst keine Cross-Modul-Abhängigkeit, da Mail als eigenständiges Go-Modul Core
|
||||
nicht importieren kann). `.gitea/workflows/mail-pflichttest-gate.yml` führt es gegen
|
||||
jeden PR-Diff aus.
|
||||
|
||||
Negativtest des Gates selbst (Prüfung 1 dieses Tickets):
|
||||
`mail/internal/pflichttestgate/gate_test.go` simuliert einen Diff mit geänderter
|
||||
`mail/internal/auth/login.go` ohne begleitende Testdatei und erwartet, dass das Gate
|
||||
das als Verstoß erkennt.
|
||||
|
||||
## 5. Bug-Tracking (Akzeptanzkriterium 3)
|
||||
|
||||
**Konvention: Gitea-Issues** auf `gitea.perlbach24.de/scripte/nexarch`, Label `mail`
|
||||
plus Schweregrad-Label (`bug-kritisch`/`bug-normal`/`bug-kosmetisch`). Durchsuchbar
|
||||
über Gitea-Suche/Label-Filter — explizit KEIN Code-Kommentar-Tracking (`BUG-N` wie in
|
||||
archivmail), das laut `known-issues-archivmail.md` genau diese Sichtbarkeitslücke
|
||||
verursacht hat.
|
||||
|
||||
**Realer Durchspiel-Nachweis (Prüfung 3):** Diese Session (nicht Mail-spezifisch, aber
|
||||
derselbe reale Vorgang) fand mehrere echte Bugs, dokumentiert nach exakt diesem
|
||||
Muster in den jeweiligen `*-PRUEFPROTOKOLL.md`-Dateien statt als Code-Kommentar, z. B.
|
||||
`archive/docs/RET-10-PRUEFPROTOKOLL.md`: fehlende CORS-Header bei RET-06-API,
|
||||
gefunden bei einer Sichtprüfung, Symptom (Browser hätte Fetch blockiert), Ursache
|
||||
(kein `Access-Control-Allow-Origin`), Fix (RET-10-Ticket), Nachweis (curl-Test vorher/
|
||||
nachher) — alles durchsuchbar in der Protokolldatei, nicht im Quelltext verstreut.
|
||||
|
||||
**Ehrlich vermerkt:** Ein ECHTER Gitea-Issue konnte in dieser Session nicht angelegt
|
||||
werden (kein Gitea-API-Token verfügbar, nur Git-SSH/HTTPS-Push-Zugriff). Das oben
|
||||
verlinkte Beispiel demonstriert das Vorgehen strukturell (Symptom → Ursache → Fix →
|
||||
Nachweis, durchsuchbar abgelegt), aber NICHT über die Gitea-Issue-Oberfläche selbst.
|
||||
Sobald ein Gitea-Zugriffstoken verfügbar ist, sollte mindestens ein Test-Issue real
|
||||
angelegt werden, um die Konvention vollständig nachzuweisen — offener Punkt, siehe
|
||||
Abschnitt 7.
|
||||
|
||||
## 6. Prüfungen (real durchgeführt)
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Dokument liegt vor und wurde von zweiter Person gegengelesen | **bestanden** — Dokument von der Nutzerin/dem Nutzer (zweite Person) gegengelesen und freigegeben (2026-08-30) |
|
||||
| 2 | Stichprobe: mindestens ein Beispieltest je benannter Testart ist umgesetzt | **bestanden** — 6 Tests real ausgeführt auf 131: `go test ./mail/internal/example/... -v -p 1`, alle grün (3 Unit, 1 Integration, 2 E2E) |
|
||||
| 3 | Bug-Tracking-Vorgehen wurde einmal exemplarisch für einen realen Befund durchgespielt | **teilweise bestanden** — Vorgehen strukturell durchgespielt anhand eines realen, bereits dokumentierten Befunds (RET-10), aber NICHT über die echte Gitea-Issue-Oberfläche (kein API-Token verfügbar). Siehe Abschnitt 5, offener Punkt in Abschnitt 7 |
|
||||
|
||||
## 7. Offene Punkte
|
||||
|
||||
- Echter Gitea-Issue als Nachweis der Bug-Tracking-Konvention noch nicht angelegt
|
||||
(fehlendes API-Token in dieser Session). Sollte nachgeholt werden, sobald Zugriff
|
||||
besteht.
|
||||
- `mail/internal/auth/`, `mail/internal/tenant/`, `mail/internal/ingest/` etc. existieren
|
||||
noch nicht — die Pflichttest-Gate-Pfadmuster sind auf Basis der geplanten
|
||||
Modulstruktur vordefiniert, nicht an echtem Code verifiziert. Erste Nagelprobe: das
|
||||
erste Ticket, das einen dieser Pfade tatsächlich anlegt (voraussichtlich `ING-01`).
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
module gitea.perlbach24.de/scripte/nexarch/mail
|
||||
|
||||
go 1.24
|
||||
|
||||
toolchain go1.24.4
|
||||
|
||||
require (
|
||||
github.com/aws/aws-sdk-go-v2 v1.45.1
|
||||
github.com/aws/aws-sdk-go-v2/config v1.33.1
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1
|
||||
github.com/aws/smithy-go v1.28.1
|
||||
github.com/jackc/pgx/v5 v5.6.0
|
||||
golang.org/x/text v0.14.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1 // indirect
|
||||
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
|
||||
)
|
||||
+64
@@ -0,0 +1,64 @@
|
||||
github.com/aws/aws-sdk-go-v2 v1.45.1 h1:iIoG3NaLhV6UZpPXyPXlDj2I9oS8tV/nMcMnITCC6Ks=
|
||||
github.com/aws/aws-sdk-go-v2 v1.45.1/go.mod h1:bttEH6JqnUL8LepvDVfdrds/fZ5bCIxzpe3abyUrhDU=
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20 h1:GPRlPwz40I2B2VrBEASOA3Bi77NyeqejNLkifosX0rs=
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20/go.mod h1:g7PNzKcsOKWb4fkSRBA7BZVAS6Y8IcxzN+nRohhQ1Q8=
|
||||
github.com/aws/aws-sdk-go-v2/config v1.33.1 h1:bq9jze1hQ5YTCLoVxNnbp0T7rglrlOE7N9YsHqjGkEw=
|
||||
github.com/aws/aws-sdk-go-v2/config v1.33.1/go.mod h1:2A3HQwG4zaL5Tm80rc6RZj8LmWWv4WYT5v8raSz/L7A=
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1 h1:Z8GRNEx0u9sDkZOq4PUnN8mjGwbUQGRzMSXpvt3d8xQ=
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1/go.mod h1:uBIK00kFo95dnemqfFMTWx0X8YRqsh6ecIoCjjOkZqM=
|
||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1 h1:YIEBqcqRnpi4Pfv0YHImtgi6czGCwKHANC7SwmUAVD0=
|
||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1/go.mod h1:imEf0oufgAo8KAkCHhrOdqGEC0YWx1PPBQH82shSxGw=
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1 h1:pc138gM1CW+XPc60rEwUlwwuwWFQK16CI1T7v1F9Oec=
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1/go.mod h1:1+koxpPIbfBdfzP6vojm5/zTpTQ/micYwlxIiNB3TxI=
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1 h1:K0JsbZQj+1h208Ro1zHeA4l7bMp0NvRffHQ91q8Ol1s=
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1/go.mod h1:W3/vL6EtCIatICGy9ab29QhMuae+cOKPWcMxv02CO+Q=
|
||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1 h1:yhw5KD1phVyP9vijxOUzDfEtJx+bt+L63k+VfuiYFAA=
|
||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1/go.mod h1:ZW2e0d7DYlRxlS9hEiMXE47gTdX5KRN4byUiNbUpG+Q=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19 h1:bAdDl/HkGCcGPoe25ToSHEw23VIxt6CT5fLcg111BKg=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19/go.mod h1:KaUzbLxv4CeSxh6ZCl9B4m7CuFenS8kUEaDs+f/DQr4=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1 h1:s67hBfG5t9rn1NCvDuB4E3QIep3UFhHPtaIqFDjV3N8=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1/go.mod h1:FpvjBMXtSNMLPmDJsWwcY5cRnqJlpS2y1R6n4pvzs4k=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1 h1:RmmWQPREQdk9U+PfqeHW3MqZaBaNK7TpV9W3RY+b+7g=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1/go.mod h1:0A3W4F+68ZnNk5XcNL/e9HFMwnP8RlEicFfy6eOEDyw=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1 h1:ZMbtPZZQRca+3+XYQne9PBvRiYpHZlNJJOZfE9WNfT0=
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1/go.mod h1:YAGWQdCYlVCoqrzvfv3RLxO6zKwti7gsAULOGWPLYv4=
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1 h1:kVpzaDBzOdRtOftmiSpTdQbWVqRg0kONLXijktiwXnk=
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1/go.mod h1:CUr46sCpGAg/rHaclRyhJX0LJAmH73uWSJPPSaMUrSk=
|
||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1 h1:mdMtSVKdQ3+mzBh+l0ogrFYZVQUCg6pJZOirA2ARsYE=
|
||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1/go.mod h1:9IqUlsJDbUPcg6cgx3WEzXdjrbWzLDQrak0aaSqlTcI=
|
||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1 h1:B6WFn91tobD6gG4724ONHaqrpKsoETGnv98LHe/yIGM=
|
||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1/go.mod h1:tWuiVBUtPBr8/rgRiYS8Uf85sHcAN+G7XS3D3CEoUh8=
|
||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1 h1:6yeYCWFvgbI2TI3K6jr9LtBNhXgJ7g4xqD+DEiaDDmM=
|
||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1/go.mod h1:naFe83jSMuYkH+QjQPX8n1MLhBkeCFM5Lsnh5m5wz3c=
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1 h1:Sv2xPnRHlThSUtVujYuUBPI/Il8si6UPHXL8DMiB/F0=
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1/go.mod h1:mKo/CzaCz8qytGW70NG4vIIGAx1HXTlb5lHNkC5k3lk=
|
||||
github.com/aws/smithy-go v1.28.1 h1:R/nXH00c8qcfCzQVELtRw+eLQWtzv+VAIEFJ1/xxXlQ=
|
||||
github.com/aws/smithy-go v1.28.1/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
||||
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/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
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/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
|
||||
github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
|
||||
github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
|
||||
github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
|
||||
github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
|
||||
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
||||
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
@@ -0,0 +1,118 @@
|
||||
// Package crypto implementiert ARC-02: Envelope-Encryption für Objekte
|
||||
// at rest. Jedes Objekt bekommt einen eigenen, zufälligen
|
||||
// Datenverschlüsselungsschlüssel (DEK, Akzeptanzkriterium 1), der mit
|
||||
// dem Tenant-Hauptschlüssel (KEK) verpackt wird — der KEK selbst kommt
|
||||
// AUSSCHLIESSLICH von Core API-10/API-12 (Akzeptanzkriterium 2), wird
|
||||
// hier nie persistiert, nur flüchtig für eine Wrap-/Unwrap-Operation
|
||||
// gehalten. Bewusste Neuimplementierung des bewährten DMS-FDN-09-
|
||||
// Musters (Mail kann DMS' internal/ nicht importieren, eigenständiges
|
||||
// Go-Modul).
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/aes"
|
||||
"crypto/cipher"
|
||||
"crypto/rand"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
const (
|
||||
DEKSize = 32
|
||||
KEKSize = 32
|
||||
)
|
||||
|
||||
// ErrDecryptFailed wird geliefert, wenn ein Chiffretext nicht
|
||||
// entschlüsselt werden kann — falscher Schlüssel ODER manipulierte
|
||||
// Daten (Pflichtprüfung 2: GCM-Auth-Tag erkennt Manipulation
|
||||
// zuverlässig, AEAD unterscheidet die beiden Ursachen bewusst nicht).
|
||||
var ErrDecryptFailed = errors.New("crypto: entschlüsselung fehlgeschlagen (falscher schlüssel oder manipulierte daten)")
|
||||
|
||||
func GenerateDEK() ([]byte, error) {
|
||||
dek := make([]byte, DEKSize)
|
||||
if _, err := rand.Read(dek); err != nil {
|
||||
return nil, fmt.Errorf("crypto: dek erzeugen: %w", err)
|
||||
}
|
||||
return dek, nil
|
||||
}
|
||||
|
||||
func seal(key, plaintext []byte) ([]byte, error) {
|
||||
block, err := aes.NewCipher(key)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: aes-cipher erstellen: %w", err)
|
||||
}
|
||||
gcm, err := cipher.NewGCM(block)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: gcm erstellen: %w", err)
|
||||
}
|
||||
nonce := make([]byte, gcm.NonceSize())
|
||||
if _, err := rand.Read(nonce); err != nil {
|
||||
return nil, fmt.Errorf("crypto: nonce erzeugen: %w", err)
|
||||
}
|
||||
return gcm.Seal(nonce, nonce, plaintext, nil), nil
|
||||
}
|
||||
|
||||
func open(key, sealed []byte) ([]byte, error) {
|
||||
block, err := aes.NewCipher(key)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: aes-cipher erstellen: %w", err)
|
||||
}
|
||||
gcm, err := cipher.NewGCM(block)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: gcm erstellen: %w", err)
|
||||
}
|
||||
if len(sealed) < gcm.NonceSize() {
|
||||
return nil, ErrDecryptFailed
|
||||
}
|
||||
nonce, ciphertext := sealed[:gcm.NonceSize()], sealed[gcm.NonceSize():]
|
||||
plaintext, err := gcm.Open(nil, nonce, ciphertext, nil)
|
||||
if err != nil {
|
||||
return nil, ErrDecryptFailed
|
||||
}
|
||||
return plaintext, nil
|
||||
}
|
||||
|
||||
func WrapDEK(kek, dek []byte) ([]byte, error) {
|
||||
wrapped, err := seal(kek, dek)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: dek verpacken: %w", err)
|
||||
}
|
||||
return wrapped, nil
|
||||
}
|
||||
|
||||
func UnwrapDEK(kek, wrappedDEK []byte) ([]byte, error) {
|
||||
return open(kek, wrappedDEK)
|
||||
}
|
||||
|
||||
// EncryptStream verschlüsselt den gesamten Inhalt von r mit dek
|
||||
// (AES-256-GCM). Liest r vollständig in den Speicher — dasselbe Muster
|
||||
// wie mail/internal/storage.S3Driver.Put (ARC-01), das S3-PutObject
|
||||
// ebenfalls vollständig puffert; ein segmentiertes AEAD-Verfahren für
|
||||
// sehr große Anhänge ist bewusst nicht Teil der "kleinsten Lösung".
|
||||
func EncryptStream(dek []byte, r io.Reader) (io.Reader, error) {
|
||||
plaintext, err := io.ReadAll(r)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: klartext lesen: %w", err)
|
||||
}
|
||||
ciphertext, err := seal(dek, plaintext)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: verschlüsseln: %w", err)
|
||||
}
|
||||
return bytes.NewReader(ciphertext), nil
|
||||
}
|
||||
|
||||
// DecryptStream entschlüsselt einen zuvor mit EncryptStream erzeugten
|
||||
// Chiffretext-Stream.
|
||||
func DecryptStream(dek []byte, r io.Reader) (io.Reader, error) {
|
||||
ciphertext, err := io.ReadAll(r)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: chiffretext lesen: %w", err)
|
||||
}
|
||||
plaintext, err := open(dek, ciphertext)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return bytes.NewReader(plaintext), nil
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
)
|
||||
|
||||
// KEKProvider liefert den aktuellen, entschlüsselten Tenant-KEK
|
||||
// (Akzeptanzkriterium 2: KEK kommt ausschließlich von Core API-10/
|
||||
// API-12). Schmale Schnittstelle, damit Tests einen Fake statt eines
|
||||
// echten HTTP-Aufrufs einsetzen können.
|
||||
type KEKProvider interface {
|
||||
TenantKEK(ctx context.Context, tenantSlug string) ([]byte, error)
|
||||
}
|
||||
|
||||
// tenantKEKResponse entspricht Core internal/kek.tenantKEKResponse
|
||||
// (JSON-Vertrag: tenant_kek_base64) — dieselbe Struktur, hier
|
||||
// gespiegelt, da Mail Cores internal/-Pakete nicht importieren kann.
|
||||
type tenantKEKResponse struct {
|
||||
TenantKEKBase64 string `json:"tenant_kek_base64"`
|
||||
}
|
||||
|
||||
// HTTPKEKProvider bezieht den Tenant-KEK über Core API-12
|
||||
// (internal/kek.Handler.TenantKEKHandler, echt laufender Dienst),
|
||||
// authentifiziert über dasselbe Service-Credential-Verfahren wie jeder
|
||||
// andere Modul-Core-Aufruf (API-02) — identisches Muster wie DMS
|
||||
// FDN-09/internal/storage.HTTPUsageReporter aus ARC-01.
|
||||
type HTTPKEKProvider struct {
|
||||
endpointURL string
|
||||
clientID string
|
||||
clientSecret string
|
||||
httpClient *http.Client
|
||||
}
|
||||
|
||||
func NewHTTPKEKProvider(endpointURL, clientID, clientSecret string, httpClient *http.Client) *HTTPKEKProvider {
|
||||
if httpClient == nil {
|
||||
httpClient = http.DefaultClient
|
||||
}
|
||||
return &HTTPKEKProvider{endpointURL: endpointURL, clientID: clientID, clientSecret: clientSecret, httpClient: httpClient}
|
||||
}
|
||||
|
||||
func (p *HTTPKEKProvider) TenantKEK(ctx context.Context, tenantSlug string) ([]byte, error) {
|
||||
u, err := url.Parse(p.endpointURL)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek-endpunkt-url ungültig: %w", err)
|
||||
}
|
||||
q := u.Query()
|
||||
q.Set("tenant", tenantSlug)
|
||||
u.RawQuery = q.Encode()
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek-anfrage aufbauen: %w", err)
|
||||
}
|
||||
req.Header.Set("X-Nexarch-Client-Id", p.clientID)
|
||||
req.Header.Set("X-Nexarch-Client-Secret", p.clientSecret)
|
||||
|
||||
resp, err := p.httpClient.Do(req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek-anfrage senden: %w", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("crypto: kek-bezug von core abgelehnt: status %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
var body tenantKEKResponse
|
||||
if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek-antwort dekodieren: %w", err)
|
||||
}
|
||||
kek, err := base64.StdEncoding.DecodeString(body.TenantKEKBase64)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek base64-dekodieren: %w", err)
|
||||
}
|
||||
return kek, nil
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// Envelope ist das Ergebnis einer Seal-Operation: der Chiffretext-
|
||||
// Stream plus der mit dem Tenant-KEK verpackte DEK, der zusammen mit
|
||||
// dem Objekt persistiert werden muss (siehe mail/internal/encstorage).
|
||||
type Envelope struct {
|
||||
Ciphertext io.Reader
|
||||
WrappedDEK []byte
|
||||
}
|
||||
|
||||
// Service verbindet KEKProvider mit den Envelope-Operationen — Aufrufer
|
||||
// (mail/internal/encstorage) rufen ausschließlich Service auf, nie die
|
||||
// Einzelfunktionen aus envelope.go direkt.
|
||||
type Service struct {
|
||||
kek KEKProvider
|
||||
}
|
||||
|
||||
func NewService(kek KEKProvider) *Service {
|
||||
return &Service{kek: kek}
|
||||
}
|
||||
|
||||
// Seal erzeugt einen neuen DEK (Akzeptanzkriterium 1), verschlüsselt
|
||||
// plaintext damit und verpackt den DEK mit dem aktuellen Tenant-KEK
|
||||
// (Akzeptanzkriterium 2 — der KEK wird bei JEDEM Aufruf frisch von Core
|
||||
// bezogen, nie zwischengespeichert).
|
||||
func (s *Service) Seal(ctx context.Context, tenantSlug string, plaintext io.Reader) (*Envelope, error) {
|
||||
dek, err := GenerateDEK()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
ciphertext, err := EncryptStream(dek, plaintext)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
||||
}
|
||||
wrappedDEK, err := WrapDEK(kek, dek)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &Envelope{Ciphertext: ciphertext, WrappedDEK: wrappedDEK}, nil
|
||||
}
|
||||
|
||||
// Open entpackt den DEK mit dem aktuellen Tenant-KEK (Akzeptanzkriterium
|
||||
// 3: nur mit gültigem, mandantenbezogenem Schlüssel möglich — ein
|
||||
// falscher Tenant-Slug liefert entweder einen falschen KEK von Core
|
||||
// [dann schlägt UnwrapDEK fehl] oder Core verweigert den Zugriff direkt)
|
||||
// und entschlüsselt ciphertext damit.
|
||||
func (s *Service) Open(ctx context.Context, tenantSlug string, wrappedDEK []byte, ciphertext io.Reader) (io.Reader, error) {
|
||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
||||
}
|
||||
dek, err := UnwrapDEK(kek, wrappedDEK)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return DecryptStream(dek, ciphertext)
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
// Package encstorage implementiert ARC-02s Anbindung an ARC-01: jedes
|
||||
// archivierte Objekt wird VOR dem Schreiben über
|
||||
// mail/internal/storage.Service verschlüsselt (Akzeptanzkriterium 1).
|
||||
// Kombiniert bewusst zwei bereits fertige, unveränderte Pakete
|
||||
// (mail/internal/storage aus ARC-01, mail/internal/crypto aus ARC-02)
|
||||
// statt eines davon zu erweitern — kein Umbau angrenzender Bereiche.
|
||||
//
|
||||
// Reihenfolge beachtet (Ticket "Bekannte Fehler vermeiden"): ein
|
||||
// SHA-256-Hash für Dublettenerkennung (ARC-03) muss auf dem KLARTEXT
|
||||
// berechnet werden, BEVOR diese Verschlüsselung angewendet wird — das
|
||||
// ist Sache des Aufrufers (ARC-03, außerhalb dieses Pakets), dieses
|
||||
// Paket nimmt bereits fertigen Klartext entgegen und verschlüsselt ihn
|
||||
// sofort, hält ihn nicht länger als nötig im Speicher.
|
||||
package encstorage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/crypto"
|
||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
|
||||
)
|
||||
|
||||
// wrappedDEKKey ist der Sidecar-Objektschlüssel für den mit dem
|
||||
// Tenant-KEK verpackten DEK — liegt im selben Storage-Backend wie der
|
||||
// Chiffretext, analog zum Prüfsummen-Sidecar aus ARC-01.
|
||||
func wrappedDEKKey(key string) string {
|
||||
return key + ".dek"
|
||||
}
|
||||
|
||||
// Service verbindet Storage (ARC-01) und Crypto (ARC-02): der Rest von
|
||||
// Mail ruft AUSSCHLIESSLICH diesen Service auf, nie storage.Service
|
||||
// direkt mit Klartext — das verhindert einen Schreibpfad, der die
|
||||
// Verschlüsselung vergisst (Akzeptanzkriterium 1).
|
||||
type Service struct {
|
||||
storage *storage.Service
|
||||
crypto *crypto.Service
|
||||
}
|
||||
|
||||
func NewService(storageSvc *storage.Service, cryptoSvc *crypto.Service) *Service {
|
||||
return &Service{storage: storageSvc, crypto: cryptoSvc}
|
||||
}
|
||||
|
||||
// Put verschlüsselt plaintext (Akzeptanzkriterium 1/2: neuer DEK je
|
||||
// Objekt, mit dem per API-12 bezogenen Tenant-KEK verpackt) und legt
|
||||
// Chiffretext + verpackten DEK über storage.Service ab (Prüfsumme,
|
||||
// Nutzungsmeldung — ARC-01 unverändert wiederverwendet).
|
||||
func (s *Service) Put(ctx context.Context, tenantSlug, key string, plaintext io.Reader, contentType string) error {
|
||||
env, err := s.crypto.Seal(ctx, tenantSlug, plaintext)
|
||||
if err != nil {
|
||||
return fmt.Errorf("encstorage: verschlüsseln: %w", err)
|
||||
}
|
||||
ciphertext, err := io.ReadAll(env.Ciphertext)
|
||||
if err != nil {
|
||||
return fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
||||
}
|
||||
if _, err := s.storage.Put(ctx, key, bytes.NewReader(ciphertext), int64(len(ciphertext)), contentType); err != nil {
|
||||
return fmt.Errorf("encstorage: chiffretext speichern: %w", err)
|
||||
}
|
||||
if _, err := s.storage.Put(ctx, wrappedDEKKey(key), bytes.NewReader(env.WrappedDEK), int64(len(env.WrappedDEK)), "application/octet-stream"); err != nil {
|
||||
return fmt.Errorf("encstorage: verpackten dek speichern: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetDecrypted liest Chiffretext (über storage.GetVerified — ARC-01s
|
||||
// Prüfsummenverifikation wird dabei mitgenutzt) und verpackten DEK,
|
||||
// entpackt den DEK mit dem AKTUELLEN Tenant-KEK und entschlüsselt den
|
||||
// Inhalt (Akzeptanzkriterium 3: nur mit gültigem, mandantenbezogenem
|
||||
// Schlüssel möglich).
|
||||
func (s *Service) GetDecrypted(ctx context.Context, tenantSlug, key string) ([]byte, error) {
|
||||
ciphertext, err := s.storage.GetVerified(ctx, key)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
||||
}
|
||||
dekReader, err := s.storage.Get(ctx, wrappedDEKKey(key))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
||||
}
|
||||
defer func() { _ = dekReader.Close() }()
|
||||
wrappedDEK, err := io.ReadAll(dekReader)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
||||
}
|
||||
|
||||
plaintextReader, err := s.crypto.Open(ctx, tenantSlug, wrappedDEK, bytes.NewReader(ciphertext))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return io.ReadAll(plaintextReader)
|
||||
}
|
||||
@@ -0,0 +1,138 @@
|
||||
package encstorage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/crypto"
|
||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
|
||||
)
|
||||
|
||||
type fakeUsageReporter struct{}
|
||||
|
||||
func (fakeUsageReporter) Report(_ context.Context, _, _ string, _ int64) error { return nil }
|
||||
|
||||
// fakeKEKProvider liefert einen festen, mandantenspezifischen KEK —
|
||||
// simuliert Core API-12, ohne den echten Dienst für Unit-Tests zu
|
||||
// brauchen. "richtiger-tenant" hat einen bekannten KEK, jeder andere
|
||||
// Tenant-Slug liefert einen ANDEREN (falschen) KEK — genau der Fall,
|
||||
// den Pflichtprüfung 2 testet.
|
||||
type fakeKEKProvider struct {
|
||||
keksByTenant map[string][]byte
|
||||
}
|
||||
|
||||
func (f fakeKEKProvider) TenantKEK(_ context.Context, tenantSlug string) ([]byte, error) {
|
||||
if kek, ok := f.keksByTenant[tenantSlug]; ok {
|
||||
return kek, nil
|
||||
}
|
||||
// Unbekannter Tenant bekommt einen ANDEREN zufälligen KEK (nicht
|
||||
// abgelehnt auf Core-Seite in diesem Fake, aber garantiert falsch —
|
||||
// entspricht dem realen Fall, dass ein falscher Tenant-Slug einen
|
||||
// anderen KEK liefert und die Entschlüsselung deshalb scheitert).
|
||||
return bytes.Repeat([]byte{0xFF}, crypto.KEKSize), nil
|
||||
}
|
||||
|
||||
func newTestServiceWithDir(t *testing.T) (*Service, string) {
|
||||
t.Helper()
|
||||
dir := t.TempDir()
|
||||
storageSvc := storage.NewService(storage.NewLocalDriver(dir), fakeUsageReporter{}, "acme")
|
||||
kekProvider := fakeKEKProvider{keksByTenant: map[string][]byte{
|
||||
"richtiger-tenant": bytes.Repeat([]byte{0x42}, crypto.KEKSize),
|
||||
}}
|
||||
cryptoSvc := crypto.NewService(kekProvider)
|
||||
return NewService(storageSvc, cryptoSvc), dir
|
||||
}
|
||||
|
||||
// TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent ist die
|
||||
// geforderte Pflichtprüfung 1: Zugriff auf Rohspeicher ohne Schlüssel
|
||||
// liefert keine lesbaren Inhalte.
|
||||
func TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent(t *testing.T) {
|
||||
svc, dir := newTestServiceWithDir(t)
|
||||
ctx := context.Background()
|
||||
key := storage.ObjectKey("msg-enc-1", 0)
|
||||
plaintext := "STRENG GEHEIMER E-MAIL-INHALT, NICHT IM KLARTEXT AUF DER PLATTE"
|
||||
|
||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(plaintext), "text/plain"); err != nil {
|
||||
t.Fatalf("put: %v", err)
|
||||
}
|
||||
|
||||
// Direkter Dateisystemzugriff, UMGEHT den Service/die Entschlüsselung
|
||||
// vollständig — simuliert "Rohspeicher ohne Schlüssel".
|
||||
raw, err := os.ReadFile(filepath.Join(dir, filepath.FromSlash(key)))
|
||||
if err != nil {
|
||||
t.Fatalf("rohdatei lesen: %v", err)
|
||||
}
|
||||
if bytes.Contains(raw, []byte(plaintext)) {
|
||||
t.Fatalf("klartext ist unverschlüsselt im rohspeicher auffindbar: %q enthält %q", raw, plaintext)
|
||||
}
|
||||
if bytes.Contains(raw, []byte("STRENG GEHEIMER")) || bytes.Contains(raw, []byte("GEHEIM")) {
|
||||
t.Fatal("erkennbare klartext-fragmente im rohspeicher gefunden")
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetDecrypted_WrongTenantKeyDeniesDecryption ist die geforderte
|
||||
// Pflichtprüfung 2: falscher Mandantenschlüssel verweigert
|
||||
// Entschlüsselung.
|
||||
func TestGetDecrypted_WrongTenantKeyDeniesDecryption(t *testing.T) {
|
||||
svc, _ := newTestServiceWithDir(t)
|
||||
ctx := context.Background()
|
||||
key := storage.ObjectKey("msg-enc-2", 0)
|
||||
plaintext := "inhalt fuer richtiger-tenant"
|
||||
|
||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(plaintext), "text/plain"); err != nil {
|
||||
t.Fatalf("put: %v", err)
|
||||
}
|
||||
|
||||
// Korrekter Tenant kann entschlüsseln.
|
||||
got, err := svc.GetDecrypted(ctx, "richtiger-tenant", key)
|
||||
if err != nil {
|
||||
t.Fatalf("getdecrypted (richtiger tenant): %v", err)
|
||||
}
|
||||
if string(got) != plaintext {
|
||||
t.Fatalf("falscher inhalt: %q", got)
|
||||
}
|
||||
|
||||
// FALSCHER Mandant (anderer Tenant-Slug -> anderer KEK) muss
|
||||
// abgelehnt werden.
|
||||
_, err = svc.GetDecrypted(ctx, "falscher-tenant", key)
|
||||
if !errors.Is(err, crypto.ErrDecryptFailed) {
|
||||
t.Fatalf("erwartet ErrDecryptFailed bei falschem mandantenschlüssel, habe: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPut_AcceptableEncryptionOverhead ist die geforderte
|
||||
// Pflichtprüfung 3: Performance-Test bestätigt akzeptablen Overhead
|
||||
// durch Verschlüsselung.
|
||||
func TestPut_AcceptableEncryptionOverhead(t *testing.T) {
|
||||
svc, _ := newTestServiceWithDir(t)
|
||||
ctx := context.Background()
|
||||
|
||||
// ~64 KiB Nutzlast, realistische Anhanggröße.
|
||||
payload := strings.Repeat("x", 64*1024)
|
||||
|
||||
const count = 50
|
||||
start := time.Now()
|
||||
for i := 0; i < count; i++ {
|
||||
key := storage.ObjectKey("msg-perf", i)
|
||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(payload), "application/octet-stream"); err != nil {
|
||||
t.Fatalf("put #%d: %v", i, err)
|
||||
}
|
||||
}
|
||||
elapsed := time.Since(start)
|
||||
avgPerObject := elapsed / count
|
||||
|
||||
// Großzügige Grenze (50ms je 64-KiB-Objekt inkl. AES-GCM,
|
||||
// Prüfsumme, Sidecar-Schreiben, Rücklese-Verifikation aus ARC-01) —
|
||||
// Ziel: Nachweis, dass Verschlüsselung keinen unverhältnismäßigen
|
||||
// Overhead verursacht, nicht ein knallhartes SLA.
|
||||
if avgPerObject > 50*time.Millisecond {
|
||||
t.Fatalf("erwartet akzeptablen verschlüsselungs-overhead (<50ms/64KiB-objekt), habe %v/objekt (gesamt %v für %d objekte)", avgPerObject, elapsed, count)
|
||||
}
|
||||
t.Logf("Verschlüsselungs-Performance: %d×64KiB-Objekte in %v (%v/Objekt)", count, elapsed, avgPerObject)
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
package example
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// NormalizeHandler ist das E2E-Test-Beispiel (QA-01): ein echter
|
||||
// HTTP-Endpunkt, gegen den ein Test einen vollständigen Request-Response-
|
||||
// Zyklus fährt (httptest.Server, echter TCP-Roundtrip, kein reiner
|
||||
// Funktionsaufruf). Sobald das erste Mail-Frontend-Ticket eine echte
|
||||
// Browser-UI mitbringt, wird die E2E-Ebene um Playwright/Jest ergänzt
|
||||
// (siehe QA-01-Teststrategiedokument, Abschnitt 2) — bis dahin ist ein
|
||||
// echter HTTP-Roundtrip die ehrliche, verfügbare Untergrenze für "E2E".
|
||||
type normalizeRequest struct {
|
||||
Address string `json:"address"`
|
||||
}
|
||||
|
||||
type normalizeResponse struct {
|
||||
Normalized string `json:"normalized"`
|
||||
}
|
||||
|
||||
func NormalizeHandler(w http.ResponseWriter, r *http.Request) {
|
||||
var req normalizeRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
http.Error(w, "ungültiger request-body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
normalized, err := NormalizeAddress(req.Address)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(normalizeResponse{Normalized: normalized})
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
// E2E-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2): echter
|
||||
// HTTP-Request über einen laufenden httptest.Server (TCP-Roundtrip),
|
||||
// nicht nur ein Funktionsaufruf im selben Prozess.
|
||||
package example
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNormalizeHandler_RealHTTPRoundTrip(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(NormalizeHandler))
|
||||
defer server.Close()
|
||||
|
||||
body, _ := json.Marshal(normalizeRequest{Address: "Kunde@Beispiel.DE"})
|
||||
resp, err := http.Post(server.URL, "application/json", bytes.NewReader(body))
|
||||
if err != nil {
|
||||
t.Fatalf("post: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200", resp.StatusCode)
|
||||
}
|
||||
var out normalizeResponse
|
||||
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
|
||||
t.Fatalf("antwort dekodieren: %v", err)
|
||||
}
|
||||
if out.Normalized != "Kunde@beispiel.de" {
|
||||
t.Fatalf("got %q", out.Normalized)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeHandler_InvalidAddressReturns400(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(NormalizeHandler))
|
||||
defer server.Close()
|
||||
|
||||
body, _ := json.Marshal(normalizeRequest{Address: "keine-gueltige-adresse"})
|
||||
resp, err := http.Post(server.URL, "application/json", bytes.NewReader(body))
|
||||
if err != nil {
|
||||
t.Fatalf("post: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusBadRequest {
|
||||
t.Fatalf("status = %d, want 400", resp.StatusCode)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
// Package example dient QA-01 (Mail): liefert je Testart (Unit,
|
||||
// Integration, E2E) genau EIN reales, lauffähiges Beispiel, an dem sich
|
||||
// spätere Mail-Tickets orientieren können — keine Wegwerf-Demo, sondern
|
||||
// eine tatsächlich nützliche, kleine Funktion (Adress-Normalisierung),
|
||||
// die spätere Ticket (z. B. ING-01/ING-04) ohnehin brauchen werden.
|
||||
package example
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var ErrInvalidAddress = errors.New("example: keine gültige e-mail-adresse")
|
||||
|
||||
// NormalizeAddress normalisiert eine E-Mail-Adresse für den
|
||||
// tenant-scoped Vergleich: Kleinschreibung der Domain-Hälfte
|
||||
// (lokaler Teil bleibt case-sensitive, RFC 5321), Leerraum entfernt.
|
||||
func NormalizeAddress(addr string) (string, error) {
|
||||
addr = strings.TrimSpace(addr)
|
||||
at := strings.LastIndex(addr, "@")
|
||||
if at <= 0 || at == len(addr)-1 {
|
||||
return "", ErrInvalidAddress
|
||||
}
|
||||
local, domain := addr[:at], addr[at+1:]
|
||||
return local + "@" + strings.ToLower(domain), nil
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
// Unit-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2): keine
|
||||
// externe Abhängigkeit (DB, Netzwerk), reine Funktionsprüfung.
|
||||
package example
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNormalizeAddress_LowercasesDomainOnly(t *testing.T) {
|
||||
got, err := NormalizeAddress("User.Name@Example.COM")
|
||||
if err != nil {
|
||||
t.Fatalf("unerwarteter fehler: %v", err)
|
||||
}
|
||||
want := "User.Name@example.com"
|
||||
if got != want {
|
||||
t.Fatalf("got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeAddress_TrimsWhitespace(t *testing.T) {
|
||||
got, err := NormalizeAddress(" user@example.com ")
|
||||
if err != nil {
|
||||
t.Fatalf("unerwarteter fehler: %v", err)
|
||||
}
|
||||
if got != "user@example.com" {
|
||||
t.Fatalf("got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeAddress_RejectsInvalidInput(t *testing.T) {
|
||||
cases := []string{"", "no-at-sign", "@nolocalpart.com", "trailing@"}
|
||||
for _, c := range cases {
|
||||
if _, err := NormalizeAddress(c); !errors.Is(err, ErrInvalidAddress) {
|
||||
t.Fatalf("input %q: erwartet ErrInvalidAddress, habe: %v", c, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
package example
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// AddressStore ist das Integrationstest-Beispiel (QA-01): eine
|
||||
// minimale, aber echte DB-gestützte Komponente — nutzt dieselbe
|
||||
// Tenant-DB-Isolationskonvention wie DMS/Archive (t.Cleanup, geteilte
|
||||
// physische Postgres-Instanz auf dem Testhost).
|
||||
type AddressStore struct {
|
||||
pool *pgxpool.Pool
|
||||
}
|
||||
|
||||
func NewAddressStore(pool *pgxpool.Pool) *AddressStore {
|
||||
return &AddressStore{pool: pool}
|
||||
}
|
||||
|
||||
func (s *AddressStore) SaveNormalized(ctx context.Context, addr string) (string, error) {
|
||||
normalized, err := NormalizeAddress(addr)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if _, err := s.pool.Exec(ctx, `
|
||||
INSERT INTO example_addresses (address) VALUES ($1)
|
||||
ON CONFLICT (address) DO NOTHING
|
||||
`, normalized); err != nil {
|
||||
return "", fmt.Errorf("example: adresse speichern: %w", err)
|
||||
}
|
||||
return normalized, nil
|
||||
}
|
||||
|
||||
func (s *AddressStore) Exists(ctx context.Context, addr string) (bool, error) {
|
||||
var exists bool
|
||||
if err := s.pool.QueryRow(ctx, `SELECT EXISTS(SELECT 1 FROM example_addresses WHERE address = $1)`, addr).Scan(&exists); err != nil {
|
||||
return false, fmt.Errorf("example: existenz prüfen: %w", err)
|
||||
}
|
||||
return exists, nil
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
// Integrations-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2):
|
||||
// echte Postgres-Instanz, folgt derselben Testhost-Konvention wie
|
||||
// DMS/Archive/Core (TEST_TENANT_DSN, t.Cleanup, geteilte physische
|
||||
// Instanz auf 192.168.1.131 — siehe project-nexarch-test-infra).
|
||||
package example
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func setupTest(t *testing.T) *pgxpool.Pool {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||
if dsn == "" {
|
||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
|
||||
}
|
||||
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 example_addresses (
|
||||
address TEXT PRIMARY KEY
|
||||
);
|
||||
`); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `TRUNCATE example_addresses`)
|
||||
})
|
||||
return pool
|
||||
}
|
||||
|
||||
func TestAddressStore_SaveAndCheckExists(t *testing.T) {
|
||||
pool := setupTest(t)
|
||||
store := NewAddressStore(pool)
|
||||
ctx := context.Background()
|
||||
|
||||
normalized, err := store.SaveNormalized(ctx, "Kunde@Beispiel.DE")
|
||||
if err != nil {
|
||||
t.Fatalf("savenormalized: %v", err)
|
||||
}
|
||||
if normalized != "Kunde@beispiel.de" {
|
||||
t.Fatalf("erwartet normalisierte adresse, habe %q", normalized)
|
||||
}
|
||||
|
||||
exists, err := store.Exists(ctx, normalized)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !exists {
|
||||
t.Fatal("erwartet real gespeicherte adresse")
|
||||
}
|
||||
|
||||
notExists, err := store.Exists(ctx, "unbekannt@beispiel.de")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if notExists {
|
||||
t.Fatal("nie gespeicherte adresse haette nicht existieren duerfen")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,206 @@
|
||||
// Package mimeparse implementiert ING-04: MIME-/Anhang-Parsing für
|
||||
// ein- und ausgehende Nachrichten (Multipart, verschachtelt,
|
||||
// Content-Transfer-Encoding, defensive Zeichensatz-Reparatur).
|
||||
//
|
||||
// NUR Parsing — Speicherung ist ARC-01s Aufgabe (siehe "Nicht
|
||||
// Bestandteil dieser Kachel"), dieses Paket schreibt nirgends in einen
|
||||
// Objekt-Speicher, sondern liefert nur strukturierte Go-Werte zurück.
|
||||
//
|
||||
// Bekannten Fehler vermieden (archivmail known-issues #3): Anhänge
|
||||
// wurden früher über io.ReadAll ohne Größenlimit gelesen — eine
|
||||
// Speicherbombe durch große/böswillige Anhänge. Hier läuft JEDER
|
||||
// Anhang-Lesevorgang über io.LimitReader mit konfigurierter Max-Size;
|
||||
// eine Überschreitung führt zu einer harten, sauberen Ablehnung
|
||||
// (ErrAttachmentTooLarge), kein stilles Abschneiden.
|
||||
package mimeparse
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"mime"
|
||||
"mime/multipart"
|
||||
"mime/quotedprintable"
|
||||
"net/mail"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/text/encoding/htmlindex"
|
||||
)
|
||||
|
||||
// ErrAttachmentTooLarge wird geliefert, wenn ein Anhang die
|
||||
// konfigurierte Maximalgröße überschreitet (Akzeptanzkriterium/
|
||||
// Pflichtprüfung 1).
|
||||
var ErrAttachmentTooLarge = errors.New("mimeparse: anhang überschreitet die maximal erlaubte größe")
|
||||
|
||||
// Part ist EIN zerlegter MIME-Teil — sowohl Textteile (IsAttachment
|
||||
// == false) als auch Anhänge (Akzeptanzkriterium 1/2).
|
||||
type Part struct {
|
||||
ContentType string
|
||||
Filename string
|
||||
Size int64
|
||||
Content []byte
|
||||
IsAttachment bool
|
||||
}
|
||||
|
||||
// Message ist das Ergebnis eines vollständig zerlegten Multipart-
|
||||
// Baums — verschachtelte multipart/*-Teile sind bereits rekursiv
|
||||
// aufgelöst, der Aufrufer sieht nur die "Blatt"-Teile (Akzeptanz-
|
||||
// kriterium 1).
|
||||
type Message struct {
|
||||
Parts []Part
|
||||
}
|
||||
|
||||
// wordDecoder dekodiert RFC-2047-kodierte Header-Werte (z. B.
|
||||
// Anhang-Dateinamen) defensiv: ein unbekannter/fehlerhafter
|
||||
// Zeichensatz bricht die Verarbeitung NICHT ab (Akzeptanzkriterium 3),
|
||||
// sondern liefert den Rohwert unverändert zurück.
|
||||
var wordDecoder = &mime.WordDecoder{CharsetReader: charsetReader}
|
||||
|
||||
func charsetReader(charsetLabel string, input io.Reader) (io.Reader, error) {
|
||||
enc, err := htmlindex.Get(charsetLabel)
|
||||
if err != nil {
|
||||
// Unbekannter/fehlerhafter Zeichensatz: defensiv als
|
||||
// UTF-8-verträglichen Rohtext weiterreichen statt
|
||||
// abzubrechen (Akzeptanzkriterium 3).
|
||||
return input, nil
|
||||
}
|
||||
return enc.NewDecoder().Reader(input), nil
|
||||
}
|
||||
|
||||
func decodeHeaderValue(raw string) string {
|
||||
decoded, err := wordDecoder.DecodeHeader(raw)
|
||||
if err != nil {
|
||||
// Defensiv: Rohwert statt Abbruch (Akzeptanzkriterium 3).
|
||||
return raw
|
||||
}
|
||||
return decoded
|
||||
}
|
||||
|
||||
// Parse zerlegt eine MIME-Nachricht vollständig, inklusive
|
||||
// verschachtelter Multipart-Teile (Akzeptanzkriterium 1). maxAttachmentSize
|
||||
// begrenzt JEDEN einzelnen Anhang (Akzeptanzkriterium/Pflichtprüfung 1).
|
||||
func Parse(r io.Reader, maxAttachmentSize int64) (Message, error) {
|
||||
msg, err := mail.ReadMessage(r)
|
||||
if err != nil {
|
||||
return Message{}, fmt.Errorf("mimeparse: nachricht lesen: %w", err)
|
||||
}
|
||||
|
||||
mediaType, params, err := mime.ParseMediaType(msg.Header.Get("Content-Type"))
|
||||
if err != nil {
|
||||
// Kein/kaputtes Content-Type: als einzelnen Textteil behandeln
|
||||
// statt abzubrechen (Akzeptanzkriterium 3: defensiv reparieren).
|
||||
body, readErr := readLimited(msg.Body, maxAttachmentSize)
|
||||
if readErr != nil {
|
||||
return Message{}, readErr
|
||||
}
|
||||
return Message{Parts: []Part{{ContentType: "text/plain", Content: body, Size: int64(len(body))}}}, nil
|
||||
}
|
||||
|
||||
var result Message
|
||||
if strings.HasPrefix(mediaType, "multipart/") {
|
||||
if err := parseMultipart(msg.Body, params["boundary"], maxAttachmentSize, &result); err != nil {
|
||||
return Message{}, err
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// Einzelner Teil (keine Multipart-Hülle).
|
||||
part, err := readSinglePart(msg.Header.Get("Content-Transfer-Encoding"), mediaType, "", msg.Body, maxAttachmentSize)
|
||||
if err != nil {
|
||||
return Message{}, err
|
||||
}
|
||||
result.Parts = append(result.Parts, part)
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// parseMultipart löst EINEN Multipart-Container rekursiv auf —
|
||||
// verschachtelte multipart/*-Teile (z. B. multipart/mixed, das
|
||||
// multipart/alternative enthält) werden vollständig zerlegt
|
||||
// (Akzeptanzkriterium 1), keine Rekursionstiefe hartkodiert begrenzt
|
||||
// außer durch die natürliche Nachrichtengröße selbst.
|
||||
func parseMultipart(r io.Reader, boundary string, maxAttachmentSize int64, result *Message) error {
|
||||
if boundary == "" {
|
||||
return errors.New("mimeparse: multipart ohne boundary")
|
||||
}
|
||||
mr := multipart.NewReader(r, boundary)
|
||||
for {
|
||||
p, err := mr.NextPart()
|
||||
if err == io.EOF {
|
||||
return nil
|
||||
}
|
||||
if err != nil {
|
||||
// Kaputte Multipart-Struktur: kontrolliert abbrechen
|
||||
// (Pflichtprüfung 3), nicht abstürzen.
|
||||
return fmt.Errorf("mimeparse: multipart-teil lesen: %w", err)
|
||||
}
|
||||
|
||||
contentType := p.Header.Get("Content-Type")
|
||||
mediaType, subParams, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
mediaType = "text/plain"
|
||||
}
|
||||
|
||||
if strings.HasPrefix(mediaType, "multipart/") {
|
||||
if err := parseMultipart(p, subParams["boundary"], maxAttachmentSize, result); err != nil {
|
||||
return err
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
part, err := readSinglePart(p.Header.Get("Content-Transfer-Encoding"), mediaType, decodeHeaderValue(p.FileName()), p, maxAttachmentSize)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
result.Parts = append(result.Parts, part)
|
||||
}
|
||||
}
|
||||
|
||||
func readSinglePart(transferEncoding, mediaType, filename string, r io.Reader, maxAttachmentSize int64) (Part, error) {
|
||||
decoded := decodeTransferEncoding(transferEncoding, r)
|
||||
|
||||
content, err := readLimited(decoded, maxAttachmentSize)
|
||||
if err != nil {
|
||||
return Part{}, err
|
||||
}
|
||||
|
||||
return Part{
|
||||
ContentType: mediaType,
|
||||
Filename: filename,
|
||||
Size: int64(len(content)),
|
||||
Content: content,
|
||||
IsAttachment: filename != "",
|
||||
}, nil
|
||||
}
|
||||
|
||||
// decodeTransferEncoding dekodiert Content-Transfer-Encoding
|
||||
// (quoted-printable/base64) — defensiv: ein unbekanntes Encoding wird
|
||||
// unverändert durchgereicht statt die Verarbeitung abzubrechen
|
||||
// (Akzeptanzkriterium 3).
|
||||
func decodeTransferEncoding(encoding string, r io.Reader) io.Reader {
|
||||
switch strings.ToLower(strings.TrimSpace(encoding)) {
|
||||
case "quoted-printable":
|
||||
return quotedprintable.NewReader(r)
|
||||
case "base64":
|
||||
return base64.NewDecoder(base64.StdEncoding, r)
|
||||
default:
|
||||
return r
|
||||
}
|
||||
}
|
||||
|
||||
// readLimited liest höchstens maxSize+1 Bytes — wird die Grenze
|
||||
// überschritten, wird ErrAttachmentTooLarge geliefert, statt beliebig
|
||||
// viel Speicher zu allozieren (Akzeptanzkriterium/Pflichtprüfung 1,
|
||||
// archivmail known-issues #3).
|
||||
func readLimited(r io.Reader, maxSize int64) ([]byte, error) {
|
||||
limited := io.LimitReader(r, maxSize+1)
|
||||
var buf bytes.Buffer
|
||||
if _, err := io.Copy(&buf, limited); err != nil {
|
||||
return nil, fmt.Errorf("mimeparse: teil lesen: %w", err)
|
||||
}
|
||||
if int64(buf.Len()) > maxSize {
|
||||
return nil, ErrAttachmentTooLarge
|
||||
}
|
||||
return buf.Bytes(), nil
|
||||
}
|
||||
@@ -0,0 +1,219 @@
|
||||
package mimeparse
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const defaultMaxSize = 10 * 1024 * 1024 // 10 MiB
|
||||
|
||||
// TestParse_NestedMultipartFullyDecomposed ist Akzeptanzkriterium 1:
|
||||
// Multipart-Nachrichten mit verschachtelten Teilen werden vollständig
|
||||
// zerlegt (multipart/mixed enthält multipart/alternative UND einen
|
||||
// Anhang).
|
||||
func TestParse_NestedMultipartFullyDecomposed(t *testing.T) {
|
||||
raw := "From: a@example.com\r\n" +
|
||||
"To: b@example.com\r\n" +
|
||||
"Subject: Test\r\n" +
|
||||
"MIME-Version: 1.0\r\n" +
|
||||
"Content-Type: multipart/mixed; boundary=\"outer\"\r\n\r\n" +
|
||||
"--outer\r\n" +
|
||||
"Content-Type: multipart/alternative; boundary=\"inner\"\r\n\r\n" +
|
||||
"--inner\r\n" +
|
||||
"Content-Type: text/plain; charset=utf-8\r\n\r\n" +
|
||||
"Hallo als Text\r\n" +
|
||||
"--inner\r\n" +
|
||||
"Content-Type: text/html; charset=utf-8\r\n\r\n" +
|
||||
"<p>Hallo als HTML</p>\r\n" +
|
||||
"--inner--\r\n" +
|
||||
"--outer\r\n" +
|
||||
"Content-Type: application/pdf\r\n" +
|
||||
"Content-Disposition: attachment; filename=\"rechnung.pdf\"\r\n" +
|
||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
||||
"JVBERi0xLjQK\r\n" +
|
||||
"--outer--\r\n"
|
||||
|
||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
||||
if err != nil {
|
||||
t.Fatalf("parse: %v", err)
|
||||
}
|
||||
if len(msg.Parts) != 3 {
|
||||
t.Fatalf("erwartet 3 zerlegte teile (text, html, anhang), habe %d: %+v", len(msg.Parts), msg.Parts)
|
||||
}
|
||||
|
||||
var sawText, sawHTML, sawAttachment bool
|
||||
for _, p := range msg.Parts {
|
||||
switch {
|
||||
case p.ContentType == "text/plain":
|
||||
sawText = true
|
||||
if string(p.Content) != "Hallo als Text" {
|
||||
t.Fatalf("unerwarteter text-inhalt: %q", p.Content)
|
||||
}
|
||||
case p.ContentType == "text/html":
|
||||
sawHTML = true
|
||||
case p.IsAttachment:
|
||||
sawAttachment = true
|
||||
}
|
||||
}
|
||||
if !sawText || !sawHTML || !sawAttachment {
|
||||
t.Fatalf("nicht alle erwarteten teile gefunden: text=%v html=%v attachment=%v", sawText, sawHTML, sawAttachment)
|
||||
}
|
||||
}
|
||||
|
||||
// TestParse_AttachmentMetadataExtracted ist Akzeptanzkriterium 2:
|
||||
// Anhänge werden mit korrektem Dateinamen, Größe und Content-Type
|
||||
// extrahiert.
|
||||
func TestParse_AttachmentMetadataExtracted(t *testing.T) {
|
||||
raw := "From: a@example.com\r\n" +
|
||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
||||
"--b\r\n" +
|
||||
"Content-Type: text/plain\r\n\r\n" +
|
||||
"Text\r\n" +
|
||||
"--b\r\n" +
|
||||
"Content-Type: image/png\r\n" +
|
||||
"Content-Disposition: attachment; filename=\"bild.png\"\r\n" +
|
||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
||||
"iVBORw0KGgo=\r\n" +
|
||||
"--b--\r\n"
|
||||
|
||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
||||
if err != nil {
|
||||
t.Fatalf("parse: %v", err)
|
||||
}
|
||||
var attachment *Part
|
||||
for i := range msg.Parts {
|
||||
if msg.Parts[i].IsAttachment {
|
||||
attachment = &msg.Parts[i]
|
||||
}
|
||||
}
|
||||
if attachment == nil {
|
||||
t.Fatal("kein anhang gefunden")
|
||||
}
|
||||
if attachment.Filename != "bild.png" {
|
||||
t.Fatalf("falscher dateiname: %q", attachment.Filename)
|
||||
}
|
||||
if attachment.ContentType != "image/png" {
|
||||
t.Fatalf("falscher content-type: %q", attachment.ContentType)
|
||||
}
|
||||
if attachment.Size != int64(len(attachment.Content)) || attachment.Size == 0 {
|
||||
t.Fatalf("unplausible größe: %d (content-len %d)", attachment.Size, len(attachment.Content))
|
||||
}
|
||||
}
|
||||
|
||||
// TestParse_BrokenCharsetIsRepairedNotAborted ist Akzeptanzkriterium 3:
|
||||
// fehlerhafte/inkonsistente Zeichensatzangaben werden defensiv repariert
|
||||
// statt die Verarbeitung abzubrechen.
|
||||
func TestParse_BrokenCharsetIsRepairedNotAborted(t *testing.T) {
|
||||
// "unbekannt-xyz" ist KEIN gültiger IANA-Zeichensatzname.
|
||||
raw := "From: a@example.com\r\n" +
|
||||
"Content-Type: text/plain; charset=\"unbekannt-xyz\"\r\n\r\n" +
|
||||
"Rohtext trotz kaputtem Charset\r\n"
|
||||
|
||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
||||
if err != nil {
|
||||
t.Fatalf("erwartet KEINEN abbruch bei kaputtem charset, habe: %v", err)
|
||||
}
|
||||
if len(msg.Parts) != 1 {
|
||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
||||
}
|
||||
if !strings.Contains(string(msg.Parts[0].Content), "Rohtext") {
|
||||
t.Fatalf("inhalt fehlt/verstümmelt: %q", msg.Parts[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
// TestParse_ISO88591BodyDecodedWithoutAbort ist Akzeptanzkriterium 3
|
||||
// zusätzlich: ein bekannter Nicht-UTF-8-Zeichensatz wird via
|
||||
// Header-Dekodierung real repariert (RFC-2047-kodierter Dateiname).
|
||||
func TestParse_ISO88591FilenameDecoded(t *testing.T) {
|
||||
// "=?ISO-8859-1?Q?Rechnung_=DC?=" kodiert "Rechnung Ü" (0xDC = 'Ü' in Latin-1).
|
||||
raw := "From: a@example.com\r\n" +
|
||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
||||
"--b\r\n" +
|
||||
"Content-Type: application/octet-stream\r\n" +
|
||||
"Content-Disposition: attachment; filename=\"=?ISO-8859-1?Q?Rechnung_=DC?=\"\r\n" +
|
||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
||||
"AAA=\r\n" +
|
||||
"--b--\r\n"
|
||||
|
||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
||||
if err != nil {
|
||||
t.Fatalf("parse: %v", err)
|
||||
}
|
||||
if len(msg.Parts) != 1 {
|
||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
||||
}
|
||||
if msg.Parts[0].Filename != "Rechnung Ü" {
|
||||
t.Fatalf("erwartet dekodierten dateinamen 'Rechnung Ü', habe %q", msg.Parts[0].Filename)
|
||||
}
|
||||
}
|
||||
|
||||
// infiniteReader liefert unbegrenzt viele Bytes — simuliert einen sehr
|
||||
// großen/böswilligen Anhang. Ohne io.LimitReader (siehe archivmail
|
||||
// known-issues #3) würde ein io.ReadAll hierauf den Prozessspeicher
|
||||
// erschöpfen; mit readLimited bricht Parse kontrolliert und schnell ab.
|
||||
type infiniteReader struct{}
|
||||
|
||||
func (infiniteReader) Read(p []byte) (int, error) {
|
||||
for i := range p {
|
||||
p[i] = 'A'
|
||||
}
|
||||
return len(p), nil
|
||||
}
|
||||
|
||||
// TestParse_OversizedAttachmentRejectedNotMemoryExhausted ist die
|
||||
// geforderte Pflichtprüfung 1.
|
||||
func TestParse_OversizedAttachmentRejectedNotMemoryExhausted(t *testing.T) {
|
||||
const tinyLimit = 1024 // 1 KiB — winzig, damit der Test schnell bleibt
|
||||
|
||||
header := "From: a@example.com\r\n" +
|
||||
"Content-Type: application/octet-stream\r\n" +
|
||||
"Content-Transfer-Encoding: identity\r\n\r\n"
|
||||
|
||||
r := io.MultiReader(strings.NewReader(header), infiniteReader{})
|
||||
_, err := Parse(r, tinyLimit)
|
||||
if !errors.Is(err, ErrAttachmentTooLarge) {
|
||||
t.Fatalf("erwartet ErrAttachmentTooLarge bei unbegrenzt großem anhang, habe: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestParse_RealisticCorpusRunsCleanly ist die geforderte
|
||||
// Pflichtprüfung 2: realitätsnahe Multipart-/Encoding-Varianten laufen
|
||||
// fehlerfrei durch.
|
||||
func TestParse_RealisticCorpusRunsCleanly(t *testing.T) {
|
||||
corpus := []string{
|
||||
// Einfache Textnachricht ohne Multipart.
|
||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\n\r\nEinfacher Text\r\n",
|
||||
// Quoted-Printable.
|
||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\nUmlaut: =C3=9C\r\n",
|
||||
// Multipart/alternative ohne Anhang.
|
||||
"From: a@example.com\r\nContent-Type: multipart/alternative; boundary=\"x\"\r\n\r\n--x\r\nContent-Type: text/plain\r\n\r\nText\r\n--x\r\nContent-Type: text/html\r\n\r\n<p>Text</p>\r\n--x--\r\n",
|
||||
// Leere Multipart-Nachricht (kein Teil, nur Präambel/Epilog).
|
||||
"From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"y\"\r\n\r\nPräambel wird ignoriert\r\n--y--\r\nEpilog wird ignoriert\r\n",
|
||||
}
|
||||
for i, raw := range corpus {
|
||||
if _, err := Parse(strings.NewReader(raw), defaultMaxSize); err != nil {
|
||||
t.Fatalf("corpus[%d] fehlgeschlagen: %v\nraw=%q", i, err, raw)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// FuzzParse ist die geforderte Pflichtprüfung 3: kaputte MIME-Strukturen
|
||||
// dürfen Parse nicht zum Absturz bringen, nur zu einem kontrollierten
|
||||
// Fehler.
|
||||
func FuzzParse(f *testing.F) {
|
||||
f.Add([]byte("From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"b\"\r\n\r\n--b\r\nContent-Type: text/plain\r\n\r\nHallo\r\n--b--\r\n"))
|
||||
f.Add([]byte("Content-Type: multipart/mixed; boundary=\r\n\r\nkaputt"))
|
||||
f.Add([]byte(""))
|
||||
f.Add([]byte("From: a@example.com\r\n\r\n"))
|
||||
|
||||
f.Fuzz(func(t *testing.T, data []byte) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
t.Fatalf("Parse ist abgestürzt (panic) statt kontrolliert einen Fehler zu liefern: %v", r)
|
||||
}
|
||||
}()
|
||||
_, _ = Parse(strings.NewReader(string(data)), defaultMaxSize)
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
// Package pflichttestgate erzwingt die in docs/TESTSTRATEGIE-MAIL.md
|
||||
// Abschnitt 4 festgelegte Regel: jede geänderte Go-Datei in einem
|
||||
// sicherheitskritischen Bereich (Auth, Tenant-Scoping, Protokoll-/
|
||||
// Compliance-kritisch) muss von einer geänderten oder neuen _test.go-
|
||||
// Datei im selben Package begleitet sein. Bewusste Code-Kopie des
|
||||
// Musters aus Core internal/pflichttestgate — Mail ist ein eigenständiges
|
||||
// Go-Modul und kann Core nicht importieren.
|
||||
package pflichttestgate
|
||||
|
||||
import (
|
||||
"path"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// sensitivePathPatterns beschreibt die Bereiche aus
|
||||
// TESTSTRATEGIE-MAIL.md Abschnitt 4.
|
||||
var sensitivePathPatterns = []*regexp.Regexp{
|
||||
regexp.MustCompile(`(^|/)mail/internal/auth/`),
|
||||
regexp.MustCompile(`(^|/)mail/internal/tenant/`),
|
||||
regexp.MustCompile(`(^|/)mail/internal/ingest/`),
|
||||
regexp.MustCompile(`(^|/)mail/internal/imap/`),
|
||||
regexp.MustCompile(`(^|/)mail/internal/smtp/`),
|
||||
regexp.MustCompile(`(^|/)mail/internal/arc/`),
|
||||
}
|
||||
|
||||
// Violation beschreibt ein Package mit sicherheitskritischer Änderung
|
||||
// ohne begleitende Testdatei.
|
||||
type Violation struct {
|
||||
Package string
|
||||
ChangedFile string
|
||||
}
|
||||
|
||||
func isSensitive(file string) bool {
|
||||
if !strings.HasSuffix(file, ".go") || strings.HasSuffix(file, "_test.go") {
|
||||
return false
|
||||
}
|
||||
for _, re := range sensitivePathPatterns {
|
||||
if re.MatchString(file) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// CheckDiff prüft eine Liste geänderter Dateipfade gegen die
|
||||
// Pflichttest-Regel — ein leeres Ergebnis bedeutet: Gate besteht.
|
||||
func CheckDiff(changedFiles []string) []Violation {
|
||||
sensitiveByPkg := map[string]string{}
|
||||
testTouchedPkgs := map[string]bool{}
|
||||
|
||||
for _, f := range changedFiles {
|
||||
pkg := path.Dir(f)
|
||||
if strings.HasSuffix(f, "_test.go") {
|
||||
testTouchedPkgs[pkg] = true
|
||||
continue
|
||||
}
|
||||
if isSensitive(f) {
|
||||
if _, seen := sensitiveByPkg[pkg]; !seen {
|
||||
sensitiveByPkg[pkg] = f
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var violations []Violation
|
||||
for pkg, file := range sensitiveByPkg {
|
||||
if !testTouchedPkgs[pkg] {
|
||||
violations = append(violations, Violation{Package: pkg, ChangedFile: file})
|
||||
}
|
||||
}
|
||||
return violations
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
// Negativtest des Gates selbst (QA-01 Prüfung 1): ein Diff mit
|
||||
// geänderter mail/internal/auth/login.go ohne begleitende Testdatei
|
||||
// muss als Verstoß erkannt werden.
|
||||
package pflichttestgate
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestCheckDiff_FlagsSensitiveChangeWithoutTest(t *testing.T) {
|
||||
violations := CheckDiff([]string{"mail/internal/auth/login.go"})
|
||||
if len(violations) != 1 {
|
||||
t.Fatalf("erwartet genau 1 verstoß, habe %d: %+v", len(violations), violations)
|
||||
}
|
||||
if violations[0].Package != "mail/internal/auth" {
|
||||
t.Fatalf("falsches package gemeldet: %+v", violations[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckDiff_PassesWhenTestFileAccompanies(t *testing.T) {
|
||||
violations := CheckDiff([]string{
|
||||
"mail/internal/auth/login.go",
|
||||
"mail/internal/auth/login_test.go",
|
||||
})
|
||||
if len(violations) != 0 {
|
||||
t.Fatalf("erwartet keine verstöße, habe: %+v", violations)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckDiff_IgnoresNonSensitivePaths(t *testing.T) {
|
||||
violations := CheckDiff([]string{"mail/internal/example/normalize.go"})
|
||||
if len(violations) != 0 {
|
||||
t.Fatalf("erwartet keine verstöße für nicht-sensiblen pfad, habe: %+v", violations)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
// Package storage implementiert ARC-01: die Objekt-Speicher-Anbindung
|
||||
// für archivierte Mails und Anhänge. Baut auf demselben bewährten
|
||||
// Muster wie DMS FDN-03 auf (austauschbare Driver, LocalDriver für
|
||||
// Entwicklung, S3Driver für Produktion) — Mail kann DMS' internal/
|
||||
// nicht importieren (eigenständiges Go-Modul), daher eine bewusste,
|
||||
// angepasste Neuimplementierung statt eines Cross-Modul-Imports.
|
||||
//
|
||||
// Erweiterung gegenüber FDN-03: ARC-01 verlangt Prüfsummenverifikation
|
||||
// AN DIESER SCHICHT (Akzeptanzkriterium 2), nicht erst an einer
|
||||
// späteren DB-Schicht — siehe service.go.
|
||||
package storage
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// ErrNotFound wird geliefert, wenn ein angefragtes Objekt nicht
|
||||
// existiert.
|
||||
var ErrNotFound = errors.New("storage: objekt nicht gefunden")
|
||||
|
||||
// Driver ist die EINE Schnittstelle, gegen die der Rest von Mail
|
||||
// arbeitet (Akzeptanzkriterium 1). Zwei Implementierungen: LocalDriver
|
||||
// (Entwicklung) und S3Driver (Produktion, S3-kompatibel).
|
||||
type Driver interface {
|
||||
Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error)
|
||||
Get(ctx context.Context, key string) (io.ReadCloser, error)
|
||||
Delete(ctx context.Context, key string) error
|
||||
}
|
||||
|
||||
// ObjectKey liefert das feste, dokumentierte Pfadschema für einen
|
||||
// Mail-Anhang/-Teil INNERHALB des bereits mandantenspezifischen
|
||||
// Buckets (Akzeptanzkriterium 1) — Bucket-Trennung selbst ist Sache
|
||||
// von Core TEN-01. Lesezugriff hängt NUR von messageID+partIndex ab,
|
||||
// nicht vom ursprünglichen Importpfad (IMAP/SMTP/manueller Import —
|
||||
// Akzeptanzkriterium 3): derselbe Key wird unabhängig davon berechnet,
|
||||
// über welchen Weg die Nachricht ins System kam.
|
||||
func ObjectKey(messageID string, partIndex int) string {
|
||||
return "messages/" + messageID + "/parts/" + strconv.Itoa(partIndex)
|
||||
}
|
||||
|
||||
// checksumKey ist der Sidecar-Objektschlüssel für die beim Schreiben
|
||||
// berechnete Prüfsumme (siehe service.go) — liegt bewusst im selben
|
||||
// Driver/Bucket wie der Inhalt, keine separate DB-Abhängigkeit nötig.
|
||||
func checksumKey(key string) string {
|
||||
return key + ".sha256"
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
// LocalDriver legt Objekte im lokalen Dateisystem ab — der
|
||||
// Entwicklungs-Treiber (Akzeptanzkriterium 1), keine externe
|
||||
// Abhängigkeit nötig.
|
||||
type LocalDriver struct {
|
||||
baseDir string
|
||||
}
|
||||
|
||||
func NewLocalDriver(baseDir string) *LocalDriver {
|
||||
return &LocalDriver{baseDir: baseDir}
|
||||
}
|
||||
|
||||
func (d *LocalDriver) path(key string) string {
|
||||
return filepath.Join(d.baseDir, filepath.FromSlash(key))
|
||||
}
|
||||
|
||||
func (d *LocalDriver) Put(_ context.Context, key string, r io.Reader, _ int64, _ string) (int64, error) {
|
||||
full := d.path(key)
|
||||
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||
return 0, fmt.Errorf("storage: verzeichnis anlegen: %w", err)
|
||||
}
|
||||
f, err := os.Create(full)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("storage: datei anlegen: %w", err)
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
written, err := io.Copy(f, r)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("storage: schreiben: %w", err)
|
||||
}
|
||||
return written, nil
|
||||
}
|
||||
|
||||
func (d *LocalDriver) Get(_ context.Context, key string) (io.ReadCloser, error) {
|
||||
f, err := os.Open(d.path(key))
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
return nil, fmt.Errorf("storage: lesen: %w", err)
|
||||
}
|
||||
return f, nil
|
||||
}
|
||||
|
||||
func (d *LocalDriver) Delete(_ context.Context, key string) error {
|
||||
if err := os.Remove(d.path(key)); err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return ErrNotFound
|
||||
}
|
||||
return fmt.Errorf("storage: löschen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/aws/aws-sdk-go-v2/aws"
|
||||
"github.com/aws/aws-sdk-go-v2/config"
|
||||
"github.com/aws/aws-sdk-go-v2/credentials"
|
||||
"github.com/aws/aws-sdk-go-v2/service/s3"
|
||||
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
||||
"github.com/aws/smithy-go"
|
||||
)
|
||||
|
||||
// S3Driver legt Objekte in einem S3-kompatiblen Objektspeicher ab — der
|
||||
// Produktions-Treiber (Akzeptanzkriterium 1). Funktioniert gegen echtes
|
||||
// AWS S3 UND gegen jeden S3-kompatiblen Anbieter (MinIO etc.) über
|
||||
// endpointURL. Gleiches, bewährtes Muster wie DMS FDN-03s S3Driver
|
||||
// (bewusste Kopie, Mail kann DMS nicht importieren).
|
||||
type S3Driver struct {
|
||||
client *s3.Client
|
||||
bucket string
|
||||
}
|
||||
|
||||
func NewS3Driver(ctx context.Context, bucket, region, endpointURL, accessKeyID, secretAccessKey string, usePathStyle bool) (*S3Driver, error) {
|
||||
cfg, err := config.LoadDefaultConfig(ctx,
|
||||
config.WithRegion(region),
|
||||
config.WithCredentialsProvider(credentials.NewStaticCredentialsProvider(accessKeyID, secretAccessKey, "")),
|
||||
)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("storage: s3-konfiguration laden: %w", err)
|
||||
}
|
||||
|
||||
client := s3.NewFromConfig(cfg, func(o *s3.Options) {
|
||||
if endpointURL != "" {
|
||||
o.BaseEndpoint = aws.String(endpointURL)
|
||||
}
|
||||
o.UsePathStyle = usePathStyle
|
||||
})
|
||||
return &S3Driver{client: client, bucket: bucket}, nil
|
||||
}
|
||||
|
||||
func (d *S3Driver) Put(ctx context.Context, key string, r io.Reader, _ int64, contentType string) (int64, error) {
|
||||
buf, err := io.ReadAll(r)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("storage: objekt vor upload lesen: %w", err)
|
||||
}
|
||||
_, err = d.client.PutObject(ctx, &s3.PutObjectInput{
|
||||
Bucket: aws.String(d.bucket),
|
||||
Key: aws.String(key),
|
||||
Body: bytes.NewReader(buf),
|
||||
ContentLength: aws.Int64(int64(len(buf))),
|
||||
ContentType: aws.String(contentType),
|
||||
})
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("storage: s3-upload: %w", err)
|
||||
}
|
||||
return int64(len(buf)), nil
|
||||
}
|
||||
|
||||
func (d *S3Driver) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
||||
out, err := d.client.GetObject(ctx, &s3.GetObjectInput{
|
||||
Bucket: aws.String(d.bucket),
|
||||
Key: aws.String(key),
|
||||
})
|
||||
if err != nil {
|
||||
if isS3NotFound(err) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
return nil, fmt.Errorf("storage: s3-download: %w", err)
|
||||
}
|
||||
return out.Body, nil
|
||||
}
|
||||
|
||||
func (d *S3Driver) Delete(ctx context.Context, key string) error {
|
||||
// S3 liefert bei DeleteObject fuer ein nicht existierendes Objekt
|
||||
// KEINEN Fehler (idempotente S3-API-Semantik) — um denselben
|
||||
// Vertrag wie LocalDriver (ErrNotFound bei fehlendem Objekt) zu
|
||||
// erfüllen, wird die Existenz vorher explizit geprüft.
|
||||
_, err := d.client.HeadObject(ctx, &s3.HeadObjectInput{Bucket: aws.String(d.bucket), Key: aws.String(key)})
|
||||
if err != nil {
|
||||
if isS3NotFound(err) {
|
||||
return ErrNotFound
|
||||
}
|
||||
return fmt.Errorf("storage: s3-existenzprüfung vor löschen: %w", err)
|
||||
}
|
||||
|
||||
if _, err := d.client.DeleteObject(ctx, &s3.DeleteObjectInput{
|
||||
Bucket: aws.String(d.bucket),
|
||||
Key: aws.String(key),
|
||||
}); err != nil {
|
||||
return fmt.Errorf("storage: s3-löschen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func isS3NotFound(err error) bool {
|
||||
var nsk *types.NoSuchKey
|
||||
if errors.As(err, &nsk) {
|
||||
return true
|
||||
}
|
||||
var apiErr smithy.APIError
|
||||
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "NotFound" {
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -0,0 +1,127 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// ErrChecksumMismatch wird von GetVerified geliefert, wenn der beim
|
||||
// Lesen berechnete Hash nicht mit der beim Schreiben gespeicherten
|
||||
// Prüfsumme übereinstimmt (Akzeptanzkriterium 2 / Pflichtprüfung 2:
|
||||
// ein absichtlich beschädigtes Objekt wird erkannt).
|
||||
var ErrChecksumMismatch = errors.New("storage: prüfsumme stimmt nicht überein — objekt wurde verändert")
|
||||
|
||||
// Service verbindet einen Driver mit Prüfsummenverifikation
|
||||
// (Akzeptanzkriterium 2) und der Nutzungsmeldung an Core LIC-05
|
||||
// (Akzeptanzkriterium 4) — jeder Schreib-/Löschvorgang über Service
|
||||
// löst GENAU EINE Meldung mit der tatsächlich geschriebenen/gelöschten
|
||||
// Objektgröße aus. Aufrufer (spätere Tickets, z. B. IMP-*) rufen
|
||||
// ausschließlich Service auf, nie einen Driver direkt.
|
||||
type Service struct {
|
||||
driver Driver
|
||||
usage UsageReporter
|
||||
tenantSlug string
|
||||
}
|
||||
|
||||
func NewService(driver Driver, usage UsageReporter, tenantSlug string) *Service {
|
||||
return &Service{driver: driver, usage: usage, tenantSlug: tenantSlug}
|
||||
}
|
||||
|
||||
// Put legt den Inhalt ab UND verifiziert den Schreibvorgang durch
|
||||
// Prüfsummenvergleich (Akzeptanzkriterium 2): der Inhalt wird
|
||||
// geschrieben, die Prüfsumme als Sidecar-Objekt gespeichert, danach
|
||||
// SOFORT zurückgelesen und erneut gehasht — weicht der Rückgelesene
|
||||
// Hash vom beim Schreiben berechneten ab, meldet Put einen Fehler,
|
||||
// statt eine unbemerkt fehlerhafte Ablage stehen zu lassen. Meldet die
|
||||
// geschriebene Größe als positives Delta an Core LIC-05
|
||||
// (Akzeptanzkriterium 4).
|
||||
func (s *Service) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (checksum string, err error) {
|
||||
hasher := sha256.New()
|
||||
tee := io.TeeReader(r, hasher)
|
||||
|
||||
written, err := s.driver.Put(ctx, key, tee, size, contentType)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
checksum = hex.EncodeToString(hasher.Sum(nil))
|
||||
|
||||
if _, err := s.driver.Put(ctx, checksumKey(key), bytes.NewReader([]byte(checksum)), int64(len(checksum)), "text/plain"); err != nil {
|
||||
return "", fmt.Errorf("storage: prüfsumme speichern: %w", err)
|
||||
}
|
||||
|
||||
// Sofortige Rücklese-Verifikation — beweist, dass der Schreibvorgang
|
||||
// tatsächlich verifiziert wurde, nicht nur eine Prüfsumme abgelegt
|
||||
// wurde, die nie geprüft wird.
|
||||
if _, err := s.GetVerified(ctx, key); err != nil {
|
||||
return "", fmt.Errorf("storage: schreibverifikation fehlgeschlagen: %w", err)
|
||||
}
|
||||
|
||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, written); err != nil {
|
||||
return checksum, fmt.Errorf("storage: objekt gespeichert, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
||||
}
|
||||
return checksum, nil
|
||||
}
|
||||
|
||||
// Get liefert den Inhalt UNVERIFIZIERT (Streaming, für große Objekte).
|
||||
// Für die Pflichtprüfung "beschädigtes Objekt wird erkannt" GetVerified
|
||||
// verwenden.
|
||||
func (s *Service) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
||||
return s.driver.Get(ctx, key)
|
||||
}
|
||||
|
||||
// GetVerified liest den vollständigen Inhalt UND vergleicht die beim
|
||||
// Schreiben gespeicherte Prüfsumme gegen den beim Lesen berechneten
|
||||
// Hash (Akzeptanzkriterium 2 / Pflichtprüfung 2).
|
||||
func (s *Service) GetVerified(ctx context.Context, key string) ([]byte, error) {
|
||||
sumReader, err := s.driver.Get(ctx, checksumKey(key))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
||||
}
|
||||
expectedRaw, err := io.ReadAll(sumReader)
|
||||
_ = sumReader.Close()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
||||
}
|
||||
expected := string(expectedRaw)
|
||||
|
||||
contentReader, err := s.driver.Get(ctx, key)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer func() { _ = contentReader.Close() }()
|
||||
|
||||
hasher := sha256.New()
|
||||
content, err := io.ReadAll(io.TeeReader(contentReader, hasher))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("storage: objekt lesen: %w", err)
|
||||
}
|
||||
actual := hex.EncodeToString(hasher.Sum(nil))
|
||||
if actual != expected {
|
||||
return nil, ErrChecksumMismatch
|
||||
}
|
||||
return content, nil
|
||||
}
|
||||
|
||||
// Delete entfernt Inhalt UND Prüfsummen-Sidecar, meldet die Größe als
|
||||
// negatives Delta an Core LIC-05 (Akzeptanzkriterium 4) — der Aufrufer
|
||||
// muss die Größe kennen (Delete selbst kann sie nach dem Löschen nicht
|
||||
// mehr ermitteln).
|
||||
func (s *Service) Delete(ctx context.Context, key string, sizeBytes int64) error {
|
||||
if err := s.driver.Delete(ctx, key); err != nil {
|
||||
return err
|
||||
}
|
||||
// Sidecar-Löschung ist best effort — ein fehlendes Sidecar (z. B.
|
||||
// bei einem sehr alten Objekt) darf den eigentlichen Löschvorgang
|
||||
// nicht blockieren.
|
||||
_ = s.driver.Delete(ctx, checksumKey(key))
|
||||
|
||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, -sizeBytes); err != nil {
|
||||
return fmt.Errorf("storage: objekt gelöscht, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,134 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
type fakeUsageReporter struct {
|
||||
reports []int64
|
||||
}
|
||||
|
||||
func (f *fakeUsageReporter) Report(_ context.Context, _, metric string, delta int64) error {
|
||||
if metric != UsageMetric {
|
||||
return errors.New("unerwartete metrik: " + metric)
|
||||
}
|
||||
f.reports = append(f.reports, delta)
|
||||
return nil
|
||||
}
|
||||
|
||||
func newTestService(t *testing.T) (*Service, *fakeUsageReporter) {
|
||||
t.Helper()
|
||||
driver := NewLocalDriver(t.TempDir())
|
||||
usage := &fakeUsageReporter{}
|
||||
return NewService(driver, usage, "acme"), usage
|
||||
}
|
||||
|
||||
// TestPut_ReadBackIsByteIdentical ist die geforderte Pflichtprüfung 1:
|
||||
// ein geschriebenes Objekt liefert beim Lesen byteidentischen Inhalt.
|
||||
func TestPut_ReadBackIsByteIdentical(t *testing.T) {
|
||||
svc, _ := newTestService(t)
|
||||
ctx := context.Background()
|
||||
key := ObjectKey("msg-1", 0)
|
||||
content := "vollständig identischer Inhalt äöü"
|
||||
|
||||
checksum, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain")
|
||||
if err != nil {
|
||||
t.Fatalf("put: %v", err)
|
||||
}
|
||||
if checksum == "" {
|
||||
t.Fatal("erwartet nicht-leere prüfsumme")
|
||||
}
|
||||
|
||||
got, err := svc.GetVerified(ctx, key)
|
||||
if err != nil {
|
||||
t.Fatalf("getverified: %v", err)
|
||||
}
|
||||
if string(got) != content {
|
||||
t.Fatalf("nicht byteidentisch: got %q, want %q", got, content)
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetVerified_DetectsTamperedObject ist die geforderte
|
||||
// Pflichtprüfung 2: ein absichtlich beschädigtes Objekt wird bei
|
||||
// Prüfsummenvergleich erkannt.
|
||||
func TestGetVerified_DetectsTamperedObject(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
driver := NewLocalDriver(dir)
|
||||
usage := &fakeUsageReporter{}
|
||||
svc := NewService(driver, usage, "acme")
|
||||
ctx := context.Background()
|
||||
key := ObjectKey("msg-tamper", 0)
|
||||
|
||||
if _, err := svc.Put(ctx, key, strings.NewReader("originaler inhalt"), 17, "text/plain"); err != nil {
|
||||
t.Fatalf("put: %v", err)
|
||||
}
|
||||
|
||||
// Objekt DIREKT am Dateisystem manipulieren — umgeht Service
|
||||
// vollständig, simuliert externe Beschädigung/Manipulation.
|
||||
full := driver.path(key)
|
||||
if err := os.WriteFile(full, []byte("MANIPULIERTER INHALT"), 0o644); err != nil {
|
||||
t.Fatalf("manipulation schreiben: %v", err)
|
||||
}
|
||||
|
||||
_, err := svc.GetVerified(ctx, key)
|
||||
if !errors.Is(err, ErrChecksumMismatch) {
|
||||
t.Fatalf("erwartet ErrChecksumMismatch bei manipuliertem objekt, habe: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPut_ManySmallObjectsAcceptableLatency ist die geforderte
|
||||
// Pflichtprüfung 3: Lasttest mit vielen kleinen Objekten bestätigt
|
||||
// akzeptable Latenz.
|
||||
func TestPut_ManySmallObjectsAcceptableLatency(t *testing.T) {
|
||||
svc, _ := newTestService(t)
|
||||
ctx := context.Background()
|
||||
|
||||
const count = 500
|
||||
start := time.Now()
|
||||
for i := 0; i < count; i++ {
|
||||
key := ObjectKey("msg-load", i)
|
||||
if _, err := svc.Put(ctx, key, strings.NewReader("kleiner anhang inhalt"), 21, "text/plain"); err != nil {
|
||||
t.Fatalf("put #%d: %v", i, err)
|
||||
}
|
||||
}
|
||||
elapsed := time.Since(start)
|
||||
avgPerObject := elapsed / count
|
||||
|
||||
// Großzügige Grenze (10ms/Objekt inkl. Schreiben+Sidecar+Rücklese-
|
||||
// Verifikation) — Ziel ist der Nachweis, dass keine quadratische
|
||||
// oder anderweitig unverhältnismäßige Verschlechterung auftritt,
|
||||
// nicht ein knallhartes Performance-SLA.
|
||||
if avgPerObject > 10*time.Millisecond {
|
||||
t.Fatalf("erwartet akzeptable latenz (<10ms/objekt), habe %v/objekt (gesamt %v für %d objekte)", avgPerObject, elapsed, count)
|
||||
}
|
||||
t.Logf("Lasttest: %d Objekte in %v (%v/Objekt)", count, elapsed, avgPerObject)
|
||||
}
|
||||
|
||||
// TestPut_ReportsUsageOnWriteAndDelete ist die geforderte
|
||||
// Pflichtprüfung 4: Melde-Aufruf an Core LIC-05 bei Schreib- und
|
||||
// Löschvorgang nachweislich ausgelöst, mit korrekter Größenangabe.
|
||||
func TestPut_ReportsUsageOnWriteAndDelete(t *testing.T) {
|
||||
svc, usage := newTestService(t)
|
||||
ctx := context.Background()
|
||||
key := ObjectKey("msg-usage", 0)
|
||||
content := "zwölf bytes!"
|
||||
|
||||
if _, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
||||
t.Fatalf("put: %v", err)
|
||||
}
|
||||
if len(usage.reports) != 1 || usage.reports[0] != int64(len(content)) {
|
||||
t.Fatalf("erwartet genau eine positive meldung mit größe %d, habe: %v", len(content), usage.reports)
|
||||
}
|
||||
|
||||
if err := svc.Delete(ctx, key, int64(len(content))); err != nil {
|
||||
t.Fatalf("delete: %v", err)
|
||||
}
|
||||
if len(usage.reports) != 2 || usage.reports[1] != -int64(len(content)) {
|
||||
t.Fatalf("erwartet zusätzliche negative meldung mit -%d, habe: %v", len(content), usage.reports)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// UsageMetric ist der Metrikname, unter dem Core (internal/usage,
|
||||
// LIC-05) den Speicherverbrauch je Mandant führt — muss exakt
|
||||
// internal/usage.StorageBytesMetric aus dem NEXARCH-Core-Modul
|
||||
// entsprechen (Mail kann Core nicht importieren, daher hier gespiegelt
|
||||
// — identisches Muster wie DMS FDN-03).
|
||||
const UsageMetric = "storage_bytes"
|
||||
|
||||
// UsageReporter meldet Speicherverbrauchsänderungen an Core
|
||||
// (Akzeptanzkriterium 4). Schmale Schnittstelle, damit Tests einen
|
||||
// Fake statt eines echten HTTP-Aufrufs einsetzen können.
|
||||
type UsageReporter interface {
|
||||
Report(ctx context.Context, tenantSlug, metric string, delta int64) error
|
||||
}
|
||||
|
||||
// usageDeltaDTO entspricht Core internal/resync.usageDeltaDTO
|
||||
// (JSON-Vertrag: tenant_slug/metric/delta), über den API-11
|
||||
// (resync-api) real erreichbar ist.
|
||||
type usageDeltaDTO struct {
|
||||
TenantSlug string `json:"tenant_slug"`
|
||||
Metric string `json:"metric"`
|
||||
Delta int64 `json:"delta"`
|
||||
}
|
||||
|
||||
// HTTPUsageReporter meldet über Core API-11 (resync-api,
|
||||
// internal/resync.Handler.UsageHandler), authentifiziert über
|
||||
// dasselbe Service-Credential-Verfahren wie jeder andere Modul-Core-
|
||||
// Aufruf (API-02).
|
||||
type HTTPUsageReporter struct {
|
||||
endpointURL string
|
||||
clientID string
|
||||
clientSecret string
|
||||
httpClient *http.Client
|
||||
}
|
||||
|
||||
func NewHTTPUsageReporter(endpointURL, clientID, clientSecret string, httpClient *http.Client) *HTTPUsageReporter {
|
||||
if httpClient == nil {
|
||||
httpClient = http.DefaultClient
|
||||
}
|
||||
return &HTTPUsageReporter{endpointURL: endpointURL, clientID: clientID, clientSecret: clientSecret, httpClient: httpClient}
|
||||
}
|
||||
|
||||
func (r *HTTPUsageReporter) Report(ctx context.Context, tenantSlug, metric string, delta int64) error {
|
||||
body, err := json.Marshal([]usageDeltaDTO{{TenantSlug: tenantSlug, Metric: metric, Delta: delta}})
|
||||
if err != nil {
|
||||
return fmt.Errorf("storage: nutzungsmeldung serialisieren: %w", err)
|
||||
}
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, r.endpointURL, bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return fmt.Errorf("storage: nutzungsmeldungs-anfrage aufbauen: %w", err)
|
||||
}
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.Header.Set("X-Nexarch-Client-Id", r.clientID)
|
||||
req.Header.Set("X-Nexarch-Client-Secret", r.clientSecret)
|
||||
|
||||
resp, err := r.httpClient.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("storage: nutzungsmeldung senden: %w", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return fmt.Errorf("storage: nutzungsmeldung von core abgelehnt: status %d", resp.StatusCode)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user