Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7cf82cc1d2 | ||
|
|
d747ddef3a | ||
|
|
1df6867cd4 | ||
|
|
5ca0d46932 | ||
|
|
6a8bb2f389 | ||
|
|
5f1f8c4f66 | ||
|
|
e8ab13b526 |
No files matched your search
@@ -2,9 +2,9 @@
|
|||||||
|
|
||||||
`vaultik` is an incremental backup tool written in Go. It encrypts data using an
|
`vaultik` is an incremental backup tool written in Go. It encrypts data using an
|
||||||
`age` public key and uploads each encrypted blob directly to a remote
|
`age` public key and uploads each encrypted blob directly to a remote
|
||||||
S3-compatible object store. It requires no private keys, secrets, or credentials
|
S3-compatible object store. The backed-up system never needs the private key. A
|
||||||
(other than those required to PUT to encrypted object storage, such as S3 API
|
backup needs only the public key and the credentials to write to the object
|
||||||
keys) stored on the backed-up system.
|
store, such as S3 API keys.
|
||||||
|
|
||||||
## quickstart
|
## quickstart
|
||||||
|
|
||||||
@@ -171,6 +171,7 @@ vaultik [--config <path>] config get <key>
|
|||||||
vaultik [--config <path>] config set <key> <value>
|
vaultik [--config <path>] config set <key> <value>
|
||||||
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--prune] [--keep-newer-than <duration>]
|
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--prune] [--keep-newer-than <duration>]
|
||||||
vaultik [--config <path>] snapshot list [--json] # alias: ls
|
vaultik [--config <path>] snapshot list [--json] # alias: ls
|
||||||
|
vaultik [--config <path>] snapshot files <snapshot-id> [path] [--json]
|
||||||
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep] [--json]
|
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep] [--json]
|
||||||
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--snapshot <name>...] [--force]
|
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--snapshot <name>...] [--force]
|
||||||
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force] [--local-only] [--json] # alias: rm
|
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force] [--local-only] [--json] # alias: rm
|
||||||
@@ -223,12 +224,24 @@ the backup can delete it; the new snapshot then cannot be restored.
|
|||||||
`remote nuke` deletes everything regardless. To not depend on the grace period,
|
`remote nuke` deletes everything regardless. To not depend on the grace period,
|
||||||
give each host or user its own prefix (or directory) on the destination.
|
give each host or user its own prefix (or directory) on the destination.
|
||||||
|
|
||||||
Read-only commands — `info`, `snapshot list`, `snapshot verify`, and
|
These read-only commands do not take the lock, so they are never blocked, even
|
||||||
`remote info` — do not take the lock and are never blocked, so they run even
|
while a backup is in progress:
|
||||||
while a backup is in progress. `snapshot restore` does not take the lock either:
|
|
||||||
it writes only to the target directory you name, not the local index or the
|
- `info`
|
||||||
destination store. `config`, `database delete`, `completion`, and `version` do
|
- `snapshot list`
|
||||||
not take the lock.
|
- `snapshot files`
|
||||||
|
- `snapshot verify`
|
||||||
|
- `remote info`
|
||||||
|
|
||||||
|
`snapshot restore` does not take the lock either: it writes only to the target
|
||||||
|
directory you name, not the local index or the destination store.
|
||||||
|
|
||||||
|
These commands do not take the lock either:
|
||||||
|
|
||||||
|
- `config`
|
||||||
|
- `database delete`
|
||||||
|
- `completion`
|
||||||
|
- `version`
|
||||||
|
|
||||||
### stdout and stderr
|
### stdout and stderr
|
||||||
|
|
||||||
@@ -261,9 +274,9 @@ work as written.
|
|||||||
### 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
|
||||||
`snapshot restore` and `snapshot verify --deep`). May hold the whole
|
`snapshot restore`, `snapshot files` and `snapshot verify --deep`). May hold
|
||||||
`age-keygen` file — comments and every identity in it are accepted. Set it
|
the whole `age-keygen` file — comments and every identity in it are accepted.
|
||||||
from the file, e.g.
|
Set it from the file, e.g.
|
||||||
`export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"`, so
|
`export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"`, so
|
||||||
the key is not typed into your shell history.
|
the key is not typed into your shell history.
|
||||||
- `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
|
- `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
|
||||||
@@ -408,6 +421,26 @@ point behind.
|
|||||||
truncated listing all go to stderr through the logger, so stdout stays a
|
truncated listing all go to stderr through the logger, so stdout stays a
|
||||||
single parseable document.
|
single parseable document.
|
||||||
|
|
||||||
|
**`snapshot files`**: List the files in a snapshot without restoring it. Each
|
||||||
|
row of the table shows mode, size in bytes, modification time and path, sorted
|
||||||
|
by path.
|
||||||
|
|
||||||
|
- Requires `VAULTIK_AGE_SECRET_KEY`: the file list is only in the snapshot's
|
||||||
|
encrypted database, which the command downloads and decrypts.
|
||||||
|
- Accepts the same identifiers as `snapshot restore`.
|
||||||
|
- An optional path limits the list to that path and what is under it. A path
|
||||||
|
that matches nothing in the snapshot is an error.
|
||||||
|
- `--json`: Output an array of objects with `path`, `size`, `mode` and `mtime`.
|
||||||
|
- In the table, a path that holds a newline or another non-printable character
|
||||||
|
is shown in double quotes, with that character escaped, as in `"a\nb"`.
|
||||||
|
- The mode is in Go's file-mode notation, in the table and in `--json`. Letters
|
||||||
|
before the nine permission characters show the file type and any special bit,
|
||||||
|
as in `dtrwxrwxrwx` for a sticky directory. These letters differ from `ls -l`:
|
||||||
|
- `L`: a symbolic link, which `ls -l` shows as `l`.
|
||||||
|
- `u`: setuid, which `ls -l` shows as `s` in place of the owner's `x`.
|
||||||
|
- `g`: setgid, which `ls -l` shows as `s` in place of the group's `x`.
|
||||||
|
- `t`: sticky, which `ls -l` shows as `t` in place of the others' `x`.
|
||||||
|
|
||||||
**`snapshot verify`**: Verify snapshot integrity.
|
**`snapshot verify`**: Verify snapshot integrity.
|
||||||
|
|
||||||
- Default (shallow): checks that every blob the manifest lists is present in
|
- Default (shallow): checks that every blob the manifest lists is present in
|
||||||
@@ -435,10 +468,12 @@ destination store. Blobs are NOT touched — deleting blobs requires reading eve
|
|||||||
remaining remote manifest (the destination store may hold snapshots this host
|
remaining remote manifest (the destination store may hold snapshots this host
|
||||||
doesn't know about), which is what `vaultik prune` does. The command prints the
|
doesn't know about), which is what `vaultik prune` does. The command prints the
|
||||||
`vaultik prune` invocation to run as a follow-up only when it removed the
|
`vaultik prune` invocation to run as a follow-up only when it removed the
|
||||||
snapshot's metadata from the destination store, and never under `--json`. An ID
|
snapshot's metadata from the destination store, and never under `--json`. It
|
||||||
that names no snapshot in the local index or on the destination store is an
|
accepts the same identifiers as `snapshot restore`: a snapshot ID, or a
|
||||||
error; with `--local-only`, the snapshot must be in the local index. Local row
|
remote-only snapshot's remote key (or an unambiguous leading part of it). An
|
||||||
cleanup (files, chunks, blobs the snapshot was the last referrer for) runs
|
identifier that names no snapshot in the local index or on the destination store
|
||||||
|
is an error; with `--local-only`, the snapshot must be in the local index. Local
|
||||||
|
row cleanup (files, chunks, blobs the snapshot was the last referrer for) runs
|
||||||
automatically. If removing the snapshot's metadata from the destination store
|
automatically. If removing the snapshot's metadata from the destination store
|
||||||
fails (for example because the store is unreachable, or the local index holds
|
fails (for example because the store is unreachable, or the local index holds
|
||||||
snapshots and the destination answers that it has no `vaultik-destination.txt`),
|
snapshots and the destination answers that it has no `vaultik-destination.txt`),
|
||||||
@@ -519,6 +554,12 @@ count and blob size unknown, `null` in `--json`. A file under `blobs/` whose
|
|||||||
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
||||||
it.
|
it.
|
||||||
|
|
||||||
|
A blob that a manifest lists but the destination does not hold is reported as
|
||||||
|
missing, with a count and size. The report names each snapshot that lists a
|
||||||
|
missing blob, since that snapshot cannot be restored. The command then exits
|
||||||
|
non-zero. `--json` gives these in `missing_blob_count`, `missing_blob_size` and
|
||||||
|
`snapshots_missing_blobs`.
|
||||||
|
|
||||||
- `--json`: Output as JSON
|
- `--json`: Output as JSON
|
||||||
|
|
||||||
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
||||||
@@ -722,7 +763,7 @@ annotated example also lives in
|
|||||||
| Field | Default | Description |
|
| Field | Default | Description |
|
||||||
| -------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `age_recipients` | (required by `snapshot create`) | Age public keys for encryption. Other commands run without one, so a machine that only restores can leave it empty |
|
| `age_recipients` | (required by `snapshot create`) | Age public keys for encryption. Other commands run without one, so a machine that only restores can leave it empty |
|
||||||
| `age_secret_key` | (unset) | Age private key for decryption (`snapshot restore`, `snapshot verify --deep`). Setting it in the config file places the private key on the backed-up host, defeating the public-key-only design (see "why" above). Prefer the `VAULTIK_AGE_SECRET_KEY` environment variable, supplied only on the machine you restore from. |
|
| `age_secret_key` | (unset) | Age private key for decryption (`snapshot restore`, `snapshot files`, `snapshot verify --deep`). Setting it in the config file places the private key on the backed-up host, defeating the public-key-only design (see "why" above). Prefer the `VAULTIK_AGE_SECRET_KEY` environment variable, supplied only on the machine you restore from. |
|
||||||
| `snapshots` | (required) | Named snapshot definitions with paths and excludes |
|
| `snapshots` | (required) | Named snapshot definitions with paths and excludes |
|
||||||
| `storage_url` | | Storage backend URL (`s3://`, `file://`, `rclone://`) |
|
| `storage_url` | | Storage backend URL (`s3://`, `file://`, `rclone://`) |
|
||||||
| `s3.*` | | Legacy S3 configuration (endpoint, bucket, credentials) |
|
| `s3.*` | | Legacy S3 configuration (endpoint, bucket, credentials) |
|
||||||
@@ -839,15 +880,27 @@ environment variable is unset (https://no-color.org/).
|
|||||||
`database delete`.
|
`database delete`.
|
||||||
- **The data a command exists to produce** is written plain, with no marker and
|
- **The data a command exists to produce** is written plain, with no marker and
|
||||||
no color, because a marker would corrupt a table or a parsed document. This
|
no color, because a marker would corrupt a table or a parsed document. This
|
||||||
covers the `version`, `info`, `remote info` and `snapshot verify` reports, the
|
covers the report or table of each of these commands:
|
||||||
`snapshot list` table, `config get` values, and every `--json` document.
|
- `version`
|
||||||
`--quiet` silences the human reports and tables (`version`, `info`,
|
- `info`
|
||||||
`remote info`, `snapshot verify`, `snapshot list`) but never the
|
- `remote info`
|
||||||
machine-consumed `config get` value or the `--json` documents, which a script
|
- `snapshot verify`
|
||||||
depends on. The confirmation prompts of `database delete`, `prune`,
|
- `snapshot list`
|
||||||
`snapshot purge` and `snapshot remove`, each with what it asks to delete, are
|
- `snapshot files`
|
||||||
also written this way and always shown: they are an interactive exchange the
|
|
||||||
operator must see.
|
`config get` values and every `--json` document are written plain too.
|
||||||
|
`--quiet` silences the reports and tables above, but never a `config get`
|
||||||
|
value or a `--json` document, which a script depends on.
|
||||||
|
|
||||||
|
These commands write their confirmation prompt plain too, with what it asks
|
||||||
|
to delete:
|
||||||
|
- `database delete`
|
||||||
|
- `prune`
|
||||||
|
- `snapshot purge`
|
||||||
|
- `snapshot remove`
|
||||||
|
|
||||||
|
`--quiet` never silences these prompts: each is an interactive exchange the
|
||||||
|
operator must see.
|
||||||
|
|
||||||
`internal/ui` writes to stdout; it is the output the user asked for. The
|
`internal/ui` writes to stdout; it is the output the user asked for. The
|
||||||
exceptions are the startup banner and the error a failed command ends with,
|
exceptions are the startup banner and the error a failed command ends with,
|
||||||
|
|||||||
+17
-9
@@ -265,15 +265,23 @@ so an operator can weigh them rather than discover them.
|
|||||||
blob holds hundreds of chunks, so individual chunk lengths are not visible in
|
blob holds hundreds of chunks, so individual chunk lengths are not visible in
|
||||||
the blob's size; lowering the limit toward the chunk size begins to expose
|
the blob's size; lowering the limit toward the chunk size begins to expose
|
||||||
them.
|
them.
|
||||||
4. **Decrypted data on local disk.** Several commands stage plaintext under
|
4. **Decrypted data on local disk.** These commands stage plaintext under
|
||||||
`$TMPDIR`: `snapshot restore` writes decrypted blobs under
|
`$TMPDIR`:
|
||||||
`vaultik-blobcache-*/` (no size cap) and the decrypted metadata database at
|
- `snapshot restore`: decrypted blobs under `vaultik-blobcache-*/`, with no
|
||||||
`vaultik-restore-*/snapshot.db`; `verify --deep` writes that database at
|
size cap, and the decrypted metadata database at
|
||||||
`vaultik-verify-*/snapshot.db`; `snapshot create` keeps a plaintext copy of
|
`vaultik-restore-*/snapshot.db`.
|
||||||
the index at `vaultik-snapshot-*/snapshot.db`. These files are created `0600`
|
- `snapshot files`: the decrypted metadata database at
|
||||||
and removed on success, but a `kill -9` or a power loss leaves them behind —
|
`vaultik-restore-*/snapshot.db`.
|
||||||
delete any leftover `vaultik-*` directory under `$TMPDIR` by hand. `$TMPDIR`
|
- `verify --deep`: the decrypted metadata database at
|
||||||
should be trusted to the same degree as the restore target.
|
`vaultik-verify-*/snapshot.db`.
|
||||||
|
- `snapshot create`: a plaintext copy of the index at
|
||||||
|
`vaultik-snapshot-*/snapshot.db`.
|
||||||
|
|
||||||
|
These files are created `0600` and removed on success, but a `kill -9` or a
|
||||||
|
power loss leaves them behind — delete any leftover `vaultik-*` directory
|
||||||
|
under `$TMPDIR` by hand. `$TMPDIR` should be trusted to the same degree as
|
||||||
|
the restore target.
|
||||||
|
|
||||||
5. **Store permissions differ per command.** The backed-up host needs only PUT
|
5. **Store permissions differ per command.** The backed-up host needs only PUT
|
||||||
to run `snapshot create`: it writes blobs and metadata and neither reads nor
|
to run `snapshot create`: it writes blobs and metadata and neither reads nor
|
||||||
deletes them. Other commands need more — `snapshot verify`,
|
deletes them. Other commands need more — `snapshot verify`,
|
||||||
|
|||||||
+7
-6
@@ -38,10 +38,11 @@ const (
|
|||||||
// prune, remote nuke) write the local index or the remote store. They
|
// prune, remote nuke) write the local index or the remote store. They
|
||||||
// hold the PID lock so that at most one runs at a time.
|
// hold the PID lock so that at most one runs at a time.
|
||||||
mutating lockMode = iota
|
mutating lockMode = iota
|
||||||
// readOnly commands (info, snapshot list, snapshot verify, remote info,
|
// readOnly commands (info, snapshot list, snapshot files, snapshot
|
||||||
// snapshot restore) do not write the local index or the remote store,
|
// verify, remote info, snapshot restore) do not write the local index
|
||||||
// so they run without the lock and are never blocked by a running
|
// or the remote store, so they run without the lock and are never
|
||||||
// mutator. restore writes only to the target directory it is given.
|
// blocked by a running mutator. restore writes only to the target
|
||||||
|
// directory it is given.
|
||||||
readOnly
|
readOnly
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -310,7 +311,7 @@ func RunOperation(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// runVaultikApp runs the standard single-operation command lifecycle
|
// runVaultikApp runs the standard single-operation command lifecycle
|
||||||
// shared by the snapshot list/purge/remove and remote nuke subcommands:
|
// shared by the snapshot list/files/purge/remove and remote nuke subcommands:
|
||||||
// resolve the config, then run op against the Vaultik instance through
|
// resolve the config, then run op against the Vaultik instance through
|
||||||
// RunOperation, reporting a failure prefixed with failMsg on stderr. mode
|
// RunOperation, reporting a failure prefixed with failMsg on stderr. mode
|
||||||
// says whether the command takes the PID lock. jsonOutput marks a command
|
// says whether the command takes the PID lock. jsonOutput marks a command
|
||||||
@@ -337,7 +338,7 @@ func runVaultikApp(
|
|||||||
},
|
},
|
||||||
Mode: mode,
|
Mode: mode,
|
||||||
}, op, func(err error) {
|
}, op, func(err error) {
|
||||||
log.Error(failMsg, "error", err)
|
log.Info(failMsg, "error", err)
|
||||||
ReportErrorf("%s: %v", failMsg, err)
|
ReportErrorf("%s: %v", failMsg, err)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -268,7 +268,7 @@ func TestConfigSetKeepsFileThatWouldNotLoad(t *testing.T) {
|
|||||||
{configWithoutRecipients, "snapshots.home.paths", "/srv",
|
{configWithoutRecipients, "snapshots.home.paths", "/srv",
|
||||||
"into []string"},
|
"into []string"},
|
||||||
{configWithoutRecipients, "chunk_size", "fast",
|
{configWithoutRecipients, "chunk_size", "fast",
|
||||||
"invalid size format"},
|
`chunk_size: "fast" is not a size`},
|
||||||
// Values of the right type that fail validation.
|
// Values of the right type that fail validation.
|
||||||
{configWithoutRecipients, "compression_level", "99",
|
{configWithoutRecipients, "compression_level", "99",
|
||||||
"compression_level must be between 1 and 19"},
|
"compression_level must be between 1 and 19"},
|
||||||
|
|||||||
@@ -85,6 +85,10 @@ func emitStartupBanner(args []string, w io.Writer) {
|
|||||||
// 🛑 ERROR: format. Use it from goroutine error paths (where returning
|
// 🛑 ERROR: format. Use it from goroutine error paths (where returning
|
||||||
// an error to cobra isn't an option) and anywhere else a CLI command
|
// an error to cobra isn't an option) and anywhere else a CLI command
|
||||||
// must surface a failure outside the normal RunE return path.
|
// must surface a failure outside the normal RunE return path.
|
||||||
|
//
|
||||||
|
// This line is the one report of the failure. A caller that also logs
|
||||||
|
// the failure logs it at info level, so the record appears only under
|
||||||
|
// --verbose or --debug and the error is not printed twice.
|
||||||
func ReportErrorf(format string, args ...any) {
|
func ReportErrorf(format string, args ...any) {
|
||||||
ui.New(os.Stderr).Errorf(format, args...)
|
ui.New(os.Stderr).Errorf(format, args...)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,205 @@
|
|||||||
|
package cli //nolint:testpackage // shares the fixtures and capture helpers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"filippo.io/age"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// errorLinePrefix starts the final line that reports a failed command.
|
||||||
|
errorLinePrefix = "ERROR: "
|
||||||
|
|
||||||
|
flagVerbose = "--verbose"
|
||||||
|
cmdRestore = "restore"
|
||||||
|
|
||||||
|
// blobsDir is the directory of a destination store that holds the
|
||||||
|
// blobs.
|
||||||
|
blobsDir = "blobs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestEntryFailureIsPrintedOnce runs commands that fail after startup
|
||||||
|
// against a destination they cannot use. `info` is not among them: it
|
||||||
|
// cannot fail after startup.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntryFailureIsPrintedOnce(t *testing.T) {
|
||||||
|
for _, command := range [][]string{
|
||||||
|
{cmdSnapshot, cmdCreate},
|
||||||
|
{cmdSnapshot, cmdRemove, someSnapshotID},
|
||||||
|
{cmdSnapshot, cmdVerify, someSnapshotID},
|
||||||
|
{cmdRemote, cmdInfo},
|
||||||
|
{cmdPrune, flagJSON},
|
||||||
|
} {
|
||||||
|
for _, verbose := range []bool{false, true} {
|
||||||
|
name := fmt.Sprintf("%s verbose=%t", strings.Join(command, " "), verbose)
|
||||||
|
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
requireErrorPrintedOnce(t, verbose, append([]string{flagConfig,
|
||||||
|
writeUnusableDestinationConfig(t)}, command...)...)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEntryBlobUploadFailureIsPrintedOnce backs up to a destination
|
||||||
|
// whose blobs directory is a file, so the blob upload fails.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntryBlobUploadFailureIsPrintedOnce(t *testing.T) {
|
||||||
|
for _, verbose := range []bool{false, true} {
|
||||||
|
t.Run(fmt.Sprintf("verbose=%t", verbose), func(t *testing.T) {
|
||||||
|
configPath, storeDir := writeBackupConfig(t)
|
||||||
|
|
||||||
|
require.NoError(t, os.WriteFile(
|
||||||
|
filepath.Join(storeDir, blobsDir), nil, 0o600))
|
||||||
|
|
||||||
|
requireErrorPrintedOnce(t, verbose,
|
||||||
|
flagConfig, configPath, cmdSnapshot, cmdCreate)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEntryBlobDownloadFailureIsPrintedOnce backs up, deletes the blobs
|
||||||
|
// from the destination, and restores, so the blob download fails.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntryBlobDownloadFailureIsPrintedOnce(t *testing.T) {
|
||||||
|
for _, verbose := range []bool{false, true} {
|
||||||
|
t.Run(fmt.Sprintf("verbose=%t", verbose), 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)))
|
||||||
|
|
||||||
|
requireErrorPrintedOnce(t, verbose, flagConfig, configPath,
|
||||||
|
cmdSnapshot, cmdRestore, onlySnapshotID(t, configPath), t.TempDir())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// requireErrorPrintedOnce runs Entry with args, adding --verbose when
|
||||||
|
// verbose is set. The command must fail, and stderr must carry its error
|
||||||
|
// once, as the final ERROR: line. A log record carrying the same error
|
||||||
|
// appears only under --verbose.
|
||||||
|
func requireErrorPrintedOnce(t *testing.T, verbose bool, args ...string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
if verbose {
|
||||||
|
args = append(args, flagVerbose)
|
||||||
|
}
|
||||||
|
|
||||||
|
code, _, stderr := runEntry(t, args...)
|
||||||
|
require.Equal(t, 1, code)
|
||||||
|
|
||||||
|
errorLine, records := failureOutput(t, stderr)
|
||||||
|
|
||||||
|
if !verbose {
|
||||||
|
assert.Zero(t, records,
|
||||||
|
"without --verbose no log record repeats the error:\n%s", stderr)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.NotZero(t, records,
|
||||||
|
"--verbose must keep the log record of %q", errorLine)
|
||||||
|
}
|
||||||
|
|
||||||
|
// failureOutput requires stderr to hold exactly one ERROR: line and
|
||||||
|
// returns it, with the number of log records whose error attribute is
|
||||||
|
// the error that line reports. stderr is a pipe here, so every log
|
||||||
|
// record is a JSON object on its own line.
|
||||||
|
func failureOutput(t *testing.T, stderr string) (string, int) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var (
|
||||||
|
errorLines []string
|
||||||
|
records []map[string]any
|
||||||
|
)
|
||||||
|
|
||||||
|
for line := range strings.Lines(stderr) {
|
||||||
|
var record map[string]any
|
||||||
|
if json.Unmarshal([]byte(line), &record) == nil {
|
||||||
|
records = append(records, record)
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.Contains(line, errorLinePrefix) {
|
||||||
|
errorLines = append(errorLines, strings.TrimSpace(line))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
require.Len(t, errorLines, 1,
|
||||||
|
"the error must be printed once as an ERROR: line:\n%s", stderr)
|
||||||
|
|
||||||
|
// An error can run over several lines; the ERROR: line holds the
|
||||||
|
// first of them.
|
||||||
|
repeats := 0
|
||||||
|
|
||||||
|
for _, record := range records {
|
||||||
|
failure, ok := record["error"].(string)
|
||||||
|
firstLine, _, _ := strings.Cut(failure, "\n")
|
||||||
|
|
||||||
|
if ok && strings.Contains(errorLines[0], firstLine) {
|
||||||
|
repeats++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return errorLines[0], repeats
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeBackupConfigWithPrivateKey builds what writeBackupConfig builds,
|
||||||
|
// with a generated key pair in place of its recipient. The config also
|
||||||
|
// holds the private key, so that restore can decrypt the backup. Returns
|
||||||
|
// the config path and the store directory.
|
||||||
|
func writeBackupConfigWithPrivateKey(t *testing.T) (string, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
configPath, storeDir := writeBackupConfig(t)
|
||||||
|
|
||||||
|
identity, err := age.GenerateX25519Identity()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
out := ui.NewWithColor(io.Discard, false)
|
||||||
|
|
||||||
|
require.NoError(t, writeConfigSet(out, configPath,
|
||||||
|
"age_recipients.0", identity.Recipient().String()))
|
||||||
|
require.NoError(t, writeConfigSet(out, configPath,
|
||||||
|
"age_secret_key", identity.String()))
|
||||||
|
|
||||||
|
return configPath, storeDir
|
||||||
|
}
|
||||||
|
|
||||||
|
// onlySnapshotID returns the ID of the one snapshot in the local index
|
||||||
|
// that writeBackupConfig puts beside the config file.
|
||||||
|
func onlySnapshotID(t *testing.T, configPath string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
db, err := database.New(ctx,
|
||||||
|
filepath.Join(filepath.Dir(configPath), "index.sqlite"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
defer func() { require.NoError(t, db.Close()) }()
|
||||||
|
|
||||||
|
backedUp, err := database.NewRepositories(db).Snapshots.GetOnlySnapshot(ctx)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
return backedUp.ID.String()
|
||||||
|
}
|
||||||
@@ -61,8 +61,8 @@ func TestEntrySnapshotCreateRejectsKeepNewerThanBeforeBackup(t *testing.T) {
|
|||||||
|
|
||||||
// TestEntrySnapshotCreateReportsPostBackupPruneFailure makes the
|
// TestEntrySnapshotCreateReportsPostBackupPruneFailure makes the
|
||||||
// post-backup prune fail after a good backup, by planting a manifest
|
// post-backup prune fail after a good backup, by planting a manifest
|
||||||
// that cannot be decoded, and checks that the failure is reported as the
|
// that cannot be decoded, and checks that the failure is reported once,
|
||||||
// prune's and not as a failed snapshot creation.
|
// as the prune's and not as a failed snapshot creation.
|
||||||
//
|
//
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
func TestEntrySnapshotCreateReportsPostBackupPruneFailure(t *testing.T) {
|
func TestEntrySnapshotCreateReportsPostBackupPruneFailure(t *testing.T) {
|
||||||
@@ -83,6 +83,9 @@ func TestEntrySnapshotCreateReportsPostBackupPruneFailure(t *testing.T) {
|
|||||||
assert.Contains(t, stderr, "Backup completed, but post-backup prune failed")
|
assert.Contains(t, stderr, "Backup completed, but post-backup prune failed")
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
assert.NotContains(t, stderr, "Snapshot creation failed")
|
||||||
|
|
||||||
|
_, repeats := failureOutput(t, stderr)
|
||||||
|
assert.Zero(t, repeats, "no log record may repeat the error:\n%s", stderr)
|
||||||
|
|
||||||
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Len(t, snapshots, 2,
|
assert.Len(t, snapshots, 2,
|
||||||
@@ -93,7 +96,8 @@ func TestEntrySnapshotCreateReportsPostBackupPruneFailure(t *testing.T) {
|
|||||||
// empties the source directory, as a volume that is not mounted leaves
|
// empties the source directory, as a volume that is not mounted leaves
|
||||||
// its mount point, and runs `snapshot create --prune`. The command exits
|
// its mount point, and runs `snapshot create --prune`. The command exits
|
||||||
// non-zero and reports the backup as completed, not as a failed snapshot
|
// non-zero and reports the backup as completed, not as a failed snapshot
|
||||||
// creation. See https://git.eeqj.de/sneak/vaultik/issues/388.
|
// creation. The error is printed once. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/388.
|
||||||
//
|
//
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
func TestEntrySnapshotCreatePruneExitsNonZeroWhenSourceIsEmpty(t *testing.T) {
|
func TestEntrySnapshotCreatePruneExitsNonZeroWhenSourceIsEmpty(t *testing.T) {
|
||||||
@@ -114,6 +118,9 @@ func TestEntrySnapshotCreatePruneExitsNonZeroWhenSourceIsEmpty(t *testing.T) {
|
|||||||
"Backup completed, but 1 source path(s) were empty")
|
"Backup completed, but 1 source path(s) were empty")
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
assert.NotContains(t, stderr, "Snapshot creation failed")
|
||||||
|
|
||||||
|
_, repeats := failureOutput(t, stderr)
|
||||||
|
assert.Zero(t, repeats, "no log record may repeat the error:\n%s", stderr)
|
||||||
|
|
||||||
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Len(t, snapshots, 2, "the older snapshot is kept")
|
assert.Len(t, snapshots, 2, "the older snapshot is kept")
|
||||||
@@ -124,7 +131,8 @@ func TestEntrySnapshotCreatePruneExitsNonZeroWhenSourceIsEmpty(t *testing.T) {
|
|||||||
// directory as a mount point, and runs `snapshot create --prune`, which
|
// directory as a mount point, and runs `snapshot create --prune`, which
|
||||||
// does not find it as one. The command exits non-zero, reports the
|
// does not find it as one. The command exits non-zero, reports the
|
||||||
// backup as completed, not as a failed snapshot creation, and keeps the
|
// backup as completed, not as a failed snapshot creation, and keeps the
|
||||||
// older snapshot. See https://git.eeqj.de/sneak/vaultik/issues/395.
|
// older snapshot. The error is printed once. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/395.
|
||||||
//
|
//
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
func TestEntrySnapshotCreatePruneExitsNonZeroWhenMountPointIsMissing(
|
func TestEntrySnapshotCreatePruneExitsNonZeroWhenMountPointIsMissing(
|
||||||
@@ -159,6 +167,9 @@ func TestEntrySnapshotCreatePruneExitsNonZeroWhenMountPointIsMissing(
|
|||||||
"an earlier snapshot recorded were not found")
|
"an earlier snapshot recorded were not found")
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
assert.NotContains(t, stderr, "Snapshot creation failed")
|
||||||
|
|
||||||
|
_, repeats := failureOutput(t, stderr)
|
||||||
|
assert.Zero(t, repeats, "no log record may repeat the error:\n%s", stderr)
|
||||||
|
|
||||||
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Len(t, snapshots, 2, "the older snapshot is kept")
|
assert.Len(t, snapshots, 2, "the older snapshot is kept")
|
||||||
|
|||||||
@@ -0,0 +1,47 @@
|
|||||||
|
package cli //nolint:testpackage // shares runEntry and the backup config helpers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
|
)
|
||||||
|
|
||||||
|
// cmdFiles is the word of `snapshot files`, used to build argument
|
||||||
|
// vectors below.
|
||||||
|
const cmdFiles = "files"
|
||||||
|
|
||||||
|
// TestEntrySnapshotFilesListsOnlyThePath backs up two files and runs
|
||||||
|
// `snapshot files` with the snapshot ID and the path of one of them,
|
||||||
|
// which must be the only file listed.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
||||||
|
func TestEntrySnapshotFilesListsOnlyThePath(t *testing.T) {
|
||||||
|
configPath, _ := writeBackupConfigWithPrivateKey(t)
|
||||||
|
|
||||||
|
// writeBackupConfig puts file.txt in the source directory beside the
|
||||||
|
// config file.
|
||||||
|
sourceDir := filepath.Join(filepath.Dir(configPath), "source")
|
||||||
|
listed := filepath.Join(sourceDir, "file.txt")
|
||||||
|
|
||||||
|
require.NoError(t, os.WriteFile(
|
||||||
|
filepath.Join(sourceDir, "other.txt"), []byte("other"), 0o600))
|
||||||
|
|
||||||
|
code, _, stderr := runEntry(t,
|
||||||
|
flagConfig, configPath, cmdSnapshot, cmdCreate)
|
||||||
|
require.Equal(t, 0, code, stderr)
|
||||||
|
|
||||||
|
code, stdout, stderr := runEntry(t, flagConfig, configPath, cmdSnapshot,
|
||||||
|
cmdFiles, onlySnapshotID(t, configPath), listed, flagJSON)
|
||||||
|
require.Equal(t, 0, code, stderr)
|
||||||
|
|
||||||
|
var entries []vaultik.ListedFile
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(stdout), &entries))
|
||||||
|
require.Len(t, entries, 1, "only the path given may be listed")
|
||||||
|
assert.Equal(t, listed, entries[0].Path)
|
||||||
|
}
|
||||||
@@ -48,7 +48,7 @@ func TestCLIEntry(t *testing.T) {
|
|||||||
} else {
|
} else {
|
||||||
// Check snapshot subcommands
|
// Check snapshot subcommands
|
||||||
expectedSubCommands := []string{
|
expectedSubCommands := []string{
|
||||||
"create", "list", "purge", "verify", "remove", "restore",
|
"create", "list", "files", "purge", "verify", "remove", "restore",
|
||||||
}
|
}
|
||||||
for _, expected := range expectedSubCommands {
|
for _, expected := range expectedSubCommands {
|
||||||
found := false
|
found := false
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ func NewInfoCommand() *cobra.Command {
|
|||||||
}, func(v *vaultik.Vaultik) error {
|
}, func(v *vaultik.Vaultik) error {
|
||||||
return v.ShowInfo()
|
return v.ShowInfo()
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
log.Error("Failed to show info", "error", err)
|
log.Info("Failed to show info", "error", err)
|
||||||
ReportErrorf("Failed to show info: %v", err)
|
ReportErrorf("Failed to show info: %v", err)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ referenced.`,
|
|||||||
}, func(v *vaultik.Vaultik) error {
|
}, func(v *vaultik.Vaultik) error {
|
||||||
return v.Prune(opts)
|
return v.Prune(opts)
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
log.Error("Prune operation failed", "error", err)
|
log.Info("Prune operation failed", "error", err)
|
||||||
ReportErrorf("Prune failed: %v", err)
|
ReportErrorf("Prune failed: %v", err)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -75,7 +75,9 @@ func newRemoteInfoCommand() *cobra.Command {
|
|||||||
- Size of all snapshot metadata (per snapshot and total)
|
- Size of all snapshot metadata (per snapshot and total)
|
||||||
- Count and total size of all blobs
|
- Count and total size of all blobs
|
||||||
- Count and size of referenced blobs (from all manifests)
|
- Count and size of referenced blobs (from all manifests)
|
||||||
- Count and size of orphaned blobs (not referenced by any manifest)`,
|
- Count and size of orphaned blobs (not referenced by any manifest)
|
||||||
|
- Count and size of referenced blobs missing from remote storage, and the
|
||||||
|
snapshots that list them; the command exits non-zero when any are missing`,
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
// Use unified config resolution
|
// Use unified config resolution
|
||||||
@@ -98,7 +100,7 @@ func newRemoteInfoCommand() *cobra.Command {
|
|||||||
}, func(v *vaultik.Vaultik) error {
|
}, func(v *vaultik.Vaultik) error {
|
||||||
return v.RemoteInfo(jsonOutput)
|
return v.RemoteInfo(jsonOutput)
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
log.Error("Failed to get remote info", "error", err)
|
log.Info("Failed to get remote info", "error", err)
|
||||||
ReportErrorf("Failed to get remote info: %v", err)
|
ReportErrorf("Failed to get remote info: %v", err)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -9,6 +9,10 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// filesMaxArgs is the maximum positional argument count of
|
||||||
|
// `snapshot files <snapshot-id> [path]`.
|
||||||
|
const filesMaxArgs = 2
|
||||||
|
|
||||||
var (
|
var (
|
||||||
errSnapshotIDRequired = errors.New("snapshot ID required")
|
errSnapshotIDRequired = errors.New("snapshot ID required")
|
||||||
errWrongArgCount = errors.New("wrong argument count")
|
errWrongArgCount = errors.New("wrong argument count")
|
||||||
@@ -52,6 +56,7 @@ func NewSnapshotCommand() *cobra.Command {
|
|||||||
// Add subcommands
|
// Add subcommands
|
||||||
cmd.AddCommand(newSnapshotCreateCommand())
|
cmd.AddCommand(newSnapshotCreateCommand())
|
||||||
cmd.AddCommand(newSnapshotListCommand())
|
cmd.AddCommand(newSnapshotListCommand())
|
||||||
|
cmd.AddCommand(newSnapshotFilesCommand())
|
||||||
cmd.AddCommand(newSnapshotPurgeCommand())
|
cmd.AddCommand(newSnapshotPurgeCommand())
|
||||||
cmd.AddCommand(newSnapshotVerifyCommand())
|
cmd.AddCommand(newSnapshotVerifyCommand())
|
||||||
cmd.AddCommand(newSnapshotRemoveCommand())
|
cmd.AddCommand(newSnapshotRemoveCommand())
|
||||||
@@ -109,7 +114,7 @@ on Linux), then /etc/vaultik/config.yml.`,
|
|||||||
return v.CreateSnapshot(opts)
|
return v.CreateSnapshot(opts)
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
if errors.Is(err, vaultik.ErrPostBackupPruneFailed) {
|
if errors.Is(err, vaultik.ErrPostBackupPruneFailed) {
|
||||||
log.Error("Post-backup prune failed", "error", err)
|
log.Info("Post-backup prune failed", "error", err)
|
||||||
ReportErrorf("Backup completed, but %v", err)
|
ReportErrorf("Backup completed, but %v", err)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -118,13 +123,13 @@ on Linux), then /etc/vaultik/config.yml.`,
|
|||||||
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
if errors.Is(err, vaultik.ErrFilesUnreadable) ||
|
||||||
errors.Is(err, vaultik.ErrSourcePathEmpty) ||
|
errors.Is(err, vaultik.ErrSourcePathEmpty) ||
|
||||||
errors.Is(err, vaultik.ErrVolumeNotMounted) {
|
errors.Is(err, vaultik.ErrVolumeNotMounted) {
|
||||||
log.Error("Backup completed with an error", "error", err)
|
log.Info("Backup completed with an error", "error", err)
|
||||||
ReportErrorf("Backup completed, but %v", err)
|
ReportErrorf("Backup completed, but %v", err)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Error("Snapshot creation failed", "error", err)
|
log.Info("Snapshot creation failed", "error", err)
|
||||||
ReportErrorf("Snapshot creation failed: %v", err)
|
ReportErrorf("Snapshot creation failed: %v", err)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
@@ -172,6 +177,44 @@ func newSnapshotListCommand() *cobra.Command {
|
|||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// newSnapshotFilesCommand creates the 'snapshot files' subcommand
|
||||||
|
func newSnapshotFilesCommand() *cobra.Command {
|
||||||
|
var jsonOutput bool
|
||||||
|
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "files <snapshot-id> [path]",
|
||||||
|
Short: "List the files in a snapshot",
|
||||||
|
Long: `Lists the path, size, mode and modification time of every file in a
|
||||||
|
snapshot, without restoring it. With a path, lists only that path and
|
||||||
|
what is under it; a path that matches nothing is an error.
|
||||||
|
|
||||||
|
The snapshot may be named by its ID or, on a host with no local index,
|
||||||
|
by the remote key that 'snapshot list' prints for a remote-only snapshot
|
||||||
|
(an unambiguous leading part is enough).
|
||||||
|
|
||||||
|
The file list is only in the snapshot's encrypted database, so this
|
||||||
|
downloads and decrypts it, and requires the age private key in the
|
||||||
|
VAULTIK_AGE_SECRET_KEY environment variable, as 'snapshot restore' does.`,
|
||||||
|
Args: cobra.RangeArgs(1, filesMaxArgs),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
path := ""
|
||||||
|
if len(args) == filesMaxArgs {
|
||||||
|
path = args[1]
|
||||||
|
}
|
||||||
|
|
||||||
|
return runVaultikApp(cmd, readOnly, jsonOutput,
|
||||||
|
"Failed to list snapshot files",
|
||||||
|
func(v *vaultik.Vaultik) error {
|
||||||
|
return v.ListSnapshotFiles(args[0], path, jsonOutput)
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.Flags().BoolVar(&jsonOutput, "json", false, "Output in JSON format")
|
||||||
|
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
// newSnapshotPurgeCommand creates the 'snapshot purge' subcommand
|
// newSnapshotPurgeCommand creates the 'snapshot purge' subcommand
|
||||||
func newSnapshotPurgeCommand() *cobra.Command {
|
func newSnapshotPurgeCommand() *cobra.Command {
|
||||||
opts := &vaultik.SnapshotPurgeOptions{}
|
opts := &vaultik.SnapshotPurgeOptions{}
|
||||||
@@ -258,7 +301,7 @@ func newSnapshotVerifyCommand() *cobra.Command {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Error("Verification failed", "error", err)
|
log.Info("Verification failed", "error", err)
|
||||||
ReportErrorf("Verification failed: %v", err)
|
ReportErrorf("Verification failed: %v", err)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
@@ -288,8 +331,10 @@ know about), which is what 'vaultik prune' does. The command prints the
|
|||||||
'vaultik prune' invocation to run as a follow-up only when it removed the
|
'vaultik prune' invocation to run as a follow-up only when it removed the
|
||||||
snapshot's metadata from the destination store, and never under --json.
|
snapshot's metadata from the destination store, and never under --json.
|
||||||
|
|
||||||
An ID that names no snapshot in the local index or on the destination
|
The snapshot may be named by its ID or by its remote key, which
|
||||||
store is an error.
|
'snapshot list' prints for a remote-only snapshot. An unambiguous
|
||||||
|
leading part of the key is enough. An identifier that names no snapshot
|
||||||
|
in the local index or on the destination store is an error.
|
||||||
|
|
||||||
Use --local-only to skip the remote half (e.g. when you want to forget a
|
Use --local-only to skip the remote half (e.g. when you want to forget a
|
||||||
snapshot locally without touching the destination store); the snapshot
|
snapshot locally without touching the destination store); the snapshot
|
||||||
|
|||||||
@@ -104,7 +104,7 @@ func runRestore(cmd *cobra.Command, args []string, opts *RestoreOptions) error {
|
|||||||
SkipErrors: rootFlags.SkipErrors,
|
SkipErrors: rootFlags.SkipErrors,
|
||||||
})
|
})
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
log.Error("Restore operation failed", "error", err)
|
log.Info("Restore operation failed", "error", err)
|
||||||
ReportErrorf("Restore failed: %v", err)
|
ReportErrorf("Restore failed: %v", err)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
+30
-10
@@ -295,7 +295,8 @@ func Load(path string) (*Config, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Parse reads YAML config data as Load does, without validating it. It
|
// Parse reads YAML config data as Load does, without validating it. It
|
||||||
// refuses a key that no setting has, applies default values for optional
|
// refuses a key that no setting has and a size setting whose value is not a
|
||||||
|
// size, naming the setting. It applies default values for optional
|
||||||
// fields, fills in ${...} references using smartconfig, and expands ~ in
|
// fields, fills in ${...} references using smartconfig, and expands ~ in
|
||||||
// paths.
|
// paths.
|
||||||
func Parse(data []byte) (*Config, error) {
|
func Parse(data []byte) (*Config, error) {
|
||||||
@@ -320,8 +321,9 @@ func Parse(data []byte) (*Config, error) {
|
|||||||
return nil, fmt.Errorf("failed to load config file: %w", err)
|
return nil, fmt.Errorf("failed to load config file: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// A ${...} reference can bring in keys that are not in the file.
|
// A ${...} reference can bring in keys that are not in the file, and
|
||||||
err = checkFilledKeys(sc.Data())
|
// is the value of a size setting only once it is filled in.
|
||||||
|
err = checkFilledConfig(sc.Data())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -394,6 +396,8 @@ func Parse(data []byte) (*Config, error) {
|
|||||||
// never the value. An empty list is accepted, because only snapshot
|
// never the value. An empty list is accepted, because only snapshot
|
||||||
// create needs a recipient and it checks for one itself
|
// create needs a recipient and it checks for one itself
|
||||||
// - At least one snapshot must be configured with at least one path
|
// - At least one snapshot must be configured with at least one path
|
||||||
|
// - Every exclude pattern, global or in a snapshot, must compile; errors
|
||||||
|
// name the setting and quote the pattern
|
||||||
// - Storage must be configured (either storage_url or s3.* fields)
|
// - Storage must be configured (either storage_url or s3.* fields)
|
||||||
// - The index path must be absolute: a relative one would resolve against
|
// - The index path must be absolute: a relative one would resolve against
|
||||||
// the working directory, so each directory would get its own index
|
// the working directory, so each directory would get its own index
|
||||||
@@ -414,18 +418,18 @@ func (c *Config) Validate() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(c.Snapshots) == 0 {
|
err := c.validateSnapshots()
|
||||||
return errNoSnapshots
|
if err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
for name, snap := range c.Snapshots {
|
err = c.validateExcludes()
|
||||||
if len(snap.Paths) == 0 {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: %q", errSnapshotNoPaths, name)
|
return err
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate storage configuration
|
// Validate storage configuration
|
||||||
err := c.validateStorage()
|
err = c.validateStorage()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -464,6 +468,22 @@ func (c *Config) Validate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// validateSnapshots refuses a config with no snapshot or with a snapshot
|
||||||
|
// that has no path.
|
||||||
|
func (c *Config) validateSnapshots() error {
|
||||||
|
if len(c.Snapshots) == 0 {
|
||||||
|
return errNoSnapshots
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, snap := range c.Snapshots {
|
||||||
|
if len(snap.Paths) == 0 {
|
||||||
|
return fmt.Errorf("%w: %q", errSnapshotNoPaths, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// validateAgeRecipient parses one age_recipients entry with the age library
|
// validateAgeRecipient parses one age_recipients entry with the age library
|
||||||
// and returns a value-free error on failure. A recipient string can be
|
// and returns a value-free error on failure. A recipient string can be
|
||||||
// sensitive (an operator may paste a secret key by mistake), so neither the
|
// sensitive (an operator may paste a secret key by mistake), so neither the
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"sneak.berlin/go/vaultik/internal/exclude"
|
||||||
|
)
|
||||||
|
|
||||||
|
// validateExcludes refuses an exclude pattern, global or in a snapshot,
|
||||||
|
// that does not compile, naming the setting and quoting the pattern.
|
||||||
|
func (c *Config) validateExcludes() error {
|
||||||
|
err := validateExcludeList("exclude", c.Exclude)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, name := range c.SnapshotNames() {
|
||||||
|
err = validateExcludeList("snapshots."+name+".exclude",
|
||||||
|
c.Snapshots[name].Exclude)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// validateExcludeList refuses the first pattern in patterns that does not
|
||||||
|
// compile. setting is the name of the list, as in "exclude".
|
||||||
|
func validateExcludeList(setting string, patterns []string) error {
|
||||||
|
for i, pattern := range patterns {
|
||||||
|
_, _, err := exclude.Compile(pattern)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s[%d]: %w", setting, i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
package config_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestLoadRefusesBadExcludePattern checks that an exclude pattern that does
|
||||||
|
// not compile, global or in a snapshot, fails at load with the setting and
|
||||||
|
// the pattern named, rather than the backup storing what it meant to leave
|
||||||
|
// out.
|
||||||
|
func TestLoadRefusesBadExcludePattern(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const storage = "storage_url: file:///tmp/vaultik-test-storage\n"
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
config string
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "global",
|
||||||
|
config: "exclude: ['*.tmp', '.cache', 'build[']\n" +
|
||||||
|
"snapshots:\n" +
|
||||||
|
" home:\n" +
|
||||||
|
" paths: [/tmp/vaultik-test-source]\n" + storage,
|
||||||
|
wantErr: `exclude[2]: "build[" is not a valid exclude pattern`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "snapshot",
|
||||||
|
config: "snapshots:\n" +
|
||||||
|
" home:\n" +
|
||||||
|
" paths: [/tmp/vaultik-test-source]\n" +
|
||||||
|
" exclude: ['/a/**/x[']\n" + storage,
|
||||||
|
wantErr: `snapshots.home.exclude[0]: "/a/**/x[" is not a valid exclude pattern`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
|
||||||
|
err := os.WriteFile(path, []byte(tt.config), 0o600)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("write config: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = config.Load(path)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatalf("Load() returned nil, want an error containing %q", tt.wantErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(err.Error(), tt.wantErr) {
|
||||||
|
t.Fatalf("Load() error = %q, want it to contain %q", err, tt.wantErr)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+11
-5
@@ -129,10 +129,11 @@ func checkKeys(node *yaml.Node, typ reflect.Type, path string,
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkFilledKeys is checkKeys for data, the config after smartconfig has
|
// checkFilledConfig checks data, the config after smartconfig has filled in
|
||||||
// filled in its ${...} references. A key that a reference brings in is not
|
// its ${...} references: its keys with checkKeys, then its size settings
|
||||||
// in the file, and the copy that Encode makes has no line numbers.
|
// with checkSizes. A key that a reference brings in is not in the file, and
|
||||||
func checkFilledKeys(data map[string]any) error {
|
// the copy that Encode makes has no line numbers.
|
||||||
|
func checkFilledConfig(data map[string]any) error {
|
||||||
var filled yaml.Node
|
var filled yaml.Node
|
||||||
|
|
||||||
err := filled.Encode(data)
|
err := filled.Encode(data)
|
||||||
@@ -140,8 +141,13 @@ func checkFilledKeys(data map[string]any) error {
|
|||||||
return fmt.Errorf("failed to marshal config data: %w", err)
|
return fmt.Errorf("failed to marshal config data: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return checkKeys(&filled, reflect.TypeFor[Config](), "",
|
err = checkKeys(&filled, reflect.TypeFor[Config](), "",
|
||||||
map[*yaml.Node]bool{}, map[nodeAndType]bool{})
|
map[*yaml.Node]bool{}, map[nodeAndType]bool{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return checkSizes(&filled, nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkMappingKeys is checkKeys for a map.
|
// checkMappingKeys is checkKeys for a map.
|
||||||
|
|||||||
+77
-11
@@ -4,13 +4,20 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"math"
|
"math"
|
||||||
|
"reflect"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
|
"gopkg.in/yaml.v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
errSizeType = errors.New("size must be a number or string")
|
errSizeType = errors.New("size must be a number or string")
|
||||||
errSizeTooLarge = errors.New("size exceeds maximum supported value")
|
errSizeTooLarge = errors.New("size exceeds maximum supported value")
|
||||||
|
errNotASize = errors.New(
|
||||||
|
"is not a size; use a number of bytes or a unit such as 10MB")
|
||||||
)
|
)
|
||||||
|
|
||||||
// Size represents a byte size that can be specified in configuration files.
|
// Size represents a byte size that can be specified in configuration files.
|
||||||
@@ -32,6 +39,15 @@ func (s *Size) UnmarshalYAML(unmarshal func(any) error) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A number too large for an int64 decodes as a float64. Its text can be
|
||||||
|
// 1e+20, which is not a size string.
|
||||||
|
var floatVal float64
|
||||||
|
|
||||||
|
err = unmarshal(&floatVal)
|
||||||
|
if err == nil && floatVal > math.MaxInt64 {
|
||||||
|
return errSizeTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
// Try to unmarshal as string
|
// Try to unmarshal as string
|
||||||
var strVal string
|
var strVal string
|
||||||
|
|
||||||
@@ -40,17 +56,66 @@ func (s *Size) UnmarshalYAML(unmarshal func(any) error) error {
|
|||||||
return errSizeType
|
return errSizeType
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parse the string using go-humanize
|
size, err := ParseSize(strVal)
|
||||||
bytes, err := humanize.ParseBytes(strVal)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("invalid size format: %w", err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if bytes > math.MaxInt64 {
|
*s = size
|
||||||
return fmt.Errorf("%w: %s", errSizeTooLarge, strVal)
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkSizes returns an error naming the first size setting in node whose
|
||||||
|
// value is not a size. node is the config, or the part of it at the dotted
|
||||||
|
// keys, after smartconfig has filled in its ${...} references.
|
||||||
|
func checkSizes(node *yaml.Node, keys []string) error {
|
||||||
|
typ, err := SettingType(keys)
|
||||||
|
if err != nil {
|
||||||
|
// Unknown keys are refused before this check, so keys is in one of
|
||||||
|
// two places. The env section holds no settings. A value of the
|
||||||
|
// wrong shape, such as a map given for hostname or inside exclude,
|
||||||
|
// is reported later by the YAML decoder.
|
||||||
|
return nil //nolint:nilerr // not an error here
|
||||||
}
|
}
|
||||||
|
|
||||||
*s = Size(bytes)
|
if typ == reflect.TypeFor[Size]() {
|
||||||
|
var size Size
|
||||||
|
|
||||||
|
err = node.Decode(&size)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s: %w", strings.Join(keys, "."), err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
switch node.Kind {
|
||||||
|
case yaml.DocumentNode:
|
||||||
|
for _, child := range node.Content {
|
||||||
|
err = checkSizes(child, keys)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case yaml.MappingNode:
|
||||||
|
for i := 0; i+1 < len(node.Content); i += 2 {
|
||||||
|
err = checkSizes(node.Content[i+1],
|
||||||
|
slices.Concat(keys, []string{node.Content[i].Value}))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case yaml.SequenceNode:
|
||||||
|
for i, child := range node.Content {
|
||||||
|
err = checkSizes(child, slices.Concat(keys, []string{strconv.Itoa(i)}))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case yaml.ScalarNode, yaml.AliasNode:
|
||||||
|
// A scalar holds no settings, and the filled config has no aliases.
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -70,16 +135,17 @@ func (s Size) String() string {
|
|||||||
return humanize.Bytes(uint64(s))
|
return humanize.Bytes(uint64(s))
|
||||||
}
|
}
|
||||||
|
|
||||||
// ParseSize parses a size string into a Size value
|
// ParseSize parses a size string, such as "10MB", into a Size value. An
|
||||||
|
// error quotes s.
|
||||||
func ParseSize(s string) (Size, error) {
|
func ParseSize(s string) (Size, error) {
|
||||||
bytes, err := humanize.ParseBytes(s)
|
bytes, err := humanize.ParseBigBytes(s)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, fmt.Errorf("invalid size format: %w", err)
|
return 0, fmt.Errorf("%q %w", s, errNotASize)
|
||||||
}
|
}
|
||||||
|
|
||||||
if bytes > math.MaxInt64 {
|
if !bytes.IsInt64() {
|
||||||
return 0, fmt.Errorf("%w: %s", errSizeTooLarge, s)
|
return 0, fmt.Errorf("%w: %s", errSizeTooLarge, s)
|
||||||
}
|
}
|
||||||
|
|
||||||
return Size(bytes), nil
|
return Size(bytes.Int64()), nil
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
package config //nolint:testpackage // checks errNotASize and errSizeTooLarge
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestParseRefusesValueThatIsNotASize checks that a size setting whose
|
||||||
|
// value is not a size fails the parse with an error naming the setting and
|
||||||
|
// quoting the value, also when a ${...} reference fills the value in.
|
||||||
|
func TestParseRefusesValueThatIsNotASize(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
sizePath := filepath.Join(t.TempDir(), "size")
|
||||||
|
|
||||||
|
err := os.WriteFile(sizePath, []byte("lots"), 0o600)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("write size: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
yaml string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"chunk_size", keysTestConfig + "chunk_size: banana\n",
|
||||||
|
`chunk_size: "banana" is not a size; ` +
|
||||||
|
"use a number of bytes or a unit such as 10MB"},
|
||||||
|
{"blob_size_limit", keysTestConfig + "blob_size_limit: 10XB\n",
|
||||||
|
`blob_size_limit: "10XB" is not a size; ` +
|
||||||
|
"use a number of bytes or a unit such as 10MB"},
|
||||||
|
{"s3.part_size", strings.Replace(keysTestConfig, " region:",
|
||||||
|
" part_size: big\n region:", 1),
|
||||||
|
`s3.part_size: "big" is not a size; ` +
|
||||||
|
"use a number of bytes or a unit such as 10MB"},
|
||||||
|
{"from a reference",
|
||||||
|
keysTestConfig + "chunk_size: ${FILE:" + sizePath + "}\n",
|
||||||
|
`chunk_size: "lots" is not a size; ` +
|
||||||
|
"use a number of bytes or a unit such as 10MB"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
_, err := Parse([]byte(tt.yaml))
|
||||||
|
if !errors.Is(err, errNotASize) {
|
||||||
|
t.Fatalf("Parse() error = %v, want errNotASize", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err.Error() != tt.want {
|
||||||
|
t.Errorf("Parse() error = %q, want %q", err.Error(), tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseRefusesSizeTooLarge checks that a size setting whose value is
|
||||||
|
// too large for a size fails the parse with an error naming the setting.
|
||||||
|
// YAML reads the second value as a float.
|
||||||
|
func TestParseRefusesSizeTooLarge(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
value string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"100EB", "chunk_size: size exceeds maximum supported value: 100EB"},
|
||||||
|
{"99999999999999999999",
|
||||||
|
"chunk_size: size exceeds maximum supported value"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.value, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
_, err := Parse([]byte(keysTestConfig + "chunk_size: " + tt.value + "\n"))
|
||||||
|
if !errors.Is(err, errSizeTooLarge) {
|
||||||
|
t.Fatalf("Parse() error = %v, want errSizeTooLarge", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err.Error() != tt.want {
|
||||||
|
t.Errorf("Parse() error = %q, want %q", err.Error(), tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseAcceptsSizes checks that size settings given as a number of
|
||||||
|
// bytes, as a unit, and through a ${...} reference still parse.
|
||||||
|
func TestParseAcceptsSizes(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
sizePath := filepath.Join(t.TempDir(), "size")
|
||||||
|
|
||||||
|
err := os.WriteFile(sizePath, []byte("20MB"), 0o600)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("write size: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
data := strings.Replace(keysTestConfig, " region:",
|
||||||
|
" part_size: 6000000\n region:", 1) +
|
||||||
|
"chunk_size: ${FILE:" + sizePath + "}\n" +
|
||||||
|
"blob_size_limit: 1GB\n"
|
||||||
|
|
||||||
|
cfg, err := Parse([]byte(data))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Parse() unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.ChunkSize != 20_000_000 || cfg.BlobSizeLimit != 1_000_000_000 ||
|
||||||
|
cfg.S3.PartSize != 6_000_000 {
|
||||||
|
t.Errorf("chunk_size, blob_size_limit, s3.part_size = %d, %d, %d, "+
|
||||||
|
"want 20000000, 1000000000, 6000000",
|
||||||
|
cfg.ChunkSize, cfg.BlobSizeLimit, cfg.S3.PartSize)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -219,7 +219,8 @@ func retryOpen(ctx context.Context, path string) (*DB, error) {
|
|||||||
|
|
||||||
// errUntrustedSnapshotSchema is returned when a downloaded snapshot
|
// errUntrustedSnapshotSchema is returned when a downloaded snapshot
|
||||||
// database carries schema objects the real schema never defines, or is
|
// database carries schema objects the real schema never defines, or is
|
||||||
// missing a table the restore and deep-verify queries read.
|
// missing a table the restore, deep-verify and `snapshot files` queries
|
||||||
|
// read.
|
||||||
var errUntrustedSnapshotSchema = errors.New(
|
var errUntrustedSnapshotSchema = errors.New(
|
||||||
"downloaded snapshot database has an untrusted schema")
|
"downloaded snapshot database has an untrusted schema")
|
||||||
|
|
||||||
@@ -241,12 +242,12 @@ func snapshotReadOnlyDSN(path string) string {
|
|||||||
|
|
||||||
// OpenReadOnly opens an already-materialized SQLite file for read-only
|
// OpenReadOnly opens an already-materialized SQLite file for read-only
|
||||||
// querying of a snapshot database downloaded from the store, used by
|
// querying of a snapshot database downloaded from the store, used by
|
||||||
// restore and deep verify. Unlike New it never applies schema migrations
|
// restore, deep verify and `snapshot files`. Unlike New it never applies
|
||||||
// and never writes: the connection is opened read-only with query_only
|
// schema migrations and never writes: the connection is opened read-only
|
||||||
// and trusted_schema=OFF. It refuses any file whose schema carries a
|
// with query_only and trusted_schema=OFF. It refuses any file whose schema
|
||||||
// trigger, view or virtual table, or lacks an expected table, so a forged
|
// carries a trigger, view or virtual table, or lacks an expected table, so
|
||||||
// file cannot redefine what the restore queries return. The caller owns
|
// a forged file cannot redefine what the restore queries return. The
|
||||||
// the file and must remove it.
|
// caller owns the file and must remove it.
|
||||||
func OpenReadOnly(ctx context.Context, path string) (*DB, error) {
|
func OpenReadOnly(ctx context.Context, path string) (*DB, error) {
|
||||||
conn, err := sql.Open("sqlite", snapshotReadOnlyDSN(path))
|
conn, err := sql.Open("sqlite", snapshotReadOnlyDSN(path))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -276,9 +277,9 @@ func OpenReadOnly(ctx context.Context, path string) (*DB, error) {
|
|||||||
// the plain table set the real schema defines. Any trigger, view or
|
// the plain table set the real schema defines. Any trigger, view or
|
||||||
// virtual table, or a missing expected table, fails the open.
|
// virtual table, or a missing expected table, fails the open.
|
||||||
func verifySnapshotSchema(ctx context.Context, conn *sql.DB) error {
|
func verifySnapshotSchema(ctx context.Context, conn *sql.DB) error {
|
||||||
// expectedSnapshotTables are the tables the restore and deep-verify
|
// expectedSnapshotTables are the tables the restore, deep-verify and
|
||||||
// queries read. A downloaded database missing any of them is not a
|
// `snapshot files` queries read. A downloaded database missing any of
|
||||||
// genuine snapshot database and is refused.
|
// them is not a genuine snapshot database and is refused.
|
||||||
expectedSnapshotTables := []string{
|
expectedSnapshotTables := []string{
|
||||||
"blob_chunks",
|
"blob_chunks",
|
||||||
"blobs",
|
"blobs",
|
||||||
|
|||||||
@@ -238,10 +238,11 @@ func (r *SnapshotRepository) GetByID(
|
|||||||
|
|
||||||
// GetOnlySnapshot returns the sole snapshot in an exported per-snapshot
|
// GetOnlySnapshot returns the sole snapshot in an exported per-snapshot
|
||||||
// metadata database. The backup path writes each snapshot's database with
|
// metadata database. The backup path writes each snapshot's database with
|
||||||
// exactly one snapshot row (see cleanSnapshotDB), so restore and deep
|
// exactly one snapshot row (see cleanSnapshotDB), so restore, deep verify
|
||||||
// verify expect exactly one. Zero rows return ErrNoSnapshotInDatabase and
|
// and `snapshot files` expect exactly one. Zero rows return
|
||||||
// more than one returns ErrMultipleSnapshotsInDatabase; callers treat
|
// ErrNoSnapshotInDatabase and more than one returns
|
||||||
// either as a failed identity check on the downloaded database.
|
// ErrMultipleSnapshotsInDatabase; callers treat either as a failed
|
||||||
|
// identity check on the downloaded database.
|
||||||
func (r *SnapshotRepository) GetOnlySnapshot(ctx context.Context) (*Snapshot, error) {
|
func (r *SnapshotRepository) GetOnlySnapshot(ctx context.Context) (*Snapshot, error) {
|
||||||
query := `
|
query := `
|
||||||
SELECT id, hostname, vaultik_version, vaultik_git_revision,
|
SELECT id, hostname, vaultik_version, vaultik_git_revision,
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
// Package exclude compiles exclude patterns into globs.
|
||||||
|
package exclude
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/gobwas/glob"
|
||||||
|
)
|
||||||
|
|
||||||
|
var errBadExcludePattern = errors.New("is not a valid exclude pattern")
|
||||||
|
|
||||||
|
// Compile compiles one exclude pattern into the globs that match it.
|
||||||
|
// anchored reports whether the pattern matches only from the root of the
|
||||||
|
// source directory. An empty pattern yields no globs. Config.Validate and
|
||||||
|
// the scanner both compile patterns with it, so a pattern that loads is one
|
||||||
|
// the scanner can use.
|
||||||
|
func Compile(pattern string) ([]glob.Glob, bool, error) {
|
||||||
|
if pattern == "" {
|
||||||
|
return nil, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// A leading "/" anchors the pattern to the source directory.
|
||||||
|
trimmed, anchored := strings.CutPrefix(pattern, "/")
|
||||||
|
|
||||||
|
// A trailing "/" marks a directory and is not matched.
|
||||||
|
trimmed = strings.TrimSuffix(trimmed, "/")
|
||||||
|
|
||||||
|
// A leading "**/" demands a "/" before the name and so misses an
|
||||||
|
// entry directly under the source path. It means "at every depth",
|
||||||
|
// which is what an unanchored pattern already does, so drop the
|
||||||
|
// prefix and match unanchored: as in gitignore, "**/x" and
|
||||||
|
// "/**/x" then also match a top-level "x".
|
||||||
|
if rest, found := strings.CutPrefix(trimmed, "**/"); found {
|
||||||
|
trimmed = rest
|
||||||
|
anchored = false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Likewise "/**/" inside a pattern demands two slashes, so
|
||||||
|
// "a/**/*.log" misses "a/x.log". As in gitignore it stands for
|
||||||
|
// zero or more directories, so also compile the pattern with it
|
||||||
|
// made a single "/". The glob library's {a,b} is no help: with a
|
||||||
|
// "**" inside it in mid-pattern, it misses paths it should match.
|
||||||
|
var globs []glob.Glob
|
||||||
|
|
||||||
|
for _, variant := range doubleStarVariants(trimmed) {
|
||||||
|
g, err := glob.Compile(variant, '/')
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, fmt.Errorf("%q %w: %w",
|
||||||
|
pattern, errBadExcludePattern, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
globs = append(globs, g)
|
||||||
|
}
|
||||||
|
|
||||||
|
return globs, anchored, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// doubleStarVariants returns pattern once for every way of keeping each
|
||||||
|
// "/**/" in it or making it a single "/".
|
||||||
|
func doubleStarVariants(pattern string) []string {
|
||||||
|
const doubleStar = "/**/"
|
||||||
|
|
||||||
|
before, after, found := strings.Cut(pattern, doubleStar)
|
||||||
|
if !found {
|
||||||
|
return []string{pattern}
|
||||||
|
}
|
||||||
|
|
||||||
|
var variants []string
|
||||||
|
|
||||||
|
for _, rest := range doubleStarVariants(after) {
|
||||||
|
variants = append(variants, before+doubleStar+rest, before+"/"+rest)
|
||||||
|
}
|
||||||
|
|
||||||
|
return variants
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package exclude_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/gobwas/glob"
|
||||||
|
"sneak.berlin/go/vaultik/internal/exclude"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestCompile checks the error, the anchoring and the globs that Compile
|
||||||
|
// returns for one exclude pattern.
|
||||||
|
func TestCompile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
pattern string
|
||||||
|
wantErr string
|
||||||
|
wantAnchored bool
|
||||||
|
// wantMatches lists paths that one of the globs must match. When
|
||||||
|
// it is empty, Compile must return no globs.
|
||||||
|
wantMatches []string
|
||||||
|
}{
|
||||||
|
{name: "does not compile", pattern: "build[",
|
||||||
|
wantErr: `"build[" is not a valid exclude pattern`},
|
||||||
|
{name: "empty", pattern: ""},
|
||||||
|
{name: "leading slash anchors", pattern: "/build",
|
||||||
|
wantAnchored: true, wantMatches: []string{"build"}},
|
||||||
|
{name: "double star after the slash clears anchoring",
|
||||||
|
pattern: "/**/build", wantMatches: []string{"build"}},
|
||||||
|
{name: "double star in the middle", pattern: "a/**/*.log",
|
||||||
|
wantMatches: []string{"a/x.log", "a/b/x.log"}},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
globs, anchored, err := exclude.Compile(tt.pattern)
|
||||||
|
if tt.wantErr == "" && err != nil {
|
||||||
|
t.Fatalf("Compile(%q) error = %v, want none", tt.pattern, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.wantErr != "" &&
|
||||||
|
(err == nil || !strings.HasPrefix(err.Error(), tt.wantErr)) {
|
||||||
|
t.Fatalf("Compile(%q) error = %v, want one starting with %q",
|
||||||
|
tt.pattern, err, tt.wantErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if anchored != tt.wantAnchored {
|
||||||
|
t.Errorf("Compile(%q) anchored = %t, want %t",
|
||||||
|
tt.pattern, anchored, tt.wantAnchored)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(tt.wantMatches) == 0 && len(globs) != 0 {
|
||||||
|
t.Errorf("Compile(%q) returned %d globs, want none",
|
||||||
|
tt.pattern, len(globs))
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, path := range tt.wantMatches {
|
||||||
|
matched := slices.ContainsFunc(globs, func(g glob.Glob) bool {
|
||||||
|
return g.Match(path)
|
||||||
|
})
|
||||||
|
if !matched {
|
||||||
|
t.Errorf("Compile(%q) globs do not match %q",
|
||||||
|
tt.pattern, path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -20,6 +20,7 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/blob"
|
"sneak.berlin/go/vaultik/internal/blob"
|
||||||
"sneak.berlin/go/vaultik/internal/chunker"
|
"sneak.berlin/go/vaultik/internal/chunker"
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
|
"sneak.berlin/go/vaultik/internal/exclude"
|
||||||
"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/types"
|
"sneak.berlin/go/vaultik/internal/types"
|
||||||
@@ -221,8 +222,12 @@ func NewScanner(cfg ScannerConfig) *Scanner {
|
|||||||
progress = NewProgressReporter()
|
progress = NewProgressReporter()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Compile exclude patterns
|
compiledExclude, err := compileExcludePatterns(cfg.Exclude)
|
||||||
compiledExclude := compileExcludePatterns(cfg.Exclude)
|
if err != nil {
|
||||||
|
log.Error("Failed to compile exclude patterns", "error", err)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
uiw := cfg.UI
|
uiw := cfg.UI
|
||||||
if uiw == nil {
|
if uiw == nil {
|
||||||
@@ -1875,10 +1880,12 @@ func (s *Scanner) uploadBlobIfNeeded(
|
|||||||
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
||||||
finishedBlob.Compressed, progressCallback)
|
finishedBlob.Compressed, progressCallback)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Only an interrupt cancels ctx, and the user is told about it,
|
// The record is at info level: the returned error ends the backup
|
||||||
// so an upload it stopped is not logged as a storage failure.
|
// and is printed as its ERROR: line. Only an interrupt cancels
|
||||||
|
// ctx, and the user is told about it, so an upload it stopped is
|
||||||
|
// not logged as a storage failure.
|
||||||
if ctx.Err() == nil {
|
if ctx.Err() == nil {
|
||||||
log.Error("Failed to upload blob", "hash", finishedBlob.Hash, "error", err)
|
log.Info("Failed to upload blob", "hash", finishedBlob.Hash, "error", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return 0, false, fmt.Errorf("uploading blob to storage: %w", err)
|
return 0, false, fmt.Errorf("uploading blob to storage: %w", err)
|
||||||
@@ -2316,51 +2323,18 @@ func wrapPermissionError(path string, err error) error {
|
|||||||
"with --skip-errors to continue past unreadable files)", path, err)
|
"with --skip-errors to continue past unreadable files)", path, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// compileExcludePatterns compiles the exclude patterns into glob matchers
|
// compileExcludePatterns compiles the exclude patterns into glob matchers.
|
||||||
func compileExcludePatterns(patterns []string) []compiledPattern {
|
// Config.Validate has already refused a pattern that does not compile.
|
||||||
|
func compileExcludePatterns(patterns []string) ([]compiledPattern, error) {
|
||||||
var compiled []compiledPattern
|
var compiled []compiledPattern
|
||||||
|
|
||||||
for _, p := range patterns {
|
for _, p := range patterns {
|
||||||
if p == "" {
|
globs, anchored, err := exclude.Compile(p)
|
||||||
continue
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if pattern is anchored (starts with /)
|
for _, g := range globs {
|
||||||
anchored := strings.HasPrefix(p, "/")
|
|
||||||
|
|
||||||
pattern := p
|
|
||||||
if anchored {
|
|
||||||
pattern = p[1:] // Remove leading /
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove trailing slash if present (directory indicator)
|
|
||||||
pattern = strings.TrimSuffix(pattern, "/")
|
|
||||||
|
|
||||||
// A leading "**/" demands a "/" before the name and so misses an
|
|
||||||
// entry directly under the source path. It means "at every depth",
|
|
||||||
// which is what an unanchored pattern already does, so drop the
|
|
||||||
// prefix and match unanchored: as in gitignore, "**/x" and
|
|
||||||
// "/**/x" then also match a top-level "x".
|
|
||||||
if rest, found := strings.CutPrefix(pattern, "**/"); found {
|
|
||||||
pattern = rest
|
|
||||||
anchored = false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Likewise "/**/" inside a pattern demands two slashes, so
|
|
||||||
// "a/**/*.log" misses "a/x.log". As in gitignore it stands for
|
|
||||||
// zero or more directories, so also compile the pattern with it
|
|
||||||
// made a single "/". The glob library's {a,b} is no help: with a
|
|
||||||
// "**" inside it in mid-pattern, it misses paths it should match.
|
|
||||||
for _, variant := range doubleStarVariants(pattern) {
|
|
||||||
// For patterns without path separators, we need to match them as components
|
|
||||||
// e.g., ".git" should match ".git" anywhere in the path
|
|
||||||
g, err := glob.Compile(variant, '/')
|
|
||||||
if err != nil {
|
|
||||||
log.Warn("Invalid exclude pattern, skipping", "pattern", p, "error", err)
|
|
||||||
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
compiled = append(compiled, compiledPattern{
|
compiled = append(compiled, compiledPattern{
|
||||||
pattern: g,
|
pattern: g,
|
||||||
anchored: anchored,
|
anchored: anchored,
|
||||||
@@ -2369,26 +2343,7 @@ func compileExcludePatterns(patterns []string) []compiledPattern {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return compiled
|
return compiled, nil
|
||||||
}
|
|
||||||
|
|
||||||
// doubleStarVariants returns pattern once for every way of keeping each
|
|
||||||
// "/**/" in it or making it a single "/".
|
|
||||||
func doubleStarVariants(pattern string) []string {
|
|
||||||
const doubleStar = "/**/"
|
|
||||||
|
|
||||||
before, after, found := strings.Cut(pattern, doubleStar)
|
|
||||||
if !found {
|
|
||||||
return []string{pattern}
|
|
||||||
}
|
|
||||||
|
|
||||||
var variants []string
|
|
||||||
|
|
||||||
for _, rest := range doubleStarVariants(after) {
|
|
||||||
variants = append(variants, before+doubleStar+rest, before+"/"+rest)
|
|
||||||
}
|
|
||||||
|
|
||||||
return variants
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// shouldExclude checks if a path should be excluded based on exclude patterns
|
// shouldExclude checks if a path should be excluded based on exclude patterns
|
||||||
|
|||||||
@@ -37,9 +37,9 @@ func uploadTestBlob(ctx context.Context, store storage.Storer) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// captureLog runs fn and returns what the logger wrote to stderr
|
// captureLog runs fn and returns what the logger wrote to stderr
|
||||||
// meanwhile. The logger writes to the os.Stderr it finds when it is
|
// meanwhile, at the --verbose level. The logger writes to the os.Stderr
|
||||||
// initialized, so os.Stderr is pointed at a file first. Not
|
// it finds when it is initialized, so os.Stderr is pointed at a file
|
||||||
// parallel-safe: os.Stderr and the logger are process-global.
|
// first. Not parallel-safe: os.Stderr and the logger are process-global.
|
||||||
func captureLog(t *testing.T, fn func()) string {
|
func captureLog(t *testing.T, fn func()) string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ func captureLog(t *testing.T, fn func()) string {
|
|||||||
previous := os.Stderr
|
previous := os.Stderr
|
||||||
os.Stderr = stderrFile
|
os.Stderr = stderrFile
|
||||||
|
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{Verbose: true})
|
||||||
|
|
||||||
fn()
|
fn()
|
||||||
|
|
||||||
@@ -107,10 +107,10 @@ func TestInterruptedUploadIsNotLoggedAsError(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// An upload that fails for any other reason is still logged as an error.
|
// An upload that fails for any other reason is still logged.
|
||||||
//
|
//
|
||||||
//nolint:paralleltest // captureLog replaces os.Stderr
|
//nolint:paralleltest // captureLog replaces os.Stderr
|
||||||
func TestFailedUploadIsLoggedAsError(t *testing.T) {
|
func TestFailedUploadIsLogged(t *testing.T) {
|
||||||
inner, err := storage.NewFileStorer(t.TempDir())
|
inner, err := storage.NewFileStorer(t.TempDir())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
|||||||
+10
-6
@@ -17,6 +17,9 @@
|
|||||||
// Count, Percent) return ANSI-colored strings the caller composes into
|
// Count, Percent) return ANSI-colored strings the caller composes into
|
||||||
// the message body. When color is disabled (non-TTY output or NO_COLOR
|
// the message body. When color is disabled (non-TTY output or NO_COLOR
|
||||||
// set) all formatters return plain text.
|
// set) all formatters return plain text.
|
||||||
|
//
|
||||||
|
// QuoteUnprintable is the same escaping without colour, for plain tables
|
||||||
|
// that print paths from the snapshot database.
|
||||||
package ui
|
package ui
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -227,17 +230,17 @@ func (w *Writer) Hex(s string) string {
|
|||||||
short = s[:hexAbbrevLen] + "..."
|
short = s[:hexAbbrevLen] + "..."
|
||||||
}
|
}
|
||||||
|
|
||||||
return w.paint(ansiCyan, sanitize(short))
|
return w.paint(ansiCyan, QuoteUnprintable(short))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Snapshot colorizes a snapshot ID (full, no abbreviation).
|
// Snapshot colorizes a snapshot ID (full, no abbreviation).
|
||||||
func (w *Writer) Snapshot(id string) string {
|
func (w *Writer) Snapshot(id string) string {
|
||||||
return w.paint(ansiCyan+ansiBold, sanitize(id))
|
return w.paint(ansiCyan+ansiBold, QuoteUnprintable(id))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Path colorizes a filesystem path.
|
// Path colorizes a filesystem path.
|
||||||
func (w *Writer) Path(p string) string {
|
func (w *Writer) Path(p string) string {
|
||||||
return w.paint(ansiBlue, sanitize(p))
|
return w.paint(ansiBlue, QuoteUnprintable(p))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Size colorizes a byte count using humanize.Bytes.
|
// Size colorizes a byte count using humanize.Bytes.
|
||||||
@@ -312,14 +315,15 @@ func (w *Writer) paint(color, s string) string {
|
|||||||
return color + s + ansiReset
|
return color + s + ansiReset
|
||||||
}
|
}
|
||||||
|
|
||||||
// sanitize returns s unchanged when every rune in it is printable, and a
|
// QuoteUnprintable returns s unchanged when every rune in it is printable,
|
||||||
// double-quoted, backslash-escaped form (\n, \x1b, …) otherwise. The
|
// and a double-quoted, backslash-escaped form (\n, \x1b, …) otherwise. The
|
||||||
// string value formatters escape their argument through this before
|
// string value formatters escape their argument through this before
|
||||||
// painting: identifiers, paths and symlink targets they render come from
|
// painting: identifiers, paths and symlink targets they render come from
|
||||||
// the snapshot database, which is not trusted, and escaping must happen
|
// the snapshot database, which is not trusted, and escaping must happen
|
||||||
// before colour is applied — the painted result already contains the
|
// before colour is applied — the painted result already contains the
|
||||||
// escape codes the raw text would otherwise be indistinguishable from.
|
// escape codes the raw text would otherwise be indistinguishable from.
|
||||||
func sanitize(s string) string {
|
// Plain tables call it directly.
|
||||||
|
func QuoteUnprintable(s string) string {
|
||||||
for _, r := range s {
|
for _, r := range s {
|
||||||
if !unicode.IsPrint(r) {
|
if !unicode.IsPrint(r) {
|
||||||
return strconv.Quote(s)
|
return strconv.Quote(s)
|
||||||
|
|||||||
@@ -160,7 +160,8 @@ func (v *Vaultik) FetchBlob(
|
|||||||
// Not every backend's reader stops on cancel by itself (the file
|
// Not every backend's reader stops on cancel by itself (the file
|
||||||
// backend's does not), and a read stalled on a slow or hung source would
|
// backend's does not), and a read stalled on a slow or hung source would
|
||||||
// otherwise outlast the shutdown timeout, so the process would exit
|
// otherwise outlast the shutdown timeout, so the process would exit
|
||||||
// before restore or deep verify removed its decrypted temporary files.
|
// before restore, deep verify or `snapshot files` removed its decrypted
|
||||||
|
// temporary files.
|
||||||
type closeOnCancelReader struct {
|
type closeOnCancelReader struct {
|
||||||
io.ReadCloser
|
io.ReadCloser
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ShowInfo displays system and configuration information
|
// ShowInfo displays system and configuration information
|
||||||
@@ -187,6 +188,9 @@ type SnapshotMetadataInfo struct {
|
|||||||
// backup interrupted before its manifest upload leaves a directory
|
// backup interrupted before its manifest upload leaves a directory
|
||||||
// without one, which prune does not treat as a snapshot.
|
// without one, which prune does not treat as a snapshot.
|
||||||
hasManifest bool
|
hasManifest bool
|
||||||
|
|
||||||
|
// Hashes of the blobs the snapshot's manifest lists.
|
||||||
|
blobHashes []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoteInfoResult contains all remote storage information
|
// RemoteInfoResult contains all remote storage information
|
||||||
@@ -216,6 +220,13 @@ type RemoteInfoResult struct {
|
|||||||
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
||||||
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
||||||
|
|
||||||
|
// Blobs that a manifest lists but the destination does not hold,
|
||||||
|
// and the remote key of each snapshot whose manifest lists one.
|
||||||
|
// Those snapshots cannot be restored.
|
||||||
|
MissingBlobCount int `json:"missing_blob_count"`
|
||||||
|
MissingBlobSize int64 `json:"missing_blob_size"`
|
||||||
|
SnapshotsMissingBlobs []string `json:"snapshots_missing_blobs,omitempty"`
|
||||||
|
|
||||||
// Remote key of each snapshot whose manifest could not be read
|
// Remote key of each snapshot whose manifest could not be read
|
||||||
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
||||||
|
|
||||||
@@ -283,19 +294,30 @@ func (v *Vaultik) RemoteInfo(jsonOutput bool) error {
|
|||||||
"snapshots", result.TotalMetadataCount,
|
"snapshots", result.TotalMetadataCount,
|
||||||
"total_blobs", result.TotalBlobCount,
|
"total_blobs", result.TotalBlobCount,
|
||||||
"referenced_blobs", result.ReferencedBlobCount,
|
"referenced_blobs", result.ReferencedBlobCount,
|
||||||
|
"missing_blobs", result.MissingBlobCount,
|
||||||
"unreadable_manifests", len(result.UnreadableManifests))
|
"unreadable_manifests", len(result.UnreadableManifests))
|
||||||
|
|
||||||
if jsonOutput {
|
if jsonOutput {
|
||||||
enc := json.NewEncoder(v.Stdout)
|
enc := json.NewEncoder(v.Stdout)
|
||||||
enc.SetIndent("", " ")
|
enc.SetIndent("", " ")
|
||||||
|
|
||||||
return enc.Encode(result)
|
err = enc.Encode(result)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("encoding JSON: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if showText {
|
if showText {
|
||||||
v.printRemoteInfoTable(result)
|
v.printRemoteInfoTable(result)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The report is written first, so the exit status adds to it.
|
||||||
|
if result.MissingBlobCount > 0 {
|
||||||
|
return fmt.Errorf("%w: %d blob(s) that snapshots list are missing; "+
|
||||||
|
"%d snapshot(s) cannot be restored", errProblemsInStorage,
|
||||||
|
result.MissingBlobCount, len(result.SnapshotsMissingBlobs))
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -405,6 +427,7 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
for _, blob := range manifest.Blobs {
|
for _, blob := range manifest.Blobs {
|
||||||
referencedBlobs[blob.Hash] = blob.CompressedSize
|
referencedBlobs[blob.Hash] = blob.CompressedSize
|
||||||
blobsSize += blob.CompressedSize
|
blobsSize += blob.CompressedSize
|
||||||
|
info.blobHashes = append(info.blobHashes, blob.Hash)
|
||||||
}
|
}
|
||||||
|
|
||||||
info.BlobCount = &blobCount
|
info.BlobCount = &blobCount
|
||||||
@@ -462,6 +485,8 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
result.TotalBlobSize += blob.Size
|
result.TotalBlobSize += blob.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
|
countMissingBlobs(result, referencedBlobs, allBlobs)
|
||||||
|
|
||||||
// A blob named only by a manifest that could not be read, or by one
|
// A blob named only by a manifest that could not be read, or by one
|
||||||
// under a skipped name, would be counted as orphaned, so the orphan
|
// under a skipped name, would be counted as orphaned, so the orphan
|
||||||
// figures stay unknown.
|
// figures stay unknown.
|
||||||
@@ -487,6 +512,33 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// countMissingBlobs records in result the referenced blobs that
|
||||||
|
// allBlobs, the listing of the destination, does not hold, and the
|
||||||
|
// snapshots whose manifests list one of them. It reads the snapshots
|
||||||
|
// from result.Snapshots, so populateRemoteInfoResult must run first.
|
||||||
|
func countMissingBlobs(
|
||||||
|
result *RemoteInfoResult, referencedBlobs map[string]int64,
|
||||||
|
allBlobs map[string]storage.ObjectInfo,
|
||||||
|
) {
|
||||||
|
for hash, size := range referencedBlobs {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.MissingBlobCount++
|
||||||
|
result.MissingBlobSize += size
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, info := range result.Snapshots {
|
||||||
|
for _, hash := range info.blobHashes {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.SnapshotsMissingBlobs = append(
|
||||||
|
result.SnapshotsMissingBlobs, info.SnapshotID)
|
||||||
|
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// printRemoteInfoTable renders the human-readable remote info output
|
// printRemoteInfoTable renders the human-readable remote info output
|
||||||
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
||||||
const (
|
const (
|
||||||
@@ -539,6 +591,12 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
"", "", ubytes(result.TotalMetadataSize))
|
"", "", ubytes(result.TotalMetadataSize))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
v.printBlobStorageSummary(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printBlobStorageSummary renders the blob storage section that ends
|
||||||
|
// the human-readable remote info output.
|
||||||
|
func (v *Vaultik) printBlobStorageSummary(result *RemoteInfoResult) {
|
||||||
v.stdoutf("\n=== Blob Storage ===\n")
|
v.stdoutf("\n=== Blob Storage ===\n")
|
||||||
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.TotalBlobCount)),
|
humanize.Comma(int64(result.TotalBlobCount)),
|
||||||
@@ -546,22 +604,31 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.ReferencedBlobCount)),
|
humanize.Comma(int64(result.ReferencedBlobCount)),
|
||||||
ubytes(result.ReferencedBlobSize))
|
ubytes(result.ReferencedBlobSize))
|
||||||
|
v.stdoutf("Missing from remote: %s (%s)\n",
|
||||||
|
humanize.Comma(int64(result.MissingBlobCount)),
|
||||||
|
ubytes(result.MissingBlobSize))
|
||||||
|
|
||||||
if result.OrphanedBlobCount == nil {
|
if result.OrphanedBlobCount == nil {
|
||||||
v.stdoutf("Orphaned (unreferenced): unknown "+
|
v.stdoutf("Orphaned (unreferenced): unknown "+
|
||||||
"(%d manifest(s) could not be read, "+
|
"(%d manifest(s) could not be read, "+
|
||||||
"%d manifest(s) under a non-conforming name skipped)\n",
|
"%d manifest(s) under a non-conforming name skipped)\n",
|
||||||
len(result.UnreadableManifests), result.SkippedManifestCount)
|
len(result.UnreadableManifests), result.SkippedManifestCount)
|
||||||
|
} else {
|
||||||
|
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
||||||
|
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
||||||
|
ubytes(*result.OrphanedBlobSize))
|
||||||
|
|
||||||
return
|
if *result.OrphanedBlobCount > 0 {
|
||||||
|
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
if len(result.SnapshotsMissingBlobs) > 0 {
|
||||||
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
v.stdoutf("\nSnapshots that cannot be restored (blobs missing):\n")
|
||||||
ubytes(*result.OrphanedBlobSize))
|
|
||||||
|
|
||||||
if *result.OrphanedBlobCount > 0 {
|
for _, id := range result.SnapshotsMissingBlobs {
|
||||||
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
v.stdoutf(" %s\n", id)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -83,6 +83,7 @@ func TestRemoteInfo_UnreadableManifestLeavesSnapshotBlobsUnknown(t *testing.T) {
|
|||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
readableKey := env.addRemote(t, listRemoteID,
|
readableKey := env.addRemote(t, listRemoteID,
|
||||||
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
require.NoError(t, env.store.Put(context.Background(),
|
||||||
@@ -270,6 +271,7 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
|
|
||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
||||||
|
|
||||||
@@ -281,3 +283,61 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRemoteInfo_ReportsBlobsMissingFromDestination checks that a blob a
|
||||||
|
// manifest lists but the destination does not hold is counted as
|
||||||
|
// missing, that the snapshot listing it is named, and that remote info
|
||||||
|
// then fails after writing its report.
|
||||||
|
func TestRemoteInfo_ReportsBlobsMissingFromDestination(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newListEnv(t)
|
||||||
|
|
||||||
|
// The first snapshot lists blob A, which is not stored. The second
|
||||||
|
// lists blob B, which is.
|
||||||
|
brokenKey := env.addRemote(t, listRemoteID,
|
||||||
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addManifest(t, env.store.testStorer, listLocalID, []string{testBlobHashB})
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashB)
|
||||||
|
|
||||||
|
const wantError = "1 blob(s) that snapshots list are missing; " +
|
||||||
|
"1 snapshot(s) cannot be restored"
|
||||||
|
|
||||||
|
err := env.v.RemoteInfo(false)
|
||||||
|
require.ErrorContains(t, err, wantError)
|
||||||
|
|
||||||
|
text := env.stdout.String()
|
||||||
|
assert.Contains(t, text, "Missing from remote: 1 (5.0 MB)")
|
||||||
|
assert.Contains(t, text, "Snapshots that cannot be restored (blobs missing):\n"+
|
||||||
|
" "+brokenKey+"\n")
|
||||||
|
assert.NotContains(t, text, snapshot.RemoteSnapshotKey(listLocalID)+"\n")
|
||||||
|
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(true), wantError)
|
||||||
|
|
||||||
|
var doc map[string]any
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 1, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, fiveMegabytes, doc["missing_blob_size"], 0)
|
||||||
|
assert.Equal(t, []any{brokenKey}, doc["snapshots_missing_blobs"])
|
||||||
|
|
||||||
|
// --quiet drops the report, not the failure.
|
||||||
|
env.stdout.Reset()
|
||||||
|
env.v.UI.SetQuiet(true)
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(false), wantError)
|
||||||
|
assert.Empty(t, env.stdout.String())
|
||||||
|
env.v.UI.SetQuiet(false)
|
||||||
|
|
||||||
|
// With blob A stored again nothing is missing.
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.NoError(t, env.v.RemoteInfo(true))
|
||||||
|
|
||||||
|
doc = nil
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_size"], 0)
|
||||||
|
assert.NotContains(t, doc, "snapshots_missing_blobs")
|
||||||
|
}
|
||||||
@@ -472,6 +472,68 @@ func TestRemoveSnapshot_NotInLocalIndex(t *testing.T) {
|
|||||||
assert.Contains(t, out, "Removed snapshot metadata from remote storage")
|
assert.Contains(t, out, "Removed snapshot metadata from remote storage")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRemoveSnapshot_ByRemoteKey checks that a snapshot only the
|
||||||
|
// destination store holds can be removed by the remote key that
|
||||||
|
// `snapshot list` shows for it, or by a leading part of that key.
|
||||||
|
func TestRemoveSnapshot_ByRemoteKey(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
remoteKey := snapshot.RemoteSnapshotKey("snapshot-001")
|
||||||
|
|
||||||
|
for name, identifier := range map[string]string{
|
||||||
|
"full key": remoteKey,
|
||||||
|
"leading part": remoteKey[:8],
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
store := newTestStorer()
|
||||||
|
addManifest(t, store, "snapshot-001", nil)
|
||||||
|
|
||||||
|
tv := vaultik.NewForTesting(store)
|
||||||
|
tv.Repositories = newLocalIndex(t)
|
||||||
|
|
||||||
|
result, err := tv.RemoveSnapshot(identifier,
|
||||||
|
&vaultik.RemoveOptions{Force: true})
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, result.RemoteRemoved)
|
||||||
|
assert.False(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRemoveSnapshot_ByRemoteKeyInLocalIndex checks that a snapshot the
|
||||||
|
// local index holds, named by its remote key, is removed from the local
|
||||||
|
// index as well as from the destination store.
|
||||||
|
func TestRemoveSnapshot_ByRemoteKeyInLocalIndex(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
store := newTestStorer()
|
||||||
|
addManifest(t, store, "snapshot-001", nil)
|
||||||
|
|
||||||
|
// A backup wrote to this destination, so it carries the marker.
|
||||||
|
require.NoError(t, store.Put(context.Background(), markerFile,
|
||||||
|
bytes.NewReader(nil)))
|
||||||
|
|
||||||
|
tv := vaultik.NewForTesting(store)
|
||||||
|
tv.Repositories = newLocalIndex(t, "snapshot-001")
|
||||||
|
|
||||||
|
result, err := tv.RemoveSnapshot(snapshot.RemoteSnapshotKey("snapshot-001"),
|
||||||
|
&vaultik.RemoveOptions{Force: true})
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, result.RemoteRemoved)
|
||||||
|
assert.False(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
||||||
|
|
||||||
|
snap, err := tv.Repositories.Snapshots.GetByID(context.Background(),
|
||||||
|
"snapshot-001")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Nil(t, snap)
|
||||||
|
}
|
||||||
|
|
||||||
// TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a
|
// TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a
|
||||||
// snapshot only the destination store holds fails when its metadata
|
// snapshot only the destination store holds fails when its metadata
|
||||||
// cannot be deleted there, under --force and under --json: nothing was
|
// cannot be deleted there, under --force and under --json: nothing was
|
||||||
|
|||||||
+32
-26
@@ -31,7 +31,7 @@ var (
|
|||||||
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(
|
||||||
"decryption key required for restore\n\n" +
|
"decryption key required\n\n" +
|
||||||
"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
|
"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
|
||||||
"age private key file:\n" +
|
"age private key file:\n" +
|
||||||
" export VAULTIK_AGE_SECRET_KEY=\"$(cat vaultik_backup_private_key.txt)\"")
|
" export VAULTIK_AGE_SECRET_KEY=\"$(cat vaultik_backup_private_key.txt)\"")
|
||||||
@@ -153,18 +153,7 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
return fmt.Errorf("downloading snapshot database: %w", err)
|
return fmt.Errorf("downloading snapshot database: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
defer func() {
|
defer v.closeSnapshotDB(tempDB, tempDir)
|
||||||
err := tempDB.Close()
|
|
||||||
if err != nil {
|
|
||||||
log.Debug("Failed to close temp database", "error", err)
|
|
||||||
}
|
|
||||||
// Remove the whole private directory, so the decrypted database
|
|
||||||
// and any SQLite side files it produced are gone on every path.
|
|
||||||
err = v.Fs.RemoveAll(tempDir)
|
|
||||||
if err != nil {
|
|
||||||
log.Debug("Failed to remove temp database directory", "error", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
repos := database.NewRepositories(tempDB)
|
repos := database.NewRepositories(tempDB)
|
||||||
|
|
||||||
@@ -325,9 +314,10 @@ func (v *Vaultik) reportUnmatchedPaths(unmatched []string) error {
|
|||||||
// identity it contains. The value may be a single key line or a whole
|
// identity it contains. The value may be a single key line or a whole
|
||||||
// age-keygen file with several identities; all of them are returned so
|
// age-keygen file with several identities; all of them are returned so
|
||||||
// blobgen (via age.Decrypt) can read a blob encrypted to any of their
|
// blobgen (via age.Decrypt) can read a blob encrypted to any of their
|
||||||
// recipients. This is the first step of both restore and deep verify, so
|
// recipients. This is the first step of restore, deep verify and
|
||||||
// a missing or unparseable key fails before anything is downloaded. The
|
// `snapshot files`, so a missing or unparseable key fails before anything
|
||||||
// error names the configuration source but never the key value.
|
// is downloaded. The error names the configuration source but never the
|
||||||
|
// key value.
|
||||||
func (v *Vaultik) restoreIdentities() ([]age.Identity, error) {
|
func (v *Vaultik) restoreIdentities() ([]age.Identity, error) {
|
||||||
if v.Config.AgeSecretKey == "" {
|
if v.Config.AgeSecretKey == "" {
|
||||||
return nil, errDecryptionKeyRequired
|
return nil, errDecryptionKeyRequired
|
||||||
@@ -667,19 +657,19 @@ func (v *Vaultik) restoreProgressTick(
|
|||||||
|
|
||||||
// handleRestoreFileError records a per-file restore failure: fatal unless
|
// handleRestoreFileError records a per-file restore failure: fatal unless
|
||||||
// --skip-errors is set, in which case the file is counted as failed and
|
// --skip-errors is set, in which case the file is counted as failed and
|
||||||
// dropped from the plan.
|
// dropped from the plan. A fatal failure is not logged here: the returned
|
||||||
|
// error is printed as the command's ERROR: line.
|
||||||
func (v *Vaultik) handleRestoreFileError(
|
func (v *Vaultik) handleRestoreFileError(
|
||||||
plan *restorePlan, opts *RestoreOptions, result *RestoreResult,
|
plan *restorePlan, opts *RestoreOptions, result *RestoreResult,
|
||||||
file *database.File, fileID types.FileID, err error,
|
file *database.File, fileID types.FileID, err error,
|
||||||
) error {
|
) error {
|
||||||
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
|
||||||
|
|
||||||
if !opts.SkipErrors {
|
if !opts.SkipErrors {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf(
|
||||||
"restoring %s: %w (pass --skip-errors to continue past "+
|
"restoring %s: %w (pass --skip-errors to continue past "+
|
||||||
"restore failures)", file.Path, err)
|
"restore failures)", file.Path, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
||||||
v.UI.Errorf("Failed to restore %s: %v. Skipping (--skip-errors).",
|
v.UI.Errorf("Failed to restore %s: %v. Skipping (--skip-errors).",
|
||||||
v.UI.Path(file.Path.String()), err)
|
v.UI.Path(file.Path.String()), err)
|
||||||
|
|
||||||
@@ -880,18 +870,34 @@ func (v *Vaultik) downloadSnapshotDB(
|
|||||||
return db, tempDir, nil
|
return db, tempDir, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// closeSnapshotDB closes a database returned by downloadSnapshotDB and
|
||||||
|
// removes its private directory, so the decrypted database and any SQLite
|
||||||
|
// side files it produced are gone.
|
||||||
|
func (v *Vaultik) closeSnapshotDB(db *database.DB, tempDir string) {
|
||||||
|
err := db.Close()
|
||||||
|
if err != nil {
|
||||||
|
log.Debug("Failed to close temp database", "error", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.Fs.RemoveAll(tempDir)
|
||||||
|
if err != nil {
|
||||||
|
log.Debug("Failed to remove temp database directory", "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// verifySnapshotDBIdentity confirms the decrypted metadata database really
|
// verifySnapshotDBIdentity confirms the decrypted metadata database really
|
||||||
// is the snapshot named by remoteKey. age decryption proves the database
|
// is the snapshot named by remoteKey. age decryption proves the database
|
||||||
// is readable, not that the object served at
|
// is readable, not that the object served at
|
||||||
// metadata/<remoteKey>/db.zst.age is the snapshot that was requested: an
|
// metadata/<remoteKey>/db.zst.age is the snapshot that was requested: an
|
||||||
// attacker who swaps in another valid db.zst.age (which needs no key
|
// attacker who swaps in another valid db.zst.age (which needs no key
|
||||||
// material) would otherwise redirect restore and deep verify to a
|
// material) would otherwise redirect restore, deep verify and
|
||||||
// different snapshot's contents. The exported per-snapshot database holds
|
// `snapshot files` to a different snapshot's contents. The exported
|
||||||
// exactly one snapshot row, and a snapshot's remote key is derived from
|
// per-snapshot database holds exactly one snapshot row, and a snapshot's
|
||||||
// that row's ID, so the database is the requested one exactly when its
|
// remote key is derived from that row's ID, so the database is the
|
||||||
// sole snapshot hashes back to remoteKey. Comparing the requested
|
// requested one exactly when its sole snapshot hashes back to remoteKey.
|
||||||
// identifier directly would not do: it may be a remote-key prefix a
|
// Comparing the requested identifier directly would not do: it may be a
|
||||||
// recovery host uses in place of a human snapshot ID it cannot know.
|
// remote-key prefix a recovery host uses in place of a human snapshot ID
|
||||||
|
// it cannot know.
|
||||||
func (v *Vaultik) verifySnapshotDBIdentity(
|
func (v *Vaultik) verifySnapshotDBIdentity(
|
||||||
db *database.DB, requested, remoteKey string,
|
db *database.DB, requested, remoteKey string,
|
||||||
) error {
|
) error {
|
||||||
|
|||||||
@@ -1467,7 +1467,8 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
|
|
||||||
inLocalIndex, err := v.checkSnapshotExists(snapshotID, opts.LocalOnly)
|
snapshotID, remoteKey, inLocalIndex, err := v.findSnapshotToRemove(
|
||||||
|
snapshotID, opts.LocalOnly)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
@@ -1498,7 +1499,7 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
}
|
}
|
||||||
|
|
||||||
result.RemoteRemoved, err = v.removeSnapshotRemote(
|
result.RemoteRemoved, err = v.removeSnapshotRemote(
|
||||||
snapshotID, inLocalIndex, markerErr, opts)
|
snapshotID, remoteKey, inLocalIndex, markerErr, opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
@@ -1530,6 +1531,41 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// findSnapshotToRemove returns the ID of the snapshot that identifier
|
||||||
|
// names, its remote key, and whether the local index holds it. A remote
|
||||||
|
// key, or the leading part of one, is resolved on the destination store;
|
||||||
|
// when the local index holds the snapshot with that key, its ID is
|
||||||
|
// returned, so it is removed from both.
|
||||||
|
func (v *Vaultik) findSnapshotToRemove(
|
||||||
|
identifier string, localOnly bool,
|
||||||
|
) (string, string, bool, error) {
|
||||||
|
if !isRemoteKeyOrPrefix(identifier) || localOnly {
|
||||||
|
inLocalIndex, err := v.checkSnapshotExists(identifier, localOnly)
|
||||||
|
|
||||||
|
return identifier, snapshot.RemoteSnapshotKey(identifier),
|
||||||
|
inLocalIndex, err
|
||||||
|
}
|
||||||
|
|
||||||
|
remoteKey, err := v.resolveSnapshotRemoteKey(identifier)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
localIDs, err := v.localSnapshotIDs()
|
||||||
|
if err != nil {
|
||||||
|
return "", "", false, fmt.Errorf(
|
||||||
|
"looking up snapshot in local index: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, id := range localIDs {
|
||||||
|
if snapshot.RemoteSnapshotKey(id) == remoteKey {
|
||||||
|
return id, remoteKey, true, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return identifier, remoteKey, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
// checkSnapshotExists returns errSnapshotNotFound when the local index
|
// checkSnapshotExists returns errSnapshotNotFound when the local index
|
||||||
// has no row for snapshotID and, unless localOnly is set, the
|
// has no row for snapshotID and, unless localOnly is set, the
|
||||||
// destination store has no metadata for it either. inLocalIndex reports
|
// destination store has no metadata for it either. inLocalIndex reports
|
||||||
@@ -1638,8 +1674,8 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions)
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// removeSnapshotRemote strips the snapshot's metadata from the
|
// removeSnapshotRemote strips the snapshot's metadata, under remoteKey,
|
||||||
// destination store. It returns true only when the delete finished
|
// from the destination store. It returns true only when the delete finished
|
||||||
// without an error and removed at least one object; under LocalOnly it
|
// without an error and removed at least one object; under LocalOnly it
|
||||||
// does nothing. markerErr is the result of checkDestinationMarker; when
|
// does nothing. markerErr is the result of checkDestinationMarker; when
|
||||||
// it is set, nothing is deleted and it is the failure. When the snapshot
|
// it is set, nothing is deleted and it is the failure. When the snapshot
|
||||||
@@ -1651,7 +1687,7 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions)
|
|||||||
// (`vaultik prune` never removes snapshot metadata that has its
|
// (`vaultik prune` never removes snapshot metadata that has its
|
||||||
// manifest).
|
// manifest).
|
||||||
func (v *Vaultik) removeSnapshotRemote(
|
func (v *Vaultik) removeSnapshotRemote(
|
||||||
snapshotID string, inLocalIndex bool, markerErr error,
|
snapshotID, remoteKey string, inLocalIndex bool, markerErr error,
|
||||||
opts *RemoveOptions,
|
opts *RemoveOptions,
|
||||||
) (bool, error) {
|
) (bool, error) {
|
||||||
if opts.LocalOnly {
|
if opts.LocalOnly {
|
||||||
@@ -1665,8 +1701,7 @@ func (v *Vaultik) removeSnapshotRemote(
|
|||||||
|
|
||||||
err := markerErr
|
err := markerErr
|
||||||
if err == nil {
|
if err == nil {
|
||||||
deleted, err = v.deleteRemoteSnapshotByKey(
|
deleted, err = v.deleteRemoteSnapshotByKey(remoteKey)
|
||||||
snapshot.RemoteSnapshotKey(snapshotID))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil && !inLocalIndex {
|
if err != nil && !inLocalIndex {
|
||||||
|
|||||||
@@ -0,0 +1,115 @@
|
|||||||
|
package vaultik
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"text/tabwriter"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ListedFile is one entry printed by `snapshot files`. Mode is the Go
|
||||||
|
// file mode string, which shows the entry type and the permission bits
|
||||||
|
// (for example -rw-r--r-- or drwxr-xr-x).
|
||||||
|
type ListedFile struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Size int64 `json:"size"`
|
||||||
|
Mode string `json:"mode"`
|
||||||
|
MTime time.Time `json:"mtime"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListSnapshotFiles prints the path, size, mode and modification time of
|
||||||
|
// every file the snapshot holds at or under path, or of every file when
|
||||||
|
// path is empty. The file list is only in the snapshot's encrypted
|
||||||
|
// database, so this downloads and decrypts it as restore does, and needs
|
||||||
|
// the private key.
|
||||||
|
func (v *Vaultik) ListSnapshotFiles(snapshotID, path string, jsonOutput bool) error {
|
||||||
|
identities, err := v.restoreIdentities()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
remoteKey, err := v.resolveSnapshotRemoteKey(snapshotID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
db, tempDir, err := v.downloadSnapshotDB(snapshotID, remoteKey, identities)
|
||||||
|
if errors.Is(err, errWrongPrivateKey) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("downloading snapshot database: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer v.closeSnapshotDB(db, tempDir)
|
||||||
|
|
||||||
|
repos := database.NewRepositories(db)
|
||||||
|
|
||||||
|
var files []*database.File
|
||||||
|
|
||||||
|
if path == "" {
|
||||||
|
files, err = repos.Files.ListAll(v.ctx)
|
||||||
|
} else {
|
||||||
|
files, err = repos.Files.ListUnderPath(v.ctx, filepath.Clean(path))
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("listing files: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if path != "" && len(files) == 0 {
|
||||||
|
return fmt.Errorf("%w: %s", errPathsNotInSnapshot, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
entries := make([]ListedFile, 0, len(files))
|
||||||
|
|
||||||
|
for _, file := range files {
|
||||||
|
entries = append(entries, ListedFile{
|
||||||
|
Path: file.Path.String(),
|
||||||
|
Size: file.Size,
|
||||||
|
Mode: os.FileMode(file.Mode).String(),
|
||||||
|
MTime: file.MTime,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if jsonOutput {
|
||||||
|
encoder := json.NewEncoder(v.Stdout)
|
||||||
|
encoder.SetIndent("", " ")
|
||||||
|
|
||||||
|
return encoder.Encode(entries)
|
||||||
|
}
|
||||||
|
|
||||||
|
if v.UI.Quiet() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return v.printListedFileTable(entries)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printListedFileTable writes the entries as a plain table to stdout.
|
||||||
|
func (v *Vaultik) printListedFileTable(entries []ListedFile) error {
|
||||||
|
w := tabwriter.NewWriter(v.Stdout, 0, 0, tabPadding, ' ', 0)
|
||||||
|
|
||||||
|
_, err := fmt.Fprintln(w, "MODE\tSIZE\tMODIFIED\tPATH")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, entry := range entries {
|
||||||
|
_, err = fmt.Fprintf(w, "%s\t%d\t%s\t%s\n",
|
||||||
|
entry.Mode, entry.Size,
|
||||||
|
entry.MTime.Format(time.RFC3339), ui.QuoteUnprintable(entry.Path))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.Flush()
|
||||||
|
}
|
||||||
@@ -0,0 +1,197 @@
|
|||||||
|
package vaultik_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
|
)
|
||||||
|
|
||||||
|
// These tests cover https://git.eeqj.de/sneak/vaultik/issues/435:
|
||||||
|
// `snapshot files` lists what a snapshot holds without restoring it.
|
||||||
|
|
||||||
|
// unprintableFileName is a file name holding a newline and an escape
|
||||||
|
// sequence, which the table must not print raw.
|
||||||
|
const unprintableFileName = "odd\nname\x1b[31m"
|
||||||
|
|
||||||
|
// backUpForFileListing backs up the fault source tree, plus a file named
|
||||||
|
// unprintableFileName at its top, and returns a reader whose stdout is
|
||||||
|
// out, the snapshot ID, and the source directory.
|
||||||
|
func backUpForFileListing(
|
||||||
|
t *testing.T, out *bytes.Buffer,
|
||||||
|
) (*vaultik.Vaultik, string, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
dataDir := filepath.Join(tempDir, "src")
|
||||||
|
dbPath := filepath.Join(tempDir, "index.sqlite")
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
cfg := faultTestConfig()
|
||||||
|
|
||||||
|
writeFaultSourceTree(t, fs, dataDir)
|
||||||
|
require.NoError(t, afero.WriteFile(fs,
|
||||||
|
filepath.Join(dataDir, unprintableFileName), []byte("odd"), 0o644))
|
||||||
|
|
||||||
|
store, err := storage.NewFileStorer(t.TempDir())
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
id := fullFaultBackup(ctx, t, fs, store, cfg,
|
||||||
|
database.NewRepositories(db), dataDir, dbPath, "files")
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
v := newReaderVaultik(ctx, cfg, store, nil, fs)
|
||||||
|
v.Stdout = out
|
||||||
|
|
||||||
|
return v, id, dataDir
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSnapshotFilesJSONListsEveryFileWithItsMetadata(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, dataDir := backUpForFileListing(t, &out)
|
||||||
|
|
||||||
|
require.NoError(t, v.ListSnapshotFiles(id, "", true))
|
||||||
|
|
||||||
|
var entries []vaultik.ListedFile
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal(out.Bytes(), &entries))
|
||||||
|
|
||||||
|
byPath := make(map[string]vaultik.ListedFile, len(entries))
|
||||||
|
for _, entry := range entries {
|
||||||
|
byPath[entry.Path] = entry
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, rel := range []string{"small.txt", "a.bin", "sub", "sub/b.bin", "sub/c.bin"} {
|
||||||
|
path := filepath.Join(dataDir, rel)
|
||||||
|
|
||||||
|
entry, ok := byPath[path]
|
||||||
|
require.True(t, ok, "%s must be listed", path)
|
||||||
|
|
||||||
|
info, err := afero.NewOsFs().Stat(path)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, info.Mode().String(), entry.Mode, path)
|
||||||
|
assert.True(t, info.ModTime().Equal(entry.MTime),
|
||||||
|
"%s: mtime %v, listed %v", path, info.ModTime(), entry.MTime)
|
||||||
|
|
||||||
|
if !info.IsDir() {
|
||||||
|
assert.Equal(t, info.Size(), entry.Size, path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSnapshotFilesListsOnlyWhatIsUnderThePath(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, dataDir := backUpForFileListing(t, &out)
|
||||||
|
|
||||||
|
require.NoError(t, v.ListSnapshotFiles(id, filepath.Join(dataDir, "sub"), false))
|
||||||
|
|
||||||
|
text := out.String()
|
||||||
|
assert.Contains(t, text, filepath.Join(dataDir, "sub", "b.bin"))
|
||||||
|
assert.Contains(t, text, filepath.Join(dataDir, "sub", "c.bin"))
|
||||||
|
assert.NotContains(t, text, filepath.Join(dataDir, "small.txt"))
|
||||||
|
assert.True(t, strings.HasPrefix(text, "MODE"), "the table must have a header")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSnapshotFilesTableEscapesAnUnprintablePath checks that the table
|
||||||
|
// prints a path holding a newline and an escape sequence quoted and
|
||||||
|
// escaped on one row: the newline must not start a forged row, and the
|
||||||
|
// escape sequence must not reach the terminal.
|
||||||
|
func TestSnapshotFilesTableEscapesAnUnprintablePath(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, dataDir := backUpForFileListing(t, &out)
|
||||||
|
|
||||||
|
require.NoError(t, v.ListSnapshotFiles(id, "", false))
|
||||||
|
|
||||||
|
text := out.String()
|
||||||
|
assert.Contains(t, text,
|
||||||
|
strconv.Quote(filepath.Join(dataDir, unprintableFileName)))
|
||||||
|
assert.NotContains(t, text, "\x1b", "no escape byte may reach the output")
|
||||||
|
|
||||||
|
for line := range strings.SplitSeq(text, "\n") {
|
||||||
|
assert.False(t, strings.HasPrefix(line, "name"),
|
||||||
|
"the newline in the name must not start a row: %q", line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSnapshotFilesQuietSuppressesTableNotJSON is the --quiet contract
|
||||||
|
// for `snapshot files`: the table is silenced, but the --json document a
|
||||||
|
// script depends on is still written.
|
||||||
|
func TestSnapshotFilesQuietSuppressesTableNotJSON(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, _ := backUpForFileListing(t, &out)
|
||||||
|
v.UI.SetQuiet(true)
|
||||||
|
|
||||||
|
require.NoError(t, v.ListSnapshotFiles(id, "", false))
|
||||||
|
require.Empty(t, out.String(), "the table must be silenced under --quiet")
|
||||||
|
|
||||||
|
require.NoError(t, v.ListSnapshotFiles(id, "", true))
|
||||||
|
|
||||||
|
var entries []vaultik.ListedFile
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal(out.Bytes(), &entries))
|
||||||
|
assert.NotEmpty(t, entries,
|
||||||
|
"the --json document must still be written under --quiet")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSnapshotFilesFailsOnAPathThatMatchesNothing(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, dataDir := backUpForFileListing(t, &out)
|
||||||
|
missing := filepath.Join(dataDir, "typo.txt")
|
||||||
|
|
||||||
|
err := v.ListSnapshotFiles(id, missing, false)
|
||||||
|
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), missing, "the error must name the path")
|
||||||
|
assert.Empty(t, out.String(), "nothing must be printed")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSnapshotFilesRequiresThePrivateKey(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v, id, _ := backUpForFileListing(t, &out)
|
||||||
|
v.Config.AgeSecretKey = ""
|
||||||
|
|
||||||
|
err := v.ListSnapshotFiles(id, "", false)
|
||||||
|
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "VAULTIK_AGE_SECRET_KEY")
|
||||||
|
}
|
||||||
@@ -39,7 +39,8 @@ const maxRemoteOnlyRows = 1000
|
|||||||
// manifest reads need throttling.
|
// manifest reads need throttling.
|
||||||
const remoteManifestFetchConcurrency = 8
|
const remoteManifestFetchConcurrency = 8
|
||||||
|
|
||||||
// tabPadding is the tabwriter cell padding for the snapshot table.
|
// tabPadding is the tabwriter cell padding for the `snapshot list` and
|
||||||
|
// `snapshot files` tables.
|
||||||
const tabPadding = 3
|
const tabPadding = 3
|
||||||
|
|
||||||
// ListSnapshots prints the table of snapshots known to this host: the
|
// ListSnapshots prints the table of snapshots known to this host: the
|
||||||
|
|||||||
@@ -349,6 +349,7 @@ func TestSnapshotListAndPurgePrintSizesLikeRemoteInfo(t *testing.T) {
|
|||||||
env.addRemote(t, listLocalID, start)
|
env.addRemote(t, listLocalID, start)
|
||||||
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
||||||
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
||||||
|
|||||||
Reference in new issue
Block a user