Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98a36c6a0c | ||
|
|
547b9faf36 | ||
|
|
fbcb1b9fc6 | ||
|
|
4605eae024 | ||
|
|
5b09271751 |
No files matched your search
+9
-2
@@ -35,9 +35,16 @@ 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 . .
|
||||||
RUN go test -timeout 90s -race -cover ./... || \
|
# -race also turns on checkptr, which checks every pointer conversion. In
|
||||||
|
# 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 -v ./...; exit 1; }
|
go test -timeout 90s -race -gcflags='modernc.org/...=-d=checkptr=0' \
|
||||||
|
-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,6 +183,7 @@ 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
|
||||||
|
|||||||
+18
-4
@@ -32,6 +32,8 @@ 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",
|
||||||
@@ -39,15 +41,27 @@ 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. The banner is
|
// Bare 'vaultik' (no subcommand): print help, or with --version
|
||||||
// printed once at process startup by Entry, before cobra
|
// the report of the version command. The banner is printed once
|
||||||
// parses arguments, so it appears even when cobra rejects
|
// at process startup by Entry, before cobra parses arguments, so
|
||||||
// args (e.g. "requires at least 2 arg(s)") and on --help.
|
// it appears even when cobra rejects args (e.g. "requires at
|
||||||
|
// 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,6 +86,30 @@ 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,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")
|
||||||
|
}
|
||||||
@@ -1438,11 +1438,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
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -118,17 +118,22 @@ 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.
|
// new timestamp. The snapshot's start time is the moment in its ID, so a
|
||||||
|
// 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 snapshotID string
|
var (
|
||||||
|
snapshotID string
|
||||||
|
startedAt time.Time
|
||||||
|
)
|
||||||
|
|
||||||
for {
|
for {
|
||||||
// Build snapshot ID with optional name
|
// Build snapshot ID with optional name
|
||||||
timestamp := time.Now().UTC().Format("2006-01-02T15:04:05Z")
|
startedAt = time.Now().UTC()
|
||||||
|
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)
|
||||||
@@ -153,7 +158,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: time.Now().UTC(),
|
StartedAt: startedAt,
|
||||||
CompletedAt: nil, // Not completed yet
|
CompletedAt: nil, // Not completed yet
|
||||||
FileCount: 0,
|
FileCount: 0,
|
||||||
ChunkCount: 0,
|
ChunkCount: 0,
|
||||||
|
|||||||
@@ -492,3 +492,55 @@ 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user