Merge 51a8298f2a into f7d28b486c

Bumps restic/restic from 0.17.1 to 0.17.2.

---
updated-dependencies:
- dependency-name: restic/restic
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

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

Dockerfile

@@ -6,7 +6,7 @@ RUN go mod download
 COPY . .
 RUN go build
 
-FROM restic/restic:0.17.1
+FROM restic/restic:0.17.2
 RUN apk add --no-cache rclone bash curl docker-cli
 COPY --from=builder /app/autorestic /usr/bin/autorestic
 ENTRYPOINT []

cmd/root.go

@@ -42,6 +42,7 @@ func init() {
 	rootCmd.PersistentFlags().BoolVarP(&flags.VERBOSE, "verbose", "v", false, "verbose mode")
 	rootCmd.PersistentFlags().StringVar(&flags.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
 	rootCmd.PersistentFlags().StringVar(&flags.DOCKER_IMAGE, "docker-image", "cupcakearmy/autorestic:"+internal.VERSION, "specify a custom docker image")
+	rootCmd.PersistentFlags().StringVar(&flags.LOCKFILE_PATH, "lockfile-path", "", "specify a custom path for the lockfile (defaults to .autorestic.lock.yml next to the loaded autorestic config file)")
 	cobra.OnInitialize(initConfig)
 }
 

docs/pages/cli/general.md

@@ -34,3 +34,11 @@ With `--restic-bin` you can specify to run a specific restic binary. This can be
 ```bash
 autorestic --restic-bin /some/path/to/my/custom/restic/binary
 ```
+
+## `--lockfile-path`
+
+Specify the path for the lockfile used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
+
+```bash
+autorestic --lockfile-path /path/to/my/.autorestic.lock.yml
+```

internal/backend.go

@@ -14,19 +14,19 @@ import (
 )
 
 type BackendRest struct {
-	User     string `mapstructure:"user,omitempty"`
+	User     string `mapstructure:"user,omitempty" yaml:"user,omitempty"`
-	Password string `mapstructure:"password,omitempty"`
+	Password string `mapstructure:"password,omitempty" yaml:"password,omitempty"`
 }
 
 type Backend struct {
 	name       string
-	Type       string            `mapstructure:"type,omitempty"`
+	Type       string            `mapstructure:"type,omitempty" yaml:"type,omitempty"`
-	Path       string            `mapstructure:"path,omitempty"`
+	Path       string            `mapstructure:"path,omitempty" yaml:"path,omitempty"`
-	Key        string            `mapstructure:"key,omitempty"`
+	Key        string            `mapstructure:"key,omitempty" yaml:"key,omitempty"`
-	RequireKey bool              `mapstructure:"requireKey,omitempty"`
+	RequireKey bool              `mapstructure:"requireKey,omitempty" yaml:"requireKey,omitempty"`
-	Env        map[string]string `mapstructure:"env,omitempty"`
+	Env        map[string]string `mapstructure:"env,omitempty" yaml:"env,omitempty"`
-	Rest       BackendRest       `mapstructure:"rest,omitempty"`
+	Rest       BackendRest       `mapstructure:"rest,omitempty" yaml:"rest,omitempty"`
-	Options    Options           `mapstructure:"options,omitempty"`
+	Options    Options           `mapstructure:"options,omitempty" yaml:"options,omitempty"`
 }
 
 func GetBackend(name string) (Backend, bool) {

internal/config.go

@@ -23,11 +23,11 @@ type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
 
 type Config struct {
-	Version   string              `mapstructure:"version"`
+	Version   string              `mapstructure:"version" yaml:"version"`
-	Extras    interface{}         `mapstructure:"extras"`
+	Extras    interface{}         `mapstructure:"extras" yaml:"extras"`
-	Locations map[string]Location `mapstructure:"locations"`
+	Locations map[string]Location `mapstructure:"locations" yaml:"locations"`
-	Backends  map[string]Backend  `mapstructure:"backends"`
+	Backends  map[string]Backend  `mapstructure:"backends" yaml:"backends"`
-	Global    Options             `mapstructure:"global"`
+	Global    Options             `mapstructure:"global" yaml:"global"`
 }
 
 var once sync.Once

internal/config_test.go

@@ -1,10 +1,15 @@
 package internal
 
 import (
+	"path"
 	"reflect"
 	"strconv"
 	"strings"
+	"sync"
 	"testing"
+
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestOptionToString(t *testing.T) {
@@ -143,6 +148,48 @@ func TestGetOptionsMultipleKeys(t *testing.T) {
 	reflect.DeepEqual(result, expected)
 }
 
+func TestSaveConfigProducesReadableConfig(t *testing.T) {
+	workDir := t.TempDir()
+	viper.SetConfigFile(path.Join(workDir, ".autorestic.yml"))
+
+	// Required to appease the config reader
+	viper.Set("version", 2)
+
+	c := Config{
+		Version: "2",
+		Locations: map[string]Location{
+			"test": {
+				Type: "local",
+				name: "test",
+				From: []string{"in-dir"},
+				To:   []string{"test"},
+				// ForgetOption & ConfigOption have previously marshalled in a way that
+				// can't get read correctly
+				ForgetOption: "foo",
+				CopyOption:   map[string][]string{"foo": {"bar"}},
+			},
+		},
+		Backends: map[string]Backend{
+			"test": {
+				name: "test",
+				Type: "local",
+				Path: "backup-target",
+				Key:  "supersecret",
+			},
+		},
+	}
+
+	err := c.SaveConfig()
+	assert.NoError(t, err)
+
+	// Ensure we the config reading logic actually runs
+	config = nil
+	once = sync.Once{}
+	readConfig := GetConfig()
+	assert.NotNil(t, readConfig)
+	assert.Equal(t, c, *readConfig)
+}
+
 func assertEqual[T comparable](t testing.TB, result, expected T) {
 	t.Helper()
 

internal/flags/flags.go

@@ -1,9 +1,10 @@
 package flags
 
 var (
-	CI         bool = false
+	CI            bool = false
-	VERBOSE    bool = false
+	VERBOSE       bool = false
-	CRON_LEAN  bool = false
+	CRON_LEAN     bool = false
-	RESTIC_BIN string
+	RESTIC_BIN    string
-	DOCKER_IMAGE string
+	DOCKER_IMAGE  string
+	LOCKFILE_PATH string
 )

internal/location.go

@@ -34,26 +34,26 @@ const (
 )
 
 type Hooks struct {
-	Dir         string    `mapstructure:"dir"`
+	Dir         string    `mapstructure:"dir" yaml:"dir"`
-	PreValidate HookArray `mapstructure:"prevalidate,omitempty"`
+	PreValidate HookArray `mapstructure:"prevalidate,omitempty" yaml:"prevalidate,omitempty"`
-	Before      HookArray `mapstructure:"before,omitempty"`
+	Before      HookArray `mapstructure:"before,omitempty" yaml:"before,omitempty"`
-	After       HookArray `mapstructure:"after,omitempty"`
+	After       HookArray `mapstructure:"after,omitempty" yaml:"after,omitempty"`
-	Success     HookArray `mapstructure:"success,omitempty"`
+	Success     HookArray `mapstructure:"success,omitempty" yaml:"success,omitempty"`
-	Failure     HookArray `mapstructure:"failure,omitempty"`
+	Failure     HookArray `mapstructure:"failure,omitempty" yaml:"failure,omitempty"`
 }
 
 type LocationCopy = map[string][]string
 
 type Location struct {
-	name         string               `mapstructure:",omitempty"`
+	name         string               `mapstructure:",omitempty" yaml:",omitempty"`
-	From         []string             `mapstructure:"from,omitempty"`
+	From         []string             `mapstructure:"from,omitempty" yaml:"from,omitempty"`
-	Type         string               `mapstructure:"type,omitempty"`
+	Type         string               `mapstructure:"type,omitempty" yaml:"type,omitempty"`
-	To           []string             `mapstructure:"to,omitempty"`
+	To           []string             `mapstructure:"to,omitempty" yaml:"to,omitempty"`
-	Hooks        Hooks                `mapstructure:"hooks,omitempty"`
+	Hooks        Hooks                `mapstructure:"hooks,omitempty" yaml:"hooks,omitempty"`
-	Cron         string               `mapstructure:"cron,omitempty"`
+	Cron         string               `mapstructure:"cron,omitempty" yaml:"cron,omitempty"`
-	Options      Options              `mapstructure:"options,omitempty"`
+	Options      Options              `mapstructure:"options,omitempty" yaml:"options,omitempty"`
-	ForgetOption LocationForgetOption `mapstructure:"forget,omitempty"`
+	ForgetOption LocationForgetOption `mapstructure:"forget,omitempty" yaml:"forget,omitempty"`
-	CopyOption   LocationCopy         `mapstructure:"copy,omitempty"`
+	CopyOption   LocationCopy         `mapstructure:"copy,omitempty" yaml:"copy,omitempty"`
 }
 
 func GetLocation(name string) (Location, bool) {

internal/lock/lock.go

@@ -18,18 +18,28 @@ const (
 	RUNNING = "running"
 )
 
+// getLockfilePath returns the path to the lockfile. If flags.LOCKFILE_PATH is
+// set, its value is used, otherwise the path is generated relative to the
+// config file.
+func getLockfilePath() string {
+	if flags.LOCKFILE_PATH != "" {
+		return flags.LOCKFILE_PATH
+	} else {
+		p := viper.ConfigFileUsed()
+		if p == "" {
+			colors.Error.Println("cannot lock before reading config location")
+			os.Exit(1)
+		}
+		return path.Join(path.Dir(p), ".autorestic.lock.yml")
+	}
+}
+
 func getLock() *viper.Viper {
 	if lock == nil {
-
 		once.Do(func() {
 			lock = viper.New()
 			lock.SetDefault("running", false)
-			p := viper.ConfigFileUsed()
+			file = getLockfilePath()
-			if p == "" {
-				colors.Error.Println("cannot lock before reading config location")
-				os.Exit(1)
-			}
-			file = path.Join(path.Dir(p), ".autorestic.lock.yml")
 			if !flags.CRON_LEAN {
 				colors.Faint.Println("Using lock:\t", file)
 			}

internal/lock/lock_test.go

@@ -7,6 +7,7 @@ import (
 	"strconv"
 	"testing"
 
+	"github.com/cupcakearmy/autorestic/internal/flags"
 	"github.com/spf13/viper"
 )
 
@@ -28,6 +29,37 @@ func setup(t *testing.T) {
 	})
 }
 
+func TestGetLockfilePath(t *testing.T) {
+	t.Run("when flags.LOCKFILE_PATH is set", func(t *testing.T) {
+		flags.LOCKFILE_PATH = "/path/to/my/autorestic.lock.yml"
+		defer func() { flags.LOCKFILE_PATH = "" }()
+
+		p := getLockfilePath()
+
+		if p != "/path/to/my/autorestic.lock.yml" {
+			t.Errorf("got %v, want %v", p, "/path/to/my/autorestic.lock.yml")
+		}
+	})
+
+	t.Run("when flags.LOCKFILE_PATH is set", func(t *testing.T) {
+		d, err := os.MkdirTemp("", testDirectory)
+		if err != nil {
+			log.Fatalf("error creating temp dir: %v", err)
+			return
+		}
+		viper.SetConfigFile(d + "/.autorestic.yml")
+		defer viper.Reset()
+
+		flags.LOCKFILE_PATH = ""
+
+		p := getLockfilePath()
+
+		if p != d+"/.autorestic.lock.yml" {
+			t.Errorf("got %v, want %v", p, d+"/.autorestic.lock.yml")
+		}
+	})
+}
+
 func TestLock(t *testing.T) {
 	setup(t)