Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d586ed4f9 |
No files matched your search
@@ -196,10 +196,9 @@ 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 `3` (see [exit status](#exit-status)): `snapshot create`
|
finishes but exits non-zero: `snapshot create` keeps the snapshot and counts
|
||||||
keeps the snapshot and counts each file or directory it skipped as failed. A
|
each file or directory it skipped as failed. A file removed during the backup
|
||||||
file removed during the backup is also counted as failed but does not change
|
is also counted as failed but does not change the exit status.
|
||||||
the exit status.
|
|
||||||
|
|
||||||
### locking
|
### locking
|
||||||
|
|
||||||
@@ -272,19 +271,6 @@ 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
|
||||||
@@ -361,25 +347,24 @@ 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. One of them may be the only one that holds
|
and every older snapshot is kept, since one of them may be the only one that
|
||||||
what was skipped. The command says so and exits `3`. The prune does not run
|
holds what was skipped; the command says so and exits non-zero. When the
|
||||||
either when the backup found nothing in a configured path, as in the mount
|
backup found nothing in a configured path, as in the mount point of a volume
|
||||||
point of a volume that is not mounted. Every older snapshot is kept, and the
|
that is not mounted, the prune does not run either: every older snapshot is
|
||||||
command names the path and exits `1`, on every run until the path holds
|
kept, and the command names the path and exits non-zero, on every run until
|
||||||
something again. Take a path that is empty on purpose out of the config, or
|
the path holds something again. Take a path that is empty on purpose out of
|
||||||
remove the older snapshots by hand with `snapshot purge`. The prune does not
|
the config, or remove the older snapshots by hand with `snapshot purge`. When
|
||||||
run either when this backup does not find a volume that an earlier snapshot of
|
an earlier snapshot of the same name in the local index found a volume mounted
|
||||||
the same name in the local index found. The volume's mount point is a
|
at or below a configured path (a directory on a different filesystem from its
|
||||||
directory at or below a configured path. That directory is on a different
|
parent, with an entry in it that the backup does not exclude) and this backup
|
||||||
filesystem from its parent and holds an entry the backup does not exclude.
|
does not, the prune does not run either: every older snapshot is kept, and the
|
||||||
Every older snapshot is kept, and the command names the directory and exits
|
command names the directory and exits non-zero, on every run until the volume
|
||||||
`1`, on every run until the volume is mounted again. A backup also does not
|
is mounted again. A backup also does not find the volume when it finds no such
|
||||||
find the volume when it finds no such entry in its directory, as when an
|
entry in its directory, as when an automounted volume cannot be mounted, or
|
||||||
automounted volume cannot be mounted. Nor does it find the volume when that
|
when that directory is no longer backed up, because it is excluded or its
|
||||||
directory is no longer backed up, because it is excluded or its configured
|
configured path was removed. If any of this is on purpose, as for a retired
|
||||||
path was removed. If any of this is on purpose, as for a retired volume,
|
volume, remove the older snapshots by hand with `snapshot purge`. A file
|
||||||
remove the older snapshots by hand with `snapshot purge`. A file removed
|
removed during the backup does not stop the prune.
|
||||||
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
|
||||||
|
|||||||
+6
-7
@@ -198,8 +198,7 @@ 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, wrapping the operation's error
|
// RunOperation through cobra to Entry.
|
||||||
// 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
|
||||||
@@ -233,8 +232,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
|
||||||
opErr error // what op returned, when it finished
|
failed bool // op finished with an error
|
||||||
)
|
)
|
||||||
|
|
||||||
opts.Invokes = append(opts.Invokes,
|
opts.Invokes = append(opts.Invokes,
|
||||||
@@ -259,7 +258,7 @@ func RunOperation(
|
|||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
finished = true
|
finished = true
|
||||||
opErr = err
|
failed = err != nil
|
||||||
mu.Unlock()
|
mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -304,8 +303,8 @@ func RunOperation(
|
|||||||
switch {
|
switch {
|
||||||
case !finished:
|
case !finished:
|
||||||
return errInterrupted
|
return errInterrupted
|
||||||
case opErr != nil:
|
case failed:
|
||||||
return fmt.Errorf("%w: %w", errReported, opErr)
|
return errReported
|
||||||
default:
|
default:
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-16
@@ -9,7 +9,6 @@ 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
|
||||||
@@ -21,13 +20,6 @@ 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.
|
||||||
@@ -38,9 +30,8 @@ const exitCodeSkippedFiles = 3
|
|||||||
// 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, 3 when files were
|
// It returns the process exit code (0 on success, 130 when interrupted,
|
||||||
// skipped, 130 when interrupted, 1 on any other error) rather than
|
// 1 on any other error) rather than calling os.Exit, so that main's
|
||||||
// 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 {
|
||||||
@@ -67,11 +58,6 @@ func Entry() int {
|
|||||||
return exitCodeInterrupted
|
return exitCodeInterrupted
|
||||||
}
|
}
|
||||||
|
|
||||||
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
|
||||||
errors.Is(err, vaultik.ErrFilesFailedRestore) {
|
|
||||||
return exitCodeSkippedFiles
|
|
||||||
}
|
|
||||||
|
|
||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,83 +0,0 @@
|
|||||||
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")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
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")
|
||||||
|
}
|
||||||
@@ -4,8 +4,10 @@ package snapshot
|
|||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@@ -38,3 +40,36 @@ func TestDeviceNumberFromStat(t *testing.T) {
|
|||||||
// /dev is a different filesystem from the temp dir on Linux, macOS and in Docker.
|
// /dev is a different filesystem from the temp dir on Linux, macOS and in Docker.
|
||||||
assert.NotEqual(t, deviceOf(dir), deviceOf("/dev"))
|
assert.NotEqual(t, deviceOf(dir), deviceOf("/dev"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// fileInfoWithStat is a file's info whose Sys returns stat.
|
||||||
|
type fileInfoWithStat struct {
|
||||||
|
os.FileInfo
|
||||||
|
|
||||||
|
stat *syscall.Stat_t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i fileInfoWithStat) Sys() any { return i.stat }
|
||||||
|
|
||||||
|
// The in-memory test filesystem has no device numbers. The pinned afero
|
||||||
|
// gives no stat; its unreleased master gives a stat holding only uid, gid
|
||||||
|
// and size. See https://git.eeqj.de/sneak/vaultik/issues/462.
|
||||||
|
func TestDeviceNumberFromStatInMemory(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
require.NoError(t, afero.WriteFile(fs, "/file.txt", []byte("data"), 0o600))
|
||||||
|
|
||||||
|
info, err := fs.Stat("/file.txt")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, ok := deviceNumberFromStat(info)
|
||||||
|
assert.False(t, ok, "device number read from a file info with no stat")
|
||||||
|
|
||||||
|
zeroed := fileInfoWithStat{
|
||||||
|
FileInfo: info,
|
||||||
|
stat: &syscall.Stat_t{Uid: 1000, Gid: 1000, Size: 4},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, ok = deviceNumberFromStat(zeroed)
|
||||||
|
assert.False(t, ok, "device number read from a stat with no device or inode number")
|
||||||
|
}
|
||||||
@@ -1438,11 +1438,12 @@ func (s *Scanner) deviceNumberAt(path string) (uint64, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// deviceNumberFromStat returns the number of the device that holds the
|
// deviceNumberFromStat returns the number of the device that holds the
|
||||||
// file info describes, and false when info carries no stat, as from the
|
// file info describes, and false when info carries no stat from a real
|
||||||
// in-memory test filesystem.
|
// filesystem. The in-memory test filesystem gives either no stat or one
|
||||||
|
// whose device and inode numbers are both zero, which no real file has.
|
||||||
func deviceNumberFromStat(info os.FileInfo) (uint64, bool) {
|
func deviceNumberFromStat(info os.FileInfo) (uint64, bool) {
|
||||||
stat, ok := info.Sys().(*syscall.Stat_t)
|
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||||
if !ok {
|
if !ok || (stat.Dev == 0 && stat.Ino == 0) {
|
||||||
return 0, false
|
return 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -25,13 +25,9 @@ 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(
|
||||||
@@ -205,9 +201,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 returns the error the
|
// warnings, runs optional verification, and converts any failed-file
|
||||||
// restore ends with: one for the files --skip-errors skipped, one for
|
// count into an error. Otherwise it returns unmatchedErr, the error for
|
||||||
// unmatchedErr, the requested paths that matched nothing, or nil.
|
// the requested paths that matched nothing (nil when there are none).
|
||||||
func (v *Vaultik) finishRestore(
|
func (v *Vaultik) finishRestore(
|
||||||
repos *database.Repositories,
|
repos *database.Repositories,
|
||||||
files []*database.File,
|
files []*database.File,
|
||||||
@@ -254,18 +250,11 @@ func (v *Vaultik) finishRestore(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
switch {
|
if result.FilesFailed > 0 {
|
||||||
case result.FilesFailed > 0 && unmatchedErr != nil:
|
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
||||||
// 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
|
||||||
|
|||||||
@@ -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,7 +49,8 @@ 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.
|
// from a failed backup. A run that also skipped unreadable files
|
||||||
|
// 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
|
||||||
@@ -58,8 +59,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 found a configured path empty returns ErrSourcePathEmpty
|
// that also skipped unreadable files or found a configured path empty
|
||||||
// instead.
|
// returns ErrFilesUnreadable or ErrSourcePathEmpty 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")
|
||||||
|
|
||||||
@@ -242,29 +243,15 @@ 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)
|
||||||
}
|
}
|
||||||
|
|
||||||
// An empty path or a missing volume can mean a whole volume is not
|
if len(emptyPaths) > 0 {
|
||||||
// in the backup, which outweighs skipped files: the error wraps only
|
return fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
||||||
// 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 err
|
return fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
||||||
}
|
}
|
||||||
|
|
||||||
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
||||||
|
|||||||
@@ -176,11 +176,8 @@ 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. It ends with the empty path's error, which
|
// too when it skips the prune. See
|
||||||
// names the unreadable file too but does not wrap ErrFilesUnreadable, so
|
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
||||||
// 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()
|
||||||
@@ -210,10 +207,7 @@ func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
|||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
Snapshots: []string{snapshotName},
|
Snapshots: []string{snapshotName},
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, vaultik.ErrSourcePathEmpty)
|
require.ErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
||||||
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(),
|
||||||
|
|||||||
Reference in new issue
Block a user