R-1256: four restore edges (review round 2 HUNT-1 H4/H5/H6/H8) — each test seen failing first
gates / gates (push) Successful in 31s

H4: a failed definition write in the off-site restore writes the live definition back before the start;
    a failed write-back holds the app (restore_mixed).
H5: a put-back whose stop fails pours nothing, keeps the copy and holds the app (off-site, local, power-cut);
    a failed definition write-back keeps the copy (D20); a failed 'volume rm -f' fails that volume (no merge).
H6: TryBeginRestoreOp/RestoreBusy: check every operation and record the restore in one step under m.mu;
    every web handler and the kept loads begin through it; install-time kept load asks about the mirror too.
H8: SweepUnusedRestoreCopies every 6 h: removes a copy only with no hold, no marker naming it, no restore
    running, and older than 14 days.

Commit only; rides the next controller release.
This commit is contained in:
admin committed 2026-10-28 22:24:16 +01:00
1 parent ed3927f03a
commit 342a394bff
20 files changed
+860 -50

No files matched your search

+26 -5
View File
@@ -301,8 +301,12 @@ func (m *Manager) downloadKeptOffsiteUnit(ctx context.Context, app, drive string
// LoadKeptOffsite is LoadKeptApp from the off-site copy c: download the unit alone, judge it, then
// prepare (nil = nothing; a dated folder's files move back here), then the one unit restore, then
// after(ok). A download failure or a refusal never reaches prepare, so the kept files stay as they were.
func (m *Manager) LoadKeptOffsite(app, drive string, c KeptCopy, prepare func() error, okMsg, failMsg func(err error) string, after func(ok bool)) {
m.BeginRestoreOp("restore", app)
// ErrRestoreBusy (nothing started, after not called) when another operation runs (R-1256 H6).
func (m *Manager) LoadKeptOffsite(app, drive string, c KeptCopy, prepare func() error, okMsg, failMsg func(err error) string, after func(ok bool)) error {
if busy, _ := m.TryBeginRestoreOp("restore", app); busy != "" {
m.logger.Printf("[WARN] [backup] kept load %s REFUSED: a %s operation runs (R-1256)", app, busy)
return ErrRestoreBusy
}
go func() {
start := time.Now()
fail := func(err error) {
@@ -345,6 +349,7 @@ func (m *Manager) LoadKeptOffsite(app, drive string, c KeptCopy, prepare func()
after(true)
}
}()
return nil
}
// RemovedUnitOnDrive is the start-fresh hook (stacks.SetKeptUnitFinder): the removed app's OWN unit when
@@ -370,11 +375,26 @@ func (m *Manager) PrimaryUnitHome(app, drive string) string {
// LoadKeptApp runs the load as a restore operation the backup pages already follow (the poll banner):
// Begin → RestoreFromRecoveryUnitAt(app, unitDir) → End, then after(ok) in the same goroutine (the
// after_load command, the kept folder's tidy-up). The caller has checked RestoreStatus/IsRunning.
func (m *Manager) LoadKeptApp(app, unitDir string, okMsg, failMsg func(err error) string, after func(ok bool)) {
m.BeginRestoreOp("restore", app)
// after_load command, the kept folder's tidy-up). prepare (nil = nothing) runs first, inside the operation — a dated
// folder's files move back there. R-1256 H6: the op is begun in the same step as the check for every other operation;
// a refusal returns ErrRestoreBusy with nothing started and nothing moved.
func (m *Manager) LoadKeptApp(app, unitDir string, prepare func() error, okMsg, failMsg func(err error) string, after func(ok bool)) error {
if busy, _ := m.TryBeginRestoreOp("restore", app); busy != "" {
m.logger.Printf("[WARN] [backup] kept load %s REFUSED: a %s operation runs (R-1256)", app, busy)
return ErrRestoreBusy
}
go func() {
start := time.Now()
if prepare != nil {
if perr := prepare(); perr != nil {
m.logger.Printf("[ERROR] [backup] kept load %s: preparing the kept files FAILED: %v — nothing was loaded", app, perr)
m.EndRestoreOp(false, failMsg(perr))
if after != nil {
after(false)
}
return
}
}
res, err := m.keptUnitRestore()(app, unitDir)
if errors.Is(err, ErrRestoreNotStarted) {
m.keptLoadNotStarted(app, err, after)
@@ -395,6 +415,7 @@ func (m *Manager) LoadKeptApp(app, unitDir string, okMsg, failMsg func(err error
after(true)
}
}()
return nil
}
// keptLoadNotStarted (R-1270): the kept data is loaded but the app did not start in time. Never „done": the record says
@@ -548,6 +548,25 @@ func (m *Manager) holdAppAfterMixedRestore(stack string, replayErr error, live *
}
}
// restartAtLiveDefinition (R-1256 H4) is the failure branch of the definition write, taken while no data has moved.
// The writer writes the compose before the app's settings, so a failure can leave the snapshot's compose in the
// stack dir: the LIVE definition is written back first, and only then is the app started. When the write-back fails
// too, the app is held stopped (restore_mixed) — a start would run the snapshot's definition over the live data.
// Pinned by TestR1256_H4_*.
func (m *Manager) restartAtLiveDefinition(stack string, live *liveDefinition, cause error, restartStack func() error) {
if live != nil {
if err := m.stackProvider.RecreateStackDefinitionFromUnit(stack, live.dir, live.env); err != nil {
m.logger.Printf("[ERROR] [offbox] %s: the definition write failed (%v) and writing the live definition back failed too: %v — holding the app stopped", stack, cause, err)
m.holdAppAfterMixedRestore(stack, cause, nil)
return
}
m.logger.Printf("[INFO] [offbox] %s: the definition write failed (%v); the live definition is written back before the start", stack, cause)
}
if sErr := restartStack(); sErr != nil {
m.logger.Printf("[WARN] [offbox] %s: restart after a failed definition write also failed: %v", stack, sErr)
}
}
// SetRestoreHoldNotify wires the operator notification for a held app (cmd/controller/main.go).
func (m *Manager) SetRestoreHoldNotify(fn func(stack string, replayErr, rollbackErr error)) {
m.restoreHoldNotify = fn
@@ -1005,16 +1024,12 @@ func (m *Manager) ReconstituteFromOffsite(ctx context.Context, stack string, ack
// yet — a failure here restarts the app as it was.
if defineFromSnapshot {
if err := m.stackProvider.RecreateStackDefinitionFromUnit(stack, scratchCompose, snapEnv); err != nil {
if sErr := restartStack(); sErr != nil {
m.logger.Printf("[WARN] [offbox] %s: restart after a failed definition write also failed: %v", stack, sErr)
}
m.restartAtLiveDefinition(stack, liveDef, err, restartStack)
return res, fmt.Errorf("restoring %s: writing the snapshot's definition failed: %w", stack, err)
}
} else if len(credOverlay) > 0 {
if err := m.stackProvider.(secretValueSetter).SetStackSecretValues(stack, credOverlay); err != nil {
if sErr := restartStack(); sErr != nil {
m.logger.Printf("[WARN] [offbox] %s: restart after a failed password write also failed: %v", stack, sErr)
}
m.restartAtLiveDefinition(stack, liveDef, err, restartStack)
return res, fmt.Errorf("restoring %s: writing the backup's database password failed: %w", stack, err)
}
m.logger.Printf("[INFO] [offbox] %s: the backup's database password(s) %v written into the app's settings before the data (R-1106)", stack, credNames(credOverlay))
@@ -226,8 +226,13 @@ func (m *Manager) putBackAfterFailedRestore(stack string, cause error, live *liv
m.holdAppAfterMixedRestore(stack, cause, live)
return util.MsgError(holdKey, stack)
}
// R-1256 H5: a put-back under an app that could not be stopped could mix the copy with what the app writes.
// Nothing is poured; the copy is kept and the app held (D20: a put-back that fails holds and keeps its copy).
if err := m.stackProvider.StopStack(stack); err != nil {
m.logger.Printf("[WARN] [offbox] %s: stopping the app before the put-back failed: %v", stack, err)
c.keepIfAny()
m.logger.Printf("[ERROR] [offbox] %s: stopping the app before the put-back FAILED: %v — nothing is put back; the copy stays at %s; holding the app", stack, err, c.dirOrNone())
m.holdAppAfterMixedRestore(stack, cause, live)
return util.MsgError(holdKey, stack)
}
if volumesMoved {
if err := m.putBack(stack, c); err != nil {
@@ -239,7 +244,8 @@ func (m *Manager) putBackAfterFailedRestore(stack string, cause error, live *liv
}
if live != nil {
if err := m.stackProvider.RecreateStackDefinitionFromUnit(stack, live.dir, live.env); err != nil {
m.logger.Printf("[ERROR] [offbox] %s: writing the live definition back FAILED: %v — holding the app", stack, err)
c.keepIfAny() // R-1256 H5 (D20): a put-back that fails keeps its copy for support
m.logger.Printf("[ERROR] [offbox] %s: writing the live definition back FAILED: %v — the copy stays at %s; holding the app", stack, err, c.dirOrNone())
m.holdAppAfterMixedRestore(stack, cause, live)
return util.MsgError(holdKey, stack)
}
@@ -249,12 +255,19 @@ func (m *Manager) putBackAfterFailedRestore(stack string, cause error, live *liv
m.restorePutBackNotify(stack, cause)
}
if err := restart(); err != nil {
m.logger.Printf("[ERROR] [offbox] %s: start after the put-back failed: %v (the copy stays at %s)", stack, err, c.dirOrNone())
m.logger.Printf("[ERROR] [offbox] %s: start after the put-back failed: %v (the live volumes and definition are back; the copy %s is removed)", stack, err, c.dirOrNone())
return util.MsgError("err.backup.restore_failed_put_back_not_started", stack)
}
return putBackMessage(stack, filesPlaced)
}
// keepIfAny marks the copy as kept for support (no copy: nothing to keep).
func (c *liveVolumeCopy) keepIfAny() {
if c != nil {
c.keep = true
}
}
func (c *liveVolumeCopy) dirOrNone() string {
if c == nil {
return "(no volume copy)"
+47
View File
@@ -62,6 +62,53 @@ type RestoreOpStatus struct {
func (m *Manager) BeginRestoreOp(op, stack string) {
m.mu.Lock()
defer m.mu.Unlock()
m.beginRestoreOpLocked(op, stack)
}
// Why a new restore may not begin now (R-1256 H6). "" = it may.
const (
RestoreBusyRestore = "restore" // a restore op is in flight (the record the pages follow)
RestoreBusyBackup = "backup" // the single-flight backup/restore run is held (the night run never records an op)
RestoreBusyMirror = "mirror" // a second-drive copy runs, or one a previous process lost may still run
)
// TryBeginRestoreOp is BeginRestoreOp that refuses — in the SAME step, under m.mu — while another restore op, a
// backup run or a second-drive copy runs. R-1256 H6: the pages asked (RestoreStatus, IsRunning,
// Tier2CopyBlocksRestore) and recorded the op later; a mirror that began in between ran beside the restore. The mirror
// asks under the same m.mu (beginTier2Run), so one of the two always sees the other. Lock order m.mu → tier2Copies,
// as in beginTier2Run. Returns the busy reason ("" = begun) and, for a mirror, its app ("" when unknown).
// Pinned by TestR1256_H6_*.
func (m *Manager) TryBeginRestoreOp(op, stack string) (busy, mirrorApp string) {
m.mu.Lock()
defer m.mu.Unlock()
if busy, app := m.restoreBusyLocked(); busy != "" {
return busy, app
}
m.beginRestoreOpLocked(op, stack)
return "", ""
}
// RestoreBusy is TryBeginRestoreOp's question alone — for a refusal asked early, before a request is read further.
func (m *Manager) RestoreBusy() (busy, mirrorApp string) {
m.mu.Lock()
defer m.mu.Unlock()
return m.restoreBusyLocked()
}
func (m *Manager) restoreBusyLocked() (string, string) {
if m.opRunning {
return RestoreBusyRestore, m.opStack
}
if m.running {
return RestoreBusyBackup, ""
}
if app, blocked := m.Tier2CopyBlocksRestore(); blocked {
return RestoreBusyMirror, app
}
return "", ""
}
func (m *Manager) beginRestoreOpLocked(op, stack string) {
m.opRunning = true
m.opName = op
m.opStack = stack
@@ -0,0 +1,358 @@
package backup
import (
"context"
"errors"
"io"
"log"
"os"
"path/filepath"
"strings"
"testing"
"time"
"gitea.dooplex.hu/admin/felhom-controller/internal/settings"
)
// R-1256 (review round 2, HUNT-1): four restore edges — H4, H5, H6 and H8, each pinned below.
//
// H4: an off-site restore writes the snapshot's definition before any data moves. The writer
// (stackAdapter.RecreateStackDefinitionFromUnit) writes the compose FIRST and the app's settings after, so a
// failure can come back with the snapshot's compose already in the stack dir. The failure branch used to start
// the app at once — on the snapshot's (older) compose, over the live data. Now the live definition is written
// back first; only then is the app started. When the write-back fails too, the app is held, never started.
// r1256DefFailProvider fails the FIRST definition write (the snapshot's), after recording it — as the real
// writer does when its compose write succeeded and its settings write did not.
type r1256DefFailProvider struct {
*r893Provider
failWrites int // how many writes fail, from the first
failFrom int // when set, every write from this one (1-based) on fails
}
func (p *r1256DefFailProvider) RecreateStackDefinitionFromUnit(name, composeDir string, env map[string]string) error {
if err := p.r893Provider.RecreateStackDefinitionFromUnit(name, composeDir, env); err != nil {
return err
}
if len(p.defs) <= p.failWrites || (p.failFrom > 0 && len(p.defs) >= p.failFrom) {
return errors.New("app.yaml write failed")
}
return nil
}
func r1256DefFailFixture(t *testing.T, failWrites int) (*Manager, *r1256DefFailProvider, *int) {
t.Helper()
m, vp, _, notified, _ := r893FixtureA(t, true, 0)
p := &r1256DefFailProvider{r893Provider: vp, failWrites: failWrites}
m.SetStackProvider(p)
return m, p, notified
}
// RED-PROOF: remove the live write-back from the definition-write failure branch (restartStack alone) → one
// definition write (the snapshot's), then the start → FAILS.
func TestR1256_H4_AFailedDefinitionWriteStartsTheAppAtItsLiveDefinition(t *testing.T) {
m, p, notified := r1256DefFailFixture(t, 1)
_, err := m.ReconstituteFromOffsite(context.Background(), "immich", false)
if err == nil {
t.Fatal("a failed definition write must be surfaced")
}
if len(p.defs) != 2 || !strings.Contains(strings.Join(p.defs[1], " "), "postgres:18-alpine") {
t.Fatalf("definition writes %v — want the snapshot's, then the LIVE one written back", p.defs)
}
if !p.fullStarted {
t.Fatalf("the app must run again at its live definition — calls %v", p.calls)
}
// The write-back comes BEFORE the start.
lastRecreate, lastStart := -1, -1
for i, c := range p.calls {
switch c {
case "recreate":
lastRecreate = i
case "start":
lastStart = i
}
}
if lastRecreate > lastStart {
t.Fatalf("the app was started before the live definition was written back — calls %v", p.calls)
}
if held, _ := m.RestoreHoldFor("immich"); held {
t.Fatal("the live definition is back: the app must not be held")
}
if *notified != 0 {
t.Errorf("hold notices %d, want 0", *notified)
}
}
// The write-back fails too: the stack dir may still hold the snapshot's compose, so the app is NOT started; it is
// held (restore_mixed: the definition moved and could not be put back) and the operator is told once.
// RED-PROOF: start the app when the write-back fails → fullStarted → FAILS.
func TestR1256_H4_AFailedWriteBackHoldsTheApp(t *testing.T) {
m, p, notified := r1256DefFailFixture(t, 2)
_, err := m.ReconstituteFromOffsite(context.Background(), "immich", false)
if err == nil {
t.Fatal("a failed definition write must be surfaced")
}
if p.fullStarted {
t.Fatalf("the app was STARTED although its live definition could not be written back — calls %v", p.calls)
}
held, _ := m.RestoreHoldFor("immich")
if !held {
t.Fatal("no hold: every start path would start the app on the snapshot's definition")
}
if k := m.HoldKind("immich"); k != settings.HoldReasonRestoreMixed {
t.Errorf("hold kind %q, want %q", k, settings.HoldReasonRestoreMixed)
}
if *notified != 1 {
t.Errorf("the operator must be told once, got %d", *notified)
}
}
// ---- H5: a put-back whose stop fails must not go on; `volume rm -f` errors count; a failed put-back keeps its copy.
// r1256StopFailProvider fails the Nth StopStack (1-based).
type r1256StopFailProvider struct {
*r893Provider
failAt, n int
}
func (p *r1256StopFailProvider) StopStack(name string) error {
p.n++
err := p.r893Provider.StopStack(name)
if p.n == p.failAt {
return errors.New("compose down: timeout")
}
return err
}
// The off-site put-back: the replay fails after the snapshot's volume replaced the live one; the stop before the
// put-back fails. Pouring the copy back under a running app could mix it with what the app writes, so nothing is
// poured, the copy is KEPT, and the app is held.
// RED-PROOF: restore the „(continuing)" WARN in putBackAfterFailedRestore → the copy is poured and the app started
// → FAILS.
func TestR1256_H5_APutBackWhoseStopFailsDoesNotPourAndKeepsTheCopy(t *testing.T) {
m, vp, rig, _, notified, putBack := r893PutBackFixture(t)
p := &r1256StopFailProvider{r893Provider: vp, failAt: 2} // 1 = the restore's stop, 2 = the put-back's
m.SetStackProvider(p)
_, err := m.ReconstituteFromOffsite(context.Background(), "immich", false)
if err == nil {
t.Fatal("a failed restore must be surfaced")
}
if p.n < 2 {
t.Fatalf("the put-back's stop never ran (stops %d) — the fixture did not reach the put-back", p.n)
}
if len(rig.poured) != 0 || len(rig.removed) != 0 {
t.Fatalf("the copy was poured (%v) / volumes removed (%v) after a FAILED stop", rig.poured, rig.removed)
}
if vp.fullStarted {
t.Fatalf("the app was started after a failed put-back — calls %v", vp.calls)
}
if held, _ := m.RestoreHoldFor("immich"); !held {
t.Fatal("a put-back that could not run must hold the app (D20)")
}
if left := undoCopies(t, rig.undoRoot); len(left) == 0 {
t.Fatal("the copy must be KEPT after a failed put-back (D20)")
}
if *notified != 1 || *putBack != 0 {
t.Errorf("hold notices %d (want 1), put-back notices %d (want 0)", *notified, *putBack)
}
}
// The live definition cannot be written back after the volumes were poured: the app is held and the copy is KEPT
// (D20: a put-back that fails keeps its copy for support).
// RED-PROOF: drop `c.keep = true` from the definition write-back failure branch → the copy is removed → FAILS.
func TestR1256_H5_AFailedDefinitionWriteBackKeepsTheCopy(t *testing.T) {
m, vp, rig, _, _, _ := r893PutBackFixture(t)
// A version change, so a live definition exists to be written back; the second write (the write-back) fails.
if err := os.WriteFile(vp.composePath, []byte(vtCompose("18")), 0o644); err != nil {
t.Fatal(err)
}
vp.livePins = ParseComposeImages(vp.composePath)
p := &r1256DefFailProvider{r893Provider: vp, failWrites: 0}
p.failFrom = 2
m.SetStackProvider(p)
_, err := m.ReconstituteFromOffsite(context.Background(), "immich", false)
if err == nil {
t.Fatal("a failed restore must be surfaced")
}
if len(p.defs) < 2 {
t.Fatalf("the write-back never ran: writes %v", p.defs)
}
if held, _ := m.RestoreHoldFor("immich"); !held {
t.Fatal("a failed write-back must hold the app")
}
if left := undoCopies(t, rig.undoRoot); len(left) == 0 {
t.Fatal("the copy must be KEPT after a failed put-back (D20)")
}
}
// The crash put-back (a restore cut by a power loss): the stop before pouring fails → an error (the guard then
// holds the app and keeps the copy, R-1251 H2), nothing poured.
// RED-PROOF: restore the „(continuing)" WARN in PutBackInterruptedRestore → nil error, the copy poured → FAILS.
func TestR1256_H5_ACrashPutBackWhoseStopFailsRefuses(t *testing.T) {
dir := t.TempDir()
undo := filepath.Join(dir, "backups", "restore-undo", "app", "20261028T000000Z")
mustWrite(t, filepath.Join(undo, "undo.json"), `{"stack":"app","copied":["app_data"],"definition":false}`)
mustWrite(t, filepath.Join(undo, "app_data.tar"), "LIVE")
poured := 0
cp := NewCrashPutBack(func(string) error { return errors.New("compose down: timeout") }, nil, log.New(io.Discard, "", 0))
cp.volReplay = func(string, string) (int, error) { poured++; return 1, nil }
if err := cp.PutBackInterruptedRestore("app", undo); err == nil {
t.Fatal("a put-back whose stop failed must return an error")
}
if poured != 0 {
t.Fatal("the copy was poured back under an app that could not be stopped")
}
if _, err := os.Stat(filepath.Join(undo, "app_data.tar")); err != nil {
t.Fatal("the copy must stay on disk")
}
}
// restoreDockerVolumesFrom: a `docker volume rm -f` that fails (the volume is still in use) used to be ignored; the
// `volume create` that follows is a no-op on an existing volume, so the tar was unpacked ON TOP of the old content —
// a merge. Now that volume counts as failed and is not touched.
// RED-PROOF: ignore the rm error again → the create and the tar run for the volume → FAILS.
func TestR1256_H5_AVolumeThatCannotBeRemovedIsNotMergedInto(t *testing.T) {
bin := t.TempDir()
calls := filepath.Join(bin, "calls.log")
stub := "#!/bin/sh\necho \"$@\" >> " + calls + "\n" +
"case \"$*\" in 'compose version --short') echo v2.29.7;; 'volume rm -f app_busy') echo 'volume is in use' >&2; exit 1;; esac\nexit 0\n"
if err := os.WriteFile(filepath.Join(bin, "docker"), []byte(stub), 0o755); err != nil {
t.Fatal(err)
}
t.Setenv("PATH", bin+string(os.PathListSeparator)+os.Getenv("PATH"))
dump := t.TempDir()
for _, n := range []string{"app_busy.tar", "app_free.tar"} {
mustWrite(t, filepath.Join(dump, n), "tar")
}
m := &Manager{logger: log.New(io.Discard, "", 0)}
n, err := m.restoreDockerVolumesFrom("app", dump)
if err == nil || n != 1 {
t.Fatalf("restored %d, err %v — want 1 and an error naming app_busy", n, err)
}
if !strings.Contains(err.Error(), "app_busy") {
t.Errorf("the error must name the volume: %v", err)
}
b, _ := os.ReadFile(calls)
for _, l := range strings.Split(string(b), "\n") {
if (strings.HasPrefix(l, "volume create") || strings.HasPrefix(l, "run ")) && strings.Contains(l, "app_busy") {
t.Fatalf("the volume that could not be removed was written into: %q", l)
}
}
}
// ---- H6: a second-drive mirror must not start between the page's refusal and the restore's own record.
// The page asked (nothing ran), then a mirror began, then the restore began: the begin itself refuses, records
// nothing, and the mirror — asked under the same lock — refuses once a restore is recorded.
// RED-PROOF: make TryBeginRestoreOp record the op without asking (the old BeginRestoreOp) → the restore begins beside
// the mirror → FAILS.
func TestR1256_H6_ARestoreCannotBeginBesideAMirrorThatStartedAfterTheCheck(t *testing.T) {
tier2ResetForTest()
defer tier2ResetForTest()
m, _ := newOffboxManager(t)
if busy, _ := m.RestoreBusy(); busy != "" {
t.Fatalf("fixture: nothing runs, got %q", busy)
}
// the window: the page's check passed; now a mirror begins
if !m.beginTier2Run("immich") {
t.Fatal("fixture: the mirror must begin while no restore is recorded")
}
if busy, app := m.TryBeginRestoreOp("restore", "immich"); busy != RestoreBusyMirror || app != "immich" {
t.Fatalf("the restore began beside a running mirror: busy=%q app=%q", busy, app)
}
if m.RestoreStatus().Running {
t.Fatal("a refused begin left a restore op recorded")
}
tier2CopyEnd("immich")
if busy, _ := m.TryBeginRestoreOp("restore", "immich"); busy != "" {
t.Fatalf("with the mirror done the restore must begin, got %q", busy)
}
if m.beginTier2Run("immich") {
t.Fatal("a mirror began while the restore of the same app is recorded")
}
// a second restore is refused while the first runs; the backup run refuses too
if busy, _ := m.TryBeginRestoreOp("restore", "other"); busy != RestoreBusyRestore {
t.Fatalf("a second restore began beside the first: %q", busy)
}
m.EndRestoreOp(true, "ok")
if err := m.AcquireRunningForTest(); err != nil {
t.Fatal(err)
}
if busy, _ := m.TryBeginRestoreOp("restore", "immich"); busy != RestoreBusyBackup {
t.Fatalf("a restore began beside a backup run: %q", busy)
}
m.ReleaseRunningForTest()
}
// ---- H8: an unused restore copy is cleaned up; a copy a hold or a pending put-back needs is never touched.
func r1256Copy(t *testing.T, m *Manager, app string, age time.Duration, now time.Time) string {
t.Helper()
dir := filepath.Join(restoreUndoDir(m.namespaceRoot(m.systemDataPath), app), now.Add(-age).UTC().Format(restoreCopyStampLayout))
mustWrite(t, filepath.Join(dir, app+"_data.tar"), "LIVE")
return dir
}
func r1256Exists(p string) bool { _, err := os.Stat(p); return err == nil }
// RED-PROOF: drop the hold check (or the marker check) from SweepUnusedRestoreCopies → the held / named copy is removed
// → FAILS; drop the age check → the young copy is removed → FAILS.
func TestR1256_H8_OnlyAnUnusedOldCopyIsRemoved(t *testing.T) {
m, sett := newOffboxManager(t)
now := time.Now()
old := 20 * 24 * time.Hour
unused := r1256Copy(t, m, "unused", old, now)
young := r1256Copy(t, m, "young", 24*time.Hour, now)
held := r1256Copy(t, m, "held", old, now)
waiting := r1256Copy(t, m, "waiting", old, now)
named := r1256Copy(t, m, "named", old, now)
if err := sett.SetRestoreHold(settings.RestoreHold{Stack: "held", At: now.Format(time.RFC3339), Reason: settings.HoldReasonRestoreMixed}); err != nil {
t.Fatal(err)
}
if err := sett.SetRestoreHold(settings.RestoreHold{Stack: "waiting", At: now.Format(time.RFC3339), Reason: settings.HoldReasonPutBackPending}); err != nil {
t.Fatal(err)
}
// a restore cut by a power loss: the marker (no longer active after a failed recovery's End) still names the copy
if err := m.appStop.Begin("unit-restore:named", ReasonUnitRestore, []string{"named"}); err != nil {
t.Fatal(err)
}
if err := m.appStop.SetUndo("named", named); err != nil {
t.Fatal(err)
}
got := m.SweepUnusedRestoreCopies(now)
if len(got) != 1 || got[0] != unused || r1256Exists(unused) {
t.Fatalf("removed %v — want exactly the unused old copy %s", got, unused)
}
for _, keep := range []string{young, held, waiting, named} {
if !r1256Exists(keep) {
t.Errorf("a needed copy was removed: %s", keep)
}
}
if r1256Exists(filepath.Dir(unused)) {
t.Error("the emptied per-app folder must go too")
}
}
// While a restore runs nothing is removed; a marker that cannot be read stops the sweep.
// RED-PROOF: drop the RestoreBusy check → the old copy goes during a restore → FAILS.
func TestR1256_H8_NothingIsRemovedDuringARestoreOrWithAnUnreadableMarker(t *testing.T) {
m, _ := newOffboxManager(t)
now := time.Now()
c := r1256Copy(t, m, "app", 20*24*time.Hour, now)
m.BeginRestoreOp("restore", "other")
if got := m.SweepUnusedRestoreCopies(now); len(got) != 0 || !r1256Exists(c) {
t.Fatalf("removed %v during a restore", got)
}
m.EndRestoreOp(true, "ok")
mustWrite(t, m.appStop.path, "{not json")
if got := m.SweepUnusedRestoreCopies(now); len(got) != 0 || !r1256Exists(c) {
t.Fatalf("removed %v with an unreadable marker", got)
}
if err := os.Remove(m.appStop.path); err != nil {
t.Fatal(err)
}
if got := m.SweepUnusedRestoreCopies(now); len(got) != 1 {
t.Fatalf("control: with nothing in the way the old copy goes, removed %v", got)
}
}
+8 -2
View File
@@ -224,8 +224,14 @@ func (m *Manager) restoreDockerVolumesFrom(stackName, dumpDir string) (int, erro
m.logger.Printf("[INFO] [backup] Restoring Docker volume %s for %s", volName, stackName)
// Remove existing volume (ignore errors — may not exist)
dockerexec.Command("docker", "volume", "rm", "-f", volName).Run()
// Remove the existing volume. `rm -f` of a missing volume succeeds, so an error means the volume EXISTS and
// could not be removed (still in use). R-1256 H5: it used to be ignored — the `volume create` below is a no-op
// on an existing volume, and the tar was unpacked ON TOP of the old content (a merge). That volume fails now.
if out, err := dockerexec.Command("docker", "volume", "rm", "-f", volName).CombinedOutput(); err != nil {
m.logger.Printf("[ERROR] [backup] Failed to remove volume %s before the restore: %s — %v (not written into)", volName, strings.TrimSpace(string(out)), err)
failed = append(failed, volName)
continue
}
// Create fresh volume — WITH the labels compose gives its own volumes (R-658, v0.268.0). A bare
// `volume create` made a volume the update's undo (until v0.267.0) could not find, and one
@@ -0,0 +1,129 @@
package backup
import (
"encoding/json"
"os"
"path/filepath"
"sort"
"time"
)
// R-1256 H8 (review round 2, HUNT-1): a restore copy (<namespace>/backups/restore-undo/<app>/<stamp>) that nothing
// will ever use again used to stay on the drive for good. A copy is KEPT on purpose in three states — a put-back that
// failed (the app is held, D20), a put-back waiting for its drive (the putback_pending hold, R-1251) and a restore cut
// by a power loss (the app-stop marker names it, D22) — and for 30 minutes after a restore while the box watches for a
// stable start (R-1270). Every one of those is still needed. A copy outside all of them — the app runs again, or was
// removed, and nothing names the copy — is disk the household cannot see or use.
//
// The rule (safest reading, decided in the 2026-10-28 night run; operator may change the age): a copy is removed only
// when ALL of these hold, and the sweep removes NOTHING when it cannot answer one of them:
// - it is older than restoreCopyUnusedAge (its folder's stamp; the folder's time when the stamp does not parse);
// - the app has no restore hold of any kind (held apps keep every copy — support decides);
// - the app-stop marker does not name the app (a pending put-back), and the marker is readable;
// - no restore op is in flight on the box (a new restore's copy and the stable-start watcher are left alone).
//
// Run every 6 hours from main.go (TestR1256_H8_TheSweepIsWiredAtStartup). Pinned by TestR1256_H8_*.
// restoreCopyUnusedAge is how long an unused copy stays for support after its restore.
const restoreCopyUnusedAge = 14 * 24 * time.Hour
// restoreCopyStampLayout is copyLiveVolumes' folder name.
const restoreCopyStampLayout = "20060102T150405Z"
// SweepUnusedRestoreCopies removes the restore copies no hold, no pending put-back and no running restore needs, and
// older than restoreCopyUnusedAge. Returns the folders removed.
func (m *Manager) SweepUnusedRestoreCopies(now time.Time) []string {
if busy, _ := m.RestoreBusy(); busy == RestoreBusyRestore {
m.logger.Printf("[INFO] [backup] restore-copy sweep skipped: a restore runs")
return nil
}
named, ok := m.appStopNamedApps()
if !ok {
m.logger.Printf("[WARN] [backup] restore-copy sweep skipped: the app-stop marker cannot be read — a copy it names must not go")
return nil
}
var removed []string
for _, nsRoot := range m.primaryUnitRoots() {
base := filepath.Join(nsRoot, "backups", "restore-undo")
apps, err := os.ReadDir(base)
if err != nil {
continue
}
for _, a := range apps {
if !a.IsDir() {
continue
}
app := a.Name()
if named[app] {
continue
}
if m.settings == nil {
return removed // no hold store: a held app cannot be told apart
}
if _, held := m.settings.GetRestoreHold(app); held {
continue
}
appDir := filepath.Join(base, app)
copies, err := os.ReadDir(appDir)
if err != nil {
continue
}
sort.Slice(copies, func(i, j int) bool { return copies[i].Name() < copies[j].Name() })
for _, c := range copies {
if !c.IsDir() {
continue
}
dir := filepath.Join(appDir, c.Name())
at, err := time.Parse(restoreCopyStampLayout, c.Name())
if err != nil {
fi, sErr := os.Stat(dir)
if sErr != nil {
continue
}
at = fi.ModTime()
}
if now.Sub(at) < restoreCopyUnusedAge {
continue
}
if err := os.RemoveAll(dir); err != nil {
m.logger.Printf("[WARN] [backup] %s: the unused restore copy %s could not be removed: %v", app, dir, err)
continue
}
m.logger.Printf("[INFO] [backup] %s: the unused restore copy %s (from %s) is removed — no hold, no pending put-back, older than %s (R-1256)",
app, dir, at.UTC().Format(time.RFC3339), restoreCopyUnusedAge)
removed = append(removed, dir)
}
_ = os.Remove(appDir) // the per-app folder, when it is now empty
}
}
return removed
}
// appStopNamedApps reads the app-stop marker without side effects: the apps of an ACTIVE marker and every app its Undo
// names. ok=false when the marker exists and cannot be read — the caller then touches nothing.
func (m *Manager) appStopNamedApps() (map[string]bool, bool) {
named := map[string]bool{}
if m.appStop == nil || m.appStop.path == "" {
return named, true
}
data, err := os.ReadFile(m.appStop.path)
if os.IsNotExist(err) {
return named, true
}
if err != nil {
return nil, false
}
var mk AppStopMarker
if err := json.Unmarshal(data, &mk); err != nil {
return nil, false
}
for app := range mk.Undo {
named[app] = true
}
if mk.Active {
for _, app := range mk.Stacks {
named[app] = true
}
}
return named, true
}
@@ -195,9 +195,11 @@ func (p *CrashPutBack) PutBackInterruptedRestore(stack, undoDir string) error {
if j.Stack != stack {
return fmt.Errorf("the restore copy at %s belongs to %q, not %q", undoDir, j.Stack, stack)
}
// R-1256 H5: never pour the copy back under an app that could not be stopped — a refusal here is a failed
// put-back: the guard holds the app and keeps the copy (R-1251 H2).
if p.stop != nil {
if err := p.stop(stack); err != nil {
p.logger.Printf("[WARN] [appstop] %s: stopping before the put-back failed: %v (continuing)", stack, err)
return fmt.Errorf("stopping %s before the put-back: %w", stack, err)
}
}
mgr := &Manager{logger: p.logger, volumeReplayFrom: p.volReplay, undoVolumeRemoveFn: p.volRemove}