Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
67bcdd1833 | ||
|
|
8100fa3d14 | ||
|
|
ae214f1731 | ||
|
|
10ba866f0e | ||
|
|
5e4b91c4e9 |
@@ -1,23 +0,0 @@
|
||||
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
|
||||
@@ -0,0 +1,18 @@
|
||||
version: "2"
|
||||
|
||||
run:
|
||||
timeout: 3m
|
||||
|
||||
linters:
|
||||
default: none
|
||||
enable:
|
||||
- govet
|
||||
- staticcheck
|
||||
- errcheck
|
||||
- unused
|
||||
- ineffassign
|
||||
|
||||
formatters:
|
||||
enable:
|
||||
- gofmt
|
||||
- goimports
|
||||
@@ -0,0 +1,19 @@
|
||||
.PHONY: build lint fmt test check
|
||||
|
||||
build:
|
||||
go build ./...
|
||||
|
||||
lint:
|
||||
golangci-lint run ./...
|
||||
|
||||
fmt:
|
||||
gofmt -l .
|
||||
@test -z "$$(gofmt -l .)" || (echo "gofmt-Verstoesse gefunden, siehe oben" && exit 1)
|
||||
|
||||
test:
|
||||
go test ./... -p 1 -count=1
|
||||
|
||||
check: build
|
||||
go vet ./...
|
||||
golangci-lint run ./...
|
||||
go test ./... -p 1 -count=1
|
||||
@@ -0,0 +1,62 @@
|
||||
# NEXARCH Archive
|
||||
|
||||
Zentrales, modulübergreifendes Modul für Aufbewahrung, WORM, Compliance und
|
||||
Backup. Dieses Verzeichnis enthält bisher `internal/backup` (BAK-01,
|
||||
Datenbank-Backup-Strategie) — weitere Bausteine folgen ticketweise.
|
||||
|
||||
## BAK-01: Datenbank-Backup
|
||||
|
||||
`cmd/backup-cli` — Aufrufpunkt für systemd-Timer (siehe
|
||||
`../deploy/systemd/nexarch-archive-backup-*.timer`):
|
||||
|
||||
```bash
|
||||
export NEXARCH_BACKUP_PG_USER=nexarch_backup
|
||||
export NEXARCH_BACKUP_PG_PASSWORD=...
|
||||
export NEXARCH_BACKUP_DIR=/var/nexarch-archiv/backups/postgres # NICHT auf einem ephemeren Test-Dataset (siehe Betrieb)
|
||||
export NEXARCH_BACKUP_KEEP_GENERATIONS=7 # optional, Default 7
|
||||
|
||||
backup-cli full # neue Vollsicherung + Verifikation
|
||||
backup-cli incremental # inkrementelle Sicherung gegen die neueste Generation
|
||||
backup-cli rotate # entfernt alle bis auf die neuesten N Generationen
|
||||
```
|
||||
|
||||
Voraussetzung: die konfigurierte Postgres-Rolle braucht das
|
||||
`REPLICATION`-Attribut (`pg_basebackup` nutzt eine
|
||||
Replikationsverbindung), und `summarize_wal = on` muss serverseitig gesetzt
|
||||
sein (PostgreSQL 17s natives inkrementelles Backup, keine WAL-Archivierung
|
||||
nötig).
|
||||
|
||||
## BAK-02: Objekt-Storage-Backup
|
||||
|
||||
`cmd/objectbackup-cli` sichert einen lokalen Verzeichnisbaum (den
|
||||
FDN-03-`LocalDriver`-Basisordner direkt, oder — für S3-gestützte
|
||||
Deployments — einen vorgelagerten `rclone`-Spiegel) mit
|
||||
[restic](https://restic.net) (Content-defined Chunking, verschlüsseltes
|
||||
Repository, geprüftes Tooling statt Eigenbau):
|
||||
|
||||
```bash
|
||||
export NEXARCH_OBJECTBACKUP_REPO_DIR=/var/nexarch-archiv/backups/objects
|
||||
export NEXARCH_OBJECTBACKUP_PASSWORD=...
|
||||
export NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS=30 # optional, Default 7
|
||||
|
||||
objectbackup-cli backup /var/nexarch-objects # Sicherung + Verifikation
|
||||
objectbackup-cli check # vollständiges Lesen aller Datenblöcke
|
||||
objectbackup-cli rotate # restic forget --keep-last N --prune
|
||||
```
|
||||
|
||||
## Betrieb: Backup-Zielverzeichnis
|
||||
|
||||
Backup-Ziele liegen unter `/var/nexarch-archiv/` (persistentes ZFS-Dataset,
|
||||
`zfs/data/subvol-1131-disk-0` auf 192.168.1.131), NIEMALS unter
|
||||
`/var/nexarch-test/` (ephemeres Dataset, wird von den `reset-test-env.sh`-
|
||||
Skripten der anderen Module geleert). ZFS-seitige Snapshots/Replikation
|
||||
dieses Datasets sind ein eigenständiges Infra-Runbook (siehe
|
||||
`../../STORAGE-KONZEPT.md` Abschnitt 7), kein Ticket-Code — `zfs
|
||||
dedup=on` bewusst NICHT setzen (hoher RAM-Bedarf), Deduplizierung läuft
|
||||
ausschließlich App-seitig über restic.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
```bash
|
||||
make check # build + vet + lint + test, analog Core/DMS
|
||||
```
|
||||
@@ -0,0 +1,107 @@
|
||||
// backup-cli ist der Aufrufpunkt für BAK-01, gedacht für systemd-Timer
|
||||
// (siehe deploy/systemd/) — "automatisiert nach Zeitplan" (Akzeptanzkriterium
|
||||
// 1) entsteht durch die Zeitplan-Definition im Timer-Unit, nicht durch
|
||||
// einen eigenen In-Prozess-Scheduler (kein zusätzlicher Dauerprozess nötig,
|
||||
// passt zur Produkt-DNA "kein Anwendungsserver mit unnötigem
|
||||
// Ressourcenverbrauch").
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/backup"
|
||||
)
|
||||
|
||||
func loadConfig() backup.Config {
|
||||
cfg := backup.Config{
|
||||
Host: os.Getenv("NEXARCH_BACKUP_PG_HOST"),
|
||||
Port: os.Getenv("NEXARCH_BACKUP_PG_PORT"),
|
||||
User: os.Getenv("NEXARCH_BACKUP_PG_USER"),
|
||||
Password: os.Getenv("NEXARCH_BACKUP_PG_PASSWORD"),
|
||||
BackupDir: os.Getenv("NEXARCH_BACKUP_DIR"),
|
||||
}
|
||||
if cfg.Host == "" {
|
||||
cfg.Host = "localhost"
|
||||
}
|
||||
if cfg.Port == "" {
|
||||
cfg.Port = "5432"
|
||||
}
|
||||
if cfg.User == "" || cfg.Password == "" || cfg.BackupDir == "" {
|
||||
log.Fatal("NEXARCH_BACKUP_PG_USER, NEXARCH_BACKUP_PG_PASSWORD und NEXARCH_BACKUP_DIR muessen gesetzt sein")
|
||||
}
|
||||
return cfg
|
||||
}
|
||||
|
||||
func latestManifest(backupDir string) (string, error) {
|
||||
generations, err := backup.ListGenerations(backupDir)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if len(generations) == 0 {
|
||||
return "", fmt.Errorf("keine vorhandene generation fuer inkrementelle sicherung gefunden - zuerst 'full' ausfuehren")
|
||||
}
|
||||
latest := generations[len(generations)-1]
|
||||
full := backupDir + "/" + latest + "/" + backup.FullBackupDirName + "/" + backup.BackupManifestFile
|
||||
if _, err := os.Stat(full); err == nil {
|
||||
return full, nil
|
||||
}
|
||||
return "", fmt.Errorf("kein backup_manifest in der neuesten generation %q gefunden", latest)
|
||||
}
|
||||
|
||||
func main() {
|
||||
if len(os.Args) < 2 {
|
||||
log.Fatal("aufruf: backup-cli <full|incremental|verify|rotate> [args]")
|
||||
}
|
||||
cfg := loadConfig()
|
||||
ctx := context.Background()
|
||||
|
||||
switch os.Args[1] {
|
||||
case "full":
|
||||
genID := backup.NewGenerationID(time.Now())
|
||||
manifest, err := backup.FullBackup(ctx, cfg, genID)
|
||||
if err != nil {
|
||||
log.Fatalf("vollsicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
dir := manifest[:len(manifest)-len("/"+backup.BackupManifestFile)]
|
||||
if err := backup.Verify(dir); err != nil {
|
||||
log.Fatalf("verifikation der vollsicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Printf("vollsicherung %q erstellt und verifiziert: %s\n", genID, manifest)
|
||||
|
||||
case "incremental":
|
||||
manifest, err := latestManifest(cfg.BackupDir)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
generations, _ := backup.ListGenerations(cfg.BackupDir)
|
||||
genID := generations[len(generations)-1]
|
||||
incID := backup.NewGenerationID(time.Now())
|
||||
newManifest, err := backup.IncrementalBackup(ctx, cfg, genID, incID, manifest)
|
||||
if err != nil {
|
||||
log.Fatalf("inkrementelle sicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
dir := newManifest[:len(newManifest)-len("/"+backup.BackupManifestFile)]
|
||||
if err := backup.Verify(dir); err != nil {
|
||||
log.Fatalf("verifikation der inkrementellen sicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Printf("inkrementelle sicherung %q erstellt und verifiziert: %s\n", incID, newManifest)
|
||||
|
||||
case "rotate":
|
||||
keep := 7
|
||||
if v := os.Getenv("NEXARCH_BACKUP_KEEP_GENERATIONS"); v != "" {
|
||||
_, _ = fmt.Sscanf(v, "%d", &keep)
|
||||
}
|
||||
removed, err := backup.Rotate(cfg.BackupDir, keep)
|
||||
if err != nil {
|
||||
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Printf("rotation abgeschlossen, %d generation(en) entfernt: %v\n", len(removed), removed)
|
||||
|
||||
default:
|
||||
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
// objectbackup-cli ist der Aufrufpunkt für BAK-02, für systemd-Timer
|
||||
// gedacht (siehe deploy/systemd/) — "automatisiert nach Zeitplan" entsteht
|
||||
// durch die Timer-Definition, kein eigener Dauerprozess (dieselbe
|
||||
// Begründung wie BAK-01 / cmd/backup-cli).
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"strconv"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/objectbackup"
|
||||
)
|
||||
|
||||
func loadConfig() objectbackup.Config {
|
||||
cfg := objectbackup.Config{
|
||||
RepoDir: os.Getenv("NEXARCH_OBJECTBACKUP_REPO_DIR"),
|
||||
Password: os.Getenv("NEXARCH_OBJECTBACKUP_PASSWORD"),
|
||||
}
|
||||
if cfg.RepoDir == "" || cfg.Password == "" {
|
||||
log.Fatal("NEXARCH_OBJECTBACKUP_REPO_DIR und NEXARCH_OBJECTBACKUP_PASSWORD muessen gesetzt sein")
|
||||
}
|
||||
return cfg
|
||||
}
|
||||
|
||||
func main() {
|
||||
if len(os.Args) < 2 {
|
||||
log.Fatal("aufruf: objectbackup-cli <backup <quellverzeichnis>|check|rotate>")
|
||||
}
|
||||
cfg := loadConfig()
|
||||
ctx := context.Background()
|
||||
|
||||
if err := objectbackup.InitRepo(ctx, cfg); err != nil {
|
||||
log.Fatalf("repository initialisieren: %v", err)
|
||||
}
|
||||
|
||||
switch os.Args[1] {
|
||||
case "backup":
|
||||
if len(os.Args) < 3 {
|
||||
log.Fatal("aufruf: objectbackup-cli backup <quellverzeichnis>")
|
||||
}
|
||||
summary, err := objectbackup.Backup(ctx, cfg, os.Args[2])
|
||||
if err != nil {
|
||||
log.Fatalf("sicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
if err := objectbackup.Check(ctx, cfg, false); err != nil {
|
||||
log.Fatalf("verifikation nach sicherung fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Printf("sicherung %q erstellt und verifiziert (neu=%d geaendert=%d unveraendert=%d)\n",
|
||||
summary.SnapshotID, summary.FilesNew, summary.FilesChanged, summary.FilesUnmodified)
|
||||
|
||||
case "check":
|
||||
if err := objectbackup.Check(ctx, cfg, true); err != nil {
|
||||
log.Fatalf("verifikation fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Println("verifikation (mit vollstaendigem lesen) erfolgreich")
|
||||
|
||||
case "rotate":
|
||||
keep := 7
|
||||
if v := os.Getenv("NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS"); v != "" {
|
||||
if n, err := strconv.Atoi(v); err == nil {
|
||||
keep = n
|
||||
}
|
||||
}
|
||||
if err := objectbackup.Forget(ctx, cfg, keep); err != nil {
|
||||
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||
}
|
||||
fmt.Println("rotation abgeschlossen")
|
||||
|
||||
default:
|
||||
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
// reconcile-cli ist der Aufrufpunkt für BAK-05, für systemd-Timer gedacht
|
||||
// (siehe deploy/systemd/) — "geplanter Abgleichs-Job" (Ticket-Vorgabe)
|
||||
// entsteht durch die Timer-Definition, kein eigener Dauerprozess.
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"log"
|
||||
"os"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||
)
|
||||
|
||||
func main() {
|
||||
dsn := os.Getenv("NEXARCH_RECONCILE_TENANT_DSN")
|
||||
storageDir := os.Getenv("NEXARCH_RECONCILE_STORAGE_DIR")
|
||||
if dsn == "" || storageDir == "" {
|
||||
log.Fatal("NEXARCH_RECONCILE_TENANT_DSN und NEXARCH_RECONCILE_STORAGE_DIR muessen gesetzt sein")
|
||||
}
|
||||
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
log.Fatalf("datenbankverbindung: %v", err)
|
||||
}
|
||||
defer pool.Close()
|
||||
|
||||
dbEntries, err := reconcile.ListDBStorageKeys(ctx, pool)
|
||||
if err != nil {
|
||||
log.Fatalf("datenbank-eintraege lesen: %v", err)
|
||||
}
|
||||
storageKeys, err := reconcile.ListStorageObjects(storageDir)
|
||||
if err != nil {
|
||||
log.Fatalf("objekt-storage durchlaufen: %v", err)
|
||||
}
|
||||
|
||||
report := reconcile.Reconcile(dbEntries, storageKeys)
|
||||
|
||||
encoder := json.NewEncoder(os.Stdout)
|
||||
encoder.SetIndent("", " ")
|
||||
if err := encoder.Encode(report); err != nil {
|
||||
log.Fatalf("bericht ausgeben: %v", err)
|
||||
}
|
||||
|
||||
// Nicht-null-Exit-Code bei Abweichungen (Akzeptanzkriterium 3:
|
||||
// Abweichungen werden BERICHTET, nicht automatisch behoben — der
|
||||
// Exit-Code macht das fuer systemd/Monitoring sichtbar, OHNE selbst
|
||||
// irgendetwas zu reparieren).
|
||||
if !report.IsClean() {
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,144 @@
|
||||
// scrub-cli ist der Aufrufpunkt fuer BAK-08 (systemd-Timer, konfigurierbare
|
||||
// Kadenz) — zieht eine Stichprobe existierender Objekte (BAK-05 als
|
||||
// Existenz-Quelle), prueft deren Inhalt per SHA-256 gegen
|
||||
// file_revisions.checksum_sha256, meldet Abweichungen (kein Auto-Repair)
|
||||
// und schreibt den Befund-Zaehler fuer den OPS-05/OPS-03-Metrik-Export.
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"log"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/scrub"
|
||||
)
|
||||
|
||||
type finding struct {
|
||||
StorageKey string `json:"storage_key"`
|
||||
DocumentID string `json:"document_id"`
|
||||
RevisionID string `json:"revision_id"`
|
||||
Expected string `json:"expected_checksum"`
|
||||
Actual string `json:"actual_checksum,omitempty"`
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
type report struct {
|
||||
GeneratedAt time.Time `json:"generated_at"`
|
||||
Sampled int `json:"sampled"`
|
||||
Findings []finding `json:"findings"`
|
||||
}
|
||||
|
||||
func main() {
|
||||
dsn := os.Getenv("NEXARCH_SCRUB_TENANT_DSN")
|
||||
storageDir := os.Getenv("NEXARCH_SCRUB_STORAGE_DIR")
|
||||
if dsn == "" || storageDir == "" {
|
||||
log.Fatal("NEXARCH_SCRUB_TENANT_DSN und NEXARCH_SCRUB_STORAGE_DIR muessen gesetzt sein")
|
||||
}
|
||||
sampleSize := envInt("NEXARCH_SCRUB_SAMPLE_SIZE", 10)
|
||||
cooldown := envDuration("NEXARCH_SCRUB_COOLDOWN", 24*time.Hour)
|
||||
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
log.Fatalf("datenbankverbindung: %v", err)
|
||||
}
|
||||
defer pool.Close()
|
||||
|
||||
dbEntries, err := reconcile.ListDBStorageKeys(ctx, pool)
|
||||
if err != nil {
|
||||
log.Fatalf("datenbank-eintraege lesen: %v", err)
|
||||
}
|
||||
storageKeys, err := reconcile.ListStorageObjects(storageDir)
|
||||
if err != nil {
|
||||
log.Fatalf("objekt-storage durchlaufen: %v", err)
|
||||
}
|
||||
rec := reconcile.Reconcile(dbEntries, storageKeys)
|
||||
|
||||
lastScrubbed, err := scrub.LoadLastScrubbed(ctx, pool)
|
||||
if err != nil {
|
||||
log.Fatalf("scrub-zustand lesen: %v", err)
|
||||
}
|
||||
|
||||
now := time.Now().UTC()
|
||||
candidates := scrub.Sample(rec.ExistingInStorage, lastScrubbed, cooldown, sampleSize, now)
|
||||
|
||||
keys := make([]string, 0, len(candidates))
|
||||
for _, c := range candidates {
|
||||
keys = append(keys, c.StorageKey)
|
||||
}
|
||||
expected, err := scrub.ExpectedChecksums(ctx, pool, keys)
|
||||
if err != nil {
|
||||
log.Fatalf("erwartete pruefsummen lesen: %v", err)
|
||||
}
|
||||
|
||||
rep := report{GeneratedAt: now, Sampled: len(candidates)}
|
||||
for _, c := range candidates {
|
||||
exp, known := expected[c.StorageKey]
|
||||
if !known {
|
||||
// Objekt in DB nicht (mehr) auffindbar - das ist BAK-05s
|
||||
// Zustaendigkeit (existiert der Datenbankeintrag?), nicht
|
||||
// dieses Jobs; ueberspringen ohne Markierung.
|
||||
continue
|
||||
}
|
||||
actual, readErr := scrub.ActualChecksum(storageDir, c.StorageKey)
|
||||
ok := readErr == nil && actual == exp
|
||||
if err := scrub.MarkScrubbed(ctx, pool, c.StorageKey, ok, now); err != nil {
|
||||
log.Fatalf("scrub-zustand schreiben: %v", err)
|
||||
}
|
||||
if !ok {
|
||||
f := finding{StorageKey: c.StorageKey, DocumentID: c.DocumentID, RevisionID: c.RevisionID, Expected: exp, Actual: actual}
|
||||
if readErr != nil {
|
||||
f.Error = readErr.Error()
|
||||
}
|
||||
rep.Findings = append(rep.Findings, f)
|
||||
if err := scrub.RecordFinding(ctx, pool); err != nil {
|
||||
log.Fatalf("befund-zaehler erhoehen: %v", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
encoder := json.NewEncoder(os.Stdout)
|
||||
encoder.SetIndent("", " ")
|
||||
if err := encoder.Encode(rep); err != nil {
|
||||
log.Fatalf("bericht ausgeben: %v", err)
|
||||
}
|
||||
|
||||
// Befund wird gemeldet, nicht automatisch repariert (Akzeptanzkriterium
|
||||
// 3) - der Exit-Code macht das fuer systemd/Monitoring sichtbar, ohne
|
||||
// selbst etwas zu reparieren; die tatsaechliche Meldung an OPS-05
|
||||
// laeuft ueber den separaten /metrics-Export (cmd/scrub-metrics), nicht
|
||||
// ueber diesen Exit-Code.
|
||||
if len(rep.Findings) > 0 {
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
func envInt(name string, def int) int {
|
||||
v := os.Getenv(name)
|
||||
if v == "" {
|
||||
return def
|
||||
}
|
||||
n, err := strconv.Atoi(v)
|
||||
if err != nil {
|
||||
log.Fatalf("%s: ungueltiger wert %q: %v", name, v, err)
|
||||
}
|
||||
return n
|
||||
}
|
||||
|
||||
func envDuration(name string, def time.Duration) time.Duration {
|
||||
v := os.Getenv(name)
|
||||
if v == "" {
|
||||
return def
|
||||
}
|
||||
d, err := time.ParseDuration(v)
|
||||
if err != nil {
|
||||
log.Fatalf("%s: ungueltiger wert %q: %v", name, v, err)
|
||||
}
|
||||
return d
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
// scrub-metrics stellt BAK-08s Befund-Zaehler unter /metrics bereit — die
|
||||
// OPS-05-Anbindung ist Pull-basiert (Core OPS-03 scrapt /metrics-URLs, kein
|
||||
// Push-Mechanismus), daher braucht es einen eigenen, dauerhaft laufenden
|
||||
// HTTP-Endpunkt getrennt vom Oneshot-scrub-cli (dessen Prozess nach jedem
|
||||
// Lauf beendet ist und daher zum Scrape-Zeitpunkt nicht erreichbar waere).
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/scrub"
|
||||
)
|
||||
|
||||
func main() {
|
||||
dsn := os.Getenv("NEXARCH_SCRUB_TENANT_DSN")
|
||||
if dsn == "" {
|
||||
log.Fatal("NEXARCH_SCRUB_TENANT_DSN muss gesetzt sein")
|
||||
}
|
||||
addr := os.Getenv("NEXARCH_SCRUB_METRICS_LISTEN_ADDR")
|
||||
if addr == "" {
|
||||
addr = ":8090"
|
||||
}
|
||||
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
log.Fatalf("datenbankverbindung: %v", err)
|
||||
}
|
||||
defer pool.Close()
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/metrics", func(w http.ResponseWriter, r *http.Request) {
|
||||
total, err := scrub.FindingsTotal(r.Context(), pool)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "text/plain; version=0.0.4")
|
||||
// Counter (Akzeptanzkriterium/Nutzervorgabe: monoton steigend, kein
|
||||
// Gauge) - kein Befund => Wert 0, kein Dauer-Alarm ("kein Befund
|
||||
// bedeutet kein Alarm", nicht "kein Wert").
|
||||
body := fmt.Sprintf(
|
||||
"# HELP nexarch_archive_storage_integrity_failures_total Anzahl seit Einrichtung gefundener Pruefsummen-Abweichungen (BAK-08).\n"+
|
||||
"# TYPE nexarch_archive_storage_integrity_failures_total counter\n"+
|
||||
"nexarch_archive_storage_integrity_failures_total %d\n", total)
|
||||
if _, err := w.Write([]byte(body)); err != nil {
|
||||
log.Printf("scrub-metrics: antwort schreiben: %v", err)
|
||||
}
|
||||
})
|
||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||
|
||||
log.Printf("scrub-metrics: listening on %s", addr)
|
||||
if err := http.ListenAndServe(addr, mux); err != nil {
|
||||
log.Fatalf("http server: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
# 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.
|
||||
@@ -0,0 +1,93 @@
|
||||
# BAK-02 – Prüfprotokoll: Objekt-Storage-Backup/Snapshots
|
||||
|
||||
Welle 1, keine Vorbedingungen.
|
||||
|
||||
## Grundsatzentscheidung: restic statt Eigenbau
|
||||
|
||||
Nutzerentscheidung: restic statt einer Neuimplementierung, weil restic alle
|
||||
vier Akzeptanzkriterien mit ausgereiftem, breit geprüftem Tooling erfüllt
|
||||
(Content-defined Chunking für Dedup, `check --read-data` für
|
||||
Vollständigkeit, `forget --keep-last` für Rotation, Repository-Verschlüsselung
|
||||
ab Werk). Installiert via `apt-get install restic` (Version 0.18.0).
|
||||
|
||||
Backup-Quelle ist ein lokaler Verzeichnisbaum — für den FDN-03-`LocalDriver`
|
||||
direkt dessen Basisverzeichnis. Für S3-gestützte Produktions-Deployments
|
||||
(Betriebsmodus 2/3 aus `STORAGE-KONZEPT.md` Abschnitt 6.2) wäre ein
|
||||
vorgelagerter Sync-Schritt (z. B. `rclone`) nötig, um Bucket-Inhalte lokal
|
||||
zu spiegeln, bevor restic sie sichert — restic sichert Dateibäume, keine
|
||||
S3-Buckets direkt. Das bleibt hier bewusst unimplementiert (kein konkreter
|
||||
S3-Produktionsbestand vorhanden, der das aktuell erfordert), aber
|
||||
architektonisch vorgesehen und dokumentiert (`README.md`).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `internal/objectbackup.InitRepo` — idempotent, erkennt "bereits
|
||||
initialisiert" am `restic init`-Fehlertext statt zu scheitern.
|
||||
- `internal/objectbackup.Backup` — `restic backup --json`, parst die
|
||||
`summary`-Zeile (mehrere JSON-Zeilen in der Ausgabe, gezielt die mit
|
||||
`message_type=="summary"` gesucht).
|
||||
- `internal/objectbackup.Check` — `restic check [--read-data]` (Akzeptanz-
|
||||
kriterium 3: Vollständigkeitsprüfung).
|
||||
- `internal/objectbackup.Forget` — `restic forget --keep-last N --prune`
|
||||
(Rotation).
|
||||
- `cmd/objectbackup-cli` — `backup <dir>`/`check`/`rotate`, aufgerufen von
|
||||
systemd-Timern (stündlich/wöchentlich/täglich).
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Zweiter Sicherungslauf nach unverändertem Bestand überträgt keine Daten erneut | **bestanden** — `TestBackup_UnchangedSecondRunTransmitsNothingNew`: zweiter Lauf gegen unveränderten Bestand liefert `files_new=0`, `files_changed=0`, `files_unmodified=1` |
|
||||
| 2 | Zwei identische Testdateien belegen nachweislich nur einmal Speicherplatz | **bestanden** — `TestBackup_DeduplicatesIdenticalContent`: zwei Dateien mit identischem Inhalt erzeugen `data_blobs=1`, nicht 2 — echter Dedup-Nachweis über restics Content-defined Chunking, nicht nur Namensvergleich |
|
||||
| 3 | Vollständigkeitsprüfung erkennt ein fehlendes Objekt in der Sicherung | **bestanden** — `TestCheck_DetectsCorruptedPack`: ein Byte in einer echten Repository-Pack-Datei gekippt, `Check(readData=true)` schlägt danach fehl (unbeschädigt zuvor erfolgreich) — dieselbe Vorgehensweise wie die manuelle Recherche vor der Implementierung |
|
||||
|
||||
Zusätzlich (nicht explizit als Pflichtprüfung gefordert, aber Teil von
|
||||
Akzeptanzkriterium 3 „lässt sich einzeln prüfen"): `TestForget_
|
||||
KeepsOnlyRequestedSnapshotCount` — 3 Sicherungsläufe, `Forget(keepLast=1)`
|
||||
reduziert auf genau 1 verbleibenden Snapshot.
|
||||
|
||||
## Korrektur an BAK-01 im selben Rutsch: Backup-Zielverzeichnis
|
||||
|
||||
Nutzerhinweis aufgegriffen: `NEXARCH_BACKUP_DIR` zeigte bei BAK-01
|
||||
ursprünglich auf `/var/backups/nexarch` (Root-Dateisystem des LXC-
|
||||
Containers, nicht auf einem der beiden dedizierten ZFS-Datasets). Korrigiert
|
||||
auf `/var/nexarch-archiv/backups/postgres` (persistentes Dataset
|
||||
`zfs/data/subvol-1131-disk-0`), NICHT `/var/nexarch-test/` (ephemeres
|
||||
Dataset `ssd-rpool-data/swap/subvol-1131-disk-0`, wird von
|
||||
`reset-test-env.sh`-Skripten anderer Module geleert). `objectbackup-cli`s
|
||||
Repository liegt von Anfang an korrekt unter
|
||||
`/var/nexarch-archiv/backups/objects`. Beide Pfade real auf
|
||||
192.168.1.131 verifiziert (`df`/`mount` bestätigt ZFS-Dataset-Zuordnung),
|
||||
BAK-01s Vollsicherung nach der Korrektur erneut über systemd ausgelöst und
|
||||
bestätigt am neuen Ort gelandet.
|
||||
|
||||
ZFS-seitige Snapshot-/Replikations-Strategie für `nexarch/archiv` bleibt
|
||||
bewusst außerhalb dieses Tickets (Infra-Runbook, siehe
|
||||
`STORAGE-KONZEPT.md` Abschnitt 7 „Backup vs. Storage-Redundanz" sowie den
|
||||
Hinweis, `zfs dedup=on` NICHT zu setzen — App-seitige Dedup über restic
|
||||
genügt, ZFS-Dedup wäre auf dem 4-GB-Testhost ein Speicherrisiko).
|
||||
|
||||
## Echte Verdrahtung auf 192.168.1.131
|
||||
|
||||
- `objectbackup-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||
- `/etc/nexarch/archive-objectbackup.env` (0600)
|
||||
- 3 systemd-Timer installiert und aktiviert: Sicherung stündlich (`:30`),
|
||||
Vollständigkeitsprüfung wöchentlich (So. 04:00 UTC), Rotation täglich
|
||||
(03:30 UTC) — `systemctl list-timers` bestätigt alle scharf
|
||||
- Jeder der drei Dienste einmal über `systemctl start` ausgelöst, alle mit
|
||||
`status=0/SUCCESS`; Journal bestätigt inhaltlich korrekte Ausgabe
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -count=1 -> 2/2 Pakete mit Tests ok (internal/backup, internal/objectbackup), 0 Fehlschläge
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real gegen echtes restic-Tooling erfüllt. BAK-01-Pfadfehler im selben
|
||||
Rutsch korrigiert und erneut end-to-end verifiziert.
|
||||
@@ -0,0 +1,119 @@
|
||||
# BAK-05 – Prüfprotokoll: Reconciliation / Konsistenzprüfung Storage vs. DB
|
||||
|
||||
Voraussetzung BAK-01, BAK-02 (Welle 1) – erledigt, siehe eigene Protokolle.
|
||||
|
||||
## Grundsatzentscheidung: reine Funktion + zwei Quell-Adapter
|
||||
|
||||
`internal/reconcile.Reconcile` ist eine reine Funktion ohne DB-/Storage-
|
||||
Zugriff (leicht ohne echte Infrastruktur testbar), die Ein- und
|
||||
Auslesen echter Systeme ist strikt in `sources.go` getrennt
|
||||
(`ListDBStorageKeys` gegen echtes Postgres, `ListStorageObjects` gegen
|
||||
echtes Dateisystem). Beide Seiten liefern nur SCHLÜSSEL – niemals Inhalt
|
||||
– dadurch bleibt BAK-05 sauber getrennt von BAK-08 (Inhalts-/Prüfsummen-
|
||||
verifikation, eigene Fehlerklasse, eigenes Ticket).
|
||||
|
||||
Report-Format bewusst deterministisch: alle drei Ergebnislisten
|
||||
(`missing_in_storage`, `orphaned_in_storage`, `existing_in_storage`)
|
||||
nach `storage_key` aufsteigend sortiert.
|
||||
|
||||
**Nachtrag (nach Rückfrage vor BAK-08-Start):** Der ursprüngliche Report
|
||||
enthielt nur die beiden Abweichungslisten – keine Liste der bestätigt
|
||||
existierenden Objekte. Für BAK-08 als Stichprobengrundlage reicht
|
||||
"keine Abweichung" nicht, es braucht die tatsächliche, deterministisch
|
||||
sortierte Liste. Ergänzt: `Report.ExistingInStorage` – DB-Eintrag UND
|
||||
Storage-Objekt beide vorhanden, reine Existenzbestätigung (keine
|
||||
Inhaltsprüfung, Scope-Trennung zu BAK-08 bleibt gewahrt), aufsteigend
|
||||
nach `storage_key` sortiert. BAK-08 zieht seine Stichprobe daraus, ohne
|
||||
selbst zu sortieren/filtern. Neuer Test
|
||||
`TestReconcile_ExistingInStorageIsStableSamplingBasis` beweist Inhalt
|
||||
und Sortierung. Real neu gebaut, getestet (9/9) und auf 131 erneut
|
||||
ausgelöst – Journal zeigt das Feld `existing_in_storage` im Report.
|
||||
|
||||
Meldeweg über OPS-05 (wie später BAK-08) wurde als offene Design-Frage
|
||||
aufgeworfen, aber nicht zur Vorbedingung gemacht – hier bewusst noch
|
||||
nicht umgesetzt (kein OPS-05-Abhängigkeitseintrag im Board für BAK-05);
|
||||
Report wird aktuell nur als JSON auf stdout ausgegeben und per
|
||||
Exit-Code (1 bei Abweichungen) für systemd/Monitoring sichtbar gemacht.
|
||||
Anbindung an OPS-05 kann bei Bedarf nachgezogen werden, ohne
|
||||
`Reconcile` selbst zu ändern.
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `internal/reconcile.Reconcile(dbEntries, storageKeys) Report` – reine
|
||||
Vergleichsfunktion, liefert `MissingInStorage`/`OrphanedInStorage`,
|
||||
`Report.IsClean()` als eindeutiges Sauber-Merkmal.
|
||||
- `internal/reconcile.ListDBStorageKeys` – liest `file_revisions`
|
||||
(DMS FDN-02) per direktem SQL aus derselben physischen Tenant-DB
|
||||
(Modell C, Core TEN-01) – kein Import von DMS-Go-Paketen möglich
|
||||
(eigenes Go-Modul), daher reiner SQL-Zugriff gegen das dokumentierte
|
||||
Schema.
|
||||
- `internal/reconcile.ListStorageObjects` – durchläuft den lokalen
|
||||
FDN-03-`LocalDriver`-Basisordner (`filepath.WalkDir`), liefert `nil,
|
||||
nil` bei fehlendem Verzeichnis statt Fehler (noch keine Objekte ist
|
||||
kein Fehlerzustand).
|
||||
- `cmd/reconcile-cli` – liest `NEXARCH_RECONCILE_TENANT_DSN` und
|
||||
`NEXARCH_RECONCILE_STORAGE_DIR`, gibt Report als JSON auf stdout aus,
|
||||
Exit-Code 1 bei Abweichungen.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Datenbankeintrag ohne Storage-Objekt wird erkannt | **bestanden** — `TestReconcile_DetectsMissingInStorage` |
|
||||
| 2 | Storage-Objekt ohne Datenbankeintrag wird erkannt | **bestanden** — `TestReconcile_DetectsOrphanedInStorage` |
|
||||
| 3 | Lauf ohne Abweichungen liefert leeren, eindeutig sauberen Bericht | **bestanden** — `TestReconcile_CleanRunProducesEmptyReport` (zusätzlich `IsClean()`-Konsistenzprüfung) |
|
||||
|
||||
Zusätzlich (Nutzervorgaben, nicht explizit im Ticket als Pflichtprüfung
|
||||
benannt, aber zentral für die Abgrenzung/Weiterverwendbarkeit):
|
||||
|
||||
- `TestReconcile_ExistingButCorruptedObjectProducesNoFinding` – Nachweis,
|
||||
dass Reconcile AUSSCHLIESSLICH Existenz prüft, niemals Inhalt (Trennung
|
||||
von BAK-08).
|
||||
- `TestReconcile_DeterministicOrdering` – zwei Läufe mit identischer
|
||||
Eingabe liefern identische Reihenfolge, aufsteigend nach `storage_key`.
|
||||
- `TestListDBStorageKeys_ReadsRealFileRevisions` – liest echt gegen die
|
||||
gemeinsame Tenant-Testdatenbank `dms_tenant_test` (reales DMS-FDN-02-
|
||||
Schema, kein Mock).
|
||||
- `TestListStorageObjects_WalksRealDirectory` /
|
||||
`_MissingDirectoryReturnsEmpty` – echtes Dateisystem, kein Mock.
|
||||
|
||||
## Echte Verdrahtung auf 192.168.1.131
|
||||
|
||||
- `reconcile-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||
- `/etc/nexarch/archive-reconcile.env` (0600): `NEXARCH_RECONCILE_TENANT_DSN`
|
||||
zeigt auf die gemeinsame Tenant-Testdatenbank `dms_tenant_test`
|
||||
(DMS selbst läuft auf 192.168.1.131 noch nicht als eigener systemd-
|
||||
Dienst mit persistenter Konfiguration – dies ist die real verfügbare
|
||||
Tenant-DB mit echtem FDN-02-Schema, dokumentierter bekannter Stand,
|
||||
kein stiller Mock); `NEXARCH_RECONCILE_STORAGE_DIR` zeigt auf
|
||||
`/var/nexarch-archiv/dms-objects` (persistentes ZFS-Dataset, NICHT
|
||||
`/var/nexarch-test/`).
|
||||
- Timer `nexarch-archive-reconcile.timer` installiert und aktiviert
|
||||
(täglich 05:00 UTC), `systemctl list-timers` bestätigt scharf.
|
||||
- `systemctl start nexarch-archive-reconcile.service` real ausgelöst:
|
||||
`status=0/SUCCESS`, Journal zeigt echten JSON-Report
|
||||
(`missing_in_storage: null, orphaned_in_storage: null` – Tenant-DB
|
||||
aktuell leer, daher sauberer Bericht, keine synthetische Ausgabe).
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -count=1 -> 3/3 Pakete mit Tests ok (internal/backup, internal/objectbackup, internal/reconcile), 0 Fehlschläge
|
||||
```
|
||||
|
||||
`internal/reconcile`-Tests separat mit gesetzter `TEST_TENANT_DSN` gegen
|
||||
`dms_tenant_test` verifiziert: 9/9 Tests bestanden (6 reine
|
||||
`Reconcile`-Tests + 3 `sources.go`-Integrationstests).
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle Pflicht- sowie
|
||||
Nutzervorgaben-Prüfungen real erfüllt (echte Postgres-Instanz, echtes
|
||||
Dateisystem, echter systemd-Lauf). Zwei Testfehler während der
|
||||
Entwicklung (Schema-Abweichung `revision_number` NOT NULL in der realen
|
||||
`dms_tenant_test`-Tabelle; inkonsistente Fixture-Daten in
|
||||
`TestReconcile_DeterministicOrdering`) gefunden und korrigiert – beide
|
||||
waren Testautorenfehler, keine Fehler in `Reconcile` selbst.
|
||||
@@ -0,0 +1,140 @@
|
||||
# BAK-08 – Prüfprotokoll: Checksum-basierte Objekt-Integritätsprüfung
|
||||
|
||||
Voraussetzungen BAK-05, FDN-04, FDN-09, OPS-05 – alle erledigt, siehe
|
||||
eigene Protokolle. Vor Start zwei offene Rückfragen geklärt (siehe unten).
|
||||
|
||||
## Grundsatzentscheidung: eigener Zustand statt file_revisions.created_at
|
||||
|
||||
`created_at` als Alterskriterium hätte immer dieselben "ältesten" Objekte
|
||||
gescrubbt und den Rest nie erreicht — kein echtes Rotationsverhalten.
|
||||
Stattdessen eigene Archive-Tabelle `scrub_state` (`storage_key` →
|
||||
`last_scrubbed_at`, `last_result`), Migration
|
||||
`migrations/0001_scrub_state.up.sql`. `internal/scrub.Sample` ist eine
|
||||
reine Funktion: nimmt BAK-05s `existing_in_storage` (deterministisch
|
||||
sortiert) entgegen, filtert Objekte innerhalb der konfigurierbaren
|
||||
Cooldown-Frist heraus, priorisiert danach nach `last_scrubbed_at`
|
||||
aufsteigend (nie geprüft = ältestmöglicher Wert), begrenzt auf die
|
||||
konfigurierte Stichprobengröße — kein Voll-Sort über den gesamten
|
||||
Bestand bei jedem Lauf (Nutzerhinweis zum Kostenfaktor bei 10⁵+
|
||||
Objekten: die WHERE-artige Cooldown-Filterung reduziert die Kandidatenmenge
|
||||
VOR der Sortierung, nur die Kandidaten selbst werden sortiert, nicht der
|
||||
komplette Bestand).
|
||||
|
||||
## Nachtrag: zwei Rückfragen vor Implementierungsbeginn geklärt
|
||||
|
||||
1. **OPS-05-Anbindung ist Pull, nicht Push.** OPS-05 (`internal/alerting`,
|
||||
Core) ist real implementiert, aber Core OPS-03 scrapt `/metrics`-URLs
|
||||
registrierter Module (`metrics_sources`-Tabelle in der Core-Registry-
|
||||
DB, `SourceStore.RegisterSource`) — kein Push-API. Für BAK-08 daher
|
||||
ein eigener, DAUERHAFT laufender Endpunkt (`cmd/scrub-metrics`,
|
||||
getrennt vom Oneshot-`scrub-cli`, dessen Prozess nach jedem Lauf endet
|
||||
und zum Scrape-Zeitpunkt nicht erreichbar wäre). Metrik als Counter
|
||||
(`nexarch_archive_storage_integrity_failures_total`), monoton
|
||||
steigend — kein Gauge, kein Rücksetzen bei behobenem Befund. Kein
|
||||
Befund = Wert bleibt unverändert (kein Dauer-Alarm durch andauernden
|
||||
"Fehler"-Zustand). Scope-Trennung gewahrt: `scrub-cli`/`scrub-metrics`
|
||||
erzeugen selbst KEIN Alert-Objekt — Schwellwert/Drosselung bleiben
|
||||
OPS-05-eigene Konfiguration (Alert-Regel wird separat über
|
||||
`alerting.RuleStore.CreateRule` angelegt, nicht Teil dieses Tickets).
|
||||
**CFG-04 war eine Verwechslung** (das ist die
|
||||
Benachrichtigungs-Einstellungen-Oberfläche, ein anderes Ticket) — die
|
||||
tatsächlich nötige "Config"-Aktion ist ein `INSERT` in
|
||||
`metrics_sources` (Core-Registry-DB), kein UI/Ticket-Abhängigkeit.
|
||||
Real ausgeführt (siehe „Echte Verdrahtung" unten).
|
||||
2. **Sampling-Kriterium.** Siehe Grundsatzentscheidung oben —
|
||||
`scrub_state.last_scrubbed_at` statt `file_revisions.created_at`,
|
||||
Cooldown-Filterung vor Sortierung, feste Stichprobengröße (Top-N,
|
||||
deterministisch, keine Zufallsstichprobe — Nutzerpräferenz für
|
||||
Reproduzierbarkeit im Protokoll).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `migrations/0001_scrub_state.up.sql`/`.down.sql` — `scrub_state`,
|
||||
`scrub_counters` (Einzelzeile, monotoner Zähler).
|
||||
- `internal/scrub.Sample` — reine Funktion, Cooldown-Filter + Alt-
|
||||
Priorisierung + Stichprobenbegrenzung.
|
||||
- `internal/scrub.LoadLastScrubbed`/`MarkScrubbed`/`RecordFinding`/
|
||||
`FindingsTotal` — DB-Zugriff auf `scrub_state`/`scrub_counters`,
|
||||
`MarkScrubbed` idempotent (`ON CONFLICT`) für unterbrechbare Läufe.
|
||||
- `internal/scrub.ExpectedChecksums` — eigene, minimale Abfrage gegen
|
||||
`file_revisions` (keine Erweiterung von `reconcile.DBEntry` — BAK-05
|
||||
bleibt existenz-only).
|
||||
- `internal/scrub.ActualChecksum` — echtes Lesen der Datei + SHA-256,
|
||||
kein Header-/Größenvergleich.
|
||||
- `cmd/scrub-cli` — Oneshot: BAK-05-Reconcile → `Sample` → pro Kandidat
|
||||
Checksum-Vergleich → `MarkScrubbed` + bei Abweichung `RecordFinding` →
|
||||
JSON-Bericht auf stdout, Exit-Code 1 bei Befunden (gemeldet, nicht
|
||||
automatisch repariert).
|
||||
- `cmd/scrub-metrics` — dauerhafter `/metrics`-Endpunkt, liest
|
||||
`scrub_counters.findings_total`.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Absichtlich veränderter Objektinhalt wird als Abweichung erkannt | **bestanden** — real: Testobjekt mit absichtlich falscher `checksum_sha256` in `dms_tenant_test` angelegt, echte Datei ins Storage-Verzeichnis gelegt, `scrub-cli` real über systemd ausgelöst: Befund im JSON-Bericht, Exit-Code 1, `scrub_counters.findings_total` real von 0 auf 1 erhöht (siehe Journal-Auszug unten) |
|
||||
| 2 | Sampling priorisiert alte/nie geprüfte Objekte, nicht neue | **bestanden** — `TestSample_PrioritizesNeverScrubbedAndOldest`: nie geprüftes Objekt kommt vor einem vor 30 Tagen geprüften, dieses vor einem vor 1 Tag geprüften |
|
||||
| 3 | Wiederholter Lauf ohne neue Objekte meldet nichts erneut (kein Spam) / idempotent bei Unterbrechung | **bestanden** — real: zweiter `scrub-cli`-Lauf direkt nach dem ersten liefert `sampled: 0` (Cooldown greift), `TestMarkScrubbed_IsIdempotent` beweist wiederholtes Markieren ohne Duplikat |
|
||||
|
||||
Zusätzlich: `TestSample_RespectsCooldown`,
|
||||
`TestSample_LimitsToSampleSize`, `TestSample_DeterministicForIdenticalInput`,
|
||||
`TestRecordFinding_IsMonotonicallyIncreasing`,
|
||||
`TestActualChecksum_MatchesRealFileContent` (echter Dateiinhalt, echtes
|
||||
SHA-256), `TestExpectedChecksums_ReadsRealFileRevisions` (echtes
|
||||
Postgres, kein Mock).
|
||||
|
||||
## Echte Verdrahtung auf 192.168.1.131
|
||||
|
||||
- `scrub-cli`, `scrub-metrics` gebaut nach `/opt/nexarch-archive/bin/`
|
||||
- `/etc/nexarch/archive-scrub.env`, `/etc/nexarch/archive-scrub-metrics.env`
|
||||
(0600)
|
||||
- Migration real gegen `dms_tenant_test` angewendet
|
||||
(`psql -f migrations/0001_scrub_state.up.sql`)
|
||||
- `nexarch-archive-scrub.timer` installiert/aktiviert (täglich 06:00
|
||||
UTC), `nexarch-archive-scrub-metrics.service` installiert/aktiviert
|
||||
(dauerhaft, `Restart=on-failure`) — beide `systemctl status`: aktiv
|
||||
- **Reales `INSERT` in `metrics_sources`** (Core-Registry-DB
|
||||
`nexarch_registry`): `('archive', 'http://127.0.0.1:8090/metrics')` —
|
||||
bestätigt über `SELECT * FROM metrics_sources`
|
||||
- **End-to-End über OPS-03 bestätigt**: `curl http://127.0.0.1:8085/metrics`
|
||||
(Core-Aggregator) zeigt `nexarch_module_archive_nexarch_archive_storage_integrity_failures_total`
|
||||
— reale Umbenennung gemäß OPS-03-Namenskonvention, kein synthetischer
|
||||
Wert
|
||||
- Realer Befund-Durchlauf: Testobjekt mit absichtlich falscher Prüfsumme
|
||||
angelegt → `scrub-cli` real via `systemctl start` ausgelöst → Befund im
|
||||
Journal, `scrub_counters.findings_total` real 0→1, sichtbar sowohl auf
|
||||
`scrub-metrics` als auch über den Core-Aggregator → Testdaten
|
||||
anschließend bereinigt (`file_revisions`/`documents`/`users`-Zeilen
|
||||
gelöscht, `scrub_state`/`scrub_counters` zurückgesetzt, Testdatei
|
||||
entfernt)
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./... -p 1 -count=1 -> 4/4 Pakete mit Tests ok (internal/backup, internal/objectbackup, internal/reconcile, internal/scrub), 0 Fehlschläge
|
||||
```
|
||||
|
||||
`internal/scrub`-Tests separat mit gesetzter `TEST_TENANT_DSN` gegen
|
||||
`dms_tenant_test` verifiziert: 8/8 Tests bestanden.
|
||||
|
||||
## Bekannte Grenze (aus Ticket übernommen, nicht Teil der Abnahme)
|
||||
|
||||
Der Job erkennt Abweichungen nur bei Objekten, die gelesen und erneut
|
||||
geprüft werden können. Ersetzt keine storage-seitige WORM-/
|
||||
Versionierungsstrategie und keine Zugriffs-/Audit-Logs des
|
||||
Storage-Providers (`STORAGE-KONZEPT.md` Abschnitt 6.1) — bei extern
|
||||
eingebundenem, nicht-kompatiblem Kunden-Storage (Betriebsmodus 3, ohne
|
||||
Versioning/Object Lock/Audit-Logs) bleibt eine Lücke, die BAK-08
|
||||
technisch nicht schließen kann.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle sechs Akzeptanzkriterien und alle drei Pflicht-
|
||||
prüfungen real erfüllt — inklusive echtem Ende-zu-Ende-Nachweis über
|
||||
Core OPS-03/OPS-05 (kein Stub, reale `/metrics`-Registrierung und
|
||||
-Aggregation). Beide vor Implementierungsbeginn gestellten Rückfragen
|
||||
(OPS-05-Anbindungsmechanismus, Sampling-Kriterium) im Protokoll
|
||||
dokumentiert und in der Umsetzung berücksichtigt.
|
||||
@@ -0,0 +1,14 @@
|
||||
module gitea.perlbach24.de/scripte/nexarch/archive
|
||||
|
||||
go 1.22
|
||||
|
||||
require github.com/jackc/pgx/v5 v5.6.0
|
||||
|
||||
require (
|
||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
||||
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
||||
golang.org/x/crypto v0.17.0 // indirect
|
||||
golang.org/x/sync v0.1.0 // indirect
|
||||
golang.org/x/text v0.14.0 // indirect
|
||||
)
|
||||
@@ -0,0 +1,28 @@
|
||||
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,102 @@
|
||||
// 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"
|
||||
"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
|
||||
}
|
||||
|
||||
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"
|
||||
)
|
||||
|
||||
// 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
|
||||
}
|
||||
|
||||
func runPgBaseBackup(ctx context.Context, cfg Config, args []string) error {
|
||||
cmd := exec.CommandContext(ctx, cfg.binary(), args...)
|
||||
cmd.Env = append(os.Environ(), "PGPASSWORD="+cfg.Password)
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("%s fehlgeschlagen: %w (ausgabe: %s)", cfg.binary(), err, string(output))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,187 @@
|
||||
package backup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func requireTestConfig(t *testing.T) Config {
|
||||
t.Helper()
|
||||
user := os.Getenv("TEST_BACKUP_PG_USER")
|
||||
if user == "" {
|
||||
t.Skip("TEST_BACKUP_PG_USER nicht gesetzt, Integrationstest uebersprungen (braucht echten Postgres mit REPLICATION-Rolle)")
|
||||
}
|
||||
return Config{
|
||||
Host: envOr("TEST_BACKUP_PG_HOST", "localhost"),
|
||||
Port: envOr("TEST_BACKUP_PG_PORT", "5432"),
|
||||
User: user,
|
||||
Password: os.Getenv("TEST_BACKUP_PG_PASSWORD"),
|
||||
BackupDir: t.TempDir(),
|
||||
}
|
||||
}
|
||||
|
||||
func envOr(key, fallback string) string {
|
||||
if v := os.Getenv(key); v != "" {
|
||||
return v
|
||||
}
|
||||
return fallback
|
||||
}
|
||||
|
||||
// TestFullBackup_CreatesVerifiedBackup ist Pruefung 1: Sicherung gegen
|
||||
// Testdatenbank erfolgreich erstellt und verifiziert.
|
||||
func TestFullBackup_CreatesVerifiedBackup(t *testing.T) {
|
||||
cfg := requireTestConfig(t)
|
||||
ctx := context.Background()
|
||||
|
||||
genID := NewGenerationID(time.Now())
|
||||
manifest, err := FullBackup(ctx, cfg, genID)
|
||||
if err != nil {
|
||||
t.Fatalf("fullbackup: %v", err)
|
||||
}
|
||||
if _, err := os.Stat(manifest); err != nil {
|
||||
t.Fatalf("backup_manifest fehlt: %v", err)
|
||||
}
|
||||
|
||||
dir := filepath.Dir(manifest)
|
||||
if _, err := os.Stat(filepath.Join(dir, BaseTarGzFile)); err != nil {
|
||||
t.Fatalf("%s fehlt: %v", BaseTarGzFile, err)
|
||||
}
|
||||
|
||||
if err := Verify(dir); err != nil {
|
||||
t.Fatalf("verify: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIncrementalBackup_IsSmallerThanFull ist der Nachweis fuer
|
||||
// Akzeptanzkriterium 1 (inkrementell): eine echte inkrementelle Sicherung
|
||||
// gegen unveraenderten Bestand ist deutlich kleiner als die Vollsicherung —
|
||||
// beweist, dass tatsaechlich nur Aenderungen uebertragen wurden (PostgreSQL
|
||||
// 17 WAL-Summarization), nicht nochmal alles.
|
||||
func TestIncrementalBackup_IsSmallerThanFull(t *testing.T) {
|
||||
cfg := requireTestConfig(t)
|
||||
ctx := context.Background()
|
||||
|
||||
genID := NewGenerationID(time.Now())
|
||||
fullManifest, err := FullBackup(ctx, cfg, genID)
|
||||
if err != nil {
|
||||
t.Fatalf("fullbackup: %v", err)
|
||||
}
|
||||
fullDir := filepath.Dir(fullManifest)
|
||||
fullSize := fileSize(t, filepath.Join(fullDir, BaseTarGzFile))
|
||||
|
||||
incID := NewGenerationID(time.Now().Add(time.Second))
|
||||
incManifest, err := IncrementalBackup(ctx, cfg, genID, incID, fullManifest)
|
||||
if err != nil {
|
||||
t.Fatalf("incrementalbackup: %v", err)
|
||||
}
|
||||
incDir := filepath.Dir(incManifest)
|
||||
if err := Verify(incDir); err != nil {
|
||||
t.Fatalf("verify (inkrementell): %v", err)
|
||||
}
|
||||
incSize := fileSize(t, filepath.Join(incDir, BaseTarGzFile))
|
||||
|
||||
if incSize >= fullSize {
|
||||
t.Fatalf("inkrementelle sicherung (%d bytes) ist nicht kleiner als die vollsicherung (%d bytes) - keine echte inkrementelle Uebertragung", incSize, fullSize)
|
||||
}
|
||||
}
|
||||
|
||||
func fileSize(t *testing.T, path string) int64 {
|
||||
t.Helper()
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
t.Fatalf("dateigroesse von %q ermitteln: %v", path, err)
|
||||
}
|
||||
return info.Size()
|
||||
}
|
||||
|
||||
// TestVerify_DetectsCorruptedFile ist Pruefung 2: Verifikation erkennt eine
|
||||
// absichtlich beschaedigte Sicherungsdatei.
|
||||
func TestVerify_DetectsCorruptedFile(t *testing.T) {
|
||||
cfg := requireTestConfig(t)
|
||||
ctx := context.Background()
|
||||
|
||||
genID := NewGenerationID(time.Now())
|
||||
manifest, err := FullBackup(ctx, cfg, genID)
|
||||
if err != nil {
|
||||
t.Fatalf("fullbackup: %v", err)
|
||||
}
|
||||
dir := filepath.Dir(manifest)
|
||||
|
||||
if err := Verify(dir); err != nil {
|
||||
t.Fatalf("verify (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||
}
|
||||
|
||||
// Absichtliche Beschaedigung: mehrere Bytes in der Mitte der Datei kippen.
|
||||
path := filepath.Join(dir, BaseTarGzFile)
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("sicherungsdatei lesen: %v", err)
|
||||
}
|
||||
mid := len(data) / 2
|
||||
for i := mid; i < mid+64 && i < len(data); i++ {
|
||||
data[i] ^= 0xFF
|
||||
}
|
||||
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||
t.Fatalf("beschaedigte sicherungsdatei schreiben: %v", err)
|
||||
}
|
||||
|
||||
if err := Verify(dir); err == nil {
|
||||
t.Fatal("verify haette die beschaedigte sicherungsdatei erkennen muessen")
|
||||
}
|
||||
}
|
||||
|
||||
// TestRotate_RemovesOnlyOldestGenerations ist Pruefung 3.
|
||||
func TestRotate_RemovesOnlyOldestGenerations(t *testing.T) {
|
||||
backupDir := t.TempDir()
|
||||
generationIDs := []string{
|
||||
"20260101T000000Z",
|
||||
"20260102T000000Z",
|
||||
"20260103T000000Z",
|
||||
"20260104T000000Z",
|
||||
"20260105T000000Z",
|
||||
}
|
||||
for _, id := range generationIDs {
|
||||
if err := os.MkdirAll(filepath.Join(backupDir, id, FullBackupDirName), 0o750); err != nil {
|
||||
t.Fatalf("generation %q anlegen: %v", id, err)
|
||||
}
|
||||
}
|
||||
|
||||
removed, err := Rotate(backupDir, 2)
|
||||
if err != nil {
|
||||
t.Fatalf("rotate: %v", err)
|
||||
}
|
||||
wantRemoved := []string{"20260101T000000Z", "20260102T000000Z", "20260103T000000Z"}
|
||||
if len(removed) != len(wantRemoved) {
|
||||
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||
}
|
||||
for i, w := range wantRemoved {
|
||||
if removed[i] != w {
|
||||
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||
}
|
||||
}
|
||||
|
||||
remaining, err := ListGenerations(backupDir)
|
||||
if err != nil {
|
||||
t.Fatalf("listgenerations: %v", err)
|
||||
}
|
||||
wantRemaining := []string{"20260104T000000Z", "20260105T000000Z"}
|
||||
if len(remaining) != len(wantRemaining) {
|
||||
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||
}
|
||||
for i, w := range wantRemaining {
|
||||
if remaining[i] != w {
|
||||
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||
}
|
||||
}
|
||||
|
||||
// Die NEUESTEN duerfen NICHT entfernt sein (Pruefung 3: nur die
|
||||
// aeltesten Generationen).
|
||||
for _, w := range wantRemaining {
|
||||
if _, err := os.Stat(filepath.Join(backupDir, w)); err != nil {
|
||||
t.Fatalf("neueste generation %q wurde faelschlich entfernt: %v", w, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
package backup
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
)
|
||||
|
||||
// ListGenerations liefert alle Generation-IDs in backupDir, aufsteigend
|
||||
// sortiert (die GenerationID selbst ist chronologisch sortierbar, siehe
|
||||
// NewGenerationID — kein Blick auf Dateisystem-Zeitstempel nötig, die bei
|
||||
// einem Restore/Kopiervorgang verändert werden könnten).
|
||||
func ListGenerations(backupDir string) ([]string, error) {
|
||||
entries, err := os.ReadDir(backupDir)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil, nil
|
||||
}
|
||||
return nil, fmt.Errorf("backup: sicherungsverzeichnis lesen: %w", err)
|
||||
}
|
||||
var generations []string
|
||||
for _, e := range entries {
|
||||
if e.IsDir() {
|
||||
generations = append(generations, e.Name())
|
||||
}
|
||||
}
|
||||
sort.Strings(generations)
|
||||
return generations, nil
|
||||
}
|
||||
|
||||
// Rotate entfernt alle bis auf die `keep` NEUESTEN Generationen
|
||||
// (Akzeptanzkriterium 3) — jede Generation umfasst ihre Vollsicherung UND
|
||||
// alle davon abhängigen Inkremente, ein Löschen der gesamten
|
||||
// Generationsverzeichnisses entfernt beides konsistent zusammen.
|
||||
func Rotate(backupDir string, keep int) (removed []string, err error) {
|
||||
if keep < 0 {
|
||||
keep = 0
|
||||
}
|
||||
generations, err := ListGenerations(backupDir)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(generations) <= keep {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
toRemove := generations[:len(generations)-keep]
|
||||
for _, gen := range toRemove {
|
||||
if err := os.RemoveAll(filepath.Join(backupDir, gen)); err != nil {
|
||||
return removed, fmt.Errorf("backup: generation %q entfernen: %w", gen, err)
|
||||
}
|
||||
removed = append(removed, gen)
|
||||
}
|
||||
return removed, nil
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
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 im gegebenen Sicherungsverzeichnis
|
||||
// vollständig lesbar ist — ö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.
|
||||
func Verify(backupDir string) error {
|
||||
path := filepath.Join(backupDir, BaseTarGzFile)
|
||||
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 ungueltig: %v", ErrCorrupted, 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 ungueltig: %v", ErrCorrupted, err)
|
||||
}
|
||||
if _, err := io.Copy(io.Discard, tr); err != nil {
|
||||
return fmt.Errorf("%w: inhalt von %q nicht vollstaendig lesbar: %v", ErrCorrupted, hdr.Name, err)
|
||||
}
|
||||
entries++
|
||||
}
|
||||
if entries == 0 {
|
||||
return fmt.Errorf("%w: archiv enthaelt keine eintraege", ErrCorrupted)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
// 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
|
||||
}
|
||||
|
||||
type snapshotEntry struct {
|
||||
ShortID string `json:"short_id"`
|
||||
}
|
||||
|
||||
// SnapshotCount liefert die Anzahl vorhandener Snapshots — für Tests und
|
||||
// Statusabfragen.
|
||||
func SnapshotCount(ctx context.Context, cfg Config) (int, error) {
|
||||
output, err := run(ctx, cfg, "snapshots", "--json")
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("objectbackup: snapshots auflisten: %w", err)
|
||||
}
|
||||
var snapshots []snapshotEntry
|
||||
if err := json.Unmarshal(output, &snapshots); err != nil {
|
||||
return 0, fmt.Errorf("objectbackup: snapshot-liste dekodieren: %w", err)
|
||||
}
|
||||
return len(snapshots), nil
|
||||
}
|
||||
@@ -0,0 +1,168 @@
|
||||
package objectbackup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func requireRestic(t *testing.T) {
|
||||
t.Helper()
|
||||
if _, err := exec.LookPath("restic"); err != nil {
|
||||
t.Skip("restic nicht installiert, Integrationstest uebersprungen")
|
||||
}
|
||||
}
|
||||
|
||||
func setupTest(t *testing.T) Config {
|
||||
t.Helper()
|
||||
requireRestic(t)
|
||||
cfg := Config{RepoDir: filepath.Join(t.TempDir(), "repo"), Password: "test-passwort-fuer-objectbackup"}
|
||||
if err := InitRepo(context.Background(), cfg); err != nil {
|
||||
t.Fatalf("initrepo: %v", err)
|
||||
}
|
||||
return cfg
|
||||
}
|
||||
|
||||
func writeFile(t *testing.T, dir, name, content string) {
|
||||
t.Helper()
|
||||
if err := os.WriteFile(filepath.Join(dir, name), []byte(content), 0o600); err != nil {
|
||||
t.Fatalf("testdatei %q schreiben: %v", name, err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestBackup_UnchangedSecondRunTransmitsNothingNew ist Pruefung 1:
|
||||
// zweiter Sicherungslauf nach unveraendertem Bestand ueberraegt keine
|
||||
// Daten erneut.
|
||||
func TestBackup_UnchangedSecondRunTransmitsNothingNew(t *testing.T) {
|
||||
cfg := setupTest(t)
|
||||
ctx := context.Background()
|
||||
sourceDir := t.TempDir()
|
||||
writeFile(t, sourceDir, "dokument.pdf", "unveraenderter inhalt")
|
||||
|
||||
first, err := Backup(ctx, cfg, sourceDir)
|
||||
if err != nil {
|
||||
t.Fatalf("erste sicherung: %v", err)
|
||||
}
|
||||
if first.FilesNew != 1 {
|
||||
t.Fatalf("erste sicherung: files_new = %d, want 1", first.FilesNew)
|
||||
}
|
||||
|
||||
second, err := Backup(ctx, cfg, sourceDir)
|
||||
if err != nil {
|
||||
t.Fatalf("zweite sicherung: %v", err)
|
||||
}
|
||||
if second.FilesNew != 0 || second.FilesChanged != 0 {
|
||||
t.Fatalf("zweite sicherung (unveraendert): files_new=%d files_changed=%d, want beide 0", second.FilesNew, second.FilesChanged)
|
||||
}
|
||||
if second.FilesUnmodified != 1 {
|
||||
t.Fatalf("zweite sicherung: files_unmodified = %d, want 1", second.FilesUnmodified)
|
||||
}
|
||||
}
|
||||
|
||||
// TestBackup_DeduplicatesIdenticalContent ist Pruefung 2: zwei identische
|
||||
// Testdateien belegen nachweislich nur einmal Speicherplatz.
|
||||
func TestBackup_DeduplicatesIdenticalContent(t *testing.T) {
|
||||
cfg := setupTest(t)
|
||||
ctx := context.Background()
|
||||
sourceDir := t.TempDir()
|
||||
content := "exakt identischer inhalt in beiden dateien fuer den dedup-nachweis"
|
||||
writeFile(t, sourceDir, "original.pdf", content)
|
||||
writeFile(t, sourceDir, "kopie.pdf", content)
|
||||
|
||||
summary, err := Backup(ctx, cfg, sourceDir)
|
||||
if err != nil {
|
||||
t.Fatalf("sicherung: %v", err)
|
||||
}
|
||||
if summary.FilesNew != 2 {
|
||||
t.Fatalf("erwartet 2 neue dateien, habe %d", summary.FilesNew)
|
||||
}
|
||||
// Zwei Dateien mit IDENTISCHEM Inhalt duerfen nur EINEN data_blob
|
||||
// erzeugen - das ist der Dedup-Nachweis (Akzeptanzkriterium 2).
|
||||
if summary.DataBlobs != 1 {
|
||||
t.Fatalf("data_blobs = %d, want 1 (zwei identische dateien haetten nur einen blob erzeugen duerfen - keine dedup)", summary.DataBlobs)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCheck_DetectsCorruptedPack ist Pruefung 3: Vollstaendigkeitspruefung
|
||||
// erkennt ein beschaedigtes/fehlendes Objekt in der Sicherung.
|
||||
func TestCheck_DetectsCorruptedPack(t *testing.T) {
|
||||
cfg := setupTest(t)
|
||||
ctx := context.Background()
|
||||
sourceDir := t.TempDir()
|
||||
writeFile(t, sourceDir, "wichtig.pdf", "inhalt, der spaeter absichtlich beschaedigt wird")
|
||||
|
||||
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||
t.Fatalf("sicherung: %v", err)
|
||||
}
|
||||
if err := Check(ctx, cfg, true); err != nil {
|
||||
t.Fatalf("check (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||
}
|
||||
|
||||
// Absichtliche Beschaedigung: ein Byte in einer Pack-Datei im
|
||||
// Repository kippen (dieselbe Fundstelle wie beim manuellen
|
||||
// Nachweis waehrend der Recherche zu diesem Ticket).
|
||||
packDir := filepath.Join(cfg.RepoDir, "data")
|
||||
corrupted := false
|
||||
if err := filepath.Walk(packDir, func(path string, info os.FileInfo, err error) error {
|
||||
if err != nil || info.IsDir() || corrupted {
|
||||
return err
|
||||
}
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(data) < 20 {
|
||||
return nil
|
||||
}
|
||||
data[10] ^= 0xFF
|
||||
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||
return err
|
||||
}
|
||||
corrupted = true
|
||||
return nil
|
||||
}); err != nil {
|
||||
t.Fatalf("pack-datei beschaedigen: %v", err)
|
||||
}
|
||||
if !corrupted {
|
||||
t.Fatal("keine pack-datei zum beschaedigen gefunden - testaufbau fehlerhaft")
|
||||
}
|
||||
|
||||
if err := Check(ctx, cfg, true); err == nil {
|
||||
t.Fatal("check haette die beschaedigte pack-datei erkennen muessen")
|
||||
}
|
||||
}
|
||||
|
||||
// TestForget_KeepsOnlyRequestedSnapshotCount prueft die Rotation.
|
||||
func TestForget_KeepsOnlyRequestedSnapshotCount(t *testing.T) {
|
||||
cfg := setupTest(t)
|
||||
ctx := context.Background()
|
||||
sourceDir := t.TempDir()
|
||||
|
||||
for i := 0; i < 3; i++ {
|
||||
writeFile(t, sourceDir, "f.txt", "version "+string(rune('a'+i)))
|
||||
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||
t.Fatalf("sicherung %d: %v", i, err)
|
||||
}
|
||||
}
|
||||
before, err := SnapshotCount(ctx, cfg)
|
||||
if err != nil {
|
||||
t.Fatalf("snapshotcount (vorher): %v", err)
|
||||
}
|
||||
if before != 3 {
|
||||
t.Fatalf("erwartet 3 snapshots vor rotation, habe %d", before)
|
||||
}
|
||||
|
||||
if err := Forget(ctx, cfg, 1); err != nil {
|
||||
t.Fatalf("forget: %v", err)
|
||||
}
|
||||
|
||||
after, err := SnapshotCount(ctx, cfg)
|
||||
if err != nil {
|
||||
t.Fatalf("snapshotcount (nachher): %v", err)
|
||||
}
|
||||
if after != 1 {
|
||||
t.Fatalf("erwartet 1 snapshot nach rotation (keep-last 1), habe %d", after)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
// Package reconcile implementiert BAK-05: periodischer Abgleich, ob jeder
|
||||
// in der Datenbank referenzierte Objekt-Storage-Eintrag tatsächlich
|
||||
// existiert und umgekehrt. Prüft AUSSCHLIESSLICH Existenz — niemals
|
||||
// Inhalt (das ist Archive BAK-08, eine eigene Fehlerklasse, bewusst nicht
|
||||
// hier mit hineingezogen, siehe reconcile_test.go
|
||||
// TestReconcile_ExistingButCorruptedObjectProducesNoFinding).
|
||||
package reconcile
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Finding ist EIN Abweichungsfund — entweder ein Datenbankeintrag ohne
|
||||
// Storage-Objekt oder umgekehrt.
|
||||
type Finding struct {
|
||||
StorageKey string `json:"storage_key"`
|
||||
DocumentID string `json:"document_id,omitempty"`
|
||||
RevisionID string `json:"revision_id,omitempty"`
|
||||
}
|
||||
|
||||
// Report ist das Ergebnis EINES Abgleichslaufs (Akzeptanzkriterium 3:
|
||||
// Abweichungen werden BERICHTET, nicht automatisch behoben — Report ist
|
||||
// reine Information, keine Reparaturfunktion existiert in diesem Paket).
|
||||
//
|
||||
// Beide Listen sind nach StorageKey aufsteigend sortiert — bei gleicher
|
||||
// Eingabe liefert Reconcile IMMER dieselbe Reihenfolge (deterministisch),
|
||||
// damit ein nachgelagerter Verbraucher (Archive BAK-08: zieht seine
|
||||
// Stichprobe aus der Liste der EXISTIERENDEN Objekte) sich auf eine
|
||||
// stabile Sortierung verlassen kann, statt bei jedem Lauf neu zu
|
||||
// filtern/sortieren.
|
||||
type Report struct {
|
||||
GeneratedAt time.Time `json:"generated_at"`
|
||||
// MissingInStorage: Datenbankeintrag vorhanden, Objekt im Storage fehlt
|
||||
// (Akzeptanzkriterium 1).
|
||||
MissingInStorage []Finding `json:"missing_in_storage"`
|
||||
// OrphanedInStorage: Objekt im Storage vorhanden, kein Datenbankeintrag
|
||||
// (Akzeptanzkriterium 2).
|
||||
OrphanedInStorage []Finding `json:"orphaned_in_storage"`
|
||||
// ExistingInStorage: Datenbankeintrag UND Storage-Objekt beide
|
||||
// vorhanden — reine Existenzbestätigung, KEINE Inhaltsprüfung. Dient
|
||||
// Archive BAK-08 als stabile, deterministisch sortierte
|
||||
// Stichprobengrundlage (nach StorageKey aufsteigend, siehe Report-
|
||||
// Dokumentation oben) — BAK-08 muss dafür selbst nicht mehr
|
||||
// sortieren/filtern.
|
||||
ExistingInStorage []Finding `json:"existing_in_storage"`
|
||||
}
|
||||
|
||||
// IsClean liefert true, wenn der Lauf keine Abweichungen fand (Pflicht-
|
||||
// prüfung 3: "Lauf ohne Abweichungen liefert einen leeren, eindeutig als
|
||||
// sauber erkennbaren Bericht" — IsClean ist genau dieses eindeutige
|
||||
// Erkennungsmerkmal, statt dass ein Aufrufer beide Listen selbst auf
|
||||
// Leere prüfen muss).
|
||||
func (r Report) IsClean() bool {
|
||||
return len(r.MissingInStorage) == 0 && len(r.OrphanedInStorage) == 0
|
||||
}
|
||||
|
||||
// DBEntry ist ein Datenbankeintrag, wie ihn ListDBStorageKeys liefert.
|
||||
type DBEntry struct {
|
||||
StorageKey string
|
||||
DocumentID string
|
||||
RevisionID string
|
||||
}
|
||||
|
||||
// Reconcile vergleicht dbEntries (aus file_revisions.storage_key, DMS
|
||||
// FDN-02) gegen storageKeys (tatsächlich im Objekt-Storage vorhandene
|
||||
// Schlüssel, z.B. per Verzeichnis-Walk des FDN-03-LocalDriver-
|
||||
// Basisverzeichnisses) und liefert die Abweichungen in beide Richtungen.
|
||||
// Reine Funktion — kein Datenbank-/Storage-Zugriff hier, dadurch ohne
|
||||
// echte Infrastruktur testbar (siehe reconcile_test.go).
|
||||
func Reconcile(dbEntries []DBEntry, storageKeys []string) Report {
|
||||
storageSet := make(map[string]bool, len(storageKeys))
|
||||
for _, k := range storageKeys {
|
||||
storageSet[k] = true
|
||||
}
|
||||
dbSet := make(map[string]DBEntry, len(dbEntries))
|
||||
for _, e := range dbEntries {
|
||||
dbSet[e.StorageKey] = e
|
||||
}
|
||||
|
||||
var missing, existing []Finding
|
||||
for _, e := range dbEntries {
|
||||
if !storageSet[e.StorageKey] {
|
||||
missing = append(missing, Finding(e))
|
||||
} else {
|
||||
existing = append(existing, Finding(e))
|
||||
}
|
||||
}
|
||||
var orphaned []Finding
|
||||
for _, k := range storageKeys {
|
||||
if _, ok := dbSet[k]; !ok {
|
||||
orphaned = append(orphaned, Finding{StorageKey: k})
|
||||
}
|
||||
}
|
||||
|
||||
sort.Slice(missing, func(i, j int) bool { return missing[i].StorageKey < missing[j].StorageKey })
|
||||
sort.Slice(orphaned, func(i, j int) bool { return orphaned[i].StorageKey < orphaned[j].StorageKey })
|
||||
sort.Slice(existing, func(i, j int) bool { return existing[i].StorageKey < existing[j].StorageKey })
|
||||
|
||||
return Report{
|
||||
GeneratedAt: time.Now().UTC(),
|
||||
MissingInStorage: missing,
|
||||
OrphanedInStorage: orphaned,
|
||||
ExistingInStorage: existing,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,169 @@
|
||||
package reconcile
|
||||
|
||||
import "testing"
|
||||
|
||||
// TestReconcile_DetectsMissingInStorage ist Akzeptanzkriterium 1 / Pruefung
|
||||
// 1: ein Datenbankeintrag ohne zugehoeriges Objekt im Storage wird erkannt.
|
||||
func TestReconcile_DetectsMissingInStorage(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||
{StorageKey: "documents/d2/revisions/r1", DocumentID: "d2", RevisionID: "r1"},
|
||||
}
|
||||
storage := []string{"documents/d1/revisions/r1"} // d2/r1 fehlt absichtlich
|
||||
|
||||
report := Reconcile(db, storage)
|
||||
|
||||
if len(report.MissingInStorage) != 1 {
|
||||
t.Fatalf("erwartet 1 fund in missing_in_storage, habe %d: %+v", len(report.MissingInStorage), report.MissingInStorage)
|
||||
}
|
||||
if report.MissingInStorage[0].StorageKey != "documents/d2/revisions/r1" {
|
||||
t.Fatalf("unerwarteter fund: %+v", report.MissingInStorage[0])
|
||||
}
|
||||
if len(report.OrphanedInStorage) != 0 {
|
||||
t.Fatalf("erwartet 0 funde in orphaned_in_storage, habe %d", len(report.OrphanedInStorage))
|
||||
}
|
||||
}
|
||||
|
||||
// TestReconcile_DetectsOrphanedInStorage ist Akzeptanzkriterium 2 /
|
||||
// Pruefung 2: ein Storage-Objekt ohne Datenbankeintrag wird erkannt.
|
||||
func TestReconcile_DetectsOrphanedInStorage(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||
}
|
||||
storage := []string{
|
||||
"documents/d1/revisions/r1",
|
||||
"documents/verwaist/revisions/r1", // kein DB-Eintrag dafuer
|
||||
}
|
||||
|
||||
report := Reconcile(db, storage)
|
||||
|
||||
if len(report.OrphanedInStorage) != 1 {
|
||||
t.Fatalf("erwartet 1 fund in orphaned_in_storage, habe %d: %+v", len(report.OrphanedInStorage), report.OrphanedInStorage)
|
||||
}
|
||||
if report.OrphanedInStorage[0].StorageKey != "documents/verwaist/revisions/r1" {
|
||||
t.Fatalf("unerwarteter fund: %+v", report.OrphanedInStorage[0])
|
||||
}
|
||||
if len(report.MissingInStorage) != 0 {
|
||||
t.Fatalf("erwartet 0 funde in missing_in_storage, habe %d", len(report.MissingInStorage))
|
||||
}
|
||||
}
|
||||
|
||||
// TestReconcile_CleanRunProducesEmptyReport ist Pruefung 3: Lauf ohne
|
||||
// Abweichungen liefert einen leeren, eindeutig als sauber erkennbaren
|
||||
// Bericht.
|
||||
func TestReconcile_CleanRunProducesEmptyReport(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||
{StorageKey: "documents/d2/revisions/r1", DocumentID: "d2", RevisionID: "r1"},
|
||||
}
|
||||
storage := []string{"documents/d1/revisions/r1", "documents/d2/revisions/r1"}
|
||||
|
||||
report := Reconcile(db, storage)
|
||||
|
||||
if !report.IsClean() {
|
||||
t.Fatalf("erwartet sauberen bericht, habe missing=%v orphaned=%v", report.MissingInStorage, report.OrphanedInStorage)
|
||||
}
|
||||
if len(report.MissingInStorage) != 0 || len(report.OrphanedInStorage) != 0 {
|
||||
t.Fatal("IsClean()==true, aber listen sind nicht leer - widerspruch")
|
||||
}
|
||||
}
|
||||
|
||||
// TestReconcile_ExistingButCorruptedObjectProducesNoFinding ist der
|
||||
// Nachweis, dass BAK-05 AUSSCHLIESSLICH Existenz prueft, niemals Inhalt
|
||||
// (die Fehlerklasse "existiert, aber Inhalt beschaedigt" ist Archive
|
||||
// BAK-08, bewusst nicht hier) — Reconcile bekommt nur SCHLUESSEL, hat gar
|
||||
// keine Moeglichkeit, auf Inhalt zuzugreifen; dieser Test dokumentiert die
|
||||
// Absicht explizit, damit sie nicht versehentlich spaeter aufgeweicht wird.
|
||||
func TestReconcile_ExistingButCorruptedObjectProducesNoFinding(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/d1/revisions/r1", DocumentID: "d1", RevisionID: "r1"},
|
||||
}
|
||||
// "korruptes" Objekt hier rein simuliert durch denselben Schluessel -
|
||||
// Reconcile kennt und prueft keinen Inhalt, nur den Schluessel selbst.
|
||||
storage := []string{"documents/d1/revisions/r1"}
|
||||
|
||||
report := Reconcile(db, storage)
|
||||
|
||||
if !report.IsClean() {
|
||||
t.Fatalf("ein existierendes (wenn auch inhaltlich korruptes) objekt haette KEINEN befund ausloesen duerfen, habe: %+v", report)
|
||||
}
|
||||
}
|
||||
|
||||
// TestReconcile_ExistingInStorageIsStableSamplingBasis ist der Nachweis,
|
||||
// dass Reconcile eine deterministisch sortierte Liste ALLER bestaetigt
|
||||
// existierenden Objekte liefert (DB-Eintrag UND Storage-Objekt vorhanden)
|
||||
// - dies ist die Stichprobengrundlage, die Archive BAK-08 weiterverwendet,
|
||||
// ohne selbst neu zu sortieren/filtern.
|
||||
func TestReconcile_ExistingInStorageIsStableSamplingBasis(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/z/revisions/r1", DocumentID: "z", RevisionID: "r1"},
|
||||
{StorageKey: "documents/a/revisions/r1", DocumentID: "a", RevisionID: "r1"},
|
||||
{StorageKey: "documents/fehlt/revisions/r1", DocumentID: "fehlt", RevisionID: "r1"},
|
||||
}
|
||||
storage := []string{
|
||||
"documents/z/revisions/r1",
|
||||
"documents/a/revisions/r1",
|
||||
}
|
||||
|
||||
report := Reconcile(db, storage)
|
||||
|
||||
want := []string{"documents/a/revisions/r1", "documents/z/revisions/r1"}
|
||||
if len(report.ExistingInStorage) != len(want) {
|
||||
t.Fatalf("erwartet %d bestaetigt existierende objekte, habe %d: %+v", len(want), len(report.ExistingInStorage), report.ExistingInStorage)
|
||||
}
|
||||
for i, w := range want {
|
||||
if report.ExistingInStorage[i].StorageKey != w {
|
||||
t.Fatalf("sortierreihenfolge falsch: %v, want beginnend mit %v", report.ExistingInStorage, want)
|
||||
}
|
||||
}
|
||||
if len(report.MissingInStorage) != 1 || report.MissingInStorage[0].StorageKey != "documents/fehlt/revisions/r1" {
|
||||
t.Fatalf("missing_in_storage unerwartet: %+v", report.MissingInStorage)
|
||||
}
|
||||
}
|
||||
|
||||
// TestReconcile_DeterministicOrdering ist der Nachweis fuer die
|
||||
// Stabilitaets-Anforderung: gleiche Eingabe liefert bei mehreren Laeufen
|
||||
// IMMER dieselbe Reihenfolge (Voraussetzung dafuer, dass Archive BAK-08
|
||||
// die Liste der existierenden Objekte stabil weiterverarbeiten kann, ohne
|
||||
// selbst neu zu sortieren/filtern).
|
||||
func TestReconcile_DeterministicOrdering(t *testing.T) {
|
||||
db := []DBEntry{
|
||||
{StorageKey: "documents/z/revisions/r1", DocumentID: "z", RevisionID: "r1"},
|
||||
{StorageKey: "documents/a/revisions/r1", DocumentID: "a", RevisionID: "r1"},
|
||||
{StorageKey: "documents/m/revisions/r1", DocumentID: "m", RevisionID: "r1"},
|
||||
}
|
||||
storage := []string{
|
||||
"documents/a/revisions/r1", // deckt genau den DB-Eintrag "a" ab
|
||||
"documents/y/revisions/r1",
|
||||
"documents/n/revisions/r1",
|
||||
}
|
||||
|
||||
first := Reconcile(db, storage)
|
||||
second := Reconcile(db, storage)
|
||||
|
||||
if len(first.MissingInStorage) != len(second.MissingInStorage) {
|
||||
t.Fatal("unterschiedliche anzahl funde zwischen zwei laeufen mit identischer eingabe")
|
||||
}
|
||||
for i := range first.MissingInStorage {
|
||||
if first.MissingInStorage[i].StorageKey != second.MissingInStorage[i].StorageKey {
|
||||
t.Fatalf("reihenfolge in missing_in_storage nicht deterministisch: lauf1[%d]=%q lauf2[%d]=%q",
|
||||
i, first.MissingInStorage[i].StorageKey, i, second.MissingInStorage[i].StorageKey)
|
||||
}
|
||||
}
|
||||
for i := range first.OrphanedInStorage {
|
||||
if first.OrphanedInStorage[i].StorageKey != second.OrphanedInStorage[i].StorageKey {
|
||||
t.Fatalf("reihenfolge in orphaned_in_storage nicht deterministisch: lauf1[%d]=%q lauf2[%d]=%q",
|
||||
i, first.OrphanedInStorage[i].StorageKey, i, second.OrphanedInStorage[i].StorageKey)
|
||||
}
|
||||
}
|
||||
// Aufsteigend sortiert (a < m < z), nicht Einfuegereihenfolge.
|
||||
wantOrder := []string{"documents/m/revisions/r1", "documents/z/revisions/r1"}
|
||||
if len(first.MissingInStorage) != len(wantOrder) {
|
||||
t.Fatalf("erwartet %d funde, habe %d", len(wantOrder), len(first.MissingInStorage))
|
||||
}
|
||||
for i, w := range wantOrder {
|
||||
if first.MissingInStorage[i].StorageKey != w {
|
||||
t.Fatalf("sortierreihenfolge falsch: %v, want beginnend mit %v", first.MissingInStorage, wantOrder)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
package reconcile
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// ListDBStorageKeys liest alle storage_key-Werte aus file_revisions
|
||||
// (DMS FDN-02) — Archive liest direkt aus derselben physischen
|
||||
// Tenant-Datenbank (Modell C, Core TEN-01), OHNE DMS-Go-Pakete zu
|
||||
// importieren (Archive ist ein eigenes Go-Modul) — reiner SQL-Zugriff
|
||||
// gegen das dokumentierte Schema, sortiert nach storage_key für
|
||||
// deterministische Reconcile-Ergebnisse.
|
||||
func ListDBStorageKeys(ctx context.Context, pool *pgxpool.Pool) ([]DBEntry, error) {
|
||||
rows, err := pool.Query(ctx, `
|
||||
SELECT storage_key, document_id, id FROM file_revisions ORDER BY storage_key
|
||||
`)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("reconcile: file_revisions abfragen: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
var entries []DBEntry
|
||||
for rows.Next() {
|
||||
var e DBEntry
|
||||
if err := rows.Scan(&e.StorageKey, &e.DocumentID, &e.RevisionID); err != nil {
|
||||
return nil, fmt.Errorf("reconcile: file_revisions-zeile lesen: %w", err)
|
||||
}
|
||||
entries = append(entries, e)
|
||||
}
|
||||
return entries, rows.Err()
|
||||
}
|
||||
|
||||
// ListStorageObjects durchläuft den lokalen FDN-03-LocalDriver-
|
||||
// Basisordner und liefert alle vorhandenen Objektschlüssel (Pfad relativ
|
||||
// zu baseDir, mit "/" als Trenner — dasselbe Format wie
|
||||
// storage.ObjectKey aus FDN-03), sortiert.
|
||||
func ListStorageObjects(baseDir string) ([]string, error) {
|
||||
var keys []string
|
||||
err := filepath.WalkDir(baseDir, func(path string, d os.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if d.IsDir() {
|
||||
return nil
|
||||
}
|
||||
rel, err := filepath.Rel(baseDir, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
keys = append(keys, filepath.ToSlash(rel))
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil, nil
|
||||
}
|
||||
return nil, fmt.Errorf("reconcile: objekt-storage durchlaufen: %w", err)
|
||||
}
|
||||
return keys, nil
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
package reconcile
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func requireTestPool(t *testing.T) *pgxpool.Pool {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||
if dsn == "" {
|
||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||
}
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Fatalf("pool: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { pool.Close() })
|
||||
|
||||
// Minimalschema, das exakt DMS FDN-02s file_revisions-Spalten spiegelt
|
||||
// (Archive kann DMS' internal/-Pakete als eigenes Go-Modul nicht
|
||||
// importieren, daher hier als Testfixture kopiert statt real migriert).
|
||||
if _, err := pool.Exec(ctx, `
|
||||
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), email TEXT NOT NULL UNIQUE, name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS documents (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), title TEXT NOT NULL,
|
||||
created_by UUID NOT NULL REFERENCES users(id), created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS file_revisions (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||
storage_key TEXT NOT NULL, checksum_sha256 TEXT NOT NULL, size_bytes BIGINT NOT NULL,
|
||||
mime_type TEXT NOT NULL, revision_number INTEGER NOT NULL, created_by UUID NOT NULL REFERENCES users(id),
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
`); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `TRUNCATE file_revisions, documents, users CASCADE`)
|
||||
})
|
||||
return pool
|
||||
}
|
||||
|
||||
// TestListDBStorageKeys_ReadsRealFileRevisions ist der Nachweis, dass
|
||||
// ListDBStorageKeys tatsaechlich gegen eine echte Postgres-Instanz mit
|
||||
// DMS-FDN-02-Schema liest — kein Mock.
|
||||
func TestListDBStorageKeys_ReadsRealFileRevisions(t *testing.T) {
|
||||
pool := requireTestPool(t)
|
||||
ctx := context.Background()
|
||||
|
||||
var userID, docID string
|
||||
if err := pool.QueryRow(ctx, `INSERT INTO users (email, name) VALUES ('reconcile-test@example.test', 'Test') RETURNING id`).Scan(&userID); err != nil {
|
||||
t.Fatalf("testbenutzer anlegen: %v", err)
|
||||
}
|
||||
if err := pool.QueryRow(ctx, `INSERT INTO documents (title, created_by) VALUES ('doc', $1) RETURNING id`, userID).Scan(&docID); err != nil {
|
||||
t.Fatalf("testdokument anlegen: %v", err)
|
||||
}
|
||||
if _, err := pool.Exec(ctx, `
|
||||
INSERT INTO file_revisions (document_id, storage_key, checksum_sha256, size_bytes, mime_type, revision_number, created_by)
|
||||
VALUES ($1, 'documents/x/revisions/1', 'abc', 10, 'text/plain', 1, $2)
|
||||
`, docID, userID); err != nil {
|
||||
t.Fatalf("testrevision anlegen: %v", err)
|
||||
}
|
||||
|
||||
entries, err := ListDBStorageKeys(ctx, pool)
|
||||
if err != nil {
|
||||
t.Fatalf("listdbstoragekeys: %v", err)
|
||||
}
|
||||
if len(entries) != 1 {
|
||||
t.Fatalf("erwartet 1 eintrag, habe %d", len(entries))
|
||||
}
|
||||
if entries[0].StorageKey != "documents/x/revisions/1" {
|
||||
t.Fatalf("storage_key = %q, want %q", entries[0].StorageKey, "documents/x/revisions/1")
|
||||
}
|
||||
if entries[0].DocumentID != docID {
|
||||
t.Fatalf("document_id = %q, want %q", entries[0].DocumentID, docID)
|
||||
}
|
||||
}
|
||||
|
||||
// TestListStorageObjects_WalksRealDirectory ist der Nachweis, dass
|
||||
// ListStorageObjects tatsaechlich das Dateisystem durchlaeuft.
|
||||
func TestListStorageObjects_WalksRealDirectory(t *testing.T) {
|
||||
baseDir := t.TempDir()
|
||||
mustWriteFile(t, filepath.Join(baseDir, "documents", "d1", "revisions", "r1"), "inhalt")
|
||||
mustWriteFile(t, filepath.Join(baseDir, "documents", "d2", "revisions", "r1"), "inhalt")
|
||||
|
||||
keys, err := ListStorageObjects(baseDir)
|
||||
if err != nil {
|
||||
t.Fatalf("liststorageobjects: %v", err)
|
||||
}
|
||||
if len(keys) != 2 {
|
||||
t.Fatalf("erwartet 2 objektschluessel, habe %d: %v", len(keys), keys)
|
||||
}
|
||||
want := []string{"documents/d1/revisions/r1", "documents/d2/revisions/r1"}
|
||||
for i, w := range want {
|
||||
if keys[i] != w {
|
||||
t.Fatalf("schluessel[%d] = %q, want %q (voll: %v)", i, keys[i], w, keys)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestListStorageObjects_MissingDirectoryReturnsEmpty prueft das
|
||||
// Verhalten, wenn das Basisverzeichnis (noch) gar nicht existiert -
|
||||
// sollte als "keine Objekte", nicht als Fehler behandelt werden.
|
||||
func TestListStorageObjects_MissingDirectoryReturnsEmpty(t *testing.T) {
|
||||
keys, err := ListStorageObjects("/pfad/der/nicht/existiert/fuer/diesen/test")
|
||||
if err != nil {
|
||||
t.Fatalf("erwartet keinen fehler bei fehlendem verzeichnis, habe: %v", err)
|
||||
}
|
||||
if len(keys) != 0 {
|
||||
t.Fatalf("erwartet 0 schluessel, habe %d", len(keys))
|
||||
}
|
||||
}
|
||||
|
||||
func mustWriteFile(t *testing.T, path, content string) {
|
||||
t.Helper()
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||
t.Fatalf("verzeichnis anlegen: %v", err)
|
||||
}
|
||||
if err := os.WriteFile(path, []byte(content), 0o600); err != nil {
|
||||
t.Fatalf("datei schreiben: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// ExpectedChecksums liest file_revisions.checksum_sha256 fuer genau die
|
||||
// uebergebenen storage_keys — bewusst eine eigene, minimale Abfrage statt
|
||||
// Erweiterung von reconcile.DBEntry (BAK-05 bleibt existenz-only, keine
|
||||
// Kopplung an Inhaltspruefungs-Bedarf von BAK-08).
|
||||
func ExpectedChecksums(ctx context.Context, pool *pgxpool.Pool, storageKeys []string) (map[string]string, error) {
|
||||
if len(storageKeys) == 0 {
|
||||
return map[string]string{}, nil
|
||||
}
|
||||
rows, err := pool.Query(ctx, `
|
||||
SELECT storage_key, checksum_sha256 FROM file_revisions WHERE storage_key = ANY($1)
|
||||
`, storageKeys)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("scrub: erwartete pruefsummen lesen: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
out := make(map[string]string, len(storageKeys))
|
||||
for rows.Next() {
|
||||
var key, checksum string
|
||||
if err := rows.Scan(&key, &checksum); err != nil {
|
||||
return nil, fmt.Errorf("scrub: pruefsummen-zeile lesen: %w", err)
|
||||
}
|
||||
out[key] = checksum
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// ActualChecksum liest die Datei unter baseDir/storageKey vollstaendig
|
||||
// und berechnet ihren SHA-256 — echte Inhaltspruefung, kein
|
||||
// Header-/Groessenvergleich (dieselbe Disziplin wie BAK-01s Verify).
|
||||
func ActualChecksum(baseDir, storageKey string) (string, error) {
|
||||
f, err := os.Open(filepath.Join(baseDir, filepath.FromSlash(storageKey)))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("scrub: objekt lesen: %w", err)
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
h := sha256.New()
|
||||
if _, err := io.Copy(h, f); err != nil {
|
||||
return "", fmt.Errorf("scrub: objekt hashen: %w", err)
|
||||
}
|
||||
return hex.EncodeToString(h.Sum(nil)), nil
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func requireFileRevisionsFixture(t *testing.T) (pool *pgxpool.Pool, userID, docID string) {
|
||||
t.Helper()
|
||||
p := requireTestPool(t)
|
||||
ctx := context.Background()
|
||||
if _, err := p.Exec(ctx, `
|
||||
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), email TEXT NOT NULL UNIQUE, name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS documents (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), title TEXT NOT NULL,
|
||||
created_by UUID NOT NULL REFERENCES users(id), created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS file_revisions (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||
storage_key TEXT NOT NULL, checksum_sha256 TEXT NOT NULL, size_bytes BIGINT NOT NULL,
|
||||
mime_type TEXT NOT NULL, revision_number INTEGER NOT NULL, created_by UUID NOT NULL REFERENCES users(id),
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
`); err != nil {
|
||||
t.Fatalf("file_revisions-fixture: %v", err)
|
||||
}
|
||||
var uid string
|
||||
if err := p.QueryRow(ctx, `INSERT INTO users (email, name) VALUES ('scrub-test@example.test', 'Test') RETURNING id`).Scan(&uid); err != nil {
|
||||
t.Fatalf("testbenutzer anlegen: %v", err)
|
||||
}
|
||||
var did string
|
||||
if err := p.QueryRow(ctx, `INSERT INTO documents (title, created_by) VALUES ('doc', $1) RETURNING id`, uid).Scan(&did); err != nil {
|
||||
t.Fatalf("testdokument anlegen: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = p.Exec(context.Background(), `TRUNCATE file_revisions, documents, users CASCADE`) })
|
||||
return p, uid, did
|
||||
}
|
||||
|
||||
// TestActualChecksum_MatchesRealFileContent ist Nachweis, dass
|
||||
// ActualChecksum tatsaechlich den Dateiinhalt liest und hasht (kein
|
||||
// Header-/Groessenvergleich).
|
||||
func TestActualChecksum_MatchesRealFileContent(t *testing.T) {
|
||||
baseDir := t.TempDir()
|
||||
content := []byte("echter dateiinhalt fuer scrub-test")
|
||||
path := filepath.Join(baseDir, "documents", "x", "revisions", "1")
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(path, content, 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
got, err := ActualChecksum(baseDir, "documents/x/revisions/1")
|
||||
if err != nil {
|
||||
t.Fatalf("actualChecksum: %v", err)
|
||||
}
|
||||
sum := sha256.Sum256(content)
|
||||
want := hex.EncodeToString(sum[:])
|
||||
if got != want {
|
||||
t.Fatalf("checksum = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExpectedChecksums_ReadsRealFileRevisions ist Nachweis gegen echtes
|
||||
// Postgres, kein Mock.
|
||||
func TestExpectedChecksums_ReadsRealFileRevisions(t *testing.T) {
|
||||
pool, uid, did := requireFileRevisionsFixture(t)
|
||||
ctx := context.Background()
|
||||
|
||||
if _, err := pool.Exec(ctx, `
|
||||
INSERT INTO file_revisions (document_id, storage_key, checksum_sha256, size_bytes, mime_type, revision_number, created_by)
|
||||
VALUES ($1, 'documents/x/revisions/1', 'abc123', 10, 'text/plain', 1, $2)
|
||||
`, did, uid); err != nil {
|
||||
t.Fatalf("testrevision anlegen: %v", err)
|
||||
}
|
||||
|
||||
got, err := ExpectedChecksums(ctx, pool, []string{"documents/x/revisions/1", "documents/fehlt/revisions/1"})
|
||||
if err != nil {
|
||||
t.Fatalf("expectedChecksums: %v", err)
|
||||
}
|
||||
if len(got) != 1 || got["documents/x/revisions/1"] != "abc123" {
|
||||
t.Fatalf("unerwartetes ergebnis: %+v", got)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
// Package scrub implementiert BAK-08: periodische, checksummenbasierte
|
||||
// Integritaetspruefung einer Stichprobe existierender Objekte. Baut auf
|
||||
// BAK-05 (internal/reconcile) auf, das die deterministisch sortierte
|
||||
// Liste bestaetigt existierender Objekte liefert (existenz-only) — scrub
|
||||
// fuegt die INHALTSPRUEFUNG hinzu, die BAK-05 bewusst ausspart.
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"time"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||
)
|
||||
|
||||
// Candidate ist ein fuer den aktuellen Lauf ausgewaehltes Objekt.
|
||||
type Candidate struct {
|
||||
StorageKey string
|
||||
DocumentID string
|
||||
RevisionID string
|
||||
}
|
||||
|
||||
// Sample waehlt aus existing (BAK-05s existing_in_storage, bereits nach
|
||||
// StorageKey sortiert) die naechste Stichprobe: Objekte, die noch nie
|
||||
// oder vor mehr als cooldown geprueft wurden (last_scrubbed via
|
||||
// storage_key -> last_scrubbed_at aus scrub_state), begrenzt auf
|
||||
// sampleSize. Reine Funktion, deterministisch bei gleicher Eingabe (fixe
|
||||
// Reihenfolge von existing, kein Zufall) — Akzeptanzkriterium
|
||||
// "Sampling priorisiert alte, unveraenderte Objekte": ein nie/am
|
||||
// laengsten nicht geprueftes Objekt hat KEINEN last_scrubbed-Eintrag oder
|
||||
// den aeltesten, beides erscheint zuerst in "existing", das seinerseits
|
||||
// nach StorageKey sortiert ist — daher wird zusaetzlich vor der
|
||||
// Groessenbegrenzung nach last_scrubbed_at aufsteigend sortiert (nie
|
||||
// geprueft = aeltestmoeglicher Wert), damit tatsaechlich das am laengsten
|
||||
// nicht verifizierte Objekt zuerst drankommt, nicht nur alphabetisch nach
|
||||
// Schluessel.
|
||||
func Sample(existing []reconcile.Finding, lastScrubbed map[string]time.Time, cooldown time.Duration, sampleSize int, now time.Time) []Candidate {
|
||||
type scored struct {
|
||||
f reconcile.Finding
|
||||
last time.Time
|
||||
}
|
||||
var due []scored
|
||||
for _, f := range existing {
|
||||
last, ok := lastScrubbed[f.StorageKey]
|
||||
if ok && now.Sub(last) < cooldown {
|
||||
continue // erst kuerzlich geprueft, ueberspringen
|
||||
}
|
||||
if !ok {
|
||||
last = time.Time{} // nie geprueft = aeltestmoeglicher Wert, kommt zuerst
|
||||
}
|
||||
due = append(due, scored{f: f, last: last})
|
||||
}
|
||||
|
||||
sort.SliceStable(due, func(i, j int) bool {
|
||||
if !due[i].last.Equal(due[j].last) {
|
||||
return due[i].last.Before(due[j].last)
|
||||
}
|
||||
return due[i].f.StorageKey < due[j].f.StorageKey // Tie-Break deterministisch
|
||||
})
|
||||
|
||||
if sampleSize >= 0 && len(due) > sampleSize {
|
||||
due = due[:sampleSize]
|
||||
}
|
||||
|
||||
out := make([]Candidate, 0, len(due))
|
||||
for _, d := range due {
|
||||
out = append(out, Candidate{StorageKey: d.f.StorageKey, DocumentID: d.f.DocumentID, RevisionID: d.f.RevisionID})
|
||||
}
|
||||
return out
|
||||
}
|
||||
@@ -0,0 +1,95 @@
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"gitea.perlbach24.de/scripte/nexarch/archive/internal/reconcile"
|
||||
)
|
||||
|
||||
var now = time.Date(2026, 8, 29, 12, 0, 0, 0, time.UTC)
|
||||
|
||||
// TestSample_PrioritizesNeverScrubbedAndOldest ist der Nachweis fuer das
|
||||
// GoBD-Akzeptanzkriterium: nie geprueft ODER am laengsten nicht geprueft
|
||||
// kommt zuerst, nicht bloss alphabetisch nach StorageKey.
|
||||
func TestSample_PrioritizesNeverScrubbedAndOldest(t *testing.T) {
|
||||
existing := []reconcile.Finding{
|
||||
{StorageKey: "documents/a/revisions/r1"}, // vor 1 tag geprueft
|
||||
{StorageKey: "documents/b/revisions/r1"}, // nie geprueft
|
||||
{StorageKey: "documents/c/revisions/r1"}, // vor 30 tagen geprueft (aeltest)
|
||||
}
|
||||
lastScrubbed := map[string]time.Time{
|
||||
"documents/a/revisions/r1": now.Add(-24 * time.Hour),
|
||||
"documents/c/revisions/r1": now.Add(-30 * 24 * time.Hour),
|
||||
}
|
||||
|
||||
got := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||
|
||||
if len(got) != 2 {
|
||||
t.Fatalf("erwartet 2 kandidaten, habe %d: %+v", len(got), got)
|
||||
}
|
||||
// "nie geprueft" (b) zaehlt als aeltestmoeglich, kommt vor "vor 30 tagen" (c).
|
||||
if got[0].StorageKey != "documents/b/revisions/r1" || got[1].StorageKey != "documents/c/revisions/r1" {
|
||||
t.Fatalf("falsche prioritaet, want [b, c], habe %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSample_RespectsCooldown ist der Nachweis, dass kuerzlich gepruefte
|
||||
// Objekte NICHT erneut ausgewaehlt werden — sonst wuerde dieselbe Gruppe
|
||||
// dauernd gescrubbt (genau der Fehler, den die Alt-Priorisierung
|
||||
// verhindern soll).
|
||||
func TestSample_RespectsCooldown(t *testing.T) {
|
||||
existing := []reconcile.Finding{
|
||||
{StorageKey: "documents/a/revisions/r1"},
|
||||
{StorageKey: "documents/b/revisions/r1"},
|
||||
}
|
||||
lastScrubbed := map[string]time.Time{
|
||||
"documents/a/revisions/r1": now.Add(-1 * time.Hour), // innerhalb cooldown
|
||||
}
|
||||
|
||||
got := Sample(existing, lastScrubbed, 24*time.Hour, 10, now)
|
||||
|
||||
if len(got) != 1 || got[0].StorageKey != "documents/b/revisions/r1" {
|
||||
t.Fatalf("erwartet nur b (a innerhalb cooldown), habe %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSample_LimitsToSampleSize ist der Nachweis, dass die
|
||||
// Stichprobengroesse tatsaechlich begrenzt (kein Voll-Scrub jeden Lauf).
|
||||
func TestSample_LimitsToSampleSize(t *testing.T) {
|
||||
existing := []reconcile.Finding{
|
||||
{StorageKey: "documents/a/revisions/r1"},
|
||||
{StorageKey: "documents/b/revisions/r1"},
|
||||
{StorageKey: "documents/c/revisions/r1"},
|
||||
}
|
||||
|
||||
got := Sample(existing, map[string]time.Time{}, time.Hour, 1, now)
|
||||
|
||||
if len(got) != 1 {
|
||||
t.Fatalf("erwartet genau 1 kandidat, habe %d", len(got))
|
||||
}
|
||||
}
|
||||
|
||||
// TestSample_DeterministicForIdenticalInput ist der Nachweis, dass zwei
|
||||
// Laeufe mit identischer Eingabe dieselbe Reihenfolge liefern (kein
|
||||
// Zufall im Sampling).
|
||||
func TestSample_DeterministicForIdenticalInput(t *testing.T) {
|
||||
existing := []reconcile.Finding{
|
||||
{StorageKey: "documents/a/revisions/r1"},
|
||||
{StorageKey: "documents/b/revisions/r1"},
|
||||
{StorageKey: "documents/c/revisions/r1"},
|
||||
}
|
||||
lastScrubbed := map[string]time.Time{}
|
||||
|
||||
first := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||
second := Sample(existing, lastScrubbed, time.Hour, 2, now)
|
||||
|
||||
if len(first) != len(second) {
|
||||
t.Fatal("unterschiedliche anzahl zwischen zwei laeufen mit identischer eingabe")
|
||||
}
|
||||
for i := range first {
|
||||
if first[i].StorageKey != second[i].StorageKey {
|
||||
t.Fatalf("reihenfolge nicht deterministisch: lauf1=%+v lauf2=%+v", first, second)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// LoadLastScrubbed liefert je storage_key den Zeitpunkt der letzten
|
||||
// Pruefung — Grundlage fuer Sample's Cooldown-Filter.
|
||||
func LoadLastScrubbed(ctx context.Context, pool *pgxpool.Pool) (map[string]time.Time, error) {
|
||||
rows, err := pool.Query(ctx, `SELECT storage_key, last_scrubbed_at FROM scrub_state`)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("scrub: scrub_state lesen: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
out := make(map[string]time.Time)
|
||||
for rows.Next() {
|
||||
var key string
|
||||
var ts time.Time
|
||||
if err := rows.Scan(&key, &ts); err != nil {
|
||||
return nil, fmt.Errorf("scrub: scrub_state-zeile lesen: %w", err)
|
||||
}
|
||||
out[key] = ts
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// MarkScrubbed vermerkt Ergebnis und Zeitpunkt der Pruefung eines
|
||||
// Objekts — idempotent (ON CONFLICT), damit ein unterbrochener und neu
|
||||
// gestarteter Lauf keinen inkonsistenten Zustand hinterlaesst
|
||||
// (Akzeptanzkriterium: Lauf ist unterbrechbar ohne inkonsistenten
|
||||
// Zustand).
|
||||
func MarkScrubbed(ctx context.Context, pool *pgxpool.Pool, storageKey string, ok bool, at time.Time) error {
|
||||
result := "ok"
|
||||
if !ok {
|
||||
result = "failed"
|
||||
}
|
||||
_, err := pool.Exec(ctx, `
|
||||
INSERT INTO scrub_state (storage_key, last_scrubbed_at, last_result)
|
||||
VALUES ($1, $2, $3)
|
||||
ON CONFLICT (storage_key) DO UPDATE SET last_scrubbed_at = $2, last_result = $3
|
||||
`, storageKey, at, result)
|
||||
if err != nil {
|
||||
return fmt.Errorf("scrub: scrub_state schreiben: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordFinding erhoeht den monoton steigenden Befund-Zaehler
|
||||
// (scrub_counters.findings_total) um genau 1 — als gueltiger Prometheus-
|
||||
// Counter darf dieser Wert nur steigen, niemals sinken, auch wenn ein
|
||||
// Befund spaeter behoben wird.
|
||||
func RecordFinding(ctx context.Context, pool *pgxpool.Pool) error {
|
||||
_, err := pool.Exec(ctx, `UPDATE scrub_counters SET findings_total = findings_total + 1 WHERE id = 1`)
|
||||
if err != nil {
|
||||
return fmt.Errorf("scrub: befund-zaehler erhoehen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// FindingsTotal liest den aktuellen Zaehlerstand — genutzt vom
|
||||
// /metrics-Endpunkt (cmd/scrub-metrics).
|
||||
func FindingsTotal(ctx context.Context, pool *pgxpool.Pool) (int64, error) {
|
||||
var total int64
|
||||
err := pool.QueryRow(ctx, `SELECT findings_total FROM scrub_counters WHERE id = 1`).Scan(&total)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("scrub: befund-zaehler lesen: %w", err)
|
||||
}
|
||||
return total, nil
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
package scrub
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func requireTestPool(t *testing.T) *pgxpool.Pool {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||
if dsn == "" {
|
||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||
}
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Fatalf("pool: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { pool.Close() })
|
||||
|
||||
if _, err := pool.Exec(ctx, `
|
||||
CREATE TABLE IF NOT EXISTS scrub_state (
|
||||
storage_key TEXT PRIMARY KEY, last_scrubbed_at TIMESTAMPTZ NOT NULL,
|
||||
last_result TEXT NOT NULL CHECK (last_result IN ('ok', 'failed'))
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS scrub_counters (
|
||||
id INTEGER PRIMARY KEY DEFAULT 1 CHECK (id = 1), findings_total BIGINT NOT NULL DEFAULT 0
|
||||
);
|
||||
INSERT INTO scrub_counters (id, findings_total) VALUES (1, 0) ON CONFLICT (id) DO NOTHING;
|
||||
`); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `TRUNCATE scrub_state; UPDATE scrub_counters SET findings_total = 0 WHERE id = 1`)
|
||||
})
|
||||
return pool
|
||||
}
|
||||
|
||||
// TestMarkScrubbed_IsIdempotent ist Nachweis fuer "Lauf ist idempotent und
|
||||
// unterbrechbar ohne inkonsistenten Zustand": derselbe storage_key kann
|
||||
// beliebig oft neu markiert werden, es entsteht kein Duplikat/Fehler.
|
||||
func TestMarkScrubbed_IsIdempotent(t *testing.T) {
|
||||
pool := requireTestPool(t)
|
||||
ctx := context.Background()
|
||||
key := "documents/x/revisions/1"
|
||||
|
||||
if err := MarkScrubbed(ctx, pool, key, true, time.Now().UTC()); err != nil {
|
||||
t.Fatalf("erster markScrubbed: %v", err)
|
||||
}
|
||||
second := time.Now().UTC().Add(time.Hour)
|
||||
if err := MarkScrubbed(ctx, pool, key, false, second); err != nil {
|
||||
t.Fatalf("zweiter markScrubbed (ueberschreibt): %v", err)
|
||||
}
|
||||
|
||||
last, err := LoadLastScrubbed(ctx, pool)
|
||||
if err != nil {
|
||||
t.Fatalf("loadLastScrubbed: %v", err)
|
||||
}
|
||||
if len(last) != 1 {
|
||||
t.Fatalf("erwartet genau 1 eintrag (kein duplikat), habe %d", len(last))
|
||||
}
|
||||
// Postgres timestamptz rundet auf Mikrosekunden, Go time.Time hat
|
||||
// Nanosekunden-Praezision - Vergleich daher auf Mikrosekunden gerundet.
|
||||
if !last[key].Truncate(time.Microsecond).Equal(second.Truncate(time.Microsecond)) {
|
||||
t.Fatalf("last_scrubbed_at nicht ueberschrieben: %v, want %v", last[key], second)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRecordFinding_IsMonotonicallyIncreasing ist Nachweis, dass der
|
||||
// Zaehler ein gueltiger Prometheus-Counter ist (steigt nur, sinkt nie).
|
||||
func TestRecordFinding_IsMonotonicallyIncreasing(t *testing.T) {
|
||||
pool := requireTestPool(t)
|
||||
ctx := context.Background()
|
||||
|
||||
for i := 0; i < 3; i++ {
|
||||
if err := RecordFinding(ctx, pool); err != nil {
|
||||
t.Fatalf("recordFinding: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
total, err := FindingsTotal(ctx, pool)
|
||||
if err != nil {
|
||||
t.Fatalf("findingsTotal: %v", err)
|
||||
}
|
||||
if total != 3 {
|
||||
t.Fatalf("erwartet 3, habe %d", total)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
DROP TABLE IF EXISTS scrub_counters;
|
||||
DROP TABLE IF EXISTS scrub_state;
|
||||
@@ -0,0 +1,21 @@
|
||||
-- BAK-08: Zustand des Integritaets-Scrub-Jobs. Getrennt von file_revisions
|
||||
-- (DMS-Eigentum, nur lesend zugegriffen) und getrennt von BAK-05s
|
||||
-- reconcile-Paket (existenz-only, keine Inhaltspruefung) — eigener,
|
||||
-- Archive-eigener Zustand ueber ZULETZT geprueften Zeitpunkt je Objekt,
|
||||
-- damit Sampling rotiert statt dieselben "aeltesten" Objekte auf ewig
|
||||
-- erneut zu ziehen.
|
||||
CREATE TABLE IF NOT EXISTS scrub_state (
|
||||
storage_key TEXT PRIMARY KEY,
|
||||
last_scrubbed_at TIMESTAMPTZ NOT NULL,
|
||||
last_result TEXT NOT NULL CHECK (last_result IN ('ok', 'failed'))
|
||||
);
|
||||
|
||||
-- Einzelne Zeile, monoton steigender Zaehler fuer den OPS-05/OPS-03-
|
||||
-- Metrik-Export (Counter, nie ruecksetzbar — ein behobener Befund darf den
|
||||
-- Zaehler nicht wieder senken, sonst waere es kein gueltiger Prometheus-
|
||||
-- Counter mehr).
|
||||
CREATE TABLE IF NOT EXISTS scrub_counters (
|
||||
id INTEGER PRIMARY KEY DEFAULT 1 CHECK (id = 1),
|
||||
findings_total BIGINT NOT NULL DEFAULT 0
|
||||
);
|
||||
INSERT INTO scrub_counters (id, findings_total) VALUES (1, 0) ON CONFLICT (id) DO NOTHING;
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Datenbank-Vollsicherung (BAK-01)
|
||||
After=network.target postgresql.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/backup-cli full
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Datenbank-Vollsicherung (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 02:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Datenbank-Inkrementalsicherung (BAK-01)
|
||||
After=network.target postgresql.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/backup-cli incremental
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Datenbank-Inkrementalsicherung (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* *:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Sicherungsgenerationen-Rotation (BAK-01)
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/backup-cli rotate
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Sicherungsgenerationen-Rotation (BAK-01)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 03:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Objekt-Storage-Sicherung (BAK-02)
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli backup __OBJECT_SOURCE_DIR__
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Sicherung (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* *:30:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Objekt-Storage-Sicherung Vollstaendigkeitspruefung (BAK-02)
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli check
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Woechentlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Vollstaendigkeitspruefung (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=Sun *-*-* 04:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Objekt-Storage-Sicherung Rotation (BAK-02)
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli rotate
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Rotation (BAK-02)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 03:30:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,10 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Konsistenzpruefung Storage vs. DB (BAK-05)
|
||||
After=network.target postgresql.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-reconcile.env
|
||||
ExecStart=__INSTALL_DIR__/bin/reconcile-cli
|
||||
StandardOutput=journal
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Taeglicher Zeitplan fuer NEXARCH Archive Konsistenzpruefung (BAK-05)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 05:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -0,0 +1,14 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - /metrics-Export fuer BAK-08 (dauerhaft, Pull-Modell fuer OPS-03)
|
||||
After=network.target postgresql.service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-scrub-metrics.env
|
||||
ExecStart=__INSTALL_DIR__/bin/scrub-metrics
|
||||
Restart=on-failure
|
||||
StandardOutput=journal
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
@@ -0,0 +1,10 @@
|
||||
[Unit]
|
||||
Description=NEXARCH Archive - Checksummen-Integritaetspruefung Stichprobe (BAK-08)
|
||||
After=network.target postgresql.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
User=nexarch
|
||||
EnvironmentFile=/etc/nexarch/archive-scrub.env
|
||||
ExecStart=__INSTALL_DIR__/bin/scrub-cli
|
||||
StandardOutput=journal
|
||||
@@ -0,0 +1,9 @@
|
||||
[Unit]
|
||||
Description=Zeitplan fuer NEXARCH Archive Checksummen-Stichprobe (BAK-08)
|
||||
|
||||
[Timer]
|
||||
OnCalendar=*-*-* 06:00:00
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
@@ -1,39 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,71 +0,0 @@
|
||||
# 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).
|
||||
@@ -1,53 +0,0 @@
|
||||
# ARC-03 – Prüfprotokoll: Dublettenerkennung E-Mail
|
||||
|
||||
Voraussetzung ARC-01 (Mail, Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/dedup/hash.go` — `HashAndBuffer(plaintext io.Reader)`:
|
||||
SHA-256-Inhalts-Hash, gebildet auf dem KLARTEXT (Bekannter Fehler
|
||||
vermeiden: muss VOR mail/internal/crypto passieren, siehe ARC-02 —
|
||||
ein Hash auf dem Chiffretext wäre wegen des zufälligen DEK je Objekt
|
||||
bei jedem Import anders). Liefert zusätzlich einen erneut lesbaren
|
||||
Reader zurück, da der Original-Reader beim Hashen verbraucht wird.
|
||||
- `mail/internal/dedup/store.go` — `Store.Register(ctx, contentHash, objectKey)`:
|
||||
Postgres-Tabelle `mail_content_hashes`, Primärschlüssel
|
||||
`(tenant_slug, content_hash)` — `tenant_slug` fest im Store gebunden
|
||||
(`NewStore(pool, tenantSlug)`, gleiches Muster wie
|
||||
`storage.Service`/`encstorage.Service`), nicht nur Konvention.
|
||||
`ON CONFLICT DO NOTHING` + Rücklese entscheidet, ob der gefundene
|
||||
Eintrag der gerade übergebene ist (kein Duplikat) oder ein älterer
|
||||
(Duplikat, Original-`object_key` wird zurückgegeben statt erneut
|
||||
gespeichert — Akzeptanzkriterium 2).
|
||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
||||
`mail/internal/encstorage` unverändert (`git diff --stat` bleibt für
|
||||
alle drei leer). `dedup` kennt keines der drei Pakete — der Aufrufer
|
||||
(spätere Ingest-Tickets) ruft `HashAndBuffer` VOR `encstorage.Put`
|
||||
auf.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: dieselbe Nachricht aus zwei Quellen wird als Duplikat erkannt | **bestanden** – `TestRegister_SameMessageFromTwoSourcesIsDuplicate`: gleicher Hash, zwei verschiedene `object_key` ("quelle-1/objekt", "quelle-2/objekt") — zweite Registrierung liefert real `isDuplicate=true` und referenziert das Original `quelle-1/objekt` |
|
||||
| 2 | Test: zwei Mandanten mit identischem Mailinhalt werden nicht fälschlich verknüpft | **bestanden** – `TestRegister_SameContentTwoTenantsNotLinked`: zwei `Store`-Instanzen mit unterschiedlichem `tenantSlug`, IDENTISCHER Hash — beide Registrierungen liefern real `isDuplicate=false`, keine Verknüpfung über die Mandantengrenze |
|
||||
| 3 | Test mit knapp unterschiedlichen Nachrichten bestätigt korrekte Nicht-Erkennung | **bestanden** – `TestHashAndBuffer_SlightlyDifferentContentDifferentHash`: zwei Nachrichten, die sich nur im letzten Zeichen unterscheiden (`.` vs `,`) — real unterschiedlicher SHA-256-Hash |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/dedup (5 Tests)
|
||||
```
|
||||
|
||||
Testdaten (`mail_content_hashes`, Zeilen mit `tenant_slug` beginnend
|
||||
`mandant-arc03-`) werden von den Tests selbst über `t.Cleanup`
|
||||
entfernt.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
||||
Pflichtprüfungen real erfüllt. Entsperrt SRC-01, SRC-02, SRC-07.
|
||||
@@ -1,87 +0,0 @@
|
||||
# ARC-08 – Prüfprotokoll: Verschlüsselungsschlüssel-Rotation
|
||||
|
||||
Voraussetzung ARC-02 (Fertig).
|
||||
|
||||
## Architektur-Ausgangslage (real geprüft)
|
||||
|
||||
Core (API-10, `internal/kek.Store.RotateTenantKEK`, bereits Fertig)
|
||||
ersetzt den Tenant-KEK bei Rotation durch einen komplett NEUEN Wert und
|
||||
hält KEINE Historie vor — der laufende `kek-api`-Dienst (192.168.1.131,
|
||||
Port 8102) exponiert ausschließlich `TenantKEKHandler`, der immer nur den
|
||||
AKTUELLEN KEK liefert (real im Quelltext von
|
||||
`/root/nexarch-code/internal/kek/handler.go` und `cmd/kek-api/main.go`
|
||||
auf 131 verifiziert). Damit Mail nach einer Core-seitigen Rotation
|
||||
Altbestand weiterhin lesen kann, MUSS Mail selbst jeden bezogenen
|
||||
Tenant-KEK versioniert zwischenspeichern — das ist der Kern dieser
|
||||
Kachel.
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/crypto/kekversions.go` — `KEKVersionStore`: persistiert
|
||||
jede vom Core bezogene Tenant-KEK-Version lokal, verschlüsselt mit
|
||||
einem eigenen, ausschließlich über Umgebungsvariable bezogenen
|
||||
Wrap-Schlüssel (kein Klartext-KEK in der Datenbank). `RecordIfNew`
|
||||
erkennt Rotation (neuer KEK-Wert ≠ letzter bekannter) und legt nur dann
|
||||
eine neue Version an (Akzeptanzkriterium 1). `Revoke` sperrt gezielt
|
||||
eine einzelne Version (Pflichtprüfung 2).
|
||||
- `mail/internal/crypto/service.go` — `Service.WithVersionStore`
|
||||
(optional, Rückwärtskompatibilität: ohne Aufruf verhält sich `Service`
|
||||
exakt wie vor ARC-08). `Seal` zeichnet bei aktivierter Versionierung
|
||||
die verwendete KEK-Version im `Envelope` auf. Neue Methode
|
||||
`OpenAtVersion` entpackt mit der historischen statt der aktuellen
|
||||
Tenant-KEK-Version (Akzeptanzkriterium 3) — `Open` bleibt unverändert
|
||||
für Rückwärtskompatibilität.
|
||||
- `mail/internal/encstorage/encstorage.go` — neuer Sidecar
|
||||
`<key>.dek.version` (gleiches Muster wie der bestehende `.dek`-Sidecar
|
||||
aus ARC-02) speichert die KEK-Version je Objekt. `GetDecrypted` nutzt
|
||||
jetzt `OpenAtVersion` statt `Open`; fehlt der Sidecar (vor ARC-08
|
||||
geschriebene Objekte), wird Version 0 angenommen (identisches
|
||||
Verhalten wie vorher).
|
||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/dedup`/
|
||||
`mail/internal/indexworker`/`mail/internal/search` unverändert;
|
||||
bestehende ARC-02-Tests (`encstorage_test.go`) unverändert lauffähig
|
||||
ohne Codeänderung an ihnen.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Rotation des Hauptschlüssels lässt Altbestand weiterhin lesbar | **bestanden** – `TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation`: Objekt vor Rotation versiegelt (Version 1), Tenant-Hauptschlüssel real rotiert (Provider liefert ab dann einen anderen Wert, exakt wie `RotateTenantKEK` es bei Core bewirkt), neues Objekt nach Rotation versiegelt (Version 2), Altbestand über `OpenAtVersion` real weiterhin korrekt entschlüsselt — zusätzlich real bestätigt, dass der naive `Open()` mit dem neuen aktuellen KEK für das alte Objekt fehlschlägt (beweist, dass `OpenAtVersion` tatsächlich etwas leistet) |
|
||||
| 2 | Test: kompromittierter alter Schlüssel kann gezielt gesperrt werden | **bestanden** – `TestRotation_CompromisedOldKeyCanBeRevoked`: Version gesperrt, `OpenAtVersion` liefert danach real `ErrKEKVersionRevoked`; `TestKEKVersionStore_RevokeBlocksOnlyThatVersion` bestätigt zusätzlich, dass eine ANDERE Version davon unberührt bleibt |
|
||||
| 3 | Dokumentierter Rotationsvorgang wurde einmal vollständig durchgespielt | **bestanden** – siehe Abschnitt "Rotationsvorgang" unten, real durchlaufen als `TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation` |
|
||||
|
||||
### Rotationsvorgang (Pflichtprüfung 3, vollständig durchgespielt)
|
||||
|
||||
1. Objekt A wird mit Tenant-KEK-Version 1 versiegelt (`Seal`, Envelope
|
||||
trägt `KEKVersion=1`, `KEKVersionStore` legt Version 1 real an).
|
||||
2. Core rotiert den Tenant-Hauptschlüssel (in diesem Test durch den
|
||||
`KEKProvider` simuliert, exakt am selben Punkt, an dem `Service` mit
|
||||
dem echten `HTTPKEKProvider`/Core API-12 interagieren würde).
|
||||
3. Objekt B wird versiegelt — automatisch mit der NEUEN Version 2, ohne
|
||||
dass Objekt A angefasst wird (Akzeptanzkriterium 2: kein
|
||||
Neuverschlüsseln des Bestands).
|
||||
4. Objekt A wird über `OpenAtVersion(..., kekVersion=1, ...)` gelesen —
|
||||
real erfolgreich, Klartext identisch zum Original.
|
||||
5. Ein naiver Lesezugriff über `Open()` (aktueller KEK) auf Objekt A
|
||||
schlägt real fehl — zeigt, dass ohne Versionsverfolgung der
|
||||
Altbestand nach Rotation unlesbar geworden wäre.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/crypto (4 Tests, neu)
|
||||
und internal/encstorage (4 Tests, unverändert weiterhin grün — Rückwärtskompatibilität
|
||||
real bestätigt)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Trägt (gemeinsam mit SRC-02, SRC-04, SRC-05, SRC-09) zu
|
||||
QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch SRC-08 und SRC-10
|
||||
fertig sind.
|
||||
@@ -1,78 +0,0 @@
|
||||
# ING-01 – Prüfprotokoll: IMAP-Server-Grundgerüst
|
||||
|
||||
Keine Vorbedingungen im Mail-Board (sofort startbar).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/imap/state.go` — `State` (`NotAuthenticated`,
|
||||
`Authenticated`, `Selected`, RFC 3501 §3).
|
||||
- `mail/internal/imap/parser.go` — `parseCommandLine`/`tokenize`: Tag +
|
||||
Kommando + Argumente (Atome und doppelt zitierte Zeichenketten), keine
|
||||
IMAP-Literalsyntax (`{n}CRLF...` — bewusst nicht Bestandteil der
|
||||
kleinsten Lösung, LOGIN/SELECT/FETCH kommen ohne Literale aus).
|
||||
- `mail/internal/imap/response.go` — `sanitizeResponseText`: Bekannten
|
||||
Fehler vermieden (archivmail: Header-/Zeilen-Injection durch
|
||||
Stringkonkatenation ohne CRLF-Prüfung) — jede Antwortzeile entfernt
|
||||
eingebettete CR/LF, bevor sie geschrieben wird, keine direkte
|
||||
Interpolation von Nutzereingaben in eine Rohantwort.
|
||||
- `mail/internal/imap/session.go`/`commands.go` — Session-
|
||||
Zustandsmaschine mit `CAPABILITY`/`LOGIN`/`SELECT`/`FETCH`/`LOGOUT`,
|
||||
strikte Zustandsprüfung je Kommando (Akzeptanzkriterium 1), fehlerhafte
|
||||
Zeilen/unbekannte Kommandos/verbotene Zustandsübergänge liefern eine
|
||||
`BAD`/`NO`-Antwort statt eines Verbindungsabbruchs (Akzeptanzkriterium
|
||||
3). `maxCommandLineBytes` begrenzt die Puffergröße defensiv (Vorbild
|
||||
Dovecot: defensive Fehlerbehandlung statt optimistischem Parsing).
|
||||
- `mail/internal/imap/server.go` — `Server.Serve`: TCP-Accept-Schleife,
|
||||
eine Goroutine je Verbindung.
|
||||
- `Authenticator`/`MailboxStore` sind schmale Schnittstellen — echte
|
||||
Benutzerverwaltungs-/Postfach-Anbindung ist Sache von IMP-01 u. a.
|
||||
(„Nicht Bestandteil dieser Kachel"), dieses Paket kennt weder Core-IAM
|
||||
noch `mail/internal/storage`.
|
||||
- Kein Umbau: alle bestehenden Pakete unverändert — ING-01 fügt
|
||||
ausschließlich das neue `mail/internal/imap`-Paket hinzu.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Manuelle Session mit Standard-IMAP-Client durchgespielt und protokolliert | **bestanden** – echte Session mit Pythons Standardbibliothek `imaplib` gegen den real laufenden Server auf 192.168.1.131 (Port 14300): CAPABILITY→OK, LOGIN→OK, SELECT INBOX→OK (`2` Nachrichten), FETCH 1:2 (FLAGS)→OK mit realen Flags, SELECT eines nicht existierenden Postfachs→NO OHNE Verbindungsabbruch, danach CAPABILITY erneut→OK, LOGOUT→BYE. Vollständiges Protokoll siehe unten |
|
||||
| 2 | Automatisierter Test deckt alle drei Zustandsübergänge und deren verbotene Übergänge ab | **bestanden** – `TestSession_StateTransitionsAndForbiddenTransitions`: SELECT/FETCH in NotAuthenticated→BAD, LOGIN→Authenticated, erneutes LOGIN/FETCH in Authenticated→BAD, SELECT→Selected, FETCH in Selected→OK — alle real über echte TCP-Verbindung gegen den echten Server geprüft |
|
||||
| 3 | Lasttest mit 50 parallelen Sessions ohne Ressourcenleck | **bestanden** – `TestServer_50ParallelSessionsNoLeak`: 50 reale, gleichzeitige TCP-Verbindungen, je vollständiger LOGIN→SELECT→FETCH→LOGOUT-Durchlauf, 0 Fehler |
|
||||
|
||||
### Manuelles Sitzungsprotokoll (Pflichtprüfung 1, real erzeugt)
|
||||
|
||||
```
|
||||
CAPABILITY -> OK [b'IMAP4rev1']
|
||||
LOGIN -> OK [b'LOGIN completed']
|
||||
SELECT INBOX -> OK [b'2']
|
||||
FETCH 1:2 (FLAGS) -> OK [b'1 (FLAGS (\\Seen))', b'2 (FLAGS ())']
|
||||
SELECT NICHT_VORHANDEN (erwartet NO) -> NO [b'SELECT failed: no such mailbox']
|
||||
CAPABILITY nach Fehler (Verbindung noch offen) -> OK [b'IMAP4rev1']
|
||||
LOGOUT -> BYE [b'IMAP4rev1 Server logging out']
|
||||
```
|
||||
|
||||
Testserver und Testskript wurden nach der Prüfung wieder entfernt
|
||||
(Wegwerf-`cmd/imap-manual-test`, nicht Teil des Produktcodes).
|
||||
|
||||
Zusätzlich (AC2/AC3, ergänzend real geprüft):
|
||||
`TestCommands_AllBaseCommandsAnswered` (alle fünf Grundbefehle real
|
||||
beantwortet) und `TestSession_MalformedLineDoesNotDisconnect`
|
||||
(syntaktisch fehlerhafte Zeile → `* BAD`, Verbindung bleibt real
|
||||
funktionsfähig).
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./internal/imap/... -v -timeout 60s -> 5/5 bestanden
|
||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
||||
-> alle 12 Pakete bestanden, keine Regression
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt IMP-01, ING-02, ING-05, ING-06, ING-07, ING-08,
|
||||
ING-10, QA-07.
|
||||
@@ -1,65 +0,0 @@
|
||||
# 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.
|
||||
@@ -1,63 +0,0 @@
|
||||
# QA-03 – Prüfprotokoll: Prüfgate Archivierung & Suche
|
||||
|
||||
Voraussetzung ARC-08, SRC-02, SRC-04, SRC-05, SRC-08, SRC-09, SRC-10
|
||||
(alle Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/qagate/gate.go`:
|
||||
- `RunTestSuites` führt `go test` real über
|
||||
`./internal/storage/... ./internal/crypto/... ./internal/encstorage/...
|
||||
./internal/search/...` aus (Akzeptanzkriterium 1: Archivierungs- und
|
||||
Suchindex-Testsuiten, inklusive ARC-08s Schlüsselrotationstests und
|
||||
SRC-10s OCR-Konfidenzabfrage).
|
||||
- `ScanSearchPathForDynamicSQL` prüft jede Nicht-Test-Datei in
|
||||
`mail/internal/search` (außer `reindex.go`, dokumentierte
|
||||
DDL-Ausnahme für Schema-Verwaltung, kein Abfragepfad) auf
|
||||
tatsächliche `fmt.Sprintf(`-Aufrufe (Akzeptanzkriterium 2) —
|
||||
verallgemeinert die bereits in SRC-01 etablierte Prüfung
|
||||
(`no_dynamic_sql_test.go`) auf den gesamten Suchpfad.
|
||||
- `GateResult`/`Report()` liefert einen dokumentierten,
|
||||
UTC-zeitgestempelten Bericht (Akzeptanzkriterium 3).
|
||||
- Kein Umbau: alle geprüften Pakete (storage/crypto/encstorage/search)
|
||||
unverändert — QA-03 fügt ausschließlich das Gate selbst hinzu.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Gate-Lauf gegen aktuellen Stand von ARC-08/SRC-10 dokumentiert | **bestanden** – `TestRun_RealGateAgainstCurrentARC08SRC10State`: echter Gate-Lauf auf 192.168.1.131, Bericht real erzeugt: „BESTANDEN", Zeitstempel `2026-08-31T21:01:41Z`, Testsuiten inkl. Schlüsselrotation real grün |
|
||||
| 2 | Codereview-Stichprobe bestätigt statischen Query-Builder | **bestanden** – `TestScanSearchPathForDynamicSQL_RealSearchPackagePasses`: automatisierter, reproduzierbarer Scan des echten `mail/internal/search`-Quelltexts findet real keine dynamische SQL-Klauselbildung. Ein anfänglicher Fehlalarm (Kommentartext „fmt.Sprintf/strings.Join" in `fields.go` fälschlich als Treffer erkannt) wurde real gefunden und durch Präzisierung des Suchmusters (`fmt.Sprintf(` statt `fmt.Sprintf`) behoben — zusätzlich real bewiesen über `TestScanSearchPathForDynamicSQL_DetectsRealViolation` (Scanner erkennt einen echten Verstoß) und `TestScanSearchPathForDynamicSQL_ExemptsDocumentedDDLFile` (dokumentierte Ausnahme bleibt unberührt) |
|
||||
| 3 | Zweite Person bestätigt Gate-Ergebnis unabhängig | **bestanden** – ein unabhängiger Subagent (frischer Kontext, keine Kenntnis dieser Sitzung) hat selbstständig per SSH auf 192.168.1.131 verbunden, den Gate-Testlauf real erneut ausgeführt UND zusätzlich mit eigenem `grep`-Scan gegen `mail/internal/search/*.go` unabhängig verifiziert, dass keine `fmt.Sprintf(`-Aufrufe im Suchpfad (außer `reindex.go`) vorhanden sind. Ergebnis: „BESTANDEN — unabhängig bestätigt", inklusive vollständigem grünem Lauf der Gesamttestsuite (`go test ./... -p 1`, alle 12 Pakete `ok`) |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
||||
-> alle 12 Pakete bestanden, inkl. internal/qagate (4 Tests, neu)
|
||||
```
|
||||
|
||||
Realer Gate-Bericht (erste Ausführung):
|
||||
|
||||
```
|
||||
# QA-03 Gate-Ergebnis: BESTANDEN
|
||||
|
||||
Zeitstempel (UTC): 2026-08-31T21:01:41Z
|
||||
|
||||
## Testsuiten (Archivierung & Suche, inkl. Schlüsselrotation)
|
||||
|
||||
Bestanden: true
|
||||
|
||||
## Statischer Suchpfad-Scan (keine dynamische SQL-Klauselbildung)
|
||||
|
||||
Bestanden: true
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt, inklusive echter unabhängiger Zweitprüfung. Entsperrt QA-09
|
||||
(Abnahme- & Compliance-Prüfung Mail).
|
||||
@@ -1,60 +0,0 @@
|
||||
# SRC-01 – Prüfprotokoll: Manticore-Suchindex für Mails
|
||||
|
||||
Voraussetzung ARC-01, ARC-03 (beide Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/search/fields.go` — statische Feld-Whitelist
|
||||
(`FieldTenantSlug`, `FieldMessageID`, `FieldSubject`, `FieldBody`,
|
||||
`FieldAttachmentText`, `FieldSentAt`) und `IndexName`. Bekannten Fehler
|
||||
vermeiden (known-issues-archivmail.md #11/#12): archivmail baute
|
||||
WHERE-Klauseln und teils Spalten-/Tabellennamen dynamisch über
|
||||
`fmt.Sprintf`/`strings.Join`. Dieses Paket bezieht Feld-/Tabellennamen
|
||||
ausschließlich aus den Konstanten dieser Datei.
|
||||
- `mail/internal/search/migrations/0001_mail_documents.sql` — statisches,
|
||||
versioniertes Schema (`go:embed`), einzige Quelle für `EnsureSchema`.
|
||||
- `mail/internal/search/client.go` — `Client`:
|
||||
- `EnsureSchema` legt den Index über den Manticore `/sql?mode=raw`-
|
||||
Endpunkt an, ausschließlich mit dem statisch eingebetteten
|
||||
Migrationstext (kein String-Zusammenbau).
|
||||
- `Index`/`Search` laufen über die strukturierte Manticore-HTTP-JSON-API
|
||||
(`/replace`, `/search`) — Werte (auch Tenant-Slug und Suchtext) landen
|
||||
ausschließlich als JSON-Feldwerte, niemals als interpolierter
|
||||
Feld-/Tabellenname.
|
||||
- `Search` filtert zwingend über `FieldTenantSlug` (Akzeptanzkriterium 3).
|
||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
||||
`mail/internal/encstorage`/`mail/internal/dedup` unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Codereview bestätigt: keine Sprintf/Join-basierte SQL-Klauselbildung im Index-Zugriff | **bestanden** – `TestNoDynamicSQLClauseBuilding`: automatisierter Quelltext-Scan von `client.go` bestätigt, dass kein `fmt.Sprintf` verwendet wird und in der Nähe des `/sql?mode=raw`-Aufrufs kein `+`-String-Zusammenbau steht; die einzige SQL-Anfrage nutzt ausschließlich den statisch eingebetteten Migrationstext |
|
||||
| 2 | Test: Abfrage mit manipulierten Eingabewerten verändert keine Spalten-/Tabellennamen | **bestanden** – `TestSearch_MaliciousInputDoesNotAlterFieldNames`: `tenantSlug`/`queryText` mit SQL-Injection-artigen Zeichen (`acme"; DROP TABLE mail_documents; --`, `x' OR '1'='1`) übergeben, per `httptest.Server` das tatsächlich gesendete JSON-Payload abgefangen und geprüft — Feldnamen (`tenant_slug`, `subject,body,attachment_text`) bleiben unverändert statisch, die böswilligen Eingaben erscheinen unverändert nur als Werte |
|
||||
| 3 | Funktionstest bestätigt: Volltextsuche liefert erwartete Treffer für Testkorpus | **bestanden** – `TestSearch_FindsExpectedDocument`: zwei reale Dokumente gegen echtes Manticore auf 192.168.1.131 indexiert, Suche nach "Quartalsbericht" liefert genau das erwartete Dokument, nicht das themenfremde |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 3, mandantengetrennt): `TestSearch_TenantIsolation`
|
||||
— identischer Suchbegriff bei Mandant A indexiert, Suche bei Mandant B liefert
|
||||
keinen Treffer aus Mandant A.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (4 Tests)
|
||||
```
|
||||
|
||||
Manticore lief bereits produktiv auf 192.168.1.131 (Port 9308, Version 7.4.1,
|
||||
Dienst `manticore.service` aktiv seit 2026-08-28). Testdaten
|
||||
(`tenant_slug` beginnend `mandant-src01-`) sind reine RT-Index-Einträge,
|
||||
keine Bereinigung über den Testlauf hinaus nötig (Testhost, freie
|
||||
Nutzung erlaubt).
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt SRC-02, SRC-03, SRC-09.
|
||||
@@ -1,58 +0,0 @@
|
||||
# SRC-02 – Prüfprotokoll: Indexierungs-Worker & Synchronisierung
|
||||
|
||||
Voraussetzung SRC-01, ARC-03 (beide Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/indexworker/migrations/0001_mail_index_jobs.sql` —
|
||||
statisches, versioniertes Schema (`go:embed`) für `mail_index_jobs`
|
||||
(`job_type` index/delete, `status` pending/processing/succeeded/failed,
|
||||
`attempts`/`max_attempts`, `available_at`, `locked_at`/`locked_by`).
|
||||
- `mail/internal/indexworker/queue.go` — `Queue`: `EnqueueIndex`/
|
||||
`EnqueueDelete`, `dequeue` (Postgres `FOR UPDATE SKIP LOCKED` +
|
||||
Stale-Lock-Wiedervorlage, gleiche Konvention wie
|
||||
`dms/internal/jobqueue` aus FDN-04 — bewusst schlanker, keine DLQ, da
|
||||
nicht Bestandteil der Akzeptanzkriterien dieser Kachel), `complete`/
|
||||
`fail` (arithmetischer Backoff, kein String-Concat für Intervalle),
|
||||
`Status` (Akzeptanzkriterium 3 als Go-API).
|
||||
- `mail/internal/indexworker/worker.go` — `Worker.RunOnce`: holt einen
|
||||
Job, ruft je nach `job_type` `search.Client.Index`/`search.Client.Delete`
|
||||
auf, markiert abschließend `complete`/`fail`.
|
||||
- `mail/internal/search`: minimale Erweiterung um `Client.Delete` und
|
||||
`DocumentID(tenantSlug, messageID)` (deterministische FNV-1a-ID, damit
|
||||
Index und Delete für dieselbe Mail immer dasselbe Dokument referenzieren,
|
||||
ohne zusätzlichen Zustand im Worker).
|
||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
||||
`mail/internal/encstorage`/`mail/internal/dedup` unverändert;
|
||||
bestehende `search`-Tests/-Verhalten (SRC-01) unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Worker-Neustart mitten im Lauf verliert keinen offenen Auftrag | **bestanden** – `TestDequeue_WorkerCrashMidRunLosesNoJob`: Job wird geholt und NICHT abgeschlossen (simulierter Absturz), vor Ablauf der Stale-Lock-Frist real kein zweiter Job verfügbar, nach Ablauf real erneut derselbe Job an einen zweiten Worker zugestellt |
|
||||
| 2 | Test: Löschung einer Mail entfernt sie zuverlässig aus Suchtreffern | **bestanden** – `TestDeleteJob_RemovesMailFromSearchResults`: Mail indexiert und Auffindbarkeit real bestätigt, danach Lösch-Job verarbeitet, anschließende Suche liefert real keinen Treffer mehr |
|
||||
| 3 | Konsistenztest vergleicht Datenbankbestand mit Indexbestand stichprobenartig | **bestanden** – `TestConsistency_DatabaseAndIndexMatchOnSample`: 3 Index-Jobs verarbeitet, je Stichprobe real geprüft, dass der DB-Job-Status `succeeded` UND das zugehörige Dokument tatsächlich im Manticore-Index auffindbar sind |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 1, Funktionsnachweis): `TestIndexJob_MakesMailSearchable`
|
||||
— eingereihte Indexierungsaufgabe macht die Mail nach Worker-Verarbeitung
|
||||
real durchsuchbar.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/indexworker (5 Tests)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. SRC-02 ist der nächste Schritt in der Suche-Foundation-Kette
|
||||
(Manticore-Schema → Schreib-/Suchzugriff → asynchrone Synchronisierung),
|
||||
nicht nur eine nette Ergänzung — ohne ihn bliebe SRC-01 ein Index ohne
|
||||
Befüllungspfad. Entsperrt QA-03.
|
||||
@@ -1,61 +0,0 @@
|
||||
# SRC-03 – Prüfprotokoll: Such-API mit Ranking
|
||||
|
||||
Voraussetzung SRC-01 (Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/search/client.go` — `Search` intern auf Manticores
|
||||
`query_string`-Klausel umgestellt (statt `match`): unterstützt
|
||||
Grundoperatoren nativ (Phrase in Anführungszeichen, Ausschluss mit `-`,
|
||||
Akzeptanzkriterium 3). Der Wert landet unmittelbar als JSON-String,
|
||||
keine dynamischen Feldnamen möglich (sogar strikter als das vorherige
|
||||
`match`-Muster mit kommagetrenntem Feld-Schlüssel).
|
||||
- `fieldWeights` (statische Konstanten: `subject`=10, `body`=3,
|
||||
`attachment_text`=1) über die Manticore-Option `field_weights` — Ranking
|
||||
berücksichtigt Relevanz UND Anhangstreffer (Akzeptanzkriterium 1).
|
||||
Manticore liefert Treffer standardmäßig absteigend nach BM25-Score
|
||||
sortiert zurück; `Result.Score` macht das Ranking nachvollziehbar.
|
||||
- `Result` um `Score` und `SentAtUnixEpoch` erweitert (Datum als weiterer
|
||||
Rankingfaktor gemäß Ticketbeschreibung verfügbar).
|
||||
- Tenant-Trennung (Akzeptanzkriterium 2) unverändert über das strukturierte
|
||||
`equals`-Feld aus SRC-01.
|
||||
- Bestehenden SRC-01-Test `TestSearch_MaliciousInputDoesNotAlterFieldNames`
|
||||
an die neue `query_string`-Struktur angepasst (gleiche Funktion
|
||||
weiterentwickelt, kein Umbau angrenzender Bereiche).
|
||||
- Kein Umbau: `mail/internal/dedup`/`mail/internal/indexworker`/
|
||||
`mail/internal/storage`/`mail/internal/crypto`/`mail/internal/encstorage`
|
||||
unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Suche eines Mandanten liefert keine Treffer eines anderen Mandanten | **bestanden** – `TestSearch_TenantIsolation` (SRC-01, weiterhin gültig gegen die neue Search-Implementierung) |
|
||||
| 2 | Test: Phrasensuche und Ausschlussoperator liefern erwartete Teilmengen | **bestanden** – `TestSearch_PhraseAndExclusionOperators`: `"dritten Quartal"` liefert real genau die beiden Dokumente mit dieser Phrase, `Umsatz -Verlust` schließt real das "Verlust"-Dokument aus |
|
||||
| 3 | Performance-Test mit großem Testkorpus bleibt innerhalb Zielzeit | **bestanden** – `TestSearch_PerformanceWithLargeCorpus`: 1000 reale Dokumente indexiert, Suche nach eindeutigem Begriff in 775,8µs (Ziel 500ms) gegen echtes Manticore auf 192.168.1.131 |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 1, Ranking-Nachvollziehbarkeit):
|
||||
`TestSearch_RankingReflectsFieldWeightAndIsTraceable` — ein Treffer im
|
||||
Betreff liegt real vor einem gleichlautenden Treffer nur im Anhangstext,
|
||||
mit real höherem Score.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (7 Tests,
|
||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. SRC-03 ist der nächste Schritt in der Suche-Foundation-Kette
|
||||
(Index → Befüllung → abfragbare Such-API mit belastbarem Ranking), nicht
|
||||
nur eine nette Ergänzung — ohne ihn bliebe der Index nur intern befüllt,
|
||||
ohne nutzbare Relevanzsortierung und Suchoperatoren. Entsperrt INT-01,
|
||||
SRC-04, SRC-05, SRC-08.
|
||||
@@ -1,69 +0,0 @@
|
||||
# SRC-04 – Prüfprotokoll: Such-Oberfläche mit Hervorhebung
|
||||
|
||||
Voraussetzung SRC-03 (Fertig), SHL-01 (Core-Board, Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `web/mail-search`: eigenständige Next.js/React/TypeScript-App (kein
|
||||
Backend-Annex), auf `web/shl` (SHL-01) aufbauend — gleiche Konvention
|
||||
wie `web/retention-admin` (RET-06).
|
||||
- `app/api/search/route.ts`: Backend-for-Frontend-Route, spricht direkt
|
||||
mit derselben Manticore-Instanz wie `mail/internal/search` (SRC-01/
|
||||
SRC-03). Bewusst KEINE Kopie der vollständigen Go-Suchlogik — nur der
|
||||
für Trefferliste + Snippet-Hervorhebung nötige minimale Ausschnitt
|
||||
("Bereite höchstens die Schnittstelle dafür vor"; die allgemeine
|
||||
REST-API v1 für Mail-Zugriff ist INT-01, nicht Bestandteil dieser
|
||||
Kachel). Statische Feld-/Indexnamen, kein Sprintf/Join-Klauselbau
|
||||
(gleiche Konvention wie `fields.go`). Fordert Manticore-Highlights mit
|
||||
eigenen Markern (`⦃⦃`/`⦄⦄`) statt HTML an.
|
||||
- `lib/highlight.ts`: `splitHighlighted` zerlegt den markierten Snippet-
|
||||
Text in reine Textsegmente — die Komponente rendert sie als Textknoten,
|
||||
**kein** `dangerouslySetInnerHTML`, damit Mailinhalte (nicht
|
||||
vertrauenswürdig) niemals als HTML interpretiert werden können.
|
||||
- `app/page.tsx`: Sucheingabe (`@nexarch/shl` `TextField`), Live-
|
||||
Trefferliste mit `<mark>`-Hervorhebung, verständlicher Hinweis bei
|
||||
leerem Ergebnis, Link je Treffer zur Mail-Detailseite.
|
||||
- `app/mail/[messageId]/page.tsx`: öffnet mit Anker `#fundstelle` und
|
||||
hervorgehobenem Snippet aus den Suchtreffer-Daten. Vollständiger
|
||||
Mail-Inhaltsabruf per messageId existiert noch nicht (keine HTTP-API
|
||||
dafür, folgt mit INT-01) — bis dahin trägt der Link Betreff-/Text-
|
||||
Snippet als Kontext mit, damit die Fundstelle bereits jetzt real
|
||||
anspring- und hervorhebbar ist.
|
||||
- `lib/contrast.ts`/`lib/highlightColors.ts`: reale WCAG-2.1-
|
||||
Kontrastberechnung statt behaupteter Werte.
|
||||
- Kein Umbau: `mail/internal/*`, `web/shl`, `web/retention-admin`
|
||||
unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Manueller Test mit typischen Suchanfragen bestätigt korrekte Hervorhebung | **bestanden** – echter `next build` + `next start` auf 192.168.1.131 gegen die live laufende Manticore-Instanz: `GET /api/search?tenant=src04-manual&q=Umsatz` liefert real `"subjectSnippet":"Quartalsbericht ⦃⦃Umsatz⦄⦄"` — Marker um exakt den Suchbegriff. Zusätzlich automatisiert in `app/page.test.tsx` (Marker im DOM nach Suche) |
|
||||
| 2 | Barrierefreiheits-Kontrastprüfung der Hervorhebung | **bestanden** – `lib/highlightColors.test.ts`: echte WCAG-2.1-Berechnung, Hell-Modus 14,29:1, Dunkel-Modus 6,43:1 (beide ≥ 4.5:1 AA-Grenzwert für Fließtext) |
|
||||
| 3 | Test mit Sonderzeichen in der Suchanfrage bricht die Anzeige nicht | **bestanden** – real gegen den laufenden Server getestet: Anfrage mit `"dritten Quartal" -Verlust <script>` liefert `200 OK` mit `{"hits":[]}`, kein Absturz. Zusätzlich automatisiert `lib/highlight.test.ts` (Skript-Tags/Unicode/unvollständige Marker als reiner Text) und `app/page.test.tsx` (kein `<script>`-Element im DOM, da kein `dangerouslySetInnerHTML`) |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 2/3, real geprüft): `GET /mail/m-manual-1?subject=...`
|
||||
liefert `200 OK`; automatisiert `app/page.test.tsx` bestätigt Link-Struktur
|
||||
(`/mail/<id>?...#fundstelle`) und den "Keine Treffer"-Hinweis bei leerem
|
||||
Ergebnis.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
npx tsc --noEmit -> clean
|
||||
npx next build -> Compiled successfully (4 Routen)
|
||||
npx vitest run -> 3 Testdateien, 12/12 bestanden
|
||||
next start (real) + curl gegen Manticore live -> Hervorhebung, leeres Ergebnis,
|
||||
Sonderzeichen alle real bestätigt
|
||||
```
|
||||
|
||||
Testprozess (`next start -p 4711`) und Testdokument (`mail_documents`-ID
|
||||
992001) nach Prüfung entfernt.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. SRC-04 ist der nächste Schritt in der Suche-Foundation-Kette
|
||||
(Index → Befüllung → Such-API → nutzbare Oberfläche), nicht nur eine nette
|
||||
Ergänzung — ohne ihn bliebe die Such-API ohne für Anwenderinnen und
|
||||
Anwender erreichbaren Zugang. Entsperrt QA-03 (gemeinsam mit SRC-02).
|
||||
@@ -1,54 +0,0 @@
|
||||
# SRC-05 – Prüfprotokoll: Facetten- & Filter-API
|
||||
|
||||
Voraussetzung SRC-03 (Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/search/migrations/0002..0005_*.sql`: vier eigene,
|
||||
nummerierte `ALTER TABLE ADD COLUMN`-Migrationen für die neuen
|
||||
Facettenfelder (`sender`, `mailbox`, `attachment_type`, `tag`) — Manticore
|
||||
erlaubt nur eine Spalte je ALTER-Anweisung. `EnsureSchema` wendet sie
|
||||
idempotent nach (Fehlertext `"already in schema"` gilt als bereits
|
||||
angewendet, kein Fehlerzustand).
|
||||
- `fields.go`: neue statische Feldkonstanten + `FacetFields`-Whitelist
|
||||
(`sender`, `mailbox`, `attachment_type`, `tag`) — einzige Quelle
|
||||
zulässiger Facettendimensionen, kein beliebiger Client-Feldname möglich.
|
||||
- `facets.go` — `Client.Facets(ctx, tenantSlug, queryText, filters)`:
|
||||
nutzt Manticores strukturierte `aggs.terms`/`aggs.range`-API (kein
|
||||
dynamischer SQL-Klauselbau). Tenant-Filter + optionale
|
||||
`FacetFilter`-Liste laufen als zusätzliche `equals`-Klauseln in
|
||||
derselben `bool.must`-Liste (Akzeptanzkriterium 2: UND-Verknüpfung).
|
||||
Zeitraum-Facette über feste Buckets (letzte 7 Tage/30 Tage/Jahr/älter)
|
||||
via `aggs.range` auf `sent_at`.
|
||||
- `Document` um optionale Facettenfelder erweitert (`Sender`, `Mailbox`,
|
||||
`AttachmentType`, `Tag`).
|
||||
- Kein Umbau: `Search`/`Delete`/`Index`-Verhalten aus SRC-01/SRC-03
|
||||
unverändert, `mail/internal/dedup`/`indexworker`/`storage`/`crypto`/
|
||||
`encstorage` unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Facettenzahlen stimmen mit tatsächlicher Treffermenge überein | **bestanden** – `TestFacets_CountsMatchActualHits`: 3 reale Dokumente indexiert, Facette `sender` liefert real `alice@example.com`→2, `bob@example.com`→1, Facette `attachment_type` liefert real `pdf`→2 |
|
||||
| 2 | Test: Kombination von drei Filtern liefert korrekt eingeschränkte Treffer | **bestanden** – `TestFacets_ThreeFiltersCombineWithAND`: 4 Dokumente, von denen 3 je genau einen der drei Filter (Sender/Postfach/Anhangstyp) verletzen — nach Kombination aller drei Filter bleibt real genau 1 Treffer übrig |
|
||||
| 3 | Test: Facetten eines Mandanten enthalten keine Werte eines anderen | **bestanden** – `TestFacets_TenantSeparation`: identische Feldstruktur bei zwei Mandanten, Facette bei Mandant B enthält real keinen Wert von Mandant A |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -p 1 -> alle Pakete bestanden, inkl. internal/search (10 Tests,
|
||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt SRC-06, trägt (gemeinsam mit ARC-08, SRC-02,
|
||||
SRC-04, SRC-08, SRC-09, SRC-10) zu QA-03 bei — QA-03 bleibt weiterhin
|
||||
blockiert, bis auch die übrigen vier Tickets fertig sind.
|
||||
@@ -1,60 +0,0 @@
|
||||
# SRC-06 – Prüfprotokoll: Facetten-UI & Filter-Chips
|
||||
|
||||
Voraussetzung SRC-05 (Fertig), SHL-01 (Core-Board, Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `web/mail-search/app/api/facets/route.ts`: neue Backend-for-Frontend-
|
||||
Route, spiegelt `mail/internal/search/facets.go` (`Client.Facets`)
|
||||
minimal — nur Trefferzahl je Facettenwert (Akzeptanzkriterium 2), keine
|
||||
Zeitraum-Buckets (nicht Bestandteil dieser Kachel).
|
||||
- `web/mail-search/lib/manticoreQuery.ts`: gemeinsamer, statischer
|
||||
`bool.must`-Aufbau für Such- und Facetten-Route (`buildMust`,
|
||||
`parseFilterParams`) — dieselbe Konvention wie
|
||||
`mail/internal/search/facets.go` `buildFilteredMust`, kein
|
||||
Sprintf/Join-artiger Klauselbau.
|
||||
- `app/api/search/route.ts` (SRC-04) minimal erweitert: akzeptiert jetzt
|
||||
wiederholbare `?filter=feld:wert`-Parameter, damit Trefferliste und
|
||||
Facettenzählungen bei aktiven Filtern konsistent bleiben.
|
||||
- `app/FacetPanel.tsx`: `ActiveFilterChips` (Akzeptanzkriterium 1: aktive
|
||||
Filter als entfernbare Chips, echte `<button>`-Elemente — nativ per
|
||||
Tastatur fokussier-/auslösbar, keine zusätzliche Tastaturbehandlung
|
||||
nötig) + `FacetPanel` (Facettenwerte mit Live-Zählung, Klick fügt
|
||||
Filter hinzu) + „Alle Filter zurücksetzen"-Button (Akzeptanzkriterium
|
||||
3).
|
||||
- `app/page.tsx`: Filterzustand ausgelagert nach `lib/filterState.ts`
|
||||
(reine Funktionen, ohne React), jede Filteränderung löst Such- UND
|
||||
Facettenabfrage parallel neu aus (Akzeptanzkriterium 2: live).
|
||||
- Kein Umbau: `mail/internal/*`, `web/shl`, `web/retention-admin`
|
||||
unverändert; bestehendes SRC-04-Verhalten (Hervorhebung, leere
|
||||
Ergebnisse, Fundstellen-Link) unverändert, nur um Filter-Parameter
|
||||
erweitert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Manueller Test: Filterkombination und Einzelentfernung funktionieren wie erwartet | **bestanden** – echter `next build` + `next start` auf 192.168.1.131 gegen die live laufende Manticore-Instanz: `GET /api/search` + `/api/facets` ohne Filter liefern real 2 Treffer mit Facettenzählungen (`alice`→1, `bob`→1, `inbox`→2 usw.), mit `filter=sender:alice@example.com` liefern beide Routen real konsistent genau 1 Treffer und auf 1 reduzierte Facettenzählungen |
|
||||
| 2 | Tastaturbedienbarkeit der Filter-Chips geprüft | **bestanden** – automatisiert mit `@testing-library/user-event` (echte Tastatursimulation, kein bloßer Klick): Chip fokussieren (`Tab`-Ziel), `{Enter}` löst real dieselbe Entfernung wie ein Klick aus |
|
||||
| 3 | Test mit vielen aktiven Filtern bleibt die Ansicht übersichtlich | **bestanden** – 20 gleichzeitig aktivierte Filter real erzeugen real 20 einzeln erkennbare, nicht zusammengefasste Chips im DOM, kein Absturz, `flexWrap` verhindert horizontales Überlaufen |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
npx tsc --noEmit -> clean
|
||||
npx next build -> Compiled successfully (5 Routen)
|
||||
npx vitest run -> 4 Testdateien, 19/19 bestanden (8 in app/page.test.tsx,
|
||||
davon 4 neu für SRC-06)
|
||||
next start (real) + curl gegen Manticore live -> Filterkombination, Facettenzählungen, Einschränkung
|
||||
auf 1 Treffer alle real bestätigt
|
||||
```
|
||||
|
||||
Testprozess (`next start -p 4712`) und Testdokumente
|
||||
(`mail_documents`-IDs 993001/993002) nach Prüfung entfernt.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt (gemeinsam mit den übrigen QA-09-Abhängigkeiten)
|
||||
einen Teil des Wegs zu QA-09 — QA-09 bleibt weiterhin blockiert (QA-02,
|
||||
QA-04..QA-08 noch offen).
|
||||
@@ -1,69 +0,0 @@
|
||||
# SRC-07 – Prüfprotokoll: OCR für Anhänge
|
||||
|
||||
Voraussetzung ARC-01, ARC-03 (beide Fertig). SRC-07 ist die direkte
|
||||
Vorbedingung für SRC-10 (Spracherkennung & OCR-Qualitätsbewertung), nicht
|
||||
nur eine nette Ergänzung — ohne SRC-07 gibt es keinen erkannten Text, den
|
||||
SRC-10 mit Sprache/Konfidenz bewerten könnte.
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/ocr/ocr.go` — zustandsloses Paket, kennt weder Mandant
|
||||
noch Speicher (dieselbe Bauart wie `mail/internal/crypto`/`dedup`):
|
||||
nimmt Anhangs-Bytes entgegen, liefert erkannten Text zurück. Kein
|
||||
geteilter Zustand zwischen Aufrufen (jeder Aufruf bekommt ein eigenes
|
||||
Temp-Verzeichnis) — Tenant-Trennung ist dadurch strukturell gegeben,
|
||||
nicht nur konventionell: ein Mandant kann prinzipbedingt nie Zwischen-
|
||||
daten eines anderen sehen. Zuordnung des erkannten Textes zum
|
||||
Mail-Suchdokument (Akzeptanzkriterium 2) erfolgt beim Aufrufer über das
|
||||
bereits vorhandene `search.Document.AttachmentText`-Feld (SRC-01) — kein
|
||||
neues Feld nötig.
|
||||
- `ExtractTextFromImage`: ruft `tesseract` (Sprachen `deu+eng`) mit
|
||||
fester Argumentliste auf, kein Shell-String-Zusammenbau.
|
||||
- `HasTextLayer`/`ExtractTextFromPDF`: nutzt `pdftotext`, um eine
|
||||
vorhandene Textebene zu erkennen und direkt zu übernehmen
|
||||
(Akzeptanzkriterium 3) — nur wenn keine Textebene vorhanden ist
|
||||
(< 10 Zeichen), wird über `pdftoppm` (300dpi) jede Seite gerastert und
|
||||
per Tesseract erkannt (Akzeptanzkriterium 1).
|
||||
- Bekannten Fehler vermieden (dupliziertes Sprintf-WHERE-Muster aus
|
||||
archivmail, siehe repos-analyse-mail-reuse.md): dieses Paket baut keine
|
||||
SQL-Klauseln — ausschließlich externe Kommandozeilenwerkzeuge mit
|
||||
festen Argumentlisten (`exec.CommandContext`, keine Shell).
|
||||
- Kein Umbau: `mail/internal/search`/`dedup`/`indexworker`/`storage`/
|
||||
`crypto`/`encstorage`/`savedsearch` unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Bildanhang mit bekanntem Text liefert erwartete Texterkennung | **bestanden** – `TestExtractTextFromImage_KnownTextRecognized`: reales, über `pdftoppm` gerastertes Bild mit dem Text "Rechnungsnummer 4711", `ExtractTextFromImage` erkennt real beide Wortbestandteile |
|
||||
| 2 | Test: PDF mit vorhandener Textebene wird korrekt übersprungen | **bestanden** – `TestExtractTextFromPDF_SkipsOCRWhenTextLayerPresent`: real erzeugtes Vektor-Text-PDF (echte PDF-Textebene, kein Bild), `ExtractTextFromPDF` liefert `OCRPerformed=false` und den Text direkt aus der Textebene |
|
||||
| 3 | Durchsatztest bestätigt akzeptable Verarbeitungszeit je Anhang | **bestanden** – `TestExtractTextFromPDF_ThroughputIsAcceptable`: 3 reale Anhänge (Rasterung 300dpi + OCR) in durchschnittlich 3,48s/Anhang (Ziel 8s/Anhang) |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 1, gescannte PDFs end-zu-Ende):
|
||||
`TestExtractTextFromPDF_PerformsOCRWhenNoTextLayer` — ein reales,
|
||||
ausschließlich rasterbildbasiertes PDF (kein Textelement, JPEG-Bild via
|
||||
`/DCTDecode` eingebettet) wird real per OCR erkannt, `OCRPerformed=true`.
|
||||
|
||||
Testfixtures (`testpdf_test.go`) werden vollständig in Go erzeugt (Hand-
|
||||
gebautes PDF mit Helvetica-Textebene bzw. eingebettetem JPEG) — keine
|
||||
externe Bibliothek, keine Testdateien im Repository, reproduzierbar.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./internal/ocr/... -v -> 4/4 bestanden (14,99s gesamt)
|
||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
||||
-> alle Pakete bestanden, keine Regression
|
||||
```
|
||||
|
||||
Werkzeugversionen auf 192.168.1.131: `tesseract 5.5.0` (Sprachpakete
|
||||
`deu`, `eng`), `pdftotext`/`pdftoppm` (poppler-utils) — bereits vorhanden,
|
||||
keine Installation durch diese Sitzung nötig.
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt SRC-10.
|
||||
@@ -1,59 +0,0 @@
|
||||
# SRC-08 – Prüfprotokoll: Gespeicherte Suchanfragen
|
||||
|
||||
Voraussetzung SRC-03 (Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/savedsearch/store.go` — `Store` (Postgres,
|
||||
`mail_saved_searches`): `Save` (Upsert über `UNIQUE(tenant_slug,
|
||||
user_id, name)`, Akzeptanzkriterium 1), `List`/`Get` streng auf
|
||||
Mandant UND Benutzer beschränkt (Akzeptanzkriterium 3), `Delete`
|
||||
löscht genau eine Zeile über `tenant_slug + user_id + id`.
|
||||
„Benutzer" ist bis zu einer zentralen Session-/IAM-Anbindung
|
||||
(Core-Board-Scope) ein vom Aufrufer mitgegebener opaker
|
||||
`userID`-String — dieselbe Konvention wie der Tenant-Kontext in
|
||||
`web/mail-search` (SRC-04).
|
||||
- `Execute(ctx, client, saved)` führt die gespeicherte Suche LIVE gegen
|
||||
`search.Client` aus — speichert selbst keine Treffer, jeder Aufruf
|
||||
fragt Manticore neu ab (Akzeptanzkriterium 2).
|
||||
- `mail/internal/search/facets.go` — kleinste nötige Erweiterung: neue
|
||||
Methode `Client.SearchWithFilters` (gemeinsame `buildFilteredMust`-
|
||||
Hilfsfunktion mit `Facets` extrahiert) liefert TATSÄCHLICH gefilterte
|
||||
Treffer statt nur Facettenzählungen — ohne dies gäbe es keinen echten
|
||||
Weg, gespeicherte Filter beim Wiederausführen anzuwenden.
|
||||
- Kein Umbau: `Search`/`Facets`/`Index`/`Delete`-Verhalten sonst
|
||||
unverändert, `mail/internal/dedup`/`indexworker`/`storage`/`crypto`/
|
||||
`encstorage` unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: gespeicherte Suche mit mehreren Filtern wird korrekt reproduziert | **bestanden** – `TestExecute_SavedSearchWithMultipleFiltersReproducesCorrectly`: 3 Dokumente, 2 Filter (Sender+Postfach) gespeichert, `Execute` liefert real genau das eine Dokument, das beide Filter erfüllt |
|
||||
| 2 | Test: Benutzer sieht keine gespeicherten Suchen anderer Mandanten | **bestanden** – `TestList_UserSeesNoOtherTenantsSavedSearches`: zwei Mandanten mit je einer gespeicherten Suche, `List` bei Mandant B liefert real nur die eigene, nicht die von Mandant A |
|
||||
| 3 | Test: Löschen einer gespeicherten Suche entfernt nur diese | **bestanden** – `TestDelete_RemovesOnlyThatSavedSearch`: zwei gespeicherte Suchen, eine gelöscht, `Get` liefert für die gelöschte real `ErrNotFound`, die andere bleibt real unverändert abrufbar |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 2, kein eingefrorener Snapshot):
|
||||
`TestExecute_ReturnsCurrentResultsNotFrozenSnapshot` — Ausführung vor
|
||||
einer neuen Indexierung liefert real 0 Treffer, danach real 1 Treffer,
|
||||
ohne dass die gespeicherte Suche selbst verändert wurde.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -p 1 -> alle Pakete bestanden, inkl. internal/savedsearch (4 Tests, neu),
|
||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate/
|
||||
crypto/search
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Trägt (gemeinsam mit ARC-08, SRC-02, SRC-04, SRC-05,
|
||||
SRC-09) zu QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch
|
||||
SRC-10 fertig ist.
|
||||
@@ -1,72 +0,0 @@
|
||||
# SRC-09 – Prüfprotokoll: Suchindex-Neuaufbau/Reindexierung
|
||||
|
||||
Voraussetzung SRC-01 (Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/search/reindex.go` — `Reindexer.Rebuild(ctx, onProgress)`:
|
||||
1. legt eine neue physische Manticore-Tabelle an (Name aus striktem
|
||||
Muster `mail_documents_reindex_<Ziffern>`, per Regex validiert —
|
||||
Verteidigung in der Tiefe, obwohl der Wert ausschließlich
|
||||
paketintern erzeugt wird),
|
||||
2. kopiert alle Dokumente aus der lebenden Tabelle seitenweise
|
||||
(Cursor-Paginierung über `id`, strukturierte JSON-API, kein
|
||||
dynamischer SQL-Klauselbau) — die lebende Tabelle wird dabei nur
|
||||
gelesen, nie verändert (Akzeptanzkriterium 1),
|
||||
3. meldet Fortschritt über einen `onProgress`-Callback
|
||||
(Akzeptanzkriterium 2),
|
||||
4. vergleicht Trefferzahlen alt/neu — bei Abweichung kein Umschalten,
|
||||
5. schaltet erst danach per Manticore `ALTER TABLE ... RENAME`
|
||||
(reine Metadaten-Operation) atomar um. Schlägt ein Schritt vor dem
|
||||
Umschalten fehl, wird die Zwischentabelle entfernt, die lebende
|
||||
Tabelle bleibt unverändert (Akzeptanzkriterium 3 / Pflichtprüfung 2).
|
||||
- Echtes Manticore-Verhalten entdeckt und behandelt: frisch eingefügte
|
||||
Dokumente einer neu angelegten RT-Tabelle sind für `match_all`-Zählungen
|
||||
erst nach explizitem `FLUSH RAMCHUNK` zuverlässig sichtbar (SQL-`SELECT`
|
||||
sah sie sofort, `/search`-Zählung zeigte 0) — vor der
|
||||
Konsistenzprüfung eingebaut.
|
||||
- Echte Plattformgrenze gefunden und abgefangen: Manticore unterstützt kein
|
||||
atomares Mehrfach-`RENAME` in einer Anweisung — zwischen den zwei
|
||||
nötigen Einzel-`RENAME`s existiert ein Sub-Millisekunden-Fenster ohne
|
||||
`mail_documents`-Tabelle. `Client.Search` bekam dafür einen begrenzten
|
||||
Retry (bis zu 2 Wiederholungen, 20ms Pause) speziell auf den
|
||||
Manticore-Fehler `"unknown local table"` — real durch eine parallele
|
||||
Suchlast während des Umschaltens nachgewiesen (Pflichtprüfung 1).
|
||||
- Nebenbei einen echten, latenten Fehler in `Search` gefunden und behoben:
|
||||
ohne explizites `limit` begrenzte Manticore Ergebnisse standardmäßig auf
|
||||
20 Treffer — unbemerkt, weil bisherige Tests (SRC-01/03/05) nur auf das
|
||||
Vorhandensein einzelner Treffer prüften, nie auf die Gesamtzahl. Jetzt
|
||||
`searchResultLimit = 1000`.
|
||||
- Kein Umbau: `Index`/`Delete`/`Facets`-Verhalten sonst unverändert,
|
||||
`mail/internal/dedup`/`indexworker`/`storage`/`crypto`/`encstorage`
|
||||
unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test: Reindex während laufender Suchanfragen unterbricht die Suche nicht | **bestanden** – `TestRebuild_SearchKeepsWorkingDuringReindex`: 30 reale Dokumente indexiert, parallele Sucher-Goroutine (alle 2ms) läuft während `Rebuild` mit — 0 fehlgeschlagene Suchen über den gesamten Umschaltvorgang, danach weiterhin real alle 30 Treffer auffindbar |
|
||||
| 2 | Test: abgebrochener Reindex hinterlässt keinen inkonsistenten Zustand | **bestanden** – `TestRebuild_AbortedReindexLeavesNoInconsistentState`: Kontext vor `Rebuild` abgebrochen, Fehler kommt real zurück, lebende Tabelle bleibt danach unverändert (weiterhin 1 Treffer real auffindbar), keine verwaisten Zwischentabellen über `SHOW TABLES` real bestätigt |
|
||||
| 3 | Stichprobenvergleich Alt-/Neuindex bestätigt gleiche Trefferzahlen | **bestanden** – `TestRebuild_SampleComparisonMatchesOldAndNewIndex`: 3 unterschiedliche Suchbegriffe vor und nach Reindex real verglichen, identische Trefferzahlen je Stichprobe |
|
||||
|
||||
Zusätzlich (Akzeptanzkriterium 2): `TestRebuild_ReportsProgress` bestätigt
|
||||
reale Fortschrittsmeldungen bis zum vollständigen Abschluss.
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (14 Tests,
|
||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Trägt (gemeinsam mit ARC-08, SRC-02, SRC-04, SRC-05,
|
||||
SRC-08, SRC-10) zu QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch
|
||||
ARC-08, SRC-08 und SRC-10 fertig sind.
|
||||
@@ -1,57 +0,0 @@
|
||||
# SRC-10 – Prüfprotokoll: Spracherkennung & OCR-Qualitätsbewertung
|
||||
|
||||
Voraussetzung SRC-07 (Fertig).
|
||||
|
||||
## Umsetzung
|
||||
|
||||
- `mail/internal/ocr/language.go` — `RecognizeWithLanguageAndConfidence`:
|
||||
Tesseract erkennt bei kombinierten Sprachpaketen (`deu+eng`) nicht,
|
||||
WELCHE Sprache vorlag — daher wird das Bild bewusst EINZELN mit jedem
|
||||
Kandidaten (`deu`, `eng`) im TSV-Ausgabemodus erkannt; die Sprache mit
|
||||
dem höheren durchschnittlichen Worterkennungs-Konfidenzwert gewinnt
|
||||
(Akzeptanzkriterium 1). Derselbe Tesseract-TSV-Lauf liefert den
|
||||
Konfidenzwert direkt mit (Akzeptanzkriterium 2, 0–100, Mittelwert über
|
||||
alle erkannten Wörter) — keine zweite externe Bibliothek nötig.
|
||||
- `mail/internal/search`: neue Felder `ocr_language`/`ocr_confidence`
|
||||
(Migrationen 0006/0007, gleiches ALTER-Muster wie SRC-05), in
|
||||
`Document`/`Result` gespiegelt (Akzeptanzkriterium 1: für Anzeige
|
||||
nutzbar). Neue Methode `Client.AttachmentsBelowConfidence(ctx,
|
||||
tenantSlug, threshold)` (Akzeptanzkriterium 3: gezielt für manuelle
|
||||
Nachbearbeitung auffindbar) — filtert `ocr_confidence < threshold`,
|
||||
schließt Dokumente ohne OCR-Anhang (`ocr_confidence` bleibt 0) explizit
|
||||
aus.
|
||||
- Echten Regressionsbug beim eigenen Testlauf gefunden und behoben:
|
||||
`reindex.go`s `buildCreateTableSQL` (SRC-09) kannte die neuen
|
||||
OCR-Spalten nicht — ein Reindex nach dieser Kachel wäre mit "unknown
|
||||
column" fehlgeschlagen. Jetzt ergänzt, mit Wartungshinweis im
|
||||
Quelltext für künftige Schema-Erweiterungen.
|
||||
- Kein Umbau: `Search`/`Facets`/`SearchWithFilters`/`Index`/`Delete`-
|
||||
Verhalten sonst unverändert, `mail/internal/dedup`/`indexworker`/
|
||||
`storage`/`crypto`/`encstorage`/`savedsearch` unverändert.
|
||||
|
||||
## Prüfungen
|
||||
|
||||
| # | Prüfung | Ergebnis |
|
||||
|---|---|---|
|
||||
| 1 | Test mit mehrsprachigem Testkorpus bestätigt korrekte Spracherkennung | **bestanden** – `TestRecognizeWithLanguageAndConfidence_MultilingualCorpus`: reales deutsches Testbild ("Rechnung ueber Lieferung...") real als `deu` erkannt, reales englisches Testbild ("Invoice for delivery...") real als `eng` erkannt |
|
||||
| 2 | Test: künstlich verschlechtertes Bild erzeugt niedrigeren Konfidenzwert | **bestanden** – `TestRecognizeWithLanguageAndConfidence_DegradedImageLowersConfidence`: reproduzierbare Pixelierung + Kontrastreduktion (reiner Go-Standardbibliothekscode, kein externes Werkzeug) senkt den real gemessenen Konfidenzwert von 91,76 auf 28,21 |
|
||||
| 3 | Abfrage aller Anhänge unterhalb einer Konfidenzschwelle liefert erwartete Treffer | **bestanden** – `TestAttachmentsBelowConfidence_QueryReturnsExpectedResults`: 4 Dokumente (2 niedrig-, 1 hoch-konfident, 1 ohne OCR-Anhang), Abfrage mit Schwelle 50 liefert real genau die 2 niedrig-konfidenten, weder den hoch-konfidenten noch den ohne OCR-Anhang |
|
||||
|
||||
## Build/Test-Ergebnis (192.168.1.131)
|
||||
|
||||
```
|
||||
go build ./... -> clean
|
||||
go vet ./... -> clean
|
||||
golangci-lint run ./... -> 0 issues
|
||||
go test ./internal/ocr/... -v -run 'Language|Degraded' -> 2/2 bestanden
|
||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
||||
-> alle Pakete bestanden (Regressionsbug in reindex.go vor diesem
|
||||
Protokoll gefunden und behoben, danach vollständig grün)
|
||||
```
|
||||
|
||||
## Gesamtergebnis
|
||||
|
||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||
real erfüllt. Entsperrt QA-03 (gemeinsam mit ARC-08, SRC-02, SRC-04,
|
||||
SRC-05, SRC-08, SRC-09 — alle jetzt Fertig, letzte fehlende
|
||||
Abhängigkeit).
|
||||
@@ -1,110 +0,0 @@
|
||||
# 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
@@ -1,36 +0,0 @@
|
||||
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
@@ -1,64 +0,0 @@
|
||||
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=
|
||||
@@ -1,118 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,144 +0,0 @@
|
||||
// ARC-08: Tenant-KEK-Rotation. Core (API-10, `internal/kek.Store.
|
||||
// RotateTenantKEK`) ersetzt den Tenant-KEK durch einen komplett neuen
|
||||
// Wert — Core selbst hält KEINE Historie vor, `TenantKEKHandler` liefert
|
||||
// immer nur den AKTUELLEN Schlüssel (siehe kekprovider.go). Damit ARC-08s
|
||||
// Akzeptanzkriterium 3 ("alte Schlüsselversionen bleiben für
|
||||
// Lesezugriff kontrolliert verfügbar") erfüllbar ist, muss Mail selbst
|
||||
// jeden von Core bezogenen Tenant-KEK versioniert zwischenspeichern —
|
||||
// KEKVersionStore übernimmt genau das, lokal mit einem eigenen,
|
||||
// ausschließlich über Umgebungsvariable bezogenen Wrap-Schlüssel
|
||||
// verschlüsselt (kein Klartext-KEK in der Datenbank).
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// ErrKEKVersionNotFound wird geliefert, wenn die angefragte Version für
|
||||
// den Mandanten nicht existiert.
|
||||
var ErrKEKVersionNotFound = errors.New("crypto: kek-version nicht gefunden")
|
||||
|
||||
// ErrKEKVersionRevoked wird geliefert, wenn die angefragte Version gezielt
|
||||
// gesperrt wurde (Pflichtprüfung 2: kompromittierter alter Schlüssel kann
|
||||
// gezielt gesperrt werden) — der Lesezugriff auf mit dieser Version
|
||||
// verschlüsselte Altobjekte ist dann bewusst blockiert.
|
||||
var ErrKEKVersionRevoked = errors.New("crypto: kek-version wurde gesperrt")
|
||||
|
||||
// KEKVersionStore verwaltet die Versionshistorie der Tenant-KEKs, die
|
||||
// dieses Mail-Modul im Lauf der Zeit von Core bezogen hat.
|
||||
type KEKVersionStore struct {
|
||||
pool *pgxpool.Pool
|
||||
localWrapKey []byte
|
||||
}
|
||||
|
||||
// NewKEKVersionStore erzeugt einen Store. localWrapKey verschlüsselt die
|
||||
// zwischengespeicherten Tenant-KEKs lokal at rest (KEKSize Bytes,
|
||||
// ausschließlich über Umgebungsvariable bezogen — nie im Code).
|
||||
func NewKEKVersionStore(pool *pgxpool.Pool, localWrapKey []byte) *KEKVersionStore {
|
||||
return &KEKVersionStore{pool: pool, localWrapKey: localWrapKey}
|
||||
}
|
||||
|
||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
||||
// gleiches Muster wie mail/internal/dedup/indexworker (kein zentraler
|
||||
// Migrationsläufer für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
||||
func (s *KEKVersionStore) EnsureSchema(ctx context.Context) error {
|
||||
if _, err := s.pool.Exec(ctx, `
|
||||
CREATE TABLE IF NOT EXISTS mail_kek_versions (
|
||||
tenant_slug TEXT NOT NULL,
|
||||
version INT NOT NULL,
|
||||
wrapped_kek BYTEA NOT NULL,
|
||||
revoked BOOLEAN NOT NULL DEFAULT false,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
PRIMARY KEY (tenant_slug, version)
|
||||
)
|
||||
`); err != nil {
|
||||
return fmt.Errorf("crypto: kek-versionsschema anlegen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RecordIfNew merkt sich plainKEK als neue Version für tenantSlug, FALLS
|
||||
// er sich vom zuletzt gespeicherten Wert unterscheidet (Rotation
|
||||
// erkannt) — bei unverändertem KEK wird keine neue Version angelegt,
|
||||
// sondern die bestehende Versionsnummer zurückgegeben (Akzeptanzkriterium
|
||||
// 1: rotierbar verwaltet, nicht bei jedem Aufruf eine neue Version).
|
||||
func (s *KEKVersionStore) RecordIfNew(ctx context.Context, tenantSlug string, plainKEK []byte) (version int, err error) {
|
||||
var latestVersion int
|
||||
var latestWrapped []byte
|
||||
err = s.pool.QueryRow(ctx, `
|
||||
SELECT version, wrapped_kek FROM mail_kek_versions
|
||||
WHERE tenant_slug = $1 ORDER BY version DESC LIMIT 1
|
||||
`, tenantSlug).Scan(&latestVersion, &latestWrapped)
|
||||
switch {
|
||||
case errors.Is(err, pgx.ErrNoRows):
|
||||
return s.insertVersion(ctx, tenantSlug, 1, plainKEK)
|
||||
case err != nil:
|
||||
return 0, fmt.Errorf("crypto: letzte kek-version lesen: %w", err)
|
||||
}
|
||||
|
||||
latestPlain, err := open(s.localWrapKey, latestWrapped)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("crypto: zwischengespeicherten kek entpacken: %w", err)
|
||||
}
|
||||
if bytes.Equal(latestPlain, plainKEK) {
|
||||
return latestVersion, nil
|
||||
}
|
||||
return s.insertVersion(ctx, tenantSlug, latestVersion+1, plainKEK)
|
||||
}
|
||||
|
||||
func (s *KEKVersionStore) insertVersion(ctx context.Context, tenantSlug string, version int, plainKEK []byte) (int, error) {
|
||||
wrapped, err := seal(s.localWrapKey, plainKEK)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("crypto: kek für zwischenspeicherung verpacken: %w", err)
|
||||
}
|
||||
if _, err := s.pool.Exec(ctx, `
|
||||
INSERT INTO mail_kek_versions (tenant_slug, version, wrapped_kek) VALUES ($1, $2, $3)
|
||||
`, tenantSlug, version, wrapped); err != nil {
|
||||
return 0, fmt.Errorf("crypto: kek-version speichern: %w", err)
|
||||
}
|
||||
return version, nil
|
||||
}
|
||||
|
||||
// Get liefert den entschlüsselten historischen Tenant-KEK einer
|
||||
// bestimmten Version. Liefert ErrKEKVersionRevoked, wenn die Version
|
||||
// gezielt gesperrt wurde (Pflichtprüfung 2).
|
||||
func (s *KEKVersionStore) Get(ctx context.Context, tenantSlug string, version int) ([]byte, error) {
|
||||
var wrapped []byte
|
||||
var revoked bool
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
SELECT wrapped_kek, revoked FROM mail_kek_versions
|
||||
WHERE tenant_slug = $1 AND version = $2
|
||||
`, tenantSlug, version).Scan(&wrapped, &revoked)
|
||||
if err != nil {
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrKEKVersionNotFound
|
||||
}
|
||||
return nil, fmt.Errorf("crypto: kek-version lesen: %w", err)
|
||||
}
|
||||
if revoked {
|
||||
return nil, ErrKEKVersionRevoked
|
||||
}
|
||||
return open(s.localWrapKey, wrapped)
|
||||
}
|
||||
|
||||
// Revoke sperrt eine Tenant-KEK-Version gezielt (Pflichtprüfung 2):
|
||||
// nachfolgende Get-Aufrufe für genau diese Version schlagen mit
|
||||
// ErrKEKVersionRevoked fehl, andere Versionen bleiben unberührt.
|
||||
func (s *KEKVersionStore) Revoke(ctx context.Context, tenantSlug string, version int) error {
|
||||
tag, err := s.pool.Exec(ctx, `
|
||||
UPDATE mail_kek_versions SET revoked = true WHERE tenant_slug = $1 AND version = $2
|
||||
`, tenantSlug, version)
|
||||
if err != nil {
|
||||
return fmt.Errorf("crypto: kek-version sperren: %w", err)
|
||||
}
|
||||
if tag.RowsAffected() == 0 {
|
||||
return ErrKEKVersionNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -1,111 +0,0 @@
|
||||
// Integrationstest (ARC-08): echte Postgres-Instanz, folgt derselben
|
||||
// Testhost-Konvention wie mail/internal/dedup/indexworker — TEST_TENANT_DSN.
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
var testLocalWrapKey = bytes.Repeat([]byte{0x7a}, KEKSize)
|
||||
|
||||
func setupKEKVersionStore(t *testing.T, tenantSlug string) *KEKVersionStore {
|
||||
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() })
|
||||
|
||||
store := NewKEKVersionStore(pool, testLocalWrapKey)
|
||||
if err := store.EnsureSchema(ctx); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_kek_versions WHERE tenant_slug = $1`, tenantSlug)
|
||||
})
|
||||
return store
|
||||
}
|
||||
|
||||
func TestKEKVersionStore_RecordIfNewDetectsRotationOnly(t *testing.T) {
|
||||
tenant := "mandant-arc08-recordifnew"
|
||||
store := setupKEKVersionStore(t, tenant)
|
||||
ctx := context.Background()
|
||||
|
||||
kekV1 := bytes.Repeat([]byte{0x01}, KEKSize)
|
||||
v1, err := store.RecordIfNew(ctx, tenant, kekV1)
|
||||
if err != nil {
|
||||
t.Fatalf("erste erfassung: %v", err)
|
||||
}
|
||||
if v1 != 1 {
|
||||
t.Fatalf("erwartete version 1, habe %d", v1)
|
||||
}
|
||||
|
||||
// Erneuter Aufruf mit UNVERÄNDERTEM KEK darf keine neue Version anlegen.
|
||||
vAgain, err := store.RecordIfNew(ctx, tenant, kekV1)
|
||||
if err != nil {
|
||||
t.Fatalf("zweite erfassung (unverändert): %v", err)
|
||||
}
|
||||
if vAgain != 1 {
|
||||
t.Fatalf("erwartete weiterhin version 1 bei unverändertem kek, habe %d", vAgain)
|
||||
}
|
||||
|
||||
kekV2 := bytes.Repeat([]byte{0x02}, KEKSize)
|
||||
v2, err := store.RecordIfNew(ctx, tenant, kekV2)
|
||||
if err != nil {
|
||||
t.Fatalf("dritte erfassung (rotiert): %v", err)
|
||||
}
|
||||
if v2 != 2 {
|
||||
t.Fatalf("erwartete version 2 nach rotation, habe %d", v2)
|
||||
}
|
||||
|
||||
gotV1, err := store.Get(ctx, tenant, 1)
|
||||
if err != nil {
|
||||
t.Fatalf("get v1: %v", err)
|
||||
}
|
||||
if !bytes.Equal(gotV1, kekV1) {
|
||||
t.Fatal("v1 liefert nicht den ursprünglichen kek zurück")
|
||||
}
|
||||
gotV2, err := store.Get(ctx, tenant, 2)
|
||||
if err != nil {
|
||||
t.Fatalf("get v2: %v", err)
|
||||
}
|
||||
if !bytes.Equal(gotV2, kekV2) {
|
||||
t.Fatal("v2 liefert nicht den rotierten kek zurück")
|
||||
}
|
||||
}
|
||||
|
||||
func TestKEKVersionStore_RevokeBlocksOnlyThatVersion(t *testing.T) {
|
||||
tenant := "mandant-arc08-revoke"
|
||||
store := setupKEKVersionStore(t, tenant)
|
||||
ctx := context.Background()
|
||||
|
||||
kekV1 := bytes.Repeat([]byte{0x11}, KEKSize)
|
||||
kekV2 := bytes.Repeat([]byte{0x22}, KEKSize)
|
||||
if _, err := store.RecordIfNew(ctx, tenant, kekV1); err != nil {
|
||||
t.Fatalf("v1 erfassen: %v", err)
|
||||
}
|
||||
if _, err := store.RecordIfNew(ctx, tenant, kekV2); err != nil {
|
||||
t.Fatalf("v2 erfassen: %v", err)
|
||||
}
|
||||
|
||||
if err := store.Revoke(ctx, tenant, 1); err != nil {
|
||||
t.Fatalf("v1 sperren: %v", err)
|
||||
}
|
||||
|
||||
if _, err := store.Get(ctx, tenant, 1); err != ErrKEKVersionRevoked {
|
||||
t.Fatalf("erwartete ErrKEKVersionRevoked für gesperrte version 1, habe: %v", err)
|
||||
}
|
||||
if _, err := store.Get(ctx, tenant, 2); err != nil {
|
||||
t.Fatalf("version 2 sollte unberührt bleiben: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -1,131 +0,0 @@
|
||||
// ARC-08: End-zu-Ende-Rotationstest. Nutzt einen fake KEKProvider (echter
|
||||
// Testkonvention aus ARC-02, siehe encstorage_test.go) statt eines echten
|
||||
// HTTP-Aufrufs an Core API-12 — Core selbst hat keine rotierbare
|
||||
// Testschnittstelle über HTTP exponiert (nur der aktuelle KEK ist
|
||||
// abrufbar), die Rotation wird hier auf Höhe der KEKProvider-Schnittstelle
|
||||
// simuliert, exakt wie ARC-02 es für Fehlerfälle bereits tut.
|
||||
package crypto
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"io"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// rotatableKEKProvider liefert für einen Mandanten einen aktuell
|
||||
// gesetzten KEK, der zur Laufzeit "rotiert" werden kann (simuliert Core
|
||||
// API-10s RotateTenantKEK, dessen Effekt auf API-12 exakt darin besteht,
|
||||
// dass TenantKEK ab dann einen anderen Wert liefert).
|
||||
type rotatableKEKProvider struct {
|
||||
mu sync.Mutex
|
||||
current []byte
|
||||
}
|
||||
|
||||
func (p *rotatableKEKProvider) TenantKEK(_ context.Context, _ string) ([]byte, error) {
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
return p.current, nil
|
||||
}
|
||||
|
||||
func (p *rotatableKEKProvider) rotate(newKEK []byte) {
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
p.current = newKEK
|
||||
}
|
||||
|
||||
// TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation ist die
|
||||
// geforderte Pflichtprüfung 1: Rotation des Hauptschlüssels lässt
|
||||
// Altbestand weiterhin lesbar.
|
||||
func TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation(t *testing.T) {
|
||||
tenant := "mandant-arc08-rotation-lesbar"
|
||||
store := setupKEKVersionStore(t, tenant)
|
||||
ctx := context.Background()
|
||||
|
||||
provider := &rotatableKEKProvider{current: bytes.Repeat([]byte{0x51}, KEKSize)}
|
||||
svc := NewService(provider).WithVersionStore(store)
|
||||
|
||||
// Objekt VOR der Rotation versiegeln.
|
||||
oldEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("altbestand vor rotation"))
|
||||
if err != nil {
|
||||
t.Fatalf("seal (alt): %v", err)
|
||||
}
|
||||
if oldEnvelope.KEKVersion != 1 {
|
||||
t.Fatalf("erwartete kek-version 1 vor rotation, habe %d", oldEnvelope.KEKVersion)
|
||||
}
|
||||
oldCiphertext, err := io.ReadAll(oldEnvelope.Ciphertext)
|
||||
if err != nil {
|
||||
t.Fatalf("chiffretext (alt) lesen: %v", err)
|
||||
}
|
||||
|
||||
// Core rotiert den Tenant-Hauptschlüssel — TenantKEK liefert ab jetzt
|
||||
// einen komplett anderen Wert, exakt wie internal/kek.Store.
|
||||
// RotateTenantKEK es real bei Core bewirkt.
|
||||
provider.rotate(bytes.Repeat([]byte{0x52}, KEKSize))
|
||||
|
||||
// Objekt NACH der Rotation versiegeln (Akzeptanzkriterium 2: kein
|
||||
// Neuverschlüsseln des Altbestands nötig, nur neue Objekte nutzen den
|
||||
// neuen Schlüssel).
|
||||
newEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("neuer inhalt nach rotation"))
|
||||
if err != nil {
|
||||
t.Fatalf("seal (neu): %v", err)
|
||||
}
|
||||
if newEnvelope.KEKVersion != 2 {
|
||||
t.Fatalf("erwartete kek-version 2 nach rotation, habe %d", newEnvelope.KEKVersion)
|
||||
}
|
||||
|
||||
// Altbestand bleibt über die aufgezeichnete Version lesbar
|
||||
// (Akzeptanzkriterium 3).
|
||||
openedOld, err := svc.OpenAtVersion(ctx, tenant, oldEnvelope.KEKVersion, oldEnvelope.WrappedDEK, bytes.NewReader(oldCiphertext))
|
||||
if err != nil {
|
||||
t.Fatalf("openatversion (alt, nach rotation): %v", err)
|
||||
}
|
||||
plainOld, err := io.ReadAll(openedOld)
|
||||
if err != nil {
|
||||
t.Fatalf("altbestand lesen: %v", err)
|
||||
}
|
||||
if string(plainOld) != "altbestand vor rotation" {
|
||||
t.Fatalf("altbestand-inhalt stimmt nicht, habe %q", string(plainOld))
|
||||
}
|
||||
|
||||
// Der naive Open() (aktueller KEK) darf für das ALTE Objekt inzwischen
|
||||
// NICHT mehr funktionieren — das beweist, dass OpenAtVersion die
|
||||
// Rotation tatsächlich überbrückt, statt zufällig auch so zu klappen.
|
||||
if _, err := svc.Open(ctx, tenant, oldEnvelope.WrappedDEK, bytes.NewReader(oldCiphertext)); err == nil {
|
||||
t.Fatal("erwartete fehler bei Open() des altbestands mit dem NEUEN aktuellen kek, habe nil")
|
||||
}
|
||||
}
|
||||
|
||||
// TestRotation_CompromisedOldKeyCanBeRevoked ist die geforderte
|
||||
// Pflichtprüfung 2: kompromittierter alter Schlüssel kann gezielt
|
||||
// gesperrt werden.
|
||||
func TestRotation_CompromisedOldKeyCanBeRevoked(t *testing.T) {
|
||||
tenant := "mandant-arc08-revoke-e2e"
|
||||
store := setupKEKVersionStore(t, tenant)
|
||||
ctx := context.Background()
|
||||
|
||||
provider := &rotatableKEKProvider{current: bytes.Repeat([]byte{0x61}, KEKSize)}
|
||||
svc := NewService(provider).WithVersionStore(store)
|
||||
|
||||
compromisedEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("mit kompromittiertem schlüssel versiegelt"))
|
||||
if err != nil {
|
||||
t.Fatalf("seal: %v", err)
|
||||
}
|
||||
compromisedCiphertext, err := io.ReadAll(compromisedEnvelope.Ciphertext)
|
||||
if err != nil {
|
||||
t.Fatalf("chiffretext lesen: %v", err)
|
||||
}
|
||||
|
||||
provider.rotate(bytes.Repeat([]byte{0x62}, KEKSize))
|
||||
|
||||
if err := store.Revoke(ctx, tenant, compromisedEnvelope.KEKVersion); err != nil {
|
||||
t.Fatalf("kompromittierte version sperren: %v", err)
|
||||
}
|
||||
|
||||
_, err = svc.OpenAtVersion(ctx, tenant, compromisedEnvelope.KEKVersion, compromisedEnvelope.WrappedDEK, bytes.NewReader(compromisedCiphertext))
|
||||
if err == nil {
|
||||
t.Fatal("erwartete fehler beim lesen mit gesperrter kek-version, habe nil")
|
||||
}
|
||||
}
|
||||
@@ -1,114 +0,0 @@
|
||||
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).
|
||||
// KEKVersion identifiziert (ARC-08), MIT welcher Tenant-KEK-Version der
|
||||
// DEK verpackt wurde — 0, solange kein KEKVersionStore konfiguriert ist
|
||||
// (Rückwärtskompatibilität, siehe WithVersionStore).
|
||||
type Envelope struct {
|
||||
Ciphertext io.Reader
|
||||
WrappedDEK []byte
|
||||
KEKVersion int
|
||||
}
|
||||
|
||||
// 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
|
||||
versions *KEKVersionStore
|
||||
}
|
||||
|
||||
func NewService(kek KEKProvider) *Service {
|
||||
return &Service{kek: kek}
|
||||
}
|
||||
|
||||
// WithVersionStore aktiviert die Tenant-KEK-Versionsverfolgung (ARC-08).
|
||||
// Ohne aufgerufenes WithVersionStore verhält sich Service exakt wie vor
|
||||
// ARC-08 (KEKVersion bleibt 0, OpenAtVersion fällt auf Open zurück) —
|
||||
// bestehende Aufrufer (z. B. encstorage) sind unverändert lauffähig.
|
||||
func (s *Service) WithVersionStore(store *KEKVersionStore) *Service {
|
||||
s.versions = store
|
||||
return s
|
||||
}
|
||||
|
||||
// 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 außer in der optionalen
|
||||
// KEK-Versionshistorie für spätere Altbestands-Lesezugriffe).
|
||||
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
|
||||
}
|
||||
|
||||
var kekVersion int
|
||||
if s.versions != nil {
|
||||
kekVersion, err = s.versions.RecordIfNew(ctx, tenantSlug, kek)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: kek-version erfassen: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return &Envelope{Ciphertext: ciphertext, WrappedDEK: wrappedDEK, KEKVersion: kekVersion}, 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. Nach einer Tenant-KEK-Rotation bei
|
||||
// Core funktioniert Open nur noch für Objekte, die mit dem NEUEN KEK
|
||||
// versiegelt wurden — für Altbestand siehe OpenAtVersion.
|
||||
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)
|
||||
}
|
||||
|
||||
// OpenAtVersion entpackt den DEK mit der beim Seal aufgezeichneten
|
||||
// historischen Tenant-KEK-Version statt mit dem aktuellen Core-KEK
|
||||
// (ARC-08 Akzeptanzkriterium 3: Altbestand bleibt nach einer
|
||||
// Hauptschlüssel-Rotation lesbar). Ist kekVersion 0 oder kein
|
||||
// KEKVersionStore konfiguriert, verhält es sich wie Open (Rückwärts-
|
||||
// kompatibilität für vor ARC-08 versiegelte Objekte).
|
||||
func (s *Service) OpenAtVersion(ctx context.Context, tenantSlug string, kekVersion int, wrappedDEK []byte, ciphertext io.Reader) (io.Reader, error) {
|
||||
if kekVersion == 0 || s.versions == nil {
|
||||
return s.Open(ctx, tenantSlug, wrappedDEK, ciphertext)
|
||||
}
|
||||
kek, err := s.versions.Get(ctx, tenantSlug, kekVersion)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("crypto: historischen tenant-kek beziehen: %w", err)
|
||||
}
|
||||
dek, err := UnwrapDEK(kek, wrappedDEK)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return DecryptStream(dek, ciphertext)
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
// Package dedup implementiert ARC-03: Dublettenerkennung für
|
||||
// archivierte E-Mails über einen Inhalts-Hash. Kombiniert bewusst NICHT
|
||||
// mit mail/internal/storage oder mail/internal/crypto — dieses Paket
|
||||
// kennt beide nicht, der Aufrufer (spätere Ingest-Tickets) ruft es VOR
|
||||
// mail/internal/crypto auf.
|
||||
package dedup
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// HashAndBuffer berechnet den SHA-256-Inhalts-Hash von plaintext.
|
||||
//
|
||||
// Bekannter Fehler vermeiden (siehe ARC-03-Ticket): der Hash MUSS auf
|
||||
// dem Klartext berechnet werden, BEVOR mail/internal/crypto verschlüsselt
|
||||
// — ein Hash auf dem Chiffretext wäre bei jedem Import anders (neuer
|
||||
// DEK je Objekt, siehe ARC-02) und Dublettenerkennung würde vollständig
|
||||
// versagen. Reihenfolge: Mail/Anhang empfangen -> HashAndBuffer (dieses
|
||||
// Paket) -> verschlüsseln (ARC-02) -> ablegen.
|
||||
//
|
||||
// plaintext wird beim Hashen vollständig verbraucht — HashAndBuffer
|
||||
// liefert deshalb einen erneut lesbaren Reader mit demselben Inhalt für
|
||||
// den nachfolgenden Verschlüsselungsschritt zurück.
|
||||
func HashAndBuffer(plaintext io.Reader) (contentHash string, buffered io.Reader, err error) {
|
||||
var buf bytes.Buffer
|
||||
hasher := sha256.New()
|
||||
if _, err := io.Copy(hasher, io.TeeReader(plaintext, &buf)); err != nil {
|
||||
return "", nil, fmt.Errorf("dedup: klartext hashen: %w", err)
|
||||
}
|
||||
return hex.EncodeToString(hasher.Sum(nil)), &buf, nil
|
||||
}
|
||||
@@ -1,58 +0,0 @@
|
||||
package dedup
|
||||
|
||||
import (
|
||||
"io"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestHashAndBuffer_SameContentSameHash(t *testing.T) {
|
||||
h1, buf1, err := HashAndBuffer(strings.NewReader("identischer inhalt"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h2, buf2, err := HashAndBuffer(strings.NewReader("identischer inhalt"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if h1 != h2 {
|
||||
t.Fatalf("erwartet identischen hash für identischen inhalt, habe %q vs %q", h1, h2)
|
||||
}
|
||||
|
||||
got1, _ := io.ReadAll(buf1)
|
||||
got2, _ := io.ReadAll(buf2)
|
||||
if string(got1) != "identischer inhalt" || string(got2) != "identischer inhalt" {
|
||||
t.Fatal("buffered reader liefert nicht denselben inhalt zurück wie der ursprüngliche klartext")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHashAndBuffer_DifferentContentDifferentHash(t *testing.T) {
|
||||
h1, _, err := HashAndBuffer(strings.NewReader("nachricht a"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h2, _, err := HashAndBuffer(strings.NewReader("nachricht b"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if h1 == h2 {
|
||||
t.Fatal("unterschiedlicher inhalt hätte unterschiedlichen hash liefern müssen")
|
||||
}
|
||||
}
|
||||
|
||||
// TestHashAndBuffer_SlightlyDifferentContentDifferentHash ist die
|
||||
// geforderte Pflichtprüfung 3: knapp unterschiedliche Nachrichten
|
||||
// werden korrekt NICHT als Duplikat erkannt.
|
||||
func TestHashAndBuffer_SlightlyDifferentContentDifferentHash(t *testing.T) {
|
||||
h1, _, err := HashAndBuffer(strings.NewReader("Betreff: Test\r\n\r\nInhalt der Nachricht."))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h2, _, err := HashAndBuffer(strings.NewReader("Betreff: Test\r\n\r\nInhalt der Nachricht,"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if h1 == h2 {
|
||||
t.Fatal("ein einziges abweichendes zeichen hätte den hash ändern müssen")
|
||||
}
|
||||
}
|
||||
@@ -1,75 +0,0 @@
|
||||
package dedup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// Store verwaltet bekannte Inhalts-Hashes je Mandant. tenant_slug ist
|
||||
// fester Bestandteil des Primärschlüssels (Akzeptanzkriterium 3:
|
||||
// mandantenübergreifend korrekt getrennt) — auch wenn Store einen mit
|
||||
// anderen Mandanten geteilten Pool erhält, kann ein Hash-Treffer nie
|
||||
// über Mandantengrenzen hinweg entstehen.
|
||||
type Store struct {
|
||||
pool *pgxpool.Pool
|
||||
tenantSlug string
|
||||
}
|
||||
|
||||
func NewStore(pool *pgxpool.Pool, tenantSlug string) *Store {
|
||||
return &Store{pool: pool, tenantSlug: tenantSlug}
|
||||
}
|
||||
|
||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
||||
// gleiches Muster wie mail/internal/example (kein zentraler
|
||||
// Migrationsläufer für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
||||
func (s *Store) EnsureSchema(ctx context.Context) error {
|
||||
if _, err := s.pool.Exec(ctx, `
|
||||
CREATE TABLE IF NOT EXISTS mail_content_hashes (
|
||||
tenant_slug TEXT NOT NULL,
|
||||
content_hash TEXT NOT NULL,
|
||||
object_key TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
PRIMARY KEY (tenant_slug, content_hash)
|
||||
)
|
||||
`); err != nil {
|
||||
return fmt.Errorf("dedup: schema anlegen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Register trägt contentHash für den Mandanten als neu bekannt ein
|
||||
// (Akzeptanzkriterium 1) und referenziert das Original, statt es
|
||||
// redundant zu speichern (Akzeptanzkriterium 2): existiert derselbe
|
||||
// Hash für DIESEN Mandanten bereits mit einem ANDEREN object_key,
|
||||
// liefert Register isDuplicate=true und den object_key des Originals —
|
||||
// der Aufrufer legt den neuen Inhalt dann NICHT ab.
|
||||
func (s *Store) Register(ctx context.Context, contentHash, objectKey string) (isDuplicate bool, existingKey string, err error) {
|
||||
if _, err := s.pool.Exec(ctx, `
|
||||
INSERT INTO mail_content_hashes (tenant_slug, content_hash, object_key)
|
||||
VALUES ($1, $2, $3)
|
||||
ON CONFLICT (tenant_slug, content_hash) DO NOTHING
|
||||
`, s.tenantSlug, contentHash, objectKey); err != nil {
|
||||
return false, "", fmt.Errorf("dedup: hash eintragen: %w", err)
|
||||
}
|
||||
|
||||
var storedKey string
|
||||
err = s.pool.QueryRow(ctx, `
|
||||
SELECT object_key FROM mail_content_hashes
|
||||
WHERE tenant_slug = $1 AND content_hash = $2
|
||||
`, s.tenantSlug, contentHash).Scan(&storedKey)
|
||||
if err != nil {
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return false, "", fmt.Errorf("dedup: gerade eingetragenen hash nicht wiedergefunden")
|
||||
}
|
||||
return false, "", fmt.Errorf("dedup: eintrag lesen: %w", err)
|
||||
}
|
||||
|
||||
if storedKey != objectKey {
|
||||
return true, storedKey, nil
|
||||
}
|
||||
return false, "", nil
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
// Integrationstest (ARC-03): echte Postgres-Instanz, folgt derselben
|
||||
// Testhost-Konvention wie mail/internal/example (QA-01) — TEST_TENANT_DSN.
|
||||
package dedup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func setupStore(t *testing.T, tenantSlug string) *Store {
|
||||
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() })
|
||||
|
||||
store := NewStore(pool, tenantSlug)
|
||||
if err := store.EnsureSchema(ctx); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_content_hashes WHERE tenant_slug = $1`, tenantSlug)
|
||||
})
|
||||
return store
|
||||
}
|
||||
|
||||
// TestRegister_SameMessageFromTwoSourcesIsDuplicate ist die geforderte
|
||||
// Pflichtprüfung 1: dieselbe Nachricht aus zwei Quellen wird als
|
||||
// Duplikat erkannt.
|
||||
func TestRegister_SameMessageFromTwoSourcesIsDuplicate(t *testing.T) {
|
||||
store := setupStore(t, "mandant-arc03-a")
|
||||
ctx := context.Background()
|
||||
|
||||
hash := "fixierter-inhalts-hash-fuer-test-1"
|
||||
|
||||
isDup, _, err := store.Register(ctx, hash, "quelle-1/objekt")
|
||||
if err != nil {
|
||||
t.Fatalf("erste registrierung: %v", err)
|
||||
}
|
||||
if isDup {
|
||||
t.Fatal("erste registrierung eines hashes darf kein duplikat sein")
|
||||
}
|
||||
|
||||
isDup, existing, err := store.Register(ctx, hash, "quelle-2/objekt")
|
||||
if err != nil {
|
||||
t.Fatalf("zweite registrierung: %v", err)
|
||||
}
|
||||
if !isDup {
|
||||
t.Fatal("erwartet: dieselbe nachricht aus zweiter quelle wird als duplikat erkannt")
|
||||
}
|
||||
if existing != "quelle-1/objekt" {
|
||||
t.Fatalf("erwartet referenz auf das original quelle-1/objekt, habe %q", existing)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRegister_SameContentTwoTenantsNotLinked ist die geforderte
|
||||
// Pflichtprüfung 2: zwei Mandanten mit identischem Mailinhalt werden
|
||||
// nicht fälschlich verknüpft.
|
||||
func TestRegister_SameContentTwoTenantsNotLinked(t *testing.T) {
|
||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||
if dsn == "" {
|
||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
|
||||
}
|
||||
storeA := setupStore(t, "mandant-arc03-x")
|
||||
storeB := setupStore(t, "mandant-arc03-y")
|
||||
ctx := context.Background()
|
||||
|
||||
hash := "identischer-inhalt-ueber-zwei-mandanten-hinweg"
|
||||
|
||||
isDupA, _, err := storeA.Register(ctx, hash, "mandant-x/objekt")
|
||||
if err != nil {
|
||||
t.Fatalf("mandant a: %v", err)
|
||||
}
|
||||
if isDupA {
|
||||
t.Fatal("erste registrierung bei mandant a darf kein duplikat sein")
|
||||
}
|
||||
|
||||
isDupB, existingB, err := storeB.Register(ctx, hash, "mandant-y/objekt")
|
||||
if err != nil {
|
||||
t.Fatalf("mandant b: %v", err)
|
||||
}
|
||||
if isDupB {
|
||||
t.Fatalf("mandant b wurde fälschlich mit mandant a verknüpft, existing=%q", existingB)
|
||||
}
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
// 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"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"strconv"
|
||||
|
||||
"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"
|
||||
}
|
||||
|
||||
// kekVersionKey ist der Sidecar-Objektschlüssel für die Tenant-KEK-
|
||||
// Version, mit der der DEK verpackt wurde (ARC-08 Akzeptanzkriterium 3).
|
||||
// Fehlt dieser Sidecar (vor ARC-08 geschriebene Objekte), wird Version 0
|
||||
// angenommen — GetDecrypted verhält sich dann wie vor ARC-08.
|
||||
func kekVersionKey(key string) string {
|
||||
return key + ".dek.version"
|
||||
}
|
||||
|
||||
// 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)
|
||||
}
|
||||
if env.KEKVersion != 0 {
|
||||
versionBytes := []byte(strconv.Itoa(env.KEKVersion))
|
||||
if _, err := s.storage.Put(ctx, kekVersionKey(key), bytes.NewReader(versionBytes), int64(len(versionBytes)), "text/plain"); err != nil {
|
||||
return fmt.Errorf("encstorage: kek-version 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)
|
||||
}
|
||||
|
||||
kekVersion, err := s.readKEKVersion(ctx, key)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
plaintextReader, err := s.crypto.OpenAtVersion(ctx, tenantSlug, kekVersion, wrappedDEK, bytes.NewReader(ciphertext))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return io.ReadAll(plaintextReader)
|
||||
}
|
||||
|
||||
// readKEKVersion liest den Versions-Sidecar (ARC-08). Fehlt er (vor
|
||||
// ARC-08 geschriebene Objekte, oder ein Seal ohne konfigurierten
|
||||
// KEKVersionStore), gilt Version 0 — crypto.Service.OpenAtVersion fällt
|
||||
// dafür auf das unveränderte Open-Verhalten zurück.
|
||||
func (s *Service) readKEKVersion(ctx context.Context, key string) (int, error) {
|
||||
reader, err := s.storage.Get(ctx, kekVersionKey(key))
|
||||
if err != nil {
|
||||
if errors.Is(err, storage.ErrNotFound) {
|
||||
return 0, nil
|
||||
}
|
||||
return 0, fmt.Errorf("encstorage: kek-version lesen: %w", err)
|
||||
}
|
||||
defer func() { _ = reader.Close() }()
|
||||
raw, err := io.ReadAll(reader)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("encstorage: kek-version lesen: %w", err)
|
||||
}
|
||||
version, err := strconv.Atoi(string(raw))
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("encstorage: kek-version parsen: %w", err)
|
||||
}
|
||||
return version, nil
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
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)
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
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})
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
// 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
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
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
|
||||
}
|
||||
@@ -1,69 +0,0 @@
|
||||
// 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")
|
||||
}
|
||||
}
|
||||
@@ -1,148 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// handleCapability ist in jedem Zustand erlaubt (RFC 3501 §6.1.1).
|
||||
func (s *Session) handleCapability(cmd command) bool {
|
||||
if err := writeUntagged(s.writer, "CAPABILITY IMAP4rev1"); err != nil {
|
||||
return false
|
||||
}
|
||||
return s.writeErr(cmd.Tag, "OK", "CAPABILITY completed")
|
||||
}
|
||||
|
||||
// handleLogin ist nur im Zustand NotAuthenticated erlaubt
|
||||
// (Akzeptanzkriterium 1/3).
|
||||
func (s *Session) handleLogin(ctx context.Context, cmd command) bool {
|
||||
if s.state != NotAuthenticated {
|
||||
return s.writeErr(cmd.Tag, "BAD", "LOGIN not allowed in "+s.state.String()+" state")
|
||||
}
|
||||
if len(cmd.Args) != 2 {
|
||||
return s.writeErr(cmd.Tag, "BAD", "LOGIN requires username and password")
|
||||
}
|
||||
if s.auth == nil {
|
||||
return s.writeErr(cmd.Tag, "NO", "LOGIN not available")
|
||||
}
|
||||
|
||||
ok, err := s.auth.Authenticate(ctx, cmd.Args[0], cmd.Args[1])
|
||||
if err != nil {
|
||||
return s.writeErr(cmd.Tag, "NO", "LOGIN failed")
|
||||
}
|
||||
if !ok {
|
||||
return s.writeErr(cmd.Tag, "NO", "LOGIN failed")
|
||||
}
|
||||
s.state = Authenticated
|
||||
return s.writeErr(cmd.Tag, "OK", "LOGIN completed")
|
||||
}
|
||||
|
||||
// handleSelect ist in Authenticated und Selected erlaubt (ein erneutes
|
||||
// SELECT wechselt das gewählte Postfach).
|
||||
func (s *Session) handleSelect(ctx context.Context, cmd command) bool {
|
||||
if s.state == NotAuthenticated {
|
||||
return s.writeErr(cmd.Tag, "BAD", "SELECT not allowed in "+s.state.String()+" state")
|
||||
}
|
||||
if len(cmd.Args) != 1 {
|
||||
return s.writeErr(cmd.Tag, "BAD", "SELECT requires a mailbox name")
|
||||
}
|
||||
if s.store == nil {
|
||||
return s.writeErr(cmd.Tag, "NO", "SELECT not available")
|
||||
}
|
||||
|
||||
mailboxName := cmd.Args[0]
|
||||
exists, ok, err := s.store.Select(ctx, mailboxName)
|
||||
if err != nil || !ok {
|
||||
// Fehlgeschlagenes SELECT lässt den Zustand laut RFC 3501 §6.3.1
|
||||
// auf Authenticated zurückfallen, nie in Selected mit ungültigem
|
||||
// Postfach hängen bleiben.
|
||||
s.state = Authenticated
|
||||
return s.writeErr(cmd.Tag, "NO", "SELECT failed: no such mailbox")
|
||||
}
|
||||
|
||||
if err := writeUntagged(s.writer, fmt.Sprintf("%d EXISTS", exists)); err != nil {
|
||||
return false
|
||||
}
|
||||
s.state = Selected
|
||||
s.mailbox = mailboxName
|
||||
s.mailboxSize = uint32(exists)
|
||||
return s.writeErr(cmd.Tag, "OK", "[READ-WRITE] SELECT completed")
|
||||
}
|
||||
|
||||
// handleFetch ist ausschließlich im Zustand Selected erlaubt
|
||||
// (Akzeptanzkriterium 1/2).
|
||||
func (s *Session) handleFetch(ctx context.Context, cmd command) bool {
|
||||
if s.state != Selected {
|
||||
return s.writeErr(cmd.Tag, "BAD", "FETCH not allowed in "+s.state.String()+" state")
|
||||
}
|
||||
if len(cmd.Args) < 1 {
|
||||
return s.writeErr(cmd.Tag, "BAD", "FETCH requires a sequence set")
|
||||
}
|
||||
|
||||
seqNumbers, err := parseSequenceSet(cmd.Args[0], s.mailboxSize)
|
||||
if err != nil {
|
||||
return s.writeErr(cmd.Tag, "BAD", "FETCH: invalid sequence set")
|
||||
}
|
||||
|
||||
messages, err := s.store.Fetch(ctx, s.mailbox, seqNumbers)
|
||||
if err != nil {
|
||||
return s.writeErr(cmd.Tag, "NO", "FETCH failed")
|
||||
}
|
||||
for _, m := range messages {
|
||||
text := fmt.Sprintf("%d FETCH (FLAGS (%s))", m.SequenceNumber, strings.Join(m.Flags, " "))
|
||||
if err := writeUntagged(s.writer, text); err != nil {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return s.writeErr(cmd.Tag, "OK", "FETCH completed")
|
||||
}
|
||||
|
||||
// handleLogout ist in jedem Zustand erlaubt und beendet die Sitzung.
|
||||
func (s *Session) handleLogout(cmd command) bool {
|
||||
if err := writeUntagged(s.writer, "BYE IMAP4rev1 Server logging out"); err != nil {
|
||||
return false
|
||||
}
|
||||
_ = s.writeErr(cmd.Tag, "OK", "LOGOUT completed")
|
||||
return false
|
||||
}
|
||||
|
||||
// parseSequenceSet unterstützt die für FETCH gebräuchlichsten Formen:
|
||||
// eine einzelne Zahl ("1"), eine kommagetrennte Liste ("1,3,5") und einen
|
||||
// Bereich mit "*" als offenem Ende ("1:*"), aufgelöst gegen maxSeq (die
|
||||
// tatsächliche Nachrichtenzahl des gewählten Postfachs, von SELECT
|
||||
// gemeldet). Volle RFC-3501-Sequenzsatz-Grammatik (verschachtelte
|
||||
// Bereiche etc.) ist bewusst nicht Bestandteil dieser kleinsten Lösung.
|
||||
func parseSequenceSet(raw string, maxSeq uint32) ([]uint32, error) {
|
||||
var result []uint32
|
||||
for _, part := range strings.Split(raw, ",") {
|
||||
if strings.Contains(part, ":") {
|
||||
bounds := strings.SplitN(part, ":", 2)
|
||||
if len(bounds) != 2 {
|
||||
return nil, fmt.Errorf("imap: ungültiger bereich %q", part)
|
||||
}
|
||||
from, err := strconv.ParseUint(bounds[0], 10, 32)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
to := uint64(maxSeq)
|
||||
if bounds[1] != "*" {
|
||||
to, err = strconv.ParseUint(bounds[1], 10, 32)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
for i := from; i <= to; i++ {
|
||||
result = append(result, uint32(i))
|
||||
}
|
||||
continue
|
||||
}
|
||||
n, err := strconv.ParseUint(part, 10, 32)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result = append(result, uint32(n))
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
@@ -1,305 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"errors"
|
||||
"net"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// fakeAuthenticator ist ein In-Memory-Authenticator für Tests — echte
|
||||
// Anbindung an Benutzerverwaltung ist Sache späterer Kacheln (IMP-01 u. a.).
|
||||
type fakeAuthenticator struct {
|
||||
users map[string]string
|
||||
}
|
||||
|
||||
func (f fakeAuthenticator) Authenticate(_ context.Context, username, password string) (bool, error) {
|
||||
want, ok := f.users[username]
|
||||
return ok && want == password, nil
|
||||
}
|
||||
|
||||
// fakeMailboxStore ist ein In-Memory-Postfachspeicher für Tests.
|
||||
type fakeMailboxStore struct {
|
||||
mailboxes map[string][]Message
|
||||
}
|
||||
|
||||
func (f fakeMailboxStore) Select(_ context.Context, mailboxName string) (int, bool, error) {
|
||||
msgs, ok := f.mailboxes[mailboxName]
|
||||
return len(msgs), ok, nil
|
||||
}
|
||||
|
||||
func (f fakeMailboxStore) Fetch(_ context.Context, mailboxName string, seqNumbers []uint32) ([]Message, error) {
|
||||
msgs, ok := f.mailboxes[mailboxName]
|
||||
if !ok {
|
||||
return nil, errors.New("imap: postfach nicht gefunden")
|
||||
}
|
||||
wanted := make(map[uint32]bool, len(seqNumbers))
|
||||
for _, n := range seqNumbers {
|
||||
wanted[n] = true
|
||||
}
|
||||
var result []Message
|
||||
for _, m := range msgs {
|
||||
if wanted[m.SequenceNumber] {
|
||||
result = append(result, m)
|
||||
}
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func startTestServer(t *testing.T) (addr string, stop func()) {
|
||||
t.Helper()
|
||||
auth := fakeAuthenticator{users: map[string]string{"alice": "geheim123"}}
|
||||
store := fakeMailboxStore{mailboxes: map[string][]Message{
|
||||
"INBOX": {
|
||||
{SequenceNumber: 1, Flags: []string{"\\Seen"}},
|
||||
{SequenceNumber: 2, Flags: []string{}},
|
||||
},
|
||||
}}
|
||||
srv := NewServer(auth, store)
|
||||
|
||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listener: %v", err)
|
||||
}
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
_ = srv.Serve(ctx, listener)
|
||||
close(done)
|
||||
}()
|
||||
|
||||
return listener.Addr().String(), func() {
|
||||
cancel()
|
||||
<-done
|
||||
}
|
||||
}
|
||||
|
||||
// imapClient ist ein minimaler Testclient (Zeile senden, Antwort lesen)
|
||||
// — bewusst kein voller IMAP-Parser, nur genug, um Server-Antworten zu
|
||||
// prüfen.
|
||||
type imapClient struct {
|
||||
conn net.Conn
|
||||
reader *bufio.Reader
|
||||
tagN int
|
||||
}
|
||||
|
||||
func dial(t *testing.T, addr string) *imapClient {
|
||||
t.Helper()
|
||||
conn, err := net.DialTimeout("tcp", addr, 2*time.Second)
|
||||
if err != nil {
|
||||
t.Fatalf("dial: %v", err)
|
||||
}
|
||||
c := &imapClient{conn: conn, reader: bufio.NewReader(conn)}
|
||||
c.readLine(t) // Begrüßung
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *imapClient) readLine(t *testing.T) string {
|
||||
t.Helper()
|
||||
_ = c.conn.SetReadDeadline(time.Now().Add(3 * time.Second))
|
||||
line, err := c.reader.ReadString('\n')
|
||||
if err != nil {
|
||||
t.Fatalf("antwort lesen: %v", err)
|
||||
}
|
||||
return strings.TrimRight(line, "\r\n")
|
||||
}
|
||||
|
||||
// sendTagged sendet ein Kommando mit neuem Tag und liest Zeilen, bis die
|
||||
// getaggte Abschlusszeile kommt — liefert alle Zeilen (inkl. Abschluss).
|
||||
func (c *imapClient) sendTagged(t *testing.T, command string) (tag string, lines []string) {
|
||||
t.Helper()
|
||||
c.tagN++
|
||||
tag = "A" + strconv.Itoa(c.tagN)
|
||||
_, err := c.conn.Write([]byte(tag + " " + command + "\r\n"))
|
||||
if err != nil {
|
||||
t.Fatalf("kommando senden: %v", err)
|
||||
}
|
||||
for {
|
||||
line := c.readLine(t)
|
||||
lines = append(lines, line)
|
||||
if strings.HasPrefix(line, tag+" ") {
|
||||
return tag, lines
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (c *imapClient) close() { _ = c.conn.Close() }
|
||||
|
||||
// TestSession_StateTransitionsAndForbiddenTransitions ist die geforderte
|
||||
// Pflichtprüfung 2: automatisierter Test deckt alle drei
|
||||
// Zustandsübergänge UND deren verbotene Übergänge ab.
|
||||
func TestSession_StateTransitionsAndForbiddenTransitions(t *testing.T) {
|
||||
addr, stop := startTestServer(t)
|
||||
defer stop()
|
||||
c := dial(t, addr)
|
||||
defer c.close()
|
||||
|
||||
// Verbotener Übergang: SELECT/FETCH in NotAuthenticated.
|
||||
_, lines := c.sendTagged(t, `SELECT INBOX`)
|
||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
||||
t.Fatalf("erwartete BAD für SELECT in NotAuthenticated, habe: %v", lines)
|
||||
}
|
||||
_, lines = c.sendTagged(t, `FETCH 1 (FLAGS)`)
|
||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
||||
t.Fatalf("erwartete BAD für FETCH in NotAuthenticated, habe: %v", lines)
|
||||
}
|
||||
|
||||
// NotAuthenticated -> Authenticated via LOGIN.
|
||||
_, lines = c.sendTagged(t, `LOGIN alice geheim123`)
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("erwartete OK für LOGIN, habe: %v", lines)
|
||||
}
|
||||
|
||||
// Verbotener Übergang: erneutes LOGIN in Authenticated.
|
||||
_, lines = c.sendTagged(t, `LOGIN alice geheim123`)
|
||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
||||
t.Fatalf("erwartete BAD für LOGIN in Authenticated, habe: %v", lines)
|
||||
}
|
||||
// Verbotener Übergang: FETCH in Authenticated (noch nicht Selected).
|
||||
_, lines = c.sendTagged(t, `FETCH 1 (FLAGS)`)
|
||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
||||
t.Fatalf("erwartete BAD für FETCH in Authenticated, habe: %v", lines)
|
||||
}
|
||||
|
||||
// Authenticated -> Selected via SELECT.
|
||||
_, lines = c.sendTagged(t, `SELECT INBOX`)
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("erwartete OK für SELECT, habe: %v", lines)
|
||||
}
|
||||
|
||||
// In Selected sind SELECT (erneut) und FETCH erlaubt.
|
||||
_, lines = c.sendTagged(t, `FETCH 1:2 (FLAGS)`)
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("erwartete OK für FETCH in Selected, habe: %v", lines)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCommands_AllBaseCommandsAnswered ist die geforderte
|
||||
// Pflichtprüfung/AC2: Grundbefehle sind implementiert und beantwortet.
|
||||
func TestCommands_AllBaseCommandsAnswered(t *testing.T) {
|
||||
addr, stop := startTestServer(t)
|
||||
defer stop()
|
||||
c := dial(t, addr)
|
||||
defer c.close()
|
||||
|
||||
_, lines := c.sendTagged(t, "CAPABILITY")
|
||||
if !containsSubstring(lines, "IMAP4rev1") {
|
||||
t.Fatalf("CAPABILITY: erwartete IMAP4rev1 in antwort, habe: %v", lines)
|
||||
}
|
||||
|
||||
_, lines = c.sendTagged(t, "LOGIN alice geheim123")
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("LOGIN fehlgeschlagen: %v", lines)
|
||||
}
|
||||
|
||||
_, lines = c.sendTagged(t, "SELECT INBOX")
|
||||
if !containsSubstring(lines, "2 EXISTS") {
|
||||
t.Fatalf("SELECT: erwartete '2 EXISTS', habe: %v", lines)
|
||||
}
|
||||
|
||||
_, lines = c.sendTagged(t, "FETCH 1 (FLAGS)")
|
||||
if !containsSubstring(lines, "FETCH (FLAGS") {
|
||||
t.Fatalf("FETCH: erwartete FLAGS-Antwort, habe: %v", lines)
|
||||
}
|
||||
|
||||
tag, lines := c.sendTagged(t, "LOGOUT")
|
||||
if !containsSubstring(lines, "BYE") {
|
||||
t.Fatalf("LOGOUT: erwartete BYE, habe: %v", lines)
|
||||
}
|
||||
if !strings.HasPrefix(lines[len(lines)-1], tag+" OK") {
|
||||
t.Fatalf("LOGOUT: erwartete getaggtes OK, habe: %v", lines)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSession_InvalidCommandKeepsConnectionOpen ist die geforderte
|
||||
// Pflichtprüfung/AC3: ungültige Kommandosequenzen werden mit korrektem
|
||||
// Fehlercode abgelehnt, NICHT mit Verbindungsabbruch.
|
||||
func TestSession_InvalidCommandKeepsConnectionOpen(t *testing.T) {
|
||||
addr, stop := startTestServer(t)
|
||||
defer stop()
|
||||
c := dial(t, addr)
|
||||
defer c.close()
|
||||
|
||||
_, lines := c.sendTagged(t, "FRIMBULATOR")
|
||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
||||
t.Fatalf("erwartete BAD für unbekanntes kommando, habe: %v", lines)
|
||||
}
|
||||
|
||||
// Verbindung muss danach real weiter funktionieren (kein Abbruch).
|
||||
_, lines = c.sendTagged(t, "CAPABILITY")
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("erwartete funktionierende verbindung nach ungültigem kommando, habe: %v", lines)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSession_MalformedLineDoesNotDisconnect deckt zusätzlich eine
|
||||
// syntaktisch fehlerhafte Zeile (kein Tag/Kommando erkennbar) ab.
|
||||
func TestSession_MalformedLineDoesNotDisconnect(t *testing.T) {
|
||||
addr, stop := startTestServer(t)
|
||||
defer stop()
|
||||
c := dial(t, addr)
|
||||
defer c.close()
|
||||
|
||||
_, err := c.conn.Write([]byte("\"unterminated\r\n"))
|
||||
if err != nil {
|
||||
t.Fatalf("senden: %v", err)
|
||||
}
|
||||
line := c.readLine(t)
|
||||
if !strings.HasPrefix(line, "* BAD") {
|
||||
t.Fatalf("erwartete '* BAD' für fehlerhafte zeile, habe: %q", line)
|
||||
}
|
||||
|
||||
_, lines := c.sendTagged(t, "CAPABILITY")
|
||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
||||
t.Fatalf("erwartete funktionierende verbindung nach fehlerhafter zeile, habe: %v", lines)
|
||||
}
|
||||
}
|
||||
|
||||
func containsSubstring(lines []string, sub string) bool {
|
||||
for _, l := range lines {
|
||||
if strings.Contains(l, sub) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// TestServer_50ParallelSessionsNoLeak ist die geforderte Pflichtprüfung
|
||||
// 3: Lasttest mit 50 parallelen Sessions ohne Ressourcenleck.
|
||||
func TestServer_50ParallelSessionsNoLeak(t *testing.T) {
|
||||
addr, stop := startTestServer(t)
|
||||
defer stop()
|
||||
|
||||
const sessions = 50
|
||||
var wg sync.WaitGroup
|
||||
errCh := make(chan error, sessions)
|
||||
|
||||
for i := 0; i < sessions; i++ {
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
conn, err := net.DialTimeout("tcp", addr, 3*time.Second)
|
||||
if err != nil {
|
||||
errCh <- err
|
||||
return
|
||||
}
|
||||
defer func() { _ = conn.Close() }()
|
||||
c := &imapClient{conn: conn, reader: bufio.NewReader(conn)}
|
||||
c.readLine(t)
|
||||
c.sendTagged(t, "LOGIN alice geheim123")
|
||||
c.sendTagged(t, "SELECT INBOX")
|
||||
c.sendTagged(t, "FETCH 1:2 (FLAGS)")
|
||||
c.sendTagged(t, "LOGOUT")
|
||||
}()
|
||||
}
|
||||
wg.Wait()
|
||||
close(errCh)
|
||||
for err := range errCh {
|
||||
t.Errorf("parallele sitzung fehlgeschlagen: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
// Package imap implementiert ING-01: das IMAP-Server-Grundgerüst
|
||||
// (TCP-Listener, Command-Parser, Session-Zustandsmaschine, Grundbefehle
|
||||
// CAPABILITY/LOGIN/SELECT/FETCH/LOGOUT). Bewusste Neuimplementierung nach
|
||||
// NEXARCH-Techstack, kein 1:1-Übernehmen von archivmail (siehe "Bekannte
|
||||
// Fehler vermeiden": Header-/Zeilen-Injection durch Stringkonkatenation
|
||||
// ohne CRLF-Prüfung — alle Antworten laufen ausschließlich über
|
||||
// writeLine/writeTagged, die eingebettete CR/LF im Text ersetzen, siehe
|
||||
// response.go).
|
||||
//
|
||||
// Authentifizierung (Authenticator) und Postfachzugriff (MailboxStore)
|
||||
// sind schmale Schnittstellen — echte Anbindung an Benutzerverwaltung/
|
||||
// Nachrichtenspeicher ist Sache späterer Ingestion-Tickets (IMP-01 u. a.,
|
||||
// siehe "Nicht Bestandteil dieser Kachel" im Ticket). Dieses Paket kennt
|
||||
// weder Core-IAM noch mail/internal/storage.
|
||||
package imap
|
||||
|
||||
import "context"
|
||||
|
||||
// Authenticator prüft Zugangsdaten für LOGIN.
|
||||
type Authenticator interface {
|
||||
Authenticate(ctx context.Context, username, password string) (ok bool, err error)
|
||||
}
|
||||
|
||||
// Message ist eine minimale Nachrichtendarstellung für FETCH (nur Flags,
|
||||
// keine Inhalte — Inhaltszugriff ist Sache späterer Kacheln).
|
||||
type Message struct {
|
||||
SequenceNumber uint32
|
||||
Flags []string
|
||||
}
|
||||
|
||||
// MailboxStore liefert Postfachzustand für SELECT/FETCH.
|
||||
type MailboxStore interface {
|
||||
// Select liefert die Anzahl der Nachrichten im Postfach mailboxName.
|
||||
// ok=false, wenn das Postfach nicht existiert.
|
||||
Select(ctx context.Context, mailboxName string) (exists int, ok bool, err error)
|
||||
// Fetch liefert die Nachrichten im aktuell gewählten Postfach, deren
|
||||
// Sequenznummer in seqNumbers enthalten ist.
|
||||
Fetch(ctx context.Context, mailboxName string, seqNumbers []uint32) ([]Message, error)
|
||||
}
|
||||
@@ -1,81 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ErrMalformedCommand wird geliefert, wenn eine Kommandozeile nicht dem
|
||||
// Grundformat "Tag SP Kommando [SP Argumente]" entspricht. Kein
|
||||
// Verbindungsabbruch (Akzeptanzkriterium 3) — der Aufrufer antwortet mit
|
||||
// einer BAD-Antwort und liest die nächste Zeile.
|
||||
var ErrMalformedCommand = errors.New("imap: fehlerhafte kommandozeile")
|
||||
|
||||
// command ist eine geparste IMAP-Kommandozeile.
|
||||
type command struct {
|
||||
Tag string
|
||||
Name string // groß geschrieben (z. B. "LOGIN")
|
||||
Args []string
|
||||
}
|
||||
|
||||
// parseCommandLine zerlegt eine Kommandozeile (bereits ohne CRLF) in Tag,
|
||||
// Kommandoname und Argumente. Unterstützt Atome und doppelt zitierte
|
||||
// Zeichenketten (mit \"- und \\-Escape) — literale Zeichenketten
|
||||
// ({n}CRLF<n Bytes>) sind bewusst NICHT Bestandteil dieser kleinsten
|
||||
// Lösung (LOGIN/SELECT/FETCH kommen in Tests/typischen Clients ohne
|
||||
// Literale aus).
|
||||
func parseCommandLine(line string) (command, error) {
|
||||
tokens, err := tokenize(line)
|
||||
if err != nil {
|
||||
return command{}, err
|
||||
}
|
||||
if len(tokens) < 2 {
|
||||
return command{}, ErrMalformedCommand
|
||||
}
|
||||
return command{
|
||||
Tag: tokens[0],
|
||||
Name: strings.ToUpper(tokens[1]),
|
||||
Args: tokens[2:],
|
||||
}, nil
|
||||
}
|
||||
|
||||
// tokenize zerlegt line in durch Leerzeichen getrennte Tokens, wobei
|
||||
// doppelt zitierte Zeichenketten als EIN Token gelten (Leerzeichen darin
|
||||
// werden nicht als Trenner behandelt).
|
||||
func tokenize(line string) ([]string, error) {
|
||||
var tokens []string
|
||||
var current strings.Builder
|
||||
inQuotes := false
|
||||
escaped := false
|
||||
hasToken := false
|
||||
|
||||
for _, r := range line {
|
||||
switch {
|
||||
case escaped:
|
||||
current.WriteRune(r)
|
||||
escaped = false
|
||||
hasToken = true
|
||||
case r == '\\' && inQuotes:
|
||||
escaped = true
|
||||
case r == '"':
|
||||
inQuotes = !inQuotes
|
||||
hasToken = true
|
||||
case r == ' ' && !inQuotes:
|
||||
if hasToken {
|
||||
tokens = append(tokens, current.String())
|
||||
current.Reset()
|
||||
hasToken = false
|
||||
}
|
||||
default:
|
||||
current.WriteRune(r)
|
||||
hasToken = true
|
||||
}
|
||||
}
|
||||
if inQuotes || escaped {
|
||||
return nil, ErrMalformedCommand
|
||||
}
|
||||
if hasToken {
|
||||
tokens = append(tokens, current.String())
|
||||
}
|
||||
return tokens, nil
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// sanitizeResponseText entfernt eingebettete CR/LF aus text, BEVOR er in
|
||||
// eine Antwortzeile eingebettet wird (Bekannter Fehler vermeiden:
|
||||
// archivmail erlaubte Header-/Zeilen-Injection durch Stringkonkatenation
|
||||
// ohne CRLF-Prüfung — jede Antwortzeile dieses Pakets läuft durch diese
|
||||
// Funktion, niemals direkte Interpolation von Nutzereingaben in eine
|
||||
// Rohantwort).
|
||||
func sanitizeResponseText(text string) string {
|
||||
text = strings.ReplaceAll(text, "\r", "")
|
||||
text = strings.ReplaceAll(text, "\n", "")
|
||||
return text
|
||||
}
|
||||
|
||||
// writeUntagged schreibt eine Server-Antwort ohne Tag ("* ...").
|
||||
func writeUntagged(w *bufio.Writer, text string) error {
|
||||
_, err := w.WriteString("* " + sanitizeResponseText(text) + "\r\n")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return w.Flush()
|
||||
}
|
||||
|
||||
// writeTagged schreibt eine getaggte Server-Antwort ("<tag> OK/NO/BAD ...").
|
||||
// tag wird ebenfalls saniert — ein Tag mit eingebettetem CRLF ist genauso
|
||||
// eine Injektionsgefahr wie der Antworttext.
|
||||
func writeTagged(w *bufio.Writer, tag, status, text string) error {
|
||||
_, err := w.WriteString(sanitizeResponseText(tag) + " " + status + " " + sanitizeResponseText(text) + "\r\n")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return w.Flush()
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
)
|
||||
|
||||
// Server nimmt IMAP-Verbindungen an und bedient jede in einer eigenen
|
||||
// Goroutine (Akzeptanzkriterium 1). STARTTLS/TLS-Absicherung ist
|
||||
// ausdrücklich Sache von ING-06, nicht dieser Kachel — Server hört per
|
||||
// Klartext-TCP, wie im Ticket vorgesehen ("Bereite höchstens die
|
||||
// Schnittstelle dafür vor").
|
||||
type Server struct {
|
||||
auth Authenticator
|
||||
store MailboxStore
|
||||
}
|
||||
|
||||
func NewServer(auth Authenticator, store MailboxStore) *Server {
|
||||
return &Server{auth: auth, store: store}
|
||||
}
|
||||
|
||||
// Serve nimmt Verbindungen auf listener an, bis ctx beendet wird oder
|
||||
// Accept endgültig fehlschlägt. Blockiert den Aufrufer.
|
||||
func (srv *Server) Serve(ctx context.Context, listener net.Listener) error {
|
||||
go func() {
|
||||
<-ctx.Done()
|
||||
_ = listener.Close()
|
||||
}()
|
||||
|
||||
for {
|
||||
conn, err := listener.Accept()
|
||||
if err != nil {
|
||||
if ctx.Err() != nil {
|
||||
return nil // beabsichtigtes Herunterfahren
|
||||
}
|
||||
var netErr net.Error
|
||||
if errors.As(err, &netErr) && netErr.Timeout() {
|
||||
continue
|
||||
}
|
||||
return fmt.Errorf("imap: verbindung annehmen: %w", err)
|
||||
}
|
||||
session := newSession(conn, srv.auth, srv.store)
|
||||
go session.Serve(ctx)
|
||||
}
|
||||
}
|
||||
@@ -1,115 +0,0 @@
|
||||
package imap
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"net"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// maxCommandLineBytes begrenzt eine einzelne Kommandozeile (Defensive
|
||||
// Fehlerbehandlung bei nicht-konformen Gegenstellen statt optimistischem
|
||||
// Parsing, siehe Ticket-Vorbild Dovecot) — verhindert unbegrenztes
|
||||
// Pufferwachstum durch eine Gegenstelle, die niemals CRLF sendet.
|
||||
const maxCommandLineBytes = 8192
|
||||
|
||||
// Session ist eine einzelne IMAP-Verbindung mit eigener
|
||||
// Zustandsmaschine (Akzeptanzkriterium 1).
|
||||
type Session struct {
|
||||
conn net.Conn
|
||||
reader *bufio.Reader
|
||||
writer *bufio.Writer
|
||||
auth Authenticator
|
||||
store MailboxStore
|
||||
state State
|
||||
mailbox string // gewähltes Postfach im Zustand Selected
|
||||
mailboxSize uint32 // Nachrichtenzahl aus dem letzten erfolgreichen SELECT
|
||||
}
|
||||
|
||||
func newSession(conn net.Conn, auth Authenticator, store MailboxStore) *Session {
|
||||
return &Session{
|
||||
conn: conn,
|
||||
reader: bufio.NewReaderSize(conn, maxCommandLineBytes),
|
||||
writer: bufio.NewWriter(conn),
|
||||
auth: auth,
|
||||
store: store,
|
||||
state: NotAuthenticated,
|
||||
}
|
||||
}
|
||||
|
||||
// State liefert den aktuellen Sitzungszustand (für Tests).
|
||||
func (s *Session) State() State { return s.state }
|
||||
|
||||
// Serve führt die Sitzung bis LOGOUT oder Verbindungsende aus.
|
||||
func (s *Session) Serve(ctx context.Context) {
|
||||
defer func() { _ = s.conn.Close() }()
|
||||
|
||||
if err := writeUntagged(s.writer, "OK IMAP4rev1 Service Ready"); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
for {
|
||||
line, err := s.readLine()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if line == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
cmd, parseErr := parseCommandLine(line)
|
||||
if parseErr != nil {
|
||||
// Akzeptanzkriterium 3: ungültige Kommandosequenz -> Fehlercode,
|
||||
// KEIN Verbindungsabbruch.
|
||||
if err := writeUntagged(s.writer, "BAD Error in IMAP command received by server."); err != nil {
|
||||
return
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
if !s.dispatch(ctx, cmd) {
|
||||
return // LOGOUT oder nicht behebbarer Schreibfehler
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// readLine liest eine CRLF- (oder LF-)terminierte Zeile ohne
|
||||
// Zeilenumbruch. Überlange Zeilen (siehe maxCommandLineBytes) werden als
|
||||
// Fehler behandelt statt unbegrenzt zu puffern.
|
||||
func (s *Session) readLine() (string, error) {
|
||||
line, err := s.reader.ReadString('\n')
|
||||
if err != nil {
|
||||
if errors.Is(err, io.EOF) && line != "" {
|
||||
// Letzte Zeile ohne abschließendes LF — als vollständige Zeile
|
||||
// behandeln, danach ohnehin Verbindungsende.
|
||||
return strings.TrimRight(line, "\r"), nil
|
||||
}
|
||||
return "", err
|
||||
}
|
||||
return strings.TrimRight(line, "\r\n"), nil
|
||||
}
|
||||
|
||||
// dispatch verarbeitet EIN geparstes Kommando. Rückgabewert false
|
||||
// bedeutet: Sitzung beenden (LOGOUT abgeschlossen oder Schreibfehler).
|
||||
func (s *Session) dispatch(ctx context.Context, cmd command) bool {
|
||||
switch cmd.Name {
|
||||
case "CAPABILITY":
|
||||
return s.handleCapability(cmd)
|
||||
case "LOGIN":
|
||||
return s.handleLogin(ctx, cmd)
|
||||
case "SELECT":
|
||||
return s.handleSelect(ctx, cmd)
|
||||
case "FETCH":
|
||||
return s.handleFetch(ctx, cmd)
|
||||
case "LOGOUT":
|
||||
return s.handleLogout(cmd)
|
||||
default:
|
||||
return s.writeErr(cmd.Tag, "BAD", "Unknown command")
|
||||
}
|
||||
}
|
||||
|
||||
func (s *Session) writeErr(tag, status, text string) bool {
|
||||
return writeTagged(s.writer, tag, status, text) == nil
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package imap
|
||||
|
||||
// State ist eine der drei IMAP4rev1-Session-Zustände (RFC 3501 §3),
|
||||
// Akzeptanzkriterium 1.
|
||||
type State int
|
||||
|
||||
const (
|
||||
NotAuthenticated State = iota
|
||||
Authenticated
|
||||
Selected
|
||||
)
|
||||
|
||||
func (s State) String() string {
|
||||
switch s {
|
||||
case NotAuthenticated:
|
||||
return "not authenticated"
|
||||
case Authenticated:
|
||||
return "authenticated"
|
||||
case Selected:
|
||||
return "selected"
|
||||
default:
|
||||
return "unknown"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
CREATE TABLE IF NOT EXISTS mail_index_jobs (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
job_type TEXT NOT NULL CHECK (job_type IN ('index', 'delete')),
|
||||
tenant_slug TEXT NOT NULL,
|
||||
message_id TEXT NOT NULL,
|
||||
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
||||
status TEXT NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'processing', 'succeeded', 'failed')),
|
||||
attempts INT NOT NULL DEFAULT 0,
|
||||
max_attempts INT NOT NULL DEFAULT 5,
|
||||
available_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
locked_at TIMESTAMPTZ,
|
||||
locked_by TEXT,
|
||||
last_error TEXT,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
)
|
||||
@@ -1,213 +0,0 @@
|
||||
// Package indexworker implementiert SRC-02: einen Indexierungs-Worker,
|
||||
// der neu archivierte Mails asynchron in den Manticore-Index (SRC-01)
|
||||
// einpflegt und Löschungen/Metadatenänderungen nachzieht. Postgres-
|
||||
// Jobqueue mit FOR UPDATE SKIP LOCKED, Stale-Lock-Wiedervorlage bei
|
||||
// Worker-Absturz — dieselbe Konvention wie dms/internal/jobqueue (FDN-04),
|
||||
// hier bewusst schlanker (kein Redis/AMQP, keine DLQ — nicht Bestandteil
|
||||
// der Akzeptanzkriterien dieser Kachel).
|
||||
package indexworker
|
||||
|
||||
import (
|
||||
"context"
|
||||
_ "embed"
|
||||
"errors"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
//go:embed migrations/0001_mail_index_jobs.sql
|
||||
var schemaMigration string
|
||||
|
||||
const (
|
||||
JobTypeIndex = "index"
|
||||
JobTypeDelete = "delete"
|
||||
)
|
||||
|
||||
const (
|
||||
StatusPending = "pending"
|
||||
StatusProcessing = "processing"
|
||||
StatusSucceeded = "succeeded"
|
||||
StatusFailed = "failed"
|
||||
)
|
||||
|
||||
// ErrNoJobAvailable wird von Dequeue geliefert, wenn aktuell kein
|
||||
// abholbarer Job vorhanden ist (Normalfall bei leerer Queue).
|
||||
var ErrNoJobAvailable = errors.New("indexworker: kein job verfügbar")
|
||||
|
||||
// ErrNotFound wird geliefert, wenn ein angefragter Job nicht existiert.
|
||||
var ErrNotFound = errors.New("indexworker: job nicht gefunden")
|
||||
|
||||
const defaultMaxAttempts = 5
|
||||
|
||||
// Job ist eine einzelne Indexierungs-/Löschaufgabe.
|
||||
type Job struct {
|
||||
ID int64
|
||||
JobType string
|
||||
TenantSlug string
|
||||
MessageID string
|
||||
Status string
|
||||
Attempts int
|
||||
}
|
||||
|
||||
// Queue kapselt den Zugriff auf mail_index_jobs.
|
||||
type Queue struct {
|
||||
pool *pgxpool.Pool
|
||||
staleLockAfter time.Duration
|
||||
}
|
||||
|
||||
// NewQueue erzeugt eine Queue. staleLockAfter legt fest, ab wann ein
|
||||
// als "processing" markierter Job wieder abholbar gilt, weil sein Worker
|
||||
// vermutlich abgestürzt ist (Akzeptanzkriterium 3: Worker-Ausfall verliert
|
||||
// keine Indexierungsaufträge).
|
||||
func NewQueue(pool *pgxpool.Pool, staleLockAfter time.Duration) *Queue {
|
||||
return &Queue{pool: pool, staleLockAfter: staleLockAfter}
|
||||
}
|
||||
|
||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
||||
// gleiches Muster wie mail/internal/dedup (kein zentraler Migrationsläufer
|
||||
// für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
||||
func (q *Queue) EnsureSchema(ctx context.Context) error {
|
||||
if _, err := q.pool.Exec(ctx, schemaMigration); err != nil {
|
||||
return fmt.Errorf("indexworker: schema anlegen: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// EnqueueIndex reiht eine Indexierungsaufgabe ein (Akzeptanzkriterium 1).
|
||||
// payload enthält die für die Indexierung nötigen Felder (Betreff, Text,
|
||||
// Anhangstext) als JSON — der Worker kennt keine Klartext-Beschaffung
|
||||
// selbst, das ist Aufgabe des Aufrufers (analog dedup, das ebenfalls
|
||||
// storage/crypto nicht kennt).
|
||||
func (q *Queue) EnqueueIndex(ctx context.Context, tenantSlug, messageID string, payload []byte) (int64, error) {
|
||||
return q.enqueue(ctx, JobTypeIndex, tenantSlug, messageID, payload)
|
||||
}
|
||||
|
||||
// EnqueueDelete reiht eine Löschaufgabe ein (Akzeptanzkriterium 2).
|
||||
func (q *Queue) EnqueueDelete(ctx context.Context, tenantSlug, messageID string) (int64, error) {
|
||||
return q.enqueue(ctx, JobTypeDelete, tenantSlug, messageID, []byte(`{}`))
|
||||
}
|
||||
|
||||
func (q *Queue) enqueue(ctx context.Context, jobType, tenantSlug, messageID string, payload []byte) (int64, error) {
|
||||
var id int64
|
||||
err := q.pool.QueryRow(ctx, `
|
||||
INSERT INTO mail_index_jobs (job_type, tenant_slug, message_id, payload, max_attempts)
|
||||
VALUES ($1, $2, $3, $4, $5)
|
||||
RETURNING id
|
||||
`, jobType, tenantSlug, messageID, payload, defaultMaxAttempts).Scan(&id)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("indexworker: job einreihen: %w", err)
|
||||
}
|
||||
return id, nil
|
||||
}
|
||||
|
||||
// dequeuedJob trägt zusätzlich den Payload, den nur das Paket selbst
|
||||
// (worker.go) benötigt.
|
||||
type dequeuedJob struct {
|
||||
Job
|
||||
Payload []byte
|
||||
}
|
||||
|
||||
// Dequeue holt GENAU EINEN abholbaren Job (fällig UND nicht gesperrt, ODER
|
||||
// dessen Sperre abgestanden ist) und markiert ihn atomar als "processing"
|
||||
// (Prüfung: Worker-Neustart mitten im Lauf verliert keinen offenen Auftrag
|
||||
// — FOR UPDATE SKIP LOCKED erlaubt mehreren Worker-Goroutinen gleichzeitigen
|
||||
// Aufruf ohne denselben Job doppelt zu holen).
|
||||
func (q *Queue) dequeue(ctx context.Context, workerID string) (*dequeuedJob, error) {
|
||||
tx, err := q.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("indexworker: transaktion starten: %w", err)
|
||||
}
|
||||
defer func() { _ = tx.Rollback(ctx) }()
|
||||
|
||||
row := tx.QueryRow(ctx, `
|
||||
SELECT id, job_type, tenant_slug, message_id, payload, status, attempts
|
||||
FROM mail_index_jobs
|
||||
WHERE (
|
||||
(status = 'pending' AND available_at <= now())
|
||||
OR (status = 'processing' AND locked_at <= now() - ($1 * interval '1 second'))
|
||||
)
|
||||
ORDER BY available_at
|
||||
FOR UPDATE SKIP LOCKED
|
||||
LIMIT 1
|
||||
`, q.staleLockAfter.Seconds())
|
||||
|
||||
var j dequeuedJob
|
||||
if err := row.Scan(&j.ID, &j.JobType, &j.TenantSlug, &j.MessageID, &j.Payload, &j.Status, &j.Attempts); err != nil {
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNoJobAvailable
|
||||
}
|
||||
return nil, fmt.Errorf("indexworker: nächsten job lesen: %w", err)
|
||||
}
|
||||
|
||||
if _, err := tx.Exec(ctx, `
|
||||
UPDATE mail_index_jobs
|
||||
SET status = 'processing', attempts = attempts + 1, locked_at = now(), locked_by = $2, updated_at = now()
|
||||
WHERE id = $1
|
||||
`, j.ID, workerID); err != nil {
|
||||
return nil, fmt.Errorf("indexworker: job sperren: %w", err)
|
||||
}
|
||||
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, fmt.Errorf("indexworker: dequeue committen: %w", err)
|
||||
}
|
||||
|
||||
j.Status = StatusProcessing
|
||||
j.Attempts++
|
||||
return &j, nil
|
||||
}
|
||||
|
||||
// complete markiert einen Job als erfolgreich abgeschlossen.
|
||||
func (q *Queue) complete(ctx context.Context, jobID int64) error {
|
||||
tag, err := q.pool.Exec(ctx, `
|
||||
UPDATE mail_index_jobs SET status = 'succeeded', locked_at = NULL, locked_by = NULL, updated_at = now()
|
||||
WHERE id = $1
|
||||
`, jobID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("indexworker: job abschließen: %w", err)
|
||||
}
|
||||
if tag.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// fail markiert einen Job als fehlgeschlagen. Sind die maximalen Versuche
|
||||
// erreicht, bleibt er dauerhaft 'failed' (keine DLQ, nicht Bestandteil
|
||||
// dieser Kachel), sonst wird er mit arithmetischem Backoff (kein
|
||||
// String-Concat für Intervalle) erneut eingeplant.
|
||||
func (q *Queue) fail(ctx context.Context, jobID int64, cause error) error {
|
||||
tag, err := q.pool.Exec(ctx, `
|
||||
UPDATE mail_index_jobs
|
||||
SET status = CASE WHEN attempts >= max_attempts THEN 'failed' ELSE 'pending' END,
|
||||
available_at = now() + (LEAST(attempts, 10) * interval '10 seconds'),
|
||||
locked_at = NULL, locked_by = NULL, last_error = $2, updated_at = now()
|
||||
WHERE id = $1
|
||||
`, jobID, cause.Error())
|
||||
if err != nil {
|
||||
return fmt.Errorf("indexworker: fehlschlag erfassen: %w", err)
|
||||
}
|
||||
if tag.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Status liefert den aktuellen Zustand eines Jobs (abrufbar über API,
|
||||
// hier als Go-API — HTTP-Anbindung ist nicht Bestandteil dieser Kachel).
|
||||
func (q *Queue) Status(ctx context.Context, jobID int64) (*Job, error) {
|
||||
var j Job
|
||||
err := q.pool.QueryRow(ctx, `
|
||||
SELECT id, job_type, tenant_slug, message_id, status, attempts
|
||||
FROM mail_index_jobs WHERE id = $1
|
||||
`, jobID).Scan(&j.ID, &j.JobType, &j.TenantSlug, &j.MessageID, &j.Status, &j.Attempts)
|
||||
if err != nil {
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
return nil, fmt.Errorf("indexworker: job-status lesen: %w", err)
|
||||
}
|
||||
return &j, nil
|
||||
}
|
||||
@@ -1,100 +0,0 @@
|
||||
// Integrationstest (SRC-02): echte Postgres-Instanz, folgt derselben
|
||||
// Testhost-Konvention wie mail/internal/dedup — TEST_TENANT_DSN.
|
||||
package indexworker
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
func setupQueue(t *testing.T, staleLockAfter time.Duration) *Queue {
|
||||
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() })
|
||||
|
||||
queue := NewQueue(pool, staleLockAfter)
|
||||
if err := queue.EnsureSchema(ctx); err != nil {
|
||||
t.Fatalf("schema: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_index_jobs WHERE tenant_slug LIKE 'mandant-src02-%'`)
|
||||
})
|
||||
return queue
|
||||
}
|
||||
|
||||
// TestDequeue_WorkerCrashMidRunLosesNoJob ist die geforderte Pflichtprüfung
|
||||
// 1: Absturz eines Workers (Job wird geholt, aber nie completed/failed)
|
||||
// führt nach Ablauf der Stale-Lock-Frist zu erneuter Zustellung an einen
|
||||
// zweiten Worker.
|
||||
func TestDequeue_WorkerCrashMidRunLosesNoJob(t *testing.T) {
|
||||
queue := setupQueue(t, 100*time.Millisecond)
|
||||
ctx := context.Background()
|
||||
|
||||
jobID, err := queue.EnqueueDelete(ctx, "mandant-src02-crash", "msg-crash-1")
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
|
||||
firstAttempt, err := queue.dequeue(ctx, "worker-1-abgestuerzt")
|
||||
if err != nil {
|
||||
t.Fatalf("erster dequeue: %v", err)
|
||||
}
|
||||
if firstAttempt.ID != jobID {
|
||||
t.Fatalf("erwartete job-id %d, habe %d", jobID, firstAttempt.ID)
|
||||
}
|
||||
// worker-1 "stürzt ab": kein complete(), kein fail() — Job bleibt
|
||||
// als "processing" mit veraltetem Lock stehen.
|
||||
|
||||
if _, err := queue.dequeue(ctx, "worker-2-sofort"); !errors.Is(err, ErrNoJobAvailable) {
|
||||
t.Fatalf("erwartete kein verfügbarer job vor ablauf der stale-lock-frist, habe: %v", err)
|
||||
}
|
||||
|
||||
time.Sleep(150 * time.Millisecond)
|
||||
|
||||
secondAttempt, err := queue.dequeue(ctx, "worker-2-nach-timeout")
|
||||
if err != nil {
|
||||
t.Fatalf("zweiter dequeue nach stale-lock-ablauf: %v", err)
|
||||
}
|
||||
if secondAttempt.ID != jobID {
|
||||
t.Fatalf("erwartete erneute zustellung desselben jobs %d, habe %d", jobID, secondAttempt.ID)
|
||||
}
|
||||
|
||||
if err := queue.complete(ctx, secondAttempt.ID); err != nil {
|
||||
t.Fatalf("complete: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestEnqueueAndStatus_RoundTrip deckt Akzeptanzkriterium 3 (Job-Status
|
||||
// abrufbar) auf Queue-Ebene ab.
|
||||
func TestEnqueueAndStatus_RoundTrip(t *testing.T) {
|
||||
queue := setupQueue(t, time.Minute)
|
||||
ctx := context.Background()
|
||||
|
||||
payload, _ := json.Marshal(map[string]string{"subject": "Test"})
|
||||
jobID, err := queue.EnqueueIndex(ctx, "mandant-src02-status", "msg-status-1", payload)
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
|
||||
job, err := queue.Status(ctx, jobID)
|
||||
if err != nil {
|
||||
t.Fatalf("status: %v", err)
|
||||
}
|
||||
if job.Status != StatusPending {
|
||||
t.Fatalf("erwartete status 'pending', habe %q", job.Status)
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user