Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
28a272903f | ||
|
|
7f3fb97012 | ||
|
|
d747ddef3a |
No files matched your search
@@ -196,9 +196,10 @@ vaultik version
|
|||||||
that cannot be restored when restoring, instead of aborting. Packing and
|
that cannot be restored when restoring, instead of aborting. Packing and
|
||||||
storage errors while creating a snapshot (which would leave a chunk recorded
|
storage errors while creating a snapshot (which would leave a chunk recorded
|
||||||
but not stored) still abort the run. A run that skipped anything still
|
but not stored) still abort the run. A run that skipped anything still
|
||||||
finishes but exits non-zero: `snapshot create` keeps the snapshot and counts
|
finishes but exits `3` (see [exit status](#exit-status)): `snapshot create`
|
||||||
each file or directory it skipped as failed. A file removed during the backup
|
keeps the snapshot and counts each file or directory it skipped as failed. A
|
||||||
is also counted as failed but does not change the exit status.
|
file removed during the backup is also counted as failed but does not change
|
||||||
|
the exit status.
|
||||||
|
|
||||||
### locking
|
### locking
|
||||||
|
|
||||||
@@ -271,6 +272,19 @@ Every `--json` command therefore pipes on its own, with no additional flag:
|
|||||||
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
||||||
work as written.
|
work as written.
|
||||||
|
|
||||||
|
### exit status
|
||||||
|
|
||||||
|
- `0`: the command succeeded.
|
||||||
|
- `1`: the command failed.
|
||||||
|
- `3`: `snapshot create` or `snapshot restore` finished, but `--skip-errors`
|
||||||
|
skipped files it could not read or restore. `restic backup` uses the same
|
||||||
|
status for this case.
|
||||||
|
- `130`: Ctrl-C, `SIGINT` or `SIGTERM` stopped the command.
|
||||||
|
|
||||||
|
A cron job can page on `1` and only log `3`. A run that skipped files and also
|
||||||
|
failed in another way exits `1`. For example, a restore that skipped files and
|
||||||
|
was asked for a path the snapshot does not hold exits `1`.
|
||||||
|
|
||||||
### environment variables
|
### environment variables
|
||||||
|
|
||||||
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
||||||
@@ -347,24 +361,25 @@ In such a config, an unknown key or a value of the wrong type is refused.
|
|||||||
local index, as `prune` does. By default keeps only the latest snapshot per
|
local index, as `prune` does. By default keeps only the latest snapshot per
|
||||||
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
||||||
skipped a file or directory it could not read or list, the prune does not run
|
skipped a file or directory it could not read or list, the prune does not run
|
||||||
and every older snapshot is kept, since one of them may be the only one that
|
and every older snapshot is kept. One of them may be the only one that holds
|
||||||
holds what was skipped; the command says so and exits non-zero. When the
|
what was skipped. The command says so and exits `3`. The prune does not run
|
||||||
backup found nothing in a configured path, as in the mount point of a volume
|
either when the backup found nothing in a configured path, as in the mount
|
||||||
that is not mounted, the prune does not run either: every older snapshot is
|
point of a volume that is not mounted. Every older snapshot is kept, and the
|
||||||
kept, and the command names the path and exits non-zero, on every run until
|
command names the path and exits `1`, on every run until the path holds
|
||||||
the path holds something again. Take a path that is empty on purpose out of
|
something again. Take a path that is empty on purpose out of the config, or
|
||||||
the config, or remove the older snapshots by hand with `snapshot purge`. When
|
remove the older snapshots by hand with `snapshot purge`. The prune does not
|
||||||
an earlier snapshot of the same name in the local index found a volume mounted
|
run either when this backup does not find a volume that an earlier snapshot of
|
||||||
at or below a configured path (a directory on a different filesystem from its
|
the same name in the local index found. The volume's mount point is a
|
||||||
parent, with an entry in it that the backup does not exclude) and this backup
|
directory at or below a configured path. That directory is on a different
|
||||||
does not, the prune does not run either: every older snapshot is kept, and the
|
filesystem from its parent and holds an entry the backup does not exclude.
|
||||||
command names the directory and exits non-zero, on every run until the volume
|
Every older snapshot is kept, and the command names the directory and exits
|
||||||
is mounted again. A backup also does not find the volume when it finds no such
|
`1`, on every run until the volume is mounted again. A backup also does not
|
||||||
entry in its directory, as when an automounted volume cannot be mounted, or
|
find the volume when it finds no such entry in its directory, as when an
|
||||||
when that directory is no longer backed up, because it is excluded or its
|
automounted volume cannot be mounted. Nor does it find the volume when that
|
||||||
configured path was removed. If any of this is on purpose, as for a retired
|
directory is no longer backed up, because it is excluded or its configured
|
||||||
volume, remove the older snapshots by hand with `snapshot purge`. A file
|
path was removed. If any of this is on purpose, as for a retired volume,
|
||||||
removed during the backup does not stop the prune.
|
remove the older snapshots by hand with `snapshot purge`. A file removed
|
||||||
|
during the backup does not stop the prune.
|
||||||
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
||||||
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
||||||
`--prune`, or with a value that is not a valid duration, the command fails
|
`--prune`, or with a value that is not a valid duration, the command fails
|
||||||
@@ -468,10 +483,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`),
|
||||||
|
|||||||
+7
-6
@@ -198,7 +198,8 @@ func RunApp(ctx context.Context, app *fx.App) error {
|
|||||||
// (or, under `snapshot verify --json`, put in its document). Entry
|
// (or, under `snapshot verify --json`, put in its document). Entry
|
||||||
// turns it into a non-zero exit status without printing anything
|
// turns it into a non-zero exit status without printing anything
|
||||||
// further, so the error line is not doubled. It flows up from
|
// further, so the error line is not doubled. It flows up from
|
||||||
// RunOperation through cobra to Entry.
|
// RunOperation through cobra to Entry, wrapping the operation's error
|
||||||
|
// so that Entry can choose the exit status from it.
|
||||||
var errReported = errors.New("operation failed")
|
var errReported = errors.New("operation failed")
|
||||||
|
|
||||||
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
||||||
@@ -232,8 +233,8 @@ func RunOperation(
|
|||||||
) error {
|
) error {
|
||||||
var (
|
var (
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
finished bool // op returned before any interrupt cancelled it
|
finished bool // op returned before any interrupt cancelled it
|
||||||
failed bool // op finished with an error
|
opErr error // what op returned, when it finished
|
||||||
)
|
)
|
||||||
|
|
||||||
opts.Invokes = append(opts.Invokes,
|
opts.Invokes = append(opts.Invokes,
|
||||||
@@ -258,7 +259,7 @@ func RunOperation(
|
|||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
finished = true
|
finished = true
|
||||||
failed = err != nil
|
opErr = err
|
||||||
mu.Unlock()
|
mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -303,8 +304,8 @@ func RunOperation(
|
|||||||
switch {
|
switch {
|
||||||
case !finished:
|
case !finished:
|
||||||
return errInterrupted
|
return errInterrupted
|
||||||
case failed:
|
case opErr != nil:
|
||||||
return errReported
|
return fmt.Errorf("%w: %w", errReported, opErr)
|
||||||
default:
|
default:
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
+16
-2
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/globals"
|
"sneak.berlin/go/vaultik/internal/globals"
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
// shortCommitLen is the number of git commit hash characters shown in
|
// shortCommitLen is the number of git commit hash characters shown in
|
||||||
@@ -20,6 +21,13 @@ const shortCommitLen = 12
|
|||||||
// shell reports for a command stopped by Ctrl-C.
|
// shell reports for a command stopped by Ctrl-C.
|
||||||
const exitCodeInterrupted = 130
|
const exitCodeInterrupted = 130
|
||||||
|
|
||||||
|
// exitCodeSkippedFiles is the exit status of a `snapshot create` or
|
||||||
|
// `snapshot restore` that finished but skipped files under
|
||||||
|
// --skip-errors. It is the status `restic backup` uses for a snapshot
|
||||||
|
// that could not read some files, so a cron job can tell such a run
|
||||||
|
// from one that made no backup.
|
||||||
|
const exitCodeSkippedFiles = 3
|
||||||
|
|
||||||
// Entry is the main entry point for the CLI application.
|
// Entry is the main entry point for the CLI application.
|
||||||
// It first calls globals.FillUnsetFromBuildInfo, which fills in the
|
// It first calls globals.FillUnsetFromBuildInfo, which fills in the
|
||||||
// version, commit and commit date that the linker flags did not set.
|
// version, commit and commit date that the linker flags did not set.
|
||||||
@@ -30,8 +38,9 @@ const exitCodeInterrupted = 130
|
|||||||
// The banner goes to stderr because stdout carries only the output the
|
// The banner goes to stderr because stdout carries only the output the
|
||||||
// user asked for, such as a completion script or a `config get` value.
|
// user asked for, such as a completion script or a `config get` value.
|
||||||
//
|
//
|
||||||
// It returns the process exit code (0 on success, 130 when interrupted,
|
// It returns the process exit code (0 on success, 3 when files were
|
||||||
// 1 on any other error) rather than calling os.Exit, so that main's
|
// skipped, 130 when interrupted, 1 on any other error) rather than
|
||||||
|
// calling os.Exit, so that main's
|
||||||
// deferred profile writers run before the process ends. See run in
|
// deferred profile writers run before the process ends. See run in
|
||||||
// cmd/vaultik/main.go.
|
// cmd/vaultik/main.go.
|
||||||
func Entry() int {
|
func Entry() int {
|
||||||
@@ -58,6 +67,11 @@ func Entry() int {
|
|||||||
return exitCodeInterrupted
|
return exitCodeInterrupted
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
||||||
|
errors.Is(err, vaultik.ErrFilesFailedRestore) {
|
||||||
|
return exitCodeSkippedFiles
|
||||||
|
}
|
||||||
|
|
||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
package cli //nolint:testpackage // shares runEntry and the hermetic config helpers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
const flagSkipErrors = "--skip-errors"
|
||||||
|
|
||||||
|
// TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips backs up,
|
||||||
|
// under --skip-errors, a source directory that does not exist, which the
|
||||||
|
// walk skips. The command exits with exitCodeSkippedFiles and reports
|
||||||
|
// the backup as completed, not as a failed snapshot creation. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/310 and
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips(t *testing.T) {
|
||||||
|
// writeBackupConfig would create the source directory.
|
||||||
|
configPath := writeHermeticPruneConfig(t, false)
|
||||||
|
|
||||||
|
code, stdout, stderr := runEntry(t,
|
||||||
|
flagConfig, configPath, flagSkipErrors, cmdSnapshot, cmdCreate)
|
||||||
|
|
||||||
|
assert.Equal(t, exitCodeSkippedFiles, code)
|
||||||
|
assert.Contains(t, stdout,
|
||||||
|
"Files: 1 examined, 0 backed up, 0 unchanged, 1 failed.")
|
||||||
|
assert.NotContains(t, stdout, "Finished successfully.")
|
||||||
|
assert.Contains(t, stderr,
|
||||||
|
"Backup completed, but 1 file(s) could not be read")
|
||||||
|
assert.NotContains(t, stderr, "Snapshot creation failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEntrySnapshotRestoreSkipErrorsExitStatus backs up, deletes the
|
||||||
|
// blobs from the destination, and restores under --skip-errors, so every
|
||||||
|
// file is skipped. A restore that only skipped files exits with
|
||||||
|
// exitCodeSkippedFiles. One that was also asked for a path the snapshot
|
||||||
|
// does not hold exits 1. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntrySnapshotRestoreSkipErrorsExitStatus(t *testing.T) {
|
||||||
|
for _, testCase := range []struct {
|
||||||
|
name string
|
||||||
|
missingPaths []string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{name: "skipped files only", want: exitCodeSkippedFiles},
|
||||||
|
{
|
||||||
|
name: "and a path that matches nothing",
|
||||||
|
missingPaths: []string{"/no/such/path"},
|
||||||
|
want: 1,
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(testCase.name, func(t *testing.T) {
|
||||||
|
configPath, storeDir := writeBackupConfigWithPrivateKey(t)
|
||||||
|
|
||||||
|
code, _, _ := runEntry(t,
|
||||||
|
flagConfig, configPath, cmdSnapshot, cmdCreate)
|
||||||
|
require.Equal(t, 0, code)
|
||||||
|
|
||||||
|
require.NoError(t, os.RemoveAll(filepath.Join(storeDir, blobsDir)))
|
||||||
|
|
||||||
|
// writeBackupConfig puts the source directory beside the
|
||||||
|
// config file.
|
||||||
|
sourceDir := filepath.Join(filepath.Dir(configPath), "source")
|
||||||
|
args := append([]string{
|
||||||
|
flagConfig, configPath, flagSkipErrors, cmdSnapshot,
|
||||||
|
cmdRestore, onlySnapshotID(t, configPath), t.TempDir(),
|
||||||
|
sourceDir,
|
||||||
|
}, testCase.missingPaths...)
|
||||||
|
|
||||||
|
code, _, stderr := runEntry(t, args...)
|
||||||
|
|
||||||
|
assert.Equal(t, testCase.want, code)
|
||||||
|
assert.Contains(t, stderr, "1 file(s) failed to restore")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares runEntry and the hermetic config helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips backs up,
|
|
||||||
// under --skip-errors, a source directory that does not exist, which the
|
|
||||||
// walk skips. The command exits non-zero and reports the backup as
|
|
||||||
// completed, not as a failed snapshot creation. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/310.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
|
||||||
func TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips(t *testing.T) {
|
|
||||||
// writeBackupConfig would create the source directory.
|
|
||||||
configPath := writeHermeticPruneConfig(t, false)
|
|
||||||
|
|
||||||
code, stdout, stderr := runEntry(t,
|
|
||||||
flagConfig, configPath, "--skip-errors", cmdSnapshot, cmdCreate)
|
|
||||||
|
|
||||||
assert.Equal(t, 1, code)
|
|
||||||
assert.Contains(t, stdout,
|
|
||||||
"Files: 1 examined, 0 backed up, 0 unchanged, 1 failed.")
|
|
||||||
assert.NotContains(t, stdout, "Finished successfully.")
|
|
||||||
assert.Contains(t, stderr,
|
|
||||||
"Backup completed, but 1 file(s) could not be read")
|
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
|
||||||
}
|
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
+23
-11
@@ -25,15 +25,20 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/types"
|
"sneak.berlin/go/vaultik/internal/types"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrFilesFailedRestore is returned when --skip-errors skipped files the
|
||||||
|
// restore could not write. Every other file was restored, so the caller
|
||||||
|
// can report it apart from a failed restore.
|
||||||
|
var ErrFilesFailedRestore = errors.New("file(s) failed to restore")
|
||||||
|
|
||||||
// Sentinel errors for restore failures.
|
// Sentinel errors for restore failures.
|
||||||
var (
|
var (
|
||||||
errFilesFailedRestore = errors.New("file(s) failed to restore")
|
|
||||||
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
||||||
errFilesFailedVerify = errors.New("files failed verification")
|
errFilesFailedVerify = errors.New("files failed verification")
|
||||||
errDecryptionKeyRequired = errors.New(
|
errDecryptionKeyRequired = errors.New(
|
||||||
"age secret key is missing; set it in the " +
|
"decryption key required\n\n" +
|
||||||
"VAULTIK_AGE_SECRET_KEY environment variable or the " +
|
"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
|
||||||
"age_secret_key config file field")
|
"age private key file:\n" +
|
||||||
|
" export VAULTIK_AGE_SECRET_KEY=\"$(cat vaultik_backup_private_key.txt)\"")
|
||||||
// errInvalidAgeSecretKey is returned when the configured key does not
|
// errInvalidAgeSecretKey is returned when the configured key does not
|
||||||
// parse as any age identity. It names the source but never the value,
|
// parse as any age identity. It names the source but never the value,
|
||||||
// which is secret, so the message is safe to print and log.
|
// which is secret, so the message is safe to print and log.
|
||||||
@@ -200,9 +205,9 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// finishRestore prints the restore summary and the post-restore
|
// finishRestore prints the restore summary and the post-restore
|
||||||
// warnings, runs optional verification, and converts any failed-file
|
// warnings, runs optional verification, and returns the error the
|
||||||
// count into an error. Otherwise it returns unmatchedErr, the error for
|
// restore ends with: one for the files --skip-errors skipped, one for
|
||||||
// the requested paths that matched nothing (nil when there are none).
|
// unmatchedErr, the requested paths that matched nothing, or nil.
|
||||||
func (v *Vaultik) finishRestore(
|
func (v *Vaultik) finishRestore(
|
||||||
repos *database.Repositories,
|
repos *database.Repositories,
|
||||||
files []*database.File,
|
files []*database.File,
|
||||||
@@ -249,11 +254,18 @@ func (v *Vaultik) finishRestore(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if result.FilesFailed > 0 {
|
switch {
|
||||||
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
case result.FilesFailed > 0 && unmatchedErr != nil:
|
||||||
|
// A requested path that matched nothing outweighs skipped files:
|
||||||
|
// the error wraps only unmatchedErr, so the command does not exit
|
||||||
|
// as a restore that only skipped files.
|
||||||
|
return fmt.Errorf("%w; %d %s",
|
||||||
|
unmatchedErr, result.FilesFailed, ErrFilesFailedRestore.Error())
|
||||||
|
case result.FilesFailed > 0:
|
||||||
|
return fmt.Errorf("%d %w", result.FilesFailed, ErrFilesFailedRestore)
|
||||||
|
default:
|
||||||
|
return unmatchedErr
|
||||||
}
|
}
|
||||||
|
|
||||||
return unmatchedErr
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
||||||
|
|||||||
@@ -106,23 +106,3 @@ func TestRestoreIdentitiesMissingKey(t *testing.T) {
|
|||||||
_, err := v.restoreIdentities()
|
_, err := v.restoreIdentities()
|
||||||
require.ErrorIs(t, err, errDecryptionKeyRequired)
|
require.ErrorIs(t, err, errDecryptionKeyRequired)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestMissingKeyErrorsNameBothSources asserts restore and deep verify
|
|
||||||
// return the same missing-key error, whose text names both places the key
|
|
||||||
// can be set: the VAULTIK_AGE_SECRET_KEY environment variable first since
|
|
||||||
// it is preferred, then the age_secret_key config file field.
|
|
||||||
func TestMissingKeyErrorsNameBothSources(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const want = "age secret key is missing; set it in " +
|
|
||||||
"the VAULTIK_AGE_SECRET_KEY environment variable or the " +
|
|
||||||
"age_secret_key config file field"
|
|
||||||
|
|
||||||
v := &Vaultik{Config: &config.Config{}}
|
|
||||||
|
|
||||||
_, err := v.restoreIdentities()
|
|
||||||
require.EqualError(t, err, want)
|
|
||||||
|
|
||||||
err = v.RunDeepVerify("any-snapshot", &VerifyOptions{})
|
|
||||||
require.EqualError(t, err, want)
|
|
||||||
}
|
|
||||||
@@ -80,7 +80,7 @@ func TestRestoreFreesBlobsNoPendingFileNeeds(t *testing.T) {
|
|||||||
TargetDir: restoreDir,
|
TargetDir: restoreDir,
|
||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, errFilesFailedRestore)
|
require.ErrorIs(t, err, ErrFilesFailedRestore)
|
||||||
|
|
||||||
requireRestoredFiles(t, fs, restoreDir, originals)
|
requireRestoredFiles(t, fs, restoreDir, originals)
|
||||||
assert.LessOrEqualf(t, peak, 1,
|
assert.LessOrEqualf(t, peak, 1,
|
||||||
|
|||||||
@@ -49,8 +49,7 @@ var ErrFilesUnreadable = errors.New("file(s) could not be read")
|
|||||||
// prune because the scan found nothing in a configured path of a
|
// prune because the scan found nothing in a configured path of a
|
||||||
// snapshot, as in the mount point of a volume that is not mounted. The
|
// snapshot, as in the mount point of a volume that is not mounted. The
|
||||||
// snapshots are complete and kept, so the caller can report it apart
|
// snapshots are complete and kept, so the caller can report it apart
|
||||||
// from a failed backup. A run that also skipped unreadable files
|
// from a failed backup.
|
||||||
// returns ErrFilesUnreadable instead.
|
|
||||||
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
||||||
|
|
||||||
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
||||||
@@ -59,8 +58,8 @@ var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
|||||||
// mounted there is not mounted, the run found no entry in it, or the
|
// mounted there is not mounted, the run found no entry in it, or the
|
||||||
// directory is no longer backed up. The snapshots are complete and
|
// directory is no longer backed up. The snapshots are complete and
|
||||||
// kept, so the caller can report it apart from a failed backup. A run
|
// kept, so the caller can report it apart from a failed backup. A run
|
||||||
// that also skipped unreadable files or found a configured path empty
|
// that also found a configured path empty returns ErrSourcePathEmpty
|
||||||
// returns ErrFilesUnreadable or ErrSourcePathEmpty instead.
|
// instead.
|
||||||
var ErrVolumeNotMounted = errors.New(
|
var ErrVolumeNotMounted = errors.New(
|
||||||
"mount point(s) an earlier snapshot recorded were not found")
|
"mount point(s) an earlier snapshot recorded were not found")
|
||||||
|
|
||||||
@@ -243,15 +242,29 @@ func (v *Vaultik) skipPostBackupPrune(
|
|||||||
if filesUnreadable > 0 {
|
if filesUnreadable > 0 {
|
||||||
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
||||||
"could not be read; older snapshots are kept.", filesUnreadable)
|
"could not be read; older snapshots are kept.", filesUnreadable)
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case len(emptyPaths) > 0:
|
||||||
|
err = fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
||||||
|
case len(unmountedPaths) > 0:
|
||||||
|
err = fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
||||||
|
default:
|
||||||
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(emptyPaths) > 0 {
|
// An empty path or a missing volume can mean a whole volume is not
|
||||||
return fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
// in the backup, which outweighs skipped files: the error wraps only
|
||||||
|
// the former, so the command does not exit as a backup that only
|
||||||
|
// skipped files.
|
||||||
|
if filesUnreadable > 0 {
|
||||||
|
return fmt.Errorf("%w; %d %s",
|
||||||
|
err, filesUnreadable, ErrFilesUnreadable.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
return fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
||||||
@@ -1467,7 +1480,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 +1512,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 +1544,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 +1687,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 +1700,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 +1714,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 {
|
||||||
|
|||||||
@@ -176,8 +176,11 @@ func TestBackupThroughSymlinkWhoseTargetIsGoneDoesNotPrune(t *testing.T) {
|
|||||||
|
|
||||||
// A backup under --skip-errors --prune that both skipped a file it could
|
// A backup under --skip-errors --prune that both skipped a file it could
|
||||||
// not read and found nothing in a configured path names the empty path
|
// not read and found nothing in a configured path names the empty path
|
||||||
// too when it skips the prune. See
|
// too when it skips the prune. It ends with the empty path's error, which
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
// names the unreadable file too but does not wrap ErrFilesUnreadable, so
|
||||||
|
// the command does not exit as a backup that only skipped files. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/388 and
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
@@ -207,7 +210,10 @@ func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
|||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
Snapshots: []string{snapshotName},
|
Snapshots: []string{snapshotName},
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
require.ErrorIs(t, err, vaultik.ErrSourcePathEmpty)
|
||||||
|
require.NotErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
||||||
|
require.EqualError(t, err,
|
||||||
|
"1 source path(s) were empty; 1 file(s) could not be read")
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
"Skipped the post-backup prune because 1 file(s) could not be read")
|
"Skipped the post-backup prune because 1 file(s) could not be read")
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
|
|||||||
@@ -163,6 +163,11 @@ func (v *Vaultik) StartOperation(fn func()) func(context.Context) bool {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// CanDecrypt returns true if this Vaultik instance has decryption capabilities
|
||||||
|
func (v *Vaultik) CanDecrypt() bool {
|
||||||
|
return v.Config.AgeSecretKey != ""
|
||||||
|
}
|
||||||
|
|
||||||
// GetFilesystem returns the filesystem instance used by Vaultik
|
// GetFilesystem returns the filesystem instance used by Vaultik
|
||||||
//
|
//
|
||||||
//nolint:ireturn // afero.Fs is the filesystem abstraction by design
|
//nolint:ireturn // afero.Fs is the filesystem abstraction by design
|
||||||
|
|||||||
@@ -22,7 +22,9 @@ import (
|
|||||||
|
|
||||||
// Sentinel errors for snapshot verification failures.
|
// Sentinel errors for snapshot verification failures.
|
||||||
var (
|
var (
|
||||||
errVerificationFailed = errors.New("verification failed")
|
errVerificationFailed = errors.New("verification failed")
|
||||||
|
errSecretKeyRequired = errors.New(
|
||||||
|
"VAULTIK_AGE_SECRET_KEY not set; required for deep verification")
|
||||||
errChunksOutOfOrder = errors.New("chunks out of order")
|
errChunksOutOfOrder = errors.New("chunks out of order")
|
||||||
errChunkHashMismatch = errors.New("chunk hash mismatch")
|
errChunkHashMismatch = errors.New("chunk hash mismatch")
|
||||||
errNegativeChunkLength = errors.New("chunk length is negative")
|
errNegativeChunkLength = errors.New("chunk length is negative")
|
||||||
@@ -104,9 +106,13 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
|
|||||||
Mode: "deep",
|
Mode: "deep",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if !v.CanDecrypt() {
|
||||||
|
return v.deepVerifyFailure(result, opts,
|
||||||
|
errSecretKeyRequired.Error(), errSecretKeyRequired)
|
||||||
|
}
|
||||||
|
|
||||||
// Parse the age secret key once, the same way restore does, and reuse
|
// Parse the age secret key once, the same way restore does, and reuse
|
||||||
// the identities for the database and every blob. A missing key fails
|
// the identities for the database and every blob.
|
||||||
// here, before anything is downloaded.
|
|
||||||
identities, err := v.restoreIdentities()
|
identities, err := v.restoreIdentities()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return v.deepVerifyFailure(result, opts, err.Error(), err)
|
return v.deepVerifyFailure(result, opts, err.Error(), err)
|
||||||
|
|||||||
Reference in new issue
Block a user