Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98a36c6a0c | ||
|
|
547b9faf36 | ||
|
|
fbcb1b9fc6 | ||
|
|
4605eae024 | ||
|
|
5b09271751 | ||
|
|
9fedcbeb0a |
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; \
|
||||
exit 1
|
||||
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 ---"; \
|
||||
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
|
||||
# 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 completion <bash|zsh|fish|powershell>
|
||||
vaultik version
|
||||
vaultik --version
|
||||
```
|
||||
|
||||
### global flags
|
||||
@@ -602,7 +603,11 @@ only `vaultik-destination.txt` stops such a backup, and only while the local
|
||||
index holds snapshots.
|
||||
|
||||
**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
|
||||
shows an object only once its upload has completed, and on the local filesystem
|
||||
|
||||
+18
-4
@@ -32,6 +32,8 @@ var rootFlags RootFlags
|
||||
// It sets up the command structure, global flags, and adds all subcommands.
|
||||
// This is the main entry point for the CLI command hierarchy.
|
||||
func NewRootCommand() *cobra.Command {
|
||||
var showVersion bool
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "vaultik",
|
||||
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
|
||||
on the source system.`,
|
||||
SilenceUsage: true,
|
||||
// Bare 'vaultik' (no subcommand): print help. The banner is
|
||||
// printed once at process startup by Entry, before cobra
|
||||
// parses arguments, so it appears even when cobra rejects
|
||||
// args (e.g. "requires at least 2 arg(s)") and on --help.
|
||||
// Bare 'vaultik' (no subcommand): print help, or with --version
|
||||
// the report of the version command. The banner is printed once
|
||||
// at process startup by Entry, before cobra parses arguments, so
|
||||
// it appears even when cobra rejects args (e.g. "requires at
|
||||
// least 2 arg(s)") and on --help.
|
||||
Run: func(cmd *cobra.Command, _ []string) {
|
||||
if showVersion {
|
||||
writeVersion(commandUI(cmd))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
_ = 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
|
||||
cmd.PersistentFlags().StringVar(&rootFlags.ConfigPath, "config", "",
|
||||
"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
|
||||
// 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
|
||||
|
||||
@@ -4,8 +4,10 @@ package snapshot
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"syscall"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/afero"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"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.
|
||||
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
|
||||
// file info describes, and false when info carries no stat, as from the
|
||||
// in-memory test filesystem.
|
||||
// file info describes, and false when info carries no stat from a real
|
||||
// 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) {
|
||||
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||
if !ok {
|
||||
if !ok || (stat.Dev == 0 && stat.Ino == 0) {
|
||||
return 0, false
|
||||
}
|
||||
|
||||
|
||||
@@ -118,17 +118,22 @@ func ShortHostname(hostname string) string {
|
||||
// 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
|
||||
// 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(
|
||||
ctx context.Context, hostname, name, version, gitRevision string,
|
||||
) (string, error) {
|
||||
shortHostname := ShortHostname(hostname)
|
||||
|
||||
var snapshotID string
|
||||
var (
|
||||
snapshotID string
|
||||
startedAt time.Time
|
||||
)
|
||||
|
||||
for {
|
||||
// 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 != "" {
|
||||
snapshotID = fmt.Sprintf("%s_%s_%s", shortHostname, name, timestamp)
|
||||
@@ -153,7 +158,7 @@ func (sm *SnapshotManager) CreateSnapshotWithName(
|
||||
Hostname: types.Hostname(hostname),
|
||||
VaultikVersion: types.Version(version),
|
||||
VaultikGitRevision: types.GitRevision(gitRevision),
|
||||
StartedAt: time.Now().UTC(),
|
||||
StartedAt: startedAt,
|
||||
CompletedAt: nil, // Not completed yet
|
||||
FileCount: 0,
|
||||
ChunkCount: 0,
|
||||
|
||||
@@ -492,3 +492,55 @@ func TestCreateSnapshotWithNameTwiceBackToBack(t *testing.T) {
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
@@ -23,6 +24,15 @@ import (
|
||||
// ErrRemoteNotFound is returned when an rclone remote is not configured.
|
||||
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.
|
||||
// This allows vaultik to use any of rclone's 70+ supported storage providers.
|
||||
type RcloneStorer struct {
|
||||
@@ -53,6 +63,19 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
||||
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
|
||||
// each object's metadata, which costs one request per object to read.
|
||||
// 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
|
||||
// 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
|
||||
|
||||
Reference in new issue
Block a user