Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2aa6fc8f66 |
No files matched your search
+2
-9
@@ -35,16 +35,9 @@ RUN for attempt in 1 2 3; do \
|
|||||||
echo "module download failed: giving up after 3 attempts" >&2; \
|
echo "module download failed: giving up after 3 attempts" >&2; \
|
||||||
exit 1
|
exit 1
|
||||||
COPY . .
|
COPY . .
|
||||||
# -race also turns on checkptr, which checks every pointer conversion. In
|
RUN go test -timeout 90s -race -cover ./... || \
|
||||||
# the SQLite library's translated C code that is about a third of the test
|
|
||||||
# CPU time, much of it under one lock all SQLite work shares, and the
|
|
||||||
# tests that use SQLite time out on a busy host. The gcflags turn it off
|
|
||||||
# for that library only; our own packages keep it.
|
|
||||||
RUN go test -timeout 90s -race -gcflags='modernc.org/...=-d=checkptr=0' \
|
|
||||||
-cover ./... || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
go test -timeout 90s -race -gcflags='modernc.org/...=-d=checkptr=0' \
|
go test -timeout 90s -race -v ./...; exit 1; }
|
||||||
-v ./...; exit 1; }
|
|
||||||
|
|
||||||
# Build stage. Nothing is wanted from either phase above; the copies
|
# Build stage. Nothing is wanted from either phase above; the copies
|
||||||
# are what make BuildKit build them first, so this stage cannot run
|
# are what make BuildKit build them first, so this stage cannot run
|
||||||
|
|||||||
@@ -183,7 +183,6 @@ vaultik [--config <path>] remote nuke --force
|
|||||||
vaultik [--config <path>] database delete [--force]
|
vaultik [--config <path>] database delete [--force]
|
||||||
vaultik completion <bash|zsh|fish|powershell>
|
vaultik completion <bash|zsh|fish|powershell>
|
||||||
vaultik version
|
vaultik version
|
||||||
vaultik --version
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### global flags
|
### global flags
|
||||||
@@ -555,6 +554,12 @@ count and blob size unknown, `null` in `--json`. A file under `blobs/` whose
|
|||||||
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
name is not a blob hash is not counted as a blob, since `prune` never deletes
|
||||||
it.
|
it.
|
||||||
|
|
||||||
|
A blob that a manifest lists but the destination does not hold is reported as
|
||||||
|
missing, with a count and size. The report names each snapshot that lists a
|
||||||
|
missing blob, since that snapshot cannot be restored. The command then exits
|
||||||
|
non-zero. `--json` gives these in `missing_blob_count`, `missing_blob_size` and
|
||||||
|
`snapshots_missing_blobs`.
|
||||||
|
|
||||||
- `--json`: Output as JSON
|
- `--json`: Output as JSON
|
||||||
|
|
||||||
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
**`remote nuke`**: Delete every object under `metadata/` and `blobs/` on the
|
||||||
|
|||||||
@@ -75,7 +75,9 @@ func newRemoteInfoCommand() *cobra.Command {
|
|||||||
- Size of all snapshot metadata (per snapshot and total)
|
- Size of all snapshot metadata (per snapshot and total)
|
||||||
- Count and total size of all blobs
|
- Count and total size of all blobs
|
||||||
- Count and size of referenced blobs (from all manifests)
|
- Count and size of referenced blobs (from all manifests)
|
||||||
- Count and size of orphaned blobs (not referenced by any manifest)`,
|
- Count and size of orphaned blobs (not referenced by any manifest)
|
||||||
|
- Count and size of referenced blobs missing from remote storage, and the
|
||||||
|
snapshots that list them; the command exits non-zero when any are missing`,
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
// Use unified config resolution
|
// Use unified config resolution
|
||||||
|
|||||||
+4
-18
@@ -32,8 +32,6 @@ var rootFlags RootFlags
|
|||||||
// It sets up the command structure, global flags, and adds all subcommands.
|
// It sets up the command structure, global flags, and adds all subcommands.
|
||||||
// This is the main entry point for the CLI command hierarchy.
|
// This is the main entry point for the CLI command hierarchy.
|
||||||
func NewRootCommand() *cobra.Command {
|
func NewRootCommand() *cobra.Command {
|
||||||
var showVersion bool
|
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "vaultik",
|
Use: "vaultik",
|
||||||
Short: "Secure incremental backup tool with asymmetric encryption",
|
Short: "Secure incremental backup tool with asymmetric encryption",
|
||||||
@@ -41,27 +39,15 @@ func NewRootCommand() *cobra.Command {
|
|||||||
public keys and uploads to S3-compatible storage. No private keys are needed
|
public keys and uploads to S3-compatible storage. No private keys are needed
|
||||||
on the source system.`,
|
on the source system.`,
|
||||||
SilenceUsage: true,
|
SilenceUsage: true,
|
||||||
// Bare 'vaultik' (no subcommand): print help, or with --version
|
// Bare 'vaultik' (no subcommand): print help. The banner is
|
||||||
// the report of the version command. The banner is printed once
|
// printed once at process startup by Entry, before cobra
|
||||||
// at process startup by Entry, before cobra parses arguments, so
|
// parses arguments, so it appears even when cobra rejects
|
||||||
// it appears even when cobra rejects args (e.g. "requires at
|
// args (e.g. "requires at least 2 arg(s)") and on --help.
|
||||||
// least 2 arg(s)") and on --help.
|
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
Run: func(cmd *cobra.Command, _ []string) {
|
||||||
if showVersion {
|
|
||||||
writeVersion(commandUI(cmd))
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = cmd.Help()
|
_ = cmd.Help()
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// cobra's own --version prints a template, not the version report,
|
|
||||||
// so vaultik defines the flag itself.
|
|
||||||
cmd.Flags().BoolVar(&showVersion, "version", false,
|
|
||||||
"Print version information (same as 'vaultik version')")
|
|
||||||
|
|
||||||
// Add global flags
|
// Add global flags
|
||||||
cmd.PersistentFlags().StringVar(&rootFlags.ConfigPath, "config", "",
|
cmd.PersistentFlags().StringVar(&rootFlags.ConfigPath, "config", "",
|
||||||
"Path to config file (default: $VAULTIK_CONFIG or platform config dir)")
|
"Path to config file (default: $VAULTIK_CONFIG or platform config dir)")
|
||||||
|
|||||||
@@ -86,30 +86,6 @@ func TestVersionCommandReportLines(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVersionFlagPrintsVersionReport checks that `vaultik --version`
|
|
||||||
// prints exactly the report of `vaultik version`.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // executes commands that read the global rootFlags
|
|
||||||
func TestVersionFlagPrintsVersionReport(t *testing.T) {
|
|
||||||
cmd := cli.NewRootCommand()
|
|
||||||
|
|
||||||
var out bytes.Buffer
|
|
||||||
|
|
||||||
cmd.SetOut(&out)
|
|
||||||
cmd.SetErr(&out)
|
|
||||||
cmd.SetArgs([]string{"--version"})
|
|
||||||
|
|
||||||
err := cmd.Execute()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("vaultik --version failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := runVersionCommand(t)
|
|
||||||
if out.String() != want {
|
|
||||||
t.Errorf("vaultik --version printed:\n%s\nwant:\n%s", out.String(), want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestVersionCommandFlagsDevelopmentBuild is the regression test for
|
// TestVersionCommandFlagsDevelopmentBuild is the regression test for
|
||||||
// the thing this command exists to prevent: a build that is not a
|
// the thing this command exists to prevent: a build that is not a
|
||||||
// release must say so. The notice used to be gated on the version
|
// release must say so. The notice used to be gated on the version
|
||||||
|
|||||||
@@ -4,10 +4,8 @@ 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"
|
||||||
)
|
)
|
||||||
@@ -40,36 +38,3 @@ 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")
|
|
||||||
}
|
|
||||||
@@ -1438,12 +1438,11 @@ 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 from a real
|
// file info describes, and false when info carries no stat, as from the
|
||||||
// filesystem. The in-memory test filesystem gives either no stat or one
|
// in-memory test filesystem.
|
||||||
// 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 || (stat.Dev == 0 && stat.Ino == 0) {
|
if !ok {
|
||||||
return 0, false
|
return 0, false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -118,22 +118,17 @@ func ShortHostname(hostname string) string {
|
|||||||
// hostname_timestamp if name is empty. The timestamp is in whole seconds.
|
// hostname_timestamp if name is empty. The timestamp is in whole seconds.
|
||||||
// If the local index already has a snapshot with that ID, from a run of the
|
// If the local index already has a snapshot with that ID, from a run of the
|
||||||
// same name that started in the same second, it waits a second and takes a
|
// same name that started in the same second, it waits a second and takes a
|
||||||
// new timestamp. The snapshot's start time is the moment in its ID, so a
|
// new timestamp.
|
||||||
// later run of one name always has a later start time.
|
|
||||||
func (sm *SnapshotManager) CreateSnapshotWithName(
|
func (sm *SnapshotManager) CreateSnapshotWithName(
|
||||||
ctx context.Context, hostname, name, version, gitRevision string,
|
ctx context.Context, hostname, name, version, gitRevision string,
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
shortHostname := ShortHostname(hostname)
|
shortHostname := ShortHostname(hostname)
|
||||||
|
|
||||||
var (
|
var snapshotID string
|
||||||
snapshotID string
|
|
||||||
startedAt time.Time
|
|
||||||
)
|
|
||||||
|
|
||||||
for {
|
for {
|
||||||
// Build snapshot ID with optional name
|
// Build snapshot ID with optional name
|
||||||
startedAt = time.Now().UTC()
|
timestamp := time.Now().UTC().Format("2006-01-02T15:04:05Z")
|
||||||
timestamp := startedAt.Format("2006-01-02T15:04:05Z")
|
|
||||||
|
|
||||||
if name != "" {
|
if name != "" {
|
||||||
snapshotID = fmt.Sprintf("%s_%s_%s", shortHostname, name, timestamp)
|
snapshotID = fmt.Sprintf("%s_%s_%s", shortHostname, name, timestamp)
|
||||||
@@ -158,7 +153,7 @@ func (sm *SnapshotManager) CreateSnapshotWithName(
|
|||||||
Hostname: types.Hostname(hostname),
|
Hostname: types.Hostname(hostname),
|
||||||
VaultikVersion: types.Version(version),
|
VaultikVersion: types.Version(version),
|
||||||
VaultikGitRevision: types.GitRevision(gitRevision),
|
VaultikGitRevision: types.GitRevision(gitRevision),
|
||||||
StartedAt: startedAt,
|
StartedAt: time.Now().UTC(),
|
||||||
CompletedAt: nil, // Not completed yet
|
CompletedAt: nil, // Not completed yet
|
||||||
FileCount: 0,
|
FileCount: 0,
|
||||||
ChunkCount: 0,
|
ChunkCount: 0,
|
||||||
|
|||||||
@@ -492,55 +492,3 @@ func TestCreateSnapshotWithNameTwiceBackToBack(t *testing.T) {
|
|||||||
t.Fatalf("both creates returned snapshot ID %s", first)
|
t.Fatalf("both creates returned snapshot ID %s", first)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Two creates of one snapshot name back to back list newest first. The
|
|
||||||
// start time is the moment in the ID, so the two cannot share a start
|
|
||||||
// time even when the clock crosses a second while the first is created.
|
|
||||||
// See https://git.eeqj.de/sneak/vaultik/issues/482.
|
|
||||||
func TestCreateSnapshotWithNameTwiceBackToBackListsNewestFirst(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const created = 2
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
db, err := database.New(ctx, filepath.Join(t.TempDir(), "index.sqlite"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = db.Close() }()
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
sm := &SnapshotManager{repos: repos}
|
|
||||||
|
|
||||||
first, err := sm.CreateSnapshotWithName(ctx, "test-host", "data", "v", "g")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("first create failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
second, err := sm.CreateSnapshotWithName(ctx, "test-host", "data", "v", "g")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("second create failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
snapshots, err := repos.Snapshots.ListRecent(ctx, created)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listing snapshots failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(snapshots) != created {
|
|
||||||
t.Fatalf("listed %d snapshots, want %d", len(snapshots), created)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !snapshots[0].StartedAt.After(snapshots[1].StartedAt) {
|
|
||||||
t.Fatalf("start times %v and %v are not in order",
|
|
||||||
snapshots[1].StartedAt, snapshots[0].StartedAt)
|
|
||||||
}
|
|
||||||
|
|
||||||
if snapshots[0].ID.String() != second || snapshots[1].ID.String() != first {
|
|
||||||
t.Fatalf("listed %s, %s; want %s, %s",
|
|
||||||
snapshots[0].ID, snapshots[1].ID, second, first)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ShowInfo displays system and configuration information
|
// ShowInfo displays system and configuration information
|
||||||
@@ -187,6 +188,9 @@ type SnapshotMetadataInfo struct {
|
|||||||
// backup interrupted before its manifest upload leaves a directory
|
// backup interrupted before its manifest upload leaves a directory
|
||||||
// without one, which prune does not treat as a snapshot.
|
// without one, which prune does not treat as a snapshot.
|
||||||
hasManifest bool
|
hasManifest bool
|
||||||
|
|
||||||
|
// Hashes of the blobs the snapshot's manifest lists.
|
||||||
|
blobHashes []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoteInfoResult contains all remote storage information
|
// RemoteInfoResult contains all remote storage information
|
||||||
@@ -216,6 +220,13 @@ type RemoteInfoResult struct {
|
|||||||
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
OrphanedBlobCount *int `json:"orphaned_blob_count"`
|
||||||
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
OrphanedBlobSize *int64 `json:"orphaned_blob_size"`
|
||||||
|
|
||||||
|
// Blobs that a manifest lists but the destination does not hold,
|
||||||
|
// and the remote key of each snapshot whose manifest lists one.
|
||||||
|
// Those snapshots cannot be restored.
|
||||||
|
MissingBlobCount int `json:"missing_blob_count"`
|
||||||
|
MissingBlobSize int64 `json:"missing_blob_size"`
|
||||||
|
SnapshotsMissingBlobs []string `json:"snapshots_missing_blobs,omitempty"`
|
||||||
|
|
||||||
// Remote key of each snapshot whose manifest could not be read
|
// Remote key of each snapshot whose manifest could not be read
|
||||||
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
UnreadableManifests []string `json:"unreadable_manifests,omitempty"`
|
||||||
|
|
||||||
@@ -283,19 +294,30 @@ func (v *Vaultik) RemoteInfo(jsonOutput bool) error {
|
|||||||
"snapshots", result.TotalMetadataCount,
|
"snapshots", result.TotalMetadataCount,
|
||||||
"total_blobs", result.TotalBlobCount,
|
"total_blobs", result.TotalBlobCount,
|
||||||
"referenced_blobs", result.ReferencedBlobCount,
|
"referenced_blobs", result.ReferencedBlobCount,
|
||||||
|
"missing_blobs", result.MissingBlobCount,
|
||||||
"unreadable_manifests", len(result.UnreadableManifests))
|
"unreadable_manifests", len(result.UnreadableManifests))
|
||||||
|
|
||||||
if jsonOutput {
|
if jsonOutput {
|
||||||
enc := json.NewEncoder(v.Stdout)
|
enc := json.NewEncoder(v.Stdout)
|
||||||
enc.SetIndent("", " ")
|
enc.SetIndent("", " ")
|
||||||
|
|
||||||
return enc.Encode(result)
|
err = enc.Encode(result)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("encoding JSON: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if showText {
|
if showText {
|
||||||
v.printRemoteInfoTable(result)
|
v.printRemoteInfoTable(result)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The report is written first, so the exit status adds to it.
|
||||||
|
if result.MissingBlobCount > 0 {
|
||||||
|
return fmt.Errorf("%w: %d blob(s) that snapshots list are missing; "+
|
||||||
|
"%d snapshot(s) cannot be restored", errProblemsInStorage,
|
||||||
|
result.MissingBlobCount, len(result.SnapshotsMissingBlobs))
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -405,6 +427,7 @@ func (v *Vaultik) collectReferencedBlobsFromManifests(
|
|||||||
for _, blob := range manifest.Blobs {
|
for _, blob := range manifest.Blobs {
|
||||||
referencedBlobs[blob.Hash] = blob.CompressedSize
|
referencedBlobs[blob.Hash] = blob.CompressedSize
|
||||||
blobsSize += blob.CompressedSize
|
blobsSize += blob.CompressedSize
|
||||||
|
info.blobHashes = append(info.blobHashes, blob.Hash)
|
||||||
}
|
}
|
||||||
|
|
||||||
info.BlobCount = &blobCount
|
info.BlobCount = &blobCount
|
||||||
@@ -462,6 +485,8 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
result.TotalBlobSize += blob.Size
|
result.TotalBlobSize += blob.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
|
countMissingBlobs(result, referencedBlobs, allBlobs)
|
||||||
|
|
||||||
// A blob named only by a manifest that could not be read, or by one
|
// A blob named only by a manifest that could not be read, or by one
|
||||||
// under a skipped name, would be counted as orphaned, so the orphan
|
// under a skipped name, would be counted as orphaned, so the orphan
|
||||||
// figures stay unknown.
|
// figures stay unknown.
|
||||||
@@ -487,6 +512,33 @@ func (v *Vaultik) scanRemoteBlobStorage(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// countMissingBlobs records in result the referenced blobs that
|
||||||
|
// allBlobs, the listing of the destination, does not hold, and the
|
||||||
|
// snapshots whose manifests list one of them. It reads the snapshots
|
||||||
|
// from result.Snapshots, so populateRemoteInfoResult must run first.
|
||||||
|
func countMissingBlobs(
|
||||||
|
result *RemoteInfoResult, referencedBlobs map[string]int64,
|
||||||
|
allBlobs map[string]storage.ObjectInfo,
|
||||||
|
) {
|
||||||
|
for hash, size := range referencedBlobs {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.MissingBlobCount++
|
||||||
|
result.MissingBlobSize += size
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, info := range result.Snapshots {
|
||||||
|
for _, hash := range info.blobHashes {
|
||||||
|
if _, present := allBlobs[hash]; !present {
|
||||||
|
result.SnapshotsMissingBlobs = append(
|
||||||
|
result.SnapshotsMissingBlobs, info.SnapshotID)
|
||||||
|
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// printRemoteInfoTable renders the human-readable remote info output
|
// printRemoteInfoTable renders the human-readable remote info output
|
||||||
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
||||||
const (
|
const (
|
||||||
@@ -539,6 +591,12 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
"", "", ubytes(result.TotalMetadataSize))
|
"", "", ubytes(result.TotalMetadataSize))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
v.printBlobStorageSummary(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printBlobStorageSummary renders the blob storage section that ends
|
||||||
|
// the human-readable remote info output.
|
||||||
|
func (v *Vaultik) printBlobStorageSummary(result *RemoteInfoResult) {
|
||||||
v.stdoutf("\n=== Blob Storage ===\n")
|
v.stdoutf("\n=== Blob Storage ===\n")
|
||||||
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
v.stdoutf("Total blobs on remote: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.TotalBlobCount)),
|
humanize.Comma(int64(result.TotalBlobCount)),
|
||||||
@@ -546,22 +604,31 @@ func (v *Vaultik) printRemoteInfoTable(result *RemoteInfoResult) {
|
|||||||
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
v.stdoutf("Referenced by snapshots: %s (%s)\n",
|
||||||
humanize.Comma(int64(result.ReferencedBlobCount)),
|
humanize.Comma(int64(result.ReferencedBlobCount)),
|
||||||
ubytes(result.ReferencedBlobSize))
|
ubytes(result.ReferencedBlobSize))
|
||||||
|
v.stdoutf("Missing from remote: %s (%s)\n",
|
||||||
|
humanize.Comma(int64(result.MissingBlobCount)),
|
||||||
|
ubytes(result.MissingBlobSize))
|
||||||
|
|
||||||
if result.OrphanedBlobCount == nil {
|
if result.OrphanedBlobCount == nil {
|
||||||
v.stdoutf("Orphaned (unreferenced): unknown "+
|
v.stdoutf("Orphaned (unreferenced): unknown "+
|
||||||
"(%d manifest(s) could not be read, "+
|
"(%d manifest(s) could not be read, "+
|
||||||
"%d manifest(s) under a non-conforming name skipped)\n",
|
"%d manifest(s) under a non-conforming name skipped)\n",
|
||||||
len(result.UnreadableManifests), result.SkippedManifestCount)
|
len(result.UnreadableManifests), result.SkippedManifestCount)
|
||||||
|
} else {
|
||||||
|
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
||||||
|
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
||||||
|
ubytes(*result.OrphanedBlobSize))
|
||||||
|
|
||||||
return
|
if *result.OrphanedBlobCount > 0 {
|
||||||
|
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
v.stdoutf("Orphaned (unreferenced): %s (%s)\n",
|
if len(result.SnapshotsMissingBlobs) > 0 {
|
||||||
humanize.Comma(int64(*result.OrphanedBlobCount)),
|
v.stdoutf("\nSnapshots that cannot be restored (blobs missing):\n")
|
||||||
ubytes(*result.OrphanedBlobSize))
|
|
||||||
|
|
||||||
if *result.OrphanedBlobCount > 0 {
|
for _, id := range result.SnapshotsMissingBlobs {
|
||||||
v.stdoutf("\nRun 'vaultik prune' to remove orphaned blobs.\n")
|
v.stdoutf(" %s\n", id)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -83,6 +83,7 @@ func TestRemoteInfo_UnreadableManifestLeavesSnapshotBlobsUnknown(t *testing.T) {
|
|||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
readableKey := env.addRemote(t, listRemoteID,
|
readableKey := env.addRemote(t, listRemoteID,
|
||||||
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
unreadableKey := snapshot.RemoteSnapshotKey(listLocalID)
|
||||||
require.NoError(t, env.store.Put(context.Background(),
|
require.NoError(t, env.store.Put(context.Background(),
|
||||||
@@ -270,6 +271,7 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
|
|
||||||
env := newListEnv(t)
|
env := newListEnv(t)
|
||||||
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
|
||||||
|
|
||||||
@@ -281,3 +283,61 @@ func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
|
|||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRemoteInfo_ReportsBlobsMissingFromDestination checks that a blob a
|
||||||
|
// manifest lists but the destination does not hold is counted as
|
||||||
|
// missing, that the snapshot listing it is named, and that remote info
|
||||||
|
// then fails after writing its report.
|
||||||
|
func TestRemoteInfo_ReportsBlobsMissingFromDestination(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newListEnv(t)
|
||||||
|
|
||||||
|
// The first snapshot lists blob A, which is not stored. The second
|
||||||
|
// lists blob B, which is.
|
||||||
|
brokenKey := env.addRemote(t, listRemoteID,
|
||||||
|
time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
|
||||||
|
addManifest(t, env.store.testStorer, listLocalID, []string{testBlobHashB})
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashB)
|
||||||
|
|
||||||
|
const wantError = "1 blob(s) that snapshots list are missing; " +
|
||||||
|
"1 snapshot(s) cannot be restored"
|
||||||
|
|
||||||
|
err := env.v.RemoteInfo(false)
|
||||||
|
require.ErrorContains(t, err, wantError)
|
||||||
|
|
||||||
|
text := env.stdout.String()
|
||||||
|
assert.Contains(t, text, "Missing from remote: 1 (5.0 MB)")
|
||||||
|
assert.Contains(t, text, "Snapshots that cannot be restored (blobs missing):\n"+
|
||||||
|
" "+brokenKey+"\n")
|
||||||
|
assert.NotContains(t, text, snapshot.RemoteSnapshotKey(listLocalID)+"\n")
|
||||||
|
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(true), wantError)
|
||||||
|
|
||||||
|
var doc map[string]any
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 1, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, fiveMegabytes, doc["missing_blob_size"], 0)
|
||||||
|
assert.Equal(t, []any{brokenKey}, doc["snapshots_missing_blobs"])
|
||||||
|
|
||||||
|
// --quiet drops the report, not the failure.
|
||||||
|
env.stdout.Reset()
|
||||||
|
env.v.UI.SetQuiet(true)
|
||||||
|
require.ErrorContains(t, env.v.RemoteInfo(false), wantError)
|
||||||
|
assert.Empty(t, env.stdout.String())
|
||||||
|
env.v.UI.SetQuiet(false)
|
||||||
|
|
||||||
|
// With blob A stored again nothing is missing.
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
env.stdout.Reset()
|
||||||
|
require.NoError(t, env.v.RemoteInfo(true))
|
||||||
|
|
||||||
|
doc = nil
|
||||||
|
require.NoError(t, json.Unmarshal(env.stdout.Bytes(), &doc))
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_count"], 0)
|
||||||
|
assert.InDelta(t, 0, doc["missing_blob_size"], 0)
|
||||||
|
assert.NotContains(t, doc, "snapshots_missing_blobs")
|
||||||
|
}
|
||||||
@@ -349,6 +349,7 @@ func TestSnapshotListAndPurgePrintSizesLikeRemoteInfo(t *testing.T) {
|
|||||||
env.addRemote(t, listLocalID, start)
|
env.addRemote(t, listLocalID, start)
|
||||||
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
require.NoError(t, env.v.Repositories.Snapshots.UpdateCounts(
|
||||||
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
context.Background(), nil, listLocalID, 0, 0, 0, 0, fiveMegabytes))
|
||||||
|
addBlob(t, env.store.testStorer, testBlobHashA)
|
||||||
|
|
||||||
require.NoError(t, env.v.RemoteInfo(false))
|
require.NoError(t, env.v.RemoteInfo(false))
|
||||||
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
assert.Contains(t, findTableRow(t, env.stdout.String(), remoteKey[:16]),
|
||||||
|
|||||||
Reference in new issue
Block a user