Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bfea94b032 | ||
|
|
a9ede93176 | ||
|
|
442bb674e9 | ||
|
|
9d4c2bae4a | ||
|
|
08d54715d4 |
@@ -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,43 @@
|
|||||||
|
.PHONY: install run run-app run-worker lint fmt test build check
|
||||||
|
|
||||||
|
# Akzeptanzkriterium 1: ein Befehl installiert+startet App und Worker.
|
||||||
|
install: build
|
||||||
|
|
||||||
|
build:
|
||||||
|
go build ./...
|
||||||
|
|
||||||
|
run: build
|
||||||
|
@echo "Starte dms-app und dms-worker (Strg+C zum Beenden beider)"
|
||||||
|
@trap 'kill 0' EXIT; \
|
||||||
|
go run ./cmd/app & \
|
||||||
|
go run ./cmd/worker & \
|
||||||
|
wait
|
||||||
|
|
||||||
|
run-app:
|
||||||
|
go run ./cmd/app
|
||||||
|
|
||||||
|
run-worker:
|
||||||
|
go run ./cmd/worker
|
||||||
|
|
||||||
|
# Akzeptanzkriterium 2: Lint-/Format-Checks laufen lokal durch.
|
||||||
|
lint:
|
||||||
|
golangci-lint run ./...
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
gofmt -l .
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "gofmt-Verstoesse gefunden, siehe oben" && exit 1)
|
||||||
|
|
||||||
|
test:
|
||||||
|
# -p 1: alle Integrationstest-Pakete teilen sich dieselbe physische
|
||||||
|
# Test-Datenbank (TEST_TENANT_DSN); parallele Paketausfuehrung wuerde
|
||||||
|
# sich gegenseitig ueberschreiben (dieselbe Konvention wie NEXARCH Core,
|
||||||
|
# siehe scripts/run-checks.sh im Core-Modul).
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
|
|
||||||
|
# Setzt die geteilte Test-Datenbank zurueck, dann build/vet/test in einem
|
||||||
|
# Rutsch — analog zu NEXARCH Cores scripts/run-checks.sh.
|
||||||
|
check: build
|
||||||
|
NEXARCH_DMS_TEST_DB_PASSWORD="$${NEXARCH_DMS_TEST_DB_PASSWORD:?Setze NEXARCH_DMS_TEST_DB_PASSWORD vor dem Aufruf}" bash scripts/reset-test-env.sh
|
||||||
|
go vet ./...
|
||||||
|
golangci-lint run ./...
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# NEXARCH DMS
|
||||||
|
|
||||||
|
Dokumentenmanagement-Modul von NEXARCH. Vereint die Stärken von
|
||||||
|
paperless-ngx, Alfresco, Docspell und ecoDMS, vermeidet deren bekannte
|
||||||
|
Schwächen (siehe `known-issues-archivdms.md` im `dms-kanban/`-Ordner).
|
||||||
|
|
||||||
|
Identität, Rechte, Mandantenverwaltung, Authentifizierung, UI-Shell,
|
||||||
|
API-Grundgerüst und Benachrichtigungen kommen aus NEXARCH Core (siehe
|
||||||
|
`../` bzw. `../../core-kanban/`) — dieses Modul implementiert nur die
|
||||||
|
DMS-eigene Logik.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Voraussetzung: Go 1.22+.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd dms
|
||||||
|
make install # baut App und Worker
|
||||||
|
make run # startet beide (Strg+C beendet beide)
|
||||||
|
```
|
||||||
|
|
||||||
|
App läuft danach auf `:8090` (überschreibbar über
|
||||||
|
`NEXARCH_DMS_APP_LISTEN_ADDR`), `GET /healthz` liefert den Status.
|
||||||
|
|
||||||
|
## Struktur
|
||||||
|
|
||||||
|
- `cmd/app` — Anfrage-Dienst (HTTP), blockiert nie durch lange Aufgaben
|
||||||
|
- `cmd/worker` — Hintergrund-Dienst für lange laufende Aufgaben (Indexierung,
|
||||||
|
OCR, Storage-Vorgänge — folgen in FDN-02 ff.)
|
||||||
|
- `internal/shared` — von App und Worker gemeinsam genutzter Code
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make fmt # gofmt-Verstöße brechen ab
|
||||||
|
make lint # golangci-lint
|
||||||
|
make test # go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Branch- und Commit-Konvention
|
||||||
|
|
||||||
|
Gleiche Konvention wie NEXARCH Core:
|
||||||
|
|
||||||
|
- Branch je Ticket: `feature/<ticket-code>-<kurzbeschreibung>`, z. B.
|
||||||
|
`feature/fdn-02-datenmodell-migrationen`
|
||||||
|
- Commit-Nachricht beginnt mit dem Ticket-Code, z. B.
|
||||||
|
`FDN-02: datenmodell & migrationen`
|
||||||
|
- Ein Ticket = ein Branch. Schrittweise committen, Branch pushen, dann
|
||||||
|
anhalten (kein Merge, kein Deploy durch die bearbeitende Person selbst).
|
||||||
|
- Deutschsprachige Oberflächentexte, englischsprachige Bezeichner im Code.
|
||||||
|
- Keine Zugangsdaten/Schlüssel/Verbindungszeichenfolgen im Code —
|
||||||
|
ausschließlich über Umgebungsvariablen.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
// app ist der Anfrage-Dienst (Request-Path) des DMS — getrennt vom Worker,
|
||||||
|
// damit lange Hintergrundaufgaben nie eine HTTP-Anfrage blockieren
|
||||||
|
// (Akzeptanzkriterium/Produkt-DNA: paperless-ngx-Trennung Dienst/Worker).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/dms/internal/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
addr := os.Getenv("NEXARCH_DMS_APP_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8090"
|
||||||
|
}
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = w.Write([]byte(`{"status":"ok","service":"dms-app","version":"` + shared.Version + `"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
log.Printf("dms-app hoert auf %s (version %s)", addr, shared.Version)
|
||||||
|
if err := http.ListenAndServe(addr, mux); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHealthz ist der Nachweis, dass der App-Dienst tatsaechlich startet und
|
||||||
|
// antwortet (Akzeptanzkriterium 1: "mit einem Befehl installieren und
|
||||||
|
// starten") — geprueft ueber den Handler direkt statt einen echten Port zu
|
||||||
|
// binden, damit der Test parallel und ohne Portkonflikte laufen kann.
|
||||||
|
func TestHealthz(t *testing.T) {
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = w.Write([]byte(`{"status":"ok","service":"dms-app","version":"test"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/healthz", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
mux.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
|
||||||
|
}
|
||||||
|
if !strings.Contains(rec.Body.String(), `"status":"ok"`) {
|
||||||
|
t.Fatalf("unerwarteter body: %s", rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// worker ist der Hintergrund-Dienst des DMS — verarbeitet lange laufende
|
||||||
|
// Aufgaben (Indexierung, OCR, Storage-Vorgaenge in spaeteren Kacheln),
|
||||||
|
// getrennt vom App-Prozess (siehe cmd/app).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/dms/internal/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
log.Printf("dms-worker gestartet (version %s)", shared.Version)
|
||||||
|
|
||||||
|
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||||||
|
defer stop()
|
||||||
|
|
||||||
|
ticker := time.NewTicker(30 * time.Second)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
log.Println("dms-worker beendet")
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
// Platzhalter fuer Job-Verarbeitung (FDN-02 ff.) — Poll-Intervall
|
||||||
|
// folgt der projektweiten Postgres-Jobqueue-Konvention.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# FDN-01 – Prüfprotokoll: Repository & Projektgerüst
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen. Verzeichnis `code/dms/` im bestehenden
|
||||||
|
NEXARCH-Repository (Monorepo-Entscheidung, siehe Rückfrage im
|
||||||
|
Session-Verlauf: DMS als Unterordner statt eigenes Gitea-Repo).
|
||||||
|
|
||||||
|
## Struktur
|
||||||
|
|
||||||
|
- `cmd/app` — Anfrage-Dienst (HTTP, Port 8090 per Default)
|
||||||
|
- `cmd/worker` — Hintergrund-Dienst (getrennter Prozess)
|
||||||
|
- `internal/shared` — gemeinsam genutzter Code
|
||||||
|
- `go.mod` — eigenes Modul `gitea.perlbach24.de/scripte/nexarch/dms`,
|
||||||
|
unabhängig vom Core-Modul (kein gemeinsames `go.mod`, um Abhängigkeits-
|
||||||
|
versionen beider Module unabhängig weiterzuentwickeln)
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Zielwert | Ergebnis |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 1 | Frischer Clone baut ohne manuelle Nacharbeit | `make install` läuft ohne Fehler | **bestanden** — `go build ./...` clean auf 192.168.1.131 |
|
||||||
|
| 2 | Lint-Fehler brechen den Build ab | `make lint` liefert Exit-Code ≠ 0 bei echtem Verstoß | **bestanden** — absichtlich eingefügte ungenutzte Variable liefert Exit-Code 2, Fund korrekt lokalisiert (`declared and not used`) |
|
||||||
|
| 3 | README-Setupanleitung von zweiter Person nachvollzogen | — | **nicht durchgeführt** — keine zweite Person in dieser autonomen Sitzung verfügbar (gleiche Methodik-Abweichung wie QA-05 Prüfung 2/QA-09 Bildschirmleser-Durchlauf); ersatzweise die Anleitung selbst Schritt für Schritt auf einer frischen Kopie (`rsync` auf 192.168.1.131) nachvollzogen: `make install` → `make run` → `curl /healthz` → `{"status":"ok",...}`. |
|
||||||
|
|
||||||
|
Zusätzlich (nicht explizit gefordert, aber Teil von Akzeptanzkriterium 1
|
||||||
|
„installieren UND starten"): `make run` startet App und Worker parallel,
|
||||||
|
`GET /healthz` antwortet mit `200 {"status":"ok","service":"dms-app",...}`
|
||||||
|
innerhalb von 2 Sekunden nach Start.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131)
|
||||||
|
|
||||||
|
```
|
||||||
|
make build -> clean
|
||||||
|
make fmt -> clean (keine gofmt-Verstoesse)
|
||||||
|
make lint -> clean (golangci-lint v1.62.2: govet, staticcheck, errcheck, unused, ineffassign, gofmt, goimports)
|
||||||
|
make test -> 1/1 Pakete mit Tests ok (cmd/app), 0 Fehlschlaege
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden**, mit einer dokumentierten Methodik-Abweichung (Prüfung 3,
|
||||||
|
Vier-Augen-Nachvollzug) mangels zweiter Person — durch Selbst-Nachvollzug auf
|
||||||
|
frischer Kopie ersetzt.
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# FDN-02 – Prüfprotokoll: Datenmodell & Migrationen
|
||||||
|
|
||||||
|
Welle 2. Voraussetzung: FDN-01 (Status "Fertig").
|
||||||
|
|
||||||
|
## Datenmodell
|
||||||
|
|
||||||
|
`migrations/tenant/0001_documents.up.sql` — läuft in der physisch isolierten
|
||||||
|
Tenant-Datenbank (Modell C, siehe Core TEN-01), keine `tenant_id`-Spalte.
|
||||||
|
|
||||||
|
| Entität | Tabelle | Beziehungen |
|
||||||
|
|---|---|---|
|
||||||
|
| Ordner | `folders` | selbstreferenzierend (`parent_folder_id`), `created_by` → `users(id)` |
|
||||||
|
| Dokument | `documents` | `folder_id` → `folders`, `current_revision_id` → `file_revisions`, `created_by` → `users(id)` |
|
||||||
|
| Datei-Revision | `file_revisions` | `document_id` → `documents`, `created_by` → `users(id)`, `UNIQUE(document_id, revision_number)` |
|
||||||
|
| Tag | `tags` | — |
|
||||||
|
| Tag-Zuordnung | `document_tags` | `document_id` → `documents`, `tag_id` → `tags` |
|
||||||
|
| Metadatenfeld | `metadata_fields` | — |
|
||||||
|
| Metadatenwert | `document_metadata_values` | `document_id` → `documents`, `field_id` → `metadata_fields` |
|
||||||
|
|
||||||
|
`created_by`/Benutzerbezug referenziert `users(id)` aus Core IAM-01 (Auth
|
||||||
|
liegt vollständig in Core, siehe "Nicht Bestandteil") — DMS legt `users`
|
||||||
|
nicht selbst an, setzt die Tabelle als bereits vorhanden voraus (dieselbe
|
||||||
|
physische Tenant-Datenbank).
|
||||||
|
|
||||||
|
**Indizes:** `folders(parent_folder_id)`, `documents(folder_id)`,
|
||||||
|
`documents(created_by)`, `file_revisions(document_id)`,
|
||||||
|
`document_tags(tag_id)`, `document_metadata_values(field_id)`.
|
||||||
|
|
||||||
|
## Migrationsmechanik
|
||||||
|
|
||||||
|
`internal/migrate` — eigenständiger, minimaler Runner (kein ORM,
|
||||||
|
`*.up.sql`/`*.down.sql`-Paare), `schema_migrations`-Tabelle als
|
||||||
|
Fortschrittsspeicher (dasselbe Prinzip wie Core, hier eigenständig
|
||||||
|
implementiert, da DMS ein eigenes Go-Modul ist und Cores `internal/`-Pakete
|
||||||
|
nicht importieren kann).
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Migration auf leerer DB und auf bestehender DB getestet | **bestanden** — `TestUp_OnEmptyAndExistingDB`: erster Lauf legt alle 7 Tabellen an, zweiter Lauf gegen dieselbe (jetzt bestehende) DB wendet 0 neue Migrationen an (über `schema_migrations` erkannt) |
|
||||||
|
| 2 | Rollback stellt Vorzustand wieder her | **bestanden** — `TestDownOne_RestoresPreviousState`: nach `DownOne` existiert keine der 7 Tabellen mehr, zweiter `DownOne`-Aufruf ohne verbleibende Migration liefert korrekt leeren String statt Fehler |
|
||||||
|
| 3 | Fremdschlüssel-Constraints durch Negativtests belegt | **bestanden** — `TestForeignKeyConstraints_RejectInvalidReferences`, 4 Fälle: Dokument mit unbekanntem Ordner, unbekanntem Ersteller, Datei-Revision mit unbekanntem Dokument, Tag-Zuordnung mit unbekanntem Tag — alle vier korrekt abgewiesen |
|
||||||
|
|
||||||
|
Zusätzlich (Akzeptanzkriterium 3, Seed-Datensatz): `migrations/tenant/seed/dev_seed.sql`
|
||||||
|
manuell gegen eine frische Test-DB mit einer `users`-Zeile ausgeführt (siehe
|
||||||
|
Sitzungsprotokoll) — legt Ordner, Dokument mit Revision, Tag und
|
||||||
|
Metadatenfeld+-wert an, per Abfrage bestätigt (`Beispieldokument`,
|
||||||
|
`Beispiel-Tag`, `rechnungsnummer` vorhanden). Schlägt bewusst mit
|
||||||
|
sprechender Fehlermeldung fehl, wenn noch kein Benutzer existiert (DMS legt
|
||||||
|
`users` nicht selbst an).
|
||||||
|
|
||||||
|
## Bekannte Fehler vermeiden (aus Ticket)
|
||||||
|
|
||||||
|
„Fehlende Lock-/Sum-Datei blockiert CI" — `go.sum` ist committet (siehe
|
||||||
|
`git status`/Commit-Diff), `go mod tidy` auf 192.168.1.131 ausgeführt und
|
||||||
|
Ergebnis übernommen.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
make lint -> clean (golangci-lint)
|
||||||
|
go test ./... -v -count=1 -> 3/3 Pakete mit Tests ok (cmd/app, internal/migrate), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
erfüllt und belegt.
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
# FDN-03 – Prüfprotokoll: Objekt-Storage-Abstraktion
|
||||||
|
|
||||||
|
Welle 2. Voraussetzung: FDN-01 (Status "Fertig"), Core LIC-05 (Status
|
||||||
|
"Fertig").
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
`internal/storage`:
|
||||||
|
|
||||||
|
- `Driver`-Interface (Akzeptanzkriterium 1): `Put`/`Get`/`Delete`/`SignedURL`.
|
||||||
|
- `LocalDriver` — Entwicklungs-Treiber, Dateisystem, signierte URLs über
|
||||||
|
HMAC-SHA256 (timing-safe verglichen, `crypto/subtle`, dieselbe Konvention
|
||||||
|
wie Core IAM-15).
|
||||||
|
- `S3Driver` — Produktions-Treiber, S3-kompatibel (`aws-sdk-go-v2`),
|
||||||
|
presigned URLs über `s3.PresignClient`.
|
||||||
|
- `ObjectKey(documentID, revisionID)` — Pfadschema `documents/<id>/revisions/<id>`
|
||||||
|
innerhalb des bereits mandantenspezifischen Buckets (Akzeptanzkriterium 3;
|
||||||
|
die Bucket-Trennung selbst ist Core TEN-01).
|
||||||
|
- `Service` — verbindet `Driver` mit `UsageReporter`: jeder `Put`/`Delete`
|
||||||
|
löst genau eine Nutzungsmeldung mit der tatsächlichen Objektgröße aus
|
||||||
|
(Akzeptanzkriterium 4). Repository-Code soll ausschließlich `Service`
|
||||||
|
aufrufen, nie einen `Driver` direkt.
|
||||||
|
- `HTTPUsageReporter` — meldet über Cores Service-Credential-authentifizierten
|
||||||
|
Resync-Endpunkt (`internal/resync.Handler.UsageHandler`, API-06/AUD-06-Muster),
|
||||||
|
Metrikname `storage_bytes` (gespiegelt aus Core `internal/usage.StorageBytesMetric`,
|
||||||
|
LIC-05 — DMS kann Cores `internal/`-Pakete als eigenes Go-Modul nicht
|
||||||
|
importieren).
|
||||||
|
|
||||||
|
## Wichtiger Befund: Core-Endpunkt noch nicht live verdrahtet
|
||||||
|
|
||||||
|
`internal/resync.Handler` (die Gegenstelle für `HTTPUsageReporter`) ist im
|
||||||
|
Core-Modul vollständig implementiert und getestet, aber **in keinem
|
||||||
|
`cmd/*/main.go` registriert** (per `grep` bestätigt, Stand
|
||||||
|
2026-08-29) — dieselbe Fehlerklasse wie der QA-05/AUD-06-Befund
|
||||||
|
(Bausteine existieren, sind aber nicht in einen laufenden Dienst verdrahtet).
|
||||||
|
`HTTPUsageReporter` ist daher gegen den **dokumentierten Vertrag** (exakte
|
||||||
|
Feldnamen/Header aus `internal/resync/handler.go` gelesen) getestet, nicht
|
||||||
|
gegen eine echte laufende Core-Instanz. Prüfung 4 ist damit im Rahmen dessen
|
||||||
|
erfüllt, was DMS beeinflussen kann — die Lücke auf Core-Seite ist ein
|
||||||
|
Core-Board-Thema (Empfehlung: analog AUD-06 ein Ticket "Resync-Endpunkt in
|
||||||
|
Core-Server verdrahten" anlegen), nicht Bestandteil dieser DMS-Kachel.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Round-Trip-Test Upload/Download je Treiber | **bestanden** — `TestLocalDriver_RoundTrip` (Dateisystem) und `TestS3Driver_RoundTrip` (echtes MinIO auf 192.168.1.131, kein Mock) |
|
||||||
|
| 2 | Abgelaufene signierte URL wird abgewiesen | **bestanden** — `TestLocalDriver_SignedURL_ExpiredIsRejected` (Signatur-/Ablauflogik) UND manuell gegen echtes MinIO verifiziert: presigned URL liefert `200` innerhalb der Gültigkeit, `403` nach Ablauf (2s TTL, siehe Sitzungsprotokoll) |
|
||||||
|
| 3 | Verhalten bei fehlendem Objekt liefert klaren Fehler | **bestanden** — `TestLocalDriver_MissingObject`/`TestS3Driver_MissingObject`: beide Treiber liefern `ErrNotFound` für `Get` UND `Delete` eines nicht existierenden Objekts |
|
||||||
|
| 4 | Melde-Aufruf an Core LIC-05 bei Schreib-/Löschvorgang nachweislich ausgelöst, korrekte Größe | **bestanden** (mit Einschränkung s.o.) — `TestService_PutReportsPositiveDelta`/`TestService_DeleteReportsNegativeDelta` (Fake-Reporter zeichnet Aufrufe auf, prüft Tenant/Metrik/Delta) UND `TestHTTPUsageReporter_SendsCorrectContractToCore` (echter HTTP-Request gegen `httptest.Server`, der Cores Vertrag nachbildet — Header, JSON-Feldnamen) |
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
make lint -> clean (golangci-lint v2.1.6, aus Quelle mit go1.24.4 gebaut,
|
||||||
|
da v1.63.4 den Zielstand go1.24 nicht linten konnte —
|
||||||
|
.golangci.yml auf v2-Konfigurationsformat migriert)
|
||||||
|
go test ./internal/storage/... -v -count=1 -> 11/11 Tests ok (3 S3-Tests real
|
||||||
|
gegen lokal installiertes MinIO statt uebersprungen)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Offener Punkt: Prüfsummen-Schreibpfad noch nicht befüllt
|
||||||
|
|
||||||
|
`file_revisions.checksum_sha256` (FDN-02) wird aktuell von **keinem**
|
||||||
|
Schreibpfad befüllt oder verifiziert — `internal/storage.Service.Put`
|
||||||
|
berechnet keine Inhalts-Prüfsumme (das einzige SHA256 im Paket ist die
|
||||||
|
HMAC-Signatur lokaler URLs, siehe oben, unabhängig vom Dateiinhalt). Die
|
||||||
|
Spalte existiert seit FDN-02 ungenutzt. Nachgetragen als
|
||||||
|
Akzeptanzkriterium/Prüfung in `DOC-01` (Upload-API), das den Hash auf
|
||||||
|
Klartext berechnen und transaktional persistieren muss — Voraussetzung für
|
||||||
|
Duplikaterkennung (`DOC-02`) und die spätere Integritätsprüfung
|
||||||
|
(Archive `BAK-08`, siehe Sitzungsprotokoll 2026-08-29 zu externem,
|
||||||
|
selbst nicht überwachtem Kunden-S3-Storage).
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden**, mit einer dokumentierten Abhängigkeit auf Core-Seite
|
||||||
|
(Abschnitt "Wichtiger Befund") — Core muss `internal/resync.Handler` noch in
|
||||||
|
einen laufenden Dienst verdrahten, bevor `HTTPUsageReporter` echte
|
||||||
|
Nutzungsmeldungen an eine Produktivinstanz senden kann. Alle vier
|
||||||
|
Akzeptanzkriterien und alle vier Pflichtprüfungen im Rahmen des
|
||||||
|
DMS-seitigen Scopes erfüllt.
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# FDN-04 – Prüfprotokoll: Job-Queue & Worker-Runtime
|
||||||
|
|
||||||
|
Welle 3. Voraussetzung: FDN-02 (Status "Fertig").
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
`internal/jobqueue`:
|
||||||
|
|
||||||
|
- `migrations/tenant/0002_processing_jobs.up.sql` — `processing_jobs`-Tabelle
|
||||||
|
(Status `pending`/`processing`/`succeeded`/`failed`/`dead_letter`,
|
||||||
|
`attempts`/`max_attempts`, `available_at` für Backoff-Terminierung,
|
||||||
|
`locked_at`/`locked_by` für die Sperre, `idempotency_key` UNIQUE).
|
||||||
|
- `Queue.Enqueue` — reiht ein, mit optionalem `idempotency_key` (Dedup bei
|
||||||
|
Doppelzustellung, `ON CONFLICT DO UPDATE ... RETURNING id`).
|
||||||
|
- `Queue.Dequeue` — `FOR UPDATE SKIP LOCKED`, holt entweder einen fälligen
|
||||||
|
`pending`-Job oder einen `processing`-Job, dessen Sperre älter als
|
||||||
|
`staleLockAfter` ist (Absturz-Wiedervorlage). Backoff-Intervallarithmetik
|
||||||
|
über `LEAST(attempts, 10) * interval '30 seconds'` — arithmetischer
|
||||||
|
Cast, keine String-Konkatenation (siehe "Bekannte Fehler vermeiden").
|
||||||
|
- `Queue.Complete`/`Queue.Fail` — bei erschöpften Versuchen wandert der Job
|
||||||
|
in `dead_letter`.
|
||||||
|
- `Queue.RequeueDeadLetter` — manuelle Wiederholung eines DLQ-Eintrags.
|
||||||
|
- `Queue.Status` — Job-Status abfragbar.
|
||||||
|
- `Worker`/`Handler` — In-Prozess-Worker-Goroutine, pollt und ruft `Handler`
|
||||||
|
je Job auf.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Absturz eines Workers führt zu erneuter Zustellung | **bestanden** — `TestDequeue_StaleLockIsRedelivered`: Job wird von `worker-crashed` gesperrt, NIE completed/failed (simulierter Absturz); sofortiger erneuter Dequeue-Versuch liefert `ErrNoJobAvailable` (Sperre noch frisch), nach Ablauf von `staleLockAfter` liefert `worker-2` denselben Job |
|
||||||
|
| 2 | Idempotenz bei Doppelzustellung nachgewiesen | **bestanden** — `TestEnqueue_IdempotencyKeyPreventsDuplicate`: zweifache Einreihung mit gleichem `idempotency_key` erzeugt nachweislich nur 1 Zeile (per Abfrage bestätigt) |
|
||||||
|
| 3 | DLQ-Eintrag manuell wiederholbar | **bestanden** — `TestRequeueDeadLetter`: Job nach erschöpften Versuchen in `dead_letter`, `RequeueDeadLetter` setzt zurück auf `pending` mit `attempts=0`; Requeue eines NICHT-DLQ-Jobs wird korrekt abgewiesen |
|
||||||
|
|
||||||
|
## Reale Fehler gefunden und behoben (kein Vorab-Wissen, beim Testen entdeckt)
|
||||||
|
|
||||||
|
1. **pgx-Typinferenz-Fehler bei ungenutztem Parameter**: `Dequeue`s SQL
|
||||||
|
übergab `workerID` als `$1`, ohne es in der Query zu referenzieren —
|
||||||
|
Postgres/pgx konnte den Typ von `$1` dadurch nicht ableiten
|
||||||
|
(`SQLSTATE 42P18`). Behoben durch Entfernen des toten Parameters
|
||||||
|
(workerID wird erst im nachfolgenden `UPDATE` gebraucht).
|
||||||
|
2. **`$2::text[]`-Cast mit untypisiertem `nil`**: `typeFilter any` (statt
|
||||||
|
`[]string`) ließ pgx den Zieltyp des Casts nicht auflösen. Behoben durch
|
||||||
|
`[]string`-Typisierung der Variable.
|
||||||
|
3. **Testinfrastruktur-Drift über Sitzungsgrenzen**: `dms_tenant_test`
|
||||||
|
sammelte über mehrere Testläufe (FDN-02/03/04) `schema_migrations`-Zustand
|
||||||
|
an, wodurch `internal/migrate`s Rollback-Test nur noch einen Teil der
|
||||||
|
Tabellen zurückrollte. Neues `scripts/reset-test-env.sh` (Datenbank
|
||||||
|
droppen+neu anlegen, analog Core `scripts/reset-test-env.sh`) sowie
|
||||||
|
`make check`-Target (Reset+vet+lint+test in einem Rutsch) behoben das
|
||||||
|
strukturell. Zusätzlich fehlte `-p 1` im `test`-Target — mehrere
|
||||||
|
Testpakete teilen sich dieselbe physische Test-DB, parallele
|
||||||
|
Paketausführung (Go-Testdefault) verursachte Querschläger zwischen
|
||||||
|
`internal/jobqueue` und `internal/migrate`.
|
||||||
|
4. **`internal/jobqueue`s Test-Fixture räumte nicht auf**: `TRUNCATE` statt
|
||||||
|
`DROP TABLE` ließ die Tabelle `processing_jobs` stehen, wodurch
|
||||||
|
`internal/migrate`s eigene, versionierte Migration mit
|
||||||
|
`relation already exists` scheiterte. Behoben durch `DROP TABLE IF EXISTS`
|
||||||
|
im Test-Cleanup.
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
scripts/reset-test-env.sh -> dms_tenant_test leer neu angelegt
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 4/4 Pakete ok, 0 Fehlschläge (inkl. 8 jobqueue-Tests, 3 migrate-Tests, 6 storage-Tests real gegen MinIO)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
erfüllt. Vier reale Fehler beim Testen gefunden und behoben (zwei
|
||||||
|
Produktionscode-Bugs im SQL-Parameterhandling, zwei
|
||||||
|
Testinfrastruktur-Bugs) — bestätigt erneut den Wert, jede Prüfung
|
||||||
|
tatsächlich auf einem echten Testhost auszuführen statt nur zu behaupten.
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
module gitea.perlbach24.de/scripte/nexarch/mail
|
module gitea.perlbach24.de/scripte/nexarch/dms
|
||||||
|
|
||||||
go 1.24
|
go 1.24
|
||||||
|
|
||||||
@@ -11,7 +11,6 @@ require (
|
|||||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1
|
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1
|
||||||
github.com/aws/smithy-go v1.28.1
|
github.com/aws/smithy-go v1.28.1
|
||||||
github.com/jackc/pgx/v5 v5.6.0
|
github.com/jackc/pgx/v5 v5.6.0
|
||||||
golang.org/x/text v0.14.0
|
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
@@ -33,4 +32,5 @@ require (
|
|||||||
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
||||||
golang.org/x/crypto v0.17.0 // indirect
|
golang.org/x/crypto v0.17.0 // indirect
|
||||||
golang.org/x/sync v0.1.0 // indirect
|
golang.org/x/sync v0.1.0 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
)
|
)
|
||||||
@@ -0,0 +1,238 @@
|
|||||||
|
// Package jobqueue implementiert FDN-04: eine Postgres-gestuetzte
|
||||||
|
// Job-Queue mit Wiederholungslogik, Backoff und Dead-Letter-Queue — kein
|
||||||
|
// Redis/AMQP (siehe Ticket-Vorgabe). FOR UPDATE SKIP LOCKED erlaubt
|
||||||
|
// mehrere gleichzeitige Worker-Goroutinen (auch mehrinstanzfaehig, da der
|
||||||
|
// Zustand ausschliesslich in Postgres liegt, keine In-Memory-Zaehler —
|
||||||
|
// dieselbe Konvention wie Core internal/lockout, siehe "Bekannte Fehler
|
||||||
|
// vermeiden" im Ticket).
|
||||||
|
package jobqueue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Status-Werte spiegeln den CHECK-Constraint der Migration.
|
||||||
|
const (
|
||||||
|
StatusPending = "pending"
|
||||||
|
StatusProcessing = "processing"
|
||||||
|
StatusSucceeded = "succeeded"
|
||||||
|
StatusFailed = "failed"
|
||||||
|
StatusDeadLetter = "dead_letter"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotFound wird geliefert, wenn ein angefragter Job nicht existiert.
|
||||||
|
var ErrNotFound = errors.New("jobqueue: job nicht gefunden")
|
||||||
|
|
||||||
|
// ErrNoJobAvailable wird von Dequeue geliefert, wenn aktuell kein
|
||||||
|
// abholbarer Job vorhanden ist (kein Fehlerzustand, sondern der Normalfall
|
||||||
|
// bei leerer Queue).
|
||||||
|
var ErrNoJobAvailable = errors.New("jobqueue: kein job verfuegbar")
|
||||||
|
|
||||||
|
// Job ist eine einzelne Aufgabe in der Queue.
|
||||||
|
type Job struct {
|
||||||
|
ID string
|
||||||
|
JobType string
|
||||||
|
Payload json.RawMessage
|
||||||
|
Status string
|
||||||
|
Attempts int
|
||||||
|
MaxAttempts int
|
||||||
|
LastError *string
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultMaxAttempts/DefaultStaleLockAfter sind Standardwerte, ueberschreibbar
|
||||||
|
// je Enqueue-Aufruf (MaxAttempts) bzw. am Queue selbst (StaleLockAfter).
|
||||||
|
const (
|
||||||
|
DefaultMaxAttempts = 5
|
||||||
|
)
|
||||||
|
|
||||||
|
// Queue kapselt den Zugriff auf processing_jobs.
|
||||||
|
type Queue struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
staleLockAfter time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewQueue erzeugt eine Queue. staleLockAfter legt fest, ab wann ein
|
||||||
|
// Job, der als "processing" markiert ist, aber dessen Worker vermutlich
|
||||||
|
// abgestuerzt ist, wieder als abholbar gilt (Pruefung 1: Absturz fuehrt zu
|
||||||
|
// erneuter Zustellung) — kein Heartbeat-Mechanismus noetig, ein grosszuegiges
|
||||||
|
// Zeitfenster genuegt fuer die "kleinste Loesung".
|
||||||
|
func NewQueue(pool *pgxpool.Pool, staleLockAfter time.Duration) *Queue {
|
||||||
|
return &Queue{pool: pool, staleLockAfter: staleLockAfter}
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnqueueOptions steuert optionale Einreih-Parameter.
|
||||||
|
type EnqueueOptions struct {
|
||||||
|
// IdempotencyKey verhindert doppelte Einreihung derselben logischen
|
||||||
|
// Aufgabe (Pruefung 2: Idempotenz bei Doppelzustellung) — leer bedeutet
|
||||||
|
// kein Dedup-Anspruch.
|
||||||
|
IdempotencyKey string
|
||||||
|
MaxAttempts int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enqueue reiht einen neuen Job ein (Akzeptanzkriterium 1). Bei gesetztem
|
||||||
|
// IdempotencyKey und bereits existierendem gleichen Key wird die ID des
|
||||||
|
// BEREITS vorhandenen Jobs zurueckgegeben, kein Duplikat angelegt.
|
||||||
|
func (q *Queue) Enqueue(ctx context.Context, jobType string, payload any, opts EnqueueOptions) (string, error) {
|
||||||
|
payloadJSON, err := json.Marshal(payload)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("jobqueue: payload serialisieren: %w", err)
|
||||||
|
}
|
||||||
|
maxAttempts := opts.MaxAttempts
|
||||||
|
if maxAttempts <= 0 {
|
||||||
|
maxAttempts = DefaultMaxAttempts
|
||||||
|
}
|
||||||
|
|
||||||
|
var idempotencyKey any
|
||||||
|
if opts.IdempotencyKey != "" {
|
||||||
|
idempotencyKey = opts.IdempotencyKey
|
||||||
|
}
|
||||||
|
|
||||||
|
var id string
|
||||||
|
err = q.pool.QueryRow(ctx, `
|
||||||
|
INSERT INTO processing_jobs (job_type, payload, idempotency_key, max_attempts)
|
||||||
|
VALUES ($1, $2, $3, $4)
|
||||||
|
ON CONFLICT (idempotency_key) DO UPDATE SET job_type = processing_jobs.job_type
|
||||||
|
RETURNING id
|
||||||
|
`, jobType, payloadJSON, idempotencyKey, maxAttempts).Scan(&id)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("jobqueue: job einreihen: %w", err)
|
||||||
|
}
|
||||||
|
return id, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dequeue holt GENAU EINEN abholbaren Job (faellig UND nicht bereits von
|
||||||
|
// einem anderen Worker gesperrt, ODER dessen Sperre als abgestanden gilt)
|
||||||
|
// und markiert ihn atomar als "processing" (Akzeptanzkriterium 1 / Pruefung
|
||||||
|
// 1 — FOR UPDATE SKIP LOCKED erlaubt mehreren Worker-Goroutinen
|
||||||
|
// gleichzeitigen Aufruf ohne sich gegenseitig zu blockieren oder denselben
|
||||||
|
// Job doppelt zu holen).
|
||||||
|
func (q *Queue) Dequeue(ctx context.Context, workerID string, jobTypes []string) (*Job, error) {
|
||||||
|
tx, err := q.pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("jobqueue: transaktion starten: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = tx.Rollback(ctx) }()
|
||||||
|
|
||||||
|
var typeFilter []string
|
||||||
|
if len(jobTypes) > 0 {
|
||||||
|
typeFilter = jobTypes
|
||||||
|
}
|
||||||
|
|
||||||
|
row := tx.QueryRow(ctx, `
|
||||||
|
SELECT id, job_type, payload, status, attempts, max_attempts, last_error
|
||||||
|
FROM processing_jobs
|
||||||
|
WHERE (
|
||||||
|
(status = 'pending' AND available_at <= now())
|
||||||
|
OR (status = 'processing' AND locked_at <= now() - ($2 * interval '1 second'))
|
||||||
|
)
|
||||||
|
AND ($1::text[] IS NULL OR job_type = ANY($1))
|
||||||
|
ORDER BY available_at
|
||||||
|
FOR UPDATE SKIP LOCKED
|
||||||
|
LIMIT 1
|
||||||
|
`, typeFilter, q.staleLockAfter.Seconds())
|
||||||
|
|
||||||
|
var j Job
|
||||||
|
if err := row.Scan(&j.ID, &j.JobType, &j.Payload, &j.Status, &j.Attempts, &j.MaxAttempts, &j.LastError); err != nil {
|
||||||
|
if errors.Is(err, pgx.ErrNoRows) {
|
||||||
|
return nil, ErrNoJobAvailable
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("jobqueue: naechsten job lesen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := tx.Exec(ctx, `
|
||||||
|
UPDATE processing_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("jobqueue: job sperren: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
return nil, fmt.Errorf("jobqueue: 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 string) error {
|
||||||
|
tag, err := q.pool.Exec(ctx, `
|
||||||
|
UPDATE processing_jobs SET status = 'succeeded', locked_at = NULL, locked_by = NULL, updated_at = now()
|
||||||
|
WHERE id = $1
|
||||||
|
`, jobID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("jobqueue: job abschliessen: %w", err)
|
||||||
|
}
|
||||||
|
if tag.RowsAffected() == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail markiert einen Job als fehlgeschlagen (Akzeptanzkriterium 2): sind
|
||||||
|
// die maximalen Versuche erreicht, wandert der Job in die Dead-Letter-Queue
|
||||||
|
// (status='dead_letter'), sonst wird er mit exponentiellem Backoff erneut
|
||||||
|
// eingeplant. Backoff-Berechnung nutzt arithmetischen Intervall-Cast
|
||||||
|
// (attempts * interval), KEINE String-Konkatenation (siehe "Bekannte
|
||||||
|
// Fehler vermeiden" im Ticket).
|
||||||
|
func (q *Queue) Fail(ctx context.Context, jobID string, cause error) error {
|
||||||
|
errMsg := cause.Error()
|
||||||
|
tag, err := q.pool.Exec(ctx, `
|
||||||
|
UPDATE processing_jobs
|
||||||
|
SET status = CASE WHEN attempts >= max_attempts THEN 'dead_letter' ELSE 'pending' END,
|
||||||
|
available_at = now() + (LEAST(attempts, 10) * interval '30 seconds'),
|
||||||
|
locked_at = NULL, locked_by = NULL, last_error = $2, updated_at = now()
|
||||||
|
WHERE id = $1
|
||||||
|
`, jobID, errMsg)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("jobqueue: fehlschlag erfassen: %w", err)
|
||||||
|
}
|
||||||
|
if tag.RowsAffected() == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Status liefert den aktuellen Zustand eines Jobs (Akzeptanzkriterium 3).
|
||||||
|
func (q *Queue) Status(ctx context.Context, jobID string) (*Job, error) {
|
||||||
|
var j Job
|
||||||
|
err := q.pool.QueryRow(ctx, `
|
||||||
|
SELECT id, job_type, payload, status, attempts, max_attempts, last_error
|
||||||
|
FROM processing_jobs WHERE id = $1
|
||||||
|
`, jobID).Scan(&j.ID, &j.JobType, &j.Payload, &j.Status, &j.Attempts, &j.MaxAttempts, &j.LastError)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, pgx.ErrNoRows) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("jobqueue: job-status lesen: %w", err)
|
||||||
|
}
|
||||||
|
return &j, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequeueDeadLetter holt einen Job manuell aus der Dead-Letter-Queue zurueck
|
||||||
|
// in "pending", mit zurueckgesetztem Versuchszaehler (Pruefung 3: DLQ-Eintrag
|
||||||
|
// manuell wiederholbar). Nur fuer Jobs, die tatsaechlich in dead_letter
|
||||||
|
// stehen — verhindert versehentliches Requeue eines noch laufenden Jobs.
|
||||||
|
func (q *Queue) RequeueDeadLetter(ctx context.Context, jobID string) error {
|
||||||
|
tag, err := q.pool.Exec(ctx, `
|
||||||
|
UPDATE processing_jobs
|
||||||
|
SET status = 'pending', attempts = 0, available_at = now(), last_error = NULL, updated_at = now()
|
||||||
|
WHERE id = $1 AND status = 'dead_letter'
|
||||||
|
`, jobID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("jobqueue: dead-letter-job erneut einreihen: %w", err)
|
||||||
|
}
|
||||||
|
if tag.RowsAffected() == 0 {
|
||||||
|
return fmt.Errorf("jobqueue: job %q steht nicht in dead_letter (oder existiert nicht): %w", jobID, ErrNotFound)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,233 @@
|
|||||||
|
package jobqueue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"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 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 EXTENSION IF NOT EXISTS pgcrypto;
|
||||||
|
CREATE TABLE IF NOT EXISTS processing_jobs (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
job_type TEXT NOT NULL,
|
||||||
|
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
||||||
|
idempotency_key TEXT UNIQUE,
|
||||||
|
status TEXT NOT NULL DEFAULT 'pending'
|
||||||
|
CHECK (status IN ('pending', 'processing', 'succeeded', 'failed', 'dead_letter')),
|
||||||
|
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()
|
||||||
|
);
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
// DROP statt nur TRUNCATE: internal/jobqueue und internal/migrate teilen
|
||||||
|
// sich dieselbe physische Test-Datenbank (TEST_TENANT_DSN) ueber
|
||||||
|
// Paketgrenzen hinweg. Bliebe die Tabelle stehen, wuerde internal/migrate
|
||||||
|
// spaeter mit "relation already exists" gegen die von diesem Fixture
|
||||||
|
// angelegte, aber unversionierte Tabelle scheitern.
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_, _ = pool.Exec(context.Background(), `DROP TABLE IF EXISTS processing_jobs`)
|
||||||
|
})
|
||||||
|
return pool
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEnqueueDequeueComplete ist Akzeptanzkriterium 1: Jobs werden
|
||||||
|
// zuverlaessig eingereiht und verarbeitet.
|
||||||
|
func TestEnqueueDequeueComplete(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "index-document", map[string]string{"document_id": "d1"}, EnqueueOptions{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
job, err := q.Dequeue(ctx, "worker-1", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue: %v", err)
|
||||||
|
}
|
||||||
|
if job.ID != id {
|
||||||
|
t.Fatalf("dequeue lieferte job %q, want %q", job.ID, id)
|
||||||
|
}
|
||||||
|
if job.Status != StatusProcessing {
|
||||||
|
t.Fatalf("status nach dequeue = %q, want %q", job.Status, StatusProcessing)
|
||||||
|
}
|
||||||
|
var payload map[string]string
|
||||||
|
if err := json.Unmarshal(job.Payload, &payload); err != nil {
|
||||||
|
t.Fatalf("payload dekodieren: %v", err)
|
||||||
|
}
|
||||||
|
if payload["document_id"] != "d1" {
|
||||||
|
t.Fatalf("payload = %v, want document_id=d1", payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := q.Complete(ctx, job.ID); err != nil {
|
||||||
|
t.Fatalf("complete: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
status, err := q.Status(ctx, job.ID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status: %v", err)
|
||||||
|
}
|
||||||
|
if status.Status != StatusSucceeded {
|
||||||
|
t.Fatalf("endstatus = %q, want %q", status.Status, StatusSucceeded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDequeue_NoJobAvailable prueft den Leerfall.
|
||||||
|
func TestDequeue_NoJobAvailable(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
|
||||||
|
if _, err := q.Dequeue(context.Background(), "worker-1", nil); !errors.Is(err, ErrNoJobAvailable) {
|
||||||
|
t.Fatalf("erwartet ErrNoJobAvailable, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestFail_LandsInDeadLetterAfterMaxAttempts ist Akzeptanzkriterium 2.
|
||||||
|
func TestFail_LandsInDeadLetterAfterMaxAttempts(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "ocr", nil, EnqueueOptions{MaxAttempts: 2})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Versuch 1: schlaegt fehl, geht zurueck nach "pending" (max_attempts=2 noch nicht erreicht).
|
||||||
|
job, err := q.Dequeue(ctx, "worker-1", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue 1: %v", err)
|
||||||
|
}
|
||||||
|
if err := q.Fail(ctx, job.ID, errors.New("ocr-engine nicht erreichbar")); err != nil {
|
||||||
|
t.Fatalf("fail 1: %v", err)
|
||||||
|
}
|
||||||
|
status, err := q.Status(ctx, id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status nach fail 1: %v", err)
|
||||||
|
}
|
||||||
|
if status.Status != StatusPending {
|
||||||
|
t.Fatalf("status nach fail 1 = %q, want %q (noch nicht erschoepft)", status.Status, StatusPending)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Versuch 2: Backoff manuell umgehen (available_at direkt zuruecksetzen,
|
||||||
|
// damit der Test nicht auf echten Backoff warten muss).
|
||||||
|
if _, err := pool.Exec(ctx, `UPDATE processing_jobs SET available_at = now() WHERE id = $1`, id); err != nil {
|
||||||
|
t.Fatalf("available_at zuruecksetzen: %v", err)
|
||||||
|
}
|
||||||
|
job2, err := q.Dequeue(ctx, "worker-1", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue 2: %v", err)
|
||||||
|
}
|
||||||
|
if err := q.Fail(ctx, job2.ID, errors.New("ocr-engine weiterhin nicht erreichbar")); err != nil {
|
||||||
|
t.Fatalf("fail 2: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
final, err := q.Status(ctx, id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status nach fail 2: %v", err)
|
||||||
|
}
|
||||||
|
if final.Status != StatusDeadLetter {
|
||||||
|
t.Fatalf("status nach erschoepften versuchen = %q, want %q", final.Status, StatusDeadLetter)
|
||||||
|
}
|
||||||
|
if final.LastError == nil || *final.LastError == "" {
|
||||||
|
t.Fatal("erwartet gesetzten last_error im dead-letter-eintrag")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRequeueDeadLetter ist Pruefung 3: DLQ-Eintrag manuell wiederholbar.
|
||||||
|
func TestRequeueDeadLetter(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "convert", nil, EnqueueOptions{MaxAttempts: 1})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
job, err := q.Dequeue(ctx, "worker-1", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue: %v", err)
|
||||||
|
}
|
||||||
|
if err := q.Fail(ctx, job.ID, errors.New("konverter abgestuerzt")); err != nil {
|
||||||
|
t.Fatalf("fail: %v", err)
|
||||||
|
}
|
||||||
|
status, _ := q.Status(ctx, id)
|
||||||
|
if status.Status != StatusDeadLetter {
|
||||||
|
t.Fatalf("voraussetzung nicht erfuellt: job sollte in dead_letter stehen, ist %q", status.Status)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := q.RequeueDeadLetter(ctx, id); err != nil {
|
||||||
|
t.Fatalf("requeuedeadletter: %v", err)
|
||||||
|
}
|
||||||
|
afterRequeue, err := q.Status(ctx, id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status nach requeue: %v", err)
|
||||||
|
}
|
||||||
|
if afterRequeue.Status != StatusPending {
|
||||||
|
t.Fatalf("status nach requeue = %q, want %q", afterRequeue.Status, StatusPending)
|
||||||
|
}
|
||||||
|
if afterRequeue.Attempts != 0 {
|
||||||
|
t.Fatalf("attempts nach requeue = %d, want 0", afterRequeue.Attempts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Requeue eines NICHT in dead_letter stehenden Jobs wird abgewiesen.
|
||||||
|
if err := q.RequeueDeadLetter(ctx, id); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("requeue eines pending-jobs: erwartet ErrNotFound, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEnqueue_IdempotencyKeyPreventsDuplicate ist Pruefung 2: Idempotenz
|
||||||
|
// bei Doppelzustellung nachgewiesen (auf Einreih-Ebene).
|
||||||
|
func TestEnqueue_IdempotencyKeyPreventsDuplicate(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id1, err := q.Enqueue(ctx, "ocr", nil, EnqueueOptions{IdempotencyKey: "ocr:revision-42"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue 1: %v", err)
|
||||||
|
}
|
||||||
|
id2, err := q.Enqueue(ctx, "ocr", nil, EnqueueOptions{IdempotencyKey: "ocr:revision-42"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue 2 (doppelzustellung): %v", err)
|
||||||
|
}
|
||||||
|
if id1 != id2 {
|
||||||
|
t.Fatalf("doppelte einreihung mit gleichem idempotency-key erzeugte zwei jobs: %q != %q", id1, id2)
|
||||||
|
}
|
||||||
|
|
||||||
|
var count int
|
||||||
|
if err := pool.QueryRow(ctx, `SELECT count(*) FROM processing_jobs WHERE idempotency_key = 'ocr:revision-42'`).Scan(&count); err != nil {
|
||||||
|
t.Fatalf("zeilen zaehlen: %v", err)
|
||||||
|
}
|
||||||
|
if count != 1 {
|
||||||
|
t.Fatalf("erwartet genau 1 zeile fuer den idempotency-key, habe %d", count)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
package jobqueue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Handler verarbeitet einen einzelnen Job. Ein zurueckgegebener Fehler
|
||||||
|
// fuehrt zu Queue.Fail (Backoff/DLQ), nil zu Queue.Complete.
|
||||||
|
type Handler func(ctx context.Context, job *Job) error
|
||||||
|
|
||||||
|
// Worker pollt die Queue in einer In-Prozess-Goroutine und ruft Handler je
|
||||||
|
// abgeholtem Job auf — die "In-Prozess-Worker-Goroutinen" aus der
|
||||||
|
// Ticket-Vorgabe, kein separater Prozess/Redis noetig.
|
||||||
|
type Worker struct {
|
||||||
|
queue *Queue
|
||||||
|
workerID string
|
||||||
|
jobTypes []string
|
||||||
|
pollInterval time.Duration
|
||||||
|
handler Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewWorker(queue *Queue, workerID string, jobTypes []string, pollInterval time.Duration, handler Handler) *Worker {
|
||||||
|
return &Worker{queue: queue, workerID: workerID, jobTypes: jobTypes, pollInterval: pollInterval, handler: handler}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run blockiert, bis ctx beendet wird, und verarbeitet dabei fortlaufend
|
||||||
|
// Jobs. Absturzsicherheit (Pruefung 1) entsteht NICHT durch Run selbst,
|
||||||
|
// sondern dadurch, dass ein abgestuerzter Prozess (der Run gar nicht mehr
|
||||||
|
// ausfuehrt) seine "processing"-Sperren nie verlaengert — ein ANDERER
|
||||||
|
// Worker-Prozess holt den Job nach Ablauf von staleLockAfter erneut ab
|
||||||
|
// (siehe Queue.Dequeue).
|
||||||
|
func (w *Worker) Run(ctx context.Context) {
|
||||||
|
ticker := time.NewTicker(w.pollInterval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
w.processOne(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// processOne holt und verarbeitet EINEN Job, falls verfuegbar. Oeffentlich
|
||||||
|
// über RunOnce fuer Tests, die deterministisch (ohne Polling-Timing) einen
|
||||||
|
// einzelnen Verarbeitungsschritt auslösen wollen.
|
||||||
|
func (w *Worker) processOne(ctx context.Context) {
|
||||||
|
job, err := w.queue.Dequeue(ctx, w.workerID, w.jobTypes)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, ErrNoJobAvailable) {
|
||||||
|
log.Printf("jobqueue: dequeue fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if handlerErr := w.handler(ctx, job); handlerErr != nil {
|
||||||
|
if err := w.queue.Fail(ctx, job.ID, handlerErr); err != nil {
|
||||||
|
log.Printf("jobqueue: fehlschlag fuer job %q nicht erfassbar: %v", job.ID, err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := w.queue.Complete(ctx, job.ID); err != nil {
|
||||||
|
log.Printf("jobqueue: abschluss fuer job %q fehlgeschlagen: %v", job.ID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunOnce verarbeitet synchron genau einen Job (falls verfuegbar) und
|
||||||
|
// kehrt zurueck — fuer Tests, die ohne Polling-Intervall arbeiten wollen.
|
||||||
|
func (w *Worker) RunOnce(ctx context.Context) {
|
||||||
|
w.processOne(ctx)
|
||||||
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
package jobqueue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestWorker_RunOnce_ProcessesAndCompletesJob ist der End-to-End-Nachweis
|
||||||
|
// fuer Akzeptanzkriterium 1 ueber den Worker statt direkt ueber Queue.
|
||||||
|
func TestWorker_RunOnce_ProcessesAndCompletesJob(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "index-document", nil, EnqueueOptions{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var handled int32
|
||||||
|
w := NewWorker(q, "worker-1", nil, time.Millisecond, func(ctx context.Context, job *Job) error {
|
||||||
|
atomic.AddInt32(&handled, 1)
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
if atomic.LoadInt32(&handled) != 1 {
|
||||||
|
t.Fatalf("handler wurde %d mal aufgerufen, want 1", handled)
|
||||||
|
}
|
||||||
|
status, err := q.Status(ctx, id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status: %v", err)
|
||||||
|
}
|
||||||
|
if status.Status != StatusSucceeded {
|
||||||
|
t.Fatalf("status = %q, want %q", status.Status, StatusSucceeded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWorker_HandlerErrorTriggersFail prueft, dass ein Handler-Fehler zu
|
||||||
|
// Queue.Fail fuehrt (Backoff/DLQ-Pfad ueber den Worker statt direkt).
|
||||||
|
func TestWorker_HandlerErrorTriggersFail(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
q := NewQueue(pool, time.Minute)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "ocr", nil, EnqueueOptions{MaxAttempts: 5})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := NewWorker(q, "worker-1", nil, time.Millisecond, func(ctx context.Context, job *Job) error {
|
||||||
|
return errors.New("ocr fehlgeschlagen")
|
||||||
|
})
|
||||||
|
w.RunOnce(ctx)
|
||||||
|
|
||||||
|
status, err := q.Status(ctx, id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("status: %v", err)
|
||||||
|
}
|
||||||
|
if status.Status != StatusPending {
|
||||||
|
t.Fatalf("status nach handler-fehler = %q, want %q (erneut eingeplant)", status.Status, StatusPending)
|
||||||
|
}
|
||||||
|
if status.LastError == nil || *status.LastError != "ocr fehlgeschlagen" {
|
||||||
|
t.Fatalf("last_error = %v, want %q", status.LastError, "ocr fehlgeschlagen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDequeue_StaleLockIsRedelivered ist Pruefung 1: Absturz eines Workers
|
||||||
|
// fuehrt zu erneuter Zustellung. Simuliert einen Absturz, indem ein Job
|
||||||
|
// dequeued (auf "processing" gesperrt), aber NIE completed/failed wird —
|
||||||
|
// nach Ablauf von staleLockAfter muss ein ANDERER Worker denselben Job
|
||||||
|
// erneut abholen koennen.
|
||||||
|
func TestDequeue_StaleLockIsRedelivered(t *testing.T) {
|
||||||
|
pool := setupTest(t)
|
||||||
|
// Sehr kurzes Stale-Fenster, damit der Test nicht lange warten muss.
|
||||||
|
q := NewQueue(pool, 50*time.Millisecond)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
id, err := q.Enqueue(ctx, "convert", nil, EnqueueOptions{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("enqueue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
crashed, err := q.Dequeue(ctx, "worker-crashed", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue (worker-crashed): %v", err)
|
||||||
|
}
|
||||||
|
if crashed.ID != id {
|
||||||
|
t.Fatalf("dequeue lieferte unerwarteten job %q", crashed.ID)
|
||||||
|
}
|
||||||
|
// worker-crashed ruft absichtlich weder Complete noch Fail auf — simuliert
|
||||||
|
// einen Prozessabsturz mitten in der Verarbeitung.
|
||||||
|
|
||||||
|
// Sofortiger erneuter Dequeue-Versuch (Sperre noch frisch) darf den Job
|
||||||
|
// NICHT liefern.
|
||||||
|
if _, err := q.Dequeue(ctx, "worker-2", nil); !errors.Is(err, ErrNoJobAvailable) {
|
||||||
|
t.Fatalf("job wurde trotz frischer sperre erneut ausgeliefert (oder anderer fehler): %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
time.Sleep(80 * time.Millisecond) // > staleLockAfter
|
||||||
|
|
||||||
|
redelivered, err := q.Dequeue(ctx, "worker-2", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dequeue nach ablauf der sperre: %v", err)
|
||||||
|
}
|
||||||
|
if redelivered.ID != id {
|
||||||
|
t.Fatalf("erneut zugestellter job = %q, want %q", redelivered.ID, id)
|
||||||
|
}
|
||||||
|
if err := q.Complete(ctx, redelivered.ID); err != nil {
|
||||||
|
t.Fatalf("complete durch worker-2: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
// Package migrate implementiert FDN-02s Migrationsmechanik: versionierte,
|
||||||
|
// rueckrollbare SQL-Migrationsdateien (kein ORM), mit einer
|
||||||
|
// schema_migrations-Tabelle als Fortschrittsspeicher — dasselbe Prinzip wie
|
||||||
|
// NEXARCH Core (internal/migrate), hier eigenstaendig implementiert, da DMS
|
||||||
|
// ein eigenes Go-Modul ist und Cores internal/-Pakete nicht importieren
|
||||||
|
// kann.
|
||||||
|
package migrate
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Migration ist eine einzelne versionierte Migrationsdatei.
|
||||||
|
type Migration struct {
|
||||||
|
Version string // Dateiname ohne .up.sql/.down.sql, z.B. "0001_documents"
|
||||||
|
UpSQL string
|
||||||
|
DownSQL string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load liest alle *.up.sql/*.down.sql-Paare aus dir, sortiert nach
|
||||||
|
// Dateiname (Akzeptanzkriterium: Migrationen sind versioniert).
|
||||||
|
func Load(dir string) ([]Migration, error) {
|
||||||
|
entries, err := os.ReadDir(dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migrationsverzeichnis %q lesen: %w", dir, err)
|
||||||
|
}
|
||||||
|
var versions []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() || !strings.HasSuffix(e.Name(), ".up.sql") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
versions = append(versions, strings.TrimSuffix(e.Name(), ".up.sql"))
|
||||||
|
}
|
||||||
|
sort.Strings(versions)
|
||||||
|
|
||||||
|
migrations := make([]Migration, 0, len(versions))
|
||||||
|
for _, v := range versions {
|
||||||
|
up, err := os.ReadFile(filepath.Join(dir, v+".up.sql"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migration %q: up.sql lesen: %w", v, err)
|
||||||
|
}
|
||||||
|
down, err := os.ReadFile(filepath.Join(dir, v+".down.sql"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("migration %q: down.sql lesen (jede Migration braucht ein Rollback): %w", v, err)
|
||||||
|
}
|
||||||
|
migrations = append(migrations, Migration{Version: v, UpSQL: string(up), DownSQL: string(down)})
|
||||||
|
}
|
||||||
|
return migrations, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func ensureTrackingTable(ctx context.Context, pool *pgxpool.Pool) error {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS schema_migrations (
|
||||||
|
version TEXT PRIMARY KEY,
|
||||||
|
applied_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
)
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("schema_migrations anlegen: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func appliedVersions(ctx context.Context, pool *pgxpool.Pool) (map[string]bool, error) {
|
||||||
|
rows, err := pool.Query(ctx, `SELECT version FROM schema_migrations`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("angewendete migrationen lesen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
applied := map[string]bool{}
|
||||||
|
for rows.Next() {
|
||||||
|
var v string
|
||||||
|
if err := rows.Scan(&v); err != nil {
|
||||||
|
return nil, fmt.Errorf("migrationsversion lesen: %w", err)
|
||||||
|
}
|
||||||
|
applied[v] = true
|
||||||
|
}
|
||||||
|
return applied, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Up wendet alle noch nicht angewendeten Migrationen in Reihenfolge an
|
||||||
|
// (Akzeptanzkriterium 2: vorwaerts ausfuehrbar) — bereits angewendete
|
||||||
|
// werden uebersprungen, damit Up auf einer leeren UND auf einer bestehenden
|
||||||
|
// DB funktioniert (Pruefung 1).
|
||||||
|
func Up(ctx context.Context, pool *pgxpool.Pool, migrations []Migration) (applied []string, err error) {
|
||||||
|
if err := ensureTrackingTable(ctx, pool); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
already, err := appliedVersions(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, m := range migrations {
|
||||||
|
if already[m.Version] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
tx, err := pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return applied, fmt.Errorf("transaktion fuer %q starten: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, m.UpSQL); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return applied, fmt.Errorf("migration %q anwenden: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, `INSERT INTO schema_migrations (version) VALUES ($1)`, m.Version); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return applied, fmt.Errorf("migration %q als angewendet markieren: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
return applied, fmt.Errorf("migration %q committen: %w", m.Version, err)
|
||||||
|
}
|
||||||
|
applied = append(applied, m.Version)
|
||||||
|
}
|
||||||
|
return applied, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DownOne macht die zuletzt angewendete Migration rueckgaengig
|
||||||
|
// (Akzeptanzkriterium 2: rueckwaerts ausfuehrbar) und liefert deren Version,
|
||||||
|
// oder "" falls keine Migration angewendet war.
|
||||||
|
func DownOne(ctx context.Context, pool *pgxpool.Pool, migrations []Migration) (version string, err error) {
|
||||||
|
if err := ensureTrackingTable(ctx, pool); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
already, err := appliedVersions(ctx, pool)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
var last *Migration
|
||||||
|
for i := len(migrations) - 1; i >= 0; i-- {
|
||||||
|
if already[migrations[i].Version] {
|
||||||
|
last = &migrations[i]
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if last == nil {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
tx, err := pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("transaktion fuer rollback von %q starten: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, last.DownSQL); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return "", fmt.Errorf("migration %q zurueckrollen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec(ctx, `DELETE FROM schema_migrations WHERE version = $1`, last.Version); err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
return "", fmt.Errorf("migration %q aus schema_migrations entfernen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
return "", fmt.Errorf("rollback von %q committen: %w", last.Version, err)
|
||||||
|
}
|
||||||
|
return last.Version, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,213 @@
|
|||||||
|
package migrate
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// usersFixtureSQL spiegelt Core IAM-01s reales Schema
|
||||||
|
// (migrations/tenant/0001_users.up.sql im NEXARCH-Core-Modul) - DMS ist ein
|
||||||
|
// eigenes Go-Modul und kann Cores Migrationsdateien nicht importieren, daher
|
||||||
|
// hier als Testfixture kopiert, NICHT als Produktionsmigration (DMS legt
|
||||||
|
// users nicht selbst an, siehe "Nicht Bestandteil" in FDN-02).
|
||||||
|
const usersFixtureSQL = `
|
||||||
|
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||||
|
CREATE TABLE IF NOT EXISTS users (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
email TEXT NOT NULL UNIQUE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active',
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
`
|
||||||
|
|
||||||
|
func setupTest(t *testing.T) (*pgxpool.Pool, []Migration) {
|
||||||
|
t.Helper()
|
||||||
|
dsn := os.Getenv("TEST_TENANT_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { pool.Close() })
|
||||||
|
|
||||||
|
if _, err := pool.Exec(ctx, usersFixtureSQL); err != nil {
|
||||||
|
t.Fatalf("users-fixture anlegen: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO users (email, name) VALUES ('seed@example.test', 'Seed-Benutzer')
|
||||||
|
ON CONFLICT (email) DO NOTHING
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("seed-benutzer anlegen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
migrations, err := Load(migrationsDir(t))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("migrationen laden: %v", err)
|
||||||
|
}
|
||||||
|
return pool, migrations
|
||||||
|
}
|
||||||
|
|
||||||
|
func migrationsDir(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
wd, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("getwd: %v", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(wd, "..", "..", "migrations", "tenant")
|
||||||
|
}
|
||||||
|
|
||||||
|
func tableExists(t *testing.T, ctx context.Context, pool *pgxpool.Pool, name string) bool {
|
||||||
|
t.Helper()
|
||||||
|
var exists bool
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_name = $1)
|
||||||
|
`, name).Scan(&exists); err != nil {
|
||||||
|
t.Fatalf("tabellenexistenz von %q pruefen: %v", name, err)
|
||||||
|
}
|
||||||
|
return exists
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUp_OnEmptyAndExistingDB ist Pruefung 1: Migration auf leerer DB und
|
||||||
|
// auf bestehender DB getestet.
|
||||||
|
func TestUp_OnEmptyAndExistingDB(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
applied, err := Up(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("up (leere db): %v", err)
|
||||||
|
}
|
||||||
|
if len(applied) == 0 {
|
||||||
|
t.Fatal("erwartet mindestens 1 angewendete migration auf leerer db")
|
||||||
|
}
|
||||||
|
for _, table := range []string{"folders", "documents", "file_revisions", "tags", "document_tags", "metadata_fields", "document_metadata_values"} {
|
||||||
|
if !tableExists(t, ctx, pool, table) {
|
||||||
|
t.Fatalf("tabelle %q existiert nach Up nicht", table)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zweiter Up-Lauf gegen die JETZT BESTEHENDE db - muss ohne Fehler
|
||||||
|
// durchlaufen und darf nichts erneut anwenden (idempotent ueber
|
||||||
|
// schema_migrations).
|
||||||
|
appliedAgain, err := Up(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("up (bestehende db, zweiter lauf): %v", err)
|
||||||
|
}
|
||||||
|
if len(appliedAgain) != 0 {
|
||||||
|
t.Fatalf("zweiter Up-Lauf haette 0 neue migrationen anwenden sollen, hat %d", len(appliedAgain))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDownOne_RestoresPreviousState ist Pruefung 2: Rollback stellt den
|
||||||
|
// Vorzustand wieder her.
|
||||||
|
func TestDownOne_RestoresPreviousState(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := Up(ctx, pool, migrations); err != nil {
|
||||||
|
t.Fatalf("up: %v", err)
|
||||||
|
}
|
||||||
|
if !tableExists(t, ctx, pool, "documents") {
|
||||||
|
t.Fatal("voraussetzung nicht erfuellt: documents sollte nach Up existieren")
|
||||||
|
}
|
||||||
|
|
||||||
|
// DownOne rollt IMMER nur die zuletzt angewendete Migration zurueck
|
||||||
|
// (dokumentiertes Verhalten) — bei mehreren Migrationen (z.B. FDN-02
|
||||||
|
// documents + FDN-04 processing_jobs) muss man entsprechend oft
|
||||||
|
// aufrufen. Anzahl der Wiederholungen richtet sich NICHT nach dem
|
||||||
|
// Rueckgabewert von Up() (der nur die in DIESEM Aufruf NEU angewendeten
|
||||||
|
// Migrationen zaehlt, siehe Kommentar an Up) — stattdessen wird
|
||||||
|
// wiederholt, bis DownOne "" liefert (schema_migrations leer).
|
||||||
|
for i := 0; i < len(migrations); i++ {
|
||||||
|
version, err := DownOne(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("downone (lauf %d): %v", i, err)
|
||||||
|
}
|
||||||
|
if version == "" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, table := range []string{"folders", "documents", "file_revisions", "tags", "document_tags", "metadata_fields", "document_metadata_values", "processing_jobs"} {
|
||||||
|
if tableExists(t, ctx, pool, table) {
|
||||||
|
t.Fatalf("tabelle %q existiert nach vollstaendigem Rollback noch - Vorzustand nicht wiederhergestellt", table)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Erneutes DownOne ohne verbleibende angewendete Migration liefert "".
|
||||||
|
versionAfterAll, err := DownOne(ctx, pool, migrations)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("downone (nichts mehr anzuwenden): %v", err)
|
||||||
|
}
|
||||||
|
if versionAfterAll != "" {
|
||||||
|
t.Fatalf("erwartet leeren string bei leerer schema_migrations, habe %q", versionAfterAll)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestForeignKeyConstraints_RejectInvalidReferences ist Pruefung 3:
|
||||||
|
// Fremdschluessel-Constraints durch Negativtests belegt.
|
||||||
|
func TestForeignKeyConstraints_RejectInvalidReferences(t *testing.T) {
|
||||||
|
pool, migrations := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
if _, err := Up(ctx, pool, migrations); err != nil {
|
||||||
|
t.Fatalf("up: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var userID string
|
||||||
|
if err := pool.QueryRow(ctx, `SELECT id FROM users LIMIT 1`).Scan(&userID); err != nil {
|
||||||
|
t.Fatalf("seed-benutzer lesen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Run("dokument mit unbekanntem ordner wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO documents (folder_id, title, created_by) VALUES (gen_random_uuid(), 'x', $1)
|
||||||
|
`, userID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem folder_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("dokument mit unbekanntem ersteller wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO documents (title, created_by) VALUES ('x', gen_random_uuid())
|
||||||
|
`)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem created_by haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("datei-revision mit unbekanntem dokument wird abgewiesen", func(t *testing.T) {
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO file_revisions (document_id, revision_number, storage_key, checksum_sha256, size_bytes, mime_type, created_by)
|
||||||
|
VALUES (gen_random_uuid(), 1, 'k', repeat('0',64), 1, 'text/plain', $1)
|
||||||
|
`, userID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem document_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("tag-zuordnung mit unbekanntem tag wird abgewiesen", func(t *testing.T) {
|
||||||
|
var docID string
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
INSERT INTO documents (title, created_by) VALUES ('fk-test-doc', $1) RETURNING id
|
||||||
|
`, userID).Scan(&docID); err != nil {
|
||||||
|
t.Fatalf("testdokument anlegen: %v", err)
|
||||||
|
}
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO document_tags (document_id, tag_id) VALUES ($1, gen_random_uuid())
|
||||||
|
`, docID)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("insert mit unbekanntem tag_id haette scheitern muessen")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
// Package shared enthaelt Code, der von App und Worker gemeinsam genutzt
|
||||||
|
// wird (FDN-01) — Datenmodell, Storage-Zugriff etc. kommen in spaeteren
|
||||||
|
// Kacheln (FDN-02/FDN-03) hierher, dieses Paket ist bewusst noch schlank.
|
||||||
|
package shared
|
||||||
|
|
||||||
|
// Version ist die aktuelle DMS-Version, per -ldflags ueberschreibbar
|
||||||
|
// (siehe Makefile) — Platzhalter fuer echtes Versionsmanagement.
|
||||||
|
var Version = "dev"
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
// Package storage implementiert FDN-03: eine einheitliche Objekt-Storage-
|
||||||
|
// Abstraktion mit zwei austauschbaren Treibern (lokal fuer Entwicklung,
|
||||||
|
// S3-kompatibel fuer Produktion). Verschluesselung at rest ist NICHT
|
||||||
|
// Bestandteil dieser Kachel (siehe FDN-09) — dieses Paket legt Bytes
|
||||||
|
// unveraendert ab.
|
||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotFound wird geliefert, wenn ein angefragtes Objekt nicht existiert
|
||||||
|
// (Akzeptanzkriterium/Pruefung 3: klarer Fehler statt treiberspezifischer
|
||||||
|
// Fehlertypen, die der Aufrufer sonst je Treiber unterschiedlich behandeln
|
||||||
|
// muesste).
|
||||||
|
var ErrNotFound = errors.New("storage: objekt nicht gefunden")
|
||||||
|
|
||||||
|
// Driver ist die EINE Schnittstelle, gegen die der Rest von DMS arbeitet
|
||||||
|
// (Akzeptanzkriterium 1). Zwei Implementierungen: LocalDriver (Entwicklung)
|
||||||
|
// und S3Driver (Produktion, S3-kompatibel).
|
||||||
|
type Driver interface {
|
||||||
|
// Put legt die Bytes aus r unter key ab und liefert die tatsaechlich
|
||||||
|
// geschriebene Groesse in Bytes.
|
||||||
|
Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error)
|
||||||
|
// Get liefert die Bytes unter key. Existiert key nicht, liefert Get
|
||||||
|
// ErrNotFound.
|
||||||
|
Get(ctx context.Context, key string) (io.ReadCloser, error)
|
||||||
|
// Delete entfernt das Objekt unter key. Existiert key nicht, liefert
|
||||||
|
// Delete ErrNotFound.
|
||||||
|
Delete(ctx context.Context, key string) error
|
||||||
|
// SignedURL liefert eine zeitlich begrenzte, signierte URL zum Lesen des
|
||||||
|
// Objekts (Akzeptanzkriterium 2: konfigurierbare Gueltigkeit ueber ttl).
|
||||||
|
SignedURL(ctx context.Context, key string, ttl time.Duration) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ObjectKey liefert das Pfadschema fuer ein Dokument/Revision INNERHALB des
|
||||||
|
// Mandanten-Buckets (Akzeptanzkriterium 3) — die Bucket-Trennung selbst ist
|
||||||
|
// Sache von Core TEN-01, hier geht es nur um den Pfad innerhalb eines
|
||||||
|
// bereits mandantenspezifischen Buckets.
|
||||||
|
func ObjectKey(documentID, revisionID string) string {
|
||||||
|
return "documents/" + documentID + "/revisions/" + revisionID
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrURLExpired wird von VerifySignedURL geliefert, wenn eine signierte URL
|
||||||
|
// nach Ablauf ihrer Gueltigkeit verwendet wird (Pruefung 2).
|
||||||
|
var ErrURLExpired = errors.New("storage: signierte url ist abgelaufen")
|
||||||
|
|
||||||
|
// ErrInvalidSignature wird geliefert, wenn die Signatur einer URL nicht zum
|
||||||
|
// Schluessel passt (manipulierte oder falsche URL).
|
||||||
|
var ErrInvalidSignature = errors.New("storage: signatur der url ist ungueltig")
|
||||||
|
|
||||||
|
// LocalDriver legt Objekte im lokalen Dateisystem ab — der Entwicklungs-
|
||||||
|
// Treiber (Akzeptanzkriterium 1), keine externe Abhaengigkeit noetig.
|
||||||
|
type LocalDriver struct {
|
||||||
|
baseDir string
|
||||||
|
signingSecret []byte
|
||||||
|
publicBaseURL string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewLocalDriver erzeugt einen LocalDriver. signingSecret authentifiziert
|
||||||
|
// die von SignedURL ausgestellten URLs (HMAC-SHA256, konstant-zeit-
|
||||||
|
// verglichen bei der Verifikation — timing-safe wie projektweite Konvention,
|
||||||
|
// siehe Core IAM-15).
|
||||||
|
func NewLocalDriver(baseDir string, signingSecret []byte, publicBaseURL string) *LocalDriver {
|
||||||
|
return &LocalDriver{baseDir: baseDir, signingSecret: signingSecret, publicBaseURL: publicBaseURL}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) path(key string) string {
|
||||||
|
return filepath.Join(d.baseDir, filepath.FromSlash(key))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error) {
|
||||||
|
full := d.path(key)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||||
|
return 0, fmt.Errorf("storage: verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
f, err := os.Create(full)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("storage: datei anlegen: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
written, err := io.Copy(f, r)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("storage: schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return written, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
||||||
|
f, err := os.Open(d.path(key))
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("storage: lesen: %w", err)
|
||||||
|
}
|
||||||
|
return f, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) Delete(ctx context.Context, key string) error {
|
||||||
|
if err := os.Remove(d.path(key)); err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return fmt.Errorf("storage: loeschen: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) SignedURL(ctx context.Context, key string, ttl time.Duration) (string, error) {
|
||||||
|
expiry := time.Now().Add(ttl).Unix()
|
||||||
|
sig := d.sign(key, expiry)
|
||||||
|
return fmt.Sprintf("%s/%s?exp=%d&sig=%s", strings.TrimRight(d.publicBaseURL, "/"), key, expiry, sig), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *LocalDriver) sign(key string, expiry int64) string {
|
||||||
|
mac := hmac.New(sha256.New, d.signingSecret)
|
||||||
|
mac.Write([]byte(key))
|
||||||
|
mac.Write([]byte(strconv.FormatInt(expiry, 10)))
|
||||||
|
return base64.RawURLEncoding.EncodeToString(mac.Sum(nil))
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifySignedURL prueft key/expiry/sig, wie sie z.B. aus den Query-
|
||||||
|
// Parametern einer von SignedURL ausgestellten URL stammen (Pruefung 2:
|
||||||
|
// abgelaufene URL wird abgewiesen). Die eigentliche HTTP-Auslieferung ist
|
||||||
|
// nicht Bestandteil dieser Kachel (siehe DOC-01) — hier wird nur die
|
||||||
|
// Signatur-/Ablauflogik bereitgestellt und getestet.
|
||||||
|
func (d *LocalDriver) VerifySignedURL(key string, expiry int64, sig string) error {
|
||||||
|
expected := d.sign(key, expiry)
|
||||||
|
if subtle.ConstantTimeCompare([]byte(expected), []byte(sig)) != 1 {
|
||||||
|
return ErrInvalidSignature
|
||||||
|
}
|
||||||
|
if time.Now().Unix() > expiry {
|
||||||
|
return ErrURLExpired
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func newTestLocalDriver(t *testing.T) *LocalDriver {
|
||||||
|
t.Helper()
|
||||||
|
return NewLocalDriver(t.TempDir(), []byte("test-signing-secret"), "https://files.example.test")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLocalDriver_RoundTrip ist Pruefung 1 fuer den lokalen Treiber:
|
||||||
|
// Upload/Download-Roundtrip.
|
||||||
|
func TestLocalDriver_RoundTrip(t *testing.T) {
|
||||||
|
d := newTestLocalDriver(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "documents/doc-1/revisions/rev-1"
|
||||||
|
content := []byte("hallo welt")
|
||||||
|
|
||||||
|
written, err := d.Put(ctx, key, bytes.NewReader(content), int64(len(content)), "text/plain")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("put: %v", err)
|
||||||
|
}
|
||||||
|
if written != int64(len(content)) {
|
||||||
|
t.Fatalf("geschriebene groesse = %d, want %d", written, len(content))
|
||||||
|
}
|
||||||
|
|
||||||
|
rc, err := d.Get(ctx, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("get: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = rc.Close() }()
|
||||||
|
got, err := io.ReadAll(rc)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("lesen: %v", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(got, content) {
|
||||||
|
t.Fatalf("gelesener inhalt = %q, want %q", got, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLocalDriver_MissingObject ist Pruefung 3: klarer Fehler bei
|
||||||
|
// fehlendem Objekt, sowohl fuer Get als auch Delete.
|
||||||
|
func TestLocalDriver_MissingObject(t *testing.T) {
|
||||||
|
d := newTestLocalDriver(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := d.Get(ctx, "nie-angelegt"); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("get eines fehlenden objekts: erwartet ErrNotFound, habe %v", err)
|
||||||
|
}
|
||||||
|
if err := d.Delete(ctx, "nie-angelegt"); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("delete eines fehlenden objekts: erwartet ErrNotFound, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLocalDriver_SignedURL_ExpiredIsRejected ist Pruefung 2: eine
|
||||||
|
// abgelaufene signierte URL wird abgewiesen.
|
||||||
|
func TestLocalDriver_SignedURL_ExpiredIsRejected(t *testing.T) {
|
||||||
|
d := newTestLocalDriver(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "documents/doc-2/revisions/rev-1"
|
||||||
|
|
||||||
|
// Gueltige, noch nicht abgelaufene URL wird akzeptiert.
|
||||||
|
urlValid, err := d.SignedURL(ctx, key, time.Hour)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("signedurl (gueltig): %v", err)
|
||||||
|
}
|
||||||
|
expiry, sig := parseSignedURLQuery(t, urlValid)
|
||||||
|
if err := d.VerifySignedURL(key, expiry, sig); err != nil {
|
||||||
|
t.Fatalf("gueltige url wurde abgewiesen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bereits abgelaufene URL (negative TTL) wird abgewiesen.
|
||||||
|
urlExpired, err := d.SignedURL(ctx, key, -time.Hour)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("signedurl (abgelaufen): %v", err)
|
||||||
|
}
|
||||||
|
expiredExpiry, expiredSig := parseSignedURLQuery(t, urlExpired)
|
||||||
|
if err := d.VerifySignedURL(key, expiredExpiry, expiredSig); !errors.Is(err, ErrURLExpired) {
|
||||||
|
t.Fatalf("abgelaufene url: erwartet ErrURLExpired, habe %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manipulierte Signatur wird abgewiesen.
|
||||||
|
if err := d.VerifySignedURL(key, expiry, "manipuliert"); !errors.Is(err, ErrInvalidSignature) {
|
||||||
|
t.Fatalf("manipulierte signatur: erwartet ErrInvalidSignature, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseSignedURLQuery(t *testing.T, rawURL string) (expiry int64, sig string) {
|
||||||
|
t.Helper()
|
||||||
|
parsed, err := url.Parse(rawURL)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("signierte url parsen: %v (%s)", err, rawURL)
|
||||||
|
}
|
||||||
|
q := parsed.Query()
|
||||||
|
expInt, err := strconv.ParseInt(q.Get("exp"), 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("exp parsen: %v", err)
|
||||||
|
}
|
||||||
|
return expInt, q.Get("sig")
|
||||||
|
}
|
||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/aws/aws-sdk-go-v2/aws"
|
"github.com/aws/aws-sdk-go-v2/aws"
|
||||||
"github.com/aws/aws-sdk-go-v2/config"
|
"github.com/aws/aws-sdk-go-v2/config"
|
||||||
@@ -17,14 +18,18 @@ import (
|
|||||||
|
|
||||||
// S3Driver legt Objekte in einem S3-kompatiblen Objektspeicher ab — der
|
// S3Driver legt Objekte in einem S3-kompatiblen Objektspeicher ab — der
|
||||||
// Produktions-Treiber (Akzeptanzkriterium 1). Funktioniert gegen echtes
|
// Produktions-Treiber (Akzeptanzkriterium 1). Funktioniert gegen echtes
|
||||||
// AWS S3 UND gegen jeden S3-kompatiblen Anbieter (MinIO etc.) über
|
// AWS S3 UND gegen jeden S3-kompatiblen Anbieter (MinIO etc.) ueber
|
||||||
// endpointURL. Gleiches, bewährtes Muster wie DMS FDN-03s S3Driver
|
// endpointURL — bewusst offenes Objektformat statt Herstellerbindung
|
||||||
// (bewusste Kopie, Mail kann DMS nicht importieren).
|
// (Produkt-DNA: "jederzeit ohne Herstellerwerkzeug lesbar").
|
||||||
type S3Driver struct {
|
type S3Driver struct {
|
||||||
client *s3.Client
|
client *s3.Client
|
||||||
bucket string
|
bucket string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewS3Driver verbindet zu einem S3-kompatiblen Endpunkt. endpointURL leer
|
||||||
|
// laesst den AWS-SDK-Standardendpunkt (echtes AWS S3) gelten,
|
||||||
|
// usePathStyle=true ist fuer die meisten Nicht-AWS-S3-kompatiblen Anbieter
|
||||||
|
// (MinIO, etc.) noetig.
|
||||||
func NewS3Driver(ctx context.Context, bucket, region, endpointURL, accessKeyID, secretAccessKey string, usePathStyle bool) (*S3Driver, error) {
|
func NewS3Driver(ctx context.Context, bucket, region, endpointURL, accessKeyID, secretAccessKey string, usePathStyle bool) (*S3Driver, error) {
|
||||||
cfg, err := config.LoadDefaultConfig(ctx,
|
cfg, err := config.LoadDefaultConfig(ctx,
|
||||||
config.WithRegion(region),
|
config.WithRegion(region),
|
||||||
@@ -43,7 +48,7 @@ func NewS3Driver(ctx context.Context, bucket, region, endpointURL, accessKeyID,
|
|||||||
return &S3Driver{client: client, bucket: bucket}, nil
|
return &S3Driver{client: client, bucket: bucket}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (d *S3Driver) Put(ctx context.Context, key string, r io.Reader, _ int64, contentType string) (int64, error) {
|
func (d *S3Driver) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error) {
|
||||||
buf, err := io.ReadAll(r)
|
buf, err := io.ReadAll(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, fmt.Errorf("storage: objekt vor upload lesen: %w", err)
|
return 0, fmt.Errorf("storage: objekt vor upload lesen: %w", err)
|
||||||
@@ -51,7 +56,7 @@ func (d *S3Driver) Put(ctx context.Context, key string, r io.Reader, _ int64, co
|
|||||||
_, err = d.client.PutObject(ctx, &s3.PutObjectInput{
|
_, err = d.client.PutObject(ctx, &s3.PutObjectInput{
|
||||||
Bucket: aws.String(d.bucket),
|
Bucket: aws.String(d.bucket),
|
||||||
Key: aws.String(key),
|
Key: aws.String(key),
|
||||||
Body: bytes.NewReader(buf),
|
Body: bytesReader(buf),
|
||||||
ContentLength: aws.Int64(int64(len(buf))),
|
ContentLength: aws.Int64(int64(len(buf))),
|
||||||
ContentType: aws.String(contentType),
|
ContentType: aws.String(contentType),
|
||||||
})
|
})
|
||||||
@@ -76,27 +81,47 @@ func (d *S3Driver) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (d *S3Driver) Delete(ctx context.Context, key string) error {
|
func (d *S3Driver) Delete(ctx context.Context, key string) error {
|
||||||
// S3 liefert bei DeleteObject fuer ein nicht existierendes Objekt
|
// S3 liefert bei DeleteObject fuer ein nicht existierendes Objekt KEINEN
|
||||||
// KEINEN Fehler (idempotente S3-API-Semantik) — um denselben
|
// Fehler (idempotente Semantik der S3-API) — um denselben Vertrag wie
|
||||||
// Vertrag wie LocalDriver (ErrNotFound bei fehlendem Objekt) zu
|
// LocalDriver (ErrNotFound bei fehlendem Objekt) zu erfuellen, wird die
|
||||||
// erfüllen, wird die Existenz vorher explizit geprüft.
|
// Existenz vorher explizit geprueft (Pruefung 3).
|
||||||
_, err := d.client.HeadObject(ctx, &s3.HeadObjectInput{Bucket: aws.String(d.bucket), Key: aws.String(key)})
|
_, err := d.client.HeadObject(ctx, &s3.HeadObjectInput{Bucket: aws.String(d.bucket), Key: aws.String(key)})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if isS3NotFound(err) {
|
if isS3NotFound(err) {
|
||||||
return ErrNotFound
|
return ErrNotFound
|
||||||
}
|
}
|
||||||
return fmt.Errorf("storage: s3-existenzprüfung vor löschen: %w", err)
|
return fmt.Errorf("storage: s3-existenzpruefung vor loeschen: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, err := d.client.DeleteObject(ctx, &s3.DeleteObjectInput{
|
if _, err := d.client.DeleteObject(ctx, &s3.DeleteObjectInput{
|
||||||
Bucket: aws.String(d.bucket),
|
Bucket: aws.String(d.bucket),
|
||||||
Key: aws.String(key),
|
Key: aws.String(key),
|
||||||
}); err != nil {
|
}); err != nil {
|
||||||
return fmt.Errorf("storage: s3-löschen: %w", err)
|
return fmt.Errorf("storage: s3-loeschen: %w", err)
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (d *S3Driver) SignedURL(ctx context.Context, key string, ttl time.Duration) (string, error) {
|
||||||
|
presignClient := s3.NewPresignClient(d.client)
|
||||||
|
req, err := presignClient.PresignGetObject(ctx, &s3.GetObjectInput{
|
||||||
|
Bucket: aws.String(d.bucket),
|
||||||
|
Key: aws.String(key),
|
||||||
|
}, s3.WithPresignExpires(ttl))
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("storage: presigned url erzeugen: %w", err)
|
||||||
|
}
|
||||||
|
return req.URL, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func bytesReader(b []byte) *bytes.Reader {
|
||||||
|
return bytes.NewReader(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// isS3NotFound erkennt sowohl den typisierten NoSuchKey-Fehler
|
||||||
|
// (GetObject) als auch den generischen "NotFound"-API-Fehlercode
|
||||||
|
// (HeadObject liefert keinen typisierten NoSuchKey, sondern einen
|
||||||
|
// generischen smithy-API-Fehler mit Code "NotFound").
|
||||||
func isS3NotFound(err error) bool {
|
func isS3NotFound(err error) bool {
|
||||||
var nsk *types.NoSuchKey
|
var nsk *types.NoSuchKey
|
||||||
if errors.As(err, &nsk) {
|
if errors.As(err, &nsk) {
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// requireS3TestEnv liefert die S3-Testkonfiguration oder ueberspringt den
|
||||||
|
// Test — dasselbe Muster wie TEST_ADMIN_DSN im Core-Modul: kein S3-
|
||||||
|
// kompatibler Speicher in dieser Umgebung verfuegbar/geprueft (siehe
|
||||||
|
// FDN-03-Pruefprotokoll), daher hier bewusst als optional markiert statt
|
||||||
|
// den Treiber ungetestet zu lassen.
|
||||||
|
func requireS3TestEnv(t *testing.T) *S3Driver {
|
||||||
|
t.Helper()
|
||||||
|
bucket := os.Getenv("TEST_S3_BUCKET")
|
||||||
|
if bucket == "" {
|
||||||
|
t.Skip("TEST_S3_BUCKET nicht gesetzt, S3-Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
endpoint := os.Getenv("TEST_S3_ENDPOINT")
|
||||||
|
region := os.Getenv("TEST_S3_REGION")
|
||||||
|
if region == "" {
|
||||||
|
region = "us-east-1"
|
||||||
|
}
|
||||||
|
accessKey := os.Getenv("TEST_S3_ACCESS_KEY_ID")
|
||||||
|
secretKey := os.Getenv("TEST_S3_SECRET_ACCESS_KEY")
|
||||||
|
|
||||||
|
d, err := NewS3Driver(context.Background(), bucket, region, endpoint, accessKey, secretKey, true)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("s3-treiber aufbauen: %v", err)
|
||||||
|
}
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestS3Driver_RoundTrip ist Pruefung 1 fuer den S3-Treiber.
|
||||||
|
func TestS3Driver_RoundTrip(t *testing.T) {
|
||||||
|
d := requireS3TestEnv(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "fdn03-test/roundtrip"
|
||||||
|
content := []byte("s3 roundtrip inhalt")
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = d.Delete(ctx, key) })
|
||||||
|
|
||||||
|
if _, err := d.Put(ctx, key, bytes.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
||||||
|
t.Fatalf("put: %v", err)
|
||||||
|
}
|
||||||
|
rc, err := d.Get(ctx, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("get: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = rc.Close() }()
|
||||||
|
got, err := io.ReadAll(rc)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("lesen: %v", err)
|
||||||
|
}
|
||||||
|
if !bytes.Equal(got, content) {
|
||||||
|
t.Fatalf("gelesener inhalt = %q, want %q", got, content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestS3Driver_MissingObject ist Pruefung 3 fuer den S3-Treiber.
|
||||||
|
func TestS3Driver_MissingObject(t *testing.T) {
|
||||||
|
d := requireS3TestEnv(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := d.Get(ctx, "fdn03-test/nie-angelegt"); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("get eines fehlenden objekts: erwartet ErrNotFound, habe %v", err)
|
||||||
|
}
|
||||||
|
if err := d.Delete(ctx, "fdn03-test/nie-angelegt"); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("delete eines fehlenden objekts: erwartet ErrNotFound, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestS3Driver_SignedURL ist Pruefung 2 fuer den S3-Treiber: eine
|
||||||
|
// presigned URL wird erzeugt und ist innerhalb der Gueltigkeit abrufbar.
|
||||||
|
func TestS3Driver_SignedURL(t *testing.T) {
|
||||||
|
d := requireS3TestEnv(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "fdn03-test/signed-url"
|
||||||
|
content := []byte("presigned")
|
||||||
|
t.Cleanup(func() { _ = d.Delete(ctx, key) })
|
||||||
|
|
||||||
|
if _, err := d.Put(ctx, key, bytes.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
||||||
|
t.Fatalf("put: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
url, err := d.SignedURL(ctx, key, time.Minute)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("signedurl: %v", err)
|
||||||
|
}
|
||||||
|
if url == "" {
|
||||||
|
t.Fatal("erwartet nicht-leere presigned url")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Service verbindet einen Driver mit der Nutzungsmeldung an Core
|
||||||
|
// (Akzeptanzkriterium 4) — jeder Schreib-/Loeschvorgang ueber Service loest
|
||||||
|
// GENAU EINE Meldung mit der tatsaechlich geschriebenen/geloeschten
|
||||||
|
// Objektgroesse aus. Repository-/Handler-Code (spaetere Kacheln, z.B.
|
||||||
|
// DOC-01) ruft ausschliesslich Service auf, nie einen Driver direkt — das
|
||||||
|
// verhindert einen Schreibpfad, der die Nutzungsmeldung vergisst.
|
||||||
|
type Service struct {
|
||||||
|
driver Driver
|
||||||
|
usage UsageReporter
|
||||||
|
tenantSlug string
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewService(driver Driver, usage UsageReporter, tenantSlug string) *Service {
|
||||||
|
return &Service{driver: driver, usage: usage, tenantSlug: tenantSlug}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put legt das Objekt ab und meldet die geschriebene Groesse als positives
|
||||||
|
// Delta (Pruefung 4).
|
||||||
|
func (s *Service) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error) {
|
||||||
|
written, err := s.driver.Put(ctx, key, r, size, contentType)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, written); err != nil {
|
||||||
|
return written, fmt.Errorf("storage: objekt gespeichert, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
||||||
|
}
|
||||||
|
return written, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
||||||
|
return s.driver.Get(ctx, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete entfernt das Objekt und meldet dessen Groesse als negatives Delta
|
||||||
|
// (Pruefung 4) — dafuer muss der Aufrufer die Groesse kennen (z.B. aus
|
||||||
|
// file_revisions.size_bytes, FDN-02), da Delete selbst die Groesse eines
|
||||||
|
// bereits geloeschten Objekts nicht mehr ermitteln kann.
|
||||||
|
func (s *Service) Delete(ctx context.Context, key string, sizeBytes int64) error {
|
||||||
|
if err := s.driver.Delete(ctx, key); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, -sizeBytes); err != nil {
|
||||||
|
return fmt.Errorf("storage: objekt geloescht, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) SignedURL(ctx context.Context, key string, ttl time.Duration) (string, error) {
|
||||||
|
return s.driver.SignedURL(ctx, key, ttl)
|
||||||
|
}
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeUsageReporter zeichnet jeden Report-Aufruf auf, damit Tests
|
||||||
|
// nachweisen koennen, dass Service tatsaechlich meldet (Akzeptanzkriterium
|
||||||
|
// 4 / Pruefung 4) — ohne echten HTTP-Aufruf gegen Core.
|
||||||
|
type fakeUsageReporter struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
calls []reportCall
|
||||||
|
failOn int // wenn >0, schlaegt der reportCall-te Aufruf fehl
|
||||||
|
}
|
||||||
|
|
||||||
|
type reportCall struct {
|
||||||
|
tenantSlug string
|
||||||
|
metric string
|
||||||
|
delta int64
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeUsageReporter) Report(ctx context.Context, tenantSlug, metric string, delta int64) error {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
f.calls = append(f.calls, reportCall{tenantSlug, metric, delta})
|
||||||
|
if f.failOn > 0 && len(f.calls) == f.failOn {
|
||||||
|
return context.DeadlineExceeded
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestService_PutReportsPositiveDelta ist Pruefung 4 (Schreibvorgang):
|
||||||
|
// Melde-Aufruf an Core wird bei Put ausgeloest, mit korrekter Groesse.
|
||||||
|
func TestService_PutReportsPositiveDelta(t *testing.T) {
|
||||||
|
driver := NewLocalDriver(t.TempDir(), []byte("secret"), "https://files.example.test")
|
||||||
|
usage := &fakeUsageReporter{}
|
||||||
|
svc := NewService(driver, usage, "acme")
|
||||||
|
|
||||||
|
content := []byte("zwoelf bytes")
|
||||||
|
if _, err := svc.Put(context.Background(), "documents/d1/revisions/r1", bytes.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
||||||
|
t.Fatalf("put: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(usage.calls) != 1 {
|
||||||
|
t.Fatalf("erwartet 1 nutzungsmeldung, habe %d", len(usage.calls))
|
||||||
|
}
|
||||||
|
call := usage.calls[0]
|
||||||
|
if call.tenantSlug != "acme" || call.metric != UsageMetric || call.delta != int64(len(content)) {
|
||||||
|
t.Fatalf("unerwarteter meldungsinhalt: %+v", call)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestService_DeleteReportsNegativeDelta ist Pruefung 4 (Loeschvorgang).
|
||||||
|
func TestService_DeleteReportsNegativeDelta(t *testing.T) {
|
||||||
|
driver := NewLocalDriver(t.TempDir(), []byte("secret"), "https://files.example.test")
|
||||||
|
usage := &fakeUsageReporter{}
|
||||||
|
svc := NewService(driver, usage, "acme")
|
||||||
|
ctx := context.Background()
|
||||||
|
key := "documents/d2/revisions/r1"
|
||||||
|
|
||||||
|
if _, err := svc.Put(ctx, key, bytes.NewReader([]byte("abc")), 3, "text/plain"); err != nil {
|
||||||
|
t.Fatalf("put: %v", err)
|
||||||
|
}
|
||||||
|
if err := svc.Delete(ctx, key, 3); err != nil {
|
||||||
|
t.Fatalf("delete: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(usage.calls) != 2 {
|
||||||
|
t.Fatalf("erwartet 2 nutzungsmeldungen (put+delete), habe %d", len(usage.calls))
|
||||||
|
}
|
||||||
|
del := usage.calls[1]
|
||||||
|
if del.delta != -3 {
|
||||||
|
t.Fatalf("delete-delta = %d, want -3", del.delta)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestService_GetMissingObjectReturnsClearError ist Pruefung 3 auf
|
||||||
|
// Service-Ebene.
|
||||||
|
func TestService_GetMissingObjectReturnsClearError(t *testing.T) {
|
||||||
|
driver := NewLocalDriver(t.TempDir(), []byte("secret"), "https://files.example.test")
|
||||||
|
svc := NewService(driver, &fakeUsageReporter{}, "acme")
|
||||||
|
|
||||||
|
if _, err := svc.Get(context.Background(), "nie-angelegt"); err == nil {
|
||||||
|
t.Fatal("get eines fehlenden objekts haette einen fehler liefern muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,33 +8,33 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
)
|
)
|
||||||
|
|
||||||
// UsageMetric ist der Metrikname, unter dem Core (internal/usage,
|
// UsageMetric ist der Metrikname, unter dem Core (internal/usage, LIC-05)
|
||||||
// LIC-05) den Speicherverbrauch je Mandant führt — muss exakt
|
// den Speicherverbrauch je Mandant fuehrt — muss exakt
|
||||||
// internal/usage.StorageBytesMetric aus dem NEXARCH-Core-Modul
|
// internal/usage.StorageBytesMetric aus dem NEXARCH-Core-Modul entsprechen
|
||||||
// entsprechen (Mail kann Core nicht importieren, daher hier gespiegelt
|
// (Core kann von DMS als eigenem Go-Modul nicht importiert werden, daher
|
||||||
// — identisches Muster wie DMS FDN-03).
|
// hier als Konstante gespiegelt statt importiert).
|
||||||
const UsageMetric = "storage_bytes"
|
const UsageMetric = "storage_bytes"
|
||||||
|
|
||||||
// UsageReporter meldet Speicherverbrauchsänderungen an Core
|
// UsageReporter meldet Speicherverbrauchsaenderungen an Core (Akzeptanz-
|
||||||
// (Akzeptanzkriterium 4). Schmale Schnittstelle, damit Tests einen
|
// kriterium 4). Schmale Schnittstelle, damit Tests einen Fake statt eines
|
||||||
// Fake statt eines echten HTTP-Aufrufs einsetzen können.
|
// echten HTTP-Aufrufs einsetzen koennen.
|
||||||
type UsageReporter interface {
|
type UsageReporter interface {
|
||||||
Report(ctx context.Context, tenantSlug, metric string, delta int64) error
|
Report(ctx context.Context, tenantSlug, metric string, delta int64) error
|
||||||
}
|
}
|
||||||
|
|
||||||
// usageDeltaDTO entspricht Core internal/resync.usageDeltaDTO
|
// usageDeltaDTO entspricht Core internal/resync.usageDeltaDTO
|
||||||
// (JSON-Vertrag: tenant_slug/metric/delta), über den API-11
|
// (JSON-Vertrag: tenant_slug/metric/delta) — dieselbe Struktur, hier
|
||||||
// (resync-api) real erreichbar ist.
|
// gespiegelt, da DMS Cores internal/-Pakete nicht importieren kann.
|
||||||
type usageDeltaDTO struct {
|
type usageDeltaDTO struct {
|
||||||
TenantSlug string `json:"tenant_slug"`
|
TenantSlug string `json:"tenant_slug"`
|
||||||
Metric string `json:"metric"`
|
Metric string `json:"metric"`
|
||||||
Delta int64 `json:"delta"`
|
Delta int64 `json:"delta"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// HTTPUsageReporter meldet über Core API-11 (resync-api,
|
// HTTPUsageReporter meldet ueber Cores Resync-Nutzungs-Endpunkt
|
||||||
// internal/resync.Handler.UsageHandler), authentifiziert über
|
// (internal/resync.Handler.UsageHandler, API-06), authentifiziert ueber
|
||||||
// dasselbe Service-Credential-Verfahren wie jeder andere Modul-Core-
|
// dasselbe Service-Credential-Verfahren wie jeder andere Modul-Core-Aufruf
|
||||||
// Aufruf (API-02).
|
// (API-02).
|
||||||
type HTTPUsageReporter struct {
|
type HTTPUsageReporter struct {
|
||||||
endpointURL string
|
endpointURL string
|
||||||
clientID string
|
clientID string
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestHTTPUsageReporter_SendsCorrectContractToCore ist der Nachweis, dass
|
||||||
|
// HTTPUsageReporter exakt den Vertrag von Core internal/resync.Handler.
|
||||||
|
// UsageHandler bedient (Service-Credential-Header, JSON-Feldnamen) — echte
|
||||||
|
// Vernetzung gegen einen laufenden Core-Prozess ist nicht Teil dieses
|
||||||
|
// Tests (internal/resync.Handler ist in Core aktuell in keinem cmd/*/
|
||||||
|
// main.go verdrahtet, siehe FDN-03-Pruefprotokoll), daher hier gegen einen
|
||||||
|
// httptest-Server geprueft, der denselben Vertrag nachbildet.
|
||||||
|
func TestHTTPUsageReporter_SendsCorrectContractToCore(t *testing.T) {
|
||||||
|
var gotClientID, gotClientSecret string
|
||||||
|
var gotBody []usageDeltaDTO
|
||||||
|
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
gotClientID = r.Header.Get("X-Nexarch-Client-Id")
|
||||||
|
gotClientSecret = r.Header.Get("X-Nexarch-Client-Secret")
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&gotBody); err != nil {
|
||||||
|
t.Errorf("anfrage-koerper dekodieren: %v", err)
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]int{"applied": len(gotBody)})
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
reporter := NewHTTPUsageReporter(srv.URL, "dms-service-client", "dms-service-secret", nil)
|
||||||
|
if err := reporter.Report(context.Background(), "acme", UsageMetric, 4096); err != nil {
|
||||||
|
t.Fatalf("report: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if gotClientID != "dms-service-client" || gotClientSecret != "dms-service-secret" {
|
||||||
|
t.Fatalf("service-credential-header falsch: id=%q secret=%q", gotClientID, gotClientSecret)
|
||||||
|
}
|
||||||
|
if len(gotBody) != 1 {
|
||||||
|
t.Fatalf("erwartet 1 delta im koerper, habe %d", len(gotBody))
|
||||||
|
}
|
||||||
|
if gotBody[0].TenantSlug != "acme" || gotBody[0].Metric != UsageMetric || gotBody[0].Delta != 4096 {
|
||||||
|
t.Fatalf("unerwarteter delta-inhalt: %+v", gotBody[0])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHTTPUsageReporter_RejectsNonOKStatus prueft, dass ein von Core
|
||||||
|
// abgelehnter Aufruf (z.B. ungueltiges Service-Credential) als Fehler
|
||||||
|
// zurueckgegeben wird, statt stillschweigend zu verlieren.
|
||||||
|
func TestHTTPUsageReporter_RejectsNonOKStatus(t *testing.T) {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
http.Error(w, "ungueltiges service-credential", http.StatusUnauthorized)
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
reporter := NewHTTPUsageReporter(srv.URL, "x", "y", nil)
|
||||||
|
if err := reporter.Report(context.Background(), "acme", UsageMetric, 1); err == nil {
|
||||||
|
t.Fatal("erwartet fehler bei abgelehnter nutzungsmeldung, habe nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
DROP TABLE IF EXISTS document_metadata_values;
|
||||||
|
DROP TABLE IF EXISTS metadata_fields;
|
||||||
|
DROP TABLE IF EXISTS document_tags;
|
||||||
|
DROP TABLE IF EXISTS tags;
|
||||||
|
ALTER TABLE documents DROP CONSTRAINT IF EXISTS fk_documents_current_revision;
|
||||||
|
DROP TABLE IF EXISTS file_revisions;
|
||||||
|
DROP TABLE IF EXISTS documents;
|
||||||
|
DROP TABLE IF EXISTS folders;
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
-- Kern-Entitaeten des DMS (FDN-02): Dokument, Datei-Revision, Ordner, Tag,
|
||||||
|
-- Metadatenfeld. Laeuft in der DB EINES Mandanten (Modell C, siehe Core
|
||||||
|
-- TEN-01) — keine tenant_id-Spalte, die Tenant-Zugehoerigkeit ist implizit
|
||||||
|
-- durch die Datenbankverbindung gegeben. FK auf users(id) spiegelt das
|
||||||
|
-- Benutzer-Datenmodell aus Core IAM-01 (migrations/tenant/0001_users.up.sql
|
||||||
|
-- im NEXARCH-Core-Modul) — Auth/Benutzerverwaltung liegt vollstaendig in
|
||||||
|
-- Core (siehe "Nicht Bestandteil" in FDN-02), diese Migration dupliziert sie
|
||||||
|
-- NICHT, sondern setzt sie als bereits vorhanden voraus (users-Tabelle wird
|
||||||
|
-- durch Cores eigene Migration in derselben physischen Tenant-Datenbank
|
||||||
|
-- angelegt, bevor DMS-Migrationen laufen).
|
||||||
|
CREATE EXTENSION IF NOT EXISTS pgcrypto;
|
||||||
|
|
||||||
|
CREATE TABLE folders (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
parent_folder_id UUID REFERENCES folders(id) ON DELETE CASCADE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_folders_parent_folder_id ON folders(parent_folder_id);
|
||||||
|
|
||||||
|
CREATE TABLE documents (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
folder_id UUID REFERENCES folders(id) ON DELETE SET NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
-- current_revision_id verweist erst NACH der Anlage von file_revisions
|
||||||
|
-- auf eine Zeile (siehe ALTER TABLE unten) — beim INSERT eines Dokuments
|
||||||
|
-- existiert noch keine Revision, daher NULLable und zirkulaer per
|
||||||
|
-- nachtraeglichem FOREIGN KEY statt Inline-Referenz geloest.
|
||||||
|
current_revision_id UUID,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
deleted_at TIMESTAMPTZ
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_documents_folder_id ON documents(folder_id);
|
||||||
|
CREATE INDEX idx_documents_created_by ON documents(created_by);
|
||||||
|
|
||||||
|
CREATE TABLE file_revisions (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
revision_number INT NOT NULL,
|
||||||
|
-- storage_key ist ein Platzhalter fuer die Objekt-Storage-Abstraktion
|
||||||
|
-- (FDN-03, "Nicht Bestandteil" dieser Kachel) — hier nur die Spalte, die
|
||||||
|
-- spaetere Kachel legt fest, was tatsaechlich dahinter liegt.
|
||||||
|
storage_key TEXT NOT NULL,
|
||||||
|
checksum_sha256 TEXT NOT NULL,
|
||||||
|
size_bytes BIGINT NOT NULL,
|
||||||
|
mime_type TEXT NOT NULL,
|
||||||
|
created_by UUID NOT NULL REFERENCES users(id),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
UNIQUE (document_id, revision_number)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_file_revisions_document_id ON file_revisions(document_id);
|
||||||
|
|
||||||
|
ALTER TABLE documents
|
||||||
|
ADD CONSTRAINT fk_documents_current_revision
|
||||||
|
FOREIGN KEY (current_revision_id) REFERENCES file_revisions(id) ON DELETE SET NULL;
|
||||||
|
|
||||||
|
CREATE TABLE tags (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
name TEXT NOT NULL UNIQUE,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE document_tags (
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
tag_id UUID NOT NULL REFERENCES tags(id) ON DELETE CASCADE,
|
||||||
|
PRIMARY KEY (document_id, tag_id)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_document_tags_tag_id ON document_tags(tag_id);
|
||||||
|
|
||||||
|
CREATE TABLE metadata_fields (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
field_key TEXT NOT NULL UNIQUE,
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
field_type TEXT NOT NULL CHECK (field_type IN ('text', 'number', 'date', 'bool', 'select')),
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE document_metadata_values (
|
||||||
|
document_id UUID NOT NULL REFERENCES documents(id) ON DELETE CASCADE,
|
||||||
|
field_id UUID NOT NULL REFERENCES metadata_fields(id) ON DELETE CASCADE,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
PRIMARY KEY (document_id, field_id)
|
||||||
|
);
|
||||||
|
CREATE INDEX idx_document_metadata_values_field_id ON document_metadata_values(field_id);
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
DROP TABLE IF EXISTS processing_jobs;
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
-- FDN-04: Postgres-Jobqueue fuer asynchrone Verarbeitung (OCR, Konvertierung,
|
||||||
|
-- Indexierung, Exporte) — kein Redis/AMQP, dasselbe Muster wie das
|
||||||
|
-- projektweite Postgres-Jobqueue-Konzept (siehe SKALIERUNGSKONZEPT.md).
|
||||||
|
-- Laeuft in der DB EINES Mandanten (Modell C, siehe Core TEN-01).
|
||||||
|
CREATE TABLE processing_jobs (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
job_type TEXT NOT NULL,
|
||||||
|
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
||||||
|
-- idempotency_key verhindert doppelte Einreihung DERSELBEN logischen
|
||||||
|
-- Aufgabe (z.B. "ocr:<revision_id>") — NULL erlaubt mehrere Zeilen ohne
|
||||||
|
-- Dedup-Anspruch (Standard-Postgres-Verhalten: NULL ist nie gleich NULL
|
||||||
|
-- im UNIQUE-Index).
|
||||||
|
idempotency_key TEXT UNIQUE,
|
||||||
|
status TEXT NOT NULL DEFAULT 'pending'
|
||||||
|
CHECK (status IN ('pending', 'processing', 'succeeded', 'failed', 'dead_letter')),
|
||||||
|
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()
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Deckt genau die Zugriffsmuster von Dequeue (status+available_at) und der
|
||||||
|
-- Stale-Lock-Wiedervorlage (status+locked_at) ab.
|
||||||
|
CREATE INDEX idx_processing_jobs_pending ON processing_jobs (available_at) WHERE status = 'pending';
|
||||||
|
CREATE INDEX idx_processing_jobs_processing ON processing_jobs (locked_at) WHERE status = 'processing';
|
||||||
|
CREATE INDEX idx_processing_jobs_job_type ON processing_jobs (job_type);
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
-- Entwicklungs-Seed (Akzeptanzkriterium 3): legt einen Beispielordner, ein
|
||||||
|
-- Beispieldokument mit einer Revision, ein Tag und ein Metadatenfeld an.
|
||||||
|
-- Setzt voraus, dass mindestens ein Benutzer existiert (Core IAM-01 legt
|
||||||
|
-- users an, DMS tut das nicht selbst - siehe "Nicht Bestandteil" in
|
||||||
|
-- FDN-02) - schlaegt sonst absichtlich mit einer sprechenden Fehlermeldung
|
||||||
|
-- fehl statt einen Platzhalter-Benutzer anzulegen, den DMS gar nicht
|
||||||
|
-- verwalten darf.
|
||||||
|
DO $$
|
||||||
|
DECLARE
|
||||||
|
seed_user_id UUID;
|
||||||
|
seed_folder_id UUID;
|
||||||
|
seed_document_id UUID;
|
||||||
|
BEGIN
|
||||||
|
SELECT id INTO seed_user_id FROM users ORDER BY created_at LIMIT 1;
|
||||||
|
IF seed_user_id IS NULL THEN
|
||||||
|
RAISE EXCEPTION 'dev_seed.sql: keine Zeile in users gefunden - zuerst Core-Seed (IAM-01) ausfuehren';
|
||||||
|
END IF;
|
||||||
|
|
||||||
|
INSERT INTO folders (name, created_by) VALUES ('Beispielordner', seed_user_id)
|
||||||
|
RETURNING id INTO seed_folder_id;
|
||||||
|
|
||||||
|
INSERT INTO documents (folder_id, title, created_by) VALUES (seed_folder_id, 'Beispieldokument', seed_user_id)
|
||||||
|
RETURNING id INTO seed_document_id;
|
||||||
|
|
||||||
|
INSERT INTO file_revisions (document_id, revision_number, storage_key, checksum_sha256, size_bytes, mime_type, created_by)
|
||||||
|
VALUES (seed_document_id, 1, 'dev-seed/beispiel.pdf', repeat('0', 64), 12345, 'application/pdf', seed_user_id);
|
||||||
|
|
||||||
|
UPDATE documents SET current_revision_id = (
|
||||||
|
SELECT id FROM file_revisions WHERE document_id = seed_document_id AND revision_number = 1
|
||||||
|
) WHERE id = seed_document_id;
|
||||||
|
|
||||||
|
INSERT INTO tags (name) VALUES ('Beispiel-Tag')
|
||||||
|
ON CONFLICT (name) DO NOTHING;
|
||||||
|
|
||||||
|
INSERT INTO document_tags (document_id, tag_id)
|
||||||
|
SELECT seed_document_id, id FROM tags WHERE name = 'Beispiel-Tag';
|
||||||
|
|
||||||
|
INSERT INTO metadata_fields (field_key, label, field_type) VALUES ('rechnungsnummer', 'Rechnungsnummer', 'text')
|
||||||
|
ON CONFLICT (field_key) DO NOTHING;
|
||||||
|
|
||||||
|
INSERT INTO document_metadata_values (document_id, field_id, value)
|
||||||
|
SELECT seed_document_id, id, 'RE-2026-0001' FROM metadata_fields WHERE field_key = 'rechnungsnummer';
|
||||||
|
END $$;
|
||||||
Executable
+22
@@ -0,0 +1,22 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Setzt die DMS-Testumgebung zurueck: droppt die Tenant-Test-Datenbank und
|
||||||
|
# legt sie leer neu an. Noetig, weil mehrere Testpakete (internal/jobqueue,
|
||||||
|
# internal/migrate, ...) dieselbe physische Test-Datenbank ueber
|
||||||
|
# Sitzungsgrenzen hinweg teilen — ohne Reset sammelt sich Zustand
|
||||||
|
# (z.B. schema_migrations-Eintraege) an, der Migrations-/Rollback-Tests
|
||||||
|
# verfaelscht (dieselbe Fehlerklasse wie in NEXARCH Core, siehe
|
||||||
|
# [[project-nexarch-test-infra]]).
|
||||||
|
#
|
||||||
|
# Aufruf: NEXARCH_DMS_TEST_DB_PASSWORD=... TEST_TENANT_DB=dms_tenant_test ./scripts/reset-test-env.sh
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
PASS="${NEXARCH_DMS_TEST_DB_PASSWORD:?Setze NEXARCH_DMS_TEST_DB_PASSWORD vor dem Aufruf}"
|
||||||
|
ROLE="${TEST_TENANT_ROLE:-nexarch_dms_test}"
|
||||||
|
DB="${TEST_TENANT_DB:-dms_tenant_test}"
|
||||||
|
|
||||||
|
export PGPASSWORD="$PASS"
|
||||||
|
|
||||||
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP DATABASE IF EXISTS ${DB};"
|
||||||
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "CREATE DATABASE ${DB};"
|
||||||
|
|
||||||
|
echo "Testumgebung zurueckgesetzt: ${DB} leer neu angelegt."
|
||||||
@@ -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,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,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`).
|
|
||||||
@@ -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,67 +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).
|
|
||||||
type Envelope struct {
|
|
||||||
Ciphertext io.Reader
|
|
||||||
WrappedDEK []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service verbindet KEKProvider mit den Envelope-Operationen — Aufrufer
|
|
||||||
// (mail/internal/encstorage) rufen ausschließlich Service auf, nie die
|
|
||||||
// Einzelfunktionen aus envelope.go direkt.
|
|
||||||
type Service struct {
|
|
||||||
kek KEKProvider
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(kek KEKProvider) *Service {
|
|
||||||
return &Service{kek: kek}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Seal erzeugt einen neuen DEK (Akzeptanzkriterium 1), verschlüsselt
|
|
||||||
// plaintext damit und verpackt den DEK mit dem aktuellen Tenant-KEK
|
|
||||||
// (Akzeptanzkriterium 2 — der KEK wird bei JEDEM Aufruf frisch von Core
|
|
||||||
// bezogen, nie zwischengespeichert).
|
|
||||||
func (s *Service) Seal(ctx context.Context, tenantSlug string, plaintext io.Reader) (*Envelope, error) {
|
|
||||||
dek, err := GenerateDEK()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
ciphertext, err := EncryptStream(dek, plaintext)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
|
||||||
}
|
|
||||||
wrappedDEK, err := WrapDEK(kek, dek)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &Envelope{Ciphertext: ciphertext, WrappedDEK: wrappedDEK}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Open entpackt den DEK mit dem aktuellen Tenant-KEK (Akzeptanzkriterium
|
|
||||||
// 3: nur mit gültigem, mandantenbezogenem Schlüssel möglich — ein
|
|
||||||
// falscher Tenant-Slug liefert entweder einen falschen KEK von Core
|
|
||||||
// [dann schlägt UnwrapDEK fehl] oder Core verweigert den Zugriff direkt)
|
|
||||||
// und entschlüsselt ciphertext damit.
|
|
||||||
func (s *Service) Open(ctx context.Context, tenantSlug string, wrappedDEK []byte, ciphertext io.Reader) (io.Reader, error) {
|
|
||||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
|
||||||
}
|
|
||||||
dek, err := UnwrapDEK(kek, wrappedDEK)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return DecryptStream(dek, ciphertext)
|
|
||||||
}
|
|
||||||
@@ -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,93 +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"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/crypto"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// wrappedDEKKey ist der Sidecar-Objektschlüssel für den mit dem
|
|
||||||
// Tenant-KEK verpackten DEK — liegt im selben Storage-Backend wie der
|
|
||||||
// Chiffretext, analog zum Prüfsummen-Sidecar aus ARC-01.
|
|
||||||
func wrappedDEKKey(key string) string {
|
|
||||||
return key + ".dek"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service verbindet Storage (ARC-01) und Crypto (ARC-02): der Rest von
|
|
||||||
// Mail ruft AUSSCHLIESSLICH diesen Service auf, nie storage.Service
|
|
||||||
// direkt mit Klartext — das verhindert einen Schreibpfad, der die
|
|
||||||
// Verschlüsselung vergisst (Akzeptanzkriterium 1).
|
|
||||||
type Service struct {
|
|
||||||
storage *storage.Service
|
|
||||||
crypto *crypto.Service
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(storageSvc *storage.Service, cryptoSvc *crypto.Service) *Service {
|
|
||||||
return &Service{storage: storageSvc, crypto: cryptoSvc}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put verschlüsselt plaintext (Akzeptanzkriterium 1/2: neuer DEK je
|
|
||||||
// Objekt, mit dem per API-12 bezogenen Tenant-KEK verpackt) und legt
|
|
||||||
// Chiffretext + verpackten DEK über storage.Service ab (Prüfsumme,
|
|
||||||
// Nutzungsmeldung — ARC-01 unverändert wiederverwendet).
|
|
||||||
func (s *Service) Put(ctx context.Context, tenantSlug, key string, plaintext io.Reader, contentType string) error {
|
|
||||||
env, err := s.crypto.Seal(ctx, tenantSlug, plaintext)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("encstorage: verschlüsseln: %w", err)
|
|
||||||
}
|
|
||||||
ciphertext, err := io.ReadAll(env.Ciphertext)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.storage.Put(ctx, key, bytes.NewReader(ciphertext), int64(len(ciphertext)), contentType); err != nil {
|
|
||||||
return fmt.Errorf("encstorage: chiffretext speichern: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.storage.Put(ctx, wrappedDEKKey(key), bytes.NewReader(env.WrappedDEK), int64(len(env.WrappedDEK)), "application/octet-stream"); err != nil {
|
|
||||||
return fmt.Errorf("encstorage: verpackten dek speichern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDecrypted liest Chiffretext (über storage.GetVerified — ARC-01s
|
|
||||||
// Prüfsummenverifikation wird dabei mitgenutzt) und verpackten DEK,
|
|
||||||
// entpackt den DEK mit dem AKTUELLEN Tenant-KEK und entschlüsselt den
|
|
||||||
// Inhalt (Akzeptanzkriterium 3: nur mit gültigem, mandantenbezogenem
|
|
||||||
// Schlüssel möglich).
|
|
||||||
func (s *Service) GetDecrypted(ctx context.Context, tenantSlug, key string) ([]byte, error) {
|
|
||||||
ciphertext, err := s.storage.GetVerified(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
|
||||||
}
|
|
||||||
dekReader, err := s.storage.Get(ctx, wrappedDEKKey(key))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = dekReader.Close() }()
|
|
||||||
wrappedDEK, err := io.ReadAll(dekReader)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
plaintextReader, err := s.crypto.Open(ctx, tenantSlug, wrappedDEK, bytes.NewReader(ciphertext))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return io.ReadAll(plaintextReader)
|
|
||||||
}
|
|
||||||
@@ -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,206 +0,0 @@
|
|||||||
// Package mimeparse implementiert ING-04: MIME-/Anhang-Parsing für
|
|
||||||
// ein- und ausgehende Nachrichten (Multipart, verschachtelt,
|
|
||||||
// Content-Transfer-Encoding, defensive Zeichensatz-Reparatur).
|
|
||||||
//
|
|
||||||
// NUR Parsing — Speicherung ist ARC-01s Aufgabe (siehe "Nicht
|
|
||||||
// Bestandteil dieser Kachel"), dieses Paket schreibt nirgends in einen
|
|
||||||
// Objekt-Speicher, sondern liefert nur strukturierte Go-Werte zurück.
|
|
||||||
//
|
|
||||||
// Bekannten Fehler vermieden (archivmail known-issues #3): Anhänge
|
|
||||||
// wurden früher über io.ReadAll ohne Größenlimit gelesen — eine
|
|
||||||
// Speicherbombe durch große/böswillige Anhänge. Hier läuft JEDER
|
|
||||||
// Anhang-Lesevorgang über io.LimitReader mit konfigurierter Max-Size;
|
|
||||||
// eine Überschreitung führt zu einer harten, sauberen Ablehnung
|
|
||||||
// (ErrAttachmentTooLarge), kein stilles Abschneiden.
|
|
||||||
package mimeparse
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/base64"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"mime"
|
|
||||||
"mime/multipart"
|
|
||||||
"mime/quotedprintable"
|
|
||||||
"net/mail"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"golang.org/x/text/encoding/htmlindex"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrAttachmentTooLarge wird geliefert, wenn ein Anhang die
|
|
||||||
// konfigurierte Maximalgröße überschreitet (Akzeptanzkriterium/
|
|
||||||
// Pflichtprüfung 1).
|
|
||||||
var ErrAttachmentTooLarge = errors.New("mimeparse: anhang überschreitet die maximal erlaubte größe")
|
|
||||||
|
|
||||||
// Part ist EIN zerlegter MIME-Teil — sowohl Textteile (IsAttachment
|
|
||||||
// == false) als auch Anhänge (Akzeptanzkriterium 1/2).
|
|
||||||
type Part struct {
|
|
||||||
ContentType string
|
|
||||||
Filename string
|
|
||||||
Size int64
|
|
||||||
Content []byte
|
|
||||||
IsAttachment bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Message ist das Ergebnis eines vollständig zerlegten Multipart-
|
|
||||||
// Baums — verschachtelte multipart/*-Teile sind bereits rekursiv
|
|
||||||
// aufgelöst, der Aufrufer sieht nur die "Blatt"-Teile (Akzeptanz-
|
|
||||||
// kriterium 1).
|
|
||||||
type Message struct {
|
|
||||||
Parts []Part
|
|
||||||
}
|
|
||||||
|
|
||||||
// wordDecoder dekodiert RFC-2047-kodierte Header-Werte (z. B.
|
|
||||||
// Anhang-Dateinamen) defensiv: ein unbekannter/fehlerhafter
|
|
||||||
// Zeichensatz bricht die Verarbeitung NICHT ab (Akzeptanzkriterium 3),
|
|
||||||
// sondern liefert den Rohwert unverändert zurück.
|
|
||||||
var wordDecoder = &mime.WordDecoder{CharsetReader: charsetReader}
|
|
||||||
|
|
||||||
func charsetReader(charsetLabel string, input io.Reader) (io.Reader, error) {
|
|
||||||
enc, err := htmlindex.Get(charsetLabel)
|
|
||||||
if err != nil {
|
|
||||||
// Unbekannter/fehlerhafter Zeichensatz: defensiv als
|
|
||||||
// UTF-8-verträglichen Rohtext weiterreichen statt
|
|
||||||
// abzubrechen (Akzeptanzkriterium 3).
|
|
||||||
return input, nil
|
|
||||||
}
|
|
||||||
return enc.NewDecoder().Reader(input), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func decodeHeaderValue(raw string) string {
|
|
||||||
decoded, err := wordDecoder.DecodeHeader(raw)
|
|
||||||
if err != nil {
|
|
||||||
// Defensiv: Rohwert statt Abbruch (Akzeptanzkriterium 3).
|
|
||||||
return raw
|
|
||||||
}
|
|
||||||
return decoded
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse zerlegt eine MIME-Nachricht vollständig, inklusive
|
|
||||||
// verschachtelter Multipart-Teile (Akzeptanzkriterium 1). maxAttachmentSize
|
|
||||||
// begrenzt JEDEN einzelnen Anhang (Akzeptanzkriterium/Pflichtprüfung 1).
|
|
||||||
func Parse(r io.Reader, maxAttachmentSize int64) (Message, error) {
|
|
||||||
msg, err := mail.ReadMessage(r)
|
|
||||||
if err != nil {
|
|
||||||
return Message{}, fmt.Errorf("mimeparse: nachricht lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
mediaType, params, err := mime.ParseMediaType(msg.Header.Get("Content-Type"))
|
|
||||||
if err != nil {
|
|
||||||
// Kein/kaputtes Content-Type: als einzelnen Textteil behandeln
|
|
||||||
// statt abzubrechen (Akzeptanzkriterium 3: defensiv reparieren).
|
|
||||||
body, readErr := readLimited(msg.Body, maxAttachmentSize)
|
|
||||||
if readErr != nil {
|
|
||||||
return Message{}, readErr
|
|
||||||
}
|
|
||||||
return Message{Parts: []Part{{ContentType: "text/plain", Content: body, Size: int64(len(body))}}}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var result Message
|
|
||||||
if strings.HasPrefix(mediaType, "multipart/") {
|
|
||||||
if err := parseMultipart(msg.Body, params["boundary"], maxAttachmentSize, &result); err != nil {
|
|
||||||
return Message{}, err
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Einzelner Teil (keine Multipart-Hülle).
|
|
||||||
part, err := readSinglePart(msg.Header.Get("Content-Transfer-Encoding"), mediaType, "", msg.Body, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return Message{}, err
|
|
||||||
}
|
|
||||||
result.Parts = append(result.Parts, part)
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseMultipart löst EINEN Multipart-Container rekursiv auf —
|
|
||||||
// verschachtelte multipart/*-Teile (z. B. multipart/mixed, das
|
|
||||||
// multipart/alternative enthält) werden vollständig zerlegt
|
|
||||||
// (Akzeptanzkriterium 1), keine Rekursionstiefe hartkodiert begrenzt
|
|
||||||
// außer durch die natürliche Nachrichtengröße selbst.
|
|
||||||
func parseMultipart(r io.Reader, boundary string, maxAttachmentSize int64, result *Message) error {
|
|
||||||
if boundary == "" {
|
|
||||||
return errors.New("mimeparse: multipart ohne boundary")
|
|
||||||
}
|
|
||||||
mr := multipart.NewReader(r, boundary)
|
|
||||||
for {
|
|
||||||
p, err := mr.NextPart()
|
|
||||||
if err == io.EOF {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
// Kaputte Multipart-Struktur: kontrolliert abbrechen
|
|
||||||
// (Pflichtprüfung 3), nicht abstürzen.
|
|
||||||
return fmt.Errorf("mimeparse: multipart-teil lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
contentType := p.Header.Get("Content-Type")
|
|
||||||
mediaType, subParams, err := mime.ParseMediaType(contentType)
|
|
||||||
if err != nil {
|
|
||||||
mediaType = "text/plain"
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.HasPrefix(mediaType, "multipart/") {
|
|
||||||
if err := parseMultipart(p, subParams["boundary"], maxAttachmentSize, result); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
part, err := readSinglePart(p.Header.Get("Content-Transfer-Encoding"), mediaType, decodeHeaderValue(p.FileName()), p, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
result.Parts = append(result.Parts, part)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func readSinglePart(transferEncoding, mediaType, filename string, r io.Reader, maxAttachmentSize int64) (Part, error) {
|
|
||||||
decoded := decodeTransferEncoding(transferEncoding, r)
|
|
||||||
|
|
||||||
content, err := readLimited(decoded, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return Part{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return Part{
|
|
||||||
ContentType: mediaType,
|
|
||||||
Filename: filename,
|
|
||||||
Size: int64(len(content)),
|
|
||||||
Content: content,
|
|
||||||
IsAttachment: filename != "",
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// decodeTransferEncoding dekodiert Content-Transfer-Encoding
|
|
||||||
// (quoted-printable/base64) — defensiv: ein unbekanntes Encoding wird
|
|
||||||
// unverändert durchgereicht statt die Verarbeitung abzubrechen
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
func decodeTransferEncoding(encoding string, r io.Reader) io.Reader {
|
|
||||||
switch strings.ToLower(strings.TrimSpace(encoding)) {
|
|
||||||
case "quoted-printable":
|
|
||||||
return quotedprintable.NewReader(r)
|
|
||||||
case "base64":
|
|
||||||
return base64.NewDecoder(base64.StdEncoding, r)
|
|
||||||
default:
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// readLimited liest höchstens maxSize+1 Bytes — wird die Grenze
|
|
||||||
// überschritten, wird ErrAttachmentTooLarge geliefert, statt beliebig
|
|
||||||
// viel Speicher zu allozieren (Akzeptanzkriterium/Pflichtprüfung 1,
|
|
||||||
// archivmail known-issues #3).
|
|
||||||
func readLimited(r io.Reader, maxSize int64) ([]byte, error) {
|
|
||||||
limited := io.LimitReader(r, maxSize+1)
|
|
||||||
var buf bytes.Buffer
|
|
||||||
if _, err := io.Copy(&buf, limited); err != nil {
|
|
||||||
return nil, fmt.Errorf("mimeparse: teil lesen: %w", err)
|
|
||||||
}
|
|
||||||
if int64(buf.Len()) > maxSize {
|
|
||||||
return nil, ErrAttachmentTooLarge
|
|
||||||
}
|
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
|
||||||
@@ -1,219 +0,0 @@
|
|||||||
package mimeparse
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
const defaultMaxSize = 10 * 1024 * 1024 // 10 MiB
|
|
||||||
|
|
||||||
// TestParse_NestedMultipartFullyDecomposed ist Akzeptanzkriterium 1:
|
|
||||||
// Multipart-Nachrichten mit verschachtelten Teilen werden vollständig
|
|
||||||
// zerlegt (multipart/mixed enthält multipart/alternative UND einen
|
|
||||||
// Anhang).
|
|
||||||
func TestParse_NestedMultipartFullyDecomposed(t *testing.T) {
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"To: b@example.com\r\n" +
|
|
||||||
"Subject: Test\r\n" +
|
|
||||||
"MIME-Version: 1.0\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"outer\"\r\n\r\n" +
|
|
||||||
"--outer\r\n" +
|
|
||||||
"Content-Type: multipart/alternative; boundary=\"inner\"\r\n\r\n" +
|
|
||||||
"--inner\r\n" +
|
|
||||||
"Content-Type: text/plain; charset=utf-8\r\n\r\n" +
|
|
||||||
"Hallo als Text\r\n" +
|
|
||||||
"--inner\r\n" +
|
|
||||||
"Content-Type: text/html; charset=utf-8\r\n\r\n" +
|
|
||||||
"<p>Hallo als HTML</p>\r\n" +
|
|
||||||
"--inner--\r\n" +
|
|
||||||
"--outer\r\n" +
|
|
||||||
"Content-Type: application/pdf\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"rechnung.pdf\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"JVBERi0xLjQK\r\n" +
|
|
||||||
"--outer--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 3 {
|
|
||||||
t.Fatalf("erwartet 3 zerlegte teile (text, html, anhang), habe %d: %+v", len(msg.Parts), msg.Parts)
|
|
||||||
}
|
|
||||||
|
|
||||||
var sawText, sawHTML, sawAttachment bool
|
|
||||||
for _, p := range msg.Parts {
|
|
||||||
switch {
|
|
||||||
case p.ContentType == "text/plain":
|
|
||||||
sawText = true
|
|
||||||
if string(p.Content) != "Hallo als Text" {
|
|
||||||
t.Fatalf("unerwarteter text-inhalt: %q", p.Content)
|
|
||||||
}
|
|
||||||
case p.ContentType == "text/html":
|
|
||||||
sawHTML = true
|
|
||||||
case p.IsAttachment:
|
|
||||||
sawAttachment = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !sawText || !sawHTML || !sawAttachment {
|
|
||||||
t.Fatalf("nicht alle erwarteten teile gefunden: text=%v html=%v attachment=%v", sawText, sawHTML, sawAttachment)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_AttachmentMetadataExtracted ist Akzeptanzkriterium 2:
|
|
||||||
// Anhänge werden mit korrektem Dateinamen, Größe und Content-Type
|
|
||||||
// extrahiert.
|
|
||||||
func TestParse_AttachmentMetadataExtracted(t *testing.T) {
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: text/plain\r\n\r\n" +
|
|
||||||
"Text\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: image/png\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"bild.png\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"iVBORw0KGgo=\r\n" +
|
|
||||||
"--b--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
var attachment *Part
|
|
||||||
for i := range msg.Parts {
|
|
||||||
if msg.Parts[i].IsAttachment {
|
|
||||||
attachment = &msg.Parts[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if attachment == nil {
|
|
||||||
t.Fatal("kein anhang gefunden")
|
|
||||||
}
|
|
||||||
if attachment.Filename != "bild.png" {
|
|
||||||
t.Fatalf("falscher dateiname: %q", attachment.Filename)
|
|
||||||
}
|
|
||||||
if attachment.ContentType != "image/png" {
|
|
||||||
t.Fatalf("falscher content-type: %q", attachment.ContentType)
|
|
||||||
}
|
|
||||||
if attachment.Size != int64(len(attachment.Content)) || attachment.Size == 0 {
|
|
||||||
t.Fatalf("unplausible größe: %d (content-len %d)", attachment.Size, len(attachment.Content))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_BrokenCharsetIsRepairedNotAborted ist Akzeptanzkriterium 3:
|
|
||||||
// fehlerhafte/inkonsistente Zeichensatzangaben werden defensiv repariert
|
|
||||||
// statt die Verarbeitung abzubrechen.
|
|
||||||
func TestParse_BrokenCharsetIsRepairedNotAborted(t *testing.T) {
|
|
||||||
// "unbekannt-xyz" ist KEIN gültiger IANA-Zeichensatzname.
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: text/plain; charset=\"unbekannt-xyz\"\r\n\r\n" +
|
|
||||||
"Rohtext trotz kaputtem Charset\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erwartet KEINEN abbruch bei kaputtem charset, habe: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 1 {
|
|
||||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
|
||||||
}
|
|
||||||
if !strings.Contains(string(msg.Parts[0].Content), "Rohtext") {
|
|
||||||
t.Fatalf("inhalt fehlt/verstümmelt: %q", msg.Parts[0].Content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_ISO88591BodyDecodedWithoutAbort ist Akzeptanzkriterium 3
|
|
||||||
// zusätzlich: ein bekannter Nicht-UTF-8-Zeichensatz wird via
|
|
||||||
// Header-Dekodierung real repariert (RFC-2047-kodierter Dateiname).
|
|
||||||
func TestParse_ISO88591FilenameDecoded(t *testing.T) {
|
|
||||||
// "=?ISO-8859-1?Q?Rechnung_=DC?=" kodiert "Rechnung Ü" (0xDC = 'Ü' in Latin-1).
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: application/octet-stream\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"=?ISO-8859-1?Q?Rechnung_=DC?=\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"AAA=\r\n" +
|
|
||||||
"--b--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 1 {
|
|
||||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
|
||||||
}
|
|
||||||
if msg.Parts[0].Filename != "Rechnung Ü" {
|
|
||||||
t.Fatalf("erwartet dekodierten dateinamen 'Rechnung Ü', habe %q", msg.Parts[0].Filename)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// infiniteReader liefert unbegrenzt viele Bytes — simuliert einen sehr
|
|
||||||
// großen/böswilligen Anhang. Ohne io.LimitReader (siehe archivmail
|
|
||||||
// known-issues #3) würde ein io.ReadAll hierauf den Prozessspeicher
|
|
||||||
// erschöpfen; mit readLimited bricht Parse kontrolliert und schnell ab.
|
|
||||||
type infiniteReader struct{}
|
|
||||||
|
|
||||||
func (infiniteReader) Read(p []byte) (int, error) {
|
|
||||||
for i := range p {
|
|
||||||
p[i] = 'A'
|
|
||||||
}
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_OversizedAttachmentRejectedNotMemoryExhausted ist die
|
|
||||||
// geforderte Pflichtprüfung 1.
|
|
||||||
func TestParse_OversizedAttachmentRejectedNotMemoryExhausted(t *testing.T) {
|
|
||||||
const tinyLimit = 1024 // 1 KiB — winzig, damit der Test schnell bleibt
|
|
||||||
|
|
||||||
header := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: application/octet-stream\r\n" +
|
|
||||||
"Content-Transfer-Encoding: identity\r\n\r\n"
|
|
||||||
|
|
||||||
r := io.MultiReader(strings.NewReader(header), infiniteReader{})
|
|
||||||
_, err := Parse(r, tinyLimit)
|
|
||||||
if !errors.Is(err, ErrAttachmentTooLarge) {
|
|
||||||
t.Fatalf("erwartet ErrAttachmentTooLarge bei unbegrenzt großem anhang, habe: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_RealisticCorpusRunsCleanly ist die geforderte
|
|
||||||
// Pflichtprüfung 2: realitätsnahe Multipart-/Encoding-Varianten laufen
|
|
||||||
// fehlerfrei durch.
|
|
||||||
func TestParse_RealisticCorpusRunsCleanly(t *testing.T) {
|
|
||||||
corpus := []string{
|
|
||||||
// Einfache Textnachricht ohne Multipart.
|
|
||||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\n\r\nEinfacher Text\r\n",
|
|
||||||
// Quoted-Printable.
|
|
||||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\nUmlaut: =C3=9C\r\n",
|
|
||||||
// Multipart/alternative ohne Anhang.
|
|
||||||
"From: a@example.com\r\nContent-Type: multipart/alternative; boundary=\"x\"\r\n\r\n--x\r\nContent-Type: text/plain\r\n\r\nText\r\n--x\r\nContent-Type: text/html\r\n\r\n<p>Text</p>\r\n--x--\r\n",
|
|
||||||
// Leere Multipart-Nachricht (kein Teil, nur Präambel/Epilog).
|
|
||||||
"From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"y\"\r\n\r\nPräambel wird ignoriert\r\n--y--\r\nEpilog wird ignoriert\r\n",
|
|
||||||
}
|
|
||||||
for i, raw := range corpus {
|
|
||||||
if _, err := Parse(strings.NewReader(raw), defaultMaxSize); err != nil {
|
|
||||||
t.Fatalf("corpus[%d] fehlgeschlagen: %v\nraw=%q", i, err, raw)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// FuzzParse ist die geforderte Pflichtprüfung 3: kaputte MIME-Strukturen
|
|
||||||
// dürfen Parse nicht zum Absturz bringen, nur zu einem kontrollierten
|
|
||||||
// Fehler.
|
|
||||||
func FuzzParse(f *testing.F) {
|
|
||||||
f.Add([]byte("From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"b\"\r\n\r\n--b\r\nContent-Type: text/plain\r\n\r\nHallo\r\n--b--\r\n"))
|
|
||||||
f.Add([]byte("Content-Type: multipart/mixed; boundary=\r\n\r\nkaputt"))
|
|
||||||
f.Add([]byte(""))
|
|
||||||
f.Add([]byte("From: a@example.com\r\n\r\n"))
|
|
||||||
|
|
||||||
f.Fuzz(func(t *testing.T, data []byte) {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("Parse ist abgestürzt (panic) statt kontrolliert einen Fehler zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
_, _ = Parse(strings.NewReader(string(data)), defaultMaxSize)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
// Package pflichttestgate erzwingt die in docs/TESTSTRATEGIE-MAIL.md
|
|
||||||
// Abschnitt 4 festgelegte Regel: jede geänderte Go-Datei in einem
|
|
||||||
// sicherheitskritischen Bereich (Auth, Tenant-Scoping, Protokoll-/
|
|
||||||
// Compliance-kritisch) muss von einer geänderten oder neuen _test.go-
|
|
||||||
// Datei im selben Package begleitet sein. Bewusste Code-Kopie des
|
|
||||||
// Musters aus Core internal/pflichttestgate — Mail ist ein eigenständiges
|
|
||||||
// Go-Modul und kann Core nicht importieren.
|
|
||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"path"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// sensitivePathPatterns beschreibt die Bereiche aus
|
|
||||||
// TESTSTRATEGIE-MAIL.md Abschnitt 4.
|
|
||||||
var sensitivePathPatterns = []*regexp.Regexp{
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/auth/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/tenant/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/ingest/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/imap/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/smtp/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/arc/`),
|
|
||||||
}
|
|
||||||
|
|
||||||
// Violation beschreibt ein Package mit sicherheitskritischer Änderung
|
|
||||||
// ohne begleitende Testdatei.
|
|
||||||
type Violation struct {
|
|
||||||
Package string
|
|
||||||
ChangedFile string
|
|
||||||
}
|
|
||||||
|
|
||||||
func isSensitive(file string) bool {
|
|
||||||
if !strings.HasSuffix(file, ".go") || strings.HasSuffix(file, "_test.go") {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
for _, re := range sensitivePathPatterns {
|
|
||||||
if re.MatchString(file) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// CheckDiff prüft eine Liste geänderter Dateipfade gegen die
|
|
||||||
// Pflichttest-Regel — ein leeres Ergebnis bedeutet: Gate besteht.
|
|
||||||
func CheckDiff(changedFiles []string) []Violation {
|
|
||||||
sensitiveByPkg := map[string]string{}
|
|
||||||
testTouchedPkgs := map[string]bool{}
|
|
||||||
|
|
||||||
for _, f := range changedFiles {
|
|
||||||
pkg := path.Dir(f)
|
|
||||||
if strings.HasSuffix(f, "_test.go") {
|
|
||||||
testTouchedPkgs[pkg] = true
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if isSensitive(f) {
|
|
||||||
if _, seen := sensitiveByPkg[pkg]; !seen {
|
|
||||||
sensitiveByPkg[pkg] = f
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var violations []Violation
|
|
||||||
for pkg, file := range sensitiveByPkg {
|
|
||||||
if !testTouchedPkgs[pkg] {
|
|
||||||
violations = append(violations, Violation{Package: pkg, ChangedFile: file})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return violations
|
|
||||||
}
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
// Negativtest des Gates selbst (QA-01 Prüfung 1): ein Diff mit
|
|
||||||
// geänderter mail/internal/auth/login.go ohne begleitende Testdatei
|
|
||||||
// muss als Verstoß erkannt werden.
|
|
||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestCheckDiff_FlagsSensitiveChangeWithoutTest(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{"mail/internal/auth/login.go"})
|
|
||||||
if len(violations) != 1 {
|
|
||||||
t.Fatalf("erwartet genau 1 verstoß, habe %d: %+v", len(violations), violations)
|
|
||||||
}
|
|
||||||
if violations[0].Package != "mail/internal/auth" {
|
|
||||||
t.Fatalf("falsches package gemeldet: %+v", violations[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_PassesWhenTestFileAccompanies(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{
|
|
||||||
"mail/internal/auth/login.go",
|
|
||||||
"mail/internal/auth/login_test.go",
|
|
||||||
})
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keine verstöße, habe: %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_IgnoresNonSensitivePaths(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{"mail/internal/example/normalize.go"})
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keine verstöße für nicht-sensiblen pfad, habe: %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
// Package storage implementiert ARC-01: die Objekt-Speicher-Anbindung
|
|
||||||
// für archivierte Mails und Anhänge. Baut auf demselben bewährten
|
|
||||||
// Muster wie DMS FDN-03 auf (austauschbare Driver, LocalDriver für
|
|
||||||
// Entwicklung, S3Driver für Produktion) — Mail kann DMS' internal/
|
|
||||||
// nicht importieren (eigenständiges Go-Modul), daher eine bewusste,
|
|
||||||
// angepasste Neuimplementierung statt eines Cross-Modul-Imports.
|
|
||||||
//
|
|
||||||
// Erweiterung gegenüber FDN-03: ARC-01 verlangt Prüfsummenverifikation
|
|
||||||
// AN DIESER SCHICHT (Akzeptanzkriterium 2), nicht erst an einer
|
|
||||||
// späteren DB-Schicht — siehe service.go.
|
|
||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"strconv"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrNotFound wird geliefert, wenn ein angefragtes Objekt nicht
|
|
||||||
// existiert.
|
|
||||||
var ErrNotFound = errors.New("storage: objekt nicht gefunden")
|
|
||||||
|
|
||||||
// Driver ist die EINE Schnittstelle, gegen die der Rest von Mail
|
|
||||||
// arbeitet (Akzeptanzkriterium 1). Zwei Implementierungen: LocalDriver
|
|
||||||
// (Entwicklung) und S3Driver (Produktion, S3-kompatibel).
|
|
||||||
type Driver interface {
|
|
||||||
Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error)
|
|
||||||
Get(ctx context.Context, key string) (io.ReadCloser, error)
|
|
||||||
Delete(ctx context.Context, key string) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// ObjectKey liefert das feste, dokumentierte Pfadschema für einen
|
|
||||||
// Mail-Anhang/-Teil INNERHALB des bereits mandantenspezifischen
|
|
||||||
// Buckets (Akzeptanzkriterium 1) — Bucket-Trennung selbst ist Sache
|
|
||||||
// von Core TEN-01. Lesezugriff hängt NUR von messageID+partIndex ab,
|
|
||||||
// nicht vom ursprünglichen Importpfad (IMAP/SMTP/manueller Import —
|
|
||||||
// Akzeptanzkriterium 3): derselbe Key wird unabhängig davon berechnet,
|
|
||||||
// über welchen Weg die Nachricht ins System kam.
|
|
||||||
func ObjectKey(messageID string, partIndex int) string {
|
|
||||||
return "messages/" + messageID + "/parts/" + strconv.Itoa(partIndex)
|
|
||||||
}
|
|
||||||
|
|
||||||
// checksumKey ist der Sidecar-Objektschlüssel für die beim Schreiben
|
|
||||||
// berechnete Prüfsumme (siehe service.go) — liegt bewusst im selben
|
|
||||||
// Driver/Bucket wie der Inhalt, keine separate DB-Abhängigkeit nötig.
|
|
||||||
func checksumKey(key string) string {
|
|
||||||
return key + ".sha256"
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
)
|
|
||||||
|
|
||||||
// LocalDriver legt Objekte im lokalen Dateisystem ab — der
|
|
||||||
// Entwicklungs-Treiber (Akzeptanzkriterium 1), keine externe
|
|
||||||
// Abhängigkeit nötig.
|
|
||||||
type LocalDriver struct {
|
|
||||||
baseDir string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewLocalDriver(baseDir string) *LocalDriver {
|
|
||||||
return &LocalDriver{baseDir: baseDir}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) path(key string) string {
|
|
||||||
return filepath.Join(d.baseDir, filepath.FromSlash(key))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Put(_ context.Context, key string, r io.Reader, _ int64, _ string) (int64, error) {
|
|
||||||
full := d.path(key)
|
|
||||||
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: verzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
f, err := os.Create(full)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: datei anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
|
|
||||||
written, err := io.Copy(f, r)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: schreiben: %w", err)
|
|
||||||
}
|
|
||||||
return written, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Get(_ context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
f, err := os.Open(d.path(key))
|
|
||||||
if err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return nil, ErrNotFound
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("storage: lesen: %w", err)
|
|
||||||
}
|
|
||||||
return f, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Delete(_ context.Context, key string) error {
|
|
||||||
if err := os.Remove(d.path(key)); err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return fmt.Errorf("storage: löschen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrChecksumMismatch wird von GetVerified geliefert, wenn der beim
|
|
||||||
// Lesen berechnete Hash nicht mit der beim Schreiben gespeicherten
|
|
||||||
// Prüfsumme übereinstimmt (Akzeptanzkriterium 2 / Pflichtprüfung 2:
|
|
||||||
// ein absichtlich beschädigtes Objekt wird erkannt).
|
|
||||||
var ErrChecksumMismatch = errors.New("storage: prüfsumme stimmt nicht überein — objekt wurde verändert")
|
|
||||||
|
|
||||||
// Service verbindet einen Driver mit Prüfsummenverifikation
|
|
||||||
// (Akzeptanzkriterium 2) und der Nutzungsmeldung an Core LIC-05
|
|
||||||
// (Akzeptanzkriterium 4) — jeder Schreib-/Löschvorgang über Service
|
|
||||||
// löst GENAU EINE Meldung mit der tatsächlich geschriebenen/gelöschten
|
|
||||||
// Objektgröße aus. Aufrufer (spätere Tickets, z. B. IMP-*) rufen
|
|
||||||
// ausschließlich Service auf, nie einen Driver direkt.
|
|
||||||
type Service struct {
|
|
||||||
driver Driver
|
|
||||||
usage UsageReporter
|
|
||||||
tenantSlug string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(driver Driver, usage UsageReporter, tenantSlug string) *Service {
|
|
||||||
return &Service{driver: driver, usage: usage, tenantSlug: tenantSlug}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put legt den Inhalt ab UND verifiziert den Schreibvorgang durch
|
|
||||||
// Prüfsummenvergleich (Akzeptanzkriterium 2): der Inhalt wird
|
|
||||||
// geschrieben, die Prüfsumme als Sidecar-Objekt gespeichert, danach
|
|
||||||
// SOFORT zurückgelesen und erneut gehasht — weicht der Rückgelesene
|
|
||||||
// Hash vom beim Schreiben berechneten ab, meldet Put einen Fehler,
|
|
||||||
// statt eine unbemerkt fehlerhafte Ablage stehen zu lassen. Meldet die
|
|
||||||
// geschriebene Größe als positives Delta an Core LIC-05
|
|
||||||
// (Akzeptanzkriterium 4).
|
|
||||||
func (s *Service) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (checksum string, err error) {
|
|
||||||
hasher := sha256.New()
|
|
||||||
tee := io.TeeReader(r, hasher)
|
|
||||||
|
|
||||||
written, err := s.driver.Put(ctx, key, tee, size, contentType)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
checksum = hex.EncodeToString(hasher.Sum(nil))
|
|
||||||
|
|
||||||
if _, err := s.driver.Put(ctx, checksumKey(key), bytes.NewReader([]byte(checksum)), int64(len(checksum)), "text/plain"); err != nil {
|
|
||||||
return "", fmt.Errorf("storage: prüfsumme speichern: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sofortige Rücklese-Verifikation — beweist, dass der Schreibvorgang
|
|
||||||
// tatsächlich verifiziert wurde, nicht nur eine Prüfsumme abgelegt
|
|
||||||
// wurde, die nie geprüft wird.
|
|
||||||
if _, err := s.GetVerified(ctx, key); err != nil {
|
|
||||||
return "", fmt.Errorf("storage: schreibverifikation fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, written); err != nil {
|
|
||||||
return checksum, fmt.Errorf("storage: objekt gespeichert, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
return checksum, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den Inhalt UNVERIFIZIERT (Streaming, für große Objekte).
|
|
||||||
// Für die Pflichtprüfung "beschädigtes Objekt wird erkannt" GetVerified
|
|
||||||
// verwenden.
|
|
||||||
func (s *Service) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
return s.driver.Get(ctx, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetVerified liest den vollständigen Inhalt UND vergleicht die beim
|
|
||||||
// Schreiben gespeicherte Prüfsumme gegen den beim Lesen berechneten
|
|
||||||
// Hash (Akzeptanzkriterium 2 / Pflichtprüfung 2).
|
|
||||||
func (s *Service) GetVerified(ctx context.Context, key string) ([]byte, error) {
|
|
||||||
sumReader, err := s.driver.Get(ctx, checksumKey(key))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
|
||||||
}
|
|
||||||
expectedRaw, err := io.ReadAll(sumReader)
|
|
||||||
_ = sumReader.Close()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
|
||||||
}
|
|
||||||
expected := string(expectedRaw)
|
|
||||||
|
|
||||||
contentReader, err := s.driver.Get(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer func() { _ = contentReader.Close() }()
|
|
||||||
|
|
||||||
hasher := sha256.New()
|
|
||||||
content, err := io.ReadAll(io.TeeReader(contentReader, hasher))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: objekt lesen: %w", err)
|
|
||||||
}
|
|
||||||
actual := hex.EncodeToString(hasher.Sum(nil))
|
|
||||||
if actual != expected {
|
|
||||||
return nil, ErrChecksumMismatch
|
|
||||||
}
|
|
||||||
return content, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delete entfernt Inhalt UND Prüfsummen-Sidecar, meldet die Größe als
|
|
||||||
// negatives Delta an Core LIC-05 (Akzeptanzkriterium 4) — der Aufrufer
|
|
||||||
// muss die Größe kennen (Delete selbst kann sie nach dem Löschen nicht
|
|
||||||
// mehr ermitteln).
|
|
||||||
func (s *Service) Delete(ctx context.Context, key string, sizeBytes int64) error {
|
|
||||||
if err := s.driver.Delete(ctx, key); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
// Sidecar-Löschung ist best effort — ein fehlendes Sidecar (z. B.
|
|
||||||
// bei einem sehr alten Objekt) darf den eigentlichen Löschvorgang
|
|
||||||
// nicht blockieren.
|
|
||||||
_ = s.driver.Delete(ctx, checksumKey(key))
|
|
||||||
|
|
||||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, -sizeBytes); err != nil {
|
|
||||||
return fmt.Errorf("storage: objekt gelöscht, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,134 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fakeUsageReporter struct {
|
|
||||||
reports []int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeUsageReporter) Report(_ context.Context, _, metric string, delta int64) error {
|
|
||||||
if metric != UsageMetric {
|
|
||||||
return errors.New("unerwartete metrik: " + metric)
|
|
||||||
}
|
|
||||||
f.reports = append(f.reports, delta)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTestService(t *testing.T) (*Service, *fakeUsageReporter) {
|
|
||||||
t.Helper()
|
|
||||||
driver := NewLocalDriver(t.TempDir())
|
|
||||||
usage := &fakeUsageReporter{}
|
|
||||||
return NewService(driver, usage, "acme"), usage
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ReadBackIsByteIdentical ist die geforderte Pflichtprüfung 1:
|
|
||||||
// ein geschriebenes Objekt liefert beim Lesen byteidentischen Inhalt.
|
|
||||||
func TestPut_ReadBackIsByteIdentical(t *testing.T) {
|
|
||||||
svc, _ := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-1", 0)
|
|
||||||
content := "vollständig identischer Inhalt äöü"
|
|
||||||
|
|
||||||
checksum, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
if checksum == "" {
|
|
||||||
t.Fatal("erwartet nicht-leere prüfsumme")
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := svc.GetVerified(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("getverified: %v", err)
|
|
||||||
}
|
|
||||||
if string(got) != content {
|
|
||||||
t.Fatalf("nicht byteidentisch: got %q, want %q", got, content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestGetVerified_DetectsTamperedObject ist die geforderte
|
|
||||||
// Pflichtprüfung 2: ein absichtlich beschädigtes Objekt wird bei
|
|
||||||
// Prüfsummenvergleich erkannt.
|
|
||||||
func TestGetVerified_DetectsTamperedObject(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
driver := NewLocalDriver(dir)
|
|
||||||
usage := &fakeUsageReporter{}
|
|
||||||
svc := NewService(driver, usage, "acme")
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-tamper", 0)
|
|
||||||
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader("originaler inhalt"), 17, "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Objekt DIREKT am Dateisystem manipulieren — umgeht Service
|
|
||||||
// vollständig, simuliert externe Beschädigung/Manipulation.
|
|
||||||
full := driver.path(key)
|
|
||||||
if err := os.WriteFile(full, []byte("MANIPULIERTER INHALT"), 0o644); err != nil {
|
|
||||||
t.Fatalf("manipulation schreiben: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := svc.GetVerified(ctx, key)
|
|
||||||
if !errors.Is(err, ErrChecksumMismatch) {
|
|
||||||
t.Fatalf("erwartet ErrChecksumMismatch bei manipuliertem objekt, habe: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ManySmallObjectsAcceptableLatency ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Lasttest mit vielen kleinen Objekten bestätigt
|
|
||||||
// akzeptable Latenz.
|
|
||||||
func TestPut_ManySmallObjectsAcceptableLatency(t *testing.T) {
|
|
||||||
svc, _ := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const count = 500
|
|
||||||
start := time.Now()
|
|
||||||
for i := 0; i < count; i++ {
|
|
||||||
key := ObjectKey("msg-load", i)
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader("kleiner anhang inhalt"), 21, "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put #%d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
avgPerObject := elapsed / count
|
|
||||||
|
|
||||||
// Großzügige Grenze (10ms/Objekt inkl. Schreiben+Sidecar+Rücklese-
|
|
||||||
// Verifikation) — Ziel ist der Nachweis, dass keine quadratische
|
|
||||||
// oder anderweitig unverhältnismäßige Verschlechterung auftritt,
|
|
||||||
// nicht ein knallhartes Performance-SLA.
|
|
||||||
if avgPerObject > 10*time.Millisecond {
|
|
||||||
t.Fatalf("erwartet akzeptable latenz (<10ms/objekt), habe %v/objekt (gesamt %v für %d objekte)", avgPerObject, elapsed, count)
|
|
||||||
}
|
|
||||||
t.Logf("Lasttest: %d Objekte in %v (%v/Objekt)", count, elapsed, avgPerObject)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ReportsUsageOnWriteAndDelete ist die geforderte
|
|
||||||
// Pflichtprüfung 4: Melde-Aufruf an Core LIC-05 bei Schreib- und
|
|
||||||
// Löschvorgang nachweislich ausgelöst, mit korrekter Größenangabe.
|
|
||||||
func TestPut_ReportsUsageOnWriteAndDelete(t *testing.T) {
|
|
||||||
svc, usage := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-usage", 0)
|
|
||||||
content := "zwölf bytes!"
|
|
||||||
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
if len(usage.reports) != 1 || usage.reports[0] != int64(len(content)) {
|
|
||||||
t.Fatalf("erwartet genau eine positive meldung mit größe %d, habe: %v", len(content), usage.reports)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := svc.Delete(ctx, key, int64(len(content))); err != nil {
|
|
||||||
t.Fatalf("delete: %v", err)
|
|
||||||
}
|
|
||||||
if len(usage.reports) != 2 || usage.reports[1] != -int64(len(content)) {
|
|
||||||
t.Fatalf("erwartet zusätzliche negative meldung mit -%d, habe: %v", len(content), usage.reports)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user