Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
28a272903f | ||
|
|
7f3fb97012 |
No files matched your search
@@ -196,9 +196,10 @@ vaultik version
|
|||||||
that cannot be restored when restoring, instead of aborting. Packing and
|
that cannot be restored when restoring, instead of aborting. Packing and
|
||||||
storage errors while creating a snapshot (which would leave a chunk recorded
|
storage errors while creating a snapshot (which would leave a chunk recorded
|
||||||
but not stored) still abort the run. A run that skipped anything still
|
but not stored) still abort the run. A run that skipped anything still
|
||||||
finishes but exits non-zero: `snapshot create` keeps the snapshot and counts
|
finishes but exits `3` (see [exit status](#exit-status)): `snapshot create`
|
||||||
each file or directory it skipped as failed. A file removed during the backup
|
keeps the snapshot and counts each file or directory it skipped as failed. A
|
||||||
is also counted as failed but does not change the exit status.
|
file removed during the backup is also counted as failed but does not change
|
||||||
|
the exit status.
|
||||||
|
|
||||||
### locking
|
### locking
|
||||||
|
|
||||||
@@ -271,6 +272,19 @@ Every `--json` command therefore pipes on its own, with no additional flag:
|
|||||||
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
||||||
work as written.
|
work as written.
|
||||||
|
|
||||||
|
### exit status
|
||||||
|
|
||||||
|
- `0`: the command succeeded.
|
||||||
|
- `1`: the command failed.
|
||||||
|
- `3`: `snapshot create` or `snapshot restore` finished, but `--skip-errors`
|
||||||
|
skipped files it could not read or restore. `restic backup` uses the same
|
||||||
|
status for this case.
|
||||||
|
- `130`: Ctrl-C, `SIGINT` or `SIGTERM` stopped the command.
|
||||||
|
|
||||||
|
A cron job can page on `1` and only log `3`. A run that skipped files and also
|
||||||
|
failed in another way exits `1`. For example, a restore that skipped files and
|
||||||
|
was asked for a path the snapshot does not hold exits `1`.
|
||||||
|
|
||||||
### environment variables
|
### environment variables
|
||||||
|
|
||||||
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
||||||
@@ -347,24 +361,25 @@ In such a config, an unknown key or a value of the wrong type is refused.
|
|||||||
local index, as `prune` does. By default keeps only the latest snapshot per
|
local index, as `prune` does. By default keeps only the latest snapshot per
|
||||||
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
||||||
skipped a file or directory it could not read or list, the prune does not run
|
skipped a file or directory it could not read or list, the prune does not run
|
||||||
and every older snapshot is kept, since one of them may be the only one that
|
and every older snapshot is kept. One of them may be the only one that holds
|
||||||
holds what was skipped; the command says so and exits non-zero. When the
|
what was skipped. The command says so and exits `3`. The prune does not run
|
||||||
backup found nothing in a configured path, as in the mount point of a volume
|
either when the backup found nothing in a configured path, as in the mount
|
||||||
that is not mounted, the prune does not run either: every older snapshot is
|
point of a volume that is not mounted. Every older snapshot is kept, and the
|
||||||
kept, and the command names the path and exits non-zero, on every run until
|
command names the path and exits `1`, on every run until the path holds
|
||||||
the path holds something again. Take a path that is empty on purpose out of
|
something again. Take a path that is empty on purpose out of the config, or
|
||||||
the config, or remove the older snapshots by hand with `snapshot purge`. When
|
remove the older snapshots by hand with `snapshot purge`. The prune does not
|
||||||
an earlier snapshot of the same name in the local index found a volume mounted
|
run either when this backup does not find a volume that an earlier snapshot of
|
||||||
at or below a configured path (a directory on a different filesystem from its
|
the same name in the local index found. The volume's mount point is a
|
||||||
parent, with an entry in it that the backup does not exclude) and this backup
|
directory at or below a configured path. That directory is on a different
|
||||||
does not, the prune does not run either: every older snapshot is kept, and the
|
filesystem from its parent and holds an entry the backup does not exclude.
|
||||||
command names the directory and exits non-zero, on every run until the volume
|
Every older snapshot is kept, and the command names the directory and exits
|
||||||
is mounted again. A backup also does not find the volume when it finds no such
|
`1`, on every run until the volume is mounted again. A backup also does not
|
||||||
entry in its directory, as when an automounted volume cannot be mounted, or
|
find the volume when it finds no such entry in its directory, as when an
|
||||||
when that directory is no longer backed up, because it is excluded or its
|
automounted volume cannot be mounted. Nor does it find the volume when that
|
||||||
configured path was removed. If any of this is on purpose, as for a retired
|
directory is no longer backed up, because it is excluded or its configured
|
||||||
volume, remove the older snapshots by hand with `snapshot purge`. A file
|
path was removed. If any of this is on purpose, as for a retired volume,
|
||||||
removed during the backup does not stop the prune.
|
remove the older snapshots by hand with `snapshot purge`. A file removed
|
||||||
|
during the backup does not stop the prune.
|
||||||
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
||||||
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
||||||
`--prune`, or with a value that is not a valid duration, the command fails
|
`--prune`, or with a value that is not a valid duration, the command fails
|
||||||
@@ -602,11 +617,7 @@ 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`). The
|
providers. Requires rclone to be configured separately (`rclone config`).
|
||||||
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
|
||||||
@@ -618,10 +629,6 @@ being written, a killed upload can leave a truncated object under its name,
|
|||||||
which a later backup takes for complete. A leftover `.partial` file is ignored
|
which a later backup takes for complete. A leftover `.partial` file is ignored
|
||||||
and can be deleted.
|
and can be deleted.
|
||||||
|
|
||||||
A blob upload that fails, such as one cut off by a lost connection, is tried
|
|
||||||
again up to five times, three seconds apart. Each new try is announced with a
|
|
||||||
warning. If the last try fails too, the backup stops with the upload's error.
|
|
||||||
|
|
||||||
A destination shared between hosts or users, each with its own local index,
|
A destination shared between hosts or users, each with its own local index,
|
||||||
relies on `prune_grace_period` to keep one's prune from deleting the blobs of
|
relies on `prune_grace_period` to keep one's prune from deleting the blobs of
|
||||||
another's backup still running, or its directory under `metadata/` that has no
|
another's backup still running, or its directory under `metadata/` that has no
|
||||||
|
|||||||
+7
-6
@@ -198,7 +198,8 @@ func RunApp(ctx context.Context, app *fx.App) error {
|
|||||||
// (or, under `snapshot verify --json`, put in its document). Entry
|
// (or, under `snapshot verify --json`, put in its document). Entry
|
||||||
// turns it into a non-zero exit status without printing anything
|
// turns it into a non-zero exit status without printing anything
|
||||||
// further, so the error line is not doubled. It flows up from
|
// further, so the error line is not doubled. It flows up from
|
||||||
// RunOperation through cobra to Entry.
|
// RunOperation through cobra to Entry, wrapping the operation's error
|
||||||
|
// so that Entry can choose the exit status from it.
|
||||||
var errReported = errors.New("operation failed")
|
var errReported = errors.New("operation failed")
|
||||||
|
|
||||||
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
||||||
@@ -232,8 +233,8 @@ func RunOperation(
|
|||||||
) error {
|
) error {
|
||||||
var (
|
var (
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
finished bool // op returned before any interrupt cancelled it
|
finished bool // op returned before any interrupt cancelled it
|
||||||
failed bool // op finished with an error
|
opErr error // what op returned, when it finished
|
||||||
)
|
)
|
||||||
|
|
||||||
opts.Invokes = append(opts.Invokes,
|
opts.Invokes = append(opts.Invokes,
|
||||||
@@ -258,7 +259,7 @@ func RunOperation(
|
|||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
finished = true
|
finished = true
|
||||||
failed = err != nil
|
opErr = err
|
||||||
mu.Unlock()
|
mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -303,8 +304,8 @@ func RunOperation(
|
|||||||
switch {
|
switch {
|
||||||
case !finished:
|
case !finished:
|
||||||
return errInterrupted
|
return errInterrupted
|
||||||
case failed:
|
case opErr != nil:
|
||||||
return errReported
|
return fmt.Errorf("%w: %w", errReported, opErr)
|
||||||
default:
|
default:
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
+16
-2
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/globals"
|
"sneak.berlin/go/vaultik/internal/globals"
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
// shortCommitLen is the number of git commit hash characters shown in
|
// shortCommitLen is the number of git commit hash characters shown in
|
||||||
@@ -20,6 +21,13 @@ const shortCommitLen = 12
|
|||||||
// shell reports for a command stopped by Ctrl-C.
|
// shell reports for a command stopped by Ctrl-C.
|
||||||
const exitCodeInterrupted = 130
|
const exitCodeInterrupted = 130
|
||||||
|
|
||||||
|
// exitCodeSkippedFiles is the exit status of a `snapshot create` or
|
||||||
|
// `snapshot restore` that finished but skipped files under
|
||||||
|
// --skip-errors. It is the status `restic backup` uses for a snapshot
|
||||||
|
// that could not read some files, so a cron job can tell such a run
|
||||||
|
// from one that made no backup.
|
||||||
|
const exitCodeSkippedFiles = 3
|
||||||
|
|
||||||
// Entry is the main entry point for the CLI application.
|
// Entry is the main entry point for the CLI application.
|
||||||
// It first calls globals.FillUnsetFromBuildInfo, which fills in the
|
// It first calls globals.FillUnsetFromBuildInfo, which fills in the
|
||||||
// version, commit and commit date that the linker flags did not set.
|
// version, commit and commit date that the linker flags did not set.
|
||||||
@@ -30,8 +38,9 @@ const exitCodeInterrupted = 130
|
|||||||
// The banner goes to stderr because stdout carries only the output the
|
// The banner goes to stderr because stdout carries only the output the
|
||||||
// user asked for, such as a completion script or a `config get` value.
|
// user asked for, such as a completion script or a `config get` value.
|
||||||
//
|
//
|
||||||
// It returns the process exit code (0 on success, 130 when interrupted,
|
// It returns the process exit code (0 on success, 3 when files were
|
||||||
// 1 on any other error) rather than calling os.Exit, so that main's
|
// skipped, 130 when interrupted, 1 on any other error) rather than
|
||||||
|
// calling os.Exit, so that main's
|
||||||
// deferred profile writers run before the process ends. See run in
|
// deferred profile writers run before the process ends. See run in
|
||||||
// cmd/vaultik/main.go.
|
// cmd/vaultik/main.go.
|
||||||
func Entry() int {
|
func Entry() int {
|
||||||
@@ -58,6 +67,11 @@ func Entry() int {
|
|||||||
return exitCodeInterrupted
|
return exitCodeInterrupted
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
||||||
|
errors.Is(err, vaultik.ErrFilesFailedRestore) {
|
||||||
|
return exitCodeSkippedFiles
|
||||||
|
}
|
||||||
|
|
||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
package cli //nolint:testpackage // shares runEntry and the hermetic config helpers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
const flagSkipErrors = "--skip-errors"
|
||||||
|
|
||||||
|
// TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips backs up,
|
||||||
|
// under --skip-errors, a source directory that does not exist, which the
|
||||||
|
// walk skips. The command exits with exitCodeSkippedFiles and reports
|
||||||
|
// the backup as completed, not as a failed snapshot creation. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/310 and
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips(t *testing.T) {
|
||||||
|
// writeBackupConfig would create the source directory.
|
||||||
|
configPath := writeHermeticPruneConfig(t, false)
|
||||||
|
|
||||||
|
code, stdout, stderr := runEntry(t,
|
||||||
|
flagConfig, configPath, flagSkipErrors, cmdSnapshot, cmdCreate)
|
||||||
|
|
||||||
|
assert.Equal(t, exitCodeSkippedFiles, code)
|
||||||
|
assert.Contains(t, stdout,
|
||||||
|
"Files: 1 examined, 0 backed up, 0 unchanged, 1 failed.")
|
||||||
|
assert.NotContains(t, stdout, "Finished successfully.")
|
||||||
|
assert.Contains(t, stderr,
|
||||||
|
"Backup completed, but 1 file(s) could not be read")
|
||||||
|
assert.NotContains(t, stderr, "Snapshot creation failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEntrySnapshotRestoreSkipErrorsExitStatus backs up, deletes the
|
||||||
|
// blobs from the destination, and restores under --skip-errors, so every
|
||||||
|
// file is skipped. A restore that only skipped files exits with
|
||||||
|
// exitCodeSkippedFiles. One that was also asked for a path the snapshot
|
||||||
|
// does not hold exits 1. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntrySnapshotRestoreSkipErrorsExitStatus(t *testing.T) {
|
||||||
|
for _, testCase := range []struct {
|
||||||
|
name string
|
||||||
|
missingPaths []string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{name: "skipped files only", want: exitCodeSkippedFiles},
|
||||||
|
{
|
||||||
|
name: "and a path that matches nothing",
|
||||||
|
missingPaths: []string{"/no/such/path"},
|
||||||
|
want: 1,
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(testCase.name, func(t *testing.T) {
|
||||||
|
configPath, storeDir := writeBackupConfigWithPrivateKey(t)
|
||||||
|
|
||||||
|
code, _, _ := runEntry(t,
|
||||||
|
flagConfig, configPath, cmdSnapshot, cmdCreate)
|
||||||
|
require.Equal(t, 0, code)
|
||||||
|
|
||||||
|
require.NoError(t, os.RemoveAll(filepath.Join(storeDir, blobsDir)))
|
||||||
|
|
||||||
|
// writeBackupConfig puts the source directory beside the
|
||||||
|
// config file.
|
||||||
|
sourceDir := filepath.Join(filepath.Dir(configPath), "source")
|
||||||
|
args := append([]string{
|
||||||
|
flagConfig, configPath, flagSkipErrors, cmdSnapshot,
|
||||||
|
cmdRestore, onlySnapshotID(t, configPath), t.TempDir(),
|
||||||
|
sourceDir,
|
||||||
|
}, testCase.missingPaths...)
|
||||||
|
|
||||||
|
code, _, stderr := runEntry(t, args...)
|
||||||
|
|
||||||
|
assert.Equal(t, testCase.want, code)
|
||||||
|
assert.Contains(t, stderr, "1 file(s) failed to restore")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares runEntry and the hermetic config helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips backs up,
|
|
||||||
// under --skip-errors, a source directory that does not exist, which the
|
|
||||||
// walk skips. The command exits non-zero and reports the backup as
|
|
||||||
// completed, not as a failed snapshot creation. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/310.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
|
||||||
func TestEntrySnapshotCreateSkipErrorsExitsNonZeroWhenItSkips(t *testing.T) {
|
|
||||||
// writeBackupConfig would create the source directory.
|
|
||||||
configPath := writeHermeticPruneConfig(t, false)
|
|
||||||
|
|
||||||
code, stdout, stderr := runEntry(t,
|
|
||||||
flagConfig, configPath, "--skip-errors", cmdSnapshot, cmdCreate)
|
|
||||||
|
|
||||||
assert.Equal(t, 1, code)
|
|
||||||
assert.Contains(t, stdout,
|
|
||||||
"Files: 1 examined, 0 backed up, 0 unchanged, 1 failed.")
|
|
||||||
assert.NotContains(t, stdout, "Finished successfully.")
|
|
||||||
assert.Contains(t, stderr,
|
|
||||||
"Backup completed, but 1 file(s) could not be read")
|
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
|
||||||
}
|
|
||||||
@@ -1,154 +0,0 @@
|
|||||||
//nolint:testpackage // exercises the unexported uploadBlobIfNeeded
|
|
||||||
package snapshot
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"io"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blob"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage/faultstore"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
)
|
|
||||||
|
|
||||||
// retryTestBlobSize is larger than what a failing faultstore Put reads,
|
|
||||||
// so a new try that did not rewind the blob would store a short object.
|
|
||||||
const retryTestBlobSize = 4096
|
|
||||||
|
|
||||||
// retryTestBlobKey is where the retry tests upload their blob.
|
|
||||||
const retryTestBlobKey = "blobs/retry"
|
|
||||||
|
|
||||||
// uploadRetryTestBlob uploads a retryTestBlobSize blob through store,
|
|
||||||
// waiting delay between tries, and returns the blob's bytes, the warnings
|
|
||||||
// the upload printed and its error.
|
|
||||||
func uploadRetryTestBlob(
|
|
||||||
ctx context.Context, store storage.Storer, delay time.Duration,
|
|
||||||
) ([]byte, int, error) {
|
|
||||||
data := bytes.Repeat([]byte("0123456789abcdef"), retryTestBlobSize/16)
|
|
||||||
output := ui.NewWithColor(io.Discard, false)
|
|
||||||
s := &Scanner{storage: store, ui: output, blobUploadRetryDelay: delay}
|
|
||||||
|
|
||||||
_, _, err := s.uploadBlobIfNeeded(ctx, retryTestBlobKey, &blob.WithReader{
|
|
||||||
FinishedBlob: &blob.FinishedBlob{
|
|
||||||
Hash: "retry",
|
|
||||||
Compressed: int64(len(data)),
|
|
||||||
},
|
|
||||||
Reader: bytes.NewReader(data),
|
|
||||||
}, time.Now(), &ScanResult{})
|
|
||||||
|
|
||||||
return data, output.WarningCount(), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// A blob upload that fails is tried again from the start of the blob,
|
|
||||||
// and each failure is a warning. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/476.
|
|
||||||
func TestFailedBlobUploadIsTriedAgain(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
puts := 0
|
|
||||||
store := faultstore.New(inner)
|
|
||||||
store.OnPut = func(string) faultstore.PutAction {
|
|
||||||
puts++
|
|
||||||
if puts <= 2 {
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
data, warnings, err := uploadRetryTestBlob(context.Background(), store, 0)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Equal(t, 3, puts)
|
|
||||||
require.Equal(t, 2, warnings)
|
|
||||||
|
|
||||||
rc, err := inner.Get(context.Background(), retryTestBlobKey)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = rc.Close() }()
|
|
||||||
|
|
||||||
stored, err := io.ReadAll(rc)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Equal(t, data, stored)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A blob upload that keeps failing is tried blobUploadRetries more times,
|
|
||||||
// BlobUploadRetryDelay apart, and then the backup stops with its error.
|
|
||||||
func TestBlobUploadStopsAfterRetries(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
puts := 0
|
|
||||||
store := faultstore.New(inner)
|
|
||||||
store.OnPut = func(string) faultstore.PutAction {
|
|
||||||
puts++
|
|
||||||
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
const delay = 10 * time.Millisecond
|
|
||||||
|
|
||||||
start := time.Now()
|
|
||||||
_, warnings, err := uploadRetryTestBlob(context.Background(), store, delay)
|
|
||||||
|
|
||||||
require.ErrorIs(t, err, faultstore.ErrInjectedUpload)
|
|
||||||
require.Equal(t, 1+blobUploadRetries, puts)
|
|
||||||
require.Equal(t, blobUploadRetries, warnings)
|
|
||||||
require.GreaterOrEqual(t, time.Since(start), blobUploadRetries*delay)
|
|
||||||
}
|
|
||||||
|
|
||||||
// An upload stopped by Ctrl-C or SIGTERM is not tried again.
|
|
||||||
func TestInterruptedBlobUploadIsNotTriedAgain(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
t.Cleanup(cancel)
|
|
||||||
|
|
||||||
puts := 0
|
|
||||||
store := faultstore.New(inner)
|
|
||||||
store.OnPut = func(string) faultstore.PutAction {
|
|
||||||
puts++
|
|
||||||
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
_, warnings, err := uploadRetryTestBlob(ctx, store, 0)
|
|
||||||
|
|
||||||
require.Error(t, err)
|
|
||||||
require.Equal(t, 1, puts)
|
|
||||||
require.Zero(t, warnings)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Backups wait BlobUploadRetryDelay before each new try.
|
|
||||||
func TestBackupScannerWaitsBetweenBlobUploadRetries(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cfg := &config.Config{
|
|
||||||
AgeRecipients: []string{testAgeRecipient},
|
|
||||||
ChunkSize: config.Size(1024 * 1024),
|
|
||||||
BlobSizeLimit: config.Size(4 * 1024 * 1024),
|
|
||||||
IndexPath: filepath.Join(t.TempDir(), "index.sqlite"),
|
|
||||||
}
|
|
||||||
|
|
||||||
scanner := provideScannerFactory(cfg, nil, nil)(ScannerParams{
|
|
||||||
Fs: afero.NewMemMapFs(),
|
|
||||||
})
|
|
||||||
require.NotNil(t, scanner)
|
|
||||||
require.Equal(t, BlobUploadRetryDelay, scanner.blobUploadRetryDelay)
|
|
||||||
}
|
|
||||||
@@ -4,10 +4,8 @@ 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"
|
||||||
)
|
)
|
||||||
@@ -40,36 +38,3 @@ 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")
|
|
||||||
}
|
|
||||||
+14
-15
@@ -54,21 +54,20 @@ func provideScannerFactory(
|
|||||||
}
|
}
|
||||||
|
|
||||||
return NewScanner(ScannerConfig{
|
return NewScanner(ScannerConfig{
|
||||||
FS: params.Fs,
|
FS: params.Fs,
|
||||||
ChunkSize: cfg.ChunkSize.Int64(),
|
ChunkSize: cfg.ChunkSize.Int64(),
|
||||||
Repositories: repos,
|
Repositories: repos,
|
||||||
Storage: storer,
|
Storage: storer,
|
||||||
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
EnableProgress: params.EnableProgress,
|
EnableProgress: params.EnableProgress,
|
||||||
UI: params.UI,
|
UI: params.UI,
|
||||||
Exclude: excludes,
|
Exclude: excludes,
|
||||||
IndexAndLockFiles: indexAndLockFiles(cfg.IndexPath, pidlock.Dir()),
|
IndexAndLockFiles: indexAndLockFiles(cfg.IndexPath, pidlock.Dir()),
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
PreviousSnapshotID: params.PreviousSnapshotID,
|
||||||
BlobUploadRetryDelay: BlobUploadRetryDelay,
|
DeviceNumber: params.DeviceNumber,
|
||||||
DeviceNumber: params.DeviceNumber,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -75,8 +75,6 @@ type Scanner struct {
|
|||||||
// skipErrors skips files that cannot be opened or read (logged loudly);
|
// skipErrors skips files that cannot be opened or read (logged loudly);
|
||||||
// packer, database, encryption, and upload errors still abort the run.
|
// packer, database, encryption, and upload errors still abort the run.
|
||||||
skipErrors bool
|
skipErrors bool
|
||||||
// blobUploadRetryDelay is ScannerConfig.BlobUploadRetryDelay.
|
|
||||||
blobUploadRetryDelay time.Duration
|
|
||||||
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
||||||
ui *ui.Writer
|
ui *ui.Writer
|
||||||
// deviceNumber returns the number of the device that holds a file;
|
// deviceNumber returns the number of the device that holds a file;
|
||||||
@@ -125,16 +123,8 @@ const (
|
|||||||
// snapshotAssocBatchSize is how many file IDs are associated with the
|
// snapshotAssocBatchSize is how many file IDs are associated with the
|
||||||
// snapshot per transaction.
|
// snapshot per transaction.
|
||||||
snapshotAssocBatchSize = 1000
|
snapshotAssocBatchSize = 1000
|
||||||
|
|
||||||
// blobUploadRetries is how many more times a failed blob upload is
|
|
||||||
// tried before the backup stops with the error.
|
|
||||||
blobUploadRetries = 5
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// BlobUploadRetryDelay is the wait before each new try of a failed blob
|
|
||||||
// upload.
|
|
||||||
const BlobUploadRetryDelay = 3 * time.Second
|
|
||||||
|
|
||||||
// ScannerConfig contains configuration for the scanner
|
// ScannerConfig contains configuration for the scanner
|
||||||
type ScannerConfig struct {
|
type ScannerConfig struct {
|
||||||
FS afero.Fs
|
FS afero.Fs
|
||||||
@@ -158,10 +148,6 @@ type ScannerConfig struct {
|
|||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
// PreviousSnapshotID is the most recent completed snapshot of the
|
||||||
// same name, "" for none.
|
// same name, "" for none.
|
||||||
PreviousSnapshotID string
|
PreviousSnapshotID string
|
||||||
// BlobUploadRetryDelay is the wait before each new try of a failed
|
|
||||||
// blob upload. Backups use snapshot.BlobUploadRetryDelay; tests leave
|
|
||||||
// it zero to try again at once.
|
|
||||||
BlobUploadRetryDelay time.Duration
|
|
||||||
// DeviceNumber returns the number of the device that holds a file,
|
// DeviceNumber returns the number of the device that holds a file,
|
||||||
// and false when there is none to read. nil reads it from the file's
|
// and false when there is none to read. nil reads it from the file's
|
||||||
// stat; tests replace it, since the in-memory test filesystem has none.
|
// stat; tests replace it, since the in-memory test filesystem has none.
|
||||||
@@ -259,24 +245,23 @@ func NewScanner(cfg ScannerConfig) *Scanner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return &Scanner{
|
return &Scanner{
|
||||||
fs: cfg.FS,
|
fs: cfg.FS,
|
||||||
chunker: chunker.NewChunker(cfg.ChunkSize),
|
chunker: chunker.NewChunker(cfg.ChunkSize),
|
||||||
packer: packer,
|
packer: packer,
|
||||||
repos: cfg.Repositories,
|
repos: cfg.Repositories,
|
||||||
storage: cfg.Storage,
|
storage: cfg.Storage,
|
||||||
maxBlobSize: cfg.MaxBlobSize,
|
maxBlobSize: cfg.MaxBlobSize,
|
||||||
compressionLevel: cfg.CompressionLevel,
|
compressionLevel: cfg.CompressionLevel,
|
||||||
ageRecipient: strings.Join(cfg.AgeRecipients, ","),
|
ageRecipient: strings.Join(cfg.AgeRecipients, ","),
|
||||||
exclude: cfg.Exclude,
|
exclude: cfg.Exclude,
|
||||||
compiledExclude: compiledExclude,
|
compiledExclude: compiledExclude,
|
||||||
indexAndLockFiles: indexAndLockFiles,
|
indexAndLockFiles: indexAndLockFiles,
|
||||||
progress: progress,
|
progress: progress,
|
||||||
skipErrors: cfg.SkipErrors,
|
skipErrors: cfg.SkipErrors,
|
||||||
previousSnapshotID: cfg.PreviousSnapshotID,
|
previousSnapshotID: cfg.PreviousSnapshotID,
|
||||||
blobUploadRetryDelay: cfg.BlobUploadRetryDelay,
|
ui: uiw,
|
||||||
ui: uiw,
|
deviceNumber: deviceNumber,
|
||||||
deviceNumber: deviceNumber,
|
pendingChunkHashes: make(map[string]struct{}),
|
||||||
pendingChunkHashes: make(map[string]struct{}),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1453,12 +1438,11 @@ 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 from a real
|
// file info describes, and false when info carries no stat, as from the
|
||||||
// filesystem. The in-memory test filesystem gives either no stat or one
|
// in-memory test filesystem.
|
||||||
// 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 || (stat.Dev == 0 && stat.Ino == 0) {
|
if !ok {
|
||||||
return 0, false
|
return 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1891,7 +1875,10 @@ func (s *Scanner) uploadBlobIfNeeded(
|
|||||||
s.ui.Hex(finishedBlob.Hash), s.ui.Size(finishedBlob.Compressed),
|
s.ui.Hex(finishedBlob.Hash), s.ui.Size(finishedBlob.Compressed),
|
||||||
s.ui.Path(destination))
|
s.ui.Path(destination))
|
||||||
|
|
||||||
err = s.putBlob(ctx, blobPath, blobWithReader)
|
progressCallback := s.makeUploadProgressCallback(ctx, finishedBlob, startTime)
|
||||||
|
|
||||||
|
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
||||||
|
finishedBlob.Compressed, progressCallback)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// The record is at info level: the returned error ends the backup
|
// The record is at info level: the returned error ends the backup
|
||||||
// and is printed as its ERROR: line. Only an interrupt cancels
|
// and is printed as its ERROR: line. Only an interrupt cancels
|
||||||
@@ -1935,44 +1922,6 @@ func (s *Scanner) uploadBlobIfNeeded(
|
|||||||
return finishedBlob.Compressed, false, nil
|
return finishedBlob.Compressed, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// putBlob uploads the blob to blobPath. After a failed upload it waits
|
|
||||||
// s.blobUploadRetryDelay and uploads the whole blob again, up to
|
|
||||||
// blobUploadRetries times, and then returns the last error. An interrupt
|
|
||||||
// stops it at once.
|
|
||||||
func (s *Scanner) putBlob(
|
|
||||||
ctx context.Context, blobPath string, blobWithReader *blob.WithReader,
|
|
||||||
) error {
|
|
||||||
finishedBlob := blobWithReader.FinishedBlob
|
|
||||||
|
|
||||||
for retries := 0; ; retries++ {
|
|
||||||
_, err := blobWithReader.Reader.Seek(0, io.SeekStart)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("rewinding blob for upload: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
progressCallback := s.makeUploadProgressCallback(
|
|
||||||
ctx, finishedBlob, time.Now().UTC())
|
|
||||||
|
|
||||||
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
|
||||||
finishedBlob.Compressed, progressCallback)
|
|
||||||
if err == nil || ctx.Err() != nil || retries == blobUploadRetries {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Info("Blob upload failed, trying again",
|
|
||||||
"hash", finishedBlob.Hash, "retry", retries+1, "error", err)
|
|
||||||
s.ui.Warningf("Upload of blob %s failed: %v. Trying again in %s (retry %d of %d).",
|
|
||||||
s.ui.Hex(finishedBlob.Hash), err,
|
|
||||||
s.ui.Duration(s.blobUploadRetryDelay), retries+1, blobUploadRetries)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return err
|
|
||||||
case <-time.After(s.blobUploadRetryDelay):
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// makeUploadProgressCallback creates a progress callback for blob uploads.
|
// makeUploadProgressCallback creates a progress callback for blob uploads.
|
||||||
// It updates the live progress reporter ~twice/sec for ETAs and prints a
|
// It updates the live progress reporter ~twice/sec for ETAs and prints a
|
||||||
// human-readable status line to s.output at most every 15 seconds.
|
// human-readable status line to s.output at most every 15 seconds.
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -24,15 +23,6 @@ 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 {
|
||||||
@@ -63,19 +53,6 @@ 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,79 +436,6 @@ 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
|
||||||
|
|||||||
@@ -25,9 +25,13 @@ 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(
|
||||||
@@ -201,9 +205,9 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// finishRestore prints the restore summary and the post-restore
|
// finishRestore prints the restore summary and the post-restore
|
||||||
// warnings, runs optional verification, and converts any failed-file
|
// warnings, runs optional verification, and returns the error the
|
||||||
// count into an error. Otherwise it returns unmatchedErr, the error for
|
// restore ends with: one for the files --skip-errors skipped, one for
|
||||||
// the requested paths that matched nothing (nil when there are none).
|
// unmatchedErr, the requested paths that matched nothing, or nil.
|
||||||
func (v *Vaultik) finishRestore(
|
func (v *Vaultik) finishRestore(
|
||||||
repos *database.Repositories,
|
repos *database.Repositories,
|
||||||
files []*database.File,
|
files []*database.File,
|
||||||
@@ -250,11 +254,18 @@ func (v *Vaultik) finishRestore(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if result.FilesFailed > 0 {
|
switch {
|
||||||
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
case result.FilesFailed > 0 && unmatchedErr != nil:
|
||||||
|
// A requested path that matched nothing outweighs skipped files:
|
||||||
|
// the error wraps only unmatchedErr, so the command does not exit
|
||||||
|
// as a restore that only skipped files.
|
||||||
|
return fmt.Errorf("%w; %d %s",
|
||||||
|
unmatchedErr, result.FilesFailed, ErrFilesFailedRestore.Error())
|
||||||
|
case result.FilesFailed > 0:
|
||||||
|
return fmt.Errorf("%d %w", result.FilesFailed, ErrFilesFailedRestore)
|
||||||
|
default:
|
||||||
|
return unmatchedErr
|
||||||
}
|
}
|
||||||
|
|
||||||
return unmatchedErr
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ func TestRestoreFreesBlobsNoPendingFileNeeds(t *testing.T) {
|
|||||||
TargetDir: restoreDir,
|
TargetDir: restoreDir,
|
||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, errFilesFailedRestore)
|
require.ErrorIs(t, err, ErrFilesFailedRestore)
|
||||||
|
|
||||||
requireRestoredFiles(t, fs, restoreDir, originals)
|
requireRestoredFiles(t, fs, restoreDir, originals)
|
||||||
assert.LessOrEqualf(t, peak, 1,
|
assert.LessOrEqualf(t, peak, 1,
|
||||||
|
|||||||
@@ -49,8 +49,7 @@ var ErrFilesUnreadable = errors.New("file(s) could not be read")
|
|||||||
// prune because the scan found nothing in a configured path of a
|
// prune because the scan found nothing in a configured path of a
|
||||||
// snapshot, as in the mount point of a volume that is not mounted. The
|
// snapshot, as in the mount point of a volume that is not mounted. The
|
||||||
// snapshots are complete and kept, so the caller can report it apart
|
// snapshots are complete and kept, so the caller can report it apart
|
||||||
// from a failed backup. A run that also skipped unreadable files
|
// from a failed backup.
|
||||||
// returns ErrFilesUnreadable instead.
|
|
||||||
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
||||||
|
|
||||||
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
||||||
@@ -59,8 +58,8 @@ var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
|||||||
// mounted there is not mounted, the run found no entry in it, or the
|
// mounted there is not mounted, the run found no entry in it, or the
|
||||||
// directory is no longer backed up. The snapshots are complete and
|
// directory is no longer backed up. The snapshots are complete and
|
||||||
// kept, so the caller can report it apart from a failed backup. A run
|
// kept, so the caller can report it apart from a failed backup. A run
|
||||||
// that also skipped unreadable files or found a configured path empty
|
// that also found a configured path empty returns ErrSourcePathEmpty
|
||||||
// returns ErrFilesUnreadable or ErrSourcePathEmpty instead.
|
// instead.
|
||||||
var ErrVolumeNotMounted = errors.New(
|
var ErrVolumeNotMounted = errors.New(
|
||||||
"mount point(s) an earlier snapshot recorded were not found")
|
"mount point(s) an earlier snapshot recorded were not found")
|
||||||
|
|
||||||
@@ -243,15 +242,29 @@ func (v *Vaultik) skipPostBackupPrune(
|
|||||||
if filesUnreadable > 0 {
|
if filesUnreadable > 0 {
|
||||||
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
||||||
"could not be read; older snapshots are kept.", filesUnreadable)
|
"could not be read; older snapshots are kept.", filesUnreadable)
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case len(emptyPaths) > 0:
|
||||||
|
err = fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
||||||
|
case len(unmountedPaths) > 0:
|
||||||
|
err = fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
||||||
|
default:
|
||||||
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(emptyPaths) > 0 {
|
// An empty path or a missing volume can mean a whole volume is not
|
||||||
return fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
// in the backup, which outweighs skipped files: the error wraps only
|
||||||
|
// the former, so the command does not exit as a backup that only
|
||||||
|
// skipped files.
|
||||||
|
if filesUnreadable > 0 {
|
||||||
|
return fmt.Errorf("%w; %d %s",
|
||||||
|
err, filesUnreadable, ErrFilesUnreadable.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
return fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
||||||
|
|||||||
@@ -176,8 +176,11 @@ func TestBackupThroughSymlinkWhoseTargetIsGoneDoesNotPrune(t *testing.T) {
|
|||||||
|
|
||||||
// A backup under --skip-errors --prune that both skipped a file it could
|
// A backup under --skip-errors --prune that both skipped a file it could
|
||||||
// not read and found nothing in a configured path names the empty path
|
// not read and found nothing in a configured path names the empty path
|
||||||
// too when it skips the prune. See
|
// too when it skips the prune. It ends with the empty path's error, which
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
// names the unreadable file too but does not wrap ErrFilesUnreadable, so
|
||||||
|
// the command does not exit as a backup that only skipped files. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/388 and
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
||||||
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
@@ -207,7 +210,10 @@ func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
|||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
Snapshots: []string{snapshotName},
|
Snapshots: []string{snapshotName},
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
require.ErrorIs(t, err, vaultik.ErrSourcePathEmpty)
|
||||||
|
require.NotErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
||||||
|
require.EqualError(t, err,
|
||||||
|
"1 source path(s) were empty; 1 file(s) could not be read")
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
"Skipped the post-backup prune because 1 file(s) could not be read")
|
"Skipped the post-backup prune because 1 file(s) could not be read")
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"maps"
|
"maps"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
@@ -13,7 +12,6 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/database"
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
"sneak.berlin/go/vaultik/internal/storage/faultstore"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -70,55 +68,3 @@ func TestBackupWithoutCronOfTwoPathSnapshotRestoresBothPaths(t *testing.T) {
|
|||||||
|
|
||||||
assertRestoredTree(t, fs, restoreDir, files)
|
assertRestoredTree(t, fs, restoreDir, files)
|
||||||
}
|
}
|
||||||
|
|
||||||
// A backup without --cron whose blob uploads keep failing stops with the
|
|
||||||
// upload's error, and stops the progress reporter once. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/476.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestBackupWithoutCronStopsWithBlobUploadError(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
const snapshotName = "data"
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
firstDir := filepath.Join(tempDir, "first")
|
|
||||||
secondDir := filepath.Join(tempDir, "second")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
writeFaultSourceTree(t, fs, firstDir)
|
|
||||||
writeFaultSourceTree(t, fs, secondDir)
|
|
||||||
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
cfg.IndexPath = dbPath
|
|
||||||
cfg.ChunkSize = config.Size(faultChunkSize)
|
|
||||||
cfg.Snapshots = map[string]config.SnapshotConfig{
|
|
||||||
snapshotName: {Paths: []string{firstDir, secondDir}},
|
|
||||||
}
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
store := faultstore.New(inner)
|
|
||||||
store.OnPut = func(key string) faultstore.PutAction {
|
|
||||||
if strings.HasPrefix(key, "blobs/") {
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
v := newBackupVaultik(ctx, cfg, store, database.NewRepositories(db), db, fs)
|
|
||||||
|
|
||||||
err = v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
Snapshots: []string{snapshotName},
|
|
||||||
})
|
|
||||||
require.ErrorIs(t, err, faultstore.ErrInjectedUpload)
|
|
||||||
}
|
|
||||||
Reference in new issue
Block a user