Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cd86db7416 | ||
|
|
d747ddef3a |
No files matched your search
@@ -468,10 +468,12 @@ destination store. Blobs are NOT touched — deleting blobs requires reading eve
|
|||||||
remaining remote manifest (the destination store may hold snapshots this host
|
remaining remote manifest (the destination store may hold snapshots this host
|
||||||
doesn't know about), which is what `vaultik prune` does. The command prints the
|
doesn't know about), which is what `vaultik prune` does. The command prints the
|
||||||
`vaultik prune` invocation to run as a follow-up only when it removed the
|
`vaultik prune` invocation to run as a follow-up only when it removed the
|
||||||
snapshot's metadata from the destination store, and never under `--json`. An ID
|
snapshot's metadata from the destination store, and never under `--json`. It
|
||||||
that names no snapshot in the local index or on the destination store is an
|
accepts the same identifiers as `snapshot restore`: a snapshot ID, or a
|
||||||
error; with `--local-only`, the snapshot must be in the local index. Local row
|
remote-only snapshot's remote key (or an unambiguous leading part of it). An
|
||||||
cleanup (files, chunks, blobs the snapshot was the last referrer for) runs
|
identifier that names no snapshot in the local index or on the destination store
|
||||||
|
is an error; with `--local-only`, the snapshot must be in the local index. Local
|
||||||
|
row cleanup (files, chunks, blobs the snapshot was the last referrer for) runs
|
||||||
automatically. If removing the snapshot's metadata from the destination store
|
automatically. If removing the snapshot's metadata from the destination store
|
||||||
fails (for example because the store is unreachable, or the local index holds
|
fails (for example because the store is unreachable, or the local index holds
|
||||||
snapshots and the destination answers that it has no `vaultik-destination.txt`),
|
snapshots and the destination answers that it has no `vaultik-destination.txt`),
|
||||||
|
|||||||
@@ -331,8 +331,10 @@ know about), which is what 'vaultik prune' does. The command prints the
|
|||||||
'vaultik prune' invocation to run as a follow-up only when it removed the
|
'vaultik prune' invocation to run as a follow-up only when it removed the
|
||||||
snapshot's metadata from the destination store, and never under --json.
|
snapshot's metadata from the destination store, and never under --json.
|
||||||
|
|
||||||
An ID that names no snapshot in the local index or on the destination
|
The snapshot may be named by its ID or by its remote key, which
|
||||||
store is an error.
|
'snapshot list' prints for a remote-only snapshot. An unambiguous
|
||||||
|
leading part of the key is enough. An identifier that names no snapshot
|
||||||
|
in the local index or on the destination store is an error.
|
||||||
|
|
||||||
Use --local-only to skip the remote half (e.g. when you want to forget a
|
Use --local-only to skip the remote half (e.g. when you want to forget a
|
||||||
snapshot locally without touching the destination store); the snapshot
|
snapshot locally without touching the destination store); the snapshot
|
||||||
|
|||||||
@@ -67,10 +67,12 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
|||||||
// Check for remote not found error
|
// Check for remote not found error
|
||||||
if strings.Contains(err.Error(), "didn't find section in config file") ||
|
if strings.Contains(err.Error(), "didn't find section in config file") ||
|
||||||
strings.Contains(err.Error(), "failed to find remote") {
|
strings.Contains(err.Error(), "failed to find remote") {
|
||||||
return nil, fmt.Errorf("%w: %s", ErrRemoteNotFound, remote)
|
return nil, fmt.Errorf("%w: %q (%s)",
|
||||||
|
ErrRemoteNotFound, remote, describeRcloneConfigFile())
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, fmt.Errorf("creating rclone filesystem: %w", err)
|
return nil, fmt.Errorf("opening rclone remote %q (%s): %w",
|
||||||
|
remote, describeRcloneConfigFile(), err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return &RcloneStorer{
|
return &RcloneStorer{
|
||||||
@@ -324,6 +326,22 @@ func (r *RcloneStorer) upload(ctx context.Context, key string, data io.Reader) e
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// describeRcloneConfigFile names the rclone config file for an error
|
||||||
|
// message, and says so when that file does not exist.
|
||||||
|
func describeRcloneConfigFile() string {
|
||||||
|
path := config.GetConfigPath()
|
||||||
|
if path == "" {
|
||||||
|
return "no config file"
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := os.Stat(path)
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return fmt.Sprintf("config file %q, which does not exist", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("config file %q", path)
|
||||||
|
}
|
||||||
|
|
||||||
// progressReader wraps an io.Reader to track read progress.
|
// progressReader wraps an io.Reader to track read progress.
|
||||||
type progressReader struct {
|
type progressReader struct {
|
||||||
reader io.Reader
|
reader io.Reader
|
||||||
|
|||||||
@@ -398,24 +398,100 @@ func TestNewRcloneStorerUnknownRemote(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestNewRcloneStorerReadsRcloneConfigEnv checks that a remote defined only
|
// setRcloneConfigEnv points RCLONE_CONFIG at path for the rest of the test.
|
||||||
// in the file RCLONE_CONFIG names is found and written to, as rclone itself
|
func setRcloneConfigEnv(t *testing.T, path string) {
|
||||||
// would.
|
t.Helper()
|
||||||
func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
|
||||||
// rclone keeps the config file path in a process-global variable, which
|
// rclone keeps the config file path in a process-global variable, which
|
||||||
// NewRcloneStorer leaves pointing at this test's file.
|
// NewRcloneStorer leaves pointing at path.
|
||||||
previous := config.GetConfigPath()
|
previous := config.GetConfigPath()
|
||||||
|
|
||||||
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
||||||
|
|
||||||
|
t.Setenv("RCLONE_CONFIG", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeRcloneConfigFile writes contents to a new rclone config file and
|
||||||
|
// returns its path.
|
||||||
|
func writeRcloneConfigFile(t *testing.T, contents string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
||||||
|
|
||||||
err := os.WriteFile(confFile, []byte("[loc]\ntype = local\n"), 0o600)
|
err := os.WriteFile(confFile, []byte(contents), 0o600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("writing rclone config: %v", err)
|
t.Fatalf("writing rclone config: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
t.Setenv("RCLONE_CONFIG", confFile)
|
return confFile
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewRcloneStorerErrorsNameRemoteAndConfigFile checks that each error
|
||||||
|
// from opening a remote names the remote and the rclone config file, and
|
||||||
|
// says when that file does not exist.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // sets RCLONE_CONFIG and the process-global rclone config
|
||||||
|
func TestNewRcloneStorerErrorsNameRemoteAndConfigFile(t *testing.T) {
|
||||||
|
const doesNotExist = "which does not exist"
|
||||||
|
|
||||||
|
missingFile := filepath.Join(t.TempDir(), "missing.conf")
|
||||||
|
emptyFile := writeRcloneConfigFile(t, "")
|
||||||
|
badRemoteFile := writeRcloneConfigFile(t,
|
||||||
|
"[bad]\ntype = vaultik-no-such-backend\n")
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
configFile string
|
||||||
|
remote string
|
||||||
|
wantNotFound bool
|
||||||
|
wantNoSuchFile bool
|
||||||
|
}{
|
||||||
|
{"config file missing", missingFile, "dav", true, true},
|
||||||
|
{"remote not in config file", emptyFile, "dav", true, false},
|
||||||
|
{"remote fails to open", badRemoteFile, "bad", false, false},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
setRcloneConfigEnv(t, tt.configFile)
|
||||||
|
|
||||||
|
_, err := storage.NewRcloneStorer(
|
||||||
|
context.Background(), tt.remote, "path")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("NewRcloneStorer succeeded, want an error")
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := err.Error()
|
||||||
|
|
||||||
|
if errors.Is(err, storage.ErrRemoteNotFound) != tt.wantNotFound {
|
||||||
|
t.Errorf("error = %v, want ErrRemoteNotFound: %v",
|
||||||
|
err, tt.wantNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(msg, `"`+tt.remote+`"`) {
|
||||||
|
t.Errorf("error %q does not name remote %q", msg, tt.remote)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(msg, tt.configFile) {
|
||||||
|
t.Errorf("error %q does not name config file %q",
|
||||||
|
msg, tt.configFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.Contains(msg, doesNotExist) != tt.wantNoSuchFile {
|
||||||
|
t.Errorf("error %q, want it to say the file does not exist: %v",
|
||||||
|
msg, tt.wantNoSuchFile)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewRcloneStorerReadsRcloneConfigEnv checks that a remote defined only
|
||||||
|
// in the file RCLONE_CONFIG names is found and written to, as rclone itself
|
||||||
|
// would.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // sets RCLONE_CONFIG and the process-global rclone config
|
||||||
|
func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
||||||
|
setRcloneConfigEnv(t, writeRcloneConfigFile(t, "[loc]\ntype = local\n"))
|
||||||
|
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|||||||
@@ -472,6 +472,68 @@ func TestRemoveSnapshot_NotInLocalIndex(t *testing.T) {
|
|||||||
assert.Contains(t, out, "Removed snapshot metadata from remote storage")
|
assert.Contains(t, out, "Removed snapshot metadata from remote storage")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRemoveSnapshot_ByRemoteKey checks that a snapshot only the
|
||||||
|
// destination store holds can be removed by the remote key that
|
||||||
|
// `snapshot list` shows for it, or by a leading part of that key.
|
||||||
|
func TestRemoveSnapshot_ByRemoteKey(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
remoteKey := snapshot.RemoteSnapshotKey("snapshot-001")
|
||||||
|
|
||||||
|
for name, identifier := range map[string]string{
|
||||||
|
"full key": remoteKey,
|
||||||
|
"leading part": remoteKey[:8],
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
store := newTestStorer()
|
||||||
|
addManifest(t, store, "snapshot-001", nil)
|
||||||
|
|
||||||
|
tv := vaultik.NewForTesting(store)
|
||||||
|
tv.Repositories = newLocalIndex(t)
|
||||||
|
|
||||||
|
result, err := tv.RemoveSnapshot(identifier,
|
||||||
|
&vaultik.RemoveOptions{Force: true})
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, result.RemoteRemoved)
|
||||||
|
assert.False(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRemoveSnapshot_ByRemoteKeyInLocalIndex checks that a snapshot the
|
||||||
|
// local index holds, named by its remote key, is removed from the local
|
||||||
|
// index as well as from the destination store.
|
||||||
|
func TestRemoveSnapshot_ByRemoteKeyInLocalIndex(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
store := newTestStorer()
|
||||||
|
addManifest(t, store, "snapshot-001", nil)
|
||||||
|
|
||||||
|
// A backup wrote to this destination, so it carries the marker.
|
||||||
|
require.NoError(t, store.Put(context.Background(), markerFile,
|
||||||
|
bytes.NewReader(nil)))
|
||||||
|
|
||||||
|
tv := vaultik.NewForTesting(store)
|
||||||
|
tv.Repositories = newLocalIndex(t, "snapshot-001")
|
||||||
|
|
||||||
|
result, err := tv.RemoveSnapshot(snapshot.RemoteSnapshotKey("snapshot-001"),
|
||||||
|
&vaultik.RemoveOptions{Force: true})
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, result.RemoteRemoved)
|
||||||
|
assert.False(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
||||||
|
|
||||||
|
snap, err := tv.Repositories.Snapshots.GetByID(context.Background(),
|
||||||
|
"snapshot-001")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Nil(t, snap)
|
||||||
|
}
|
||||||
|
|
||||||
// TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a
|
// TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a
|
||||||
// snapshot only the destination store holds fails when its metadata
|
// snapshot only the destination store holds fails when its metadata
|
||||||
// cannot be deleted there, under --force and under --json: nothing was
|
// cannot be deleted there, under --force and under --json: nothing was
|
||||||
|
|||||||
@@ -1467,7 +1467,8 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
|
|
||||||
inLocalIndex, err := v.checkSnapshotExists(snapshotID, opts.LocalOnly)
|
snapshotID, remoteKey, inLocalIndex, err := v.findSnapshotToRemove(
|
||||||
|
snapshotID, opts.LocalOnly)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
@@ -1498,7 +1499,7 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
}
|
}
|
||||||
|
|
||||||
result.RemoteRemoved, err = v.removeSnapshotRemote(
|
result.RemoteRemoved, err = v.removeSnapshotRemote(
|
||||||
snapshotID, inLocalIndex, markerErr, opts)
|
snapshotID, remoteKey, inLocalIndex, markerErr, opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
@@ -1530,6 +1531,41 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// findSnapshotToRemove returns the ID of the snapshot that identifier
|
||||||
|
// names, its remote key, and whether the local index holds it. A remote
|
||||||
|
// key, or the leading part of one, is resolved on the destination store;
|
||||||
|
// when the local index holds the snapshot with that key, its ID is
|
||||||
|
// returned, so it is removed from both.
|
||||||
|
func (v *Vaultik) findSnapshotToRemove(
|
||||||
|
identifier string, localOnly bool,
|
||||||
|
) (string, string, bool, error) {
|
||||||
|
if !isRemoteKeyOrPrefix(identifier) || localOnly {
|
||||||
|
inLocalIndex, err := v.checkSnapshotExists(identifier, localOnly)
|
||||||
|
|
||||||
|
return identifier, snapshot.RemoteSnapshotKey(identifier),
|
||||||
|
inLocalIndex, err
|
||||||
|
}
|
||||||
|
|
||||||
|
remoteKey, err := v.resolveSnapshotRemoteKey(identifier)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
localIDs, err := v.localSnapshotIDs()
|
||||||
|
if err != nil {
|
||||||
|
return "", "", false, fmt.Errorf(
|
||||||
|
"looking up snapshot in local index: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, id := range localIDs {
|
||||||
|
if snapshot.RemoteSnapshotKey(id) == remoteKey {
|
||||||
|
return id, remoteKey, true, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return identifier, remoteKey, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
// checkSnapshotExists returns errSnapshotNotFound when the local index
|
// checkSnapshotExists returns errSnapshotNotFound when the local index
|
||||||
// has no row for snapshotID and, unless localOnly is set, the
|
// has no row for snapshotID and, unless localOnly is set, the
|
||||||
// destination store has no metadata for it either. inLocalIndex reports
|
// destination store has no metadata for it either. inLocalIndex reports
|
||||||
@@ -1638,8 +1674,8 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions)
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// removeSnapshotRemote strips the snapshot's metadata from the
|
// removeSnapshotRemote strips the snapshot's metadata, under remoteKey,
|
||||||
// destination store. It returns true only when the delete finished
|
// from the destination store. It returns true only when the delete finished
|
||||||
// without an error and removed at least one object; under LocalOnly it
|
// without an error and removed at least one object; under LocalOnly it
|
||||||
// does nothing. markerErr is the result of checkDestinationMarker; when
|
// does nothing. markerErr is the result of checkDestinationMarker; when
|
||||||
// it is set, nothing is deleted and it is the failure. When the snapshot
|
// it is set, nothing is deleted and it is the failure. When the snapshot
|
||||||
@@ -1651,7 +1687,7 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions)
|
|||||||
// (`vaultik prune` never removes snapshot metadata that has its
|
// (`vaultik prune` never removes snapshot metadata that has its
|
||||||
// manifest).
|
// manifest).
|
||||||
func (v *Vaultik) removeSnapshotRemote(
|
func (v *Vaultik) removeSnapshotRemote(
|
||||||
snapshotID string, inLocalIndex bool, markerErr error,
|
snapshotID, remoteKey string, inLocalIndex bool, markerErr error,
|
||||||
opts *RemoveOptions,
|
opts *RemoveOptions,
|
||||||
) (bool, error) {
|
) (bool, error) {
|
||||||
if opts.LocalOnly {
|
if opts.LocalOnly {
|
||||||
@@ -1665,8 +1701,7 @@ func (v *Vaultik) removeSnapshotRemote(
|
|||||||
|
|
||||||
err := markerErr
|
err := markerErr
|
||||||
if err == nil {
|
if err == nil {
|
||||||
deleted, err = v.deleteRemoteSnapshotByKey(
|
deleted, err = v.deleteRemoteSnapshotByKey(remoteKey)
|
||||||
snapshot.RemoteSnapshotKey(snapshotID))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil && !inLocalIndex {
|
if err != nil && !inLocalIndex {
|
||||||
|
|||||||
Reference in new issue
Block a user