Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a717539650 |
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,18 @@ 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. `config`,
|
||||||
|
`database delete`, `completion`, and `version` do not take the lock.
|
||||||
|
|
||||||
### stdout and stderr
|
### stdout and stderr
|
||||||
|
|
||||||
@@ -261,9 +268,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 +415,24 @@ 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`.
|
||||||
|
- 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
|
||||||
@@ -722,7 +747,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 +864,21 @@ 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. The confirmation
|
||||||
|
prompts of `database delete`, `prune`, `snapshot purge` and
|
||||||
|
`snapshot remove`, each with what it asks to delete, are also written this
|
||||||
|
way and always shown: they are 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,
|
||||||
|
|||||||
+5
-4
@@ -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
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -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())
|
||||||
@@ -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{}
|
||||||
|
|||||||
@@ -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)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,130 @@
|
|||||||
|
package vaultik
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"text/tabwriter"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 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), entry.Path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.Flush()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
package vaultik_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"path/filepath"
|
||||||
|
"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.
|
||||||
|
|
||||||
|
// backUpForFileListing backs up the fault source tree 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)
|
||||||
|
|
||||||
|
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")
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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")
|
||||||
|
}
|
||||||
Reference in new issue
Block a user