Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d71be0b4c8 | ||
|
|
4605eae024 | ||
|
|
5b09271751 | ||
|
|
9fedcbeb0a |
No files matched your search
@@ -602,7 +602,11 @@ only `vaultik-destination.txt` stops such a backup, and only while the local
|
|||||||
index holds snapshots.
|
index holds snapshots.
|
||||||
|
|
||||||
**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`). The
|
||||||
|
path after the remote name is relative: rclone resolves it on the remote, for
|
||||||
|
example against the login directory on sftp. A second slash makes it absolute,
|
||||||
|
as in `rclone://remote//srv/backup`. A remote of type `local` needs an absolute
|
||||||
|
path; a relative one is refused.
|
||||||
|
|
||||||
An upload cut off part-way leaves nothing under the object's name on S3, which
|
An upload cut off part-way leaves nothing under the object's name on S3, which
|
||||||
shows an object only once its upload has completed, and on the local filesystem
|
shows an object only once its upload has completed, and on the local filesystem
|
||||||
@@ -614,6 +618,10 @@ being written, a killed upload can leave a truncated object under its name,
|
|||||||
which a later backup takes for complete. A leftover `.partial` file is ignored
|
which a later backup takes for complete. A leftover `.partial` file is ignored
|
||||||
and can be deleted.
|
and can be deleted.
|
||||||
|
|
||||||
|
A blob upload that fails, such as one cut off by a lost connection, is tried
|
||||||
|
again up to five times, three seconds apart. Each new try is announced with a
|
||||||
|
warning. If the last try fails too, the backup stops with the upload's error.
|
||||||
|
|
||||||
A destination shared between hosts or users, each with its own local index,
|
A destination shared between hosts or users, each with its own local index,
|
||||||
relies on `prune_grace_period` to keep one's prune from deleting the blobs of
|
relies on `prune_grace_period` to keep one's prune from deleting the blobs of
|
||||||
another's backup still running, or its directory under `metadata/` that has no
|
another's backup still running, or its directory under `metadata/` that has no
|
||||||
|
|||||||
@@ -0,0 +1,154 @@
|
|||||||
|
//nolint:testpackage // exercises the unexported uploadBlobIfNeeded
|
||||||
|
package snapshot
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/blob"
|
||||||
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage/faultstore"
|
||||||
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
)
|
||||||
|
|
||||||
|
// retryTestBlobSize is larger than what a failing faultstore Put reads,
|
||||||
|
// so a new try that did not rewind the blob would store a short object.
|
||||||
|
const retryTestBlobSize = 4096
|
||||||
|
|
||||||
|
// retryTestBlobKey is where the retry tests upload their blob.
|
||||||
|
const retryTestBlobKey = "blobs/retry"
|
||||||
|
|
||||||
|
// uploadRetryTestBlob uploads a retryTestBlobSize blob through store,
|
||||||
|
// waiting delay between tries, and returns the blob's bytes, the warnings
|
||||||
|
// the upload printed and its error.
|
||||||
|
func uploadRetryTestBlob(
|
||||||
|
ctx context.Context, store storage.Storer, delay time.Duration,
|
||||||
|
) ([]byte, int, error) {
|
||||||
|
data := bytes.Repeat([]byte("0123456789abcdef"), retryTestBlobSize/16)
|
||||||
|
output := ui.NewWithColor(io.Discard, false)
|
||||||
|
s := &Scanner{storage: store, ui: output, blobUploadRetryDelay: delay}
|
||||||
|
|
||||||
|
_, _, err := s.uploadBlobIfNeeded(ctx, retryTestBlobKey, &blob.WithReader{
|
||||||
|
FinishedBlob: &blob.FinishedBlob{
|
||||||
|
Hash: "retry",
|
||||||
|
Compressed: int64(len(data)),
|
||||||
|
},
|
||||||
|
Reader: bytes.NewReader(data),
|
||||||
|
}, time.Now(), &ScanResult{})
|
||||||
|
|
||||||
|
return data, output.WarningCount(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// A blob upload that fails is tried again from the start of the blob,
|
||||||
|
// and each failure is a warning. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/476.
|
||||||
|
func TestFailedBlobUploadIsTriedAgain(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
inner, err := storage.NewFileStorer(t.TempDir())
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
puts := 0
|
||||||
|
store := faultstore.New(inner)
|
||||||
|
store.OnPut = func(string) faultstore.PutAction {
|
||||||
|
puts++
|
||||||
|
if puts <= 2 {
|
||||||
|
return faultstore.PutFail
|
||||||
|
}
|
||||||
|
|
||||||
|
return faultstore.PutNormal
|
||||||
|
}
|
||||||
|
|
||||||
|
data, warnings, err := uploadRetryTestBlob(context.Background(), store, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, 3, puts)
|
||||||
|
require.Equal(t, 2, warnings)
|
||||||
|
|
||||||
|
rc, err := inner.Get(context.Background(), retryTestBlobKey)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
defer func() { _ = rc.Close() }()
|
||||||
|
|
||||||
|
stored, err := io.ReadAll(rc)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, data, stored)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A blob upload that keeps failing is tried blobUploadRetries more times,
|
||||||
|
// BlobUploadRetryDelay apart, and then the backup stops with its error.
|
||||||
|
func TestBlobUploadStopsAfterRetries(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
inner, err := storage.NewFileStorer(t.TempDir())
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
puts := 0
|
||||||
|
store := faultstore.New(inner)
|
||||||
|
store.OnPut = func(string) faultstore.PutAction {
|
||||||
|
puts++
|
||||||
|
|
||||||
|
return faultstore.PutFail
|
||||||
|
}
|
||||||
|
|
||||||
|
const delay = 10 * time.Millisecond
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
_, warnings, err := uploadRetryTestBlob(context.Background(), store, delay)
|
||||||
|
|
||||||
|
require.ErrorIs(t, err, faultstore.ErrInjectedUpload)
|
||||||
|
require.Equal(t, 1+blobUploadRetries, puts)
|
||||||
|
require.Equal(t, blobUploadRetries, warnings)
|
||||||
|
require.GreaterOrEqual(t, time.Since(start), blobUploadRetries*delay)
|
||||||
|
}
|
||||||
|
|
||||||
|
// An upload stopped by Ctrl-C or SIGTERM is not tried again.
|
||||||
|
func TestInterruptedBlobUploadIsNotTriedAgain(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
inner, err := storage.NewFileStorer(t.TempDir())
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
t.Cleanup(cancel)
|
||||||
|
|
||||||
|
puts := 0
|
||||||
|
store := faultstore.New(inner)
|
||||||
|
store.OnPut = func(string) faultstore.PutAction {
|
||||||
|
puts++
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
return faultstore.PutFail
|
||||||
|
}
|
||||||
|
|
||||||
|
_, warnings, err := uploadRetryTestBlob(ctx, store, 0)
|
||||||
|
|
||||||
|
require.Error(t, err)
|
||||||
|
require.Equal(t, 1, puts)
|
||||||
|
require.Zero(t, warnings)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Backups wait BlobUploadRetryDelay before each new try.
|
||||||
|
func TestBackupScannerWaitsBetweenBlobUploadRetries(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := &config.Config{
|
||||||
|
AgeRecipients: []string{testAgeRecipient},
|
||||||
|
ChunkSize: config.Size(1024 * 1024),
|
||||||
|
BlobSizeLimit: config.Size(4 * 1024 * 1024),
|
||||||
|
IndexPath: filepath.Join(t.TempDir(), "index.sqlite"),
|
||||||
|
}
|
||||||
|
|
||||||
|
scanner := provideScannerFactory(cfg, nil, nil)(ScannerParams{
|
||||||
|
Fs: afero.NewMemMapFs(),
|
||||||
|
})
|
||||||
|
require.NotNil(t, scanner)
|
||||||
|
require.Equal(t, BlobUploadRetryDelay, scanner.blobUploadRetryDelay)
|
||||||
|
}
|
||||||
@@ -4,8 +4,10 @@ package snapshot
|
|||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@@ -38,3 +40,36 @@ func TestDeviceNumberFromStat(t *testing.T) {
|
|||||||
// /dev is a different filesystem from the temp dir on Linux, macOS and in Docker.
|
// /dev is a different filesystem from the temp dir on Linux, macOS and in Docker.
|
||||||
assert.NotEqual(t, deviceOf(dir), deviceOf("/dev"))
|
assert.NotEqual(t, deviceOf(dir), deviceOf("/dev"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// fileInfoWithStat is a file's info whose Sys returns stat.
|
||||||
|
type fileInfoWithStat struct {
|
||||||
|
os.FileInfo
|
||||||
|
|
||||||
|
stat *syscall.Stat_t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i fileInfoWithStat) Sys() any { return i.stat }
|
||||||
|
|
||||||
|
// The in-memory test filesystem has no device numbers. The pinned afero
|
||||||
|
// gives no stat; its unreleased master gives a stat holding only uid, gid
|
||||||
|
// and size. See https://git.eeqj.de/sneak/vaultik/issues/462.
|
||||||
|
func TestDeviceNumberFromStatInMemory(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
require.NoError(t, afero.WriteFile(fs, "/file.txt", []byte("data"), 0o600))
|
||||||
|
|
||||||
|
info, err := fs.Stat("/file.txt")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, ok := deviceNumberFromStat(info)
|
||||||
|
assert.False(t, ok, "device number read from a file info with no stat")
|
||||||
|
|
||||||
|
zeroed := fileInfoWithStat{
|
||||||
|
FileInfo: info,
|
||||||
|
stat: &syscall.Stat_t{Uid: 1000, Gid: 1000, Size: 4},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, ok = deviceNumberFromStat(zeroed)
|
||||||
|
assert.False(t, ok, "device number read from a stat with no device or inode number")
|
||||||
|
}
|
||||||
+15
-14
@@ -54,20 +54,21 @@ 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,
|
||||||
IndexAndLockFiles: indexAndLockFiles(cfg.IndexPath, pidlock.Dir()),
|
IndexAndLockFiles: indexAndLockFiles(cfg.IndexPath, pidlock.Dir()),
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
PreviousSnapshotID: params.PreviousSnapshotID,
|
||||||
DeviceNumber: params.DeviceNumber,
|
BlobUploadRetryDelay: BlobUploadRetryDelay,
|
||||||
|
DeviceNumber: params.DeviceNumber,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -75,6 +75,8 @@ type Scanner struct {
|
|||||||
// skipErrors skips files that cannot be opened or read (logged loudly);
|
// skipErrors skips files that cannot be opened or read (logged loudly);
|
||||||
// packer, database, encryption, and upload errors still abort the run.
|
// packer, database, encryption, and upload errors still abort the run.
|
||||||
skipErrors bool
|
skipErrors bool
|
||||||
|
// blobUploadRetryDelay is ScannerConfig.BlobUploadRetryDelay.
|
||||||
|
blobUploadRetryDelay time.Duration
|
||||||
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
||||||
ui *ui.Writer
|
ui *ui.Writer
|
||||||
// deviceNumber returns the number of the device that holds a file;
|
// deviceNumber returns the number of the device that holds a file;
|
||||||
@@ -123,8 +125,16 @@ const (
|
|||||||
// snapshotAssocBatchSize is how many file IDs are associated with the
|
// snapshotAssocBatchSize is how many file IDs are associated with the
|
||||||
// snapshot per transaction.
|
// snapshot per transaction.
|
||||||
snapshotAssocBatchSize = 1000
|
snapshotAssocBatchSize = 1000
|
||||||
|
|
||||||
|
// blobUploadRetries is how many more times a failed blob upload is
|
||||||
|
// tried before the backup stops with the error.
|
||||||
|
blobUploadRetries = 5
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// BlobUploadRetryDelay is the wait before each new try of a failed blob
|
||||||
|
// upload.
|
||||||
|
const BlobUploadRetryDelay = 3 * time.Second
|
||||||
|
|
||||||
// ScannerConfig contains configuration for the scanner
|
// ScannerConfig contains configuration for the scanner
|
||||||
type ScannerConfig struct {
|
type ScannerConfig struct {
|
||||||
FS afero.Fs
|
FS afero.Fs
|
||||||
@@ -148,6 +158,10 @@ type ScannerConfig struct {
|
|||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
// PreviousSnapshotID is the most recent completed snapshot of the
|
||||||
// same name, "" for none.
|
// same name, "" for none.
|
||||||
PreviousSnapshotID string
|
PreviousSnapshotID string
|
||||||
|
// BlobUploadRetryDelay is the wait before each new try of a failed
|
||||||
|
// blob upload. Backups use snapshot.BlobUploadRetryDelay; tests leave
|
||||||
|
// it zero to try again at once.
|
||||||
|
BlobUploadRetryDelay time.Duration
|
||||||
// DeviceNumber returns the number of the device that holds a file,
|
// DeviceNumber returns the number of the device that holds a file,
|
||||||
// and false when there is none to read. nil reads it from the file's
|
// and false when there is none to read. nil reads it from the file's
|
||||||
// stat; tests replace it, since the in-memory test filesystem has none.
|
// stat; tests replace it, since the in-memory test filesystem has none.
|
||||||
@@ -245,23 +259,24 @@ func NewScanner(cfg ScannerConfig) *Scanner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return &Scanner{
|
return &Scanner{
|
||||||
fs: cfg.FS,
|
fs: cfg.FS,
|
||||||
chunker: chunker.NewChunker(cfg.ChunkSize),
|
chunker: chunker.NewChunker(cfg.ChunkSize),
|
||||||
packer: packer,
|
packer: packer,
|
||||||
repos: cfg.Repositories,
|
repos: cfg.Repositories,
|
||||||
storage: cfg.Storage,
|
storage: cfg.Storage,
|
||||||
maxBlobSize: cfg.MaxBlobSize,
|
maxBlobSize: cfg.MaxBlobSize,
|
||||||
compressionLevel: cfg.CompressionLevel,
|
compressionLevel: cfg.CompressionLevel,
|
||||||
ageRecipient: strings.Join(cfg.AgeRecipients, ","),
|
ageRecipient: strings.Join(cfg.AgeRecipients, ","),
|
||||||
exclude: cfg.Exclude,
|
exclude: cfg.Exclude,
|
||||||
compiledExclude: compiledExclude,
|
compiledExclude: compiledExclude,
|
||||||
indexAndLockFiles: indexAndLockFiles,
|
indexAndLockFiles: indexAndLockFiles,
|
||||||
progress: progress,
|
progress: progress,
|
||||||
skipErrors: cfg.SkipErrors,
|
skipErrors: cfg.SkipErrors,
|
||||||
previousSnapshotID: cfg.PreviousSnapshotID,
|
previousSnapshotID: cfg.PreviousSnapshotID,
|
||||||
ui: uiw,
|
blobUploadRetryDelay: cfg.BlobUploadRetryDelay,
|
||||||
deviceNumber: deviceNumber,
|
ui: uiw,
|
||||||
pendingChunkHashes: make(map[string]struct{}),
|
deviceNumber: deviceNumber,
|
||||||
|
pendingChunkHashes: make(map[string]struct{}),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1438,11 +1453,12 @@ func (s *Scanner) deviceNumberAt(path string) (uint64, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// deviceNumberFromStat returns the number of the device that holds the
|
// deviceNumberFromStat returns the number of the device that holds the
|
||||||
// file info describes, and false when info carries no stat, as from the
|
// file info describes, and false when info carries no stat from a real
|
||||||
// in-memory test filesystem.
|
// filesystem. The in-memory test filesystem gives either no stat or one
|
||||||
|
// whose device and inode numbers are both zero, which no real file has.
|
||||||
func deviceNumberFromStat(info os.FileInfo) (uint64, bool) {
|
func deviceNumberFromStat(info os.FileInfo) (uint64, bool) {
|
||||||
stat, ok := info.Sys().(*syscall.Stat_t)
|
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||||
if !ok {
|
if !ok || (stat.Dev == 0 && stat.Ino == 0) {
|
||||||
return 0, false
|
return 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1875,10 +1891,7 @@ func (s *Scanner) uploadBlobIfNeeded(
|
|||||||
s.ui.Hex(finishedBlob.Hash), s.ui.Size(finishedBlob.Compressed),
|
s.ui.Hex(finishedBlob.Hash), s.ui.Size(finishedBlob.Compressed),
|
||||||
s.ui.Path(destination))
|
s.ui.Path(destination))
|
||||||
|
|
||||||
progressCallback := s.makeUploadProgressCallback(ctx, finishedBlob, startTime)
|
err = s.putBlob(ctx, blobPath, blobWithReader)
|
||||||
|
|
||||||
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
|
||||||
finishedBlob.Compressed, progressCallback)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// The record is at info level: the returned error ends the backup
|
// The record is at info level: the returned error ends the backup
|
||||||
// and is printed as its ERROR: line. Only an interrupt cancels
|
// and is printed as its ERROR: line. Only an interrupt cancels
|
||||||
@@ -1922,6 +1935,44 @@ func (s *Scanner) uploadBlobIfNeeded(
|
|||||||
return finishedBlob.Compressed, false, nil
|
return finishedBlob.Compressed, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// putBlob uploads the blob to blobPath. After a failed upload it waits
|
||||||
|
// s.blobUploadRetryDelay and uploads the whole blob again, up to
|
||||||
|
// blobUploadRetries times, and then returns the last error. An interrupt
|
||||||
|
// stops it at once.
|
||||||
|
func (s *Scanner) putBlob(
|
||||||
|
ctx context.Context, blobPath string, blobWithReader *blob.WithReader,
|
||||||
|
) error {
|
||||||
|
finishedBlob := blobWithReader.FinishedBlob
|
||||||
|
|
||||||
|
for retries := 0; ; retries++ {
|
||||||
|
_, err := blobWithReader.Reader.Seek(0, io.SeekStart)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("rewinding blob for upload: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
progressCallback := s.makeUploadProgressCallback(
|
||||||
|
ctx, finishedBlob, time.Now().UTC())
|
||||||
|
|
||||||
|
err = s.storage.PutWithProgress(ctx, blobPath, blobWithReader.Reader,
|
||||||
|
finishedBlob.Compressed, progressCallback)
|
||||||
|
if err == nil || ctx.Err() != nil || retries == blobUploadRetries {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Info("Blob upload failed, trying again",
|
||||||
|
"hash", finishedBlob.Hash, "retry", retries+1, "error", err)
|
||||||
|
s.ui.Warningf("Upload of blob %s failed: %v. Trying again in %s (retry %d of %d).",
|
||||||
|
s.ui.Hex(finishedBlob.Hash), err,
|
||||||
|
s.ui.Duration(s.blobUploadRetryDelay), retries+1, blobUploadRetries)
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return err
|
||||||
|
case <-time.After(s.blobUploadRetryDelay):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// makeUploadProgressCallback creates a progress callback for blob uploads.
|
// makeUploadProgressCallback creates a progress callback for blob uploads.
|
||||||
// It updates the live progress reporter ~twice/sec for ETAs and prints a
|
// It updates the live progress reporter ~twice/sec for ETAs and prints a
|
||||||
// human-readable status line to s.output at most every 15 seconds.
|
// human-readable status line to s.output at most every 15 seconds.
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -23,6 +24,15 @@ import (
|
|||||||
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
||||||
var ErrRemoteNotFound = errors.New("rclone remote not found in config")
|
var ErrRemoteNotFound = errors.New("rclone remote not found in config")
|
||||||
|
|
||||||
|
// ErrRcloneRelativeLocalPath is returned when the path on an rclone remote
|
||||||
|
// of type local is relative. rclone would resolve it against the working
|
||||||
|
// directory, so the destination would move with it.
|
||||||
|
var ErrRcloneRelativeLocalPath = errors.New(
|
||||||
|
"the path on an rclone remote of type local must be absolute")
|
||||||
|
|
||||||
|
// rcloneLocalBackend is the type of rclone's local disk backend.
|
||||||
|
const rcloneLocalBackend = "local"
|
||||||
|
|
||||||
// RcloneStorer implements Storer using rclone's filesystem abstraction.
|
// RcloneStorer implements Storer using rclone's filesystem abstraction.
|
||||||
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
||||||
type RcloneStorer struct {
|
type RcloneStorer struct {
|
||||||
@@ -53,6 +63,19 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
|||||||
rclonePath += path
|
rclonePath += path
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A remote rclone cannot find is reported by fs.NewFs below. Only the
|
||||||
|
// backend of what fs.ParseRemote returns is needed here.
|
||||||
|
backend, _, _, _, err := fs.ParseRemote(rclonePath) //nolint:dogsled
|
||||||
|
if err == nil && backend.Name == rcloneLocalBackend && !filepath.IsAbs(path) {
|
||||||
|
example := path
|
||||||
|
if example == "" {
|
||||||
|
example = "path/to/backup"
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("%w: use rclone://%s//%s",
|
||||||
|
ErrRcloneRelativeLocalPath, remote, example)
|
||||||
|
}
|
||||||
|
|
||||||
// On S3, Swift and some other remotes rclone keeps a time of its own in
|
// On S3, Swift and some other remotes rclone keeps a time of its own in
|
||||||
// each object's metadata, which costs one request per object to read.
|
// each object's metadata, which costs one request per object to read.
|
||||||
// rclone's use_server_modtime setting makes ModTime the time the
|
// rclone's use_server_modtime setting makes ModTime the time the
|
||||||
|
|||||||
@@ -436,6 +436,79 @@ func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// useRcloneConfig points rclone at a config file holding contents for the
|
||||||
|
// rest of the test.
|
||||||
|
func useRcloneConfig(t *testing.T, contents string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
previous := config.GetConfigPath()
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
||||||
|
|
||||||
|
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
||||||
|
|
||||||
|
err := os.WriteFile(confFile, []byte(contents), 0o600)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("writing rclone config: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Setenv("RCLONE_CONFIG", confFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewRcloneStorerRefusesRelativeLocalPath checks that a relative path
|
||||||
|
// on a remote of type local is refused, with the absolute form in the
|
||||||
|
// error, and that nothing is created under the working directory. rclone
|
||||||
|
// would otherwise resolve the path against the working directory.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // changes the working directory and the rclone config
|
||||||
|
func TestNewRcloneStorerRefusesRelativeLocalPath(t *testing.T) {
|
||||||
|
useRcloneConfig(t, "[localfs]\ntype = local\n")
|
||||||
|
|
||||||
|
workdir := t.TempDir()
|
||||||
|
t.Chdir(workdir)
|
||||||
|
|
||||||
|
for path, wantInError := range map[string]string{
|
||||||
|
"srv/backup": "rclone://localfs//srv/backup",
|
||||||
|
"": "rclone://localfs//path/to/backup",
|
||||||
|
} {
|
||||||
|
_, err := storage.NewRcloneStorer(context.Background(), "localfs", path)
|
||||||
|
if !errors.Is(err, storage.ErrRcloneRelativeLocalPath) {
|
||||||
|
t.Errorf("path %q: error = %v, want ErrRcloneRelativeLocalPath",
|
||||||
|
path, err)
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(err.Error(), wantInError) {
|
||||||
|
t.Errorf("path %q: error %q does not show %q",
|
||||||
|
path, err, wantInError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
entries, err := os.ReadDir(workdir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("reading working directory: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(entries) != 0 {
|
||||||
|
t.Errorf("working directory holds %d entries, want none", len(entries))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewRcloneStorerKeepsRelativePathOnOtherRemotes checks that a relative
|
||||||
|
// path is accepted on a remote not of type local, where rclone resolves it
|
||||||
|
// on the remote itself, as sftp does against the login directory.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // changes the process-global rclone config
|
||||||
|
func TestNewRcloneStorerKeepsRelativePathOnOtherRemotes(t *testing.T) {
|
||||||
|
useRcloneConfig(t, "[mem]\ntype = memory\n")
|
||||||
|
|
||||||
|
_, err := storage.NewRcloneStorer(context.Background(), "mem", "backups")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("NewRcloneStorer: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestRcloneListStreamOnS3MakesNoRequestPerObject checks that listing an
|
// TestRcloneListStreamOnS3MakesNoRequestPerObject checks that listing an
|
||||||
// rclone S3 remote takes each object's time from the listing itself. By
|
// rclone S3 remote takes each object's time from the listing itself. By
|
||||||
// default rclone reads the time it keeps in each object's metadata, one
|
// default rclone reads the time it keeps in each object's metadata, one
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"maps"
|
"maps"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
@@ -12,6 +13,7 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/database"
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage/faultstore"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -68,3 +70,55 @@ func TestBackupWithoutCronOfTwoPathSnapshotRestoresBothPaths(t *testing.T) {
|
|||||||
|
|
||||||
assertRestoredTree(t, fs, restoreDir, files)
|
assertRestoredTree(t, fs, restoreDir, files)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A backup without --cron whose blob uploads keep failing stops with the
|
||||||
|
// upload's error, and stops the progress reporter once. See
|
||||||
|
// https://git.eeqj.de/sneak/vaultik/issues/476.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // installs the global logger via log.Initialize
|
||||||
|
func TestBackupWithoutCronStopsWithBlobUploadError(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
|
||||||
|
const snapshotName = "data"
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
firstDir := filepath.Join(tempDir, "first")
|
||||||
|
secondDir := filepath.Join(tempDir, "second")
|
||||||
|
dbPath := filepath.Join(tempDir, "index.sqlite")
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
writeFaultSourceTree(t, fs, firstDir)
|
||||||
|
writeFaultSourceTree(t, fs, secondDir)
|
||||||
|
|
||||||
|
cfg := faultTestConfig()
|
||||||
|
cfg.IndexPath = dbPath
|
||||||
|
cfg.ChunkSize = config.Size(faultChunkSize)
|
||||||
|
cfg.Snapshots = map[string]config.SnapshotConfig{
|
||||||
|
snapshotName: {Paths: []string{firstDir, secondDir}},
|
||||||
|
}
|
||||||
|
|
||||||
|
inner, err := storage.NewFileStorer(t.TempDir())
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
store := faultstore.New(inner)
|
||||||
|
store.OnPut = func(key string) faultstore.PutAction {
|
||||||
|
if strings.HasPrefix(key, "blobs/") {
|
||||||
|
return faultstore.PutFail
|
||||||
|
}
|
||||||
|
|
||||||
|
return faultstore.PutNormal
|
||||||
|
}
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
t.Cleanup(func() { _ = db.Close() })
|
||||||
|
|
||||||
|
v := newBackupVaultik(ctx, cfg, store, database.NewRepositories(db), db, fs)
|
||||||
|
|
||||||
|
err = v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
||||||
|
Snapshots: []string{snapshotName},
|
||||||
|
})
|
||||||
|
require.ErrorIs(t, err, faultstore.ErrInjectedUpload)
|
||||||
|
}
|
||||||
Reference in new issue
Block a user