Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ca98a6d5e1 |
@@ -349,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
|
||||||
@@ -400,8 +398,7 @@ key is skipped with a warning and is not printed. If a listed
|
|||||||
orphaned blob figures are reported as unknown; `--json` gives them as
|
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`.
|
||||||
snapshot's blob count and blob size unknown, `null` in `--json`.
|
|
||||||
* `--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
|
||||||
@@ -414,8 +411,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
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -22,68 +22,6 @@ the tag exists and is exercised; what is left is merging `next` to
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-13: Made an S3 listing that the server cuts short an error
|
|
||||||
([issue #297](https://git.eeqj.de/sneak/vaultik/issues/297)). A page
|
|
||||||
marked truncated with no continuation token, as a server answering V2
|
|
||||||
listings V1-style sends, ended the listing without an error, so
|
|
||||||
`prune` saw only the snapshots on the first page and could delete
|
|
||||||
blobs the rest still use. Such a page is now a listing error, and
|
|
||||||
`prune`, `snapshot list` and `remote nuke` handle it as a destination
|
|
||||||
that cannot be listed.
|
|
||||||
|
|
||||||
- 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
|
- 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
|
([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
|
that phase 1 counted and phase 2 could not open, because it was
|
||||||
@@ -93,15 +31,6 @@ the tag exists and is exercised; what is left is merging `next` to
|
|||||||
summary now counts it as failed, and its data total and the row leave
|
summary now counts it as failed, and its data total and the row leave
|
||||||
it out.
|
it out.
|
||||||
|
|
||||||
- 2026-10-08: Made `remote info` report a snapshot's blob count and
|
|
||||||
blob size as unknown when its manifest cannot be read
|
|
||||||
([issue #272](https://git.eeqj.de/sneak/vaultik/issues/272)). The
|
|
||||||
orphan figures were already unknown in that case, but the snapshot's
|
|
||||||
row still gave 0 blobs and 0 B, in the table and in `--json`. The row
|
|
||||||
now reads `unknown` and `--json` gives `null`. A directory with no
|
|
||||||
manifest still shows 0, since the orphan figures count its blobs as
|
|
||||||
orphaned.
|
|
||||||
|
|
||||||
- 2026-10-08: Kept the progress line of a snapshot with more than one
|
- 2026-10-08: Kept the progress line of a snapshot with more than one
|
||||||
path within 100%
|
path within 100%
|
||||||
([issue #271](https://git.eeqj.de/sneak/vaultik/issues/271)). The
|
([issue #271](https://git.eeqj.de/sneak/vaultik/issues/271)). The
|
||||||
|
|||||||
@@ -255,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
|
||||||
|
|||||||
+2
-29
@@ -18,13 +18,6 @@ import (
|
|||||||
"github.com/aws/smithy-go/logging"
|
"github.com/aws/smithy-go/logging"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrNoContinuationToken is returned by ListObjects and ListObjectsStream
|
|
||||||
// when the server marks a page of a listing truncated but sends no
|
|
||||||
// continuation token to fetch the rest with, as a server answering V2
|
|
||||||
// listings V1-style does.
|
|
||||||
var ErrNoContinuationToken = errors.New(
|
|
||||||
"server marked the listing truncated but sent no continuation token")
|
|
||||||
|
|
||||||
// Client wraps the AWS S3 client for vaultik operations.
|
// Client wraps the AWS S3 client for vaultik operations.
|
||||||
// It provides a simplified interface for S3 operations with automatic
|
// It provides a simplified interface for S3 operations with automatic
|
||||||
// prefix handling and connection management. All operations are performed
|
// prefix handling and connection management. All operations are performed
|
||||||
@@ -221,7 +214,7 @@ func (c *Client) ListObjects(ctx context.Context, prefix string) ([]string, erro
|
|||||||
})
|
})
|
||||||
|
|
||||||
for paginator.HasMorePages() {
|
for paginator.HasMorePages() {
|
||||||
page, err := nextListPage(ctx, paginator)
|
page, err := paginator.NextPage(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -242,26 +235,6 @@ func (c *Client) ListObjects(ctx context.Context, prefix string) ([]string, erro
|
|||||||
return keys, nil
|
return keys, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// nextListPage fetches the next page of a listing. The SDK paginator takes
|
|
||||||
// a page marked truncated without a continuation token for the last page
|
|
||||||
// and stops without an error, so such a page is ErrNoContinuationToken
|
|
||||||
// here instead.
|
|
||||||
func nextListPage(
|
|
||||||
ctx context.Context, paginator *s3.ListObjectsV2Paginator,
|
|
||||||
) (*s3.ListObjectsV2Output, error) {
|
|
||||||
page, err := paginator.NextPage(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
truncated := aws.ToBool(page.IsTruncated)
|
|
||||||
if truncated && aws.ToString(page.NextContinuationToken) == "" {
|
|
||||||
return nil, ErrNoContinuationToken
|
|
||||||
}
|
|
||||||
|
|
||||||
return page, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// HeadObject checks if an object exists in S3.
|
// HeadObject checks if an object exists in S3.
|
||||||
// Returns true if the object exists, false otherwise.
|
// Returns true if the object exists, false otherwise.
|
||||||
// The key is automatically prefixed with the configured prefix.
|
// The key is automatically prefixed with the configured prefix.
|
||||||
@@ -327,7 +300,7 @@ func (c *Client) ListObjectsStream(
|
|||||||
})
|
})
|
||||||
|
|
||||||
for paginator.HasMorePages() {
|
for paginator.HasMorePages() {
|
||||||
page, err := nextListPage(ctx, paginator)
|
page, err := paginator.NextPage(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
ch <- ObjectInfo{Err: err}
|
ch <- ObjectInfo{Err: err}
|
||||||
|
|
||||||
|
|||||||
@@ -1312,13 +1312,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)
|
||||||
@@ -1355,32 +1348,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
|
||||||
@@ -1418,7 +1392,12 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
|
|
||||||
// countFailedFile counts a file that phase 2 could not store as failed
|
// 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.
|
// and takes its size back out of BytesScanned, where phase 1 put it.
|
||||||
|
// Phase 1 counts no directories, so a directory is not counted here.
|
||||||
func countFailedFile(fileToProcess *FileToProcess, result *ScanResult) {
|
func countFailedFile(fileToProcess *FileToProcess, result *ScanResult) {
|
||||||
|
if fileToProcess.FileInfo.IsDir() {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
result.FilesFailed++
|
result.FilesFailed++
|
||||||
result.BytesScanned -= fileToProcess.FileInfo.Size()
|
result.BytesScanned -= fileToProcess.FileInfo.Size()
|
||||||
}
|
}
|
||||||
@@ -1791,11 +1770,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))
|
||||||
|
|||||||
@@ -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,56 +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())
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -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{
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"slices"
|
"slices"
|
||||||
@@ -23,16 +22,13 @@ import (
|
|||||||
// s3TestBucket is the bucket created for each in-process S3 server.
|
// s3TestBucket is the bucket created for each in-process S3 server.
|
||||||
const s3TestBucket = "test-bucket"
|
const s3TestBucket = "test-bucket"
|
||||||
|
|
||||||
// Credentials for the tests' S3 clients. The test servers accept any.
|
// Credentials for the tests that build a storer from a config.Config. The
|
||||||
|
// in-process S3 server accepts any.
|
||||||
const (
|
const (
|
||||||
s3TestAccessKeyID = "key"
|
s3TestAccessKeyID = "key"
|
||||||
s3TestSecretAccessKey = "secret"
|
s3TestSecretAccessKey = "secret"
|
||||||
)
|
)
|
||||||
|
|
||||||
// s3TestRegion is the region of the S3 clients built here with
|
|
||||||
// s3.NewClient. The test servers ignore it.
|
|
||||||
const s3TestRegion = "us-east-1"
|
|
||||||
|
|
||||||
// newS3Storer builds an s3:// backend backed by a fresh in-process
|
// newS3Storer builds an s3:// backend backed by a fresh in-process
|
||||||
// S3 server. It reuses the same in-memory S3 harness (gofakes3 + s3mem
|
// S3 server. It reuses the same in-memory S3 harness (gofakes3 + s3mem
|
||||||
// over httptest) that internal/s3 and the not-found regression test use,
|
// over httptest) that internal/s3 and the not-found regression test use,
|
||||||
@@ -59,7 +55,7 @@ func newS3Storer(t *testing.T) storage.Storer {
|
|||||||
Bucket: s3TestBucket,
|
Bucket: s3TestBucket,
|
||||||
AccessKeyID: "test",
|
AccessKeyID: "test",
|
||||||
SecretAccessKey: "test",
|
SecretAccessKey: "test",
|
||||||
Region: s3TestRegion,
|
Region: "us-east-1",
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("new client: %v", err)
|
t.Fatalf("new client: %v", err)
|
||||||
@@ -97,68 +93,6 @@ func TestS3StorerMissingKeyMapsToErrNotFound(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestS3ListingCutShortIsAnError checks that List and ListStream fail on a
|
|
||||||
// listing page marked truncated that carries no continuation token, as a
|
|
||||||
// server answering V2 listings V1-style sends it. Taken as the last page,
|
|
||||||
// it would hide every later key, and prune would treat the blobs of the
|
|
||||||
// snapshots listed there as unreferenced.
|
|
||||||
func TestS3ListingCutShortIsAnError(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
prefix = "metadata/"
|
|
||||||
truncatedPage = `<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
|
|
||||||
<Name>test-bucket</Name>
|
|
||||||
<Prefix>metadata/</Prefix>
|
|
||||||
<KeyCount>1</KeyCount>
|
|
||||||
<MaxKeys>1</MaxKeys>
|
|
||||||
<IsTruncated>true</IsTruncated>
|
|
||||||
<Contents>
|
|
||||||
<Key>metadata/snap/manifest.json.zst</Key>
|
|
||||||
<Size>8</Size>
|
|
||||||
</Contents>
|
|
||||||
</ListBucketResult>`
|
|
||||||
)
|
|
||||||
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
_, _ = io.WriteString(w, truncatedPage)
|
|
||||||
}))
|
|
||||||
t.Cleanup(srv.Close)
|
|
||||||
|
|
||||||
client, err := s3.NewClient(context.Background(), s3.Config{
|
|
||||||
Endpoint: srv.URL,
|
|
||||||
Bucket: s3TestBucket,
|
|
||||||
AccessKeyID: s3TestAccessKeyID,
|
|
||||||
SecretAccessKey: s3TestSecretAccessKey,
|
|
||||||
Region: s3TestRegion,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new client: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
storer := storage.NewS3Storer(client)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
keys, err := storer.List(ctx, prefix)
|
|
||||||
if !errors.Is(err, s3.ErrNoContinuationToken) {
|
|
||||||
t.Errorf("List = %q, %v; want ErrNoContinuationToken", keys, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var streamErr error
|
|
||||||
|
|
||||||
for obj := range storer.ListStream(ctx, prefix) {
|
|
||||||
if obj.Err != nil {
|
|
||||||
streamErr = obj.Err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !errors.Is(streamErr, s3.ErrNoContinuationToken) {
|
|
||||||
t.Errorf("ListStream error = %v, want ErrNoContinuationToken", streamErr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestS3URLPrefixKeyLayout pins the bucket keys an s3:// URL reads and
|
// TestS3URLPrefixKeyLayout pins the bucket keys an s3:// URL reads and
|
||||||
// writes: the README's remote storage layout, with the prefix joined to
|
// writes: the README's remote storage layout, with the prefix joined to
|
||||||
// each key by one "/". s3://b/p and s3://b/p/ must be the same
|
// each key by one "/". s3://b/p and s3://b/p/ must be the same
|
||||||
|
|||||||
@@ -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
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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{}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 {
|
||||||
|
|||||||
@@ -181,11 +181,8 @@ type SnapshotMetadataInfo struct {
|
|||||||
ManifestSize int64 `json:"manifest_size"`
|
ManifestSize int64 `json:"manifest_size"`
|
||||||
DatabaseSize int64 `json:"database_size"`
|
DatabaseSize int64 `json:"database_size"`
|
||||||
TotalSize int64 `json:"total_size"`
|
TotalSize int64 `json:"total_size"`
|
||||||
|
BlobCount int `json:"blob_count"`
|
||||||
// Both stay nil (null in the JSON) when the snapshot's manifest was
|
BlobsSize int64 `json:"blobs_size"`
|
||||||
// listed but could not be read.
|
|
||||||
BlobCount *int `json:"blob_count"`
|
|
||||||
BlobsSize *int64 `json:"blobs_size"`
|
|
||||||
|
|
||||||
// Set when the listing holds this snapshot's manifest.json.zst. A
|
// Set when the listing holds this snapshot's manifest.json.zst. A
|
||||||
// backup interrupted before its manifest upload leaves a directory
|
// backup interrupted before its manifest upload leaves a directory
|
||||||
@@ -383,10 +380,6 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
for _, snapshotID := range snapshotIDs {
|
for _, snapshotID := range snapshotIDs {
|
||||||
info := snapshotMetadata[snapshotID]
|
info := snapshotMetadata[snapshotID]
|
||||||
if !info.hasManifest {
|
if !info.hasManifest {
|
||||||
// The orphan figures count this directory's blobs as
|
|
||||||
// orphaned, so it references none.
|
|
||||||
info.BlobCount, info.BlobsSize = new(int), new(int64)
|
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -402,7 +395,7 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
blobCount := manifest.BlobCount
|
info.BlobCount = manifest.BlobCount
|
||||||
|
|
||||||
var blobsSize int64
|
var blobsSize int64
|
||||||
|
|
||||||
@@ -411,8 +404,7 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
blobsSize += blob.CompressedSize
|
blobsSize += blob.CompressedSize
|
||||||
}
|
}
|
||||||
|
|
||||||
info.BlobCount = &blobCount
|
info.BlobsSize = blobsSize
|
||||||
info.BlobsSize = &blobsSize
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return referencedBlobs, unreadable
|
return referencedBlobs, unreadable
|
||||||
@@ -524,23 +516,13 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
v.stdoutf("%s", separator)
|
v.stdoutf("%s", separator)
|
||||||
|
|
||||||
for _, info := range result.Snapshots {
|
for _, info := range result.Snapshots {
|
||||||
blobCount := unknownText
|
|
||||||
if info.BlobCount != nil {
|
|
||||||
blobCount = humanize.Comma(int64(*info.BlobCount))
|
|
||||||
}
|
|
||||||
|
|
||||||
blobsSize := unknownText
|
|
||||||
if info.BlobsSize != nil {
|
|
||||||
blobsSize = ubytes(*info.BlobsSize)
|
|
||||||
}
|
|
||||||
|
|
||||||
v.stdoutf(rowFormat,
|
v.stdoutf(rowFormat,
|
||||||
truncateString(info.SnapshotID, snapshotIDColWidth),
|
truncateString(info.SnapshotID, snapshotIDColWidth),
|
||||||
ubytes(info.ManifestSize),
|
ubytes(info.ManifestSize),
|
||||||
ubytes(info.DatabaseSize),
|
ubytes(info.DatabaseSize),
|
||||||
ubytes(info.TotalSize),
|
ubytes(info.TotalSize),
|
||||||
blobCount,
|
humanize.Comma(int64(info.BlobCount)),
|
||||||
blobsSize,
|
ubytes(info.BlobsSize),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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)
|
|
||||||
}
|
|
||||||
@@ -24,9 +24,8 @@ var errNukeRequiresForce = errors.New(
|
|||||||
const metadataDirName = "metadata"
|
const metadataDirName = "metadata"
|
||||||
|
|
||||||
// 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.
|
||||||
@@ -49,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
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ func TestTableCountForReportSurfacesReadFailure(t *testing.T) {
|
|||||||
assert.Nil(t, missing, "a failed read is unknown, not a count")
|
assert.Nil(t, missing, "a failed read is unknown, not a count")
|
||||||
|
|
||||||
// The rendered count for a failed read must say unknown, never 0.
|
// The rendered count for a failed read must say unknown, never 0.
|
||||||
assert.Equal(t, unknownText, countText(missing))
|
assert.Equal(t, countUnknown, countText(missing))
|
||||||
assert.NotEqual(t, "0", countText(missing))
|
assert.NotEqual(t, "0", countText(missing))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ func TestCountTextDistinguishesEmptyFromUnknown(t *testing.T) {
|
|||||||
|
|
||||||
assert.Equal(t, "0", countText(&zero))
|
assert.Equal(t, "0", countText(&zero))
|
||||||
assert.Equal(t, "7", countText(&seven))
|
assert.Equal(t, "7", countText(&seven))
|
||||||
assert.Equal(t, unknownText, countText(nil))
|
assert.Equal(t, countUnknown, countText(nil))
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestCountDiffUnknownWhenEitherSideUnknown checks that a delta computed
|
// TestCountDiffUnknownWhenEitherSideUnknown checks that a delta computed
|
||||||
|
|||||||
@@ -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()
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -70,74 +69,6 @@ func TestRemoteInfo_UnreadableManifestLeavesOrphansUnknown(t *testing.T) {
|
|||||||
assert.Equal(t, []any{unreadableKey}, doc["unreadable_manifests"])
|
assert.Equal(t, []any{unreadableKey}, doc["unreadable_manifests"])
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRemoteInfo_UnreadableManifestLeavesSnapshotBlobsUnknown checks
|
|
||||||
// that the row of a snapshot whose manifest cannot be read gives its
|
|
||||||
// blob count and blob size as unknown in the table and as null in
|
|
||||||
// --json, not as 0. A directory without a manifest still shows 0: the
|
|
||||||
// orphan figures count its blobs as orphaned, so it references none.
|
|
||||||
func TestRemoteInfo_UnreadableManifestLeavesSnapshotBlobsUnknown(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newListEnv(t)
|
|
||||||
readableKey := env.addRemote(t, listRemoteID,
|
|
||||||
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
|
||||||
|
|
||||||
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
|
||||||
"metadata/"+unreadableKey+"/manifest.json.zst",
|
|
||||||
bytes.NewReader([]byte("not a valid manifest"))))
|
|
||||||
|
|
||||||
noManifestKey := snapshot.RemoteSnapshotKey("testhost_home_2026-03-03T10:00:00Z")
|
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
|
||||||
"metadata/"+noManifestKey+"/db.zst.age",
|
|
||||||
bytes.NewReader([]byte("not a valid database"))))
|
|
||||||
|
|
||||||
require.NoError(t, env.v.RemoteInfo(false))
|
|
||||||
|
|
||||||
// The table truncates the remote key, so a row is found by a prefix.
|
|
||||||
wantUnknown := map[string]int{readableKey: 0, unreadableKey: 2, noManifestKey: 0}
|
|
||||||
for key, want := range wantUnknown {
|
|
||||||
var row string
|
|
||||||
|
|
||||||
for line := range strings.SplitSeq(env.stdout.String(), "\n") {
|
|
||||||
if strings.HasPrefix(line, key[:16]) {
|
|
||||||
row = line
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NotEmpty(t, row, "no table row for %s", key)
|
|
||||||
assert.Equal(t, want, strings.Count(row, "unknown"), "row: %q", row)
|
|
||||||
}
|
|
||||||
|
|
||||||
env.stdout.Reset()
|
|
||||||
require.NoError(t, env.v.RemoteInfo(true))
|
|
||||||
|
|
||||||
var doc struct {
|
|
||||||
Snapshots []map[string]any `json:"snapshots"`
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
|
||||||
require.Len(t, doc.Snapshots, len(wantUnknown))
|
|
||||||
|
|
||||||
for _, entry := range doc.Snapshots {
|
|
||||||
switch entry["snapshot_id"] {
|
|
||||||
case readableKey:
|
|
||||||
assert.InDelta(t, 1, entry["blob_count"], 0)
|
|
||||||
assert.InDelta(t, fiveMegabytes, entry["blobs_size"], 0)
|
|
||||||
case noManifestKey:
|
|
||||||
assert.InDelta(t, 0, entry["blob_count"], 0)
|
|
||||||
assert.InDelta(t, 0, entry["blobs_size"], 0)
|
|
||||||
default:
|
|
||||||
assert.Equal(t, unreadableKey, entry["snapshot_id"])
|
|
||||||
assert.Contains(t, entry, "blob_count")
|
|
||||||
assert.Nil(t, entry["blob_count"])
|
|
||||||
assert.Contains(t, entry, "blobs_size")
|
|
||||||
assert.Nil(t, entry["blobs_size"])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRemoteInfo_SkipsNonConformingMetadataName checks that a directory
|
// TestRemoteInfo_SkipsNonConformingMetadataName checks that a directory
|
||||||
// under metadata/ whose name is not a remote key is left out of the
|
// under metadata/ whose name is not a remote key is left out of the
|
||||||
// report, and that the orphan figures are unknown when it holds a
|
// report, and that the orphan figures are unknown when it holds a
|
||||||
|
|||||||
@@ -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()
|
||||||
|
|||||||
@@ -23,7 +23,6 @@ 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 " +
|
||||||
@@ -644,7 +643,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)
|
||||||
}
|
}
|
||||||
@@ -1154,11 +1153,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)
|
||||||
}
|
}
|
||||||
@@ -1167,13 +1161,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 {
|
||||||
@@ -1192,11 +1184,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 "+
|
||||||
@@ -1206,45 +1196,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(
|
||||||
@@ -1304,14 +1255,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 "+
|
||||||
@@ -1329,7 +1280,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
|
||||||
@@ -1621,7 +1572,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",
|
||||||
@@ -1647,7 +1598,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)
|
||||||
@@ -1694,44 +1645,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
|
||||||
@@ -1825,9 +1766,9 @@ func (v *Vaultik) PruneDatabase() (*PruneResult, error) {
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// unknownText is what a count or size reads as when it could not be
|
// countUnknown is what a count reads as when its query could not be run,
|
||||||
// determined, distinct from "0", which is a real zero.
|
// distinct from "0", which means the table really was empty.
|
||||||
const unknownText = "unknown"
|
const countUnknown = "unknown"
|
||||||
|
|
||||||
// tableCountForReport returns the row count of a table for the prune
|
// tableCountForReport returns the row count of a table for the prune
|
||||||
// summary, or nil if the count could not be read. A read failure is
|
// summary, or nil if the count could not be read. A read failure is
|
||||||
@@ -1864,7 +1805,7 @@ func countDiff(before, after *int64) *int64 {
|
|||||||
// one that could not be queried.
|
// one that could not be queried.
|
||||||
func countText(count *int64) string {
|
func countText(count *int64) string {
|
||||||
if count == nil {
|
if count == nil {
|
||||||
return unknownText
|
return countUnknown
|
||||||
}
|
}
|
||||||
|
|
||||||
return strconv.FormatInt(*count, 10)
|
return strconv.FormatInt(*count, 10)
|
||||||
|
|||||||
@@ -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