Merge 0c7da11f4d into 068121d722

fix #191

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Main
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
 
 jobs:
   docker:
@@ -40,7 +40,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: '^1.21'
+          go-version: "^1.20"
       - name: Build
         run: go run build/build.go
       - name: Release

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22-alpine as builder
+FROM golang:1.20-alpine as builder
 
 WORKDIR /app
 COPY go.* .
@@ -6,8 +6,8 @@ RUN go mod download
 COPY . .
 RUN go build
 
-FROM restic/restic:0.16.4
-RUN apk add --no-cache rclone bash curl docker-cli
+FROM restic/restic:0.16.0
+RUN apk add --no-cache rclone bash
 COPY --from=builder /app/autorestic /usr/bin/autorestic
 ENTRYPOINT []
 CMD [ "autorestic" ]

README.md

@@ -34,7 +34,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
-- Before/after backup hooks
+- Pre/After hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volume

cmd/root.go

@@ -59,7 +59,24 @@ func initConfig() {
 			os.Exit(1)
 		}
 	} else {
-		configPaths := getConfigPaths()
+		configPaths := []string{"."}
+
+		// Home
+		if home, err := homedir.Dir(); err == nil {
+			configPaths = append(configPaths, home)
+		}
+
+		// XDG_CONFIG_HOME
+		{
+			prefix, found := os.LookupEnv("XDG_CONFIG_HOME")
+			if !found {
+				if home, err := homedir.Dir(); err != nil {
+					prefix = filepath.Join(home, ".config")
+				}
+			}
+			xdgConfig := filepath.Join(prefix, "autorestic")
+			configPaths = append(configPaths, xdgConfig)
+		}
 		for _, cfgPath := range configPaths {
 			viper.AddConfigPath(cfgPath)
 		}
@@ -71,22 +88,3 @@ func initConfig() {
 		viper.AutomaticEnv()
 	}
 }
-
-func getConfigPaths() []string {
-	result := []string{"."}
-	if home, err := homedir.Dir(); err == nil {
-		result = append(result, home)
-	}
-
-	{
-		xdgConfigHome, found := os.LookupEnv("XDG_CONFIG_HOME")
-		if !found {
-			if home, err := homedir.Dir(); err == nil {
-				xdgConfigHome = filepath.Join(home, ".config")
-			}
-		}
-		xdgConfig := filepath.Join(xdgConfigHome, "autorestic")
-		result = append(result, xdgConfig)
-	}
-	return result
-}

cmd/root_test.go

@@ -1,36 +0,0 @@
-package cmd
-
-import (
-	"github.com/mitchellh/go-homedir"
-	"os"
-	"path/filepath"
-	"slices"
-	"testing"
-)
-
-const xdgConfigHome = "XDG_CONFIG_HOME"
-
-func assertContains(t *testing.T, array []string, element string) {
-	if !slices.Contains(array, element) {
-		t.Errorf("Expected %s to be contained in %s", element, array)
-	}
-}
-
-func TestConfigResolving(t *testing.T) {
-	t.Run("~/.config/autorestic is used if XDG_CONFIG_HOME is not set", func(t *testing.T) {
-		// Override env using testing so that env gets restored after test
-		t.Setenv(xdgConfigHome, "")
-		_ = os.Unsetenv("XDG_CONFIG_HOME")
-		configPaths := getConfigPaths()
-		homeDir, _ := homedir.Dir()
-		expectedConfigPath := filepath.Join(homeDir, ".config/autorestic")
-		assertContains(t, configPaths, expectedConfigPath)
-	})
-
-	t.Run("XDG_CONFIG_HOME is respected if set", func(t *testing.T) {
-		t.Setenv(xdgConfigHome, "/foo/bar")
-
-		configPaths := getConfigPaths()
-		assertContains(t, configPaths, filepath.Join("/", "foo", "bar", "autorestic"))
-	})
-}

cmd/unlock.go

