feat(lockfile): allow changing the lockfile path

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)
 }
 

internal/flags/flags.go

@@ -6,4 +6,5 @@ var (
 	CRON_LEAN     bool = false
 	RESTIC_BIN    string
 	DOCKER_IMAGE  string
+	LOCKFILE_PATH string
 )

internal/lock/lock.go

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