Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0e94770b90 |
+4
-4
@@ -279,8 +279,8 @@ Key methods:
|
|||||||
- `Scan(ctx, path, snapshotID)` → Main scan operation
|
- `Scan(ctx, path, snapshotID)` → Main scan operation
|
||||||
|
|
||||||
Scan phases:
|
Scan phases:
|
||||||
1. **Phase 1**: Walk directory, identify files needing processing
|
1. **Phase 0**: Detect deleted files from previous snapshots
|
||||||
2. **Phase 1b**: Count as deleted the files that the previous snapshot of the same name lists and the walk did not find; a file that is excluded, or inside an excluded directory, is not counted
|
2. **Phase 1**: Walk directory, identify files needing processing
|
||||||
3. **Phase 2**: Process files (chunk → pack → upload)
|
3. **Phase 2**: Process files (chunk → pack → upload)
|
||||||
|
|
||||||
#### SnapshotManager
|
#### SnapshotManager
|
||||||
@@ -320,13 +320,13 @@ CreateSnapshot(opts)
|
|||||||
│ │
|
│ │
|
||||||
│ ├─► scanner.Scan(ctx, path, snapshotID)
|
│ ├─► scanner.Scan(ctx, path, snapshotID)
|
||||||
│ │ │
|
│ │ │
|
||||||
|
│ │ ├─► Phase 0: detectDeletedFiles()
|
||||||
|
│ │ │
|
||||||
│ │ ├─► Phase 1: scanPhase()
|
│ │ ├─► Phase 1: scanPhase()
|
||||||
│ │ │ Walk directory
|
│ │ │ Walk directory
|
||||||
│ │ │ Check file metadata changes
|
│ │ │ Check file metadata changes
|
||||||
│ │ │ Build list of files to process
|
│ │ │ Build list of files to process
|
||||||
│ │ │
|
│ │ │
|
||||||
│ │ ├─► Phase 1b: detectDeletedFiles()
|
|
||||||
│ │ │
|
|
||||||
│ │ └─► Phase 2: processPhase()
|
│ │ └─► Phase 2: processPhase()
|
||||||
│ │ For each file:
|
│ │ For each file:
|
||||||
│ │ chunker.ChunkReaderStreaming()
|
│ │ chunker.ChunkReaderStreaming()
|
||||||
|
|||||||
@@ -286,9 +286,7 @@ needed.
|
|||||||
remove orphaned blobs from remote storage. By default keeps only the latest
|
remove orphaned blobs from remote storage. By default keeps only the latest
|
||||||
snapshot per name; use `--keep-newer-than` for a rolling window.
|
snapshot per name; use `--keep-newer-than` for a rolling window.
|
||||||
* `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than
|
* `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than
|
||||||
this duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`).
|
this duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`)
|
||||||
Without `--prune`, or with a value that is not a valid duration, the
|
|
||||||
command fails before the backup starts.
|
|
||||||
|
|
||||||
**`snapshot list`**: Show every snapshot known to this host — the union
|
**`snapshot list`**: Show every snapshot known to this host — the union
|
||||||
of the local index and the backup destination store — with timestamps
|
of the local index and the backup destination store — with timestamps
|
||||||
@@ -351,11 +349,9 @@ the backup destination store. Blobs are NOT touched — deleting blobs
|
|||||||
requires reading every remaining remote manifest (the destination store
|
requires reading every remaining remote manifest (the destination store
|
||||||
may hold snapshots this host doesn't know about), which is what
|
may hold snapshots this host doesn't know about), which is what
|
||||||
`vaultik prune` does. On success the command prints the exact `vaultik
|
`vaultik prune` does. On success the command prints the exact `vaultik
|
||||||
prune` invocation to run as a follow-up. An ID that names no snapshot in
|
prune` invocation to run as a follow-up. Local row cleanup (files,
|
||||||
the local index or on the destination store is an error; with
|
chunks, blobs the snapshot was the last referrer for) runs
|
||||||
`--local-only`, the snapshot must be in the local index. Local row
|
automatically. If the destination store is unreachable, the local-DB
|
||||||
cleanup (files, chunks, blobs the snapshot was the last referrer for)
|
|
||||||
runs automatically. If the destination store is unreachable, the local-DB
|
|
||||||
removal still completes and a warning is emitted; run `vaultik snapshot
|
removal still completes and a warning is emitted; run `vaultik snapshot
|
||||||
remove <snapshot-id>` again once the store is reachable to remove the
|
remove <snapshot-id>` again once the store is reachable to remove the
|
||||||
snapshot's metadata from it (`vaultik prune` does not). To wipe everything
|
snapshot's metadata from it (`vaultik prune` does not). To wipe everything
|
||||||
@@ -403,9 +399,7 @@ orphaned blob figures are reported as unknown; `--json` gives them as
|
|||||||
`null`, lists the remote key of each unreadable manifest in
|
`null`, lists the remote key of each unreadable manifest in
|
||||||
`unreadable_manifests` and counts the manifests under skipped names in
|
`unreadable_manifests` and counts the manifests under skipped names in
|
||||||
`skipped_manifest_count`. An unreadable manifest also leaves its
|
`skipped_manifest_count`. An unreadable manifest also leaves its
|
||||||
snapshot's blob count and blob size unknown, `null` in `--json`. A file
|
snapshot's blob count and blob size unknown, `null` in `--json`.
|
||||||
under `blobs/` whose name is not a blob hash is not counted as a blob,
|
|
||||||
since `prune` never deletes it.
|
|
||||||
* `--json`: Output as JSON
|
* `--json`: Output as JSON
|
||||||
|
|
||||||
**`remote nuke`**: Delete every snapshot's metadata and every blob from the
|
**`remote nuke`**: Delete every snapshot's metadata and every blob from the
|
||||||
@@ -418,8 +412,7 @@ destination store.
|
|||||||
entirely. Remote storage is unaffected; the next backup will do a full
|
entirely. Remote storage is unaffected; the next backup will do a full
|
||||||
scan and re-deduplicate against existing remote blobs, and the local
|
scan and re-deduplicate against existing remote blobs, and the local
|
||||||
index will re-bind to the currently configured storage destination.
|
index will re-bind to the currently configured storage destination.
|
||||||
Use this after changing `storage_url`, or `s3.endpoint`, `s3.bucket` or
|
Use this after changing `storage_url` to a different destination.
|
||||||
`s3.prefix`, to a different destination.
|
|
||||||
* `--force`: Skip confirmation prompt
|
* `--force`: Skip confirmation prompt
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -433,10 +426,7 @@ object store. Credentials are read from `s3.access_key_id` and
|
|||||||
`s3.secret_access_key` in the config file.
|
`s3.secret_access_key` in the config file.
|
||||||
|
|
||||||
**Local filesystem** (`file:///path/to/backup`): Stores blobs and metadata on
|
**Local filesystem** (`file:///path/to/backup`): Stores blobs and metadata on
|
||||||
a local or mounted filesystem. Useful for testing or backing up to a NAS. The
|
a local or mounted filesystem. Useful for testing or backing up to a NAS.
|
||||||
path must be absolute; a relative one is refused when the config loads.
|
|
||||||
Percent-escapes in the path are decoded, so `my%20stick` and `my stick` name
|
|
||||||
the same directory.
|
|
||||||
|
|
||||||
**Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud
|
**Rclone** (`rclone://remote/path`): Uses rclone's 70+ supported cloud
|
||||||
providers. Requires rclone to be configured separately (`rclone config`).
|
providers. Requires rclone to be configured separately (`rclone config`).
|
||||||
|
|||||||
@@ -22,76 +22,6 @@ the tag exists and is exercised; what is left is merging `next` to
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-13: Stopped `remote info` counting a file under `blobs/` that
|
|
||||||
is not a blob as an orphaned blob
|
|
||||||
([issue #295](https://git.eeqj.de/sneak/vaultik/issues/295)). A stray
|
|
||||||
file such as `.DS_Store` was reported as an orphaned blob and the
|
|
||||||
report advised running `prune`, which skips such a file and deleted
|
|
||||||
nothing. `remote info` now takes its blob list from the same listing
|
|
||||||
`prune` uses, in the table and in `--json`.
|
|
||||||
|
|
||||||
- 2026-10-13: Made `snapshot remove` fail for a snapshot that does not
|
|
||||||
exist ([issue #293](https://git.eeqj.de/sneak/vaultik/issues/293)).
|
|
||||||
The command never checked the ID: it reported the snapshot removed
|
|
||||||
from the local database and from the destination store and exited 0,
|
|
||||||
under `--json`, `--dry-run` and `--local-only` too. An ID that names
|
|
||||||
no snapshot in the local index or on the destination store is now an
|
|
||||||
error; with `--local-only`, the snapshot must be in the local index.
|
|
||||||
The command now reports a removal from either side only when one
|
|
||||||
happened, and `remote_removed` is true only when metadata was deleted.
|
|
||||||
|
|
||||||
- 2026-10-12: Bound the local index to the destination an `s3.*` config
|
|
||||||
names ([issue #298](https://git.eeqj.de/sneak/vaultik/issues/298)).
|
|
||||||
Only `storage_url` was checked, so after `s3.bucket` or `s3.prefix`
|
|
||||||
changed, the next backup treated every chunk as already stored,
|
|
||||||
uploaded nothing, and completed a snapshot that could not be restored.
|
|
||||||
Without `storage_url`, the local index is now bound to `s3.endpoint`,
|
|
||||||
`s3.bucket` and `s3.prefix`, and a change is refused as a changed
|
|
||||||
`storage_url` is.
|
|
||||||
|
|
||||||
- 2026-10-12: Rejected a retention duration longer than about 292 years
|
|
||||||
([issue #289](https://git.eeqj.de/sneak/vaultik/issues/289)). The
|
|
||||||
number given to `--older-than` or `--keep-newer-than` was multiplied
|
|
||||||
by the length of its unit with no limit, so from `293y`, `15251w`,
|
|
||||||
`3559mo` or `106752d`, or a sum of parts such as `200y200y`, the
|
|
||||||
result wrapped to a negative duration. The cutoff then lay in the
|
|
||||||
future, every snapshot of the name was deleted, the one just made
|
|
||||||
included, and the command exited 0. Such a duration is now rejected
|
|
||||||
as invalid and nothing is deleted.
|
|
||||||
|
|
||||||
- 2026-10-08: Made a backup cancelled under `--skip-errors` stop at once
|
|
||||||
([issue #286](https://git.eeqj.de/sneak/vaultik/issues/286)). After
|
|
||||||
Ctrl-C or SIGTERM, phase 2 treated the cancellation error from each
|
|
||||||
remaining file like an unreadable file: it opened the file, printed an
|
|
||||||
error line for it, counted it as failed and went on to the next one.
|
|
||||||
The run now stops at the first file after the cancellation, and no
|
|
||||||
file is counted as failed because of it.
|
|
||||||
|
|
||||||
- 2026-10-08: Made `remote nuke` delete the `.partial` files that
|
|
||||||
uploads cut off part-way leave on the destination store
|
|
||||||
([issue #281](https://git.eeqj.de/sneak/vaultik/issues/281)). The
|
|
||||||
file and rclone listings skip such a file, so the command left it in
|
|
||||||
place and still reported the store empty. It now removes them under
|
|
||||||
`metadata/` and `blobs/` as its last step.
|
|
||||||
|
|
||||||
- 2026-10-08: Made a local index error while recording a directory or
|
|
||||||
symlink stop a backup under `--skip-errors`
|
|
||||||
([issue #284](https://git.eeqj.de/sneak/vaultik/issues/284)). Phase 2
|
|
||||||
only records such an entry in the local index, since it has no data
|
|
||||||
to open or read, but an error doing so was skipped like an unreadable
|
|
||||||
file. The snapshot then completed without the entry, and a restore
|
|
||||||
did not recreate it. The error now stops the backup, as it does
|
|
||||||
without the flag.
|
|
||||||
|
|
||||||
- 2026-10-08: Counted a file that a backup could not store as failed
|
|
||||||
([issue #280](https://git.eeqj.de/sneak/vaultik/issues/280)). A file
|
|
||||||
that phase 1 counted and phase 2 could not open, because it was
|
|
||||||
unreadable under `--skip-errors` or removed in between, was reported
|
|
||||||
in the summary as unchanged with its bytes as backed up, and the
|
|
||||||
`snapshots` row's `file_count` and `total_size` included it. The
|
|
||||||
summary now counts it as failed, and its data total and the row leave
|
|
||||||
it out.
|
|
||||||
|
|
||||||
- 2026-10-08: Made `remote info` report a snapshot's blob count and
|
- 2026-10-08: Made `remote info` report a snapshot's blob count and
|
||||||
blob size as unknown when its manifest cannot be read
|
blob size as unknown when its manifest cannot be read
|
||||||
([issue #272](https://git.eeqj.de/sneak/vaultik/issues/272)). The
|
([issue #272](https://git.eeqj.de/sneak/vaultik/issues/272)). The
|
||||||
@@ -101,17 +31,6 @@ the tag exists and is exercised; what is left is merging `next` to
|
|||||||
manifest still shows 0, since the orphan figures count its blobs as
|
manifest still shows 0, since the orphan figures count its blobs as
|
||||||
orphaned.
|
orphaned.
|
||||||
|
|
||||||
- 2026-10-08: Kept the progress line of a snapshot with more than one
|
|
||||||
path within 100%
|
|
||||||
([issue #271](https://git.eeqj.de/sneak/vaultik/issues/271)). The
|
|
||||||
bytes and files processed counted every path, but the totals they
|
|
||||||
were divided by held only the current path's, so a second path
|
|
||||||
smaller than the first showed more than 100% and an ETA of `unknown`.
|
|
||||||
The totals now add up over the paths scanned so far. The rate behind
|
|
||||||
the ETA restarts when each path's scan phase ends, so that phase does
|
|
||||||
not lower the rate while the path is processed; until then the rate
|
|
||||||
is the previous path's.
|
|
||||||
|
|
||||||
- 2026-10-08: Made a second `snapshot create` of one name succeed when
|
- 2026-10-08: Made a second `snapshot create` of one name succeed when
|
||||||
it starts in the same second as the first
|
it starts in the same second as the first
|
||||||
([issue #270](https://git.eeqj.de/sneak/vaultik/issues/270)). The
|
([issue #270](https://git.eeqj.de/sneak/vaultik/issues/270)). The
|
||||||
|
|||||||
@@ -245,17 +245,6 @@ func (p *Packer) Flush(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// DiscardCurrentBlob closes and removes the temp file of the blob being
|
|
||||||
// packed, if any, and drops that blob. A caller that stops before Flush
|
|
||||||
// must call it, or the temp file is left behind. Thread-safe.
|
|
||||||
func (p *Packer) DiscardCurrentBlob() {
|
|
||||||
p.mu.Lock()
|
|
||||||
defer p.mu.Unlock()
|
|
||||||
|
|
||||||
p.cleanupTempFile()
|
|
||||||
p.currentBlob = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// FinalizeBlob finalizes the current blob being assembled.
|
// FinalizeBlob finalizes the current blob being assembled.
|
||||||
// This compresses the accumulated chunks, encrypts the result, and computes
|
// This compresses the accumulated chunks, encrypts the result, and computes
|
||||||
// the content-addressed hash. The finalized blob is either passed to the
|
// the content-addressed hash. The finalized blob is either passed to the
|
||||||
|
|||||||
@@ -251,12 +251,6 @@ func NewConfigCommand() *cobra.Command {
|
|||||||
Use: "config",
|
Use: "config",
|
||||||
Short: "Manage the configuration file",
|
Short: "Manage the configuration file",
|
||||||
Long: "Commands for creating, editing, and querying the vaultik config file.",
|
Long: "Commands for creating, editing, and querying the vaultik config file.",
|
||||||
// cobra checks Args only on a command that has a Run: without
|
|
||||||
// one, a mistyped subcommand printed help and exited 0.
|
|
||||||
Args: cobra.NoArgs,
|
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
|
||||||
_ = cmd.Help()
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.AddCommand(newConfigInitCommand())
|
cmd.AddCommand(newConfigInitCommand())
|
||||||
|
|||||||
@@ -15,12 +15,6 @@ func NewDatabaseCommand() *cobra.Command {
|
|||||||
Use: "database",
|
Use: "database",
|
||||||
Short: "Manage the local state database",
|
Short: "Manage the local state database",
|
||||||
Long: `Commands for managing the local SQLite state database.`,
|
Long: `Commands for managing the local SQLite state database.`,
|
||||||
// cobra checks Args only on a command that has a Run: without
|
|
||||||
// one, a mistyped subcommand printed help and exited 0.
|
|
||||||
Args: cobra.NoArgs,
|
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
|
||||||
_ = cmd.Help()
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.AddCommand(
|
cmd.AddCommand(
|
||||||
|
|||||||
@@ -1,108 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares runEntry and the hermetic config helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Flags of `snapshot create` used to build argument vectors below.
|
|
||||||
const (
|
|
||||||
flagPrune = "--prune"
|
|
||||||
flagKeepNewerThan = "--keep-newer-than"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestEntrySnapshotCreateRejectsKeepNewerThanBeforeBackup checks that a
|
|
||||||
// --keep-newer-than the post-backup prune could not use stops `snapshot
|
|
||||||
// create` before the backup: the command fails and the destination
|
|
||||||
// store stays empty. It used to be read only by the prune, after the
|
|
||||||
// snapshot was uploaded, and without --prune it was ignored.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
|
||||||
func TestEntrySnapshotCreateRejectsKeepNewerThanBeforeBackup(t *testing.T) {
|
|
||||||
for _, testCase := range []struct {
|
|
||||||
name string
|
|
||||||
args []string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "decimal in a day count",
|
|
||||||
args: []string{flagPrune, flagKeepNewerThan, "1.5d"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "unknown unit",
|
|
||||||
args: []string{flagPrune, flagKeepNewerThan, "4x"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "without --prune",
|
|
||||||
args: []string{flagKeepNewerThan, "4w"},
|
|
||||||
},
|
|
||||||
} {
|
|
||||||
t.Run(testCase.name, func(t *testing.T) {
|
|
||||||
configPath, storeDir := writeBackupConfig(t)
|
|
||||||
|
|
||||||
code, _, _ := runEntry(t, append(
|
|
||||||
[]string{flagConfig, configPath, cmdSnapshot, cmdCreate},
|
|
||||||
testCase.args...)...)
|
|
||||||
|
|
||||||
assert.Equal(t, 1, code)
|
|
||||||
|
|
||||||
stored, err := os.ReadDir(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, stored, "nothing may be uploaded")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEntrySnapshotCreateReportsPostBackupPruneFailure makes the
|
|
||||||
// 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
|
|
||||||
// prune's and not as a failed snapshot creation.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
|
||||||
func TestEntrySnapshotCreateReportsPostBackupPruneFailure(t *testing.T) {
|
|
||||||
configPath, storeDir := writeBackupConfig(t)
|
|
||||||
|
|
||||||
// A remote key is 64 lowercase hex characters. The prune reads every
|
|
||||||
// manifest on the store and fails on one it cannot decode.
|
|
||||||
plantedDir := filepath.Join(storeDir, "metadata", strings.Repeat("a", 64))
|
|
||||||
require.NoError(t, os.MkdirAll(plantedDir, 0o750))
|
|
||||||
require.NoError(t, os.WriteFile(
|
|
||||||
filepath.Join(plantedDir, "manifest.json.zst"),
|
|
||||||
[]byte("not a valid manifest"), 0o600))
|
|
||||||
|
|
||||||
code, _, stderr := runEntry(t,
|
|
||||||
flagConfig, configPath, cmdSnapshot, cmdCreate, flagPrune)
|
|
||||||
|
|
||||||
assert.Equal(t, 1, code)
|
|
||||||
assert.Contains(t, stderr, "Backup completed, but post-backup prune failed")
|
|
||||||
assert.NotContains(t, stderr, "Snapshot creation failed")
|
|
||||||
|
|
||||||
snapshots, err := os.ReadDir(filepath.Join(storeDir, "metadata"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Len(t, snapshots, 2,
|
|
||||||
"the new snapshot is on the store beside the planted one")
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeBackupConfig builds a hermetic config with one small file in its
|
|
||||||
// source directory and an empty destination store directory. Returns the
|
|
||||||
// config path and the store directory.
|
|
||||||
func writeBackupConfig(t *testing.T) (string, string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
configPath := writeHermeticPruneConfig(t, false)
|
|
||||||
|
|
||||||
// writeHermeticPruneConfig puts the source and store directories
|
|
||||||
// beside the config file.
|
|
||||||
dir := filepath.Dir(configPath)
|
|
||||||
sourceDir := filepath.Join(dir, "source")
|
|
||||||
|
|
||||||
require.NoError(t, os.Mkdir(sourceDir, 0o750))
|
|
||||||
require.NoError(t, os.WriteFile(
|
|
||||||
filepath.Join(sourceDir, "file.txt"), []byte("hello"), 0o600))
|
|
||||||
|
|
||||||
return configPath, filepath.Join(dir, "store")
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares runEntry and the command-word constants
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestEntryGroupRejectsUnknownSubcommand runs each group command with a
|
|
||||||
// mistyped subcommand, as a crontab line might carry one. It must fail
|
|
||||||
// with exit 1 and name the word, as `vaultik bogus` does at the top
|
|
||||||
// level, instead of printing the group's help and exiting 0 having done
|
|
||||||
// nothing. The group name alone still prints its help.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout and os.Stderr
|
|
||||||
func TestEntryGroupRejectsUnknownSubcommand(t *testing.T) {
|
|
||||||
for _, testCase := range []struct {
|
|
||||||
group string
|
|
||||||
mistyped string
|
|
||||||
}{
|
|
||||||
{group: cmdSnapshot, mistyped: "craete"},
|
|
||||||
{group: "config", mistyped: "inti"},
|
|
||||||
{group: cmdRemote, mistyped: "ifno"},
|
|
||||||
{group: "database", mistyped: "delte"},
|
|
||||||
{group: "completion", mistyped: "nosuchshell"},
|
|
||||||
} {
|
|
||||||
t.Run(testCase.group, func(t *testing.T) {
|
|
||||||
code, stdout, stderr := runEntry(t,
|
|
||||||
testCase.group, testCase.mistyped)
|
|
||||||
|
|
||||||
assert.Equal(t, 1, code)
|
|
||||||
assert.Empty(t, stdout)
|
|
||||||
assert.Contains(t, stderr,
|
|
||||||
`unknown command "`+testCase.mistyped+`"`)
|
|
||||||
|
|
||||||
code, stdout, _ = runEntry(t, testCase.group)
|
|
||||||
|
|
||||||
assert.Equal(t, 0, code)
|
|
||||||
assert.Contains(t, stdout,
|
|
||||||
programName+" "+testCase.group+" [command]")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -18,12 +18,6 @@ func NewRemoteCommand() *cobra.Command {
|
|||||||
Use: "remote",
|
Use: "remote",
|
||||||
Short: "Remote storage management commands",
|
Short: "Remote storage management commands",
|
||||||
Long: "Commands for inspecting and managing remote storage",
|
Long: "Commands for inspecting and managing remote storage",
|
||||||
// cobra checks Args only on a command that has a Run: without
|
|
||||||
// one, a mistyped subcommand printed help and exited 0.
|
|
||||||
Args: cobra.NoArgs,
|
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
|
||||||
_ = cmd.Help()
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add subcommands
|
// Add subcommands
|
||||||
|
|||||||
@@ -74,21 +74,6 @@ on the source system.`,
|
|||||||
NewDatabaseCommand(),
|
NewDatabaseCommand(),
|
||||||
)
|
)
|
||||||
|
|
||||||
// cobra adds the completion command only when Execute runs, and with
|
|
||||||
// no Run, so it skipped its own cobra.NoArgs and a mistyped shell name
|
|
||||||
// printed help and exited 0. Adding it here lets it have a Run. Its
|
|
||||||
// scripts go to os.Stdout as it is now: a later SetOut does not
|
|
||||||
// redirect them.
|
|
||||||
cmd.InitDefaultCompletionCmd()
|
|
||||||
|
|
||||||
for _, sub := range cmd.Commands() {
|
|
||||||
if sub.Name() == "completion" {
|
|
||||||
sub.Run = func(completion *cobra.Command, _ []string) {
|
|
||||||
_ = completion.Help()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -41,12 +41,6 @@ func NewSnapshotCommand() *cobra.Command {
|
|||||||
Use: "snapshot",
|
Use: "snapshot",
|
||||||
Short: "Snapshot management commands",
|
Short: "Snapshot management commands",
|
||||||
Long: "Commands for creating, listing, and managing snapshots",
|
Long: "Commands for creating, listing, and managing snapshots",
|
||||||
// cobra checks Args only on a command that has a Run: without
|
|
||||||
// one, a mistyped subcommand printed help and exited 0.
|
|
||||||
Args: cobra.NoArgs,
|
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
|
||||||
_ = cmd.Help()
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add subcommands
|
// Add subcommands
|
||||||
@@ -77,11 +71,6 @@ otherwise from the platform config directory (~/.config/vaultik/config.yml
|
|||||||
on Linux), then /etc/vaultik/config.yml.`,
|
on Linux), then /etc/vaultik/config.yml.`,
|
||||||
Args: cobra.ArbitraryArgs,
|
Args: cobra.ArbitraryArgs,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
err := opts.Validate()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pass snapshot names from args
|
// Pass snapshot names from args
|
||||||
opts.Snapshots = args
|
opts.Snapshots = args
|
||||||
// --skip-errors is a global flag on the root command.
|
// --skip-errors is a global flag on the root command.
|
||||||
@@ -108,13 +97,6 @@ on Linux), then /etc/vaultik/config.yml.`,
|
|||||||
}, func(v *vaultik.Vaultik) error {
|
}, func(v *vaultik.Vaultik) error {
|
||||||
return v.CreateSnapshot(opts)
|
return v.CreateSnapshot(opts)
|
||||||
}, func(err error) {
|
}, func(err error) {
|
||||||
if errors.Is(err, vaultik.ErrPostBackupPruneFailed) {
|
|
||||||
log.Error("Post-backup prune failed", "error", err)
|
|
||||||
ReportErrorf("Backup completed, but %v", err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Error("Snapshot creation failed", "error", err)
|
log.Error("Snapshot creation failed", "error", err)
|
||||||
ReportErrorf("Snapshot creation failed: %v", err)
|
ReportErrorf("Snapshot creation failed: %v", err)
|
||||||
})
|
})
|
||||||
@@ -273,12 +255,8 @@ manifest (the destination store may hold snapshots this host doesn't
|
|||||||
know about), which is what 'vaultik prune' does. On success the command
|
know about), which is what 'vaultik prune' does. On success the command
|
||||||
prints the exact 'vaultik prune' invocation to run as a follow-up.
|
prints the exact 'vaultik prune' invocation to run as a follow-up.
|
||||||
|
|
||||||
An ID 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).
|
||||||
must then be in the local index.
|
|
||||||
|
|
||||||
If the remote is unreachable, the local-database removal still completes
|
If the remote is unreachable, the local-database removal still completes
|
||||||
and a warning is emitted; run 'vaultik snapshot remove <snapshot-id>' again
|
and a warning is emitted; run 'vaultik snapshot remove <snapshot-id>' again
|
||||||
|
|||||||
@@ -61,9 +61,6 @@ var (
|
|||||||
errBadS3PartSize = errors.New("s3.part_size must be between 5MiB and 5GiB")
|
errBadS3PartSize = errors.New("s3.part_size must be between 5MiB and 5GiB")
|
||||||
errBadStorageScheme = errors.New(
|
errBadStorageScheme = errors.New(
|
||||||
"storage_url must start with s3://, file://, or rclone://")
|
"storage_url must start with s3://, file://, or rclone://")
|
||||||
errFileURLNotAbsolute = errors.New(
|
|
||||||
"a file:// storage_url needs an absolute path, " +
|
|
||||||
"as in file:///path/to/backup")
|
|
||||||
errStorageNotConfigured = errors.New(
|
errStorageNotConfigured = errors.New(
|
||||||
"storage not configured; set storage_url or provide s3.endpoint + " +
|
"storage not configured; set storage_url or provide s3.endpoint + " +
|
||||||
"s3.bucket + credentials")
|
"s3.bucket + credentials")
|
||||||
@@ -464,18 +461,11 @@ func (c *Config) validateStorage() error {
|
|||||||
|
|
||||||
// validateStorageURL validates URL-based storage configuration. File and
|
// validateStorageURL validates URL-based storage configuration. File and
|
||||||
// rclone URLs need no credentials; S3 URLs require the legacy s3.*
|
// rclone URLs need no credentials; S3 URLs require the legacy s3.*
|
||||||
// credential fields. A file URL must name an absolute path: a relative one
|
// credential fields.
|
||||||
// would resolve against the working directory, so the destination would
|
|
||||||
// move with it.
|
|
||||||
func (c *Config) validateStorageURL() error {
|
func (c *Config) validateStorageURL() error {
|
||||||
switch {
|
switch {
|
||||||
case strings.HasPrefix(c.StorageURL, "file://"):
|
case strings.HasPrefix(c.StorageURL, "file://"):
|
||||||
// storage.ParseStorageURL applies the same rule, but config
|
// File storage doesn't need S3 credentials
|
||||||
// cannot import storage, which imports config.
|
|
||||||
if !strings.HasPrefix(c.StorageURL, "file:///") {
|
|
||||||
return errFileURLNotAbsolute
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
case strings.HasPrefix(c.StorageURL, "rclone://"):
|
case strings.HasPrefix(c.StorageURL, "rclone://"):
|
||||||
// Rclone storage uses rclone's own config
|
// Rclone storage uses rclone's own config
|
||||||
|
|||||||
@@ -337,35 +337,6 @@ func TestLoadS3PartSize(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestLoadRejectsRelativeFileURL checks that a file:// storage_url with a
|
|
||||||
// relative path fails at load. Accepted, it would resolve against the
|
|
||||||
// working directory, so a backup run from another directory would write
|
|
||||||
// to a different destination and still succeed.
|
|
||||||
func TestLoadRejectsRelativeFileURL(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const relativeConfig = "snapshots:\n" +
|
|
||||||
" test:\n" +
|
|
||||||
" paths: [/tmp/vaultik-test-source]\n" +
|
|
||||||
"storage_url: file://dest\n"
|
|
||||||
|
|
||||||
path := filepath.Join(t.TempDir(), "config.yml")
|
|
||||||
|
|
||||||
err := os.WriteFile(path, []byte(relativeConfig), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("write config: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = Load(path)
|
|
||||||
if !errors.Is(err, errFileURLNotAbsolute) {
|
|
||||||
t.Fatalf("Load() error = %v, want errFileURLNotAbsolute", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(err.Error(), "absolute path") {
|
|
||||||
t.Errorf("error %q does not say to use an absolute path", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestValidateAgeRecipients checks that recipients are parsed at config load
|
// TestValidateAgeRecipients checks that recipients are parsed at config load
|
||||||
// (a bad entry fails immediately, not mid-backup) and that no invalid entry —
|
// (a bad entry fails immediately, not mid-backup) and that no invalid entry —
|
||||||
// least of all a pasted secret key — is echoed in the error. An empty list
|
// least of all a pasted secret key — is echoed in the error. An empty list
|
||||||
|
|||||||
@@ -277,50 +277,6 @@ func (r *FileRepository) ListUnderPath(
|
|||||||
return files, rows.Err()
|
return files, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListUnderPathInSnapshot returns the files that ListUnderPath returns
|
|
||||||
// for path and that the snapshot lists, in no particular order.
|
|
||||||
func (r *FileRepository) ListUnderPathInSnapshot(
|
|
||||||
ctx context.Context, path, snapshotID string,
|
|
||||||
) ([]*File, error) {
|
|
||||||
path = strings.TrimRight(path, "/")
|
|
||||||
dirPrefix := path + "/"
|
|
||||||
|
|
||||||
query := `
|
|
||||||
SELECT f.id, f.path, f.source_path, f.mtime, f.mtime_nsec, f.size,
|
|
||||||
f.mode, f.uid, f.gid, f.link_target
|
|
||||||
FROM files f
|
|
||||||
JOIN snapshot_files sf ON sf.file_id = f.id
|
|
||||||
WHERE sf.snapshot_id = ?
|
|
||||||
AND (f.path = ? OR substr(f.path, 1, length(?)) = ?)
|
|
||||||
`
|
|
||||||
|
|
||||||
rows, err := r.db.conn.QueryContext(ctx, query,
|
|
||||||
snapshotID, path, dirPrefix, dirPrefix)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("querying files: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
err := rows.Close()
|
|
||||||
if err != nil {
|
|
||||||
Fatalf("failed to close rows: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
var files []*File
|
|
||||||
|
|
||||||
for rows.Next() {
|
|
||||||
file, err := r.scanFileRows(rows)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("scanning file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
files = append(files, file)
|
|
||||||
}
|
|
||||||
|
|
||||||
return files, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListIDsWithChunksNotInUploadedBlobs returns the IDs of the files whose
|
// ListIDsWithChunksNotInUploadedBlobs returns the IDs of the files whose
|
||||||
// path starts with prefix and that list at least one chunk held by no
|
// path starts with prefix and that list at least one chunk held by no
|
||||||
// blob whose upload has completed (uploaded_ts set). A new snapshot
|
// blob whose upload has completed (uploaded_ts set). A new snapshot
|
||||||
|
|||||||
@@ -212,65 +212,6 @@ func TestFileRepositoryListUnderPath(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListUnderPathInSnapshot leaves out files outside path and files the
|
|
||||||
// snapshot does not list, though another snapshot lists them.
|
|
||||||
func TestFileRepositoryListUnderPathInSnapshot(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db, cleanup := setupTestDB(t)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
files := database.NewFileRepository(db)
|
|
||||||
snapshots := database.NewSnapshotRepository(db)
|
|
||||||
|
|
||||||
listed := map[string][]string{
|
|
||||||
"one": {"/src/a.txt", "/src2/c.txt"},
|
|
||||||
"two": {"/src/b.txt"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for snapshotID, paths := range listed {
|
|
||||||
err := snapshots.Create(ctx, nil, &database.Snapshot{
|
|
||||||
ID: types.SnapshotID(snapshotID),
|
|
||||||
Hostname: "host",
|
|
||||||
StartedAt: time.Now(),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create snapshot %s: %v", snapshotID, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, path := range paths {
|
|
||||||
err := files.Create(ctx, nil, &database.File{
|
|
||||||
Path: types.FilePath(path),
|
|
||||||
MTime: time.Now().Truncate(time.Second),
|
|
||||||
Mode: 0644,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create %s: %v", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = snapshots.AddFile(ctx, nil, snapshotID, path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to add %s to %s: %v", path, snapshotID, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
found, err := files.ListUnderPathInSnapshot(ctx, "/src", "one")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to list files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := make([]string, 0, len(found))
|
|
||||||
for _, f := range found {
|
|
||||||
got = append(got, f.Path.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !slices.Equal(got, []string{"/src/a.txt"}) {
|
|
||||||
t.Errorf("got %q, want only /src/a.txt", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFileRepositorySymlink(t *testing.T) {
|
func TestFileRepositorySymlink(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
@@ -531,50 +531,3 @@ func TestExcludePatterns_UnanchoredPatternFile(t *testing.T) {
|
|||||||
require.Equal(t, 1, result.FilesScanned,
|
require.Equal(t, 1, result.FilesScanned,
|
||||||
"Unanchored pattern for file should match anywhere")
|
"Unanchored pattern for file should match anywhere")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExcludePatterns_DoubleStarDirectoryAtEveryDepth(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// As in gitignore, a leading **/ also matches directly under the source dir
|
|
||||||
fs := setupAnchoredTestFS(t)
|
|
||||||
|
|
||||||
scanner, repos, cleanup := createTestScanner(t, fs, []string{"**/projectname"})
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
createSnapshotRecord(ctx, t, repos, "test-snapshot")
|
|
||||||
|
|
||||||
result, err := scanner.Scan(ctx, "/backup", "test-snapshot")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// **/projectname should exclude BOTH:
|
|
||||||
// - /backup/projectname/file.txt
|
|
||||||
// - /backup/otherproject/projectname/file.txt
|
|
||||||
// Total files: 4, excluded: 2
|
|
||||||
require.Equal(t, 2, result.FilesScanned,
|
|
||||||
"**/ directory pattern should match at the top level and nested")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestExcludePatterns_DoubleStarFileAtEveryDepth(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// As in gitignore, a leading **/ also matches directly under the source dir
|
|
||||||
fs := setupAnchoredTestFS(t)
|
|
||||||
|
|
||||||
scanner, repos, cleanup := createTestScanner(t, fs, []string{"**/*.txt"})
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
createSnapshotRecord(ctx, t, repos, "test-snapshot")
|
|
||||||
|
|
||||||
result, err := scanner.Scan(ctx, "/backup", "test-snapshot")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// **/*.txt should exclude ALL .txt files:
|
|
||||||
// - /backup/file.txt
|
|
||||||
// - /backup/projectname/file.txt
|
|
||||||
// - /backup/otherproject/projectname/file.txt
|
|
||||||
// Total files: 4, excluded: 3
|
|
||||||
require.Equal(t, 1, result.FilesScanned,
|
|
||||||
"**/ file pattern should match at the top level and nested")
|
|
||||||
}
|
|
||||||
|
|||||||
+11
-15
@@ -16,9 +16,6 @@ type ScannerParams struct {
|
|||||||
Fs afero.Fs
|
Fs afero.Fs
|
||||||
Exclude []string // Exclude patterns (combined global + snapshot-specific)
|
Exclude []string // Exclude patterns (combined global + snapshot-specific)
|
||||||
SkipErrors bool // Skip file read errors (log loudly but continue)
|
SkipErrors bool // Skip file read errors (log loudly but continue)
|
||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none.
|
|
||||||
PreviousSnapshotID string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Module exports backup functionality as an fx module.
|
// Module exports backup functionality as an fx module.
|
||||||
@@ -47,18 +44,17 @@ func provideScannerFactory(
|
|||||||
}
|
}
|
||||||
|
|
||||||
return NewScanner(ScannerConfig{
|
return NewScanner(ScannerConfig{
|
||||||
FS: params.Fs,
|
FS: params.Fs,
|
||||||
ChunkSize: cfg.ChunkSize.Int64(),
|
ChunkSize: cfg.ChunkSize.Int64(),
|
||||||
Repositories: repos,
|
Repositories: repos,
|
||||||
Storage: storer,
|
Storage: storer,
|
||||||
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
EnableProgress: params.EnableProgress,
|
EnableProgress: params.EnableProgress,
|
||||||
UI: params.UI,
|
UI: params.UI,
|
||||||
Exclude: excludes,
|
Exclude: excludes,
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -56,27 +56,23 @@ const (
|
|||||||
|
|
||||||
// ProgressStats holds atomic counters for progress tracking
|
// ProgressStats holds atomic counters for progress tracking
|
||||||
type ProgressStats struct {
|
type ProgressStats struct {
|
||||||
FilesScanned atomic.Int64 // Total files seen during scan (includes skipped)
|
FilesScanned atomic.Int64 // Total files seen during scan (includes skipped)
|
||||||
FilesProcessed atomic.Int64 // Files actually processed in phase 2
|
FilesProcessed atomic.Int64 // Files actually processed in phase 2
|
||||||
FilesSkipped atomic.Int64 // Files skipped due to no changes
|
FilesSkipped atomic.Int64 // Files skipped due to no changes
|
||||||
BytesScanned atomic.Int64 // Bytes from new/changed files only
|
BytesScanned atomic.Int64 // Bytes from new/changed files only
|
||||||
BytesSkipped atomic.Int64 // Bytes from unchanged files
|
BytesSkipped atomic.Int64 // Bytes from unchanged files
|
||||||
BytesProcessed atomic.Int64 // Actual bytes processed (for ETA calculation)
|
BytesProcessed atomic.Int64 // Actual bytes processed (for ETA calculation)
|
||||||
ChunksCreated atomic.Int64
|
ChunksCreated atomic.Int64
|
||||||
BlobsCreated atomic.Int64
|
BlobsCreated atomic.Int64
|
||||||
BlobsUploaded atomic.Int64
|
BlobsUploaded atomic.Int64
|
||||||
BytesUploaded atomic.Int64
|
BytesUploaded atomic.Int64
|
||||||
CurrentFile atomic.Value // stores string
|
CurrentFile atomic.Value // stores string
|
||||||
TotalSize atomic.Int64 // Size to process in the paths scanned so far
|
TotalSize atomic.Int64 // Total size to process (set after scan phase)
|
||||||
TotalFiles atomic.Int64 // Files to process in the paths scanned so far
|
TotalFiles atomic.Int64 // Total files to process in phase 2
|
||||||
StartTime time.Time
|
ProcessStartTime atomic.Value // stores time.Time when processing starts
|
||||||
mu sync.RWMutex
|
StartTime time.Time
|
||||||
lastDetailTime time.Time
|
mu sync.RWMutex
|
||||||
|
lastDetailTime time.Time
|
||||||
// Guarded by mu: when the last scan phase ended, and
|
|
||||||
// BytesProcessed at that moment.
|
|
||||||
processStartTime time.Time
|
|
||||||
processStartBytes int64
|
|
||||||
|
|
||||||
// Upload tracking
|
// Upload tracking
|
||||||
CurrentUpload atomic.Value // stores *UploadInfo
|
CurrentUpload atomic.Value // stores *UploadInfo
|
||||||
@@ -152,36 +148,10 @@ func (pr *ProgressReporter) GetStats() *ProgressStats {
|
|||||||
return pr.stats
|
return pr.stats
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddTotalSize adds the size one path of the snapshot has to process to
|
// SetTotalSize sets the total size to process (after scan phase)
|
||||||
// the total, once that path's scan phase is done, and starts measuring
|
func (pr *ProgressReporter) SetTotalSize(size int64) {
|
||||||
// the processing rate again. The processed counts run across every path,
|
pr.stats.TotalSize.Store(size)
|
||||||
// so the total does too. Restarting the rate keeps a path's scan phase,
|
pr.stats.ProcessStartTime.Store(time.Now().UTC())
|
||||||
// which processes nothing, out of the rate while that path is processed.
|
|
||||||
// During a later path's scan phase the rate is still the previous
|
|
||||||
// path's, and falls as that scan goes on.
|
|
||||||
func (pr *ProgressReporter) AddTotalSize(size int64) {
|
|
||||||
pr.stats.TotalSize.Add(size)
|
|
||||||
|
|
||||||
pr.stats.mu.Lock()
|
|
||||||
defer pr.stats.mu.Unlock()
|
|
||||||
|
|
||||||
pr.stats.processStartTime = time.Now().UTC()
|
|
||||||
pr.stats.processStartBytes = pr.stats.BytesProcessed.Load()
|
|
||||||
}
|
|
||||||
|
|
||||||
// processRate returns the bytes processed per second since the last scan
|
|
||||||
// phase ended, or 0 before the first path's scan phase is done.
|
|
||||||
func (s *ProgressStats) processRate() float64 {
|
|
||||||
s.mu.RLock()
|
|
||||||
defer s.mu.RUnlock()
|
|
||||||
|
|
||||||
if s.processStartTime.IsZero() {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
processed := s.BytesProcessed.Load() - s.processStartBytes
|
|
||||||
|
|
||||||
return float64(processed) / time.Since(s.processStartTime).Seconds()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Helper functions
|
// Helper functions
|
||||||
@@ -387,12 +357,19 @@ func (pr *ProgressReporter) printSummaryStatus() {
|
|||||||
// Calculate ETA if we have total size and are processing
|
// Calculate ETA if we have total size and are processing
|
||||||
etaStr := ""
|
etaStr := ""
|
||||||
|
|
||||||
processRate := pr.stats.processRate()
|
if totalSize > 0 && bytesProcessed > 0 {
|
||||||
if totalSize > 0 && processRate > 0 {
|
processStart, ok := pr.stats.ProcessStartTime.Load().(time.Time)
|
||||||
remainingBytes := totalSize - bytesProcessed
|
if ok && !processStart.IsZero() {
|
||||||
remainingSeconds := float64(remainingBytes) / processRate
|
processElapsed := time.Since(processStart)
|
||||||
eta := time.Duration(remainingSeconds * float64(time.Second))
|
|
||||||
etaStr = " | ETA: " + formatDuration(eta)
|
rate := float64(bytesProcessed) / processElapsed.Seconds()
|
||||||
|
if rate > 0 {
|
||||||
|
remainingBytes := totalSize - bytesProcessed
|
||||||
|
remainingSeconds := float64(remainingBytes) / rate
|
||||||
|
eta := time.Duration(remainingSeconds * float64(time.Second))
|
||||||
|
etaStr = " | ETA: " + formatDuration(eta)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
rate := float64(bytesScanned+bytesSkipped) / elapsed.Seconds()
|
rate := float64(bytesScanned+bytesSkipped) / elapsed.Seconds()
|
||||||
@@ -444,18 +421,25 @@ func (pr *ProgressReporter) printDetailedStatus() {
|
|||||||
log.Info("Elapsed time", "duration", formatDuration(elapsed))
|
log.Info("Elapsed time", "duration", formatDuration(elapsed))
|
||||||
|
|
||||||
// Calculate and show ETA if we have data
|
// Calculate and show ETA if we have data
|
||||||
processRate := pr.stats.processRate()
|
if totalSize > 0 && bytesProcessed > 0 {
|
||||||
if totalSize > 0 && processRate > 0 {
|
processStart, ok := pr.stats.ProcessStartTime.Load().(time.Time)
|
||||||
remainingBytes := totalSize - bytesProcessed
|
if ok && !processStart.IsZero() {
|
||||||
remainingSeconds := float64(remainingBytes) / processRate
|
processElapsed := time.Since(processStart)
|
||||||
eta := time.Duration(remainingSeconds * float64(time.Second))
|
|
||||||
percentComplete := float64(bytesProcessed) / float64(totalSize) * percentScale
|
processRate := float64(bytesProcessed) / processElapsed.Seconds()
|
||||||
log.Info("Overall progress",
|
if processRate > 0 {
|
||||||
"percent", fmt.Sprintf("%.1f%%", percentComplete),
|
remainingBytes := totalSize - bytesProcessed
|
||||||
"processed", humanize.Bytes(safeUint64(bytesProcessed)),
|
remainingSeconds := float64(remainingBytes) / processRate
|
||||||
"total", humanize.Bytes(safeUint64(totalSize)),
|
eta := time.Duration(remainingSeconds * float64(time.Second))
|
||||||
"rate", humanize.Bytes(uint64(processRate))+"/s",
|
percentComplete := float64(bytesProcessed) / float64(totalSize) * percentScale
|
||||||
"eta", formatDuration(eta))
|
log.Info("Overall progress",
|
||||||
|
"percent", fmt.Sprintf("%.1f%%", percentComplete),
|
||||||
|
"processed", humanize.Bytes(safeUint64(bytesProcessed)),
|
||||||
|
"total", humanize.Bytes(safeUint64(totalSize)),
|
||||||
|
"rate", humanize.Bytes(uint64(processRate))+"/s",
|
||||||
|
"eta", formatDuration(eta))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("Files processed",
|
log.Info("Files processed",
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
//nolint:testpackage // exercises the unexported processRate helper
|
|
||||||
package snapshot
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestProcessRateNotLoweredByLaterScanPhase feeds the reporter two paths
|
|
||||||
// that each take 10 seconds to process, the second after a 30-second scan
|
|
||||||
// phase. That scan phase processes nothing, so the rate while the second
|
|
||||||
// path is processed must be that path's own.
|
|
||||||
func TestProcessRateNotLoweredByLaterScanPhase(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
pathSize = 1000
|
|
||||||
processingTime = 10 * time.Second
|
|
||||||
scanTime = 30 * time.Second
|
|
||||||
)
|
|
||||||
|
|
||||||
// Never started, but Stop releases its tickers and signal handler.
|
|
||||||
progress := NewProgressReporter()
|
|
||||||
defer progress.Stop()
|
|
||||||
|
|
||||||
stats := progress.GetStats()
|
|
||||||
|
|
||||||
// Moves the processing start time back instead of sleeping.
|
|
||||||
elapse := func(d time.Duration) {
|
|
||||||
stats.mu.Lock()
|
|
||||||
defer stats.mu.Unlock()
|
|
||||||
|
|
||||||
stats.processStartTime = stats.processStartTime.Add(-d)
|
|
||||||
}
|
|
||||||
|
|
||||||
progress.AddTotalSize(pathSize)
|
|
||||||
stats.BytesProcessed.Add(pathSize)
|
|
||||||
elapse(processingTime)
|
|
||||||
|
|
||||||
elapse(scanTime)
|
|
||||||
progress.AddTotalSize(pathSize)
|
|
||||||
stats.BytesProcessed.Add(pathSize)
|
|
||||||
elapse(processingTime)
|
|
||||||
|
|
||||||
want := pathSize / processingTime.Seconds()
|
|
||||||
got := stats.processRate()
|
|
||||||
|
|
||||||
// The test's own run time adds to the elapsed time, so got is a hair
|
|
||||||
// under want.
|
|
||||||
if got > want || got < want*0.99 {
|
|
||||||
t.Errorf("rate while the second path is processed is %.1f bytes/s, "+
|
|
||||||
"want %.1f", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
package snapshot_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestProgressPercentWithSecondPathSmaller backs up two paths with one
|
|
||||||
// scanner, as a snapshot with two paths does, the second path smaller
|
|
||||||
// than the first. The progress line divides the bytes processed by the
|
|
||||||
// total size, so both must count both paths to stay within 100%.
|
|
||||||
func TestProgressPercentWithSecondPathSmaller(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
fs := afero.NewMemMapFs()
|
|
||||||
files := map[string]string{
|
|
||||||
"/large/one.txt": strings.Repeat("1", 4000),
|
|
||||||
"/large/two.txt": strings.Repeat("2", 4000),
|
|
||||||
"/small/three.txt": strings.Repeat("3", 1000),
|
|
||||||
}
|
|
||||||
|
|
||||||
for path, content := range files {
|
|
||||||
err := fs.MkdirAll(filepath.Dir(path), 0755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mkdir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = afero.WriteFile(fs, path, []byte(content), 0644)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("write %s: %v", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
db, err := database.NewTestDB()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create test db: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
cerr := db.Close()
|
|
||||||
if cerr != nil {
|
|
||||||
t.Errorf("close db: %v", cerr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
scanner := snapshot.NewScanner(snapshot.ScannerConfig{
|
|
||||||
FS: fs,
|
|
||||||
ChunkSize: int64(1024 * 16),
|
|
||||||
Repositories: repos,
|
|
||||||
MaxBlobSize: int64(1024 * 1024),
|
|
||||||
CompressionLevel: 3,
|
|
||||||
AgeRecipients: []string{testAgePublicKey},
|
|
||||||
EnableProgress: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
// Never started, but Stop releases its tickers and signal handler.
|
|
||||||
progress := scanner.GetProgress()
|
|
||||||
defer progress.Stop()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
snapshotID := "test-snapshot-progress"
|
|
||||||
createTestSnapshotRecord(ctx, t, repos, snapshotID)
|
|
||||||
|
|
||||||
for _, path := range []string{"/large", "/small"} {
|
|
||||||
_, err := scanner.Scan(ctx, path, snapshotID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("scanning %s: %v", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
stats := progress.GetStats()
|
|
||||||
|
|
||||||
// Directories count toward the total size but produce no chunks, so
|
|
||||||
// the percentage ends just under 100%.
|
|
||||||
percent := float64(stats.BytesProcessed.Load()) /
|
|
||||||
float64(stats.TotalSize.Load()) * 100
|
|
||||||
if percent > 100 {
|
|
||||||
t.Errorf("progress after both paths is %.1f%%, want at most 100%%",
|
|
||||||
percent)
|
|
||||||
}
|
|
||||||
|
|
||||||
if stats.FilesProcessed.Load() != stats.TotalFiles.Load() {
|
|
||||||
t.Errorf("progress after both paths is %d of %d files, want all",
|
|
||||||
stats.FilesProcessed.Load(), stats.TotalFiles.Load())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+33
-109
@@ -58,10 +58,6 @@ type Scanner struct {
|
|||||||
compressionLevel int
|
compressionLevel int
|
||||||
ageRecipient string
|
ageRecipient string
|
||||||
snapshotID string // Current snapshot being processed
|
snapshotID string // Current snapshot being processed
|
||||||
// previousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none. Only a file it lists can be counted as
|
|
||||||
// deleted.
|
|
||||||
previousSnapshotID string
|
|
||||||
// currentSourcePath is the source directory being scanned, stored with
|
// currentSourcePath is the source directory being scanned, stored with
|
||||||
// each file record.
|
// each file record.
|
||||||
currentSourcePath string
|
currentSourcePath string
|
||||||
@@ -133,20 +129,14 @@ type ScannerConfig struct {
|
|||||||
// SkipErrors skips files that cannot be opened or read (log loudly but
|
// SkipErrors skips files that cannot be opened or read (log loudly but
|
||||||
// continue); packer, database, encryption, and upload errors still abort.
|
// continue); packer, database, encryption, and upload errors still abort.
|
||||||
SkipErrors bool
|
SkipErrors bool
|
||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none.
|
|
||||||
PreviousSnapshotID string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ScanResult contains the results of a scan operation. Files and bytes
|
// ScanResult contains the results of a scan operation. Files and bytes
|
||||||
// are counted per file: BytesScanned is the size of the new and changed
|
// are counted per file: BytesScanned is the size of the new and changed
|
||||||
// files, BytesSkipped that of the unchanged ones. FilesFailed counts the
|
// files, BytesSkipped that of the unchanged ones.
|
||||||
// new and changed files that phase 2 could not store; FilesScanned
|
|
||||||
// includes them and BytesScanned does not.
|
|
||||||
type ScanResult struct {
|
type ScanResult struct {
|
||||||
FilesScanned int
|
FilesScanned int
|
||||||
FilesSkipped int
|
FilesSkipped int
|
||||||
FilesFailed int
|
|
||||||
FilesDeleted int
|
FilesDeleted int
|
||||||
BytesScanned int64
|
BytesScanned int64
|
||||||
BytesSkipped int64
|
BytesSkipped int64
|
||||||
@@ -211,7 +201,6 @@ func NewScanner(cfg ScannerConfig) *Scanner {
|
|||||||
compiledExclude: compiledExclude,
|
compiledExclude: compiledExclude,
|
||||||
progress: progress,
|
progress: progress,
|
||||||
skipErrors: cfg.SkipErrors,
|
skipErrors: cfg.SkipErrors,
|
||||||
previousSnapshotID: cfg.PreviousSnapshotID,
|
|
||||||
ui: uiw,
|
ui: uiw,
|
||||||
pendingChunkHashes: make(map[string]struct{}),
|
pendingChunkHashes: make(map[string]struct{}),
|
||||||
}
|
}
|
||||||
@@ -263,9 +252,8 @@ func (s *Scanner) Scan(
|
|||||||
|
|
||||||
filesToProcess := scanResult.FilesToProcess
|
filesToProcess := scanResult.FilesToProcess
|
||||||
|
|
||||||
// Phase 1b: Detect deleted files by comparing the previous snapshot
|
// Phase 1b: Detect deleted files by comparing DB against scanned files
|
||||||
// of this name against scanned files
|
err = s.detectDeletedFilesFromMap(ctx, knownFiles, existingFiles, result)
|
||||||
err = s.detectDeletedFiles(ctx, path, existingFiles, result)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("detecting deleted files: %w", err)
|
return nil, fmt.Errorf("detecting deleted files: %w", err)
|
||||||
}
|
}
|
||||||
@@ -419,8 +407,8 @@ func (s *Scanner) summarizeScanPhase(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if s.progress != nil {
|
if s.progress != nil {
|
||||||
s.progress.AddTotalSize(totalSizeToProcess)
|
s.progress.SetTotalSize(totalSizeToProcess)
|
||||||
s.progress.GetStats().TotalFiles.Add(int64(len(filesToProcess)))
|
s.progress.GetStats().TotalFiles.Store(int64(len(filesToProcess)))
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("Phase 1 complete",
|
log.Info("Phase 1 complete",
|
||||||
@@ -445,8 +433,9 @@ func (s *Scanner) summarizeScanPhase(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// loadKnownFiles loads the known files at and beneath path from the
|
// loadKnownFiles loads the known files at and beneath path from the
|
||||||
// database into a map for fast lookup. This avoids per-file database
|
// database into a map for fast lookup. Every loaded file the scan does
|
||||||
// queries during the scan phase.
|
// not find is counted as deleted. This avoids per-file database queries
|
||||||
|
// during the scan phase.
|
||||||
func (s *Scanner) loadKnownFiles(
|
func (s *Scanner) loadKnownFiles(
|
||||||
ctx context.Context, path string,
|
ctx context.Context, path string,
|
||||||
) (map[string]*database.File, error) {
|
) (map[string]*database.File, error) {
|
||||||
@@ -1303,11 +1292,6 @@ func (s *Scanner) batchAddFilesToSnapshot(
|
|||||||
func (s *Scanner) processPhase(
|
func (s *Scanner) processPhase(
|
||||||
ctx context.Context, filesToProcess []*FileToProcess, result *ScanResult,
|
ctx context.Context, filesToProcess []*FileToProcess, result *ScanResult,
|
||||||
) error {
|
) error {
|
||||||
// On an error or cancellation the blob being packed is never
|
|
||||||
// finalized, so its temp file must be removed here. After a
|
|
||||||
// successful flush there is no such blob and this does nothing.
|
|
||||||
defer s.packer.DiscardCurrentBlob()
|
|
||||||
|
|
||||||
// Calculate total bytes to process
|
// Calculate total bytes to process
|
||||||
var totalBytes int64
|
var totalBytes int64
|
||||||
for _, f := range filesToProcess {
|
for _, f := range filesToProcess {
|
||||||
@@ -1325,13 +1309,6 @@ func (s *Scanner) processPhase(
|
|||||||
|
|
||||||
// Process each file
|
// Process each file
|
||||||
for _, fileToProcess := range filesToProcess {
|
for _, fileToProcess := range filesToProcess {
|
||||||
// Check context cancellation
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update progress
|
// Update progress
|
||||||
if s.progress != nil {
|
if s.progress != nil {
|
||||||
s.progress.GetStats().CurrentFile.Store(fileToProcess.Path)
|
s.progress.GetStats().CurrentFile.Store(fileToProcess.Path)
|
||||||
@@ -1368,32 +1345,13 @@ func (s *Scanner) processPhase(
|
|||||||
return s.finalizeProcessPhase(ctx, result)
|
return s.finalizeProcessPhase(ctx, result)
|
||||||
}
|
}
|
||||||
|
|
||||||
// processFileWithErrorHandling records a directory or symlink, or wraps
|
// processFileWithErrorHandling wraps processFileStreaming with error recovery for
|
||||||
// processFileStreaming for a regular file with error recovery for deleted
|
// deleted files and skip-errors mode. Returns (skipped, error).
|
||||||
// files and skip-errors mode. Returns (skipped, error).
|
|
||||||
func (s *Scanner) processFileWithErrorHandling(
|
func (s *Scanner) processFileWithErrorHandling(
|
||||||
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
||||||
) (bool, error) {
|
) (bool, error) {
|
||||||
// A directory or symlink has no data to open or read; it is only
|
|
||||||
// recorded in the local index. An error recording it stops the run
|
|
||||||
// even under --skip-errors, or the snapshot would complete without it.
|
|
||||||
mode := os.FileMode(fileToProcess.File.Mode)
|
|
||||||
if mode&os.ModeSymlink != 0 || mode.IsDir() {
|
|
||||||
err := s.recordNonRegularFile(ctx, fileToProcess)
|
|
||||||
if err != nil {
|
|
||||||
return false, fmt.Errorf("processing file %s: %w", fileToProcess.Path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err := s.processFileStreaming(ctx, fileToProcess, result)
|
err := s.processFileStreaming(ctx, fileToProcess, result)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// A cancelled run stops here even under --skip-errors, rather than
|
|
||||||
// counting this file as failed and going on to the next one.
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
return false, fmt.Errorf("processing file %s: %w", fileToProcess.Path, err)
|
|
||||||
}
|
|
||||||
// A packer/database/encryption/upload failure means the chunk's data
|
// A packer/database/encryption/upload failure means the chunk's data
|
||||||
// may not have been stored. Skipping the file would let the snapshot
|
// may not have been stored. Skipping the file would let the snapshot
|
||||||
// record a file whose chunk is in no blob and cannot be restored, so
|
// record a file whose chunk is in no blob and cannot be restored, so
|
||||||
@@ -1407,7 +1365,7 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
log.Warn("File was deleted during backup, skipping",
|
log.Warn("File was deleted during backup, skipping",
|
||||||
"path", fileToProcess.Path)
|
"path", fileToProcess.Path)
|
||||||
|
|
||||||
countFailedFile(fileToProcess, result)
|
result.FilesSkipped++
|
||||||
|
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
@@ -1418,7 +1376,7 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
s.ui.Errorf("Failed to process %s: %v. Skipping (--skip-errors).",
|
s.ui.Errorf("Failed to process %s: %v. Skipping (--skip-errors).",
|
||||||
s.ui.Path(fileToProcess.Path), err)
|
s.ui.Path(fileToProcess.Path), err)
|
||||||
|
|
||||||
countFailedFile(fileToProcess, result)
|
result.FilesSkipped++
|
||||||
|
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
@@ -1429,13 +1387,6 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// countFailedFile counts a file that phase 2 could not store as failed
|
|
||||||
// and takes its size back out of BytesScanned, where phase 1 put it.
|
|
||||||
func countFailedFile(fileToProcess *FileToProcess, result *ScanResult) {
|
|
||||||
result.FilesFailed++
|
|
||||||
result.BytesScanned -= fileToProcess.FileInfo.Size()
|
|
||||||
}
|
|
||||||
|
|
||||||
// printProcessingProgress prints a periodic progress line during the process phase,
|
// printProcessingProgress prints a periodic progress line during the process phase,
|
||||||
// showing files processed, bytes transferred, throughput, and ETA
|
// showing files processed, bytes transferred, throughput, and ETA
|
||||||
func (s *Scanner) printProcessingProgress(
|
func (s *Scanner) printProcessingProgress(
|
||||||
@@ -1804,11 +1755,16 @@ func (e *packerError) Error() string { return e.err.Error() }
|
|||||||
|
|
||||||
func (e *packerError) Unwrap() error { return e.err }
|
func (e *packerError) Unwrap() error { return e.err }
|
||||||
|
|
||||||
// processFileStreaming processes a regular file by streaming chunks directly
|
// processFileStreaming processes a file by streaming chunks directly to the packer
|
||||||
// to the packer
|
|
||||||
func (s *Scanner) processFileStreaming(
|
func (s *Scanner) processFileStreaming(
|
||||||
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
||||||
) error {
|
) error {
|
||||||
|
// Symlinks and directories have no data to chunk — just record them in the DB.
|
||||||
|
mode := os.FileMode(fileToProcess.File.Mode)
|
||||||
|
if mode&os.ModeSymlink != 0 || mode.IsDir() {
|
||||||
|
return s.recordNonRegularFile(ctx, fileToProcess)
|
||||||
|
}
|
||||||
|
|
||||||
file, err := s.fs.Open(fileToProcess.Path)
|
file, err := s.fs.Open(fileToProcess.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("opening file: %w", wrapPermissionError(fileToProcess.Path, err))
|
return fmt.Errorf("opening file: %w", wrapPermissionError(fileToProcess.Path, err))
|
||||||
@@ -1946,28 +1902,21 @@ func (s *Scanner) queueFileForBatchInsert(
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// detectDeletedFiles counts as deleted each file at or beneath path that
|
// detectDeletedFilesFromMap finds files that existed in previous snapshots
|
||||||
// the previous snapshot of this name lists and the walk did not find.
|
// but no longer exist. Uses pre-loaded maps to avoid any filesystem or
|
||||||
// A file that is excluded, or inside an excluded directory, is not
|
// database access.
|
||||||
// counted: the walk skips it whether or not it is still on disk.
|
func (s *Scanner) detectDeletedFilesFromMap(
|
||||||
func (s *Scanner) detectDeletedFiles(
|
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
path string,
|
knownFiles map[string]*database.File,
|
||||||
existingFiles map[string]struct{},
|
existingFiles map[string]struct{},
|
||||||
result *ScanResult,
|
result *ScanResult,
|
||||||
) error {
|
) error {
|
||||||
if s.previousSnapshotID == "" {
|
if len(knownFiles) == 0 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
previousFiles, err := s.repos.Files.ListUnderPathInSnapshot(
|
// Check each known file against the enumerated set (no filesystem access needed)
|
||||||
ctx, path, s.previousSnapshotID)
|
for path, file := range knownFiles {
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("listing files of snapshot %s: %w",
|
|
||||||
s.previousSnapshotID, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, file := range previousFiles {
|
|
||||||
// Check context cancellation periodically
|
// Check context cancellation periodically
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
@@ -1975,16 +1924,13 @@ func (s *Scanner) detectDeletedFiles(
|
|||||||
default:
|
default:
|
||||||
}
|
}
|
||||||
|
|
||||||
filePath := file.Path.String()
|
// Check if the file exists in our enumerated set
|
||||||
|
if _, exists := existingFiles[path]; !exists {
|
||||||
_, exists := existingFiles[filePath]
|
// File has been deleted
|
||||||
if exists || s.excludedOrInExcludedDir(filePath, path) {
|
result.FilesDeleted++
|
||||||
continue
|
result.BytesDeleted += file.Size
|
||||||
|
log.Debug("Detected deleted file", "path", path, "size", file.Size)
|
||||||
}
|
}
|
||||||
|
|
||||||
result.FilesDeleted++
|
|
||||||
result.BytesDeleted += file.Size
|
|
||||||
log.Debug("Detected deleted file", "path", filePath, "size", file.Size)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if result.FilesDeleted > 0 {
|
if result.FilesDeleted > 0 {
|
||||||
@@ -1995,20 +1941,6 @@ func (s *Scanner) detectDeletedFiles(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// excludedOrInExcludedDir reports whether filePath, which is at or
|
|
||||||
// beneath rootPath, or any directory between rootPath and it, matches an
|
|
||||||
// exclude pattern. A pattern such as */.local/share/Trash matches the
|
|
||||||
// directory but not the files inside it, which the walk skips too.
|
|
||||||
func (s *Scanner) excludedOrInExcludedDir(filePath, rootPath string) bool {
|
|
||||||
for p := filePath; len(p) > len(rootPath); p = filepath.Dir(p) {
|
|
||||||
if s.shouldExclude(p, rootPath) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// wrapPermissionError augments permission errors with platform-specific
|
// wrapPermissionError augments permission errors with platform-specific
|
||||||
// remediation instructions. On macOS, TCC-protected directories (Calendars,
|
// remediation instructions. On macOS, TCC-protected directories (Calendars,
|
||||||
// Reminders, Photos, etc.) return EPERM unless the running application has
|
// Reminders, Photos, etc.) return EPERM unless the running application has
|
||||||
@@ -2050,14 +1982,6 @@ func compileExcludePatterns(patterns []string) []compiledPattern {
|
|||||||
// Remove trailing slash if present (directory indicator)
|
// Remove trailing slash if present (directory indicator)
|
||||||
pattern = strings.TrimSuffix(pattern, "/")
|
pattern = strings.TrimSuffix(pattern, "/")
|
||||||
|
|
||||||
// A leading "**/" demands a "/" before the name and so misses an
|
|
||||||
// entry directly under the source path. An unanchored pattern
|
|
||||||
// already matches at every depth, so drop the prefix: as in
|
|
||||||
// gitignore, "**/x" then also matches a top-level "x".
|
|
||||||
if !anchored {
|
|
||||||
pattern = strings.TrimPrefix(pattern, "**/")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Compile the glob pattern
|
// Compile the glob pattern
|
||||||
// For patterns without path separators, we need to match them as components
|
// For patterns without path separators, we need to match them as components
|
||||||
// e.g., ".git" should match ".git" anywhere in the path
|
// e.g., ".git" should match ".git" anywhere in the path
|
||||||
|
|||||||
@@ -82,32 +82,6 @@ func (f *readFailFs) Open(name string) (afero.File, error) {
|
|||||||
return file, nil
|
return file, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// cancelOnOpenFs cancels the run when the scanner opens the target file to
|
|
||||||
// back it up, as Ctrl-C partway through processing would, and records each
|
|
||||||
// file opened after that.
|
|
||||||
type cancelOnOpenFs struct {
|
|
||||||
afero.Fs
|
|
||||||
|
|
||||||
target string
|
|
||||||
cancel context.CancelFunc
|
|
||||||
cancelled bool
|
|
||||||
openedAfterCancel []string
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:ireturn // afero.Fs.Open is defined to return the interface.
|
|
||||||
func (f *cancelOnOpenFs) Open(name string) (afero.File, error) {
|
|
||||||
if f.cancelled {
|
|
||||||
f.openedAfterCancel = append(f.openedAfterCancel, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
if name == f.target {
|
|
||||||
f.cancel()
|
|
||||||
f.cancelled = true
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.Fs.Open(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// linkRemovedAfterLstatFs is the real filesystem, except that the symlink at
|
// linkRemovedAfterLstatFs is the real filesystem, except that the symlink at
|
||||||
// target is removed right after the walk lstats it, as happens when a link is
|
// target is removed right after the walk lstats it, as happens when a link is
|
||||||
// deleted during a backup. The scanner's readlink of it then fails.
|
// deleted during a backup. The scanner's readlink of it then fails.
|
||||||
@@ -154,16 +128,15 @@ func writeSkipErrorTestFile(t *testing.T, fs afero.Fs, path, content string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// runSkipErrorScan scans source on fs under ctx with the given skip-errors
|
// runSkipErrorScan scans source on fs with the given skip-errors setting,
|
||||||
// setting, printing user-facing messages to uiw (nil discards them), and
|
// printing user-facing messages to uiw (nil discards them), and returns the
|
||||||
// returns the repositories (for inspection) and the scan error.
|
// repositories (for inspection) and the scan error.
|
||||||
func runSkipErrorScan(
|
func runSkipErrorScan(
|
||||||
ctx context.Context, t *testing.T, fs afero.Fs, source string,
|
t *testing.T, fs afero.Fs, source string, skipErrors bool, uiw *ui.Writer,
|
||||||
skipErrors bool, uiw *ui.Writer,
|
|
||||||
) (*database.Repositories, error) {
|
) (*database.Repositories, error) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
db, err := database.New(ctx, ":memory:")
|
db, err := database.NewTestDB()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("create test db: %v", err)
|
t.Fatalf("create test db: %v", err)
|
||||||
}
|
}
|
||||||
@@ -188,6 +161,7 @@ func runSkipErrorScan(
|
|||||||
SkipErrors: skipErrors,
|
SkipErrors: skipErrors,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
snapshotID := "test-snapshot-skip-errors"
|
snapshotID := "test-snapshot-skip-errors"
|
||||||
createTestSnapshotRecord(ctx, t, repos, snapshotID)
|
createTestSnapshotRecord(ctx, t, repos, snapshotID)
|
||||||
|
|
||||||
@@ -211,7 +185,7 @@ func TestScannerPackingFailureAbortsUnderSkipErrors(t *testing.T) {
|
|||||||
writeSkipErrorTestFile(t, fs, "/source/file1.txt", "first file content")
|
writeSkipErrorTestFile(t, fs, "/source/file1.txt", "first file content")
|
||||||
writeSkipErrorTestFile(t, fs, "/source/file2.txt", "second file content")
|
writeSkipErrorTestFile(t, fs, "/source/file2.txt", "second file content")
|
||||||
|
|
||||||
repos, err := runSkipErrorScan(context.Background(), t, fs, "/source", true, nil)
|
repos, err := runSkipErrorScan(t, fs, "/source", true, nil)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected scan to abort on the packer error, got nil")
|
t.Fatal("expected scan to abort on the packer error, got nil")
|
||||||
}
|
}
|
||||||
@@ -238,7 +212,7 @@ func TestScannerReadErrorAbortsWithoutSkipErrors(t *testing.T) {
|
|||||||
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
||||||
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
||||||
|
|
||||||
_, err := runSkipErrorScan(context.Background(), t, fs, "/source", false, nil)
|
_, err := runSkipErrorScan(t, fs, "/source", false, nil)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected scan to fail on the read error, got nil")
|
t.Fatal("expected scan to fail on the read error, got nil")
|
||||||
}
|
}
|
||||||
@@ -254,7 +228,7 @@ func TestScannerReadErrorSkippedWithSkipErrors(t *testing.T) {
|
|||||||
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
||||||
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
||||||
|
|
||||||
repos, err := runSkipErrorScan(context.Background(), t, fs, "/source", true, nil)
|
repos, err := runSkipErrorScan(t, fs, "/source", true, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected scan to complete with --skip-errors, got %v", err)
|
t.Fatalf("expected scan to complete with --skip-errors, got %v", err)
|
||||||
}
|
}
|
||||||
@@ -293,7 +267,7 @@ func TestScannerUnreadableSymlinkAbortsWithoutSkipErrors(t *testing.T) {
|
|||||||
sourceDir, linkPath := writeSymlinkSource(t)
|
sourceDir, linkPath := writeSymlinkSource(t)
|
||||||
fs := &linkRemovedAfterLstatFs{t: t, target: linkPath}
|
fs := &linkRemovedAfterLstatFs{t: t, target: linkPath}
|
||||||
|
|
||||||
_, err := runSkipErrorScan(context.Background(), t, fs, sourceDir, false, nil)
|
_, err := runSkipErrorScan(t, fs, sourceDir, false, nil)
|
||||||
if !errors.Is(err, os.ErrNotExist) {
|
if !errors.Is(err, os.ErrNotExist) {
|
||||||
t.Fatalf("expected scan to fail on the removed symlink, got %v", err)
|
t.Fatalf("expected scan to fail on the removed symlink, got %v", err)
|
||||||
}
|
}
|
||||||
@@ -309,7 +283,7 @@ func TestScannerUnreadableSymlinkSkippedWithSkipErrors(t *testing.T) {
|
|||||||
fs := &linkRemovedAfterLstatFs{t: t, target: linkPath}
|
fs := &linkRemovedAfterLstatFs{t: t, target: linkPath}
|
||||||
uiw := ui.NewWithColor(io.Discard, false)
|
uiw := ui.NewWithColor(io.Discard, false)
|
||||||
|
|
||||||
repos, err := runSkipErrorScan(context.Background(), t, fs, sourceDir, true, uiw)
|
repos, err := runSkipErrorScan(t, fs, sourceDir, true, uiw)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected scan to complete with --skip-errors, got %v", err)
|
t.Fatalf("expected scan to complete with --skip-errors, got %v", err)
|
||||||
}
|
}
|
||||||
@@ -328,113 +302,3 @@ func TestScannerUnreadableSymlinkSkippedWithSkipErrors(t *testing.T) {
|
|||||||
t.Fatalf("expected %s not to be recorded", linkPath)
|
t.Fatalf("expected %s not to be recorded", linkPath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestScannerCancelStopsSkipErrorsRun checks that a --skip-errors backup
|
|
||||||
// cancelled partway through processing returns the cancellation error,
|
|
||||||
// opens no further file, and reports no file as failed.
|
|
||||||
func TestScannerCancelStopsSkipErrorsRun(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
targetContent string
|
|
||||||
}{
|
|
||||||
// The cancellation lands while the target is being read.
|
|
||||||
{name: "while reading a file", targetContent: "first file content"},
|
|
||||||
// An empty target has no chunks, so the cancellation goes unnoticed
|
|
||||||
// until the run moves on to the next file.
|
|
||||||
{name: "between files", targetContent: ""},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const target = "/source/a.txt"
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
fs := &cancelOnOpenFs{
|
|
||||||
Fs: afero.NewMemMapFs(), target: target, cancel: cancel,
|
|
||||||
}
|
|
||||||
writeSkipErrorTestFile(t, fs, target, tt.targetContent)
|
|
||||||
writeSkipErrorTestFile(t, fs, "/source/b.txt", "second file content")
|
|
||||||
writeSkipErrorTestFile(t, fs, "/source/c.txt", "third file content")
|
|
||||||
|
|
||||||
uiw := ui.NewWithColor(io.Discard, false)
|
|
||||||
|
|
||||||
_, err := runSkipErrorScan(ctx, t, fs, "/source", true, uiw)
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Fatalf("expected the cancellation error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(fs.openedAfterCancel) != 0 {
|
|
||||||
t.Fatalf("expected no file opened after the cancellation, got %v",
|
|
||||||
fs.openedAfterCancel)
|
|
||||||
}
|
|
||||||
|
|
||||||
if uiw.ErrorCount() != 0 {
|
|
||||||
t.Fatalf("expected no file reported as failed, got %d error lines",
|
|
||||||
uiw.ErrorCount())
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScannerRemovesBlobTempFileWhenRunStops checks that a run stopped
|
|
||||||
// part-way, by a file it cannot read or by a cancellation, removes the
|
|
||||||
// temp file of the blob it was packing.
|
|
||||||
func TestScannerRemovesBlobTempFileWhenRunStops(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// a.txt is backed up first and starts a blob; the run stops at b.txt.
|
|
||||||
const target = "/source/b.txt"
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
newFs func(cancel context.CancelFunc) afero.Fs
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "file cannot be read",
|
|
||||||
newFs: func(context.CancelFunc) afero.Fs {
|
|
||||||
return &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "cancelled",
|
|
||||||
newFs: func(cancel context.CancelFunc) afero.Fs {
|
|
||||||
return &cancelOnOpenFs{
|
|
||||||
Fs: afero.NewMemMapFs(), target: target, cancel: cancel,
|
|
||||||
}
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
fs := tt.newFs(cancel)
|
|
||||||
writeSkipErrorTestFile(t, fs, "/source/a.txt", "first file content")
|
|
||||||
writeSkipErrorTestFile(t, fs, target, "second file content")
|
|
||||||
|
|
||||||
_, err := runSkipErrorScan(ctx, t, fs, "/source", false, nil)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected the scan to stop with an error, got nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
left, err := afero.Glob(fs, filepath.Join(os.TempDir(), "vaultik-blob-*"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listing blob temp files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(left) != 0 {
|
|
||||||
t.Fatalf("expected no blob temp file left, got %v", left)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -892,7 +892,7 @@ func (sm *SnapshotManager) getFileSize(path string) int64 {
|
|||||||
// BackupStats contains statistics from a backup operation
|
// BackupStats contains statistics from a backup operation
|
||||||
type BackupStats struct {
|
type BackupStats struct {
|
||||||
FilesScanned int
|
FilesScanned int
|
||||||
TotalSize int64 // Total size of the files in the snapshot
|
TotalSize int64 // Total size of all files examined
|
||||||
ChunksCreated int
|
ChunksCreated int
|
||||||
BlobsCreated int
|
BlobsCreated int
|
||||||
BytesUploaded int64
|
BytesUploaded int64
|
||||||
|
|||||||
@@ -171,11 +171,6 @@ func (f *Storer) ListStream(
|
|||||||
return f.inner.ListStream(ctx, prefix)
|
return f.inner.ListStream(ctx, prefix)
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads delegates unchanged.
|
|
||||||
func (f *Storer) DeletePartialUploads(ctx context.Context, prefix string) error {
|
|
||||||
return f.inner.DeletePartialUploads(ctx, prefix)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info delegates unchanged.
|
// Info delegates unchanged.
|
||||||
func (f *Storer) Info() storage.Info {
|
func (f *Storer) Info() storage.Info {
|
||||||
return f.inner.Info()
|
return f.inner.Info()
|
||||||
|
|||||||
@@ -242,42 +242,6 @@ func (f *FileStorer) ListStream(ctx context.Context, prefix string) <-chan Objec
|
|||||||
return ch
|
return ch
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads removes every file under prefix whose name ends in
|
|
||||||
// tempSuffix. A missing prefix has none to remove.
|
|
||||||
func (f *FileStorer) DeletePartialUploads(ctx context.Context, prefix string) error {
|
|
||||||
basePath := f.fullPath(prefix)
|
|
||||||
|
|
||||||
exists, err := afero.Exists(f.fs, basePath)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("checking path: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !exists {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err = afero.Walk(f.fs, basePath, func(path string, info os.FileInfo, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
return ctx.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.IsDir() || !strings.HasSuffix(info.Name(), tempSuffix) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.fs.Remove(path)
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("walking directory: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info returns human-readable storage location information.
|
// Info returns human-readable storage location information.
|
||||||
func (f *FileStorer) Info() Info {
|
func (f *FileStorer) Info() Info {
|
||||||
return Info{
|
return Info{
|
||||||
|
|||||||
@@ -120,45 +120,3 @@ func TestFileStorer_ListSkipsPartialFiles(t *testing.T) {
|
|||||||
t.Fatalf("ListStream should return only the real key, got %v", streamed)
|
t.Fatalf("ListStream should return only the real key, got %v", streamed)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestFileStorer_DeletePartialUploads checks that a leftover temp file is
|
|
||||||
// removed and the object at the real key is kept.
|
|
||||||
func TestFileStorer_DeletePartialUploads(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
base := t.TempDir()
|
|
||||||
|
|
||||||
f, err := storage.NewFileStorer(base)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewFileStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
err = f.Put(ctx, testBlobKey, strings.NewReader("blob-bytes"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
leftover := filepath.Join(base, testBlobKey+"-123456.partial")
|
|
||||||
|
|
||||||
err = os.WriteFile(leftover, []byte("half"), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writing leftover temp file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = f.DeletePartialUploads(ctx, "blobs/")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("DeletePartialUploads: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = os.Stat(leftover)
|
|
||||||
if !os.IsNotExist(err) {
|
|
||||||
t.Errorf("leftover temp file was not removed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = f.Stat(ctx, testBlobKey)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("Stat of the real key: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -213,31 +213,6 @@ func (r *RcloneStorer) ListStream(
|
|||||||
return ch
|
return ch
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads removes every object under prefix whose name ends
|
|
||||||
// in tempSuffix.
|
|
||||||
func (r *RcloneStorer) DeletePartialUploads(ctx context.Context, prefix string) error {
|
|
||||||
var partial []fs.Object
|
|
||||||
|
|
||||||
err := operations.ListFn(ctx, r.fsys, func(obj fs.Object) {
|
|
||||||
key := obj.Remote()
|
|
||||||
if strings.HasPrefix(key, prefix) && strings.HasSuffix(key, tempSuffix) {
|
|
||||||
partial = append(partial, obj)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("listing objects: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, obj := range partial {
|
|
||||||
err = obj.Remove(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("removing object: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info returns human-readable storage location information.
|
// Info returns human-readable storage location information.
|
||||||
func (r *RcloneStorer) Info() Info {
|
func (r *RcloneStorer) Info() Info {
|
||||||
location := r.remote
|
location := r.remote
|
||||||
|
|||||||
@@ -198,47 +198,6 @@ func TestRcloneStorerListSkipsPartialFiles(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRcloneStorerDeletePartialUploads checks that a temporary file left
|
|
||||||
// by a killed upload is removed and the object at the real key is kept.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // NewRcloneStorer installs the process-global rclone config
|
|
||||||
func TestRcloneStorerDeletePartialUploads(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
s, err := storage.NewRcloneStorer(ctx, ":local", dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewRcloneStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.Put(ctx, testBlobKey, strings.NewReader("blob-bytes"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
leftover := filepath.Join(dir, testBlobKey+"-123456.partial")
|
|
||||||
|
|
||||||
err = os.WriteFile(leftover, []byte("half"), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writing leftover temp file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.DeletePartialUploads(ctx, "blobs/")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("DeletePartialUploads: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = os.Stat(leftover)
|
|
||||||
if !os.IsNotExist(err) {
|
|
||||||
t.Errorf("leftover temp file was not removed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = s.Stat(ctx, testBlobKey)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("Stat of the real key: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRcloneStorerOnWrappedLocal registers name as rclone's local backend
|
// newRcloneStorerOnWrappedLocal registers name as rclone's local backend
|
||||||
// wrapped by wrap, and builds an rclone backend on it rooted at a fresh
|
// wrapped by wrap, and builds an rclone backend on it rooted at a fresh
|
||||||
// temp directory. wrap changes the features the local backend reports, so
|
// temp directory. wrap changes the features the local backend reports, so
|
||||||
|
|||||||
@@ -99,12 +99,6 @@ func (s *S3Storer) ListStream(ctx context.Context, prefix string) <-chan ObjectI
|
|||||||
return ch
|
return ch
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads has nothing to remove: S3 shows an object only once
|
|
||||||
// its upload has completed, so an upload cut off part-way leaves none.
|
|
||||||
func (s *S3Storer) DeletePartialUploads(_ context.Context, _ string) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info returns human-readable storage location information.
|
// Info returns human-readable storage location information.
|
||||||
func (s *S3Storer) Info() Info {
|
func (s *S3Storer) Info() Info {
|
||||||
return Info{
|
return Info{
|
||||||
|
|||||||
@@ -71,12 +71,6 @@ type Storer interface {
|
|||||||
// If an error occurs during listing, the final item will have Err set.
|
// If an error occurs during listing, the final item will have Err set.
|
||||||
ListStream(ctx context.Context, prefix string) <-chan ObjectInfo
|
ListStream(ctx context.Context, prefix string) <-chan ObjectInfo
|
||||||
|
|
||||||
// DeletePartialUploads removes every object under prefix that an
|
|
||||||
// upload cut off part-way left under a temporary name ending in
|
|
||||||
// `.partial`. The file and rclone backends' List and ListStream skip
|
|
||||||
// such an object.
|
|
||||||
DeletePartialUploads(ctx context.Context, prefix string) error
|
|
||||||
|
|
||||||
// Info returns human-readable storage location information.
|
// Info returns human-readable storage location information.
|
||||||
Info() Info
|
Info() Info
|
||||||
}
|
}
|
||||||
|
|||||||
+12
-26
@@ -17,10 +17,8 @@ const (
|
|||||||
|
|
||||||
// Sentinel errors for storage URL parsing.
|
// Sentinel errors for storage URL parsing.
|
||||||
var (
|
var (
|
||||||
ErrEmptyStorageURL = errors.New("storage URL is empty")
|
ErrEmptyStorageURL = errors.New("storage URL is empty")
|
||||||
ErrEmptyFilePath = errors.New("file URL path is empty")
|
ErrEmptyFilePath = errors.New("file URL path is empty")
|
||||||
ErrRelativeFilePath = errors.New(
|
|
||||||
"file URL needs an absolute path, as in file:///path/to/backup")
|
|
||||||
ErrMissingBucket = errors.New("s3 URL missing bucket name")
|
ErrMissingBucket = errors.New("s3 URL missing bucket name")
|
||||||
ErrMissingRemote = errors.New("rclone URL missing remote name")
|
ErrMissingRemote = errors.New("rclone URL missing remote name")
|
||||||
ErrUnsupportedScheme = errors.New(
|
ErrUnsupportedScheme = errors.New(
|
||||||
@@ -53,8 +51,17 @@ func ParseStorageURL(rawURL string) (*URL, error) {
|
|||||||
return nil, ErrEmptyStorageURL
|
return nil, ErrEmptyStorageURL
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Handle file:// URLs
|
||||||
if after, ok := strings.CutPrefix(rawURL, "file://"); ok {
|
if after, ok := strings.CutPrefix(rawURL, "file://"); ok {
|
||||||
return parseFileURL(after)
|
path := after
|
||||||
|
if path == "" {
|
||||||
|
return nil, ErrEmptyFilePath
|
||||||
|
}
|
||||||
|
|
||||||
|
return &URL{
|
||||||
|
Scheme: schemeFile,
|
||||||
|
Prefix: path,
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if strings.HasPrefix(rawURL, "s3://") {
|
if strings.HasPrefix(rawURL, "s3://") {
|
||||||
@@ -68,27 +75,6 @@ func ParseStorageURL(rawURL string) (*URL, error) {
|
|||||||
return nil, ErrUnsupportedScheme
|
return nil, ErrUnsupportedScheme
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseFileURL parses the path that follows file://. The path must be
|
|
||||||
// absolute: a relative one would resolve against the working directory,
|
|
||||||
// so the destination would move with it. Percent-escapes are decoded, so
|
|
||||||
// my%20stick names the directory "my stick"; a literal space is kept.
|
|
||||||
func parseFileURL(rawPath string) (*URL, error) {
|
|
||||||
if rawPath == "" {
|
|
||||||
return nil, ErrEmptyFilePath
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.HasPrefix(rawPath, "/") {
|
|
||||||
return nil, ErrRelativeFilePath
|
|
||||||
}
|
|
||||||
|
|
||||||
path, err := url.PathUnescape(rawPath)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("invalid file URL path: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return &URL{Scheme: schemeFile, Prefix: path}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseS3URL parses an s3://bucket/prefix URL. It rejects credentials in
|
// parseS3URL parses an s3://bucket/prefix URL. It rejects credentials in
|
||||||
// the userinfo and any query parameter other than endpoint, region and
|
// the userinfo and any query parameter other than endpoint, region and
|
||||||
// ssl, so a credential-bearing URL is never stored or echoed.
|
// ssl, so a credential-bearing URL is never stored or echoed.
|
||||||
|
|||||||
@@ -14,10 +14,7 @@ import (
|
|||||||
func TestParseStorageURLValid(t *testing.T) {
|
func TestParseStorageURLValid(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const bucket = "mybucket"
|
||||||
bucket = "mybucket"
|
|
||||||
fileScheme = "file"
|
|
||||||
)
|
|
||||||
|
|
||||||
cases := []struct {
|
cases := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -27,17 +24,7 @@ func TestParseStorageURLValid(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "file absolute path",
|
name: "file absolute path",
|
||||||
raw: "file:///var/backups/vaultik",
|
raw: "file:///var/backups/vaultik",
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/var/backups/vaultik"},
|
want: &storage.URL{Scheme: "file", Prefix: "/var/backups/vaultik"},
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "file percent-escaped path is decoded",
|
|
||||||
raw: "file:///Volumes/my%20stick/backup",
|
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "file path with a literal space",
|
|
||||||
raw: "file:///Volumes/my stick/backup",
|
|
||||||
want: &storage.URL{Scheme: fileScheme, Prefix: "/Volumes/my stick/backup"},
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "s3 bucket and prefix, ssl defaults on",
|
name: "s3 bucket and prefix, ssl defaults on",
|
||||||
@@ -103,7 +90,6 @@ func TestParseStorageURLErrors(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{"empty url", "", storage.ErrEmptyStorageURL},
|
{"empty url", "", storage.ErrEmptyStorageURL},
|
||||||
{"file empty path", "file://", storage.ErrEmptyFilePath},
|
{"file empty path", "file://", storage.ErrEmptyFilePath},
|
||||||
{"file relative path", "file://dest", storage.ErrRelativeFilePath},
|
|
||||||
{"s3 missing bucket", "s3://", storage.ErrMissingBucket},
|
{"s3 missing bucket", "s3://", storage.ErrMissingBucket},
|
||||||
{"s3 missing bucket with path", "s3:///justprefix", storage.ErrMissingBucket},
|
{"s3 missing bucket with path", "s3:///justprefix", storage.ErrMissingBucket},
|
||||||
{"rclone missing remote", "rclone://", storage.ErrMissingRemote},
|
{"rclone missing remote", "rclone://", storage.ErrMissingRemote},
|
||||||
|
|||||||
@@ -257,10 +257,6 @@ func (s *stubLister) List(_ context.Context, _ string) ([]string, error) {
|
|||||||
return nil, errStubUnused
|
return nil, errStubUnused
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *stubLister) DeletePartialUploads(_ context.Context, _ string) error {
|
|
||||||
return errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Info() storage.Info {
|
func (s *stubLister) Info() storage.Info {
|
||||||
return storage.Info{}
|
return storage.Info{}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -661,18 +661,17 @@ func faultScannerFactory(
|
|||||||
) snapshot.ScannerFactory {
|
) snapshot.ScannerFactory {
|
||||||
return func(params snapshot.ScannerParams) *snapshot.Scanner {
|
return func(params snapshot.ScannerParams) *snapshot.Scanner {
|
||||||
return snapshot.NewScanner(snapshot.ScannerConfig{
|
return snapshot.NewScanner(snapshot.ScannerConfig{
|
||||||
FS: params.Fs,
|
FS: params.Fs,
|
||||||
Storage: storer,
|
Storage: storer,
|
||||||
ChunkSize: faultChunkSize,
|
ChunkSize: faultChunkSize,
|
||||||
MaxBlobSize: faultMaxBlobSize,
|
MaxBlobSize: faultMaxBlobSize,
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
Repositories: repos,
|
Repositories: repos,
|
||||||
EnableProgress: params.EnableProgress,
|
EnableProgress: params.EnableProgress,
|
||||||
UI: params.UI,
|
UI: params.UI,
|
||||||
Exclude: params.Exclude,
|
Exclude: params.Exclude,
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ package vaultik
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"math"
|
|
||||||
"regexp"
|
"regexp"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -48,10 +47,6 @@ const (
|
|||||||
year = 365 * day
|
year = 365 * day
|
||||||
)
|
)
|
||||||
|
|
||||||
// maxDuration is the largest value a time.Duration can hold, about 292
|
|
||||||
// years.
|
|
||||||
const maxDuration = time.Duration(math.MaxInt64)
|
|
||||||
|
|
||||||
// A snapshot ID split on "_" has at least a hostname and a trailing
|
// A snapshot ID split on "_" has at least a hostname and a trailing
|
||||||
// timestamp.
|
// timestamp.
|
||||||
const minSnapshotIDParts = 2
|
const minSnapshotIDParts = 2
|
||||||
@@ -150,10 +145,10 @@ func parseSnapshotName(snapshotID, hostname string) string {
|
|||||||
// parseDuration parses a duration string with support for human-friendly units:
|
// parseDuration parses a duration string with support for human-friendly units:
|
||||||
// d/day/days, w/week/weeks, mo/month/months, y/year/years, plus standard Go
|
// d/day/days, w/week/weeks, mo/month/months, y/year/years, plus standard Go
|
||||||
// duration units. Following Go, m is minutes and mo is months. A bare number,
|
// duration units. Following Go, m is minutes and mo is months. A bare number,
|
||||||
// an unknown unit, a negative value, and a total longer than maxDuration are
|
// an unknown unit, and a negative value are all rejected. Outside the Go
|
||||||
// all rejected. Outside the Go units the input must be whole numbers each
|
// units the input must be whole numbers each followed directly by a unit
|
||||||
// followed directly by a unit (2w3d), so 1.0y and 30 days are errors;
|
// (2w3d), so 1.0y and 30 days are errors; decimals work only in Go units
|
||||||
// decimals work only in Go units (1.5h).
|
// (1.5h).
|
||||||
func parseDuration(s string) (time.Duration, error) {
|
func parseDuration(s string) (time.Duration, error) {
|
||||||
if strings.HasPrefix(strings.TrimSpace(s), "-") {
|
if strings.HasPrefix(strings.TrimSpace(s), "-") {
|
||||||
return 0, errNegativeDuration
|
return 0, errNegativeDuration
|
||||||
@@ -186,30 +181,19 @@ func parseDuration(s string) (time.Duration, error) {
|
|||||||
return 0, fmt.Errorf("invalid number %q: %w", match[1], err)
|
return 0, fmt.Errorf("invalid number %q: %w", match[1], err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var unitLength time.Duration
|
|
||||||
|
|
||||||
unit := strings.ToLower(match[2])
|
unit := strings.ToLower(match[2])
|
||||||
switch unit {
|
switch unit {
|
||||||
case "d", "day", "days":
|
case "d", "day", "days":
|
||||||
unitLength = day
|
total += time.Duration(n) * day
|
||||||
case "w", "week", "weeks":
|
case "w", "week", "weeks":
|
||||||
unitLength = week
|
total += time.Duration(n) * week
|
||||||
case "mo", "month", "months":
|
case "mo", "month", "months":
|
||||||
unitLength = month
|
total += time.Duration(n) * month
|
||||||
case "y", "year", "years":
|
case "y", "year", "years":
|
||||||
unitLength = year
|
total += time.Duration(n) * year
|
||||||
default:
|
default:
|
||||||
return 0, fmt.Errorf("%w %q", errUnknownTimeUnit, unit)
|
return 0, fmt.Errorf("%w %q", errUnknownTimeUnit, unit)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Past maxDuration the sum wraps to a negative value, which would
|
|
||||||
// put the purge cutoff in the future.
|
|
||||||
if time.Duration(n) > (maxDuration-total)/unitLength {
|
|
||||||
return 0, fmt.Errorf("%w: %q is longer than about 292 years",
|
|
||||||
errInvalidDuration, s)
|
|
||||||
}
|
|
||||||
|
|
||||||
total += time.Duration(n) * unitLength
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return total, nil
|
return total, nil
|
||||||
|
|||||||
@@ -111,17 +111,6 @@ func TestParseDuration(t *testing.T) {
|
|||||||
{"30 days", 0, true},
|
{"30 days", 0, true},
|
||||||
{"30 days ago", 0, true},
|
{"30 days ago", 0, true},
|
||||||
{"x7d", 0, true},
|
{"x7d", 0, true},
|
||||||
// The largest time.Duration is about 292 years. A larger value
|
|
||||||
// must be rejected, not wrapped to a negative one, which would
|
|
||||||
// put the cutoff in the future and select every snapshot.
|
|
||||||
{"292y", 292 * 365 * 24 * time.Hour, false},
|
|
||||||
{"293y", 0, true},
|
|
||||||
{"3559mo", 0, true},
|
|
||||||
{"15251w", 0, true},
|
|
||||||
{"106752d", 0, true},
|
|
||||||
{"2562048h", 0, true},
|
|
||||||
{"200y200y", 0, true},
|
|
||||||
{"292y6mo", 0, true},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
|
|||||||
@@ -167,6 +167,10 @@ const (
|
|||||||
// metadataKeyParts is the minimum "/"-separated segment count of a
|
// metadataKeyParts is the minimum "/"-separated segment count of a
|
||||||
// metadata object key (metadata/<snapshot-id>/<filename>).
|
// metadata object key (metadata/<snapshot-id>/<filename>).
|
||||||
metadataKeyParts = 3
|
metadataKeyParts = 3
|
||||||
|
|
||||||
|
// blobKeyParts is the minimum "/"-separated segment count of a blob
|
||||||
|
// object key (blobs/<aa>/<bb>/<hash>).
|
||||||
|
blobKeyParts = 4
|
||||||
)
|
)
|
||||||
|
|
||||||
// SnapshotMetadataInfo contains information about a single snapshot's metadata
|
// SnapshotMetadataInfo contains information about a single snapshot's metadata
|
||||||
@@ -450,16 +454,23 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
v.stdoutf("Scanning blobs...\n")
|
v.stdoutf("Scanning blobs...\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Use prune's listing, so a file under blobs/ that prune would never
|
blobCh := v.Storage.ListStream(v.ctx, "blobs/")
|
||||||
// delete is not counted as a blob, and so not as an orphaned one.
|
allBlobs := make(map[string]int64)
|
||||||
allBlobs, err := v.listAllRemoteBlobs()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, size := range allBlobs {
|
for obj := range blobCh {
|
||||||
|
if obj.Err != nil {
|
||||||
|
return fmt.Errorf("listing blobs: %w", obj.Err)
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := strings.Split(obj.Key, "/")
|
||||||
|
if len(parts) < blobKeyParts {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
hash := parts[3]
|
||||||
|
allBlobs[hash] = obj.Size
|
||||||
result.TotalBlobCount++
|
result.TotalBlobCount++
|
||||||
result.TotalBlobSize += size
|
result.TotalBlobSize += obj.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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
|
||||||
|
|||||||
@@ -155,12 +155,6 @@ func (m *MockStorer) ListStream(
|
|||||||
return ch
|
return ch
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads has nothing to remove: Put stores each object
|
|
||||||
// under its key at once.
|
|
||||||
func (m *MockStorer) DeletePartialUploads(_ context.Context, _ string) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *MockStorer) Info() storage.Info {
|
func (m *MockStorer) Info() storage.Info {
|
||||||
return storage.Info{
|
return storage.Info{
|
||||||
Type: "mock",
|
Type: "mock",
|
||||||
|
|||||||
@@ -1,64 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"io/fs"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestNukeRemoteLeavesNoFiles checks that remote nuke leaves no file
|
|
||||||
// under a file:// destination, including the `.partial` files uploads
|
|
||||||
// killed part-way leave next to a snapshot's metadata and next to where a
|
|
||||||
// blob would have been.
|
|
||||||
func TestNukeRemoteLeavesNoFiles(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
storeDir := filepath.Join(t.TempDir(), "store")
|
|
||||||
v, repos, _ := backUpToFileDestination(ctx, t, storeDir)
|
|
||||||
|
|
||||||
snapshots, err := repos.Snapshots.ListRecent(ctx, listRecentTestLimit)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, snapshots, 1)
|
|
||||||
|
|
||||||
snapshotKey := snapshot.RemoteSnapshotKey(snapshots[0].ID.String())
|
|
||||||
hash := testBlobHashA
|
|
||||||
leftovers := []string{
|
|
||||||
filepath.Join(storeDir, "metadata", snapshotKey,
|
|
||||||
"db.zst.age-123456.partial"),
|
|
||||||
filepath.Join(storeDir, "blobs", hash[:2], hash[2:4],
|
|
||||||
hash+"-123456.partial"),
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, leftover := range leftovers {
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(leftover), 0o750))
|
|
||||||
require.NoError(t, os.WriteFile(leftover, []byte("half an upload"), 0o600))
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NoError(t, v.NukeRemote(true))
|
|
||||||
|
|
||||||
var files []string
|
|
||||||
|
|
||||||
err = filepath.WalkDir(storeDir,
|
|
||||||
func(path string, entry fs.DirEntry, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !entry.IsDir() {
|
|
||||||
files = append(files, path)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, files)
|
|
||||||
}
|
|
||||||
@@ -23,14 +23,9 @@ var errNukeRequiresForce = errors.New(
|
|||||||
// metadata.
|
// metadata.
|
||||||
const metadataDirName = "metadata"
|
const metadataDirName = "metadata"
|
||||||
|
|
||||||
// blobKeyParts is the "/"-separated segment count of a blob object key
|
|
||||||
// (blobs/<aa>/<bb>/<hash>).
|
|
||||||
const blobKeyParts = 4
|
|
||||||
|
|
||||||
// NukeRemote deletes every snapshot's metadata and every blob from remote
|
// NukeRemote deletes every snapshot's metadata and every blob from remote
|
||||||
// storage, along with any object an upload cut off part-way left under a
|
// storage. After this returns successfully the bucket prefix is empty and
|
||||||
// temporary `.partial` name. After this returns successfully the bucket
|
// the next backup starts from scratch.
|
||||||
// prefix is empty and the next backup starts from scratch.
|
|
||||||
//
|
//
|
||||||
// Refuses to run unless force is true. The caller is responsible for
|
// Refuses to run unless force is true. The caller is responsible for
|
||||||
// confirming with the user.
|
// confirming with the user.
|
||||||
@@ -53,15 +48,6 @@ func (v *Vaultik) NukeRemote(force bool) error {
|
|||||||
return fmt.Errorf("pruning blobs: %w", err)
|
return fmt.Errorf("pruning blobs: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The file and rclone listings skip `.partial` objects, so the two
|
|
||||||
// steps above never delete them.
|
|
||||||
for _, prefix := range []string{"metadata/", "blobs/"} {
|
|
||||||
err = v.Storage.DeletePartialUploads(v.ctx, prefix)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("deleting partial uploads: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
v.UI.Completef("Backup destination store is now empty.")
|
v.UI.Completef("Backup destination store is now empty.")
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
@@ -267,29 +267,6 @@ func TestPurgeOlderThan_WithNameFilter(t *testing.T) {
|
|||||||
assert.Contains(t, remaining, snapHomeT0)
|
assert.Contains(t, remaining, snapHomeT0)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPurgeOlderThan_TooLargeDeletesNothing(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
snapshotIDs := []string{snapHomeT0, snapHomeT1}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapHostname, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
OlderThan: "1000y",
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.Error(t, err)
|
|
||||||
|
|
||||||
err = v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
OlderThan: "292y",
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
assert.ElementsMatch(t, snapshotIDs, listRemainingSnapshots(t, v))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_ThreeNames(t *testing.T) {
|
func TestPurgeKeepLatest_ThreeNames(t *testing.T) {
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|||||||
@@ -185,39 +185,6 @@ func TestRemoteInfo_SkipsNonConformingMetadataName(t *testing.T) {
|
|||||||
assert.NotContains(t, doc, "unreadable_manifests")
|
assert.NotContains(t, doc, "unreadable_manifests")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRemoteInfo_DoesNotCountNonBlobFileUnderBlobs checks that a file
|
|
||||||
// under blobs/ whose name is not a blob hash is not counted as a blob.
|
|
||||||
// prune never deletes such a file, so counting it as an orphaned blob
|
|
||||||
// would advise a prune that removes nothing.
|
|
||||||
func TestRemoteInfo_DoesNotCountNonBlobFileUnderBlobs(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newListEnv(t)
|
|
||||||
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
|
||||||
addBlob(t, env.store.testStorer, testBlobHashA)
|
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
|
||||||
"blobs/"+testBlobHashA[:2]+"/"+testBlobHashA[2:4]+"/.DS_Store",
|
|
||||||
bytes.NewReader([]byte("junk"))))
|
|
||||||
|
|
||||||
require.NoError(t, env.v.RemoteInfo(false))
|
|
||||||
|
|
||||||
text := env.stdout.String()
|
|
||||||
assert.Contains(t, text, "Total blobs on remote: 1 (")
|
|
||||||
assert.Contains(t, text, "Orphaned (unreferenced): 0 (")
|
|
||||||
assert.NotContains(t, text, "vaultik prune")
|
|
||||||
|
|
||||||
env.stdout.Reset()
|
|
||||||
require.NoError(t, env.v.RemoteInfo(true))
|
|
||||||
|
|
||||||
var doc map[string]any
|
|
||||||
|
|
||||||
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
|
||||||
assert.InDelta(t, 1, doc["total_blob_count"], 0)
|
|
||||||
assert.InDelta(t, 0, doc["orphaned_blob_count"], 0)
|
|
||||||
assert.InDelta(t, 0, doc["orphaned_blob_size"], 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRemoteInfo_DirectoryWithoutManifestLeavesOrphansKnown checks that
|
// TestRemoteInfo_DirectoryWithoutManifestLeavesOrphansKnown checks that
|
||||||
// a directory under metadata/ holding no manifest.json.zst, such as one
|
// a directory under metadata/ holding no manifest.json.zst, such as one
|
||||||
// left by a backup interrupted before its manifest upload, leaves the
|
// left by a backup interrupted before its manifest upload, leaves the
|
||||||
|
|||||||
@@ -3,21 +3,17 @@ package vaultik_test
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"database/sql"
|
|
||||||
"io"
|
"io"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/klauspost/compress/zstd"
|
"github.com/klauspost/compress/zstd"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
"sneak.berlin/go/vaultik/internal/snapshot"
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
"sneak.berlin/go/vaultik/internal/types"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -129,12 +125,6 @@ func (s *testStorer) ListStream(
|
|||||||
return ch
|
return ch
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeletePartialUploads has nothing to remove: Put stores each object
|
|
||||||
// under its key at once.
|
|
||||||
func (s *testStorer) DeletePartialUploads(_ context.Context, _ string) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *testStorer) Info() storage.Info {
|
func (s *testStorer) Info() storage.Info {
|
||||||
return storage.Info{
|
return storage.Info{
|
||||||
Type: testLabel,
|
Type: testLabel,
|
||||||
@@ -218,37 +208,6 @@ func addBlob(t *testing.T, store *testStorer, hash string) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// newLocalIndex returns an in-memory local index holding a completed
|
|
||||||
// snapshot row for each of ids.
|
|
||||||
func newLocalIndex(t *testing.T, ids ...string) *database.Repositories {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
db, err := database.New(ctx, ":memory:")
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
for _, id := range ids {
|
|
||||||
completedAt := time.Now().UTC()
|
|
||||||
snap := &database.Snapshot{
|
|
||||||
ID: types.SnapshotID(id),
|
|
||||||
Hostname: snapHostname,
|
|
||||||
StartedAt: completedAt,
|
|
||||||
CompletedAt: &completedAt,
|
|
||||||
}
|
|
||||||
|
|
||||||
err = repos.WithTx(ctx, func(ctx context.Context, tx *sql.Tx) error {
|
|
||||||
return repos.Snapshots.Create(ctx, tx, snap)
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return repos
|
|
||||||
}
|
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
// Unit Tests for RemoveSnapshot
|
// Unit Tests for RemoveSnapshot
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
@@ -268,7 +227,6 @@ func TestRemoveSnapshot_LocalOnly_PreservesRemote(t *testing.T) {
|
|||||||
addBlob(t, store, blobA)
|
addBlob(t, store, blobA)
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(store)
|
tv := vaultik.NewForTesting(store)
|
||||||
tv.Repositories = newLocalIndex(t, "snapshot-001")
|
|
||||||
|
|
||||||
opts := &vaultik.RemoveOptions{Force: true, LocalOnly: true}
|
opts := &vaultik.RemoveOptions{Force: true, LocalOnly: true}
|
||||||
result, err := tv.RemoveSnapshot("snapshot-001", opts)
|
result, err := tv.RemoveSnapshot("snapshot-001", opts)
|
||||||
@@ -304,7 +262,6 @@ func TestRemoveSnapshot_DefaultRemovesMetadataNotBlobs(t *testing.T) {
|
|||||||
addBlob(t, store, blobShared)
|
addBlob(t, store, blobShared)
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(store)
|
tv := vaultik.NewForTesting(store)
|
||||||
tv.Repositories = newLocalIndex(t, "snapshot-001", "snapshot-002")
|
|
||||||
|
|
||||||
opts := &vaultik.RemoveOptions{Force: true}
|
opts := &vaultik.RemoveOptions{Force: true}
|
||||||
result, err := tv.RemoveSnapshot("snapshot-001", opts)
|
result, err := tv.RemoveSnapshot("snapshot-001", opts)
|
||||||
@@ -353,84 +310,6 @@ func TestRemoveSnapshot_DryRun(t *testing.T) {
|
|||||||
assert.Contains(t, tv.Stdout.String(), "[Dry run - no changes made]")
|
assert.Contains(t, tv.Stdout.String(), "[Dry run - no changes made]")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRemoveSnapshot_UnknownIDIsError checks that an ID naming no
|
|
||||||
// snapshot in the local index or on the destination store is an error
|
|
||||||
// under every option, and that nothing is reported as removed.
|
|
||||||
func TestRemoveSnapshot_UnknownIDIsError(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for name, opts := range map[string]vaultik.RemoveOptions{
|
|
||||||
"force": {Force: true},
|
|
||||||
"json": {JSON: true},
|
|
||||||
"dry-run": {Force: true, DryRun: true},
|
|
||||||
"local-only": {Force: true, LocalOnly: true},
|
|
||||||
} {
|
|
||||||
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, "snapshot-001")
|
|
||||||
|
|
||||||
result, err := tv.RemoveSnapshot("snapshot-999", &opts)
|
|
||||||
|
|
||||||
require.ErrorContains(t, err, "snapshot not found")
|
|
||||||
assert.False(t, result.RemoteRemoved)
|
|
||||||
assert.Empty(t, tv.Stdout.String())
|
|
||||||
assert.True(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRemoveSnapshot_NoMetadataOnDestination checks that removing a
|
|
||||||
// snapshot whose metadata is not on the destination store does not
|
|
||||||
// report metadata removed from it.
|
|
||||||
func TestRemoveSnapshot_NoMetadataOnDestination(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(newTestStorer())
|
|
||||||
tv.Repositories = newLocalIndex(t, "snapshot-001")
|
|
||||||
|
|
||||||
result, err := tv.RemoveSnapshot("snapshot-001",
|
|
||||||
&vaultik.RemoveOptions{Force: true})
|
|
||||||
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.False(t, result.RemoteRemoved)
|
|
||||||
|
|
||||||
out := tv.Stdout.String()
|
|
||||||
assert.Contains(t, out, "Removed snapshot 'snapshot-001' from local database")
|
|
||||||
assert.NotContains(t, out, "Removed snapshot metadata from remote storage")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRemoveSnapshot_NotInLocalIndex checks that removing a snapshot
|
|
||||||
// only the destination store holds removes its metadata there without
|
|
||||||
// reporting a removal from the local database.
|
|
||||||
func TestRemoveSnapshot_NotInLocalIndex(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
store := newTestStorer()
|
|
||||||
addManifest(t, store, "snapshot-001", nil)
|
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(store)
|
|
||||||
tv.Repositories = newLocalIndex(t)
|
|
||||||
|
|
||||||
result, err := tv.RemoveSnapshot("snapshot-001",
|
|
||||||
&vaultik.RemoveOptions{Force: true})
|
|
||||||
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.True(t, result.RemoteRemoved)
|
|
||||||
assert.False(t, store.hasKey(remoteKeyPath("snapshot-001")))
|
|
||||||
|
|
||||||
out := tv.Stdout.String()
|
|
||||||
assert.NotContains(t, out, "from local database")
|
|
||||||
assert.Contains(t, out, "Removed snapshot metadata from remote storage")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRemoveAllSnapshots_RequiresForce(t *testing.T) {
|
func TestRemoveAllSnapshots_RequiresForce(t *testing.T) {
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|||||||
+40
-159
@@ -23,19 +23,12 @@ var (
|
|||||||
errNoSnapshotsInConfig = errors.New("no snapshots configured")
|
errNoSnapshotsInConfig = errors.New("no snapshots configured")
|
||||||
errSnapshotVerifyFailed = errors.New("verification failed")
|
errSnapshotVerifyFailed = errors.New("verification failed")
|
||||||
errRemoveAllNeedsForce = errors.New("--all requires --force")
|
errRemoveAllNeedsForce = errors.New("--all requires --force")
|
||||||
errSnapshotNotFound = errors.New("snapshot not found")
|
|
||||||
errInvalidTableName = errors.New("invalid table name")
|
errInvalidTableName = errors.New("invalid table name")
|
||||||
errNoAgeRecipients = errors.New(
|
errNoAgeRecipients = errors.New(
|
||||||
"creating a snapshot needs at least one public key in " +
|
"creating a snapshot needs at least one public key in " +
|
||||||
"age_recipients (generate a keypair with: age-keygen)")
|
"age_recipients (generate a keypair with: age-keygen)")
|
||||||
errKeepNewerThanNeedsPrune = errors.New("--keep-newer-than requires --prune")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrPostBackupPruneFailed wraps a failure of the post-backup prune,
|
|
||||||
// which runs only after every snapshot was created and uploaded, so the
|
|
||||||
// caller can report it apart from a failed backup.
|
|
||||||
var ErrPostBackupPruneFailed = errors.New("post-backup prune failed")
|
|
||||||
|
|
||||||
// listRecentLimit caps how many snapshot rows are fetched from the
|
// listRecentLimit caps how many snapshot rows are fetched from the
|
||||||
// local index for listing and purge operations.
|
// local index for listing and purge operations.
|
||||||
const listRecentLimit = 10000
|
const listRecentLimit = 10000
|
||||||
@@ -51,26 +44,6 @@ type SnapshotCreateOptions struct {
|
|||||||
Snapshots []string // Optional list of snapshot names to process (empty = all)
|
Snapshots []string // Optional list of snapshot names to process (empty = all)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate fails when KeepNewerThan is set without Prune or is not a
|
|
||||||
// valid duration. Only the post-backup prune reads KeepNewerThan, after
|
|
||||||
// the backup, so the caller checks it before starting one.
|
|
||||||
func (opts *SnapshotCreateOptions) Validate() error {
|
|
||||||
if opts.KeepNewerThan == "" {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if !opts.Prune {
|
|
||||||
return errKeepNewerThanNeedsPrune
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := parseDuration(opts.KeepNewerThan)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("--keep-newer-than: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateSnapshot executes the snapshot creation operation
|
// CreateSnapshot executes the snapshot creation operation
|
||||||
func (v *Vaultik) CreateSnapshot(opts *SnapshotCreateOptions) error {
|
func (v *Vaultik) CreateSnapshot(opts *SnapshotCreateOptions) error {
|
||||||
// config.Load accepts an empty list, since listing, verifying and
|
// config.Load accepts an empty list, since listing, verifying and
|
||||||
@@ -149,7 +122,7 @@ func (v *Vaultik) CreateSnapshot(opts *SnapshotCreateOptions) error {
|
|||||||
if opts.Prune {
|
if opts.Prune {
|
||||||
err = v.runPostBackupPrune(snapshotNames, opts.KeepNewerThan)
|
err = v.runPostBackupPrune(snapshotNames, opts.KeepNewerThan)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: %w", ErrPostBackupPruneFailed, err)
|
return fmt.Errorf("post-backup prune: %w", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -212,7 +185,6 @@ type snapshotStats struct {
|
|||||||
totalBlobs int
|
totalBlobs int
|
||||||
totalBytesSkipped int64
|
totalBytesSkipped int64
|
||||||
totalFilesSkipped int
|
totalFilesSkipped int
|
||||||
totalFilesFailed int
|
|
||||||
totalFilesDeleted int
|
totalFilesDeleted int
|
||||||
totalBytesDeleted int64
|
totalBytesDeleted int64
|
||||||
totalBytesUploaded int64
|
totalBytesUploaded int64
|
||||||
@@ -240,18 +212,12 @@ func (v *Vaultik) createNamedSnapshot(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
previousSnapshotID, err := v.previousSnapshotID(snapName)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
scanner := v.ScannerFactory(snapshot.ScannerParams{
|
scanner := v.ScannerFactory(snapshot.ScannerParams{
|
||||||
EnableProgress: !opts.Cron,
|
EnableProgress: !opts.Cron,
|
||||||
UI: v.UI,
|
UI: v.UI,
|
||||||
Fs: v.Fs,
|
Fs: v.Fs,
|
||||||
Exclude: v.Config.GetExcludes(snapName),
|
Exclude: v.Config.GetExcludes(snapName),
|
||||||
SkipErrors: opts.SkipErrors,
|
SkipErrors: opts.SkipErrors,
|
||||||
PreviousSnapshotID: previousSnapshotID,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
snapshotID, err := v.SnapshotManager.CreateSnapshotWithName(
|
snapshotID, err := v.SnapshotManager.CreateSnapshotWithName(
|
||||||
@@ -286,24 +252,6 @@ func (v *Vaultik) createNamedSnapshot(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// previousSnapshotID returns the ID of the most recent completed snapshot
|
|
||||||
// named snapName in the local index, or "" when there is none.
|
|
||||||
func (v *Vaultik) previousSnapshotID(snapName string) (string, error) {
|
|
||||||
snapshots, err := v.Repositories.Snapshots.ListRecent(v.ctx, listRecentLimit)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("listing snapshots: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, s := range snapshots {
|
|
||||||
if s.CompletedAt != nil &&
|
|
||||||
parseSnapshotName(s.ID.String(), s.Hostname.String()) == snapName {
|
|
||||||
return s.ID.String(), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// resolveSnapshotPaths resolves source directories to absolute paths
|
// resolveSnapshotPaths resolves source directories to absolute paths
|
||||||
// with symlink resolution.
|
// with symlink resolution.
|
||||||
func (v *Vaultik) resolveSnapshotPaths(snapName string) ([]string, error) {
|
func (v *Vaultik) resolveSnapshotPaths(snapName string) ([]string, error) {
|
||||||
@@ -367,7 +315,6 @@ func (v *Vaultik) scanAllDirectories(
|
|||||||
stats.totalChunks += result.ChunksCreated
|
stats.totalChunks += result.ChunksCreated
|
||||||
stats.totalBlobs += result.BlobsCreated
|
stats.totalBlobs += result.BlobsCreated
|
||||||
stats.totalFilesSkipped += result.FilesSkipped
|
stats.totalFilesSkipped += result.FilesSkipped
|
||||||
stats.totalFilesFailed += result.FilesFailed
|
|
||||||
stats.totalBytesSkipped += result.BytesSkipped
|
stats.totalBytesSkipped += result.BytesSkipped
|
||||||
stats.totalFilesDeleted += result.FilesDeleted
|
stats.totalFilesDeleted += result.FilesDeleted
|
||||||
stats.totalBytesDeleted += result.BytesDeleted
|
stats.totalBytesDeleted += result.BytesDeleted
|
||||||
@@ -379,7 +326,6 @@ func (v *Vaultik) scanAllDirectories(
|
|||||||
"path", dir,
|
"path", dir,
|
||||||
"files", result.FilesScanned,
|
"files", result.FilesScanned,
|
||||||
"files_skipped", result.FilesSkipped,
|
"files_skipped", result.FilesSkipped,
|
||||||
"files_failed", result.FilesFailed,
|
|
||||||
"bytes", result.BytesScanned,
|
"bytes", result.BytesScanned,
|
||||||
"bytes_skipped", result.BytesSkipped,
|
"bytes_skipped", result.BytesSkipped,
|
||||||
"chunks", result.ChunksCreated,
|
"chunks", result.ChunksCreated,
|
||||||
@@ -413,11 +359,9 @@ func (v *Vaultik) finalizeSnapshotMetadata(
|
|||||||
return fmt.Errorf("getting snapshot blob sizes: %w", err)
|
return fmt.Errorf("getting snapshot blob sizes: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// file_count and total_size leave out the files that could not be
|
|
||||||
// stored; stats.totalBytes already does.
|
|
||||||
extStats := snapshot.ExtendedBackupStats{
|
extStats := snapshot.ExtendedBackupStats{
|
||||||
BackupStats: snapshot.BackupStats{
|
BackupStats: snapshot.BackupStats{
|
||||||
FilesScanned: stats.totalFiles - stats.totalFilesFailed,
|
FilesScanned: stats.totalFiles,
|
||||||
TotalSize: stats.totalBytes + stats.totalBytesSkipped,
|
TotalSize: stats.totalBytes + stats.totalBytesSkipped,
|
||||||
ChunksCreated: stats.totalChunks,
|
ChunksCreated: stats.totalChunks,
|
||||||
BlobsCreated: stats.totalBlobs,
|
BlobsCreated: stats.totalBlobs,
|
||||||
@@ -465,8 +409,7 @@ func (v *Vaultik) printSnapshotSummary(
|
|||||||
snapshotID string, startTime time.Time, stats *snapshotStats,
|
snapshotID string, startTime time.Time, stats *snapshotStats,
|
||||||
) {
|
) {
|
||||||
snapshotDuration := time.Since(startTime)
|
snapshotDuration := time.Since(startTime)
|
||||||
totalFilesChanged := stats.totalFiles - stats.totalFilesSkipped -
|
totalFilesChanged := stats.totalFiles - stats.totalFilesSkipped
|
||||||
stats.totalFilesFailed
|
|
||||||
totalBytesAll := stats.totalBytes + stats.totalBytesSkipped
|
totalBytesAll := stats.totalBytes + stats.totalBytesSkipped
|
||||||
|
|
||||||
var compressionRatio float64
|
var compressionRatio float64
|
||||||
@@ -483,10 +426,6 @@ func (v *Vaultik) printSnapshotSummary(
|
|||||||
v.UI.Count(stats.totalFiles),
|
v.UI.Count(stats.totalFiles),
|
||||||
v.UI.Count(totalFilesChanged),
|
v.UI.Count(totalFilesChanged),
|
||||||
v.UI.Count(stats.totalFilesSkipped))
|
v.UI.Count(stats.totalFilesSkipped))
|
||||||
if stats.totalFilesFailed > 0 {
|
|
||||||
filesMsg += fmt.Sprintf(", %s failed", v.UI.Count(stats.totalFilesFailed))
|
|
||||||
}
|
|
||||||
|
|
||||||
if stats.totalFilesDeleted > 0 {
|
if stats.totalFilesDeleted > 0 {
|
||||||
filesMsg += fmt.Sprintf(", %s deleted", v.UI.Count(stats.totalFilesDeleted))
|
filesMsg += fmt.Sprintf(", %s deleted", v.UI.Count(stats.totalFilesDeleted))
|
||||||
}
|
}
|
||||||
@@ -694,7 +633,7 @@ func (v *Vaultik) confirmAndExecutePurge(
|
|||||||
"snapshot_id", snapshotID, "error", err)
|
"snapshot_id", snapshotID, "error", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = v.deleteRemoteSnapshotByKey(snapshot.RemoteSnapshotKey(snapshotID))
|
err = v.deleteRemoteSnapshotByKey(snapshot.RemoteSnapshotKey(snapshotID))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("deleting snapshot %s from remote: %w", snapshotID, err)
|
return fmt.Errorf("deleting snapshot %s from remote: %w", snapshotID, err)
|
||||||
}
|
}
|
||||||
@@ -1204,11 +1143,6 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
|
|
||||||
inLocalIndex, err := v.findSnapshotToRemove(snapshotID, opts)
|
|
||||||
if err != nil {
|
|
||||||
return result, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if opts.DryRun {
|
if opts.DryRun {
|
||||||
return v.removeSnapshotDryRun(result, snapshotID, opts)
|
return v.removeSnapshotDryRun(result, snapshotID, opts)
|
||||||
}
|
}
|
||||||
@@ -1217,13 +1151,11 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if inLocalIndex {
|
log.Info("Removing snapshot from local database", "snapshot_id", snapshotID)
|
||||||
log.Info("Removing snapshot from local database", "snapshot_id", snapshotID)
|
|
||||||
|
|
||||||
err = v.deleteSnapshotFromLocalDB(snapshotID)
|
err = v.deleteSnapshotFromLocalDB(snapshotID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, fmt.Errorf("removing from local database: %w", err)
|
return result, fmt.Errorf("removing from local database: %w", err)
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if !opts.LocalOnly {
|
if !opts.LocalOnly {
|
||||||
@@ -1242,11 +1174,9 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, v.outputRemoveJSON(result)
|
return result, v.outputRemoveJSON(result)
|
||||||
}
|
}
|
||||||
|
|
||||||
if inLocalIndex {
|
v.stdoutf("Removed snapshot '%s' from local database\n", snapshotID)
|
||||||
v.stdoutf("Removed snapshot '%s' from local database\n", snapshotID)
|
|
||||||
}
|
|
||||||
|
|
||||||
if result.RemoteRemoved {
|
if !opts.LocalOnly && result.RemoteRemoved {
|
||||||
v.printlnStdout("Removed snapshot metadata from remote storage")
|
v.printlnStdout("Removed snapshot metadata from remote storage")
|
||||||
v.stdoutf("\nNote: The removed snapshot's blobs remain on the remote. "+
|
v.stdoutf("\nNote: The removed snapshot's blobs remain on the remote. "+
|
||||||
"Run '%s' to delete any blobs no longer referenced by any "+
|
"Run '%s' to delete any blobs no longer referenced by any "+
|
||||||
@@ -1256,45 +1186,6 @@ func (v *Vaultik) RemoveSnapshot(
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// findSnapshotToRemove reports whether the local index has a row for
|
|
||||||
// snapshotID, and returns errSnapshotNotFound when there is nothing to
|
|
||||||
// remove: no row and, unless LocalOnly is set, no metadata on the
|
|
||||||
// destination store either. The destination store is consulted only
|
|
||||||
// when the local index has no row, so a snapshot in the local index can
|
|
||||||
// still be removed from it while the destination store is unreachable.
|
|
||||||
func (v *Vaultik) findSnapshotToRemove(
|
|
||||||
snapshotID string, opts *RemoveOptions,
|
|
||||||
) (bool, error) {
|
|
||||||
if v.Repositories != nil {
|
|
||||||
snap, err := v.Repositories.Snapshots.GetByID(v.ctx, snapshotID)
|
|
||||||
if err != nil {
|
|
||||||
return false, fmt.Errorf("looking up snapshot in local index: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if snap != nil {
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if opts.LocalOnly {
|
|
||||||
return false, fmt.Errorf("%w in the local index: %s",
|
|
||||||
errSnapshotNotFound, snapshotID)
|
|
||||||
}
|
|
||||||
|
|
||||||
objects, err := v.remoteSnapshotObjects(snapshot.RemoteSnapshotKey(snapshotID))
|
|
||||||
if err != nil {
|
|
||||||
return false, fmt.Errorf("looking up snapshot on destination store: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(objects) == 0 {
|
|
||||||
return false, fmt.Errorf(
|
|
||||||
"%w in the local index or on the destination store: %s",
|
|
||||||
errSnapshotNotFound, snapshotID)
|
|
||||||
}
|
|
||||||
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// removeSnapshotDryRun reports what RemoveSnapshot would do without
|
// removeSnapshotDryRun reports what RemoveSnapshot would do without
|
||||||
// making changes.
|
// making changes.
|
||||||
func (v *Vaultik) removeSnapshotDryRun(
|
func (v *Vaultik) removeSnapshotDryRun(
|
||||||
@@ -1354,14 +1245,14 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions)
|
|||||||
// didn't finish and to run `vaultik snapshot remove` for the snapshot
|
// didn't finish and to run `vaultik snapshot remove` for the snapshot
|
||||||
// again once the destination store is reachable (`vaultik prune` never
|
// again once the destination store is reachable (`vaultik prune` never
|
||||||
// removes snapshot metadata). Returns true when the remote removal
|
// removes snapshot metadata). Returns true when the remote removal
|
||||||
// succeeded and deleted something.
|
// succeeded.
|
||||||
func (v *Vaultik) removeSnapshotRemote(snapshotID string, opts *RemoveOptions) bool {
|
func (v *Vaultik) removeSnapshotRemote(snapshotID string, opts *RemoveOptions) bool {
|
||||||
log.Info("Removing snapshot metadata from remote storage",
|
log.Info("Removing snapshot metadata from remote storage",
|
||||||
"snapshot_id", snapshotID)
|
"snapshot_id", snapshotID)
|
||||||
|
|
||||||
remoteKey := snapshot.RemoteSnapshotKey(snapshotID)
|
remoteKey := snapshot.RemoteSnapshotKey(snapshotID)
|
||||||
|
|
||||||
deleted, err := v.deleteRemoteSnapshotByKey(remoteKey)
|
err := v.deleteRemoteSnapshotByKey(remoteKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warn("Could not remove snapshot metadata from remote storage; "+
|
log.Warn("Could not remove snapshot metadata from remote storage; "+
|
||||||
"run '"+snapshotRemoveCommandHint+"' with the snapshot's ID "+
|
"run '"+snapshotRemoveCommandHint+"' with the snapshot's ID "+
|
||||||
@@ -1379,7 +1270,7 @@ func (v *Vaultik) removeSnapshotRemote(snapshotID string, opts *RemoveOptions) b
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
return deleted > 0
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveAllSnapshots removes every snapshot known to the local
|
// RemoveAllSnapshots removes every snapshot known to the local
|
||||||
@@ -1671,7 +1562,7 @@ func (v *Vaultik) removeAllLocalSnapshots(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !opts.LocalOnly {
|
if !opts.LocalOnly {
|
||||||
_, err = v.deleteRemoteSnapshotByKey(
|
err = v.deleteRemoteSnapshotByKey(
|
||||||
snapshot.RemoteSnapshotKey(snapshotID))
|
snapshot.RemoteSnapshotKey(snapshotID))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warn("Failed to remove snapshot metadata from remote",
|
log.Warn("Failed to remove snapshot metadata from remote",
|
||||||
@@ -1697,7 +1588,7 @@ func (v *Vaultik) removeAllOrphanRemotes(
|
|||||||
for _, key := range orphanRemoteKeys {
|
for _, key := range orphanRemoteKeys {
|
||||||
log.Info("Removing orphan remote snapshot", "remote_key", key)
|
log.Info("Removing orphan remote snapshot", "remote_key", key)
|
||||||
|
|
||||||
_, err := v.deleteRemoteSnapshotByKey(key)
|
err := v.deleteRemoteSnapshotByKey(key)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warn("Failed to remove orphan from remote",
|
log.Warn("Failed to remove orphan from remote",
|
||||||
"remote_key", key, "error", err)
|
"remote_key", key, "error", err)
|
||||||
@@ -1744,44 +1635,34 @@ func (v *Vaultik) deleteSnapshotFromLocalDB(snapshotID string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// deleteRemoteSnapshotByKey removes everything under
|
// deleteRemoteSnapshotByKey removes everything under
|
||||||
// metadata/<remoteKey>/ on the destination store and returns how many
|
// metadata/<remoteKey>/ on the destination store. The argument is a
|
||||||
// objects it deleted. The argument is a remote key (double-SHA256
|
// remote key (double-SHA256 derivation), not a human snapshot ID;
|
||||||
// derivation), not a human snapshot ID; callers that have a human ID
|
// callers that have a human ID must hash via snapshot.RemoteSnapshotKey
|
||||||
// must hash via snapshot.RemoteSnapshotKey first.
|
// first.
|
||||||
func (v *Vaultik) deleteRemoteSnapshotByKey(remoteKey string) (int, error) {
|
func (v *Vaultik) deleteRemoteSnapshotByKey(remoteKey string) error {
|
||||||
objectsToDelete, err := v.remoteSnapshotObjects(remoteKey)
|
prefix := fmt.Sprintf("metadata/%s/", remoteKey)
|
||||||
if err != nil {
|
objectCh := v.Storage.ListStream(v.ctx, prefix)
|
||||||
return 0, err
|
|
||||||
|
var objectsToDelete []string
|
||||||
|
|
||||||
|
for object := range objectCh {
|
||||||
|
if object.Err != nil {
|
||||||
|
return fmt.Errorf("listing objects: %w", object.Err)
|
||||||
|
}
|
||||||
|
|
||||||
|
objectsToDelete = append(objectsToDelete, object.Key)
|
||||||
}
|
}
|
||||||
|
|
||||||
for i, key := range objectsToDelete {
|
for _, key := range objectsToDelete {
|
||||||
err = v.Storage.Delete(v.ctx, key)
|
err := v.Storage.Delete(v.ctx, key)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return i, fmt.Errorf("removing %s: %w", key, err)
|
return fmt.Errorf("removing %s: %w", key, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Debug("Deleted remote object", "key", key)
|
log.Debug("Deleted remote object", "key", key)
|
||||||
}
|
}
|
||||||
|
|
||||||
return len(objectsToDelete), nil
|
return nil
|
||||||
}
|
|
||||||
|
|
||||||
// remoteSnapshotObjects lists the keys of every object under
|
|
||||||
// metadata/<remoteKey>/ on the destination store.
|
|
||||||
func (v *Vaultik) remoteSnapshotObjects(remoteKey string) ([]string, error) {
|
|
||||||
prefix := fmt.Sprintf("metadata/%s/", remoteKey)
|
|
||||||
|
|
||||||
var keys []string
|
|
||||||
|
|
||||||
for object := range v.Storage.ListStream(v.ctx, prefix) {
|
|
||||||
if object.Err != nil {
|
|
||||||
return nil, fmt.Errorf("listing objects: %w", object.Err)
|
|
||||||
}
|
|
||||||
|
|
||||||
keys = append(keys, object.Key)
|
|
||||||
}
|
|
||||||
|
|
||||||
return keys, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// outputRemoveJSON outputs the removal result as JSON
|
// outputRemoveJSON outputs the removal result as JSON
|
||||||
|
|||||||
@@ -1,196 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// These tests cover https://git.eeqj.de/sneak/vaultik/issues/304: a
|
|
||||||
// backup counts a file as deleted only when the previous snapshot of
|
|
||||||
// the same name had it and it is gone, and never counts an excluded
|
|
||||||
// file.
|
|
||||||
|
|
||||||
// deletedCountEnv is a backup setup over the source directory src whose
|
|
||||||
// user-facing output is kept in out. Each test configures its snapshots
|
|
||||||
// with setSnapshot.
|
|
||||||
type deletedCountEnv struct {
|
|
||||||
v *vaultik.Vaultik
|
|
||||||
out *bytes.Buffer
|
|
||||||
src string
|
|
||||||
}
|
|
||||||
|
|
||||||
// newDeletedCountEnv writes files, keyed by path relative to src.
|
|
||||||
func newDeletedCountEnv(t *testing.T, files map[string][]byte) *deletedCountEnv {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
srcDir := filepath.Join(tempDir, "src")
|
|
||||||
|
|
||||||
for rel, content := range files {
|
|
||||||
path := filepath.Join(srcDir, rel)
|
|
||||||
require.NoError(t, fs.MkdirAll(filepath.Dir(path), 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs, path, content, 0o644))
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
cfg.IndexPath = filepath.Join(tempDir, "index.sqlite")
|
|
||||||
cfg.Snapshots = map[string]config.SnapshotConfig{}
|
|
||||||
|
|
||||||
store, err := storage.NewFileStorer(filepath.Join(tempDir, "remote"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, cfg.IndexPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
out := &bytes.Buffer{}
|
|
||||||
v := newBackupVaultik(ctx, cfg, store, repos, db, fs)
|
|
||||||
v.UI = ui.NewWithColor(out, false)
|
|
||||||
|
|
||||||
return &deletedCountEnv{v: v, out: out, src: srcDir}
|
|
||||||
}
|
|
||||||
|
|
||||||
// setSnapshot configures the snapshot name to back up the path rel
|
|
||||||
// beneath src, with the given excludes.
|
|
||||||
func (e *deletedCountEnv) setSnapshot(name, rel string, exclude ...string) {
|
|
||||||
e.v.Config.Snapshots[name] = config.SnapshotConfig{
|
|
||||||
Paths: []string{filepath.Join(e.src, rel)},
|
|
||||||
Exclude: exclude,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// backUp runs a backup of the named snapshot and returns its output.
|
|
||||||
func (e *deletedCountEnv) backUp(t *testing.T, name string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
e.out.Reset()
|
|
||||||
require.NoError(t, e.v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
Snapshots: []string{name},
|
|
||||||
}))
|
|
||||||
|
|
||||||
return e.out.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file this snapshot excludes is not counted as deleted: neither one
|
|
||||||
// that another snapshot backs up, nor one that the previous snapshot of
|
|
||||||
// this name had before the exclude was added.
|
|
||||||
func TestBackupDoesNotCountExcludedFileAsDeleted(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"top.txt": []byte("top"),
|
|
||||||
"cache/tmp.bin": []byte("cache"),
|
|
||||||
"photos/a.jpg": []byte("photo a"),
|
|
||||||
"photos/b.jpg": []byte("photo b"),
|
|
||||||
"photos/c.jpg": []byte("photo c"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("photos", "photos")
|
|
||||||
env.setSnapshot("home", "", "/photos")
|
|
||||||
|
|
||||||
env.backUp(t, "photos")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(2, 2, 0))
|
|
||||||
|
|
||||||
env.setSnapshot("home", "", "/photos", "/cache")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file inside a directory that an exclude added after a backup
|
|
||||||
// matches is not counted as deleted, though the pattern matches only the
|
|
||||||
// directory.
|
|
||||||
func TestBackupDoesNotCountFileInExcludedDirectoryAsDeleted(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"top.txt": []byte("top"),
|
|
||||||
"user/.local/share/Trash/old.txt": []byte("old"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(2, 2, 0))
|
|
||||||
|
|
||||||
env.setSnapshot("home", "", "*/.local/share/Trash")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A backup counts only files that the previous snapshot of its own name
|
|
||||||
// had, not one that a later snapshot of another name over the same path
|
|
||||||
// had and that is since removed.
|
|
||||||
func TestBackupIgnoresSnapshotOfAnotherName(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"kept.txt": []byte("kept"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
env.setSnapshot("other", "")
|
|
||||||
|
|
||||||
env.backUp(t, "home")
|
|
||||||
|
|
||||||
// Snapshot start times are kept in whole seconds: wait so that other's
|
|
||||||
// snapshot is strictly the most recent.
|
|
||||||
time.Sleep(time.Second)
|
|
||||||
|
|
||||||
extra := filepath.Join(env.src, "extra.txt")
|
|
||||||
require.NoError(t, os.WriteFile(extra, []byte("extra"), 0o600))
|
|
||||||
env.backUp(t, "other")
|
|
||||||
require.NoError(t, os.Remove(extra))
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file removed from disk is counted as deleted by the next backup of
|
|
||||||
// the snapshot that had it, and not by any later backup of that
|
|
||||||
// snapshot, nor by the first backup of another name over the same path.
|
|
||||||
func TestBackupCountsDeletedFileOnce(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
aContent := bytes.Repeat([]byte("a"), 1000)
|
|
||||||
bContent := bytes.Repeat([]byte("b"), 2000)
|
|
||||||
keptContent := bytes.Repeat([]byte("k"), 500)
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"a.txt": aContent,
|
|
||||||
"b.txt": bContent,
|
|
||||||
"kept.txt": keptContent,
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
env.setSnapshot("other", "")
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(3, 3, 0))
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(env.src, "a.txt")))
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(env.src, "b.txt")))
|
|
||||||
|
|
||||||
summary := env.backUp(t, "home")
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
"Files: 1 examined, 0 backed up, 1 unchanged, 2 deleted.")
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
fmt.Sprintf("Data: %s total (%s backed up), %s deleted.",
|
|
||||||
env.v.UI.Size(int64(len(keptContent))), env.v.UI.Size(0),
|
|
||||||
env.v.UI.Size(int64(len(aContent)+len(bContent)))))
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
assert.Contains(t, env.backUp(t, "other"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
@@ -1,123 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// openFailFs is the real filesystem, except that opening path fails
|
|
||||||
// with err. Phase 1 of a backup only lstats a file, so it still counts
|
|
||||||
// path; phase 2 is the first to open it.
|
|
||||||
type openFailFs struct {
|
|
||||||
afero.OsFs
|
|
||||||
|
|
||||||
path string
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:ireturn // afero.Fs.Open is defined to return the interface.
|
|
||||||
func (f *openFailFs) Open(name string) (afero.File, error) {
|
|
||||||
if name == f.path {
|
|
||||||
return nil, &os.PathError{Op: "open", Path: name, Err: f.err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.OsFs.Open(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file that phase 2 cannot open is reported as failed, not as
|
|
||||||
// unchanged, and neither the summary's data total nor the snapshots row
|
|
||||||
// counts it. See https://git.eeqj.de/sneak/vaultik/issues/280.
|
|
||||||
func TestSnapshotSummaryCountsFileNotStoredAsFailed(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
openErr error
|
|
||||||
skipErrors bool
|
|
||||||
}{
|
|
||||||
// What a normal user gets opening a file with mode 000.
|
|
||||||
{name: "unopenable under skip-errors",
|
|
||||||
openErr: os.ErrPermission, skipErrors: true},
|
|
||||||
// What opening a file removed after phase 1 gives.
|
|
||||||
{name: "removed between the phases",
|
|
||||||
openErr: os.ErrNotExist, skipErrors: false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
// The scan walks the source path with symlinks resolved, so
|
|
||||||
// failedPath must be spelled the same way to match.
|
|
||||||
tempDir, err := filepath.EvalSymlinks(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
srcDir := filepath.Join(tempDir, "src")
|
|
||||||
failedPath := filepath.Join(srcDir, "failed.txt")
|
|
||||||
storedContent := []byte("this file is backed up")
|
|
||||||
storedSize := int64(len(storedContent))
|
|
||||||
|
|
||||||
fs := &openFailFs{path: failedPath, err: tt.openErr}
|
|
||||||
require.NoError(t, fs.MkdirAll(srcDir, 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs,
|
|
||||||
filepath.Join(srcDir, "stored.txt"), storedContent, 0o644))
|
|
||||||
require.NoError(t, afero.WriteFile(fs,
|
|
||||||
failedPath, []byte("this file cannot be opened"), 0o644))
|
|
||||||
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
cfg.IndexPath = filepath.Join(tempDir, "index.sqlite")
|
|
||||||
cfg.Snapshots = map[string]config.SnapshotConfig{
|
|
||||||
"src": {Paths: []string{srcDir}},
|
|
||||||
}
|
|
||||||
|
|
||||||
store, err := storage.NewFileStorer(filepath.Join(tempDir, "remote"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, cfg.IndexPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
out := &bytes.Buffer{}
|
|
||||||
v := newBackupVaultik(ctx, cfg, store, repos, db, fs)
|
|
||||||
v.UI = ui.NewWithColor(out, false)
|
|
||||||
|
|
||||||
require.NoError(t, v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
SkipErrors: tt.skipErrors,
|
|
||||||
Snapshots: []string{"src"},
|
|
||||||
}))
|
|
||||||
|
|
||||||
summary := out.String()
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
"Files: 2 examined, 1 backed up, 0 unchanged, 1 failed.")
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
fmt.Sprintf("Data: %s total (%s backed up).",
|
|
||||||
v.UI.Size(storedSize), v.UI.Size(storedSize)))
|
|
||||||
|
|
||||||
snap, err := repos.Snapshots.GetByID(ctx,
|
|
||||||
localSnapshotID(ctx, t, repos, "src"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotNil(t, snap)
|
|
||||||
|
|
||||||
assert.Equal(t, int64(1), snap.FileCount)
|
|
||||||
assert.Equal(t, storedSize, snap.TotalSize)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// --skip-errors skips only a file that cannot be opened or read. A local
|
|
||||||
// index error while a directory is recorded stops the backup, and the
|
|
||||||
// snapshot is not recorded as complete. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/284.
|
|
||||||
func TestSkipErrorsBackupStopsOnIndexErrorRecordingDirectory(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
// The scan walks the source path with symlinks resolved, so dirPath
|
|
||||||
// must be spelled the same way to match the row the scan inserts.
|
|
||||||
tempDir, err := filepath.EvalSymlinks(t.TempDir())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
srcDir := filepath.Join(tempDir, "src")
|
|
||||||
dirPath := filepath.Join(srcDir, "dir")
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
require.NoError(t, fs.MkdirAll(dirPath, 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs,
|
|
||||||
filepath.Join(dirPath, "file.txt"), []byte("file content"), 0o644))
|
|
||||||
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
cfg.IndexPath = filepath.Join(tempDir, "index.sqlite")
|
|
||||||
cfg.Snapshots = map[string]config.SnapshotConfig{
|
|
||||||
"tree": {Paths: []string{srcDir}},
|
|
||||||
}
|
|
||||||
|
|
||||||
store, err := storage.NewFileStorer(filepath.Join(tempDir, "remote"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, cfg.IndexPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
// The local index refuses the directory's files row.
|
|
||||||
_, err = db.Conn().ExecContext(ctx, fmt.Sprintf(`
|
|
||||||
CREATE TRIGGER refuse_directory BEFORE INSERT ON files
|
|
||||||
WHEN NEW.path = '%s'
|
|
||||||
BEGIN SELECT RAISE(ABORT, 'simulated index error'); END`, dirPath))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
v := newBackupVaultik(ctx, cfg, store, repos, db, fs)
|
|
||||||
|
|
||||||
err = v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
SkipErrors: true,
|
|
||||||
Snapshots: []string{"tree"},
|
|
||||||
})
|
|
||||||
require.ErrorContains(t, err, "simulated index error")
|
|
||||||
|
|
||||||
snapshots, err := repos.Snapshots.ListRecent(ctx, listRecentTestLimit)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, snapshots, 1)
|
|
||||||
assert.Nil(t, snapshots[0].CompletedAt)
|
|
||||||
}
|
|
||||||
@@ -9,7 +9,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// errStorageBindingMismatch is returned when the local index database is
|
// errStorageBindingMismatch is returned when the local index database is
|
||||||
// bound to a different destination than the configured one.
|
// bound to a different destination than the configured storage_url.
|
||||||
var errStorageBindingMismatch = errors.New(
|
var errStorageBindingMismatch = errors.New(
|
||||||
"local index is bound to a different backup destination")
|
"local index is bound to a different backup destination")
|
||||||
|
|
||||||
@@ -24,9 +24,8 @@ var errStorageBindingMismatch = errors.New(
|
|||||||
//
|
//
|
||||||
// Behaviour:
|
// Behaviour:
|
||||||
// - On first use (empty stored value), record the configured
|
// - On first use (empty stored value), record the configured
|
||||||
// destination (storage_url, or the s3.* endpoint, bucket and
|
// storage_url and log the binding.
|
||||||
// prefix) and log the binding.
|
// - When the stored value matches the configured storage_url, do
|
||||||
// - When the stored value matches the configured destination, do
|
|
||||||
// nothing and return nil.
|
// nothing and return nil.
|
||||||
// - When the two differ, refuse with an error that tells the user
|
// - When the two differ, refuse with an error that tells the user
|
||||||
// how to recover (revert the config, or run `vaultik database
|
// how to recover (revert the config, or run `vaultik database
|
||||||
@@ -47,10 +46,12 @@ func (v *Vaultik) EnsureStorageBinding() error {
|
|||||||
|
|
||||||
configured := v.Config.StorageURL
|
configured := v.Config.StorageURL
|
||||||
if configured == "" {
|
if configured == "" {
|
||||||
// The s3.* form: bind on its endpoint, bucket and prefix,
|
// Some legacy configs still use the split s3.* keys instead of
|
||||||
// written the way storage_url would name the same destination.
|
// storage_url. Falling back to a synthetic URL for those would
|
||||||
s3 := v.Config.S3
|
// hide the fact that the binding is loose. Instead, treat
|
||||||
configured = "s3://" + s3.Bucket + "/" + s3.Prefix + "?endpoint=" + s3.Endpoint
|
// unset as "nothing to bind against" — the check is
|
||||||
|
// necessarily best-effort for those configs.
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
stored, err := v.Repositories.LocalMeta.Get(v.ctx, database.LocalMetaKeyStorageURL)
|
stored, err := v.Repositories.LocalMeta.Get(v.ctx, database.LocalMetaKeyStorageURL)
|
||||||
@@ -95,8 +96,7 @@ func buildBindingMismatchMessage(stored, configured string) string {
|
|||||||
"future snapshots referencing blobs that don't exist at the new destination.\n" +
|
"future snapshots referencing blobs that don't exist at the new destination.\n" +
|
||||||
"\n" +
|
"\n" +
|
||||||
"To proceed, either:\n" +
|
"To proceed, either:\n" +
|
||||||
" - revert storage_url (or the s3.* endpoint, bucket and prefix) in your\n" +
|
" - revert storage_url in your config to the bound destination, or\n" +
|
||||||
" config to the bound destination, or\n" +
|
|
||||||
" - run 'vaultik database delete' to discard the local index and rebuild it\n" +
|
" - run 'vaultik database delete' to discard the local index and rebuild it\n" +
|
||||||
" from a fresh full backup against the new destination"
|
" from a fresh full backup against the new destination"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -76,51 +76,3 @@ func TestEnsureStorageBinding_MismatchRefuses(t *testing.T) {
|
|||||||
assert.Contains(t, err.Error(), "file:///mnt/backups/new")
|
assert.Contains(t, err.Error(), "file:///mnt/backups/new")
|
||||||
assert.Contains(t, err.Error(), "vaultik database delete")
|
assert.Contains(t, err.Error(), "vaultik database delete")
|
||||||
}
|
}
|
||||||
|
|
||||||
// A config with no storage_url names its destination with s3.endpoint,
|
|
||||||
// s3.bucket and s3.prefix; a change to any of them must be refused just
|
|
||||||
// as a changed storage_url is.
|
|
||||||
func TestEnsureStorageBinding_S3FieldsChangeRefuses(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
bound := config.S3Config{
|
|
||||||
Endpoint: "https://s3.example.com",
|
|
||||||
Bucket: "bucket-a",
|
|
||||||
Prefix: "backups",
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
changed config.S3Config
|
|
||||||
}{
|
|
||||||
{"bucket", config.S3Config{
|
|
||||||
Endpoint: bound.Endpoint, Bucket: "bucket-b", Prefix: bound.Prefix,
|
|
||||||
}},
|
|
||||||
{"prefix", config.S3Config{
|
|
||||||
Endpoint: bound.Endpoint, Bucket: bound.Bucket, Prefix: "other",
|
|
||||||
}},
|
|
||||||
{"endpoint", config.S3Config{
|
|
||||||
Endpoint: "https://s3.other.com", Bucket: bound.Bucket, Prefix: bound.Prefix,
|
|
||||||
}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tv, _ := buildBindTestVaultik(t, "")
|
|
||||||
|
|
||||||
tv.Config.S3 = bound
|
|
||||||
require.NoError(t, tv.EnsureStorageBinding(), "first use binds")
|
|
||||||
require.NoError(t, tv.EnsureStorageBinding(), "same destination passes")
|
|
||||||
|
|
||||||
tv.Config.S3 = tt.changed
|
|
||||||
err := tv.EnsureStorageBinding()
|
|
||||||
require.Error(t, err)
|
|
||||||
assert.Contains(t, err.Error(),
|
|
||||||
"local index is bound to a different backup destination")
|
|
||||||
assert.Contains(t, err.Error(), "vaultik database delete")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user