Compare commits
2 Commits
c76a357570
...
fix/sql-in
| Author | SHA1 | Date | |
|---|---|---|---|
| 3e282af516 | |||
|
|
bb4b9b5bc9 |
@@ -1,8 +0,0 @@
|
|||||||
.git
|
|
||||||
.gitea
|
|
||||||
*.md
|
|
||||||
LICENSE
|
|
||||||
vaultik
|
|
||||||
coverage.out
|
|
||||||
coverage.html
|
|
||||||
.DS_Store
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
name: check
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
jobs:
|
|
||||||
check:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
# actions/checkout v4, 2024-09-16
|
|
||||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
|
|
||||||
- name: Build and check
|
|
||||||
run: docker build .
|
|
||||||
61
Dockerfile
61
Dockerfile
@@ -1,61 +0,0 @@
|
|||||||
# Lint stage
|
|
||||||
# golangci/golangci-lint:v2.11.3-alpine, 2026-03-17
|
|
||||||
FROM golangci/golangci-lint:v2.11.3-alpine@sha256:b1c3de5862ad0a95b4e45a993b0f00415835d687e4f12c845c7493b86c13414e AS lint
|
|
||||||
|
|
||||||
RUN apk add --no-cache make build-base
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
|
|
||||||
# Copy go mod files first for better layer caching
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
|
|
||||||
# Copy source code
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Run formatting check and linter
|
|
||||||
RUN make fmt-check
|
|
||||||
RUN make lint
|
|
||||||
|
|
||||||
# Build stage
|
|
||||||
# golang:1.26.1-alpine, 2026-03-17
|
|
||||||
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
|
||||||
|
|
||||||
# Depend on lint stage passing
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
|
|
||||||
ARG VERSION=dev
|
|
||||||
|
|
||||||
# Install build dependencies for CGO (mattn/go-sqlite3) and sqlite3 CLI (tests)
|
|
||||||
RUN apk add --no-cache make build-base sqlite
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
|
|
||||||
# Copy go mod files first for better layer caching
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
|
|
||||||
# Copy source code
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Run tests
|
|
||||||
RUN make test
|
|
||||||
|
|
||||||
# Build with CGO enabled (required for mattn/go-sqlite3)
|
|
||||||
RUN CGO_ENABLED=1 go build -ldflags "-X 'git.eeqj.de/sneak/vaultik/internal/globals.Version=${VERSION}' -X 'git.eeqj.de/sneak/vaultik/internal/globals.Commit=$(git rev-parse HEAD 2>/dev/null || echo unknown)'" -o /vaultik ./cmd/vaultik
|
|
||||||
|
|
||||||
# Runtime stage
|
|
||||||
# alpine:3.21, 2026-02-25
|
|
||||||
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
|
||||||
|
|
||||||
RUN apk add --no-cache ca-certificates sqlite
|
|
||||||
|
|
||||||
# Copy binary from builder
|
|
||||||
COPY --from=builder /vaultik /usr/local/bin/vaultik
|
|
||||||
|
|
||||||
# Create non-root user
|
|
||||||
RUN adduser -D -H -s /sbin/nologin vaultik
|
|
||||||
|
|
||||||
USER vaultik
|
|
||||||
|
|
||||||
ENTRYPOINT ["/usr/local/bin/vaultik"]
|
|
||||||
40
Makefile
40
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: test fmt lint fmt-check check build clean all docker hooks
|
.PHONY: test fmt lint build clean all
|
||||||
|
|
||||||
# Version number
|
# Version number
|
||||||
VERSION := 0.0.1
|
VERSION := 0.0.1
|
||||||
@@ -14,12 +14,21 @@ LDFLAGS := -X 'git.eeqj.de/sneak/vaultik/internal/globals.Version=$(VERSION)' \
|
|||||||
all: vaultik
|
all: vaultik
|
||||||
|
|
||||||
# Run tests
|
# Run tests
|
||||||
test:
|
test: lint fmt-check
|
||||||
go test -race -timeout 30s ./...
|
@echo "Running tests..."
|
||||||
|
@if ! go test -v -timeout 10s ./... 2>&1; then \
|
||||||
|
echo ""; \
|
||||||
|
echo "TEST FAILURES DETECTED"; \
|
||||||
|
echo "Run 'go test -v ./internal/database' to see database test details"; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
|
|
||||||
# Check if code is formatted (read-only)
|
# Check if code is formatted
|
||||||
fmt-check:
|
fmt-check:
|
||||||
@test -z "$$(gofmt -l .)" || (echo "Files not formatted:" && gofmt -l . && exit 1)
|
@if [ -n "$$(go fmt ./...)" ]; then \
|
||||||
|
echo "Error: Code is not formatted. Run 'make fmt' to fix."; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
|
|
||||||
# Format code
|
# Format code
|
||||||
fmt:
|
fmt:
|
||||||
@@ -27,7 +36,7 @@ fmt:
|
|||||||
|
|
||||||
# Run linter
|
# Run linter
|
||||||
lint:
|
lint:
|
||||||
golangci-lint run ./...
|
golangci-lint run
|
||||||
|
|
||||||
# Build binary
|
# Build binary
|
||||||
vaultik: internal/*/*.go cmd/vaultik/*.go
|
vaultik: internal/*/*.go cmd/vaultik/*.go
|
||||||
@@ -38,6 +47,11 @@ clean:
|
|||||||
rm -f vaultik
|
rm -f vaultik
|
||||||
go clean
|
go clean
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
deps:
|
||||||
|
go mod download
|
||||||
|
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
|
||||||
|
|
||||||
# Run tests with coverage
|
# Run tests with coverage
|
||||||
test-coverage:
|
test-coverage:
|
||||||
go test -v -coverprofile=coverage.out ./...
|
go test -v -coverprofile=coverage.out ./...
|
||||||
@@ -53,17 +67,3 @@ local:
|
|||||||
|
|
||||||
install: vaultik
|
install: vaultik
|
||||||
cp ./vaultik $(HOME)/bin/
|
cp ./vaultik $(HOME)/bin/
|
||||||
|
|
||||||
# Run all checks (formatting, linting, tests) without modifying files
|
|
||||||
check: fmt-check lint test
|
|
||||||
|
|
||||||
# Build Docker image
|
|
||||||
docker:
|
|
||||||
docker build -t vaultik .
|
|
||||||
|
|
||||||
# Install pre-commit hook
|
|
||||||
hooks:
|
|
||||||
@printf '#!/bin/sh\nset -e\n' > .git/hooks/pre-commit
|
|
||||||
@printf 'go mod tidy\ngo fmt ./...\ngit diff --exit-code -- go.mod go.sum || { echo "go mod tidy changed files; please stage and retry"; exit 1; }\n' >> .git/hooks/pre-commit
|
|
||||||
@printf 'make check\n' >> .git/hooks/pre-commit
|
|
||||||
@chmod +x .git/hooks/pre-commit
|
|
||||||
|
|||||||
@@ -150,7 +150,7 @@ passphrase is needed or stored locally.
|
|||||||
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--daemon] [--prune]
|
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--daemon] [--prune]
|
||||||
vaultik [--config <path>] snapshot list [--json]
|
vaultik [--config <path>] snapshot list [--json]
|
||||||
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep]
|
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep]
|
||||||
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--name <name>] [--force]
|
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--force]
|
||||||
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force]
|
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force]
|
||||||
vaultik [--config <path>] snapshot prune
|
vaultik [--config <path>] snapshot prune
|
||||||
vaultik [--config <path>] restore <snapshot-id> <target-dir> [paths...]
|
vaultik [--config <path>] restore <snapshot-id> <target-dir> [paths...]
|
||||||
@@ -180,9 +180,8 @@ vaultik [--config <path>] store info
|
|||||||
* `--deep`: Download and verify blob contents (not just existence)
|
* `--deep`: Download and verify blob contents (not just existence)
|
||||||
|
|
||||||
**snapshot purge**: Remove old snapshots based on criteria
|
**snapshot purge**: Remove old snapshots based on criteria
|
||||||
* `--keep-latest`: Keep the most recent snapshot per snapshot name
|
* `--keep-latest`: Keep only the most recent snapshot
|
||||||
* `--older-than`: Remove snapshots older than duration (e.g., 30d, 6mo, 1y)
|
* `--older-than`: Remove snapshots older than duration (e.g., 30d, 6mo, 1y)
|
||||||
* `--name`: Filter purge to a specific snapshot name
|
|
||||||
* `--force`: Skip confirmation prompt
|
* `--force`: Skip confirmation prompt
|
||||||
|
|
||||||
**snapshot remove**: Remove a specific snapshot
|
**snapshot remove**: Remove a specific snapshot
|
||||||
|
|||||||
2
go.mod
2
go.mod
@@ -1,6 +1,6 @@
|
|||||||
module git.eeqj.de/sneak/vaultik
|
module git.eeqj.de/sneak/vaultik
|
||||||
|
|
||||||
go 1.26.1
|
go 1.24.4
|
||||||
|
|
||||||
require (
|
require (
|
||||||
filippo.io/age v1.2.1
|
filippo.io/age v1.2.1
|
||||||
|
|||||||
@@ -11,9 +11,16 @@ import (
|
|||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// PurgeOptions contains options for the purge command
|
||||||
|
type PurgeOptions struct {
|
||||||
|
KeepLatest bool
|
||||||
|
OlderThan string
|
||||||
|
Force bool
|
||||||
|
}
|
||||||
|
|
||||||
// NewPurgeCommand creates the purge command
|
// NewPurgeCommand creates the purge command
|
||||||
func NewPurgeCommand() *cobra.Command {
|
func NewPurgeCommand() *cobra.Command {
|
||||||
opts := &vaultik.SnapshotPurgeOptions{}
|
opts := &PurgeOptions{}
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "purge",
|
Use: "purge",
|
||||||
@@ -21,15 +28,8 @@ func NewPurgeCommand() *cobra.Command {
|
|||||||
Long: `Removes snapshots based on age or count criteria.
|
Long: `Removes snapshots based on age or count criteria.
|
||||||
|
|
||||||
This command allows you to:
|
This command allows you to:
|
||||||
- Keep only the latest snapshot per name (--keep-latest)
|
- Keep only the latest snapshot (--keep-latest)
|
||||||
- Remove snapshots older than a specific duration (--older-than)
|
- Remove snapshots older than a specific duration (--older-than)
|
||||||
- Filter to a specific snapshot name (--name)
|
|
||||||
|
|
||||||
When --keep-latest is used, retention is applied per snapshot name. For example,
|
|
||||||
if you have snapshots named "home" and "system", --keep-latest keeps the most
|
|
||||||
recent of each.
|
|
||||||
|
|
||||||
Use --name to restrict the purge to a single snapshot name.
|
|
||||||
|
|
||||||
Config is located at /etc/vaultik/config.yml by default, but can be overridden by
|
Config is located at /etc/vaultik/config.yml by default, but can be overridden by
|
||||||
specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
||||||
@@ -66,7 +66,7 @@ specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
|||||||
// Start the purge operation in a goroutine
|
// Start the purge operation in a goroutine
|
||||||
go func() {
|
go func() {
|
||||||
// Run the purge operation
|
// Run the purge operation
|
||||||
if err := v.PurgeSnapshotsWithOptions(opts); err != nil {
|
if err := v.PurgeSnapshots(opts.KeepLatest, opts.OlderThan, opts.Force); err != nil {
|
||||||
if err != context.Canceled {
|
if err != context.Canceled {
|
||||||
log.Error("Purge operation failed", "error", err)
|
log.Error("Purge operation failed", "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -92,10 +92,9 @@ specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.Flags().BoolVar(&opts.KeepLatest, "keep-latest", false, "Keep only the latest snapshot per name")
|
cmd.Flags().BoolVar(&opts.KeepLatest, "keep-latest", false, "Keep only the latest snapshot")
|
||||||
cmd.Flags().StringVar(&opts.OlderThan, "older-than", "", "Remove snapshots older than duration (e.g. 30d, 6m, 1y)")
|
cmd.Flags().StringVar(&opts.OlderThan, "older-than", "", "Remove snapshots older than duration (e.g. 30d, 6m, 1y)")
|
||||||
cmd.Flags().BoolVar(&opts.Force, "force", false, "Skip confirmation prompts")
|
cmd.Flags().BoolVar(&opts.Force, "force", false, "Skip confirmation prompts")
|
||||||
cmd.Flags().StringVar(&opts.Name, "name", "", "Filter purge to a specific snapshot name")
|
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -167,25 +167,21 @@ func newSnapshotListCommand() *cobra.Command {
|
|||||||
|
|
||||||
// newSnapshotPurgeCommand creates the 'snapshot purge' subcommand
|
// newSnapshotPurgeCommand creates the 'snapshot purge' subcommand
|
||||||
func newSnapshotPurgeCommand() *cobra.Command {
|
func newSnapshotPurgeCommand() *cobra.Command {
|
||||||
opts := &vaultik.SnapshotPurgeOptions{}
|
var keepLatest bool
|
||||||
|
var olderThan string
|
||||||
|
var force bool
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "purge",
|
Use: "purge",
|
||||||
Short: "Purge old snapshots",
|
Short: "Purge old snapshots",
|
||||||
Long: `Removes snapshots based on age or count criteria.
|
Long: "Removes snapshots based on age or count criteria",
|
||||||
|
|
||||||
When --keep-latest is used, retention is applied per snapshot name. For example,
|
|
||||||
if you have snapshots named "home" and "system", --keep-latest keeps the most
|
|
||||||
recent of each.
|
|
||||||
|
|
||||||
Use --name to restrict the purge to a single snapshot name.`,
|
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
// Validate flags
|
// Validate flags
|
||||||
if !opts.KeepLatest && opts.OlderThan == "" {
|
if !keepLatest && olderThan == "" {
|
||||||
return fmt.Errorf("must specify either --keep-latest or --older-than")
|
return fmt.Errorf("must specify either --keep-latest or --older-than")
|
||||||
}
|
}
|
||||||
if opts.KeepLatest && opts.OlderThan != "" {
|
if keepLatest && olderThan != "" {
|
||||||
return fmt.Errorf("cannot specify both --keep-latest and --older-than")
|
return fmt.Errorf("cannot specify both --keep-latest and --older-than")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,7 +205,7 @@ Use --name to restrict the purge to a single snapshot name.`,
|
|||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
OnStart: func(ctx context.Context) error {
|
OnStart: func(ctx context.Context) error {
|
||||||
go func() {
|
go func() {
|
||||||
if err := v.PurgeSnapshotsWithOptions(opts); err != nil {
|
if err := v.PurgeSnapshots(keepLatest, olderThan, force); err != nil {
|
||||||
if err != context.Canceled {
|
if err != context.Canceled {
|
||||||
log.Error("Failed to purge snapshots", "error", err)
|
log.Error("Failed to purge snapshots", "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -232,10 +228,9 @@ Use --name to restrict the purge to a single snapshot name.`,
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.Flags().BoolVar(&opts.KeepLatest, "keep-latest", false, "Keep only the latest snapshot per name")
|
cmd.Flags().BoolVar(&keepLatest, "keep-latest", false, "Keep only the latest snapshot")
|
||||||
cmd.Flags().StringVar(&opts.OlderThan, "older-than", "", "Remove snapshots older than duration (e.g., 30d, 6m, 1y)")
|
cmd.Flags().StringVar(&olderThan, "older-than", "", "Remove snapshots older than duration (e.g., 30d, 6m, 1y)")
|
||||||
cmd.Flags().BoolVar(&opts.Force, "force", false, "Skip confirmation prompt")
|
cmd.Flags().BoolVar(&force, "force", false, "Skip confirmation prompt")
|
||||||
cmd.Flags().StringVar(&opts.Name, "name", "", "Filter purge to a specific snapshot name")
|
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -79,21 +79,6 @@ func parseSnapshotTimestamp(snapshotID string) (time.Time, error) {
|
|||||||
return timestamp.UTC(), nil
|
return timestamp.UTC(), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseSnapshotName extracts the snapshot name from a snapshot ID.
|
|
||||||
// Format: hostname_snapshotname_timestamp (3 parts) or hostname_timestamp (2 parts, no name).
|
|
||||||
// Returns the snapshot name, or empty string if no name component is present.
|
|
||||||
func parseSnapshotName(snapshotID string) string {
|
|
||||||
parts := strings.Split(snapshotID, "_")
|
|
||||||
if len(parts) < 3 {
|
|
||||||
// Format: hostname_timestamp — no snapshot name
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
// Format: hostname_name_timestamp — middle parts are the name.
|
|
||||||
// The last part is the RFC3339 timestamp, the first part is the hostname,
|
|
||||||
// everything in between is the snapshot name (which may itself contain underscores).
|
|
||||||
return strings.Join(parts[1:len(parts)-1], "_")
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseDuration parses a duration string with support for days
|
// parseDuration parses a duration string with support for days
|
||||||
func parseDuration(s string) (time.Duration, error) {
|
func parseDuration(s string) (time.Duration, error) {
|
||||||
// Check for days suffix
|
// Check for days suffix
|
||||||
|
|||||||
@@ -1,119 +0,0 @@
|
|||||||
package vaultik
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestParseSnapshotName(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
snapshotID string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "standard format with name",
|
|
||||||
snapshotID: "myhost_home_2026-01-12T14:41:15Z",
|
|
||||||
want: "home",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "standard format with different name",
|
|
||||||
snapshotID: "server1_system_2026-02-15T09:30:00Z",
|
|
||||||
want: "system",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "no snapshot name (legacy format)",
|
|
||||||
snapshotID: "myhost_2026-01-12T14:41:15Z",
|
|
||||||
want: "",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "name with underscores",
|
|
||||||
snapshotID: "myhost_my_special_backup_2026-03-01T00:00:00Z",
|
|
||||||
want: "my_special_backup",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "single part (edge case)",
|
|
||||||
snapshotID: "nounderscore",
|
|
||||||
want: "",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "empty string",
|
|
||||||
snapshotID: "",
|
|
||||||
want: "",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
got := parseSnapshotName(tt.snapshotID)
|
|
||||||
if got != tt.want {
|
|
||||||
t.Errorf("parseSnapshotName(%q) = %q, want %q", tt.snapshotID, got, tt.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseSnapshotTimestamp(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
snapshotID string
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "valid with name",
|
|
||||||
snapshotID: "myhost_home_2026-01-12T14:41:15Z",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid without name",
|
|
||||||
snapshotID: "myhost_2026-01-12T14:41:15Z",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "invalid - single part",
|
|
||||||
snapshotID: "nounderscore",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "invalid - bad timestamp",
|
|
||||||
snapshotID: "myhost_home_notadate",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
_, err := parseSnapshotTimestamp(tt.snapshotID)
|
|
||||||
if (err != nil) != tt.wantErr {
|
|
||||||
t.Errorf("parseSnapshotTimestamp(%q) error = %v, wantErr %v", tt.snapshotID, err, tt.wantErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSnapshotPurgeOptions(t *testing.T) {
|
|
||||||
opts := &SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Name: "home",
|
|
||||||
Force: true,
|
|
||||||
}
|
|
||||||
if !opts.KeepLatest {
|
|
||||||
t.Error("Expected KeepLatest to be true")
|
|
||||||
}
|
|
||||||
if opts.Name != "home" {
|
|
||||||
t.Errorf("Expected Name to be 'home', got %q", opts.Name)
|
|
||||||
}
|
|
||||||
if !opts.Force {
|
|
||||||
t.Error("Expected Force to be true")
|
|
||||||
}
|
|
||||||
|
|
||||||
opts2 := &SnapshotPurgeOptions{
|
|
||||||
OlderThan: "30d",
|
|
||||||
Name: "system",
|
|
||||||
}
|
|
||||||
if opts2.OlderThan != "30d" {
|
|
||||||
t.Errorf("Expected OlderThan to be '30d', got %q", opts2.OlderThan)
|
|
||||||
}
|
|
||||||
if opts2.Name != "system" {
|
|
||||||
t.Errorf("Expected Name to be 'system', got %q", opts2.Name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,303 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"database/sql"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/database"
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/log"
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/types"
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/vaultik"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// setupPurgeTest creates a Vaultik instance with an in-memory database and mock
|
|
||||||
// storage pre-populated with the given snapshot IDs. Each snapshot is marked as
|
|
||||||
// completed. Remote metadata stubs are created so syncWithRemote keeps them.
|
|
||||||
func setupPurgeTest(t *testing.T, snapshotIDs []string) *vaultik.Vaultik {
|
|
||||||
t.Helper()
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
db, err := database.New(ctx, ":memory:")
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
mockStorage := NewMockStorer()
|
|
||||||
|
|
||||||
// Insert each snapshot into the DB and create remote metadata stubs.
|
|
||||||
// Use timestamps parsed from snapshot IDs for realistic ordering.
|
|
||||||
for _, id := range snapshotIDs {
|
|
||||||
// Parse timestamp from the snapshot ID
|
|
||||||
parts := strings.Split(id, "_")
|
|
||||||
timestampStr := parts[len(parts)-1]
|
|
||||||
startedAt, err := time.Parse(time.RFC3339, timestampStr)
|
|
||||||
require.NoError(t, err, "parsing timestamp from snapshot ID %q", id)
|
|
||||||
|
|
||||||
completedAt := startedAt.Add(5 * time.Minute)
|
|
||||||
snap := &database.Snapshot{
|
|
||||||
ID: types.SnapshotID(id),
|
|
||||||
Hostname: "testhost",
|
|
||||||
VaultikVersion: "test",
|
|
||||||
StartedAt: startedAt,
|
|
||||||
CompletedAt: &completedAt,
|
|
||||||
}
|
|
||||||
err = repos.WithTx(ctx, func(ctx context.Context, tx *sql.Tx) error {
|
|
||||||
return repos.Snapshots.Create(ctx, tx, snap)
|
|
||||||
})
|
|
||||||
require.NoError(t, err, "creating snapshot %s", id)
|
|
||||||
|
|
||||||
// Create remote metadata stub so syncWithRemote keeps it
|
|
||||||
metadataKey := "metadata/" + id + "/manifest.json.zst"
|
|
||||||
err = mockStorage.Put(ctx, metadataKey, strings.NewReader("stub"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
stdout := &bytes.Buffer{}
|
|
||||||
stderr := &bytes.Buffer{}
|
|
||||||
stdin := &bytes.Buffer{}
|
|
||||||
|
|
||||||
v := &vaultik.Vaultik{
|
|
||||||
Storage: mockStorage,
|
|
||||||
Repositories: repos,
|
|
||||||
DB: db,
|
|
||||||
Stdout: stdout,
|
|
||||||
Stderr: stderr,
|
|
||||||
Stdin: stdin,
|
|
||||||
}
|
|
||||||
v.SetContext(ctx)
|
|
||||||
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// listRemainingSnapshots returns IDs of all completed snapshots in the database.
|
|
||||||
func listRemainingSnapshots(t *testing.T, v *vaultik.Vaultik) []string {
|
|
||||||
t.Helper()
|
|
||||||
ctx := context.Background()
|
|
||||||
dbSnaps, err := v.Repositories.Snapshots.ListRecent(ctx, 10000)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
var ids []string
|
|
||||||
for _, s := range dbSnaps {
|
|
||||||
if s.CompletedAt != nil {
|
|
||||||
ids = append(ids, s.ID.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return ids
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_PerName(t *testing.T) {
|
|
||||||
// Create snapshots for two different names: "home" and "system".
|
|
||||||
// With per-name --keep-latest, the latest of each should be kept.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_system_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T02:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T03:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T04:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
|
|
||||||
// Should keep the latest of each name
|
|
||||||
assert.Len(t, remaining, 2, "should keep exactly 2 snapshots (one per name)")
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2026-01-01T04:00:00Z", "should keep latest system")
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T03:00:00Z", "should keep latest home")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_SingleName(t *testing.T) {
|
|
||||||
// All snapshots have the same name — keep-latest should keep exactly one.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_home_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T02:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
assert.Len(t, remaining, 1)
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T02:00:00Z", "should keep the newest")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_WithNameFilter(t *testing.T) {
|
|
||||||
// Use --name to filter purge to only "home" snapshots.
|
|
||||||
// "system" snapshots should be untouched.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_system_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T02:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T03:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T04:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
Name: "home",
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
|
|
||||||
// 2 system snapshots untouched + 1 latest home = 3
|
|
||||||
assert.Len(t, remaining, 3)
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2026-01-01T00:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2026-01-01T02:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T04:00:00Z")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_NoSnapshots(t *testing.T) {
|
|
||||||
v := setupPurgeTest(t, nil)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_NameFilterNoMatch(t *testing.T) {
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_system_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T01:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
Name: "nonexistent",
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// All snapshots should remain — the name filter matched nothing
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
assert.Len(t, remaining, 2)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeOlderThan_WithNameFilter(t *testing.T) {
|
|
||||||
// Snapshots with different names and timestamps.
|
|
||||||
// --older-than should apply only to the named subset when --name is used.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_system_2020-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2020-01-01T00:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T00:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
// Purge only "home" snapshots older than 365 days
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
OlderThan: "365d",
|
|
||||||
Force: true,
|
|
||||||
Name: "home",
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
|
|
||||||
// Old system stays (not filtered by name), old home deleted, recent ones stay
|
|
||||||
assert.Len(t, remaining, 3)
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2020-01-01T00:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2026-01-01T00:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T00:00:00Z")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_LegacyNoNameSnapshots(t *testing.T) {
|
|
||||||
// Legacy snapshots without a name component (hostname_timestamp).
|
|
||||||
// Should be grouped together under empty-name.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_2026-01-01T02:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
assert.Len(t, remaining, 1)
|
|
||||||
assert.Contains(t, remaining, "testhost_2026-01-01T02:00:00Z")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_MixedNamedAndLegacy(t *testing.T) {
|
|
||||||
// Mix of named snapshots and legacy ones (no name).
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_2026-01-01T02:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T03:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
|
|
||||||
// Should keep latest of each group: latest legacy + latest home
|
|
||||||
assert.Len(t, remaining, 2)
|
|
||||||
assert.Contains(t, remaining, "testhost_2026-01-01T02:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T03:00:00Z")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPurgeKeepLatest_ThreeNames(t *testing.T) {
|
|
||||||
// Three different snapshot names with multiple snapshots each.
|
|
||||||
snapshotIDs := []string{
|
|
||||||
"testhost_home_2026-01-01T00:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T01:00:00Z",
|
|
||||||
"testhost_media_2026-01-01T02:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T03:00:00Z",
|
|
||||||
"testhost_system_2026-01-01T04:00:00Z",
|
|
||||||
"testhost_media_2026-01-01T05:00:00Z",
|
|
||||||
"testhost_home_2026-01-01T06:00:00Z",
|
|
||||||
}
|
|
||||||
|
|
||||||
v := setupPurgeTest(t, snapshotIDs)
|
|
||||||
|
|
||||||
err := v.PurgeSnapshotsWithOptions(&vaultik.SnapshotPurgeOptions{
|
|
||||||
KeepLatest: true,
|
|
||||||
Force: true,
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
remaining := listRemainingSnapshots(t, v)
|
|
||||||
assert.Len(t, remaining, 3, "should keep one per name")
|
|
||||||
assert.Contains(t, remaining, "testhost_home_2026-01-01T06:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_system_2026-01-01T04:00:00Z")
|
|
||||||
assert.Contains(t, remaining, "testhost_media_2026-01-01T05:00:00Z")
|
|
||||||
}
|
|
||||||
@@ -22,13 +22,6 @@ import (
|
|||||||
"golang.org/x/term"
|
"golang.org/x/term"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
// progressBarWidth is the character width of the progress bar display.
|
|
||||||
progressBarWidth = 40
|
|
||||||
// progressBarThrottle is the minimum interval between progress bar redraws.
|
|
||||||
progressBarThrottle = 100 * time.Millisecond
|
|
||||||
)
|
|
||||||
|
|
||||||
// RestoreOptions contains options for the restore operation
|
// RestoreOptions contains options for the restore operation
|
||||||
type RestoreOptions struct {
|
type RestoreOptions struct {
|
||||||
SnapshotID string
|
SnapshotID string
|
||||||
@@ -122,15 +115,6 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
defer func() { _ = blobCache.Close() }()
|
defer func() { _ = blobCache.Close() }()
|
||||||
|
|
||||||
// Calculate total bytes for progress bar
|
|
||||||
var totalBytesExpected int64
|
|
||||||
for _, file := range files {
|
|
||||||
totalBytesExpected += file.Size
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create progress bar if output is a terminal
|
|
||||||
bar := v.newProgressBar("Restoring", totalBytesExpected)
|
|
||||||
|
|
||||||
for i, file := range files {
|
for i, file := range files {
|
||||||
if v.ctx.Err() != nil {
|
if v.ctx.Err() != nil {
|
||||||
return v.ctx.Err()
|
return v.ctx.Err()
|
||||||
@@ -138,21 +122,11 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
|
|
||||||
if err := v.restoreFile(v.ctx, repos, file, opts.TargetDir, identity, chunkToBlobMap, blobCache, result); err != nil {
|
if err := v.restoreFile(v.ctx, repos, file, opts.TargetDir, identity, chunkToBlobMap, blobCache, result); err != nil {
|
||||||
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
||||||
result.FilesFailed++
|
// Continue with other files
|
||||||
result.FailedFiles = append(result.FailedFiles, file.Path.String())
|
|
||||||
// Update progress bar even on failure
|
|
||||||
if bar != nil {
|
|
||||||
_ = bar.Add64(file.Size)
|
|
||||||
}
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Update progress bar
|
// Progress logging
|
||||||
if bar != nil {
|
|
||||||
_ = bar.Add64(file.Size)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Progress logging (for non-terminal or structured logs)
|
|
||||||
if (i+1)%100 == 0 || i+1 == len(files) {
|
if (i+1)%100 == 0 || i+1 == len(files) {
|
||||||
log.Info("Restore progress",
|
log.Info("Restore progress",
|
||||||
"files", fmt.Sprintf("%d/%d", i+1, len(files)),
|
"files", fmt.Sprintf("%d/%d", i+1, len(files)),
|
||||||
@@ -161,10 +135,6 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if bar != nil {
|
|
||||||
_ = bar.Finish()
|
|
||||||
}
|
|
||||||
|
|
||||||
result.Duration = time.Since(startTime)
|
result.Duration = time.Since(startTime)
|
||||||
|
|
||||||
log.Info("Restore complete",
|
log.Info("Restore complete",
|
||||||
@@ -181,13 +151,6 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
result.Duration.Round(time.Second),
|
result.Duration.Round(time.Second),
|
||||||
)
|
)
|
||||||
|
|
||||||
if result.FilesFailed > 0 {
|
|
||||||
_, _ = fmt.Fprintf(v.Stdout, "\nWARNING: %d file(s) failed to restore:\n", result.FilesFailed)
|
|
||||||
for _, path := range result.FailedFiles {
|
|
||||||
_, _ = fmt.Fprintf(v.Stdout, " - %s\n", path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run verification if requested
|
// Run verification if requested
|
||||||
if opts.Verify {
|
if opts.Verify {
|
||||||
if err := v.verifyRestoredFiles(v.ctx, repos, files, opts.TargetDir, result); err != nil {
|
if err := v.verifyRestoredFiles(v.ctx, repos, files, opts.TargetDir, result); err != nil {
|
||||||
@@ -208,10 +171,6 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if result.FilesFailed > 0 {
|
|
||||||
return fmt.Errorf("%d file(s) failed to restore", result.FilesFailed)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -564,7 +523,22 @@ func (v *Vaultik) verifyRestoredFiles(
|
|||||||
)
|
)
|
||||||
|
|
||||||
// Create progress bar if output is a terminal
|
// Create progress bar if output is a terminal
|
||||||
bar := v.newProgressBar("Verifying", totalBytes)
|
var bar *progressbar.ProgressBar
|
||||||
|
if isTerminal() {
|
||||||
|
bar = progressbar.NewOptions64(
|
||||||
|
totalBytes,
|
||||||
|
progressbar.OptionSetDescription("Verifying"),
|
||||||
|
progressbar.OptionSetWriter(v.Stderr),
|
||||||
|
progressbar.OptionShowBytes(true),
|
||||||
|
progressbar.OptionShowCount(),
|
||||||
|
progressbar.OptionSetWidth(40),
|
||||||
|
progressbar.OptionThrottle(100*time.Millisecond),
|
||||||
|
progressbar.OptionOnCompletion(func() {
|
||||||
|
v.printfStderr("\n")
|
||||||
|
}),
|
||||||
|
progressbar.OptionSetRenderBlankState(true),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// Verify each file
|
// Verify each file
|
||||||
for _, file := range regularFiles {
|
for _, file := range regularFiles {
|
||||||
@@ -658,37 +632,7 @@ func (v *Vaultik) verifyFile(
|
|||||||
return bytesVerified, nil
|
return bytesVerified, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// newProgressBar creates a terminal-aware progress bar with standard options.
|
// isTerminal returns true if stdout is a terminal
|
||||||
// It returns nil if stdout is not a terminal.
|
func isTerminal() bool {
|
||||||
func (v *Vaultik) newProgressBar(description string, total int64) *progressbar.ProgressBar {
|
return term.IsTerminal(int(os.Stdout.Fd()))
|
||||||
if !v.isTerminal() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return progressbar.NewOptions64(
|
|
||||||
total,
|
|
||||||
progressbar.OptionSetDescription(description),
|
|
||||||
progressbar.OptionSetWriter(v.Stderr),
|
|
||||||
progressbar.OptionShowBytes(true),
|
|
||||||
progressbar.OptionShowCount(),
|
|
||||||
progressbar.OptionSetWidth(progressBarWidth),
|
|
||||||
progressbar.OptionThrottle(progressBarThrottle),
|
|
||||||
progressbar.OptionOnCompletion(func() {
|
|
||||||
v.printfStderr("\n")
|
|
||||||
}),
|
|
||||||
progressbar.OptionSetRenderBlankState(true),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// isTerminal returns true if stdout is a terminal.
|
|
||||||
// It checks whether v.Stdout implements Fd() (i.e. is an *os.File),
|
|
||||||
// and falls back to false for non-file writers (e.g. in tests).
|
|
||||||
func (v *Vaultik) isTerminal() bool {
|
|
||||||
type fder interface {
|
|
||||||
Fd() uintptr
|
|
||||||
}
|
|
||||||
f, ok := v.Stdout.(fder)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return term.IsTerminal(int(f.Fd()))
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"regexp"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"text/tabwriter"
|
"text/tabwriter"
|
||||||
@@ -90,24 +89,6 @@ func (v *Vaultik) CreateSnapshot(opts *SnapshotCreateOptions) error {
|
|||||||
v.printfStdout("\nAll %d snapshots completed in %s\n", len(snapshotNames), time.Since(overallStartTime).Round(time.Second))
|
v.printfStdout("\nAll %d snapshots completed in %s\n", len(snapshotNames), time.Since(overallStartTime).Round(time.Second))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Prune old snapshots and unreferenced blobs if --prune was specified
|
|
||||||
if opts.Prune {
|
|
||||||
log.Info("Pruning enabled - deleting old snapshots and unreferenced blobs")
|
|
||||||
v.printlnStdout("\nPruning old snapshots (keeping latest)...")
|
|
||||||
|
|
||||||
if err := v.PurgeSnapshots(true, "", true); err != nil {
|
|
||||||
return fmt.Errorf("prune: purging old snapshots: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
v.printlnStdout("Pruning unreferenced blobs...")
|
|
||||||
|
|
||||||
if err := v.PruneBlobs(&PruneOptions{Force: true}); err != nil {
|
|
||||||
return fmt.Errorf("prune: removing unreferenced blobs: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Info("Pruning complete")
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -324,6 +305,11 @@ func (v *Vaultik) createNamedSnapshot(opts *SnapshotCreateOptions, hostname, sna
|
|||||||
}
|
}
|
||||||
v.printfStdout("Duration: %s\n", formatDuration(snapshotDuration))
|
v.printfStdout("Duration: %s\n", formatDuration(snapshotDuration))
|
||||||
|
|
||||||
|
if opts.Prune {
|
||||||
|
log.Info("Pruning enabled - will delete old snapshots after snapshot")
|
||||||
|
// TODO: Implement pruning
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -488,30 +474,8 @@ func (v *Vaultik) ListSnapshots(jsonOutput bool) error {
|
|||||||
return w.Flush()
|
return w.Flush()
|
||||||
}
|
}
|
||||||
|
|
||||||
// SnapshotPurgeOptions contains options for the snapshot purge command
|
// PurgeSnapshots removes old snapshots based on criteria
|
||||||
type SnapshotPurgeOptions struct {
|
|
||||||
KeepLatest bool
|
|
||||||
OlderThan string
|
|
||||||
Force bool
|
|
||||||
Name string // Filter purge to a specific snapshot name
|
|
||||||
}
|
|
||||||
|
|
||||||
// PurgeSnapshots removes old snapshots based on criteria.
|
|
||||||
// When keepLatest is true, retention is applied per snapshot name — the latest
|
|
||||||
// snapshot for each distinct name is kept.
|
|
||||||
func (v *Vaultik) PurgeSnapshots(keepLatest bool, olderThan string, force bool) error {
|
func (v *Vaultik) PurgeSnapshots(keepLatest bool, olderThan string, force bool) error {
|
||||||
return v.PurgeSnapshotsWithOptions(&SnapshotPurgeOptions{
|
|
||||||
KeepLatest: keepLatest,
|
|
||||||
OlderThan: olderThan,
|
|
||||||
Force: force,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// PurgeSnapshotsWithOptions removes old snapshots based on criteria with full options.
|
|
||||||
// When KeepLatest is true, retention is applied per snapshot name — the latest
|
|
||||||
// snapshot for each distinct name is kept. If Name is non-empty, only snapshots
|
|
||||||
// matching that name are considered for purge.
|
|
||||||
func (v *Vaultik) PurgeSnapshotsWithOptions(opts *SnapshotPurgeOptions) error {
|
|
||||||
// Sync with remote first
|
// Sync with remote first
|
||||||
if err := v.syncWithRemote(); err != nil {
|
if err := v.syncWithRemote(); err != nil {
|
||||||
return fmt.Errorf("syncing with remote: %w", err)
|
return fmt.Errorf("syncing with remote: %w", err)
|
||||||
@@ -535,17 +499,6 @@ func (v *Vaultik) PurgeSnapshotsWithOptions(opts *SnapshotPurgeOptions) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// If --name is specified, filter to only snapshots matching that name
|
|
||||||
if opts.Name != "" {
|
|
||||||
filtered := make([]SnapshotInfo, 0, len(snapshots))
|
|
||||||
for _, snap := range snapshots {
|
|
||||||
if parseSnapshotName(snap.ID.String()) == opts.Name {
|
|
||||||
filtered = append(filtered, snap)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
snapshots = filtered
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sort by timestamp (newest first)
|
// Sort by timestamp (newest first)
|
||||||
sort.Slice(snapshots, func(i, j int) bool {
|
sort.Slice(snapshots, func(i, j int) bool {
|
||||||
return snapshots[i].Timestamp.After(snapshots[j].Timestamp)
|
return snapshots[i].Timestamp.After(snapshots[j].Timestamp)
|
||||||
@@ -553,23 +506,14 @@ func (v *Vaultik) PurgeSnapshotsWithOptions(opts *SnapshotPurgeOptions) error {
|
|||||||
|
|
||||||
var toDelete []SnapshotInfo
|
var toDelete []SnapshotInfo
|
||||||
|
|
||||||
if opts.KeepLatest {
|
if keepLatest {
|
||||||
// Keep the latest snapshot per snapshot name
|
// Keep only the most recent snapshot
|
||||||
// Group snapshots by name, then mark all but the newest in each group
|
if len(snapshots) > 1 {
|
||||||
latestByName := make(map[string]bool) // tracks whether we've seen the latest for each name
|
toDelete = snapshots[1:]
|
||||||
for _, snap := range snapshots {
|
|
||||||
name := parseSnapshotName(snap.ID.String())
|
|
||||||
if latestByName[name] {
|
|
||||||
// Already kept the latest for this name — delete this one
|
|
||||||
toDelete = append(toDelete, snap)
|
|
||||||
} else {
|
|
||||||
// This is the latest (sorted newest-first) — keep it
|
|
||||||
latestByName[name] = true
|
|
||||||
}
|
}
|
||||||
}
|
} else if olderThan != "" {
|
||||||
} else if opts.OlderThan != "" {
|
|
||||||
// Parse duration
|
// Parse duration
|
||||||
duration, err := parseDuration(opts.OlderThan)
|
duration, err := parseDuration(olderThan)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("invalid duration: %w", err)
|
return fmt.Errorf("invalid duration: %w", err)
|
||||||
}
|
}
|
||||||
@@ -597,7 +541,7 @@ func (v *Vaultik) PurgeSnapshotsWithOptions(opts *SnapshotPurgeOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Confirm unless --force is used
|
// Confirm unless --force is used
|
||||||
if !opts.Force {
|
if !force {
|
||||||
v.printfStdout("\nDelete %d snapshot(s)? [y/N] ", len(toDelete))
|
v.printfStdout("\nDelete %d snapshot(s)? [y/N] ", len(toDelete))
|
||||||
var confirm string
|
var confirm string
|
||||||
if _, err := v.scanStdin(&confirm); err != nil {
|
if _, err := v.scanStdin(&confirm); err != nil {
|
||||||
@@ -1059,16 +1003,16 @@ func (v *Vaultik) deleteSnapshotFromLocalDB(snapshotID string) error {
|
|||||||
|
|
||||||
// Delete related records first to avoid foreign key constraints
|
// Delete related records first to avoid foreign key constraints
|
||||||
if err := v.Repositories.Snapshots.DeleteSnapshotFiles(v.ctx, snapshotID); err != nil {
|
if err := v.Repositories.Snapshots.DeleteSnapshotFiles(v.ctx, snapshotID); err != nil {
|
||||||
return fmt.Errorf("deleting snapshot files for %s: %w", snapshotID, err)
|
log.Error("Failed to delete snapshot files", "snapshot_id", snapshotID, "error", err)
|
||||||
}
|
}
|
||||||
if err := v.Repositories.Snapshots.DeleteSnapshotBlobs(v.ctx, snapshotID); err != nil {
|
if err := v.Repositories.Snapshots.DeleteSnapshotBlobs(v.ctx, snapshotID); err != nil {
|
||||||
return fmt.Errorf("deleting snapshot blobs for %s: %w", snapshotID, err)
|
log.Error("Failed to delete snapshot blobs", "snapshot_id", snapshotID, "error", err)
|
||||||
}
|
}
|
||||||
if err := v.Repositories.Snapshots.DeleteSnapshotUploads(v.ctx, snapshotID); err != nil {
|
if err := v.Repositories.Snapshots.DeleteSnapshotUploads(v.ctx, snapshotID); err != nil {
|
||||||
return fmt.Errorf("deleting snapshot uploads for %s: %w", snapshotID, err)
|
log.Error("Failed to delete snapshot uploads", "snapshot_id", snapshotID, "error", err)
|
||||||
}
|
}
|
||||||
if err := v.Repositories.Snapshots.Delete(v.ctx, snapshotID); err != nil {
|
if err := v.Repositories.Snapshots.Delete(v.ctx, snapshotID); err != nil {
|
||||||
return fmt.Errorf("deleting snapshot record %s: %w", snapshotID, err)
|
log.Error("Failed to delete snapshot record", "snapshot_id", snapshotID, "error", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -1182,18 +1126,25 @@ func (v *Vaultik) PruneDatabase() (*PruneResult, error) {
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// validTableNameRe matches table names containing only lowercase alphanumeric characters and underscores.
|
// allowedTableNames is the exhaustive whitelist of table names that may be
|
||||||
var validTableNameRe = regexp.MustCompile(`^[a-z0-9_]+$`)
|
// passed to getTableCount. Any name not in this set is rejected, preventing
|
||||||
|
// SQL injection even if caller-controlled input is accidentally supplied.
|
||||||
// getTableCount returns the count of rows in a table.
|
var allowedTableNames = map[string]struct{}{
|
||||||
// The tableName is sanitized to only allow [a-z0-9_] characters to prevent SQL injection.
|
"files": {},
|
||||||
func (v *Vaultik) getTableCount(tableName string) (int64, error) {
|
"chunks": {},
|
||||||
if v.DB == nil {
|
"blobs": {},
|
||||||
return 0, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if !validTableNameRe.MatchString(tableName) {
|
// getTableCount returns the number of rows in the given table.
|
||||||
return 0, fmt.Errorf("invalid table name: %q", tableName)
|
// tableName must appear in the allowedTableNames whitelist; all other values
|
||||||
|
// are rejected with an error, preventing SQL injection.
|
||||||
|
func (v *Vaultik) getTableCount(tableName string) (int64, error) {
|
||||||
|
if _, ok := allowedTableNames[tableName]; !ok {
|
||||||
|
return 0, fmt.Errorf("table name not allowed: %q", tableName)
|
||||||
|
}
|
||||||
|
|
||||||
|
if v.DB == nil {
|
||||||
|
return 0, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var count int64
|
var count int64
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
package vaultik
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestSnapshotCreateOptions_PruneFlag verifies the Prune field exists on
|
|
||||||
// SnapshotCreateOptions and can be set.
|
|
||||||
func TestSnapshotCreateOptions_PruneFlag(t *testing.T) {
|
|
||||||
opts := &SnapshotCreateOptions{
|
|
||||||
Prune: true,
|
|
||||||
}
|
|
||||||
if !opts.Prune {
|
|
||||||
t.Error("Expected Prune to be true")
|
|
||||||
}
|
|
||||||
|
|
||||||
opts2 := &SnapshotCreateOptions{
|
|
||||||
Prune: false,
|
|
||||||
}
|
|
||||||
if opts2.Prune {
|
|
||||||
t.Error("Expected Prune to be false")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
51
internal/vaultik/table_count_test.go
Normal file
51
internal/vaultik/table_count_test.go
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
package vaultik
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAllowedTableNames(t *testing.T) {
|
||||||
|
// Verify the whitelist contains exactly the expected tables
|
||||||
|
expected := []string{"files", "chunks", "blobs"}
|
||||||
|
assert.Len(t, allowedTableNames, len(expected))
|
||||||
|
for _, name := range expected {
|
||||||
|
_, ok := allowedTableNames[name]
|
||||||
|
assert.True(t, ok, "expected %q in allowedTableNames", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetTableCount_RejectsInvalidNames(t *testing.T) {
|
||||||
|
v := &Vaultik{} // DB is nil, but rejection happens before DB access
|
||||||
|
v.DB = nil // explicit
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
tableName string
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{"allowed files", "files", false},
|
||||||
|
{"allowed chunks", "chunks", false},
|
||||||
|
{"allowed blobs", "blobs", false},
|
||||||
|
{"sql injection attempt", "files; DROP TABLE files--", true},
|
||||||
|
{"unknown table", "users", true},
|
||||||
|
{"empty string", "", true},
|
||||||
|
{"uppercase", "FILES", true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
count, err := v.getTableCount(tt.tableName)
|
||||||
|
if tt.wantErr {
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "not allowed")
|
||||||
|
assert.Equal(t, int64(0), count)
|
||||||
|
} else {
|
||||||
|
// DB is nil so returns 0, nil for allowed names
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, int64(0), count)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user