Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fe25eff9ae |
No files matched your search
@@ -196,10 +196,9 @@ vaultik version
|
||||
that cannot be restored when restoring, instead of aborting. Packing and
|
||||
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
|
||||
finishes but exits `3` (see [exit status](#exit-status)): `snapshot create`
|
||||
keeps the snapshot and counts each file or directory it skipped as failed. A
|
||||
file removed during the backup is also counted as failed but does not change
|
||||
the exit status.
|
||||
finishes but exits non-zero: `snapshot create` keeps the snapshot and counts
|
||||
each file or directory it skipped as failed. A file removed during the backup
|
||||
is also counted as failed but does not change the exit status.
|
||||
|
||||
### 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
|
||||
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
|
||||
|
||||
- `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
|
||||
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
|
||||
and every older snapshot is kept. One of them may be the only one that holds
|
||||
what was skipped. The command says so and exits `3`. The prune does not run
|
||||
either when the backup found nothing in a configured path, as in the mount
|
||||
point of a volume that is not mounted. Every older snapshot is kept, and the
|
||||
command names the path and exits `1`, on every run until the path holds
|
||||
something again. Take a path that is empty on purpose out of the config, or
|
||||
remove the older snapshots by hand with `snapshot purge`. The prune does not
|
||||
run either when this backup does not find a volume that an earlier snapshot of
|
||||
the same name in the local index found. The volume's mount point is a
|
||||
directory at or below a configured path. That directory is on a different
|
||||
filesystem from its parent and holds an entry the backup does not exclude.
|
||||
Every older snapshot is kept, and the command names the directory and exits
|
||||
`1`, on every run until the volume is mounted again. A backup also does not
|
||||
find the volume when it finds no such entry in its directory, as when an
|
||||
automounted volume cannot be mounted. Nor does it find the volume when that
|
||||
directory is no longer backed up, because it is excluded or its configured
|
||||
path was removed. If any of this is on purpose, as for a retired volume,
|
||||
remove the older snapshots by hand with `snapshot purge`. A file removed
|
||||
during the backup does not stop the prune.
|
||||
and every older snapshot is kept, since one of them may be the only one that
|
||||
holds what was skipped; the command says so and exits non-zero. When the
|
||||
backup found nothing in a configured path, as in the mount point of a volume
|
||||
that is not mounted, the prune does not run either: every older snapshot is
|
||||
kept, and the command names the path and exits non-zero, on every run until
|
||||
the path holds something again. Take a path that is empty on purpose out of
|
||||
the config, or remove the older snapshots by hand with `snapshot purge`. When
|
||||
an earlier snapshot of the same name in the local index found a volume mounted
|
||||
at or below a configured path (a directory on a different filesystem from its
|
||||
parent, with an entry in it that the backup does not exclude) and this backup
|
||||
does not, the prune does not run either: every older snapshot is kept, and the
|
||||
command names the directory and exits non-zero, on every run until the volume
|
||||
is mounted again. A backup also does not find the volume when it finds no such
|
||||
entry in its directory, as when an automounted volume cannot be mounted, or
|
||||
when that directory is no longer backed up, because it is excluded or its
|
||||
configured path was removed. If any of this is on purpose, as for a retired
|
||||
volume, 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
|
||||
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
|
||||
@@ -617,7 +602,11 @@ only `vaultik-destination.txt` stops such a backup, and only while the local
|
||||
index holds snapshots.
|
||||
|
||||
**Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud
|
||||
providers. Requires rclone to be configured separately (`rclone config`).
|
||||
providers. Requires rclone to be configured separately (`rclone config`). The
|
||||
path after the remote name is relative: rclone resolves it on the remote, for
|
||||
example against the login directory on sftp. A second slash makes it absolute,
|
||||
as in `rclone://remote//srv/backup`. A remote of type `local` needs an absolute
|
||||
path; a relative one is refused.
|
||||
|
||||
An upload cut off part-way leaves nothing under the object's name on S3, which
|
||||
shows an object only once its upload has completed, and on the local filesystem
|
||||
|
||||
+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
|
||||
// turns it into a non-zero exit status without printing anything
|
||||
// further, so the error line is not doubled. It flows up from
|
||||
// RunOperation through cobra to Entry, wrapping the operation's error
|
||||
// so that Entry can choose the exit status from it.
|
||||
// RunOperation through cobra to Entry.
|
||||
var errReported = errors.New("operation failed")
|
||||
|
||||
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
||||
@@ -233,8 +232,8 @@ func RunOperation(
|
||||
) error {
|
||||
var (
|
||||
mu sync.Mutex
|
||||
finished bool // op returned before any interrupt cancelled it
|
||||
opErr error // what op returned, when it finished
|
||||
finished bool // op returned before any interrupt cancelled it
|
||||
failed bool // op finished with an error
|
||||
)
|
||||
|
||||
opts.Invokes = append(opts.Invokes,
|
||||
@@ -259,7 +258,7 @@ func RunOperation(
|
||||
|
||||
mu.Lock()
|
||||
finished = true
|
||||
opErr = err
|
||||
failed = err != nil
|
||||
mu.Unlock()
|
||||
}
|
||||
|
||||
@@ -304,8 +303,8 @@ func RunOperation(
|
||||
switch {
|
||||
case !finished:
|
||||
return errInterrupted
|
||||
case opErr != nil:
|
||||
return fmt.Errorf("%w: %w", errReported, opErr)
|
||||
case failed:
|
||||
return errReported
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
|
||||
+2
-16
@@ -9,7 +9,6 @@ import (
|
||||
|
||||
"sneak.berlin/go/vaultik/internal/globals"
|
||||
"sneak.berlin/go/vaultik/internal/ui"
|
||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||
)
|
||||
|
||||
// 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.
|
||||
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.
|
||||
// It first calls globals.FillUnsetFromBuildInfo, which fills in the
|
||||
// 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
|
||||
// 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
|
||||
// skipped, 130 when interrupted, 1 on any other error) rather than
|
||||
// calling os.Exit, so that main's
|
||||
// It returns the process exit code (0 on success, 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
|
||||
// cmd/vaultik/main.go.
|
||||
func Entry() int {
|
||||
@@ -67,11 +58,6 @@ func Entry() int {
|
||||
return exitCodeInterrupted
|
||||
}
|
||||
|
||||
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
||||
errors.Is(err, vaultik.ErrFilesFailedRestore) {
|
||||
return exitCodeSkippedFiles
|
||||
}
|
||||
|
||||
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")
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
@@ -23,6 +24,15 @@ import (
|
||||
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
||||
var ErrRemoteNotFound = errors.New("rclone remote not found in config")
|
||||
|
||||
// ErrRcloneRelativeLocalPath is returned when the path on an rclone remote
|
||||
// of type local is relative. rclone would resolve it against the working
|
||||
// directory, so the destination would move with it.
|
||||
var ErrRcloneRelativeLocalPath = errors.New(
|
||||
"the path on an rclone remote of type local must be absolute")
|
||||
|
||||
// rcloneLocalBackend is the type of rclone's local disk backend.
|
||||
const rcloneLocalBackend = "local"
|
||||
|
||||
// RcloneStorer implements Storer using rclone's filesystem abstraction.
|
||||
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
||||
type RcloneStorer struct {
|
||||
@@ -53,6 +63,19 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
||||
rclonePath += path
|
||||
}
|
||||
|
||||
// A remote rclone cannot find is reported by fs.NewFs below. Only the
|
||||
// backend of what fs.ParseRemote returns is needed here.
|
||||
backend, _, _, _, err := fs.ParseRemote(rclonePath) //nolint:dogsled
|
||||
if err == nil && backend.Name == rcloneLocalBackend && !filepath.IsAbs(path) {
|
||||
example := path
|
||||
if example == "" {
|
||||
example = "path/to/backup"
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("%w: use rclone://%s//%s",
|
||||
ErrRcloneRelativeLocalPath, remote, example)
|
||||
}
|
||||
|
||||
// On S3, Swift and some other remotes rclone keeps a time of its own in
|
||||
// each object's metadata, which costs one request per object to read.
|
||||
// rclone's use_server_modtime setting makes ModTime the time the
|
||||
|
||||
@@ -436,6 +436,79 @@ func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// useRcloneConfig points rclone at a config file holding contents for the
|
||||
// rest of the test.
|
||||
func useRcloneConfig(t *testing.T, contents string) {
|
||||
t.Helper()
|
||||
|
||||
previous := config.GetConfigPath()
|
||||
|
||||
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
||||
|
||||
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
||||
|
||||
err := os.WriteFile(confFile, []byte(contents), 0o600)
|
||||
if err != nil {
|
||||
t.Fatalf("writing rclone config: %v", err)
|
||||
}
|
||||
|
||||
t.Setenv("RCLONE_CONFIG", confFile)
|
||||
}
|
||||
|
||||
// TestNewRcloneStorerRefusesRelativeLocalPath checks that a relative path
|
||||
// on a remote of type local is refused, with the absolute form in the
|
||||
// error, and that nothing is created under the working directory. rclone
|
||||
// would otherwise resolve the path against the working directory.
|
||||
//
|
||||
//nolint:paralleltest // changes the working directory and the rclone config
|
||||
func TestNewRcloneStorerRefusesRelativeLocalPath(t *testing.T) {
|
||||
useRcloneConfig(t, "[localfs]\ntype = local\n")
|
||||
|
||||
workdir := t.TempDir()
|
||||
t.Chdir(workdir)
|
||||
|
||||
for path, wantInError := range map[string]string{
|
||||
"srv/backup": "rclone://localfs//srv/backup",
|
||||
"": "rclone://localfs//path/to/backup",
|
||||
} {
|
||||
_, err := storage.NewRcloneStorer(context.Background(), "localfs", path)
|
||||
if !errors.Is(err, storage.ErrRcloneRelativeLocalPath) {
|
||||
t.Errorf("path %q: error = %v, want ErrRcloneRelativeLocalPath",
|
||||
path, err)
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
if !strings.Contains(err.Error(), wantInError) {
|
||||
t.Errorf("path %q: error %q does not show %q",
|
||||
path, err, wantInError)
|
||||
}
|
||||
}
|
||||
|
||||
entries, err := os.ReadDir(workdir)
|
||||
if err != nil {
|
||||
t.Fatalf("reading working directory: %v", err)
|
||||
}
|
||||
|
||||
if len(entries) != 0 {
|
||||
t.Errorf("working directory holds %d entries, want none", len(entries))
|
||||
}
|
||||
}
|
||||
|
||||
// TestNewRcloneStorerKeepsRelativePathOnOtherRemotes checks that a relative
|
||||
// path is accepted on a remote not of type local, where rclone resolves it
|
||||
// on the remote itself, as sftp does against the login directory.
|
||||
//
|
||||
//nolint:paralleltest // changes the process-global rclone config
|
||||
func TestNewRcloneStorerKeepsRelativePathOnOtherRemotes(t *testing.T) {
|
||||
useRcloneConfig(t, "[mem]\ntype = memory\n")
|
||||
|
||||
_, err := storage.NewRcloneStorer(context.Background(), "mem", "backups")
|
||||
if err != nil {
|
||||
t.Errorf("NewRcloneStorer: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRcloneListStreamOnS3MakesNoRequestPerObject checks that listing an
|
||||
// rclone S3 remote takes each object's time from the listing itself. By
|
||||
// default rclone reads the time it keeps in each object's metadata, one
|
||||
|
||||
@@ -25,13 +25,9 @@ import (
|
||||
"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.
|
||||
var (
|
||||
errFilesFailedRestore = errors.New("file(s) failed to restore")
|
||||
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
||||
errFilesFailedVerify = errors.New("files failed verification")
|
||||
errDecryptionKeyRequired = errors.New(
|
||||
@@ -205,9 +201,9 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
||||
}
|
||||
|
||||
// finishRestore prints the restore summary and the post-restore
|
||||
// warnings, runs optional verification, and returns the error the
|
||||
// restore ends with: one for the files --skip-errors skipped, one for
|
||||
// unmatchedErr, the requested paths that matched nothing, or nil.
|
||||
// warnings, runs optional verification, and converts any failed-file
|
||||
// count into an error. Otherwise it returns unmatchedErr, the error for
|
||||
// the requested paths that matched nothing (nil when there are none).
|
||||
func (v *Vaultik) finishRestore(
|
||||
repos *database.Repositories,
|
||||
files []*database.File,
|
||||
@@ -254,18 +250,11 @@ func (v *Vaultik) finishRestore(
|
||||
}
|
||||
}
|
||||
|
||||
switch {
|
||||
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
|
||||
if result.FilesFailed > 0 {
|
||||
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
||||
}
|
||||
|
||||
return unmatchedErr
|
||||
}
|
||||
|
||||
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
||||
|
||||
@@ -80,7 +80,7 @@ func TestRestoreFreesBlobsNoPendingFileNeeds(t *testing.T) {
|
||||
TargetDir: restoreDir,
|
||||
SkipErrors: true,
|
||||
})
|
||||
require.ErrorIs(t, err, ErrFilesFailedRestore)
|
||||
require.ErrorIs(t, err, errFilesFailedRestore)
|
||||
|
||||
requireRestoredFiles(t, fs, restoreDir, originals)
|
||||
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
|
||||
// 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
|
||||
// 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")
|
||||
|
||||
// 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
|
||||
// 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
|
||||
// that also found a configured path empty returns ErrSourcePathEmpty
|
||||
// instead.
|
||||
// that also skipped unreadable files or found a configured path empty
|
||||
// returns ErrFilesUnreadable or ErrSourcePathEmpty instead.
|
||||
var ErrVolumeNotMounted = errors.New(
|
||||
"mount point(s) an earlier snapshot recorded were not found")
|
||||
|
||||
@@ -242,29 +243,15 @@ func (v *Vaultik) skipPostBackupPrune(
|
||||
if filesUnreadable > 0 {
|
||||
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
||||
"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)
|
||||
}
|
||||
|
||||
// An empty path or a missing volume can mean a whole volume is not
|
||||
// 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())
|
||||
if len(emptyPaths) > 0 {
|
||||
return fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
||||
}
|
||||
|
||||
return err
|
||||
return fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
||||
}
|
||||
|
||||
// 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
|
||||
// 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
|
||||
// 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.
|
||||
// too when it skips the prune. See
|
||||
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
||||
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
||||
log.Initialize(log.Config{})
|
||||
t.Parallel()
|
||||
@@ -210,10 +207,7 @@ func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
||||
SkipErrors: true,
|
||||
Snapshots: []string{snapshotName},
|
||||
})
|
||||
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")
|
||||
require.ErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
||||
assert.Contains(t, env.out.String(),
|
||||
"Skipped the post-backup prune because 1 file(s) could not be read")
|
||||
assert.Contains(t, env.out.String(),
|
||||
|
||||
Reference in new issue
Block a user