@@ -1,81 +0,0 @@
-package cmd
-
-import (
-	"bytes"
-	"fmt"
-	"os"
-	"os/exec"
-	"strings"
-
-	"github.com/cupcakearmy/autorestic/internal"
-	"github.com/cupcakearmy/autorestic/internal/colors"
-	"github.com/cupcakearmy/autorestic/internal/lock"
-	"github.com/spf13/cobra"
-)
-
-var unlockCmd = &cobra.Command{
-	Use:   "unlock",
-	Short: "Unlock autorestic only if you are sure that no other instance is running",
-	Long: `Unlock autorestic only if you are sure that no other instance is running.
-To check you can run "ps aux | grep autorestic".`,
-	Run: func(cmd *cobra.Command, args []string) {
-		internal.GetConfig()
-
-		force, _ := cmd.Flags().GetBool("force")
-
-		if !force && isAutoresticRunning() {
-			colors.Error.Print("Another autorestic instance is running. Are you sure you want to unlock? (yes/no): ")
-			var response string
-			fmt.Scanln(&response)
-			if strings.ToLower(response) != "yes" {
-				colors.Primary.Println("Unlocking aborted.")
-				return
-			}
-		}
-
-		err := lock.Unlock()
-		if err != nil {
-			colors.Error.Println("Could not unlock:", err)
-			return
-		}
-
-		colors.Success.Println("Unlock successful")
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(unlockCmd)
-	unlockCmd.Flags().Bool("force", false, "force unlock")
-}
-
-// isAutoresticRunning checks if autorestic is running
-// and returns true if it is.
-// It also prints the processes to stdout.
-func isAutoresticRunning() bool {
-	cmd := exec.Command("sh", "-c", "ps aux | grep autorestic")
-	var out bytes.Buffer
-	cmd.Stdout = &out
-	err := cmd.Run()
-	if err != nil {
-		return false
-	}
-
-	lines := strings.Split(out.String(), "\n")
-	autoresticProcesses := []string{}
-	currentPid := fmt.Sprint(os.Getpid())
-
-	for _, line := range lines {
-		if strings.Contains(line, "autorestic") && !strings.Contains(line, "grep autorestic") && !strings.Contains(line, currentPid) {
-			autoresticProcesses = append(autoresticProcesses, line)
-		}
-	}
-
-	if len(autoresticProcesses) > 0 {
-		colors.Faint.Println("Found autorestic processes:")
-		for _, proc := range autoresticProcesses {
-			colors.Faint.Println(proc)
-		}
-		return true
-	}
-	return false
-}

docs/pages/cli/forget.md

@@ -4,7 +4,7 @@
 autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
 ```
 
-This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/options/forget).
+This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget).
 
 The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
 

docs/pages/cli/unlock.md

@@ -1,32 +0,0 @@
-# Unlock
-
-In case autorestic throws the error message `an instance is already running. exiting`, but there is no instance running you can unlock the lock.
-
-To verify that there is no instance running you can use `ps aux | grep autorestic`.
-
-Example with no instance running:
-
-```bash
-> ps aux | grep autorestic
-root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
-```
-
-Example with an instance running:
-
-```bash
-> ps aux | grep autorestic
-root       29465  0.0  0.0 1162068 7380 pts/7    Sl+  19:28   0:00 autorestic --ci backup -a
-root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
-```
-
-**If an instance is running you should not unlock as it could lead to data loss!**
-
-```bash
-autorestic unlock
-```
-
-Use the `--force` to prevent the confirmation prompt if an instance is running.
-
-```bash
-autorestic unlock --force
-```

docs/pages/config.md

@@ -2,11 +2,10 @@
 
 ## Path
 
-By default autorestic searches for a `.autorestic.yml` file in the current directory, your home folder and your XDG config folder (`~/.config/` by default):
+By default autorestic searches for a `.autorestic.yml` file in the current directory and your home folder.
 
 - `./.autorestic.yml`
 - `~/.autorestic.yml`
-- `~/.config/autorestic/.autorestic.yml`
 
 You can also specify a custom file with the `-c path/to/some/config.yml`
 
@@ -56,8 +55,6 @@ version: 2
 
 extras:
   hooks: &foo
-    prevalidate:
-      - echo "Wake up!"
     before:
       - echo "Hello"
     after:

docs/pages/index.md

@@ -13,7 +13,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
-- Before/after backup hooks
+- Pre/After hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volumes

docs/pages/installation.md

@@ -30,4 +30,4 @@ Fedora users can install the [autorestic](https://src.fedoraproject.org/rpms/aut
 
 ### AUR
 
-If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/)
+~~If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) (looking for maintainers).~~ - Deprecated

docs/pages/location/hooks.md

@@ -6,28 +6,23 @@ They consist of a list of commands that will be executed in the same directory a
 
 The following hooks groups are supported, none are required:
 
-- `prevalidate`
 - `before`
 - `after`
 - `failure`
 - `success`
 
-The difference between `prevalidate` and `before` hooks are that `prevalidate` is run before checking the backup location is valid, including checking that the `from` directories exist. This can be useful, for example, to mount the source filesystem that contains the directories listed in `from`.
-
 ```yml | .autorestic.yml
 locations:
   my-location:
     from: /data
     to: my-backend
     hooks:
-      prevalidate:
-        - echo "Checks"
       before:
         - echo "One"
         - echo "Two"
         - echo "Three"
       after:
-        - echo "Bye"
+        - echo "Byte"
       failure:
         - echo "Something went wrong"
       success:
@@ -36,15 +31,13 @@ locations:
 
 ## Flowchart
 
-1. `prevalidate` hook
-2. Check backup location
-3. `before` hook
-4. Run backup
-5. `after` hook
-6. - `success` hook if no errors were found
+1. `before` hook
+2. Run backup
+3. `after` hook
+4. - `success` hook if no errors were found
    - `failure` hook if at least one error was encountered
 
-If either the `prevalidate` or `before` hook encounters errors then the backup and `after` hooks will be skipped and only the `failed` hooks will run.
+If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
 
 ## Environment variables
 

go.mod

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

internal/backend.go

@@ -143,7 +143,6 @@ func (b Backend) Exec(args []string) error {
 		return err
 	}
 	options := ExecuteOptions{Envs: env}
-	args = append(args, combineBackendOptions("exec", b)...)
 	_, out, err := ExecuteResticCommand(options, args...)
 	if err != nil {
 		colors.Error.Println(out)

internal/config.go

@@ -17,7 +17,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.8.1"
+const VERSION = "1.7.9"
 
 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
@@ -132,11 +132,10 @@ func (c *Config) Describe() {
 
 		tmp = ""
 		hooks := map[string][]string{
-			"PreValidate": l.Hooks.PreValidate,
-			"Before":      l.Hooks.Before,
-			"After":       l.Hooks.After,
-			"Failure":     l.Hooks.Failure,
-			"Success":     l.Hooks.Success,
+			"Before":  l.Hooks.Before,
+			"After":   l.Hooks.After,
+			"Failure": l.Hooks.Failure,
+			"Success": l.Hooks.Success,
 		}
 		for hook, commands := range hooks {
 			if len(commands) > 0 {

internal/location.go

@@ -33,12 +33,11 @@ const (
 )
 
 type Hooks struct {
-	Dir         string    `mapstructure:"dir"`
-	PreValidate HookArray `mapstructure:"prevalidate,omitempty"`
-	Before      HookArray `mapstructure:"before,omitempty"`
-	After       HookArray `mapstructure:"after,omitempty"`
-	Success     HookArray `mapstructure:"success,omitempty"`
-	Failure     HookArray `mapstructure:"failure,omitempty"`
+	Dir     string    `mapstructure:"dir"`
+	Before  HookArray `mapstructure:"before,omitempty"`
+	After   HookArray `mapstructure:"after,omitempty"`
+	Success HookArray `mapstructure:"success,omitempty"`
+	Failure HookArray `mapstructure:"failure,omitempty"`
 }
 
 type LocationCopy = map[string][]string
@@ -185,18 +184,12 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		},
 	}
 
-	// Hooks before location validation
-	if err := l.ExecuteHooks(l.Hooks.PreValidate, options); err != nil {
-		errors = append(errors, err)
-		goto after
-	}
-
 	if err := l.validate(); err != nil {
 		errors = append(errors, err)
 		goto after
 	}
 
-	// Hooks after location validation
+	// Hooks
 	if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil {
 		errors = append(errors, err)
 		goto after
@@ -296,13 +289,12 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		}
 	}
 
-	// After backup hooks
+	// After hooks
 	if err := l.ExecuteHooks(l.Hooks.After, options); err != nil {
 		errors = append(errors, err)
 	}
 
 after:
-	// Success/failure hooks
 	var commands []string
 	var isSuccess = len(errors) == 0
 	if isSuccess {

main.go

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-	http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,