Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f0d67aada |
+4
-4
@@ -279,8 +279,8 @@ Key methods:
|
|||||||
- `Scan(ctx, path, snapshotID)` → Main scan operation
|
- `Scan(ctx, path, snapshotID)` → Main scan operation
|
||||||
|
|
||||||
Scan phases:
|
Scan phases:
|
||||||
1. **Phase 1**: Walk directory, identify files needing processing
|
1. **Phase 0**: Detect deleted files from previous snapshots
|
||||||
2. **Phase 1b**: Count as deleted the files that the previous snapshot of the same name lists, the walk did not find, and are gone from disk; a file that is excluded, or inside an excluded directory, is not counted
|
2. **Phase 1**: Walk directory, identify files needing processing
|
||||||
3. **Phase 2**: Process files (chunk → pack → upload)
|
3. **Phase 2**: Process files (chunk → pack → upload)
|
||||||
|
|
||||||
#### SnapshotManager
|
#### SnapshotManager
|
||||||
@@ -320,13 +320,13 @@ CreateSnapshot(opts)
|
|||||||
│ │
|
│ │
|
||||||
│ ├─► scanner.Scan(ctx, path, snapshotID)
|
│ ├─► scanner.Scan(ctx, path, snapshotID)
|
||||||
│ │ │
|
│ │ │
|
||||||
|
│ │ ├─► Phase 0: detectDeletedFiles()
|
||||||
|
│ │ │
|
||||||
│ │ ├─► Phase 1: scanPhase()
|
│ │ ├─► Phase 1: scanPhase()
|
||||||
│ │ │ Walk directory
|
│ │ │ Walk directory
|
||||||
│ │ │ Check file metadata changes
|
│ │ │ Check file metadata changes
|
||||||
│ │ │ Build list of files to process
|
│ │ │ Build list of files to process
|
||||||
│ │ │
|
│ │ │
|
||||||
│ │ ├─► Phase 1b: detectDeletedFiles()
|
|
||||||
│ │ │
|
|
||||||
│ │ └─► Phase 2: processPhase()
|
│ │ └─► Phase 2: processPhase()
|
||||||
│ │ For each file:
|
│ │ For each file:
|
||||||
│ │ chunker.ChunkReaderStreaming()
|
│ │ chunker.ChunkReaderStreaming()
|
||||||
|
|||||||
@@ -373,7 +373,9 @@ on the destination in one go, use `vaultik remote nuke --force`.
|
|||||||
store — its remote key (or an unambiguous leading part of it) as shown
|
store — its remote key (or an unambiguous leading part of it) as shown
|
||||||
by `snapshot list`. See
|
by `snapshot list`. See
|
||||||
[restoring on another machine](#restoring-on-another-machine).
|
[restoring on another machine](#restoring-on-another-machine).
|
||||||
* Optional path arguments to restore specific files/directories (default: all)
|
* Optional path arguments to restore specific files/directories (default: all).
|
||||||
|
A path that matches nothing in the snapshot is named in a warning, and the
|
||||||
|
command exits non-zero after restoring the paths that match.
|
||||||
* Preserves file permissions, timestamps, ownership (ownership requires root),
|
* Preserves file permissions, timestamps, ownership (ownership requires root),
|
||||||
symlinks, and empty directories
|
symlinks, and empty directories
|
||||||
* `--verify`: After restoring, verify every restored file's chunk hashes
|
* `--verify`: After restoring, verify every restored file's chunk hashes
|
||||||
|
|||||||
@@ -30,6 +30,8 @@ This command will restore files from the specified snapshot to the
|
|||||||
target directory.
|
target directory.
|
||||||
If no paths are specified, all files are restored.
|
If no paths are specified, all files are restored.
|
||||||
If paths are specified, only matching files/directories are restored.
|
If paths are specified, only matching files/directories are restored.
|
||||||
|
A path that matches nothing in the snapshot is named in a warning, and
|
||||||
|
the command exits non-zero after restoring the paths that match.
|
||||||
|
|
||||||
The snapshot may be named by its ID or, when restoring on a host with no
|
The snapshot may be named by its ID or, when restoring on a host with no
|
||||||
local index, by the remote key that 'snapshot list' prints for a
|
local index, by the remote key that 'snapshot list' prints for a
|
||||||
|
|||||||
@@ -267,45 +267,6 @@ func (r *FileRepository) ListUnderPath(
|
|||||||
return files, rows.Err()
|
return files, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListUnderPathInSnapshot returns the files that ListUnderPath returns
|
|
||||||
// for path and that the snapshot lists, in no particular order.
|
|
||||||
func (r *FileRepository) ListUnderPathInSnapshot(
|
|
||||||
ctx context.Context, path, snapshotID string,
|
|
||||||
) ([]*File, error) {
|
|
||||||
path = strings.TrimRight(path, "/")
|
|
||||||
dirPrefix := path + "/"
|
|
||||||
|
|
||||||
query := `
|
|
||||||
SELECT f.id, f.path, f.source_path, f.mtime, f.mtime_nsec, f.size,
|
|
||||||
f.mode, f.uid, f.gid, f.link_target
|
|
||||||
FROM files f
|
|
||||||
JOIN snapshot_files sf ON sf.file_id = f.id
|
|
||||||
WHERE sf.snapshot_id = ?
|
|
||||||
AND (f.path = ? OR substr(f.path, 1, length(?)) = ?)
|
|
||||||
`
|
|
||||||
|
|
||||||
rows, err := r.db.conn.QueryContext(ctx, query,
|
|
||||||
snapshotID, path, dirPrefix, dirPrefix)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("querying files: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = rows.Close() }()
|
|
||||||
|
|
||||||
var files []*File
|
|
||||||
|
|
||||||
for rows.Next() {
|
|
||||||
file, err := r.scanFileRows(rows)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("scanning file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
files = append(files, file)
|
|
||||||
}
|
|
||||||
|
|
||||||
return files, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListIDsWithChunksNotInUploadedBlobs returns the IDs of the files whose
|
// ListIDsWithChunksNotInUploadedBlobs returns the IDs of the files whose
|
||||||
// path starts with prefix and that list at least one chunk held by no
|
// path starts with prefix and that list at least one chunk held by no
|
||||||
// blob whose upload has completed (uploaded_ts set). A new snapshot
|
// blob whose upload has completed (uploaded_ts set). A new snapshot
|
||||||
|
|||||||
@@ -212,65 +212,6 @@ func TestFileRepositoryListUnderPath(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListUnderPathInSnapshot leaves out files outside path and files the
|
|
||||||
// snapshot does not list, though another snapshot lists them.
|
|
||||||
func TestFileRepositoryListUnderPathInSnapshot(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db, cleanup := setupTestDB(t)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
files := database.NewFileRepository(db)
|
|
||||||
snapshots := database.NewSnapshotRepository(db)
|
|
||||||
|
|
||||||
listed := map[string][]string{
|
|
||||||
"one": {"/src/a.txt", "/src2/c.txt"},
|
|
||||||
"two": {"/src/b.txt"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for snapshotID, paths := range listed {
|
|
||||||
err := snapshots.Create(ctx, nil, &database.Snapshot{
|
|
||||||
ID: types.SnapshotID(snapshotID),
|
|
||||||
Hostname: "host",
|
|
||||||
StartedAt: time.Now(),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create snapshot %s: %v", snapshotID, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, path := range paths {
|
|
||||||
err := files.Create(ctx, nil, &database.File{
|
|
||||||
Path: types.FilePath(path),
|
|
||||||
MTime: time.Now().Truncate(time.Second),
|
|
||||||
Mode: 0644,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create %s: %v", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = snapshots.AddFile(ctx, nil, snapshotID, path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to add %s to %s: %v", path, snapshotID, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
found, err := files.ListUnderPathInSnapshot(ctx, "/src", "one")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to list files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := make([]string, 0, len(found))
|
|
||||||
for _, f := range found {
|
|
||||||
got = append(got, f.Path.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !slices.Equal(got, []string{"/src/a.txt"}) {
|
|
||||||
t.Errorf("got %q, want only /src/a.txt", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFileRepositorySymlink(t *testing.T) {
|
func TestFileRepositorySymlink(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
+11
-15
@@ -16,9 +16,6 @@ type ScannerParams struct {
|
|||||||
Fs afero.Fs
|
Fs afero.Fs
|
||||||
Exclude []string // Exclude patterns (combined global + snapshot-specific)
|
Exclude []string // Exclude patterns (combined global + snapshot-specific)
|
||||||
SkipErrors bool // Skip file read errors (log loudly but continue)
|
SkipErrors bool // Skip file read errors (log loudly but continue)
|
||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none.
|
|
||||||
PreviousSnapshotID string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Module exports backup functionality as an fx module.
|
// Module exports backup functionality as an fx module.
|
||||||
@@ -47,18 +44,17 @@ func provideScannerFactory(
|
|||||||
}
|
}
|
||||||
|
|
||||||
return NewScanner(ScannerConfig{
|
return NewScanner(ScannerConfig{
|
||||||
FS: params.Fs,
|
FS: params.Fs,
|
||||||
ChunkSize: cfg.ChunkSize.Int64(),
|
ChunkSize: cfg.ChunkSize.Int64(),
|
||||||
Repositories: repos,
|
Repositories: repos,
|
||||||
Storage: storer,
|
Storage: storer,
|
||||||
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
MaxBlobSize: cfg.BlobSizeLimit.Int64(),
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
EnableProgress: params.EnableProgress,
|
EnableProgress: params.EnableProgress,
|
||||||
UI: params.UI,
|
UI: params.UI,
|
||||||
Exclude: excludes,
|
Exclude: excludes,
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -58,10 +58,6 @@ type Scanner struct {
|
|||||||
compressionLevel int
|
compressionLevel int
|
||||||
ageRecipient string
|
ageRecipient string
|
||||||
snapshotID string // Current snapshot being processed
|
snapshotID string // Current snapshot being processed
|
||||||
// previousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none. Only a file it lists can be counted as
|
|
||||||
// deleted.
|
|
||||||
previousSnapshotID string
|
|
||||||
// currentSourcePath is the source directory being scanned, stored with
|
// currentSourcePath is the source directory being scanned, stored with
|
||||||
// each file record.
|
// each file record.
|
||||||
currentSourcePath string
|
currentSourcePath string
|
||||||
@@ -133,9 +129,6 @@ type ScannerConfig struct {
|
|||||||
// SkipErrors skips files that cannot be opened or read (log loudly but
|
// SkipErrors skips files that cannot be opened or read (log loudly but
|
||||||
// continue); packer, database, encryption, and upload errors still abort.
|
// continue); packer, database, encryption, and upload errors still abort.
|
||||||
SkipErrors bool
|
SkipErrors bool
|
||||||
// PreviousSnapshotID is the most recent completed snapshot of the
|
|
||||||
// same name, "" for none.
|
|
||||||
PreviousSnapshotID string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ScanResult contains the results of a scan operation. Files and bytes
|
// ScanResult contains the results of a scan operation. Files and bytes
|
||||||
@@ -214,7 +207,6 @@ func NewScanner(cfg ScannerConfig) *Scanner {
|
|||||||
compiledExclude: compiledExclude,
|
compiledExclude: compiledExclude,
|
||||||
progress: progress,
|
progress: progress,
|
||||||
skipErrors: cfg.SkipErrors,
|
skipErrors: cfg.SkipErrors,
|
||||||
previousSnapshotID: cfg.PreviousSnapshotID,
|
|
||||||
ui: uiw,
|
ui: uiw,
|
||||||
pendingChunkHashes: make(map[string]struct{}),
|
pendingChunkHashes: make(map[string]struct{}),
|
||||||
}
|
}
|
||||||
@@ -266,9 +258,8 @@ func (s *Scanner) Scan(
|
|||||||
|
|
||||||
filesToProcess := scanResult.FilesToProcess
|
filesToProcess := scanResult.FilesToProcess
|
||||||
|
|
||||||
// Phase 1b: Detect deleted files by comparing the previous snapshot
|
// Phase 1b: Detect deleted files by comparing DB against scanned files
|
||||||
// of this name against scanned files
|
err = s.detectDeletedFilesFromMap(ctx, knownFiles, existingFiles, result)
|
||||||
err = s.detectDeletedFiles(ctx, path, existingFiles, result)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("detecting deleted files: %w", err)
|
return nil, fmt.Errorf("detecting deleted files: %w", err)
|
||||||
}
|
}
|
||||||
@@ -448,8 +439,9 @@ func (s *Scanner) summarizeScanPhase(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// loadKnownFiles loads the known files at and beneath path from the
|
// loadKnownFiles loads the known files at and beneath path from the
|
||||||
// database into a map for fast lookup. This avoids per-file database
|
// database into a map for fast lookup. Every loaded file the scan does
|
||||||
// queries during the scan phase.
|
// not find is counted as deleted. This avoids per-file database queries
|
||||||
|
// during the scan phase.
|
||||||
func (s *Scanner) loadKnownFiles(
|
func (s *Scanner) loadKnownFiles(
|
||||||
ctx context.Context, path string,
|
ctx context.Context, path string,
|
||||||
) (map[string]*database.File, error) {
|
) (map[string]*database.File, error) {
|
||||||
@@ -1962,29 +1954,21 @@ func (s *Scanner) queueFileForBatchInsert(
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// detectDeletedFiles counts as deleted each file at or beneath path that
|
// detectDeletedFilesFromMap finds files that existed in previous snapshots
|
||||||
// the previous snapshot of this name lists, the walk did not find, and
|
// but no longer exist. Uses pre-loaded maps to avoid any filesystem or
|
||||||
// is gone from disk. A file that is excluded, or inside an excluded
|
// database access.
|
||||||
// directory, is not counted: the walk skips it whether or not it is
|
func (s *Scanner) detectDeletedFilesFromMap(
|
||||||
// still on disk.
|
|
||||||
func (s *Scanner) detectDeletedFiles(
|
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
path string,
|
knownFiles map[string]*database.File,
|
||||||
existingFiles map[string]struct{},
|
existingFiles map[string]struct{},
|
||||||
result *ScanResult,
|
result *ScanResult,
|
||||||
) error {
|
) error {
|
||||||
if s.previousSnapshotID == "" {
|
if len(knownFiles) == 0 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
previousFiles, err := s.repos.Files.ListUnderPathInSnapshot(
|
// Check each known file against the enumerated set (no filesystem access needed)
|
||||||
ctx, path, s.previousSnapshotID)
|
for path, file := range knownFiles {
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("listing files of snapshot %s: %w",
|
|
||||||
s.previousSnapshotID, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, file := range previousFiles {
|
|
||||||
// Check context cancellation periodically
|
// Check context cancellation periodically
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
@@ -1992,22 +1976,13 @@ func (s *Scanner) detectDeletedFiles(
|
|||||||
default:
|
default:
|
||||||
}
|
}
|
||||||
|
|
||||||
filePath := file.Path.String()
|
// Check if the file exists in our enumerated set
|
||||||
|
if _, exists := existingFiles[path]; !exists {
|
||||||
_, exists := existingFiles[filePath]
|
// File has been deleted
|
||||||
if exists || s.excludedOrInExcludedDir(filePath, path) {
|
result.FilesDeleted++
|
||||||
continue
|
result.BytesDeleted += file.Size
|
||||||
|
log.Debug("Detected deleted file", "path", path, "size", file.Size)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Under --skip-errors the walk also misses what it cannot reach,
|
|
||||||
// such as the files in a directory it cannot open.
|
|
||||||
if !s.goneFromDisk(filePath) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
result.FilesDeleted++
|
|
||||||
result.BytesDeleted += file.Size
|
|
||||||
log.Debug("Detected deleted file", "path", filePath, "size", file.Size)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if result.FilesDeleted > 0 {
|
if result.FilesDeleted > 0 {
|
||||||
@@ -2018,34 +1993,6 @@ func (s *Scanner) detectDeletedFiles(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// excludedOrInExcludedDir reports whether filePath, which is at or
|
|
||||||
// beneath rootPath, or any directory between rootPath and it, matches an
|
|
||||||
// exclude pattern. A pattern such as */.local/share/Trash matches the
|
|
||||||
// directory but not the files inside it, which the walk skips too.
|
|
||||||
func (s *Scanner) excludedOrInExcludedDir(filePath, rootPath string) bool {
|
|
||||||
for p := filePath; len(p) > len(rootPath); p = filepath.Dir(p) {
|
|
||||||
if s.shouldExclude(p, rootPath) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// goneFromDisk reports whether looking filePath up on disk finds that
|
|
||||||
// it does not exist. Like the walk, it does not follow a symlink, so a
|
|
||||||
// symlink whose target is gone is still on disk.
|
|
||||||
func (s *Scanner) goneFromDisk(filePath string) bool {
|
|
||||||
var err error
|
|
||||||
if lstater, ok := s.fs.(afero.Lstater); ok {
|
|
||||||
_, _, err = lstater.LstatIfPossible(filePath)
|
|
||||||
} else {
|
|
||||||
_, err = s.fs.Stat(filePath)
|
|
||||||
}
|
|
||||||
|
|
||||||
return errors.Is(err, os.ErrNotExist)
|
|
||||||
}
|
|
||||||
|
|
||||||
// wrapPermissionError augments permission errors with platform-specific
|
// wrapPermissionError augments permission errors with platform-specific
|
||||||
// remediation instructions. On macOS, TCC-protected directories (Calendars,
|
// remediation instructions. On macOS, TCC-protected directories (Calendars,
|
||||||
// Reminders, Photos, etc.) return EPERM unless the running application has
|
// Reminders, Photos, etc.) return EPERM unless the running application has
|
||||||
|
|||||||
@@ -661,18 +661,17 @@ func faultScannerFactory(
|
|||||||
) snapshot.ScannerFactory {
|
) snapshot.ScannerFactory {
|
||||||
return func(params snapshot.ScannerParams) *snapshot.Scanner {
|
return func(params snapshot.ScannerParams) *snapshot.Scanner {
|
||||||
return snapshot.NewScanner(snapshot.ScannerConfig{
|
return snapshot.NewScanner(snapshot.ScannerConfig{
|
||||||
FS: params.Fs,
|
FS: params.Fs,
|
||||||
Storage: storer,
|
Storage: storer,
|
||||||
ChunkSize: faultChunkSize,
|
ChunkSize: faultChunkSize,
|
||||||
MaxBlobSize: faultMaxBlobSize,
|
MaxBlobSize: faultMaxBlobSize,
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
Repositories: repos,
|
Repositories: repos,
|
||||||
EnableProgress: params.EnableProgress,
|
EnableProgress: params.EnableProgress,
|
||||||
UI: params.UI,
|
UI: params.UI,
|
||||||
Exclude: params.Exclude,
|
Exclude: params.Exclude,
|
||||||
SkipErrors: params.SkipErrors,
|
SkipErrors: params.SkipErrors,
|
||||||
PreviousSnapshotID: params.PreviousSnapshotID,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+55
-24
@@ -27,6 +27,7 @@ import (
|
|||||||
// Sentinel errors for restore failures.
|
// Sentinel errors for restore failures.
|
||||||
var (
|
var (
|
||||||
errFilesFailedRestore = errors.New("file(s) failed to restore")
|
errFilesFailedRestore = errors.New("file(s) failed to restore")
|
||||||
|
errPathsNotInSnapshot = errors.New("requested path(s) not in the snapshot")
|
||||||
errFilesFailedVerify = errors.New("files failed verification")
|
errFilesFailedVerify = errors.New("files failed verification")
|
||||||
errDecryptionKeyRequired = errors.New(
|
errDecryptionKeyRequired = errors.New(
|
||||||
"decryption key required for restore\n\n" +
|
"decryption key required for restore\n\n" +
|
||||||
@@ -150,16 +151,20 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
repos := database.NewRepositories(tempDB)
|
repos := database.NewRepositories(tempDB)
|
||||||
|
|
||||||
// Step 2: Get list of files to restore
|
// Step 2: Get list of files to restore
|
||||||
files, err := v.getFilesToRestore(v.ctx, repos, opts.Paths)
|
files, unmatched, err := v.getFilesToRestore(v.ctx, repos, opts.Paths)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("getting files to restore: %w", err)
|
return fmt.Errorf("getting files to restore: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Named before anything is restored, so the names are shown even
|
||||||
|
// when the restore stops on an error.
|
||||||
|
unmatchedErr := v.reportUnmatchedPaths(unmatched)
|
||||||
|
|
||||||
if len(files) == 0 {
|
if len(files) == 0 {
|
||||||
log.Warn("No files found to restore")
|
log.Warn("No files found to restore")
|
||||||
v.UI.Warningf("No files found to restore.")
|
v.UI.Warningf("No files found to restore.")
|
||||||
|
|
||||||
return nil
|
return unmatchedErr
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("Found files to restore", "count", len(files))
|
log.Info("Found files to restore", "count", len(files))
|
||||||
@@ -185,6 +190,20 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
|
|
||||||
result.Duration = time.Since(startTime)
|
result.Duration = time.Since(startTime)
|
||||||
|
|
||||||
|
return v.finishRestore(repos, files, unmatchedErr, opts, result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// finishRestore prints the restore summary and the post-restore
|
||||||
|
// warnings, runs optional verification, and converts any failed-file
|
||||||
|
// count into an error. Otherwise it returns unmatchedErr, the error for
|
||||||
|
// the requested paths that matched nothing (nil when there are none).
|
||||||
|
func (v *Vaultik) finishRestore(
|
||||||
|
repos *database.Repositories,
|
||||||
|
files []*database.File,
|
||||||
|
unmatchedErr error,
|
||||||
|
opts *RestoreOptions,
|
||||||
|
result *RestoreResult,
|
||||||
|
) error {
|
||||||
log.Info("Restore complete",
|
log.Info("Restore complete",
|
||||||
"files_restored", result.FilesRestored,
|
"files_restored", result.FilesRestored,
|
||||||
"bytes_restored", ubytes(result.BytesRestored),
|
"bytes_restored", ubytes(result.BytesRestored),
|
||||||
@@ -199,17 +218,6 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
v.UI.Duration(result.Duration),
|
v.UI.Duration(result.Duration),
|
||||||
)
|
)
|
||||||
|
|
||||||
return v.finishRestore(repos, files, opts, result)
|
|
||||||
}
|
|
||||||
|
|
||||||
// finishRestore emits the post-restore warnings, runs optional
|
|
||||||
// verification, and converts any failed-file count into an error.
|
|
||||||
func (v *Vaultik) finishRestore(
|
|
||||||
repos *database.Repositories,
|
|
||||||
files []*database.File,
|
|
||||||
opts *RestoreOptions,
|
|
||||||
result *RestoreResult,
|
|
||||||
) error {
|
|
||||||
if os.Geteuid() != 0 {
|
if os.Geteuid() != 0 {
|
||||||
v.UI.Warningf("Restore did not preserve file ownership: chown(2) " +
|
v.UI.Warningf("Restore did not preserve file ownership: chown(2) " +
|
||||||
"requires root. Re-run as root (e.g. with sudo) if you need " +
|
"requires root. Re-run as root (e.g. with sudo) if you need " +
|
||||||
@@ -236,7 +244,23 @@ func (v *Vaultik) finishRestore(
|
|||||||
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
return fmt.Errorf("%d %w", result.FilesFailed, errFilesFailedRestore)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return unmatchedErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// reportUnmatchedPaths warns, by name, about each requested path that
|
||||||
|
// matched nothing in the snapshot, and returns an error counting them,
|
||||||
|
// or nil when there are none.
|
||||||
|
func (v *Vaultik) reportUnmatchedPaths(unmatched []string) error {
|
||||||
|
if len(unmatched) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, path := range unmatched {
|
||||||
|
log.Warn("Requested path matches nothing in the snapshot", "path", path)
|
||||||
|
v.UI.Warningf("%s matches nothing in the snapshot.", v.UI.Path(path))
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Errorf("%d %w", len(unmatched), errPathsNotInSnapshot)
|
||||||
}
|
}
|
||||||
|
|
||||||
// restoreIdentities parses the configured age secret key once into every
|
// restoreIdentities parses the configured age secret key once into every
|
||||||
@@ -840,27 +864,34 @@ func (v *Vaultik) materializeSnapshotDB(
|
|||||||
return db, tempDir, nil
|
return db, tempDir, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// getFilesToRestore returns the list of files to restore based on path filters
|
// getFilesToRestore returns the list of files to restore based on path
|
||||||
|
// filters, and the filters, as given, that matched no file.
|
||||||
func (v *Vaultik) getFilesToRestore(
|
func (v *Vaultik) getFilesToRestore(
|
||||||
ctx context.Context, repos *database.Repositories, pathFilters []string,
|
ctx context.Context, repos *database.Repositories, pathFilters []string,
|
||||||
) ([]*database.File, error) {
|
) ([]*database.File, []string, error) {
|
||||||
// If no filters, get all files
|
// If no filters, get all files
|
||||||
if len(pathFilters) == 0 {
|
if len(pathFilters) == 0 {
|
||||||
return repos.Files.ListAll(ctx)
|
files, err := repos.Files.ListAll(ctx)
|
||||||
|
|
||||||
|
return files, nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get files matching the path filters
|
// Get files matching the path filters
|
||||||
var result []*database.File
|
var (
|
||||||
|
result []*database.File
|
||||||
|
unmatched []string
|
||||||
|
)
|
||||||
|
|
||||||
seen := make(map[string]bool)
|
seen := make(map[string]bool)
|
||||||
|
|
||||||
for _, filter := range pathFilters {
|
for _, filter := range pathFilters {
|
||||||
// Normalize the filter path
|
files, err := repos.Files.ListUnderPath(ctx, filepath.Clean(filter))
|
||||||
filter = filepath.Clean(filter)
|
|
||||||
|
|
||||||
files, err := repos.Files.ListUnderPath(ctx, filter)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("listing files under %s: %w", filter, err)
|
return nil, nil, fmt.Errorf("listing files under %s: %w", filter, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(files) == 0 {
|
||||||
|
unmatched = append(unmatched, filter)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, file := range files {
|
for _, file := range files {
|
||||||
@@ -871,7 +902,7 @@ func (v *Vaultik) getFilesToRestore(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return result, nil
|
return result, unmatched, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildChunkToBlobMap creates a mapping from chunk hash to blob information
|
// buildChunkToBlobMap creates a mapping from chunk hash to blob information
|
||||||
|
|||||||
@@ -0,0 +1,202 @@
|
|||||||
|
package vaultik_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"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/storage/faultstore"
|
||||||
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
|
)
|
||||||
|
|
||||||
|
// These tests cover https://git.eeqj.de/sneak/vaultik/issues/309: a path
|
||||||
|
// given to restore that matches nothing in the snapshot is named in a
|
||||||
|
// warning and makes the restore fail, after the paths that do match are
|
||||||
|
// restored.
|
||||||
|
|
||||||
|
func TestRestoreNamesUnmatchedPathAndRestoresTheMatchingOne(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
dataDir := filepath.Join(tempDir, "src")
|
||||||
|
storeDir := filepath.Join(tempDir, "remote")
|
||||||
|
restoreDir := filepath.Join(tempDir, "restored")
|
||||||
|
dbPath := filepath.Join(tempDir, "index.sqlite")
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
cfg := faultTestConfig()
|
||||||
|
files := writeFaultSourceTree(t, fs, dataDir)
|
||||||
|
|
||||||
|
store, err := storage.NewFileStorer(storeDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
id := fullFaultBackup(ctx, t, fs, store, cfg,
|
||||||
|
database.NewRepositories(db), dataDir, dbPath, "unmatched")
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
matched := filepath.Join(dataDir, "small.txt")
|
||||||
|
unmatched := filepath.Join(dataDir, "typo.txt")
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v := newReaderVaultik(ctx, cfg, store, nil, fs)
|
||||||
|
v.UI = ui.NewWithColor(&out, false)
|
||||||
|
|
||||||
|
err = v.Restore(&vaultik.RestoreOptions{
|
||||||
|
SnapshotID: id,
|
||||||
|
TargetDir: restoreDir,
|
||||||
|
Paths: []string{matched, unmatched},
|
||||||
|
})
|
||||||
|
|
||||||
|
require.Error(t, err, "a path that matches nothing must fail the restore")
|
||||||
|
assert.Contains(t, out.String(), unmatched,
|
||||||
|
"the path that matches nothing must be named")
|
||||||
|
assert.NotContains(t, out.String(), matched,
|
||||||
|
"the path that matches must not be reported")
|
||||||
|
|
||||||
|
got, err := afero.ReadFile(fs, filepath.Join(restoreDir, matched))
|
||||||
|
require.NoError(t, err, "the path that matches must still be restored")
|
||||||
|
assert.Equal(t, files[matched], got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// When no requested path matches, nothing is restored and each path is
|
||||||
|
// named. One path is relative. The other goes through the symlink that
|
||||||
|
// is the snapshot's configured path, while the entries are stored under
|
||||||
|
// the directory the symlink points to.
|
||||||
|
func TestRestoreNamesEveryPathWhenNothingMatches(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const snapshotName = "linked"
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
dataDir := filepath.Join(tempDir, "src")
|
||||||
|
linkDir := filepath.Join(tempDir, "srclink")
|
||||||
|
storeDir := filepath.Join(tempDir, "remote")
|
||||||
|
restoreDir := filepath.Join(tempDir, "restored")
|
||||||
|
dbPath := filepath.Join(tempDir, "index.sqlite")
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
writeFaultSourceTree(t, fs, dataDir)
|
||||||
|
require.NoError(t, os.Symlink(dataDir, linkDir))
|
||||||
|
|
||||||
|
cfg := faultTestConfig()
|
||||||
|
cfg.IndexPath = dbPath
|
||||||
|
cfg.ChunkSize = config.Size(faultChunkSize)
|
||||||
|
cfg.Snapshots = map[string]config.SnapshotConfig{
|
||||||
|
snapshotName: {Paths: []string{linkDir}},
|
||||||
|
}
|
||||||
|
|
||||||
|
store, err := storage.NewFileStorer(storeDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
repos := database.NewRepositories(db)
|
||||||
|
v := newBackupVaultik(ctx, cfg, store, repos, db, fs)
|
||||||
|
|
||||||
|
require.NoError(t, backUp(v, snapshotName))
|
||||||
|
|
||||||
|
id := localSnapshotID(ctx, t, repos, snapshotName)
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
throughLink := filepath.Join(linkDir, "sub")
|
||||||
|
relative := strings.TrimPrefix(filepath.Join(dataDir, "small.txt"), "/")
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
reader := newReaderVaultik(ctx, cfg, store, nil, fs)
|
||||||
|
reader.UI = ui.NewWithColor(&out, false)
|
||||||
|
|
||||||
|
err = reader.Restore(&vaultik.RestoreOptions{
|
||||||
|
SnapshotID: id,
|
||||||
|
TargetDir: restoreDir,
|
||||||
|
Paths: []string{throughLink, relative},
|
||||||
|
})
|
||||||
|
|
||||||
|
require.Error(t, err, "a restore that matches nothing must fail")
|
||||||
|
assert.Contains(t, out.String(), throughLink,
|
||||||
|
"the path through the symlink must be named")
|
||||||
|
assert.Contains(t, out.String(), relative,
|
||||||
|
"the relative path must be named")
|
||||||
|
|
||||||
|
_, err = fs.Stat(restoreDir)
|
||||||
|
assert.True(t, os.IsNotExist(err), "nothing must be restored")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without --skip-errors a damaged blob stops the restore part way. The
|
||||||
|
// path that matches nothing must still be named.
|
||||||
|
func TestRestoreNamesUnmatchedPathWhenADamagedBlobStopsIt(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
dataDir := filepath.Join(tempDir, "src")
|
||||||
|
storeDir := filepath.Join(tempDir, "remote")
|
||||||
|
restoreDir := filepath.Join(tempDir, "restored")
|
||||||
|
dbPath := filepath.Join(tempDir, "index.sqlite")
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
cfg := faultTestConfig()
|
||||||
|
|
||||||
|
writeFaultSourceTree(t, fs, dataDir)
|
||||||
|
|
||||||
|
inner, err := storage.NewFileStorer(storeDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
id := fullFaultBackup(ctx, t, fs, inner, cfg,
|
||||||
|
database.NewRepositories(db), dataDir, dbPath, "damaged")
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
damaged := faultstore.New(inner)
|
||||||
|
damaged.OnGet = func(key string) faultstore.GetFault {
|
||||||
|
if strings.HasPrefix(key, "blobs/") {
|
||||||
|
return faultstore.GetCorrupt
|
||||||
|
}
|
||||||
|
|
||||||
|
return faultstore.GetNormal
|
||||||
|
}
|
||||||
|
|
||||||
|
matched := filepath.Join(dataDir, "small.txt")
|
||||||
|
unmatched := filepath.Join(dataDir, "typo.txt")
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
v := newReaderVaultik(ctx, cfg, damaged, nil, fs)
|
||||||
|
v.UI = ui.NewWithColor(&out, false)
|
||||||
|
|
||||||
|
err = v.Restore(&vaultik.RestoreOptions{
|
||||||
|
SnapshotID: id,
|
||||||
|
TargetDir: restoreDir,
|
||||||
|
Paths: []string{matched, unmatched},
|
||||||
|
})
|
||||||
|
|
||||||
|
require.Error(t, err, "a damaged blob must stop the restore")
|
||||||
|
assert.Contains(t, err.Error(), "blob",
|
||||||
|
"the restore must stop on the damaged blob")
|
||||||
|
assert.Contains(t, out.String(), unmatched,
|
||||||
|
"the path that matches nothing must be named")
|
||||||
|
}
|
||||||
@@ -243,18 +243,12 @@ func (v *Vaultik) createNamedSnapshot(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
previousSnapshotID, err := v.previousSnapshotID(snapName)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
scanner := v.ScannerFactory(snapshot.ScannerParams{
|
scanner := v.ScannerFactory(snapshot.ScannerParams{
|
||||||
EnableProgress: !opts.Cron,
|
EnableProgress: !opts.Cron,
|
||||||
UI: v.UI,
|
UI: v.UI,
|
||||||
Fs: v.Fs,
|
Fs: v.Fs,
|
||||||
Exclude: v.Config.GetExcludes(snapName),
|
Exclude: v.Config.GetExcludes(snapName),
|
||||||
SkipErrors: opts.SkipErrors,
|
SkipErrors: opts.SkipErrors,
|
||||||
PreviousSnapshotID: previousSnapshotID,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
snapshotID, err := v.SnapshotManager.CreateSnapshotWithName(
|
snapshotID, err := v.SnapshotManager.CreateSnapshotWithName(
|
||||||
@@ -289,24 +283,6 @@ func (v *Vaultik) createNamedSnapshot(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// previousSnapshotID returns the ID of the most recent completed snapshot
|
|
||||||
// named snapName in the local index, or "" when there is none.
|
|
||||||
func (v *Vaultik) previousSnapshotID(snapName string) (string, error) {
|
|
||||||
snapshots, err := v.Repositories.Snapshots.ListRecent(v.ctx, listRecentLimit)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("listing snapshots: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, s := range snapshots {
|
|
||||||
if s.CompletedAt != nil &&
|
|
||||||
parseSnapshotName(s.ID.String(), s.Hostname.String()) == snapName {
|
|
||||||
return s.ID.String(), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// resolveSnapshotPaths resolves source directories to absolute paths
|
// resolveSnapshotPaths resolves source directories to absolute paths
|
||||||
// with symlink resolution.
|
// with symlink resolution.
|
||||||
func (v *Vaultik) resolveSnapshotPaths(snapName string) ([]string, error) {
|
func (v *Vaultik) resolveSnapshotPaths(snapName string) ([]string, error) {
|
||||||
|
|||||||
@@ -1,225 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// These tests cover https://git.eeqj.de/sneak/vaultik/issues/304: a
|
|
||||||
// backup counts a file as deleted only when the previous snapshot of
|
|
||||||
// the same name had it and it is gone, and never counts an excluded
|
|
||||||
// file.
|
|
||||||
|
|
||||||
// deletedCountEnv is a backup setup over the source directory src whose
|
|
||||||
// user-facing output is kept in out. Each test configures its snapshots
|
|
||||||
// with setSnapshot.
|
|
||||||
type deletedCountEnv struct {
|
|
||||||
v *vaultik.Vaultik
|
|
||||||
out *bytes.Buffer
|
|
||||||
src string
|
|
||||||
}
|
|
||||||
|
|
||||||
// newDeletedCountEnv writes files, keyed by path relative to src.
|
|
||||||
func newDeletedCountEnv(t *testing.T, files map[string][]byte) *deletedCountEnv {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
srcDir := filepath.Join(tempDir, "src")
|
|
||||||
|
|
||||||
for rel, content := range files {
|
|
||||||
path := filepath.Join(srcDir, rel)
|
|
||||||
require.NoError(t, fs.MkdirAll(filepath.Dir(path), 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs, path, content, 0o644))
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
cfg.IndexPath = filepath.Join(tempDir, "index.sqlite")
|
|
||||||
cfg.Snapshots = map[string]config.SnapshotConfig{}
|
|
||||||
|
|
||||||
store, err := storage.NewFileStorer(filepath.Join(tempDir, "remote"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, cfg.IndexPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
out := &bytes.Buffer{}
|
|
||||||
v := newBackupVaultik(ctx, cfg, store, repos, db, fs)
|
|
||||||
v.UI = ui.NewWithColor(out, false)
|
|
||||||
|
|
||||||
return &deletedCountEnv{v: v, out: out, src: srcDir}
|
|
||||||
}
|
|
||||||
|
|
||||||
// setSnapshot configures the snapshot name to back up the path rel
|
|
||||||
// beneath src, with the given excludes.
|
|
||||||
func (e *deletedCountEnv) setSnapshot(name, rel string, exclude ...string) {
|
|
||||||
e.v.Config.Snapshots[name] = config.SnapshotConfig{
|
|
||||||
Paths: []string{filepath.Join(e.src, rel)},
|
|
||||||
Exclude: exclude,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// backUp runs a backup of the named snapshot and returns its output.
|
|
||||||
func (e *deletedCountEnv) backUp(t *testing.T, name string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
e.out.Reset()
|
|
||||||
require.NoError(t, e.v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
Snapshots: []string{name},
|
|
||||||
}))
|
|
||||||
|
|
||||||
return e.out.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file this snapshot excludes is not counted as deleted: neither one
|
|
||||||
// that another snapshot backs up, nor one that the previous snapshot of
|
|
||||||
// this name had before the exclude was added.
|
|
||||||
func TestBackupDoesNotCountExcludedFileAsDeleted(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"top.txt": []byte("top"),
|
|
||||||
"cache/tmp.bin": []byte("cache"),
|
|
||||||
"photos/a.jpg": []byte("photo a"),
|
|
||||||
"photos/b.jpg": []byte("photo b"),
|
|
||||||
"photos/c.jpg": []byte("photo c"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("photos", "photos")
|
|
||||||
env.setSnapshot("home", "", "/photos")
|
|
||||||
|
|
||||||
env.backUp(t, "photos")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(2, 2, 0))
|
|
||||||
|
|
||||||
env.setSnapshot("home", "", "/photos", "/cache")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file inside a directory that an exclude added after a backup
|
|
||||||
// matches is not counted as deleted, though the pattern matches only the
|
|
||||||
// directory.
|
|
||||||
func TestBackupDoesNotCountFileInExcludedDirectoryAsDeleted(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"top.txt": []byte("top"),
|
|
||||||
"user/.local/share/Trash/old.txt": []byte("old"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(2, 2, 0))
|
|
||||||
|
|
||||||
env.setSnapshot("home", "", "*/.local/share/Trash")
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Under --skip-errors a file inside a directory that the walk cannot
|
|
||||||
// open is not counted as deleted: it is still on disk.
|
|
||||||
func TestBackupDoesNotCountFileInUnopenableDirectoryAsDeleted(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"top.txt": []byte("top"),
|
|
||||||
"locked/inside.txt": []byte("inside"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(2, 2, 0))
|
|
||||||
|
|
||||||
// A directory's mode does not lock out root, who runs the tests, so
|
|
||||||
// opening the directory is made to fail instead.
|
|
||||||
env.v.Fs = &openFailFs{
|
|
||||||
path: filepath.Join(env.src, "locked"),
|
|
||||||
err: os.ErrPermission,
|
|
||||||
}
|
|
||||||
|
|
||||||
env.out.Reset()
|
|
||||||
require.NoError(t, env.v.CreateSnapshot(&vaultik.SnapshotCreateOptions{
|
|
||||||
SkipErrors: true,
|
|
||||||
Snapshots: []string{"home"},
|
|
||||||
}))
|
|
||||||
assert.Contains(t, env.out.String(), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A backup counts only files that the previous snapshot of its own name
|
|
||||||
// had, not one that a later snapshot of another name over the same path
|
|
||||||
// had and that is since removed.
|
|
||||||
func TestBackupIgnoresSnapshotOfAnotherName(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"kept.txt": []byte("kept"),
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
env.setSnapshot("other", "")
|
|
||||||
|
|
||||||
env.backUp(t, "home")
|
|
||||||
|
|
||||||
// Snapshot start times are kept in whole seconds: wait so that other's
|
|
||||||
// snapshot is strictly the most recent.
|
|
||||||
time.Sleep(time.Second)
|
|
||||||
|
|
||||||
extra := filepath.Join(env.src, "extra.txt")
|
|
||||||
require.NoError(t, os.WriteFile(extra, []byte("extra"), 0o600))
|
|
||||||
env.backUp(t, "other")
|
|
||||||
require.NoError(t, os.Remove(extra))
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file removed from disk is counted as deleted by the next backup of
|
|
||||||
// the snapshot that had it, and not by any later backup of that
|
|
||||||
// snapshot, nor by the first backup of another name over the same path.
|
|
||||||
func TestBackupCountsDeletedFileOnce(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
aContent := bytes.Repeat([]byte("a"), 1000)
|
|
||||||
bContent := bytes.Repeat([]byte("b"), 2000)
|
|
||||||
keptContent := bytes.Repeat([]byte("k"), 500)
|
|
||||||
|
|
||||||
env := newDeletedCountEnv(t, map[string][]byte{
|
|
||||||
"a.txt": aContent,
|
|
||||||
"b.txt": bContent,
|
|
||||||
"kept.txt": keptContent,
|
|
||||||
})
|
|
||||||
env.setSnapshot("home", "")
|
|
||||||
env.setSnapshot("other", "")
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(3, 3, 0))
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(env.src, "a.txt")))
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(env.src, "b.txt")))
|
|
||||||
|
|
||||||
summary := env.backUp(t, "home")
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
"Files: 1 examined, 0 backed up, 1 unchanged, 2 deleted.")
|
|
||||||
assert.Contains(t, summary,
|
|
||||||
fmt.Sprintf("Data: %s total (%s backed up), %s deleted.",
|
|
||||||
env.v.UI.Size(int64(len(keptContent))), env.v.UI.Size(0),
|
|
||||||
env.v.UI.Size(int64(len(aContent)+len(bContent)))))
|
|
||||||
|
|
||||||
assert.Contains(t, env.backUp(t, "home"), filesLine(1, 0, 1))
|
|
||||||
assert.Contains(t, env.backUp(t, "other"), filesLine(1, 0, 1))
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user