Merge branch 'master' into ai-testing

Bumps golang from 1.24-alpine to 1.25-alpine.

---
updated-dependencies:
- dependency-name: golang
  dependency-version: 1.25-alpine
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/build.yml

@@ -1,21 +1,19 @@
-name: Main
+name: Release
 
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
 
 jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
-      - name: Set up QEMU
+      - uses: docker/setup-qemu-action@v4
-        uses: docker/setup-qemu-action@v2
+      - uses: docker/setup-buildx-action@v4
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
       - name: Docker Labels
         id: meta
-        uses: crazy-max/ghaction-docker-meta@v4
+        uses: docker/metadata-action@v6
         with:
           images: cupcakearmy/autorestic
           tags: |
@@ -23,12 +21,12 @@ jobs:
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v4
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           platforms: linux/amd64,linux/arm64
           push: true
@@ -37,10 +35,9 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
-      - uses: actions/setup-go@v3
+      - uses: jdx/mise-action@v3
-        with:
+      - run: mise run build
-          go-version: '^1.21'
       - name: Build
         run: go run build/build.go
       - name: Release

.github/workflows/ci.yml

@@ -2,23 +2,28 @@ name: CI
 on:
   pull_request:
   push:
-    branches: [master]
+    branches:
+      - main
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  MISE_EXPERIMENTAL: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
-      - uses: actions/setup-go@v3
+      - uses: jdx/mise-action@v3
-        with:
+      - run: mise run test
-          go-version: '^1.21'
-      - run: go test -v ./...
 
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
-      - uses: actions/setup-go@v3
+      - uses: jdx/mise-action@v3
-        with:
+      - run: mise run build
-          go-version: '^1.21'
-      - run: go build -v .

.gitignore

@@ -9,4 +9,5 @@
 test
 autorestic
 data
-dist
+dist
+coverage*

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.24-alpine as builder
+FROM golang:1.25-alpine as builder
 
 WORKDIR /app
 COPY go.* .

cmd/backup.go

