Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4e084a2746 |
No files matched your search
@@ -196,10 +196,9 @@ vaultik version
|
|||||||
that cannot be restored when restoring, instead of aborting. Packing and
|
that cannot be restored when restoring, instead of aborting. Packing and
|
||||||
storage errors while creating a snapshot (which would leave a chunk recorded
|
storage errors while creating a snapshot (which would leave a chunk recorded
|
||||||
but not stored) still abort the run. A run that skipped anything still
|
but not stored) still abort the run. A run that skipped anything still
|
||||||
finishes but exits `3` (see [exit status](#exit-status)): `snapshot create`
|
finishes but exits non-zero: `snapshot create` keeps the snapshot and counts
|
||||||
keeps the snapshot and counts each file or directory it skipped as failed. A
|
each file or directory it skipped as failed. A file removed during the backup
|
||||||
file removed during the backup is also counted as failed but does not change
|
is also counted as failed but does not change the exit status.
|
||||||
the exit status.
|
|
||||||
|
|
||||||
### locking
|
### locking
|
||||||
|
|
||||||
@@ -272,19 +271,6 @@ Every `--json` command therefore pipes on its own, with no additional flag:
|
|||||||
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
`vaultik snapshot list --json | jq .` and `vaultik prune --json | jq .` both
|
||||||
work as written.
|
work as written.
|
||||||
|
|
||||||
### exit status
|
|
||||||
|
|
||||||
- `0`: the command succeeded.
|
|
||||||
- `1`: the command failed.
|
|
||||||
- `3`: `snapshot create` or `snapshot restore` finished, but `--skip-errors`
|
|
||||||
skipped files it could not read or restore. `restic backup` uses the same
|
|
||||||
status for this case.
|
|
||||||
- `130`: Ctrl-C, `SIGINT` or `SIGTERM` stopped the command.
|
|
||||||
|
|
||||||
A cron job can page on `1` and only log `3`. A run that skipped files and also
|
|
||||||
failed in another way exits `1`. For example, a restore that skipped files and
|
|
||||||
was asked for a path the snapshot does not hold exits `1`.
|
|
||||||
|
|
||||||
### environment variables
|
### environment variables
|
||||||
|
|
||||||
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
- `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for
|
||||||
@@ -361,25 +347,24 @@ In such a config, an unknown key or a value of the wrong type is refused.
|
|||||||
local index, as `prune` does. By default keeps only the latest snapshot per
|
local index, as `prune` does. By default keeps only the latest snapshot per
|
||||||
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
|
||||||
skipped a file or directory it could not read or list, the prune does not run
|
skipped a file or directory it could not read or list, the prune does not run
|
||||||
and every older snapshot is kept. One of them may be the only one that holds
|
and every older snapshot is kept, since one of them may be the only one that
|
||||||
what was skipped. The command says so and exits `3`. The prune does not run
|
holds what was skipped; the command says so and exits non-zero. When the
|
||||||
either when the backup found nothing in a configured path, as in the mount
|
backup found nothing in a configured path, as in the mount point of a volume
|
||||||
point of a volume that is not mounted. Every older snapshot is kept, and the
|
that is not mounted, the prune does not run either: every older snapshot is
|
||||||
command names the path and exits `1`, on every run until the path holds
|
kept, and the command names the path and exits non-zero, on every run until
|
||||||
something again. Take a path that is empty on purpose out of the config, or
|
the path holds something again. Take a path that is empty on purpose out of
|
||||||
remove the older snapshots by hand with `snapshot purge`. The prune does not
|
the config, or remove the older snapshots by hand with `snapshot purge`. When
|
||||||
run either when this backup does not find a volume that an earlier snapshot of
|
an earlier snapshot of the same name in the local index found a volume mounted
|
||||||
the same name in the local index found. The volume's mount point is a
|
at or below a configured path (a directory on a different filesystem from its
|
||||||
directory at or below a configured path. That directory is on a different
|
parent, with an entry in it that the backup does not exclude) and this backup
|
||||||
filesystem from its parent and holds an entry the backup does not exclude.
|
does not, the prune does not run either: every older snapshot is kept, and the
|
||||||
Every older snapshot is kept, and the command names the directory and exits
|
command names the directory and exits non-zero, on every run until the volume
|
||||||
`1`, on every run until the volume is mounted again. A backup also does not
|
is mounted again. A backup also does not find the volume when it finds no such
|
||||||
find the volume when it finds no such entry in its directory, as when an
|
entry in its directory, as when an automounted volume cannot be mounted, or
|
||||||
automounted volume cannot be mounted. Nor does it find the volume when that
|
when that directory is no longer backed up, because it is excluded or its
|
||||||
directory is no longer backed up, because it is excluded or its configured
|
configured path was removed. If any of this is on purpose, as for a retired
|
||||||
path was removed. If any of this is on purpose, as for a retired volume,
|
volume, remove the older snapshots by hand with `snapshot purge`. A file
|
||||||
remove the older snapshots by hand with `snapshot purge`. A file removed
|
removed during the backup does not stop the prune.
|
||||||
during the backup does not stop the prune.
|
|
||||||
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
|
||||||
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
|
||||||
`--prune`, or with a value that is not a valid duration, the command fails
|
`--prune`, or with a value that is not a valid duration, the command fails
|
||||||
|
|||||||
+6
-7
@@ -198,8 +198,7 @@ func RunApp(ctx context.Context, app *fx.App) error {
|
|||||||
// (or, under `snapshot verify --json`, put in its document). Entry
|
// (or, under `snapshot verify --json`, put in its document). Entry
|
||||||
// turns it into a non-zero exit status without printing anything
|
// turns it into a non-zero exit status without printing anything
|
||||||
// further, so the error line is not doubled. It flows up from
|
// further, so the error line is not doubled. It flows up from
|
||||||
// RunOperation through cobra to Entry, wrapping the operation's error
|
// RunOperation through cobra to Entry.
|
||||||
// so that Entry can choose the exit status from it.
|
|
||||||
var errReported = errors.New("operation failed")
|
var errReported = errors.New("operation failed")
|
||||||
|
|
||||||
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
// errInterrupted marks an operation that SIGINT or SIGTERM stopped
|
||||||
@@ -233,8 +232,8 @@ func RunOperation(
|
|||||||
) error {
|
) error {
|
||||||
var (
|
var (
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
finished bool // op returned before any interrupt cancelled it
|
finished bool // op returned before any interrupt cancelled it
|
||||||
opErr error // what op returned, when it finished
|
failed bool // op finished with an error
|
||||||
)
|
)
|
||||||
|
|
||||||
opts.Invokes = append(opts.Invokes,
|
opts.Invokes = append(opts.Invokes,
|
||||||
@@ -259,7 +258,7 @@ func RunOperation(
|
|||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
finished = true
|
finished = true
|
||||||
opErr = err
|
failed = err != nil
|
||||||
mu.Unlock()
|
mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -304,8 +303,8 @@ func RunOperation(
|
|||||||
switch {
|
switch {
|
||||||
case !finished:
|
case !finished:
|
||||||
return errInterrupted
|
return errInterrupted
|
||||||
case opErr != nil:
|
case failed:
|
||||||
return fmt.Errorf("%w: %w", errReported, opErr)
|
return errReported
|
||||||
default:
|
default:
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -282,6 +282,13 @@ func TestConfigSetKeepsFileThatWouldNotLoad(t *testing.T) {
|
|||||||
storageURLKey, testS3URL,
|
storageURLKey, testS3URL,
|
||||||
"s3.secret_access_key is required for s3:// URLs; " +
|
"s3.secret_access_key is required for s3:// URLs; " +
|
||||||
"set s3.access_key_id and s3.secret_access_key first"},
|
"set s3.access_key_id and s3.secret_access_key first"},
|
||||||
|
// rclone:// URLs that no command could open.
|
||||||
|
{configWithoutRecipients, storageURLKey, "rclone:///backups",
|
||||||
|
"rclone URL missing remote name"},
|
||||||
|
{configWithoutRecipients, storageURLKey, "rclone://dav,user=x/backups",
|
||||||
|
"rclone URL must not carry parameters in the remote name"},
|
||||||
|
{configWithoutRecipients, storageURLKey, "rclone://dav/backups?x=1",
|
||||||
|
`unknown query parameter in storage URL: "x"`},
|
||||||
// With its reference filled in, the config loads.
|
// With its reference filled in, the config loads.
|
||||||
{levelReference, "blob_size_limit", "1MB",
|
{levelReference, "blob_size_limit", "1MB",
|
||||||
"blob_size_limit must be at least"},
|
"blob_size_limit must be at least"},
|
||||||
|
|||||||
+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")
|
||||||
|
}
|
||||||
+24
-37
@@ -21,6 +21,7 @@ import (
|
|||||||
"gopkg.in/yaml.v3"
|
"gopkg.in/yaml.v3"
|
||||||
"sneak.berlin/go/vaultik/internal/chunker"
|
"sneak.berlin/go/vaultik/internal/chunker"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
const appName = "vaultik"
|
const appName = "vaultik"
|
||||||
@@ -63,13 +64,8 @@ var (
|
|||||||
errBlobSizeTooSmall = errors.New(
|
errBlobSizeTooSmall = errors.New(
|
||||||
"blob_size_limit must be at least the largest chunk the chunker can " +
|
"blob_size_limit must be at least the largest chunk the chunker can " +
|
||||||
"emit (chunk_size times the FastCDC size spread)")
|
"emit (chunk_size times the FastCDC size spread)")
|
||||||
errBadCompression = errors.New("compression_level must be between 1 and 19")
|
errBadCompression = errors.New("compression_level must be between 1 and 19")
|
||||||
errBadS3PartSize = errors.New("s3.part_size must be between 5MiB and 5GiB")
|
errBadS3PartSize = errors.New("s3.part_size must be between 5MiB and 5GiB")
|
||||||
errBadStorageScheme = errors.New(
|
|
||||||
"storage_url must start with s3://, file://, or rclone://")
|
|
||||||
errFileURLNotAbsolute = errors.New(
|
|
||||||
"a file:// storage_url needs an absolute path, " +
|
|
||||||
"as in file:///path/to/backup")
|
|
||||||
errIndexPathNotAbsolute = errors.New(
|
errIndexPathNotAbsolute = errors.New(
|
||||||
"index_path and VAULTIK_INDEX_PATH need an absolute path, " +
|
"index_path and VAULTIK_INDEX_PATH need an absolute path, " +
|
||||||
"as in ~/.local/share/vaultik/index.sqlite")
|
"as in ~/.local/share/vaultik/index.sqlite")
|
||||||
@@ -557,38 +553,29 @@ func (c *Config) validateStorage() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// validateStorageURL validates URL-based storage configuration. File and
|
// validateStorageURL checks storage_url with the same parser that opens
|
||||||
// rclone URLs need no credentials; S3 URLs require the legacy s3.*
|
// the destination, so a value every command would refuse fails at load.
|
||||||
// credential fields. A file URL must name an absolute path: a relative one
|
// File and rclone URLs need no credentials; S3 URLs require the legacy
|
||||||
// would resolve against the working directory, so the destination would
|
// s3.* credential fields.
|
||||||
// move with it.
|
|
||||||
func (c *Config) validateStorageURL() error {
|
func (c *Config) validateStorageURL() error {
|
||||||
switch {
|
parsed, err := storageurl.Parse(c.StorageURL)
|
||||||
case strings.HasPrefix(c.StorageURL, "file://"):
|
if err != nil {
|
||||||
// storage.ParseStorageURL applies the same rule, but config
|
return fmt.Errorf("invalid storage_url: %w", err)
|
||||||
// cannot import storage, which imports config.
|
|
||||||
if !strings.HasPrefix(c.StorageURL, "file:///") {
|
|
||||||
return errFileURLNotAbsolute
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
case strings.HasPrefix(c.StorageURL, "rclone://"):
|
|
||||||
// Rclone storage uses rclone's own config
|
|
||||||
return nil
|
|
||||||
case strings.HasPrefix(c.StorageURL, "s3://"):
|
|
||||||
// S3 storage needs credentials
|
|
||||||
if c.S3.AccessKeyID == "" {
|
|
||||||
return fmt.Errorf("%w for s3:// URLs", ErrS3KeyIDRequired)
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.S3.SecretAccessKey == "" {
|
|
||||||
return fmt.Errorf("%w for s3:// URLs", ErrS3SecretRequired)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
default:
|
|
||||||
return errBadStorageScheme
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if parsed.Scheme != storageurl.SchemeS3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.S3.AccessKeyID == "" {
|
||||||
|
return fmt.Errorf("%w for s3:// URLs", ErrS3KeyIDRequired)
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.S3.SecretAccessKey == "" {
|
||||||
|
return fmt.Errorf("%w for s3:// URLs", ErrS3SecretRequired)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Module exports the config module for fx dependency injection.
|
// Module exports the config module for fx dependency injection.
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/chunker"
|
"sneak.berlin/go/vaultik/internal/chunker"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -502,8 +503,8 @@ func TestLoadRejectsRelativeFileURL(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
_, err = Load(path)
|
_, err = Load(path)
|
||||||
if !errors.Is(err, errFileURLNotAbsolute) {
|
if !errors.Is(err, storageurl.ErrRelativeFilePath) {
|
||||||
t.Fatalf("Load() error = %v, want errFileURLNotAbsolute", err)
|
t.Fatalf("Load() error = %v, want storageurl.ErrRelativeFilePath", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !strings.Contains(err.Error(), "absolute path") {
|
if !strings.Contains(err.Error(), "absolute path") {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
// FileStorer implements Storer using the local filesystem.
|
// FileStorer implements Storer using the local filesystem.
|
||||||
@@ -288,7 +289,7 @@ func (f *FileStorer) DeletePartialUploads(ctx context.Context, prefix string) er
|
|||||||
// Info returns human-readable storage location information.
|
// Info returns human-readable storage location information.
|
||||||
func (f *FileStorer) Info() Info {
|
func (f *FileStorer) Info() Info {
|
||||||
return Info{
|
return Info{
|
||||||
Type: schemeFile,
|
Type: storageurl.SchemeFile,
|
||||||
Location: f.basePath,
|
Location: f.basePath,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,14 +2,20 @@ package storage
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
"sneak.berlin/go/vaultik/internal/s3"
|
"sneak.berlin/go/vaultik/internal/s3"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrUnsupportedStorage is returned for a parsed storage URL whose scheme
|
||||||
|
// has no storage backend.
|
||||||
|
var ErrUnsupportedStorage = errors.New("unsupported storage scheme")
|
||||||
|
|
||||||
// defaultS3Region is used when neither the URL nor the config specify one.
|
// defaultS3Region is used when neither the URL nor the config specify one.
|
||||||
const defaultS3Region = "us-east-1"
|
const defaultS3Region = "us-east-1"
|
||||||
|
|
||||||
@@ -40,19 +46,19 @@ func NewStorer(cfg *config.Config) (Storer, error) {
|
|||||||
|
|
||||||
//nolint:ireturn // factory intentionally returns the Storer interface
|
//nolint:ireturn // factory intentionally returns the Storer interface
|
||||||
func storerFromURL(rawURL string, cfg *config.Config) (Storer, error) {
|
func storerFromURL(rawURL string, cfg *config.Config) (Storer, error) {
|
||||||
parsed, err := ParseStorageURL(rawURL)
|
parsed, err := storageurl.Parse(rawURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("parsing storage URL: %w", err)
|
return nil, fmt.Errorf("parsing storage URL: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
switch parsed.Scheme {
|
switch parsed.Scheme {
|
||||||
case schemeFile:
|
case storageurl.SchemeFile:
|
||||||
return NewFileStorer(parsed.Prefix)
|
return NewFileStorer(parsed.Prefix)
|
||||||
|
|
||||||
case schemeS3:
|
case storageurl.SchemeS3:
|
||||||
return storerFromParsedS3URL(parsed, cfg)
|
return storerFromParsedS3URL(parsed, cfg)
|
||||||
|
|
||||||
case schemeRclone:
|
case storageurl.SchemeRclone:
|
||||||
return NewRcloneStorer(
|
return NewRcloneStorer(
|
||||||
context.Background(), parsed.RcloneRemote, parsed.Prefix)
|
context.Background(), parsed.RcloneRemote, parsed.Prefix)
|
||||||
|
|
||||||
@@ -65,7 +71,7 @@ func storerFromURL(rawURL string, cfg *config.Config) (Storer, error) {
|
|||||||
// filling endpoint protocol and region defaults from the config.
|
// filling endpoint protocol and region defaults from the config.
|
||||||
//
|
//
|
||||||
//nolint:ireturn // factory intentionally returns the Storer interface
|
//nolint:ireturn // factory intentionally returns the Storer interface
|
||||||
func storerFromParsedS3URL(parsed *URL, cfg *config.Config) (Storer, error) {
|
func storerFromParsedS3URL(parsed *storageurl.URL, cfg *config.Config) (Storer, error) {
|
||||||
// Build endpoint URL
|
// Build endpoint URL
|
||||||
endpoint := parsed.Endpoint
|
endpoint := parsed.Endpoint
|
||||||
if endpoint == "" {
|
if endpoint == "" {
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ import (
|
|||||||
"github.com/rclone/rclone/fs/config"
|
"github.com/rclone/rclone/fs/config"
|
||||||
"github.com/rclone/rclone/fs/config/configfile"
|
"github.com/rclone/rclone/fs/config/configfile"
|
||||||
"github.com/rclone/rclone/fs/operations"
|
"github.com/rclone/rclone/fs/operations"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
|
|
||||||
// Import all rclone backends
|
// Import all rclone backends
|
||||||
_ "github.com/rclone/rclone/backend/all"
|
_ "github.com/rclone/rclone/backend/all"
|
||||||
@@ -266,7 +267,7 @@ func (r *RcloneStorer) Info() Info {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return Info{
|
return Info{
|
||||||
Type: schemeRclone,
|
Type: storageurl.SchemeRclone,
|
||||||
Location: location,
|
Location: location,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
package storage
|
// Package storageurl parses the storage_url config value. The config
|
||||||
|
// package uses it to refuse a bad value when the config loads; the storage
|
||||||
|
// package uses it to open the destination.
|
||||||
|
package storageurl
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
@@ -10,9 +13,9 @@ import (
|
|||||||
|
|
||||||
// Storage URL scheme names.
|
// Storage URL scheme names.
|
||||||
const (
|
const (
|
||||||
schemeFile = "file"
|
SchemeFile = "file"
|
||||||
schemeS3 = "s3"
|
SchemeS3 = "s3"
|
||||||
schemeRclone = "rclone"
|
SchemeRclone = "rclone"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Sentinel errors for storage URL parsing.
|
// Sentinel errors for storage URL parsing.
|
||||||
@@ -25,8 +28,7 @@ var (
|
|||||||
ErrMissingRemote = errors.New("rclone URL missing remote name")
|
ErrMissingRemote = errors.New("rclone URL missing remote name")
|
||||||
ErrUnsupportedScheme = errors.New(
|
ErrUnsupportedScheme = errors.New(
|
||||||
"unsupported URL scheme: must start with s3://, file://, or rclone://")
|
"unsupported URL scheme: must start with s3://, file://, or rclone://")
|
||||||
ErrUnsupportedStorage = errors.New("unsupported storage scheme")
|
ErrURLCredentials = errors.New(
|
||||||
ErrURLCredentials = errors.New(
|
|
||||||
"storage URL must not carry credentials; " +
|
"storage URL must not carry credentials; " +
|
||||||
"set s3.access_key_id and s3.secret_access_key in the config instead")
|
"set s3.access_key_id and s3.secret_access_key in the config instead")
|
||||||
ErrURLUnknownParam = errors.New("unknown query parameter in storage URL")
|
ErrURLUnknownParam = errors.New("unknown query parameter in storage URL")
|
||||||
@@ -49,12 +51,12 @@ type URL struct {
|
|||||||
RcloneRemote string // rclone remote name (for rclone:// URLs)
|
RcloneRemote string // rclone remote name (for rclone:// URLs)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ParseStorageURL parses a storage URL string.
|
// Parse parses a storage URL string.
|
||||||
// Supported formats:
|
// Supported formats:
|
||||||
// - s3://bucket/prefix?endpoint=host®ion=us-east-1&ssl=true
|
// - s3://bucket/prefix?endpoint=host®ion=us-east-1&ssl=true
|
||||||
// - file:///absolute/path/to/backup
|
// - file:///absolute/path/to/backup
|
||||||
// - rclone://remote/path/to/backups
|
// - rclone://remote/path/to/backups
|
||||||
func ParseStorageURL(rawURL string) (*URL, error) {
|
func Parse(rawURL string) (*URL, error) {
|
||||||
if rawURL == "" {
|
if rawURL == "" {
|
||||||
return nil, ErrEmptyStorageURL
|
return nil, ErrEmptyStorageURL
|
||||||
}
|
}
|
||||||
@@ -92,7 +94,7 @@ func parseFileURL(rawPath string) (*URL, error) {
|
|||||||
return nil, fmt.Errorf("invalid file URL path: %w", err)
|
return nil, fmt.Errorf("invalid file URL path: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return &URL{Scheme: schemeFile, Prefix: path}, nil
|
return &URL{Scheme: SchemeFile, Prefix: path}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseS3URL parses an s3://bucket/prefix URL. It rejects credentials in
|
// parseS3URL parses an s3://bucket/prefix URL. It rejects credentials in
|
||||||
@@ -135,7 +137,7 @@ func parseS3URL(rawURL string) (*URL, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return &URL{
|
return &URL{
|
||||||
Scheme: schemeS3,
|
Scheme: SchemeS3,
|
||||||
Bucket: bucket,
|
Bucket: bucket,
|
||||||
Prefix: strings.TrimPrefix(u.Path, "/"),
|
Prefix: strings.TrimPrefix(u.Path, "/"),
|
||||||
Endpoint: query.Get("endpoint"),
|
Endpoint: query.Get("endpoint"),
|
||||||
@@ -189,7 +191,7 @@ func parseRcloneURL(rawURL string) (*URL, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return &URL{
|
return &URL{
|
||||||
Scheme: schemeRclone,
|
Scheme: SchemeRclone,
|
||||||
Prefix: strings.TrimPrefix(u.Path, "/"),
|
Prefix: strings.TrimPrefix(u.Path, "/"),
|
||||||
RcloneRemote: remote,
|
RcloneRemote: remote,
|
||||||
}, nil
|
}, nil
|
||||||
@@ -226,9 +228,9 @@ func wrapParseError(err error) error {
|
|||||||
// String returns a human-readable representation of the storage URL.
|
// String returns a human-readable representation of the storage URL.
|
||||||
func (u *URL) String() string {
|
func (u *URL) String() string {
|
||||||
switch u.Scheme {
|
switch u.Scheme {
|
||||||
case schemeFile:
|
case SchemeFile:
|
||||||
return "file://" + u.Prefix
|
return "file://" + u.Prefix
|
||||||
case schemeS3:
|
case SchemeS3:
|
||||||
endpoint := u.Endpoint
|
endpoint := u.Endpoint
|
||||||
if endpoint == "" {
|
if endpoint == "" {
|
||||||
endpoint = "s3.amazonaws.com"
|
endpoint = "s3.amazonaws.com"
|
||||||
@@ -239,7 +241,7 @@ func (u *URL) String() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return fmt.Sprintf("s3://%s (endpoint: %s)", u.Bucket, endpoint)
|
return fmt.Sprintf("s3://%s (endpoint: %s)", u.Bucket, endpoint)
|
||||||
case schemeRclone:
|
case SchemeRclone:
|
||||||
if u.Prefix != "" {
|
if u.Prefix != "" {
|
||||||
return fmt.Sprintf("rclone://%s/%s", u.RcloneRemote, u.Prefix)
|
return fmt.Sprintf("rclone://%s/%s", u.RcloneRemote, u.Prefix)
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
package storage_test
|
package storageurl_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
@@ -6,12 +6,12 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
"sneak.berlin/go/vaultik/internal/storageurl"
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestParseStorageURLValid checks that each supported scheme parses into
|
// TestParseValid checks that each supported scheme parses into the
|
||||||
// the expected fields, since those fields decide which backend is built.
|
// expected fields, since those fields decide which backend is built.
|
||||||
func TestParseStorageURLValid(t *testing.T) {
|
func TestParseValid(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -22,27 +22,27 @@ func TestParseStorageURLValid(t *testing.T) {
|
|||||||
cases := []struct {
|
cases := []struct {
|
||||||
name string
|
name string
|
||||||
raw string
|
raw string
|
||||||
want *storage.URL
|
want *storageurl.URL
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "file absolute path",
|
name: "file absolute path",
|
||||||
raw: "file:///var/backups/vaultik",
|
raw: "file:///var/backups/vaultik",
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/var/backups/vaultik"},
|
want: &storageurl.URL{Scheme: fileScheme, Prefix: "/var/backups/vaultik"},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "file percent-escaped path is decoded",
|
name: "file percent-escaped path is decoded",
|
||||||
raw: "file:///Volumes/my%20stick/backup",
|
raw: "file:///Volumes/my%20stick/backup",
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
want: &storageurl.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "file path with a literal space",
|
name: "file path with a literal space",
|
||||||
raw: "file:///Volumes/my stick/backup",
|
raw: "file:///Volumes/my stick/backup",
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
want: &storageurl.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 bucket and prefix, ssl defaults on",
|
name: "s3 bucket and prefix, ssl defaults on",
|
||||||
raw: "s3://mybucket/backups/host",
|
raw: "s3://mybucket/backups/host",
|
||||||
want: &storage.URL{
|
want: &storageurl.URL{
|
||||||
Scheme: "s3", Bucket: bucket,
|
Scheme: "s3", Bucket: bucket,
|
||||||
Prefix: "backups/host", UseSSL: true,
|
Prefix: "backups/host", UseSSL: true,
|
||||||
},
|
},
|
||||||
@@ -50,12 +50,12 @@ func TestParseStorageURLValid(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "s3 bucket only",
|
name: "s3 bucket only",
|
||||||
raw: "s3://mybucket",
|
raw: "s3://mybucket",
|
||||||
want: &storage.URL{Scheme: "s3", Bucket: bucket, UseSSL: true},
|
want: &storageurl.URL{Scheme: "s3", Bucket: bucket, UseSSL: true},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 with endpoint, region, ssl off",
|
name: "s3 with endpoint, region, ssl off",
|
||||||
raw: "s3://mybucket?endpoint=minio.example.com®ion=us-west-2&ssl=false",
|
raw: "s3://mybucket?endpoint=minio.example.com®ion=us-west-2&ssl=false",
|
||||||
want: &storage.URL{
|
want: &storageurl.URL{
|
||||||
Scheme: "s3", Bucket: bucket,
|
Scheme: "s3", Bucket: bucket,
|
||||||
Endpoint: "minio.example.com", Region: "us-west-2", UseSSL: false,
|
Endpoint: "minio.example.com", Region: "us-west-2", UseSSL: false,
|
||||||
},
|
},
|
||||||
@@ -63,14 +63,14 @@ func TestParseStorageURLValid(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "rclone remote and path",
|
name: "rclone remote and path",
|
||||||
raw: "rclone://gdrive/backups/host",
|
raw: "rclone://gdrive/backups/host",
|
||||||
want: &storage.URL{
|
want: &storageurl.URL{
|
||||||
Scheme: "rclone", RcloneRemote: "gdrive", Prefix: "backups/host",
|
Scheme: "rclone", RcloneRemote: "gdrive", Prefix: "backups/host",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "rclone remote only",
|
name: "rclone remote only",
|
||||||
raw: "rclone://gdrive",
|
raw: "rclone://gdrive",
|
||||||
want: &storage.URL{Scheme: "rclone", RcloneRemote: "gdrive"},
|
want: &storageurl.URL{Scheme: "rclone", RcloneRemote: "gdrive"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,22 +78,22 @@ func TestParseStorageURLValid(t *testing.T) {
|
|||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
got, err := storage.ParseStorageURL(tc.raw)
|
got, err := storageurl.Parse(tc.raw)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("ParseStorageURL(%q) returned error: %v", tc.raw, err)
|
t.Fatalf("Parse(%q) returned error: %v", tc.raw, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !reflect.DeepEqual(got, tc.want) {
|
if !reflect.DeepEqual(got, tc.want) {
|
||||||
t.Errorf("ParseStorageURL(%q) = %+v, want %+v", tc.raw, got, tc.want)
|
t.Errorf("Parse(%q) = %+v, want %+v", tc.raw, got, tc.want)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestParseStorageURLErrors checks that empty, missing, and unknown-scheme
|
// TestParseErrors checks that empty, missing, and unknown-scheme inputs
|
||||||
// inputs fail with the documented sentinel errors instead of parsing to a
|
// fail with the documented sentinel errors instead of parsing to a wrong
|
||||||
// wrong destination.
|
// destination.
|
||||||
func TestParseStorageURLErrors(t *testing.T) {
|
func TestParseErrors(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
cases := []struct {
|
cases := []struct {
|
||||||
@@ -101,34 +101,33 @@ func TestParseStorageURLErrors(t *testing.T) {
|
|||||||
raw string
|
raw string
|
||||||
wantErr error
|
wantErr error
|
||||||
}{
|
}{
|
||||||
{"empty url", "", storage.ErrEmptyStorageURL},
|
{"empty url", "", storageurl.ErrEmptyStorageURL},
|
||||||
{"file empty path", "file://", storage.ErrEmptyFilePath},
|
{"file empty path", "file://", storageurl.ErrEmptyFilePath},
|
||||||
{"file relative path", "file://dest", storage.ErrRelativeFilePath},
|
{"file relative path", "file://dest", storageurl.ErrRelativeFilePath},
|
||||||
{"s3 missing bucket", "s3://", storage.ErrMissingBucket},
|
{"s3 missing bucket", "s3://", storageurl.ErrMissingBucket},
|
||||||
{"s3 missing bucket with path", "s3:///justprefix", storage.ErrMissingBucket},
|
{"s3 missing bucket with path", "s3:///justprefix", storageurl.ErrMissingBucket},
|
||||||
{"rclone missing remote", "rclone://", storage.ErrMissingRemote},
|
{"rclone missing remote", "rclone://", storageurl.ErrMissingRemote},
|
||||||
{"unknown scheme", "gs://bucket/x", storage.ErrUnsupportedScheme},
|
{"unknown scheme", "gs://bucket/x", storageurl.ErrUnsupportedScheme},
|
||||||
{"no scheme", "/local/path", storage.ErrUnsupportedScheme},
|
{"no scheme", "/local/path", storageurl.ErrUnsupportedScheme},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
_, err := storageurl.Parse(tc.raw)
|
||||||
if !errors.Is(err, tc.wantErr) {
|
if !errors.Is(err, tc.wantErr) {
|
||||||
t.Errorf("ParseStorageURL(%q) error = %v, want %v",
|
t.Errorf("Parse(%q) error = %v, want %v",
|
||||||
tc.raw, err, tc.wantErr)
|
tc.raw, err, tc.wantErr)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestParseStorageURLRejectsCredentials checks that a URL carrying
|
// TestParseRejectsCredentials checks that a URL carrying credentials in
|
||||||
// credentials in its userinfo or in an unknown query parameter is
|
// its userinfo or in an unknown query parameter is rejected, and that the
|
||||||
// rejected, and that the error never echoes the secret-bearing URL back
|
// error never echoes the secret-bearing URL back into logs or output.
|
||||||
// into logs or output.
|
func TestParseRejectsCredentials(t *testing.T) {
|
||||||
func TestParseStorageURLRejectsCredentials(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
// Split so the literals never form a "user:pass@" URL pattern that
|
// Split so the literals never form a "user:pass@" URL pattern that
|
||||||
@@ -147,44 +146,44 @@ func TestParseStorageURLRejectsCredentials(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "s3 userinfo",
|
name: "s3 userinfo",
|
||||||
raw: "s3://" + key + ":" + secret + "@mybucket/prefix",
|
raw: "s3://" + key + ":" + secret + "@mybucket/prefix",
|
||||||
wantErr: storage.ErrURLCredentials,
|
wantErr: storageurl.ErrURLCredentials,
|
||||||
secrets: []string{key, secret, "mybucket"},
|
secrets: []string{key, secret, "mybucket"},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 userinfo in endpoint",
|
name: "s3 userinfo in endpoint",
|
||||||
raw: "s3://mybucket?endpoint=https://" +
|
raw: "s3://mybucket?endpoint=https://" +
|
||||||
key + ":" + secret + "@minio.example.com",
|
key + ":" + secret + "@minio.example.com",
|
||||||
wantErr: storage.ErrURLCredentials,
|
wantErr: storageurl.ErrURLCredentials,
|
||||||
secrets: []string{key, secret},
|
secrets: []string{key, secret},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 userinfo in endpoint without scheme",
|
name: "s3 userinfo in endpoint without scheme",
|
||||||
raw: "s3://mybucket?endpoint=" + key + ":" + secret + "@minio.example.com",
|
raw: "s3://mybucket?endpoint=" + key + ":" + secret + "@minio.example.com",
|
||||||
wantErr: storage.ErrURLCredentials,
|
wantErr: storageurl.ErrURLCredentials,
|
||||||
secrets: []string{key, secret},
|
secrets: []string{key, secret},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 unknown query param",
|
name: "s3 unknown query param",
|
||||||
raw: "s3://mybucket?access_key=" + key + "&secret=" + secret,
|
raw: "s3://mybucket?access_key=" + key + "&secret=" + secret,
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
wantErr: storageurl.ErrURLUnknownParam,
|
||||||
secrets: []string{key, secret},
|
secrets: []string{key, secret},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 misspelt endpoint",
|
name: "s3 misspelt endpoint",
|
||||||
raw: "s3://mybucket?endpiont=minio.example.com",
|
raw: "s3://mybucket?endpiont=minio.example.com",
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
wantErr: storageurl.ErrURLUnknownParam,
|
||||||
secrets: nil,
|
secrets: nil,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "rclone userinfo",
|
name: "rclone userinfo",
|
||||||
raw: "rclone://user:" + secret + "@gdrive/backups",
|
raw: "rclone://user:" + secret + "@gdrive/backups",
|
||||||
wantErr: storage.ErrURLCredentials,
|
wantErr: storageurl.ErrURLCredentials,
|
||||||
secrets: []string{secret},
|
secrets: []string{secret},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "rclone query param",
|
name: "rclone query param",
|
||||||
raw: "rclone://gdrive/backups?token=" + secret,
|
raw: "rclone://gdrive/backups?token=" + secret,
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
wantErr: storageurl.ErrURLUnknownParam,
|
||||||
secrets: []string{secret},
|
secrets: []string{secret},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -193,9 +192,9 @@ func TestParseStorageURLRejectsCredentials(t *testing.T) {
|
|||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
_, err := storageurl.Parse(tc.raw)
|
||||||
if !errors.Is(err, tc.wantErr) {
|
if !errors.Is(err, tc.wantErr) {
|
||||||
t.Fatalf("ParseStorageURL(%q) error = %v, want %v",
|
t.Fatalf("Parse(%q) error = %v, want %v",
|
||||||
tc.raw, err, tc.wantErr)
|
tc.raw, err, tc.wantErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -216,11 +215,11 @@ func TestParseStorageURLRejectsCredentials(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestParseStorageURLRejectsRcloneRemoteParams checks that an rclone
|
// TestParseRejectsRcloneRemoteParams checks that an rclone remote name
|
||||||
// remote name carrying parameters (rclone's "remote,param=value" form,
|
// carrying parameters (rclone's "remote,param=value" form, which can hold
|
||||||
// which can hold a credential) is rejected without echoing the value,
|
// a credential) is rejected without echoing the value, including the URLs
|
||||||
// including the URLs that url.Parse itself refuses.
|
// that url.Parse itself refuses.
|
||||||
func TestParseStorageURLRejectsRcloneRemoteParams(t *testing.T) {
|
func TestParseRejectsRcloneRemoteParams(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
cases := []struct {
|
cases := []struct {
|
||||||
@@ -249,10 +248,10 @@ func TestParseStorageURLRejectsRcloneRemoteParams(t *testing.T) {
|
|||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
_, err := storageurl.Parse(tc.raw)
|
||||||
if !errors.Is(err, storage.ErrRcloneRemoteParams) {
|
if !errors.Is(err, storageurl.ErrRcloneRemoteParams) {
|
||||||
t.Fatalf("ParseStorageURL(%q) error = %v, want %v",
|
t.Fatalf("Parse(%q) error = %v, want %v",
|
||||||
tc.raw, err, storage.ErrRcloneRemoteParams)
|
tc.raw, err, storageurl.ErrRcloneRemoteParams)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, secret := range tc.secrets {
|
for _, secret := range tc.secrets {
|
||||||
@@ -264,10 +263,10 @@ func TestParseStorageURLRejectsRcloneRemoteParams(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestParseStorageURLRejectsUndecodableQuery checks that an s3 or rclone
|
// TestParseRejectsUndecodableQuery checks that an s3 or rclone URL whose
|
||||||
// URL whose query cannot be decoded is rejected, not read with that part
|
// query cannot be decoded is rejected, not read with that part of the
|
||||||
// of the query left out, and that the error does not echo it.
|
// query left out, and that the error does not echo it.
|
||||||
func TestParseStorageURLRejectsUndecodableQuery(t *testing.T) {
|
func TestParseRejectsUndecodableQuery(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -303,14 +302,14 @@ func TestParseStorageURLRejectsUndecodableQuery(t *testing.T) {
|
|||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
_, err := storageurl.Parse(tc.raw)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatalf("ParseStorageURL(%q) returned no error", tc.raw)
|
t.Fatalf("Parse(%q) returned no error", tc.raw)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !errors.Is(err, storage.ErrURLBadQuery) {
|
if !errors.Is(err, storageurl.ErrURLBadQuery) {
|
||||||
t.Errorf("ParseStorageURL(%q) error = %v, want %v",
|
t.Errorf("Parse(%q) error = %v, want %v",
|
||||||
tc.raw, err, storage.ErrURLBadQuery)
|
tc.raw, err, storageurl.ErrURLBadQuery)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, s := range []string{key, secret, "minio.example.com"} {
|
for _, s := range []string{key, secret, "minio.example.com"} {
|
||||||
@@ -322,17 +321,17 @@ func TestParseStorageURLRejectsUndecodableQuery(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestParseStorageURLParseFailureHidesURL checks that when url.Parse
|
// TestParseFailureHidesURL checks that when url.Parse itself fails, the
|
||||||
// itself fails, the wrapped error carries only the inner cause, not the
|
// wrapped error carries only the inner cause, not the *url.Error whose
|
||||||
// *url.Error whose text embeds the raw (possibly credential-bearing) URL.
|
// text embeds the raw (possibly credential-bearing) URL.
|
||||||
func TestParseStorageURLParseFailureHidesURL(t *testing.T) {
|
func TestParseFailureHidesURL(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const raw = "s3://mybucket/%zz"
|
const raw = "s3://mybucket/%zz"
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(raw)
|
_, err := storageurl.Parse(raw)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatalf("ParseStorageURL(%q) returned no error", raw)
|
t.Fatalf("Parse(%q) returned no error", raw)
|
||||||
}
|
}
|
||||||
|
|
||||||
if strings.Contains(err.Error(), "mybucket") {
|
if strings.Contains(err.Error(), "mybucket") {
|
||||||
@@ -25,13 +25,9 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/types"
|
"sneak.berlin/go/vaultik/internal/types"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrFilesFailedRestore is returned when --skip-errors skipped files the
|
|
||||||
// restore could not write. Every other file was restored, so the caller
|
|
||||||
// can report it apart from a failed restore.
|
|
||||||
var ErrFilesFailedRestore = errors.New("file(s) failed to restore")
|
|
||||||
|
|
||||||
// Sentinel errors for restore failures.
|
// Sentinel errors for restore failures.
|
||||||
var (
|
var (
|
||||||
|
errFilesFailedRestore = errors.New("file(s) failed to restore")
|
||||||
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
||||||
errFilesFailedVerify = errors.New("files failed verification")
|
errFilesFailedVerify = errors.New("files failed verification")
|
||||||
errDecryptionKeyRequired = errors.New(
|
errDecryptionKeyRequired = errors.New(
|
||||||
@@ -205,9 +201,9 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// finishRestore prints the restore summary and the post-restore
|
// finishRestore prints the restore summary and the post-restore
|
||||||
// warnings, runs optional verification, and returns the error the
|
// warnings, runs optional verification, and converts any failed-file
|
||||||
// restore ends with: one for the files --skip-errors skipped, one for
|
// count into an error. Otherwise it returns unmatchedErr, the error for
|
||||||
// unmatchedErr, the requested paths that matched nothing, or nil.
|
// the requested paths that matched nothing (nil when there are none).
|
||||||
func (v *Vaultik) finishRestore(
|
func (v *Vaultik) finishRestore(
|
||||||
repos *database.Repositories,
|
repos *database.Repositories,
|
||||||
files []*database.File,
|
files []*database.File,
|
||||||
@@ -254,18 +250,11 @@ func (v *Vaultik) finishRestore(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
switch {
|
if result.FilesFailed > 0 {
|
||||||
case result.FilesFailed > 0 && unmatchedErr != nil:
|
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
||||||
// A requested path that matched nothing outweighs skipped files:
|
|
||||||
// the error wraps only unmatchedErr, so the command does not exit
|
|
||||||
// as a restore that only skipped files.
|
|
||||||
return fmt.Errorf("%w; %d %s",
|
|
||||||
unmatchedErr, result.FilesFailed, ErrFilesFailedRestore.Error())
|
|
||||||
case result.FilesFailed > 0:
|
|
||||||
return fmt.Errorf("%d %w", result.FilesFailed, ErrFilesFailedRestore)
|
|
||||||
default:
|
|
||||||
return unmatchedErr
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return unmatchedErr
|
||||||
}
|
}
|
||||||
|
|
||||||
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
// warnIfOwnershipNotPreserved warns once if some entry restored under
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ func TestRestoreFreesBlobsNoPendingFileNeeds(t *testing.T) {
|
|||||||
TargetDir: restoreDir,
|
TargetDir: restoreDir,
|
||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, ErrFilesFailedRestore)
|
require.ErrorIs(t, err, errFilesFailedRestore)
|
||||||
|
|
||||||
requireRestoredFiles(t, fs, restoreDir, originals)
|
requireRestoredFiles(t, fs, restoreDir, originals)
|
||||||
assert.LessOrEqualf(t, peak, 1,
|
assert.LessOrEqualf(t, peak, 1,
|
||||||
|
|||||||
@@ -49,7 +49,8 @@ var ErrFilesUnreadable = errors.New("file(s) could not be read")
|
|||||||
// prune because the scan found nothing in a configured path of a
|
// prune because the scan found nothing in a configured path of a
|
||||||
// snapshot, as in the mount point of a volume that is not mounted. The
|
// snapshot, as in the mount point of a volume that is not mounted. The
|
||||||
// snapshots are complete and kept, so the caller can report it apart
|
// snapshots are complete and kept, so the caller can report it apart
|
||||||
// from a failed backup.
|
// from a failed backup. A run that also skipped unreadable files
|
||||||
|
// returns ErrFilesUnreadable instead.
|
||||||
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
||||||
|
|
||||||
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
// ErrVolumeNotMounted is returned when --prune skipped the post-backup
|
||||||
@@ -58,8 +59,8 @@ var ErrSourcePathEmpty = errors.New("source path(s) were empty")
|
|||||||
// mounted there is not mounted, the run found no entry in it, or the
|
// mounted there is not mounted, the run found no entry in it, or the
|
||||||
// directory is no longer backed up. The snapshots are complete and
|
// directory is no longer backed up. The snapshots are complete and
|
||||||
// kept, so the caller can report it apart from a failed backup. A run
|
// kept, so the caller can report it apart from a failed backup. A run
|
||||||
// that also found a configured path empty returns ErrSourcePathEmpty
|
// that also skipped unreadable files or found a configured path empty
|
||||||
// instead.
|
// returns ErrFilesUnreadable or ErrSourcePathEmpty instead.
|
||||||
var ErrVolumeNotMounted = errors.New(
|
var ErrVolumeNotMounted = errors.New(
|
||||||
"mount point(s) an earlier snapshot recorded were not found")
|
"mount point(s) an earlier snapshot recorded were not found")
|
||||||
|
|
||||||
@@ -242,29 +243,15 @@ func (v *Vaultik) skipPostBackupPrune(
|
|||||||
if filesUnreadable > 0 {
|
if filesUnreadable > 0 {
|
||||||
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
v.UI.Warningf("Skipped the post-backup prune because %d file(s) "+
|
||||||
"could not be read; older snapshots are kept.", filesUnreadable)
|
"could not be read; older snapshots are kept.", filesUnreadable)
|
||||||
}
|
|
||||||
|
|
||||||
var err error
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case len(emptyPaths) > 0:
|
|
||||||
err = fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
|
||||||
case len(unmountedPaths) > 0:
|
|
||||||
err = fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
return fmt.Errorf("%d %w", filesUnreadable, ErrFilesUnreadable)
|
||||||
}
|
}
|
||||||
|
|
||||||
// An empty path or a missing volume can mean a whole volume is not
|
if len(emptyPaths) > 0 {
|
||||||
// in the backup, which outweighs skipped files: the error wraps only
|
return fmt.Errorf("%d %w", len(emptyPaths), ErrSourcePathEmpty)
|
||||||
// the former, so the command does not exit as a backup that only
|
|
||||||
// skipped files.
|
|
||||||
if filesUnreadable > 0 {
|
|
||||||
return fmt.Errorf("%w; %d %s",
|
|
||||||
err, filesUnreadable, ErrFilesUnreadable.Error())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return err
|
return fmt.Errorf("%d %w", len(unmountedPaths), ErrVolumeNotMounted)
|
||||||
}
|
}
|
||||||
|
|
||||||
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
// finishCreateSnapshot ends a run whose snapshots are all complete and
|
||||||
|
|||||||
@@ -176,11 +176,8 @@ func TestBackupThroughSymlinkWhoseTargetIsGoneDoesNotPrune(t *testing.T) {
|
|||||||
|
|
||||||
// A backup under --skip-errors --prune that both skipped a file it could
|
// A backup under --skip-errors --prune that both skipped a file it could
|
||||||
// not read and found nothing in a configured path names the empty path
|
// not read and found nothing in a configured path names the empty path
|
||||||
// too when it skips the prune. It ends with the empty path's error, which
|
// too when it skips the prune. See
|
||||||
// names the unreadable file too but does not wrap ErrFilesUnreadable, so
|
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
||||||
// the command does not exit as a backup that only skipped files. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/388 and
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/439.
|
|
||||||
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
@@ -210,10 +207,7 @@ func TestBackupWithEmptySourcePathAndUnreadableFileNamesBoth(t *testing.T) {
|
|||||||
SkipErrors: true,
|
SkipErrors: true,
|
||||||
Snapshots: []string{snapshotName},
|
Snapshots: []string{snapshotName},
|
||||||
})
|
})
|
||||||
require.ErrorIs(t, err, vaultik.ErrSourcePathEmpty)
|
require.ErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
||||||
require.NotErrorIs(t, err, vaultik.ErrFilesUnreadable)
|
|
||||||
require.EqualError(t, err,
|
|
||||||
"1 source path(s) were empty; 1 file(s) could not be read")
|
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
"Skipped the post-backup prune because 1 file(s) could not be read")
|
"Skipped the post-backup prune because 1 file(s) could not be read")
|
||||||
assert.Contains(t, env.out.String(),
|
assert.Contains(t, env.out.String(),
|
||||||
|
|||||||
Reference in new issue
Block a user