Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2aa6fc8f66 | ||
|
|
9fedcbeb0a |
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
|
||||||
@@ -569,6 +554,12 @@ count and blob size unknown, `null` in `--json`. A file under `blobs/` whose
|
|||||||
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
||||||
it.
|
it.
|
||||||
|
|
||||||
|
A blob that a manifest lists but the destination does not hold is reported as
|
||||||
|
missing, with a count and size. The report names each snapshot that lists a
|
||||||
|
missing blob, since that snapshot cannot be restored. The command then exits
|
||||||
|
non-zero. `--json` gives these in `missing_blob_count`, `missing_blob_size` and
|
||||||
|
`snapshots_missing_blobs`.
|
||||||
|
|
||||||
- `--json`: Output as JSON
|
- `--json`: Output as JSON
|
||||||
|
|
||||||
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
||||||
@@ -617,7 +608,11 @@ only `vaultik-destination.txt` stops such a backup, and only while the local
|
|||||||
index holds snapshots.
|
index holds snapshots.
|
||||||
|
|
||||||
**Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud
|
**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
|
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
|
shows an object only once its upload has completed, and on the local filesystem
|
||||||
|
|||||||
+5
-6
@@ -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
|
||||||
@@ -234,7 +233,7 @@ func RunOperation(
|
|||||||
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")
|
||||||
|
}
|
||||||
@@ -75,7 +75,9 @@ func newRemoteInfoCommand() *cobra.Command {
|
|||||||
- Size of all snapshot metadata (per snapshot and total)
|
- Size of all snapshot metadata (per snapshot and total)
|
||||||
- Count and total size of all blobs
|
- Count and total size of all blobs
|
||||||
- Count and size of referenced blobs (from all manifests)
|
- Count and size of referenced blobs (from all manifests)
|
||||||
- Count and size of orphaned blobs (not referenced by any manifest)`,
|
- Count and size of orphaned blobs (not referenced by any manifest)
|
||||||
|
- Count and size of referenced blobs missing from remote storage, and the
|
||||||
|
snapshots that list them; the command exits non-zero when any are missing`,
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
// Use unified config resolution
|
// Use unified config resolution
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -23,6 +24,15 @@ import (
|
|||||||
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
||||||
var ErrRemoteNotFound = errors.New("rclone remote not found in config")
|
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.
|
// RcloneStorer implements Storer using rclone's filesystem abstraction.
|
||||||
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
||||||
type RcloneStorer struct {
|
type RcloneStorer struct {
|
||||||
@@ -53,6 +63,19 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
|||||||
rclonePath += path
|
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
|
// 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.
|
// each object's metadata, which costs one request per object to read.
|
||||||
// rclone's use_server_modtime setting makes ModTime the time the
|
// 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
|
// TestRcloneListStreamOnS3MakesNoRequestPerObject checks that listing an
|
||||||
// rclone S3 remote takes each object's time from the listing itself. By
|
// 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
|
// default rclone reads the time it keeps in each object's metadata, one
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ShowInfo displays system and configuration information
|
// ShowInfo displays system and configuration information
|
||||||
@@ -187,6 +188,9 @@ type SnapshotMetadataInfo struct {
|
|||||||
// backup interrupted before its manifest upload leaves a directory
|
// backup interrupted before its manifest upload leaves a directory
|
||||||
// without one, which prune does not treat as a snapshot.
|
// without one, which prune does not treat as a snapshot.
|
||||||
hasManifest bool
|
hasManifest bool
|
||||||
|
|
||||||
|
// Hashes of the blobs the snapshot's manifest lists.
|
||||||
|
blobHashes []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoteInfoResult contains all remote storage information
|
// RemoteInfoResult contains all remote storage information
|
||||||
@@ -216,6 +220,13 @@ type RemoteInfoResult struct {
|
|||||||
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
||||||
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
||||||
|
|
||||||
|
// Blobs that a manifest lists but the destination does not hold,
|
||||||
|
// and the remote key of each snapshot whose manifest lists one.
|
||||||
|
// Those snapshots cannot be restored.
|
||||||
|
MissingBlobCount int `json:"missing_blob_count"`
|
||||||
|
MissingBlobSize int64 `json:"missing_blob_size"`
|
||||||
|
SnapshotsMissingBlobs []string `json:"snapshots_missing_blobs,omitempty"`
|
||||||
|
|
||||||
// Remote key of each snapshot whose manifest could not be read
|
// Remote key of each snapshot whose manifest could not be read
|
||||||
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
||||||
|
|
||||||
@@ -283,19 +294,30 @@ func (v *Vaultik) RemoteInfo(jsonOutput bool) error {
|
|||||||
"snapshots", result.TotalMetadataCount,
|
"snapshots", result.TotalMetadataCount,
|
||||||
"total_blobs", result.TotalBlobCount,
|
"total_blobs", result.TotalBlobCount,
|
||||||
"referenced_blobs", result.ReferencedBlobCount,
|
"referenced_blobs", result.ReferencedBlobCount,
|
||||||
|
"missing_blobs", result.MissingBlobCount,
|
||||||
"unreadable_manifests", len(result.UnreadableManifests))
|
"unreadable_manifests", len(result.UnreadableManifests))
|
||||||
|
|
||||||
if jsonOutput {
|
if jsonOutput {
|
||||||
enc := json.NewEncoder(v.Stdout)
|
enc := json.NewEncoder(v.Stdout)
|
||||||
enc.SetIndent("", " ")
|
enc.SetIndent("", " ")
|
||||||
|
|
||||||
return enc.Encode(result)
|
err = enc.Encode(result)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("encoding JSON: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if showText {
|
if showText {
|
||||||
v.printRemoteInfoTable(result)
|
v.printRemoteInfoTable(result)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The report is written first, so the exit status adds to it.
|
||||||
|
if result.MissingBlobCount > 0 {
|
||||||
|
return fmt.Errorf("%w: %d blob(s) that snapshots list are missing; "+
|
||||||
|
"%d snapshot(s) cannot be restored", errProblemsInStorage,
|
||||||
|
result.MissingBlobCount, len(result.SnapshotsMissingBlobs))
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -405,6 +427,7 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
for _, blob := range manifest.Blobs {
|
for _, blob := range manifest.Blobs {
|
||||||
referencedBlobs[blob.Hash] = blob.CompressedSize
|
referencedBlobs[blob.Hash] = blob.CompressedSize
|
||||||
blobsSize += blob.CompressedSize
|
blobsSize += blob.CompressedSize
|
||||||
|
info.blobHashes = append(info.blobHashes, blob.Hash)
|
||||||
}
|
}
|
||||||
|
|
||||||
info.BlobCount = &blobCount
|
info.BlobCount = &blobCount
|
||||||
@@ -462,6 +485,8 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
result.TotalBlobSize += blob.Size
|
result.TotalBlobSize += blob.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
|
countMissingBlobs(result, referencedBlobs, allBlobs)
|
||||||
|
|
||||||
// A blob named only by a manifest that could not be read, or by one
|
// A blob named only by a manifest that could not be read, or by one
|
||||||
// under a skipped name, would be counted as orphaned, so the orphan
|
// under a skipped name, would be counted as orphaned, so the orphan
|
||||||
// figures stay unknown.
|
// figures stay unknown.
|
||||||
@@ -487,6 +512,33 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// countMissingBlobs records in result the referenced blobs that
|
||||||
|
// allBlobs, the listing of the destination, does not hold, and the
|
||||||
|
// snapshots whose manifests list one of them. It reads the snapshots
|
||||||
|
// from result.Snapshots, so populateRemoteInfoResult must run first.
|
||||||
|
func countMissingBlobs(
|
||||||
|
result *RemoteInfoResult, referencedBlobs map[string]int64,
|
||||||
|
allBlobs map[string]storage.ObjectInfo,
|
||||||
|
) {
|
||||||
|
for hash, size := range referencedBlobs {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.MissingBlobCount++
|
||||||
|
result.MissingBlobSize += size
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, info := range result.Snapshots {
|
||||||
|
for _, hash := range info.blobHashes {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.SnapshotsMissingBlobs = append(
|
||||||
|
result.SnapshotsMissingBlobs, info.SnapshotID)
|
||||||
|
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// printRemoteInfoTable renders the human-readable remote info output
|
// printRemoteInfoTable renders the human-readable remote info output
|
||||||
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
||||||
const (
|
const (
|
||||||
@@ -539,6 +591,12 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
"", "", ubytes(result.TotalMetadataSize))
|
"", "", ubytes(result.TotalMetadataSize))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
v.printBlobStorageSummary(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printBlobStorageSummary renders the blob storage section that ends
|
||||||
|
// the human-readable remote info output.
|
||||||
|
func (v *Vaultik) printBlobStorageSummary(result *RemoteInfoResult) {
|
||||||
v.stdoutf("\n=== Blob Storage ===\n")
|
v.stdoutf("\n=== Blob Storage ===\n")
|
||||||
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.TotalBlobCount)),
|
humanize.Comma(int64(result.TotalBlobCount)),
|
||||||
@@ -546,16 +604,16 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.ReferencedBlobCount)),
|
humanize.Comma(int64(result.ReferencedBlobCount)),
|
||||||
ubytes(result.ReferencedBlobSize))
|
ubytes(result.ReferencedBlobSize))
|
||||||
|
v.stdoutf("Missing from remote: %s (%s)\n",
|
||||||
|
humanize.Comma(int64(result.MissingBlobCount)),
|
||||||
|
ubytes(result.MissingBlobSize))
|
||||||
|
|
||||||
if result.OrphanedBlobCount == nil {
|
if result.OrphanedBlobCount == nil {
|
||||||
v.stdoutf("Orphaned (unreferenced): unknown "+
|
v.stdoutf("Orphaned (unreferenced): unknown "+
|
||||||
"(%d manifest(s) could not be read, "+
|
"(%d manifest(s) could not be read, "+
|
||||||
"%d manifest(s) under a non-conforming name skipped)\n",
|
"%d manifest(s) under a non-conforming name skipped)\n",
|
||||||
len(result.UnreadableManifests), result.SkippedManifestCount)
|
len(result.UnreadableManifests), result.SkippedManifestCount)
|
||||||
|
} else {
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
||||||
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
||||||
ubytes(*result.OrphanedBlobSize))
|
ubytes(*result.OrphanedBlobSize))
|
||||||
@@ -563,6 +621,15 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
if *result.OrphanedBlobCount > 0 {
|
if *result.OrphanedBlobCount > 0 {
|
||||||
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(result.SnapshotsMissingBlobs) > 0 {
|
||||||
|
v.stdoutf("\nSnapshots that cannot be restored (blobs missing):\n")
|
||||||
|
|
||||||
|
for _, id := range result.SnapshotsMissingBlobs {
|
||||||
|
v.stdoutf(" %s\n", id)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ellipsis is appended by truncateString when it shortens a string.
|
// ellipsis is appended by truncateString when it shortens a string.
|
||||||
|
|||||||
@@ -83,6 +83,7 @@ func TestRemoteInfo_UnreadableManifestLeavesSnapshotBlobsUnknown(t *testing.T) {
|
|||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
readableKey := env.addRemote(t, listRemoteID,
|
readableKey := env.addRemote(t, listRemoteID,
|
||||||
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
require.NoError(t, env.store.Put(context.Background(),
|
||||||
@@ -270,6 +271,7 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
|
|
||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
||||||
|
|
||||||
@@ -281,3 +283,61 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRemoteInfo_ReportsBlobsMissingFromDestination checks that a blob a
|
||||||
|
// manifest lists but the destination does not hold is counted as
|
||||||
|
// missing, that the snapshot listing it is named, and that remote info
|
||||||
|
// then fails after writing its report.
|
||||||
|
func TestRemoteInfo_ReportsBlobsMissingFromDestination(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newListEnv(t)
|
||||||
|
|
||||||
|
// The first snapshot lists blob A, which is not stored. The second
|
||||||
|
// lists blob B, which is.
|
||||||
|
brokenKey := env.addRemote(t, listRemoteID,
|
||||||
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addManifest(t, env.store.testStorer, listLocalID, []string{testBlobHashB})
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashB)
|
||||||
|
|
||||||
|
const wantError = "1 blob(s) that snapshots list are missing; " +
|
||||||
|
"1 snapshot(s) cannot be restored"
|
||||||
|
|
||||||
|
err := env.v.RemoteInfo(false)
|
||||||
|
require.ErrorContains(t, err, wantError)
|
||||||
|
|
||||||
|
text := env.stdout.String()
|
||||||
|
assert.Contains(t, text, "Missing from remote: 1 (5.0 MB)")
|
||||||
|
assert.Contains(t, text, "Snapshots that cannot be restored (blobs missing):\n"+
|
||||||
|
" "+brokenKey+"\n")
|
||||||
|
assert.NotContains(t, text, snapshot.RemoteSnapshotKey(listLocalID)+"\n")
|
||||||
|
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(true), wantError)
|
||||||
|
|
||||||
|
var doc map[string]any
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 1, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, fiveMegabytes, doc["missing_blob_size"], 0)
|
||||||
|
assert.Equal(t, []any{brokenKey}, doc["snapshots_missing_blobs"])
|
||||||
|
|
||||||
|
// --quiet drops the report, not the failure.
|
||||||
|
env.stdout.Reset()
|
||||||
|
env.v.UI.SetQuiet(true)
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(false), wantError)
|
||||||
|
assert.Empty(t, env.stdout.String())
|
||||||
|
env.v.UI.SetQuiet(false)
|
||||||
|
|
||||||
|
// With blob A stored again nothing is missing.
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.NoError(t, env.v.RemoteInfo(true))
|
||||||
|
|
||||||
|
doc = nil
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_size"], 0)
|
||||||
|
assert.NotContains(t, doc, "snapshots_missing_blobs")
|
||||||
|
}
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -349,6 +349,7 @@ func TestSnapshotListAndPurgePrintSizesLikeRemoteInfo(t *testing.T) {
|
|||||||
env.addRemote(t, listLocalID, start)
|
env.addRemote(t, listLocalID, start)
|
||||||
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
||||||
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
||||||
|
|||||||
@@ -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