@@ -18,9 +18,11 @@ var backupCmd = &cobra.Command{
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()
+		dry, _ := cmd.Flags().GetBool("dry-run")
 
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)
+
 		errors := 0
 		for _, name := range selected {
 			var splitted = strings.Split(name, "@")
@@ -29,7 +31,7 @@ var backupCmd = &cobra.Command{
 				specificBackend = splitted[1]
 			}
 			location, _ := internal.GetLocation(splitted[0])
-			errs := location.Backup(false, specificBackend)
+			errs := location.Backup(false, dry, specificBackend)
 			for _, err := range errs {
 				colors.Error.Printf("%s\n\n", err)
 				errors++
@@ -44,4 +46,5 @@ var backupCmd = &cobra.Command{
 func init() {
 	rootCmd.AddCommand(backupCmd)
 	internal.AddFlagsToCommand(backupCmd, false)
+	backupCmd.Flags().Bool("dry-run", false, "do not write changes, show what would be affected")
 }

docs/.nvmrc

@@ -1 +1 @@
-v22.7.0
+v24

docs/mise.toml

@@ -0,0 +1,2 @@
+[settings]
+idiomatic_version_file_enable_tools = ["node", "pnpm"]

docs/package.json

@@ -5,11 +5,11 @@
     "start": "NEXT_TELEMETRY_DISABLED=1 next start"
   },
   "dependencies": {
-    "next": "^14.2.7",
+    "next": "^14.2.35",
     "nextra": "^2.13.4",
     "nextra-theme-docs": "^2.13.4",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
-  "packageManager": "pnpm@9.9.0"
+  "packageManager": "pnpm@10.33.0"
 }

docs/pages/cli/backup.md

@@ -1,11 +1,14 @@
 # Backup
 
 ```bash
-autorestic backup [-l, --location] [-a, --all]
+autorestic backup [-l, --location] [-a, --all] [--dry-run]
 ```
 
 Performs a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
 
+The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
+
+
 ```bash
 # All
 autorestic backup -a

go.mod

@@ -1,6 +1,6 @@
 module github.com/cupcakearmy/autorestic
 
-go 1.21
+go 1.26.1
 
 require (
 	github.com/blang/semver/v4 v4.0.0

internal/config.go

@@ -188,15 +188,31 @@ func CheckConfig() error {
 	if !CheckIfResticIsCallable() {
 		return fmt.Errorf(`%s was not found. Install either with "autorestic install" or manually`, flags.RESTIC_BIN)
 	}
-	for name, backend := range c.Backends {
+
-		backend.name = name
+	cwd, _ := GetPathRelativeToConfig(".")
-		if err := backend.validate(); err != nil {
+	for name, location := range c.Locations {
+		location.name = name
+
+		// Hooks before location validation
+		options := ExecuteOptions{
+			Command: "bash",
+			Dir:     cwd,
+			Envs: map[string]string{
+				"AUTORESTIC_LOCATION": location.name,
+			},
+		}
+		if err := location.ExecuteHooks(location.Hooks.PreValidate, options); err != nil {
+			return err
+		}
+
+		if err := location.validate(); err != nil {
 			return err
 		}
 	}
-	for name, location := range c.Locations {
+
-		location.name = name
+	for name, backend := range c.Backends {
-		if err := location.validate(); err != nil {
+		backend.name = name
+		if err := backend.validate(); err != nil {
 			return err
 		}
 	}

internal/location.go

@@ -168,7 +168,7 @@ func (l Location) getLocationTags() string {
 	return buildTag("location", l.name)
 }
 
-func (l Location) Backup(cron bool, specificBackend string) []error {
+func (l Location) Backup(cron bool, dry bool, specificBackend string) []error {
 	var errors []error
 	var backends []string
 	colors.PrimaryPrint("  Backing up location \"%s\"  ", l.name)
@@ -228,6 +228,9 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		if cron {
 			cmd = append(cmd, "--tag", buildTag("cron"))
 		}
+		if dry {
+			cmd = append(cmd, "--dry-run")
+		}
 		cmd = append(cmd, "--tag", l.getLocationTags())
 		backupOptions := ExecuteOptions{
 			Envs: env,
@@ -447,7 +450,7 @@ func (l Location) RunCron() error {
 	now := time.Now()
 	if now.After(next) {
 		lock.SetCron(l.name, now.Unix())
-		errs := l.Backup(true, "")
+		errs := l.Backup(true, false, "")
 		if len(errs) > 0 {
 			return fmt.Errorf("Failed to backup location \"%s\":\n%w", l.name, errors.Join(errs...))
 		}

internal/location_test.go

@@ -1,6 +1,14 @@
 package internal
 
-import "testing"
+import (
+	"os"
+	"path"
+	"sync"
+	"testing"
+
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
+)
 
 func TestGetType(t *testing.T) {
 
@@ -91,3 +99,46 @@ func TestBuildRestoreCommand(t *testing.T) {
 	expected := []string{"restore", "--target", "to", "--tag", "ar:location:foo", "snapshot", "options"}
 	assertSliceEqual(t, result, expected)
 }
+
+func TestLocationBackupWithMock(t *testing.T) {
+	// Backup original
+	originalExecutor := DefaultExecutor
+	defer func() { DefaultExecutor = originalExecutor }()
+
+	// Inject mock
+	mock := &MockExecutor{
+		ExecuteResticFunc: func(options ExecuteOptions, args ...string) (int, string, error) {
+			assert.Equal(t, "backup", args[0])
+			return 0, "success", nil
+		},
+	}
+	DefaultExecutor = mock
+
+	// Setup dummy config
+	workDir := t.TempDir()
+	configFile := path.Join(workDir, ".autorestic.yml")
+	err := os.WriteFile(configFile, []byte("version: 2"), 0644)
+	assert.NoError(t, err)
+
+	viper.Reset()
+	viper.SetConfigFile(configFile)
+	viper.Set("version", 2)
+	// Register test-backend
+	viper.Set("backends.test-backend.type", "local")
+	viper.Set("backends.test-backend.path", workDir)
+
+	config = nil
+	once = sync.Once{}
+
+	loc := Location{
+		name: "test-location",
+		To:   []string{"test-backend"},
+		From: []string{"/"},
+		Type: "local",
+	}
+
+	errs := loc.Backup(false, false, "")
+	if len(errs) != 0 {
+		t.Errorf("expected no error, got %v", errs)
+	}
+}

internal/mock_executor_test.go

@@ -0,0 +1,20 @@
+package internal
+
+type MockExecutor struct {
+	ExecuteFunc       func(options ExecuteOptions, args ...string) (int, string, error)
+	ExecuteResticFunc func(options ExecuteOptions, args ...string) (int, string, error)
+}
+
+func (m *MockExecutor) Execute(options ExecuteOptions, args ...string) (int, string, error) {
+	if m.ExecuteFunc != nil {
+		return m.ExecuteFunc(options, args...)
+	}
+	return 0, "", nil
+}
+
+func (m *MockExecutor) ExecuteRestic(options ExecuteOptions, args ...string) (int, string, error) {
+	if m.ExecuteResticFunc != nil {
+		return m.ExecuteResticFunc(options, args...)
+	}
+	return 0, "", nil
+}

internal/utils.go

@@ -39,7 +39,14 @@ func (w ColoredWriter) Write(p []byte) (n int, err error) {
 	return len(p), nil
 }
 
-func ExecuteCommand(options ExecuteOptions, args ...string) (int, string, error) {
+type Executor interface {
+	Execute(options ExecuteOptions, args ...string) (int, string, error)
+	ExecuteRestic(options ExecuteOptions, args ...string) (int, string, error)
+}
+
+type RealExecutor struct{}
+
+func (e *RealExecutor) Execute(options ExecuteOptions, args ...string) (int, string, error) {
 	cmd := exec.Command(options.Command, args...)
 	env := os.Environ()
 	for k, v := range options.Envs {
@@ -76,12 +83,22 @@ func ExecuteCommand(options ExecuteOptions, args ...string) (int, string, error)
 	return 0, out.String(), nil
 }
 
-func ExecuteResticCommand(options ExecuteOptions, args ...string) (int, string, error) {
+func (e *RealExecutor) ExecuteRestic(options ExecuteOptions, args ...string) (int, string, error) {
 	options.Command = flags.RESTIC_BIN
 	var c = GetConfig()
 	var optionsAsString = getOptions(c.Global, []string{"all"})
 	args = append(optionsAsString, args...)
-	return ExecuteCommand(options, args...)
+	return e.Execute(options, args...)
+}
+
+var DefaultExecutor Executor = &RealExecutor{}
+
+func ExecuteCommand(options ExecuteOptions, args ...string) (int, string, error) {
+	return DefaultExecutor.Execute(options, args...)
+}
+
+func ExecuteResticCommand(options ExecuteOptions, args ...string) (int, string, error) {
+	return DefaultExecutor.ExecuteRestic(options, args...)
 }
 
 func CopyFile(from, to string) error {

internal/utils_test.go

@@ -0,0 +1,27 @@
+package internal
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestExecuteCommandWithMock(t *testing.T) {
+	// Backup original
+	originalExecutor := DefaultExecutor
+	defer func() { DefaultExecutor = originalExecutor }()
+
+	// Inject mock
+	mock := &MockExecutor{
+		ExecuteFunc: func(options ExecuteOptions, args ...string) (int, string, error) {
+			assert.Equal(t, "docker", options.Command)
+			return 0, "mock output", nil
+		},
+	}
+	DefaultExecutor = mock
+
+	code, out, err := ExecuteCommand(ExecuteOptions{Command: "docker"}, "info")
+
+	assert.NoError(t, err)
+	assert.Equal(t, 0, code)
+	assert.Equal(t, "mock output", out)
+}

mise.toml

@@ -0,0 +1,14 @@
+[tools]
+go = "latest"
+restic = "latest"
+
+[tasks]
+build = { description = "Build the project", run = "go build -v ." }
+
+test = { description = "Run tests", run = "go test -v ./..." }
+
+coverage = { description = "Generate coverage report", run = "go test -coverprofile=coverage.out ./... && go tool cover -func=coverage.out && go tool cover -html=coverage.out -o coverage.html", depends = [
+  "test"
+] }
+
+clean = { run = "rm -f coverage.*", description = "Clean up coverage files" }

tests/integration_test.go

@@ -0,0 +1,280 @@
+package integration_test
+
+import (
+	"os"
+	"os/exec"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func runAutorestic(t *testing.T, dir string, configPath string, args ...string) string {
+	// Find project root dynamically
+	wd, err := os.Getwd()
+	assert.NoError(t, err)
+	root := filepath.Dir(wd)
+
+	mainGo := filepath.Join(root, "main.go")
+
+	// Get restic path from mise
+	resticPath := "/Users/cupcakearmy/.local/share/mise/installs/restic/0.18.1/restic"
+
+	// Convert configPath to absolute path
+	absConfigPath, err := filepath.Abs(configPath)
+	assert.NoError(t, err)
+
+	cmd := exec.Command("go", append([]string{"run", mainGo, "--restic-bin", resticPath, "-c", absConfigPath}, args...)...)
+
+	// Run from root to find go.mod
+	cmd.Dir = root
+
+	// Add mise path to environment and set dummy password
+	cmd.Env = os.Environ()
+	cmd.Env = append(cmd.Env, "PATH="+os.Getenv("PATH"))
+	cmd.Env = append(cmd.Env, "RESTIC_PASSWORD=password")
+
+	output, err := cmd.CombinedOutput()
+	// NOTE: We don't assert NoError here because tests might expect failures
+	return string(output)
+}
+
+func initRepo(t *testing.T, repoPath string) {
+	resticPath := "/Users/cupcakearmy/.local/share/mise/installs/restic/0.18.1/restic"
+	cmd := exec.Command(resticPath, "-r", repoPath, "init")
+	cmd.Env = append(os.Environ(), "RESTIC_PASSWORD=password")
+	output, err := cmd.CombinedOutput()
+	assert.NoError(t, err, string(output))
+}
+
+func TestAutoresticCheck(t *testing.T) {
+	tempDir := t.TempDir()
+
+	configContent := `
+version: 2
+locations:
+  my-data:
+    from: ` + tempDir + `
+    to: local
+backends:
+  local:
+    type: local
+    path: ` + filepath.Join(tempDir, "repo") + `
+    key: password
+`
+	configPath := filepath.Join(tempDir, "autorestic.yml")
+	err := os.WriteFile(configPath, []byte(configContent), 0644)
+	assert.NoError(t, err)
+
+	_ = runAutorestic(t, tempDir, configPath, "check")
+}
+
+func TestBackupRestore(t *testing.T) {
+	tempDir := t.TempDir()
+
+	// 1. Create a source file
+	sourceFile := "source.txt"
+	err := os.WriteFile(filepath.Join(tempDir, sourceFile), []byte("hello world"), 0644)
+	assert.NoError(t, err)
+
+	repoPath := filepath.Join(tempDir, "repo")
+	initRepo(t, repoPath)
+
+	configContent := `
+version: 2
+locations:
+  my-data:
+    from: 
+      - ` + sourceFile + `
+    to: local
+backends:
+  local:
+    type: local
+    path: ` + repoPath + `
+    key: password
+`
+	configPath := filepath.Join(tempDir, "autorestic.yml")
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	assert.NoError(t, err)
+
+	// 2. Backup
+	output := runAutorestic(t, tempDir, configPath, "backup", "-l", "my-data")
+	assert.Contains(t, output, "Done")
+
+	// 3. Restore
+	restoreDir := filepath.Join(tempDir, "restore")
+	err = os.MkdirAll(restoreDir, 0755)
+	assert.NoError(t, err)
+	output = runAutorestic(t, tempDir, configPath, "restore", "-l", "my-data", "--to", restoreDir)
+	t.Logf("Restore output: %s", output)
+
+	// DEBUG: List files in restoreDir and subdirectories
+	err = filepath.Walk(restoreDir, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		t.Logf("Found: %s", path)
+		return nil
+	})
+	assert.NoError(t, err)
+
+	// 4. Verify
+	// It might be nested depending on how it was backed up
+	// Let's look for source.txt in any subdirectory
+	var restoredFile string
+	err = filepath.Walk(restoreDir, func(path string, info os.FileInfo, err error) error {
+		if !info.IsDir() && info.Name() == "source.txt" {
+			restoredFile = path
+		}
+		return nil
+	})
+	assert.NoError(t, err)
+	assert.NotEmpty(t, restoredFile, "source.txt not found")
+
+	content, err := os.ReadFile(restoredFile)
+	assert.NoError(t, err)
+	assert.Equal(t, "hello world", string(content))
+}
+
+func TestHooks(t *testing.T) {
+	tempDir := t.TempDir()
+
+	// Create a dummy file to back up
+	sourceFile := "source.txt"
+	err := os.WriteFile(filepath.Join(tempDir, sourceFile), []byte("data"), 0644)
+	assert.NoError(t, err)
+
+	repoPath := filepath.Join(tempDir, "repo")
+	initRepo(t, repoPath)
+
+	configContent := `
+version: 2
+locations:
+  my-data:
+    from: 
+      - ` + sourceFile + `
+    to: local
+    hooks:
+      before:
+        - touch before.txt
+      after:
+        - touch after.txt
+backends:
+  local:
+    type: local
+    path: ` + repoPath + `
+    key: password
+`
+	configPath := filepath.Join(tempDir, "autorestic.yml")
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	assert.NoError(t, err)
+
+	// Run backup
+	runAutorestic(t, tempDir, configPath, "backup", "-l", "my-data")
+
+	// Verify
+	assert.FileExists(t, filepath.Join(tempDir, "before.txt"))
+	assert.FileExists(t, filepath.Join(tempDir, "after.txt"))
+}
+
+func TestCopy(t *testing.T) {
+	tempDir := t.TempDir()
+
+	// Create a dummy file to back up
+	sourceFile := "source.txt"
+	err := os.WriteFile(filepath.Join(tempDir, sourceFile), []byte("data"), 0644)
+	assert.NoError(t, err)
+
+	repoPath := filepath.Join(tempDir, "repo")
+	initRepo(t, repoPath)
+
+	remoteRepoPath := filepath.Join(tempDir, "remote_repo")
+	initRepo(t, remoteRepoPath)
+
+	configContent := `
+version: 2
+locations:
+  my-data:
+    from: 
+      - ` + sourceFile + `
+    to: local
+    copy:
+      local:
+        - remote
+backends:
+  local:
+    type: local
+    path: ` + repoPath + `
+    key: password
+  remote:
+    type: local
+    path: ` + remoteRepoPath + `
+    key: password
+`
+	configPath := filepath.Join(tempDir, "autorestic.yml")
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	assert.NoError(t, err)
+
+	// Run backup
+	output := runAutorestic(t, tempDir, configPath, "backup", "-l", "my-data")
+
+	// Verify copy in output
+	assert.Contains(t, output, "Copying local → remote")
+}
+
+func TestPermissions(t *testing.T) {
+	tempDir := t.TempDir()
+
+	// 1. Create a source file with specific permissions (0600)
+	sourceFile := "source.txt"
+	sourcePath := filepath.Join(tempDir, sourceFile)
+	err := os.WriteFile(sourcePath, []byte("data"), 0600)
+	assert.NoError(t, err)
+
+	repoPath := filepath.Join(tempDir, "repo")
+	initRepo(t, repoPath)
+
+	configContent := `
+version: 2
+locations:
+  my-data:
+    from: 
+      - ` + sourceFile + `
+    to: local
+backends:
+  local:
+    type: local
+    path: ` + repoPath + `
+    key: password
+`
+	configPath := filepath.Join(tempDir, "autorestic.yml")
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	assert.NoError(t, err)
+
+	// 2. Backup
+	runAutorestic(t, tempDir, configPath, "backup", "-l", "my-data")
+
+	// 3. Restore
+	restoreDir := filepath.Join(tempDir, "restore")
+	err = os.MkdirAll(restoreDir, 0755)
+	assert.NoError(t, err)
+	runAutorestic(t, tempDir, configPath, "restore", "-l", "my-data", "--to", restoreDir)
+
+	// 4. Verify permissions
+	// Use walk to find the restored file
+	var restoredFile string
+	err = filepath.Walk(restoreDir, func(path string, info os.FileInfo, err error) error {
+		if !info.IsDir() && info.Name() == "source.txt" {
+			restoredFile = path
+		}
+		return nil
+	})
+	assert.NoError(t, err)
+	assert.NotEmpty(t, restoredFile, "source.txt not found")
+
+	info, err := os.Stat(restoredFile)
+	assert.NoError(t, err)
+
+	// Check permissions (masking only for permission bits)
+	assert.Equal(t, os.FileMode(0600), info.Mode().Perm())
+}

tests/version_test.go

@@ -0,0 +1,14 @@
+package integration_test
+
+import (
+	"github.com/stretchr/testify/assert"
+	"os/exec"
+	"testing"
+)
+
+func TestVersion(t *testing.T) {
+	cmd := exec.Command("go", "run", "../main.go", "--version")
+	out, err := cmd.CombinedOutput()
+	assert.NoError(t, err)
+	assert.Contains(t, string(out), "autorestic")
+}