diff --git a/README.md b/README.md index 002180c..0664f99 100644 --- a/README.md +++ b/README.md @@ -448,6 +448,8 @@ remove the snapshot's metadata from it (`vaultik prune` does not). For a snapshot that is only on the destination store, that failure is an error. To wipe everything on the destination in one go, use `vaultik remote nuke --force`. +- Accepts a snapshot ID, or — for a snapshot only on the destination store — its + remote key (or an unambiguous leading part of it) as shown by `snapshot list`. - `--local-only`: Skip remote cleanup; only touch the local index - `--dry-run`: Show what would be deleted without deleting - `--force`: Skip confirmation prompt diff --git a/internal/cli/snapshot.go b/internal/cli/snapshot.go index 8996d35..7a3b402 100644 --- a/internal/cli/snapshot.go +++ b/internal/cli/snapshot.go @@ -288,6 +288,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 snapshot's metadata from the destination store, and never under --json. +The snapshot may be named by its ID or, on a host with no local index, by +the remote key that 'snapshot list' prints for a remote-only snapshot (an +unambiguous leading part is enough). + An ID that names no snapshot in the local index or on the destination store is an error. diff --git a/internal/vaultik/remove_snapshot_test.go b/internal/vaultik/remove_snapshot_test.go index ea88183..2162364 100644 --- a/internal/vaultik/remove_snapshot_test.go +++ b/internal/vaultik/remove_snapshot_test.go @@ -472,6 +472,100 @@ func TestRemoveSnapshot_NotInLocalIndex(t *testing.T) { assert.Contains(t, out, "Removed snapshot metadata from remote storage") } +// TestRemoveSnapshot_RemoteOnlyByRemoteKey checks that a snapshot only +// on the destination store, on a host with no local index, is removed by +// the remote key that 'snapshot list' prints for such a snapshot, and by +// an unambiguous leading part of it — the same identifiers verify and +// restore accept. Snapshot remove used to hash the argument again, so +// the hashed key never matched and only the plain snapshot ID worked. +func TestRemoveSnapshot_RemoteOnlyByRemoteKey(t *testing.T) { + log.Initialize(log.Config{}) + t.Parallel() + + remoteKey := snapshot.RemoteSnapshotKey("snapshot-001") + + identifiers := map[string]string{ + "full key": remoteKey, + "leading part": remoteKey[:8], + } + + for name, identifier := range identifiers { + t.Run(name, func(t *testing.T) { + t.Parallel() + + store := newTestStorer() + addManifest(t, store, "snapshot-001", nil) + + // No local index: a host that sees the snapshot only remotely. + 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"))) + + out := tv.Stdout.String() + assert.NotContains(t, out, "from local database") + assert.Contains(t, out, "Removed snapshot metadata from remote storage") + }) + } +} + +// TestRemoveSnapshot_LocalIndexByRemoteKey checks that a remote key (or +// its unambiguous leading part) that names a snapshot the local index +// holds removes that snapshot's local row and its remote metadata +// together. `snapshot list --json` prints a remote key for every +// snapshot, including local ones. +func TestRemoveSnapshot_LocalIndexByRemoteKey(t *testing.T) { + log.Initialize(log.Config{}) + t.Parallel() + + remoteKey := snapshot.RemoteSnapshotKey("snapshot-001") + + identifiers := map[string]string{ + "full key": remoteKey, + "leading part": remoteKey[:8], + } + + for name, identifier := range identifiers { + t.Run(name, func(t *testing.T) { + t.Parallel() + + store := newTestStorer() + addManifest(t, store, "snapshot-001", nil) + + // A backup wrote to this destination, so it carries the + // marker, and the local index holds the snapshot. + require.NoError(t, store.Put(context.Background(), markerFile, + bytes.NewReader(nil))) + + tv := vaultik.NewForTesting(store) + repos := newLocalIndex(t, "snapshot-001") + tv.Repositories = repos + + 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"))) + + row, err := repos.Snapshots.GetByID( + context.Background(), "snapshot-001") + require.NoError(t, err) + assert.Nil(t, row) + + out := tv.Stdout.String() + assert.Contains(t, out, + "Removed snapshot 'snapshot-001' from local database") + assert.Contains(t, out, "Removed snapshot metadata from remote storage") + }) + } +} + // TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a // snapshot only the destination store holds fails when its metadata // cannot be deleted there, under --force and under --json: nothing was diff --git a/internal/vaultik/snapshot.go b/internal/vaultik/snapshot.go index 34c7827..2270a47 100644 --- a/internal/vaultik/snapshot.go +++ b/internal/vaultik/snapshot.go @@ -1467,7 +1467,8 @@ func (v *Vaultik) RemoveSnapshot( return result, err } - inLocalIndex, err := v.checkSnapshotExists(snapshotID, opts.LocalOnly) + inLocalIndex, localID, remoteKey, err := v.findSnapshotToRemove( + snapshotID, opts.LocalOnly) if err != nil { return result, err } @@ -1489,16 +1490,16 @@ func (v *Vaultik) RemoveSnapshot( } if inLocalIndex { - log.Info("Removing snapshot from local database", "snapshot_id", snapshotID) + log.Info("Removing snapshot from local database", "snapshot_id", localID) - err = v.deleteSnapshotFromLocalDB(snapshotID) + err = v.deleteSnapshotFromLocalDB(localID) if err != nil { return result, fmt.Errorf("removing from local database: %w", err) } } result.RemoteRemoved, err = v.removeSnapshotRemote( - snapshotID, inLocalIndex, markerErr, opts) + snapshotID, remoteKey, inLocalIndex, markerErr, opts) if err != nil { return result, err } @@ -1517,7 +1518,7 @@ func (v *Vaultik) RemoveSnapshot( if inLocalIndex { v.UI.Infof("Removed snapshot '%s' from local database.", - v.UI.Snapshot(snapshotID)) + v.UI.Snapshot(localID)) } if result.RemoteRemoved { @@ -1530,6 +1531,62 @@ func (v *Vaultik) RemoveSnapshot( return result, nil } +// findSnapshotToRemove finds the snapshot that identifier names. It +// returns whether the local index holds that snapshot, the ID of its row +// there when it does, and the remote key of its metadata on the +// destination store. +// +// A snapshot ID is looked up by checkSnapshotExists. Under localOnly the +// store is not consulted, so every identifier is looked up that way and +// a remote key is not found. Otherwise a remote key, or a leading part +// of one, is resolved by resolveSnapshotRemoteKey, as restore and verify +// do. That fails with errSnapshotKeyNotFound or errSnapshotKeyAmbiguous +// when the identifier matches no snapshot on the store, or more than +// one. The store is listed only after checkDestinationMarker passes, as +// in checkSnapshotExists. The local row is the one whose snapshot ID +// hashes to the resolved key, as in RemoveAllSnapshots, so removing by +// remote key removes that row too. +func (v *Vaultik) findSnapshotToRemove( + identifier string, localOnly bool, +) (bool, string, string, error) { + if localOnly || !isRemoteKeyOrPrefix(identifier) { + inLocalIndex, err := v.checkSnapshotExists(identifier, localOnly) + if err != nil { + return false, "", "", err + } + + return inLocalIndex, identifier, snapshot.RemoteSnapshotKey(identifier), nil + } + + err := v.checkDestinationMarker() + if err != nil { + return false, "", "", err + } + + remoteKey, err := v.resolveSnapshotRemoteKey(identifier) + if err != nil { + return false, "", "", err + } + + objects, err := v.remoteSnapshotObjects(remoteKey) + if err != nil { + return false, "", "", fmt.Errorf("looking up snapshot on destination store: %w", err) + } + + if len(objects) == 0 { + return false, "", "", fmt.Errorf( + "%w in the local index or on the destination store: %s", + errSnapshotNotFound, identifier) + } + + localID, err := v.localSnapshotIDForRemoteKey(remoteKey) + if err != nil { + return false, "", "", err + } + + return localID != "", localID, remoteKey, nil +} + // checkSnapshotExists returns errSnapshotNotFound when the local index // has no row for snapshotID and, unless localOnly is set, the // destination store has no metadata for it either. inLocalIndex reports @@ -1639,19 +1696,20 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions) } // removeSnapshotRemote strips the snapshot's metadata from the -// destination store. It returns true only when the delete finished -// without an error and removed at least one object; under LocalOnly it -// does nothing. markerErr is the result of checkDestinationMarker; when -// it is set, nothing is deleted and it is the failure. When the snapshot -// is only on the destination store, a failure is returned as an error, -// because that removal is all the command does. When the snapshot was in -// the local index, its removal there has already happened, so a failure -// is only a warning telling the user to run `vaultik snapshot remove` -// for the snapshot again once the destination store is reachable -// (`vaultik prune` never removes snapshot metadata that has its -// manifest). +// destination store. remoteKey is the resolved metadata directory name +// to delete, as returned by findSnapshotToRemove. It returns true only +// when the delete finished without an error and removed at least one +// object; under LocalOnly it does nothing. markerErr is the result of +// checkDestinationMarker; when it is set, nothing is deleted and it is +// the failure. When the snapshot is only on the destination store, a +// failure is returned as an error, because that removal is all the +// command does. When the snapshot was in the local index, its removal +// there has already happened, so a failure is only a warning telling +// the user to run `vaultik snapshot remove` for the snapshot again once +// the destination store is reachable (`vaultik prune` never removes +// snapshot metadata that has its manifest). func (v *Vaultik) removeSnapshotRemote( - snapshotID string, inLocalIndex bool, markerErr error, + snapshotID, remoteKey string, inLocalIndex bool, markerErr error, opts *RemoveOptions, ) (bool, error) { if opts.LocalOnly { @@ -1665,8 +1723,7 @@ func (v *Vaultik) removeSnapshotRemote( err := markerErr if err == nil { - deleted, err = v.deleteRemoteSnapshotByKey( - snapshot.RemoteSnapshotKey(snapshotID)) + deleted, err = v.deleteRemoteSnapshotByKey(remoteKey) } if err != nil && !inLocalIndex { @@ -1780,6 +1837,23 @@ func (v *Vaultik) localSnapshotIDs() ([]string, error) { return ids, nil } +// localSnapshotIDForRemoteKey returns the human snapshot ID of the local +// index row whose RemoteSnapshotKey is key, or "" when no row has it. +func (v *Vaultik) localSnapshotIDForRemoteKey(key string) (string, error) { + ids, err := v.localSnapshotIDs() + if err != nil { + return "", fmt.Errorf("listing local snapshots: %w", err) + } + + for _, id := range ids { + if snapshot.RemoteSnapshotKey(id) == key { + return id, nil + } + } + + return "", nil +} + // listAllRemoteSnapshotKeys collects the hashed remote keys // (subdirectories under metadata/) currently present in the // destination store. Returns (nil, err) when the store cannot be