repository: do not delete config on atomic backends during upgrade rollback (#22136)

In UpgradeRepo, if upgradeRepository fails, the error handler attempts
contingency rollback by re-uploading the original config file.

However, the contingency path unconditionally executed repo.be.Remove(ctx, h)
before calling repo.be.Save. On backends supporting atomic replacement (such
as local filesystems), a failed upgrade (e.g. out-of-disk-space or permissions
error while writing the temporary file) leaves the original, valid version 1
configuration file completely intact on disk.

Unconditionally removing the config file during rollback actively deletes
the working configuration. If the subsequent Save call also fails, the
repository is left permanently corrupted without a config file.

Condition the pre-removal on !repo.be.Properties().HasAtomicReplace, matching
the forward upgrade path in upgradeRepository. Add a unit test asserting that
aborted upgrades on atomic backends preserve the intact original configuration.

---------

Co-authored-by: Michael Eischer <michael.eischer@fau.de>
This commit is contained in:
Rob MartinandMichael Eischer authored and GitHub committed 2026-11-15 18:57:01 +00:00
1 parent c904b78998
commit 2c9b353cbf
4 files changed
+50 -7

No files matched your search

+1 -1
View File
@@ -36,5 +36,5 @@ func (*UpgradeRepoV2) RepoCheck() bool {
}
func (m *UpgradeRepoV2) Apply(ctx context.Context, repo restic.Repository) error {
return repository.UpgradeRepo(ctx, repo.(*repository.Repository))
return repository.UpgradeRepo(ctx, repo.(*repository.Repository), "")
}
+7 -4
View File
@@ -53,12 +53,12 @@ func upgradeRepository(ctx context.Context, repo *Repository) error {
return nil
}
func UpgradeRepo(ctx context.Context, repo *Repository) error {
func UpgradeRepo(ctx context.Context, repo *Repository, tempBaseDir string) error {
if repo.Config().Version != 1 {
return fmt.Errorf("repository has version %v, only upgrades from version 1 are supported", repo.Config().Version)
}
tempdir, err := os.MkdirTemp("", "restic-migrate-upgrade-repo-v2-")
tempdir, err := os.MkdirTemp(tempBaseDir, "restic-migrate-upgrade-repo-v2-")
if err != nil {
return fmt.Errorf("create temp dir failed: %w", err)
}
@@ -87,8 +87,11 @@ func UpgradeRepo(ctx context.Context, repo *Repository) error {
BackupFilePath: backupFileName,
}
// try contingency methods, reupload the original file
_ = repo.be.Remove(ctx, h)
// Reupload the original file. For atomic-replace backends, keep the
// existing config intact in case the recovery write also fails.
if !repo.be.Properties().HasAtomicReplace {
_ = repo.be.Remove(ctx, h)
}
err = repo.be.Save(ctx, h, backend.NewByteReader(rawConfigFile, nil))
if err != nil {
repoError.ReuploadOldConfigError = err
+32 -2
View File
@@ -8,7 +8,9 @@ import (
"testing"
"github.com/restic/restic/internal/backend"
"github.com/restic/restic/internal/backend/local"
"github.com/restic/restic/internal/errors"
"github.com/restic/restic/internal/restic"
rtest "github.com/restic/restic/internal/test"
)
@@ -18,7 +20,7 @@ func TestUpgradeRepoV2(t *testing.T) {
t.Fatal("test repo has wrong version")
}
err := UpgradeRepo(context.Background(), repo)
err := UpgradeRepo(context.Background(), repo, "")
rtest.OK(t, err)
}
@@ -46,6 +48,34 @@ func (be *failBackend) Save(ctx context.Context, h backend.Handle, rd backend.Re
return be.Backend.Save(ctx, h, rd)
}
func TestUpgradeRepoV2FailurePreservesLocalConfig(t *testing.T) {
ctx := context.Background()
be, err := local.Create(ctx, local.Config{Path: t.TempDir()}, t.Logf)
rtest.OK(t, err)
// Both the upgrade and the recovery write fail after initialization.
repo, _ := TestRepositoryWithBackend(t, &failBackend{
ConfigFileSavesUntilError: 1,
Backend: be,
}, 1, Options{})
originalConfig, err := repo.LoadRaw(ctx, restic.ConfigFile, restic.ID{})
rtest.OK(t, err)
err = UpgradeRepo(ctx, repo, t.TempDir())
if err == nil {
t.Fatal("expected upgrade to fail")
}
upgradeErr := err.(*upgradeRepoV2Error)
if upgradeErr.ReuploadOldConfigError == nil {
t.Fatal("expected recovery write to fail")
}
// A failed recovery must not delete the intact original config.
preservedConfig, err := repo.LoadRaw(ctx, restic.ConfigFile, restic.ID{})
rtest.OK(t, err)
rtest.Equals(t, originalConfig, preservedConfig)
}
func TestUpgradeRepoV2Failure(t *testing.T) {
be := TestBackend(t)
@@ -60,7 +90,7 @@ func TestUpgradeRepoV2Failure(t *testing.T) {
t.Fatal("test repo has wrong version")
}
err := UpgradeRepo(context.Background(), repo)
err := UpgradeRepo(context.Background(), repo, "")
if err == nil {
t.Fatal("expected error returned from Apply(), got nil")
}