WIP: Automatically set restore target to / if all backup paths are absolute

.drone.yml

@@ -4,7 +4,7 @@ name: test
 
 steps:
   - name: test
-    image: golang:1.21
+    image: golang:1.20
     environment:
       VERSION: ${DRONE_TAG:-${DRONE_COMMIT}}
     commands:
@@ -13,7 +13,7 @@ steps:
       - make test
 
   - name: check
-    image: iamthefij/drone-pre-commit@sha256:30fa17489b86d7a4c3ad9c3ce2e152c25d82b8671e5609d322c6cae0baed89cd
+    image: iamthefij/drone-pre-commit:personal
 
 ---
 kind: pipeline
@@ -32,7 +32,7 @@ trigger:
 
 steps:
   - name: build all binaries
-    image: golang:1.21
+    image: golang:1.17
     environment:
       VERSION: ${DRONE_TAG:-${DRONE_COMMIT}}
     commands:

.golangci.yml

@@ -31,8 +31,10 @@ linters:
     - gocognit
     - goconst
     - gocritic
+    # - gocyclo  # Using cyclop
     - godot
-    - gofumpt
+    # - goerr113  # Using errorlint
+    - gofmt
     - goheader
     - goimports
     - gomnd
@@ -42,6 +44,7 @@ linters:
     - gosec
     - grouper
     - importas
+    # - ireturn
     - lll
     - maintidx
     - makezero
@@ -56,9 +59,11 @@ linters:
     - paralleltest
     - prealloc
     - predeclared
+    # - promlinter  # Not common enough
     - revive
     - rowserrcheck
     - sqlclosecheck
+    # - stylecheck  # Using revive
     - tagliatelle
     - tenv
     - testpackage
@@ -66,11 +71,27 @@ linters:
     - tparallel
     - unconvert
     - unparam
+    - varnamelen
     - wastedassign
     - whitespace
     - wrapcheck
     - wsl
 
+  disable:
+    - gochecknoglobals
+    - godox
+    - forbidigo
+    # Deprecated
+    - golint
+    - interfacer
+    - maligned
+    - scopelint
+    - ifshort
+    - varcheck
+    - structcheck
+    - deadcode
+    - exhaustivestruct
+
 linters-settings:
   gomnd:
     settings:

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v3.4.0
     hooks:
       - id: check-added-large-files
       - id: check-yaml
@@ -11,8 +11,10 @@ repos:
       - id: end-of-file-fixer
       - id: check-merge-conflict
   - repo: https://github.com/dnephin/pre-commit-golang
-    rev: v0.5.1
+    rev: v0.4.0
     hooks:
+      - id: go-fmt
+      - id: go-imports
       - id: golangci-lint
         args:
           - --timeout=3m

Dockerfile

@@ -1,23 +1,21 @@
-FROM alpine:3.18
+FROM alpine:3.17
 
 RUN apk add --no-cache \
         bash~=5 \
-        consul~=1 \
+        consul~=1.14 \
-        mariadb-client~=10 \
+        mariadb-client~=10.6 \
-        mariadb-connector-c~=3 \
+        mariadb-connector-c~=3.3 \
-        nomad~=1 \
+        nomad~=1.4 \
-        postgresql15-client~=15 \
+        postgresql15-client~=15.3 \
-        rclone~=1.62 \
+        rclone~=1.60 \
-        redis~=7 \
+        redis~=7.0 \
-        restic~=0.15 \
+        restic~=0.14 \
         sqlite~=3 \
-        tzdata~=2023 \
+        tzdata~=2023c \
         ;
 
 ARG TARGETOS
 ARG TARGETARCH
 COPY ./dist/resticscheduler-$TARGETOS-$TARGETARCH /bin/resticscheduler
 
-HEALTHCHECK CMD ["wget", "-O", "-", "http://localhost:8080/health"]
-
 ENTRYPOINT [ "/bin/resticscheduler" ]

job.go

@@ -280,10 +280,8 @@ func (j Job) Run() {
 		result.LastError = err
 	} else {
 		Metrics.SnapshotCurrentCount.WithLabelValues(j.Name).Set(float64(len(snapshots)))
-		if len(snapshots) > 0 {
+		latestSnapshot := snapshots[len(snapshots)-1]
-			latestSnapshot := snapshots[len(snapshots)-1]
+		Metrics.SnapshotLatestTime.WithLabelValues(j.Name).Set(float64(latestSnapshot.Time.Unix()))
-			Metrics.SnapshotLatestTime.WithLabelValues(j.Name).Set(float64(latestSnapshot.Time.Unix()))
-		}
 	}
 
 	if result.Success {

job_test.go

@@ -148,9 +148,7 @@ func TestJobValidation(t *testing.T) {
 				Name:     "Test job",
 				Schedule: "@daily",
 				Config:   ValidResticConfig(),
-				Tasks: []main.JobTask{
+				Tasks:    []main.JobTask{{}},
-					{}, //nolint:exhaustruct
-				},
 				Backup:   main.BackupFilesTask{Paths: []string{"/test"}}, //nolint:exhaustruct
 				Forget:   nil,
 				MySQL:    []main.JobTaskMySQL{},
@@ -168,9 +166,7 @@ func TestJobValidation(t *testing.T) {
 				Tasks:    []main.JobTask{},
 				Backup:   main.BackupFilesTask{Paths: []string{"/test"}}, //nolint:exhaustruct
 				Forget:   nil,
-				MySQL: []main.JobTaskMySQL{
+				MySQL:    []main.JobTaskMySQL{{}},
-					{}, //nolint:exhaustruct
-				},
 				Postgres: []main.JobTaskPostgres{},
 				Sqlite:   []main.JobTaskSqlite{},
 			},
@@ -187,9 +183,7 @@ func TestJobValidation(t *testing.T) {
 				Forget:   nil,
 				MySQL:    []main.JobTaskMySQL{},
 				Postgres: []main.JobTaskPostgres{},
-				Sqlite: []main.JobTaskSqlite{
+				Sqlite:   []main.JobTaskSqlite{{}},
-					{}, //nolint:exhaustruct
-				},
 			},
 			expectedErr: main.ErrMissingField,
 		},
@@ -228,7 +222,6 @@ func TestConfigValidation(t *testing.T) {
 					Config:   ValidResticConfig(),
 					Tasks:    []main.JobTask{},
 					Backup:   main.BackupFilesTask{Paths: []string{"/test"}}, //nolint:exhaustruct
-					Forget:   nil,
 					MySQL:    []main.JobTaskMySQL{},
 					Postgres: []main.JobTaskPostgres{},
 					Sqlite:   []main.JobTaskSqlite{},
@@ -246,7 +239,6 @@ func TestConfigValidation(t *testing.T) {
 					Config:   nil,
 					Tasks:    []main.JobTask{},
 					Backup:   main.BackupFilesTask{Paths: []string{"/test"}}, //nolint:exhaustruct
-					Forget:   nil,
 					MySQL:    []main.JobTaskMySQL{},
 					Postgres: []main.JobTaskPostgres{},
 					Sqlite:   []main.JobTaskSqlite{},
@@ -294,8 +286,7 @@ func TestConfigValidation(t *testing.T) {
 					MySQL:    []main.JobTaskMySQL{},
 					Postgres: []main.JobTaskPostgres{},
 					Sqlite:   []main.JobTaskSqlite{},
-				}},
+				}}},
-			},
 			expectedErr: main.ErrMissingField,
 		},
 	}

main.go

@@ -29,12 +29,8 @@ func ParseConfig(path string) ([]Job, error) {
 		Functions: map[string]function.Function{
 			"env": function.New(&function.Spec{
 				Params: []function.Parameter{{
-					Name:             "var",
+					Name: "var",
-					Type:             cty.String,
+					Type: cty.String,
-					AllowNull:        false,
-					AllowUnknown:     false,
-					AllowDynamicType: false,
-					AllowMarked:      false,
 				}},
 				VarParam: nil,
 				Type:     function.StaticReturnType(cty.String),
@@ -44,12 +40,8 @@ func ParseConfig(path string) ([]Job, error) {
 			}),
 			"readfile": function.New(&function.Spec{
 				Params: []function.Parameter{{
-					Name:             "path",
+					Name: "path",
-					Type:             cty.String,
+					Type: cty.String,
-					AllowNull:        false,
-					AllowUnknown:     false,
-					AllowDynamicType: false,
-					AllowMarked:      false,
 				}},
 				VarParam: nil,
 				Type:     function.StaticReturnType(cty.String),
@@ -189,32 +181,10 @@ func runRestoreJobs(jobs []Job, names string, snapshot string) error {
 	return filterJobErr
 }
 
-func runUnlockJobs(jobs []Job, names string) error {
-	if names == "" {
-		return nil
-	}
-
-	namesSlice := strings.Split(names, ",")
-
-	if len(namesSlice) == 0 {
-		return nil
-	}
-
-	jobs, filterJobErr := FilterJobs(jobs, namesSlice)
-	for _, job := range jobs {
-		if err := job.NewRestic().Unlock(UnlockOpts{RemoveAll: true}); err != nil {
-			return err
-		}
-	}
-
-	return filterJobErr
-}
-
 type Flags struct {
 	showVersion        bool
 	backup             string
 	restore            string
-	unlock             string
 	restoreSnapshot    string
 	once               bool
 	healthCheckAddr    string
@@ -226,7 +196,6 @@ func readFlags() Flags {
 	flag.BoolVar(&flags.showVersion, "version", false, "Display the version and exit")
 	flag.StringVar(&flags.backup, "backup", "", "Run backup jobs now. Names are comma separated. `all` will run all.")
 	flag.StringVar(&flags.restore, "restore", "", "Run restore jobs now. Names are comma separated. `all` will run all.")
-	flag.StringVar(&flags.unlock, "unlock", "", "Unlock job repos now. Names are comma separated. `all` will run all.")
 	flag.BoolVar(&flags.once, "once", false, "Run jobs specified using -backup and -restore once and exit")
 	flag.StringVar(&flags.healthCheckAddr, "addr", "0.0.0.0:8080", "address to bind health check API")
 	flag.StringVar(&flags.metricsPushGateway, "push-gateway", "", "url of push gateway service for batch runs (optional)")
@@ -237,12 +206,7 @@ func readFlags() Flags {
 	return flags
 }
 
-func runSpecifiedJobs(jobs []Job, backupJobs, restoreJobs, unlockJobs, snapshot string) error {
+func runSpecifiedJobs(jobs []Job, backupJobs, restoreJobs, snapshot string) error {
-	// Run specified job unlocks
-	if err := runUnlockJobs(jobs, unlockJobs); err != nil {
-		return fmt.Errorf("Failed running unlock for jobs: %w", err)
-	}
-
 	// Run specified backup jobs
 	if err := runBackupJobs(jobs, backupJobs); err != nil {
 		return fmt.Errorf("Failed running backup jobs: %w", err)
@@ -258,8 +222,6 @@ func runSpecifiedJobs(jobs []Job, backupJobs, restoreJobs, unlockJobs, snapshot
 
 func maybePushMetrics(metricsPushGateway string) error {
 	if metricsPushGateway != "" {
-		fmt.Println("Pushing metrics to push gateway")
-
 		if err := Metrics.PushToGateway(metricsPushGateway); err != nil {
 			return fmt.Errorf("Failed pushing metrics after jobs run: %w", err)
 		}
@@ -291,7 +253,7 @@ func main() {
 		log.Fatalf("Failed to read jobs from files: %v", err)
 	}
 
-	if err := runSpecifiedJobs(jobs, flags.backup, flags.restore, flags.unlock, flags.restoreSnapshot); err != nil {
+	if err := runSpecifiedJobs(jobs, flags.backup, flags.restore, flags.restoreSnapshot); err != nil {
 		log.Fatal(err)
 	}
 

main_test.go

@@ -31,6 +31,7 @@ func TestReadJobs(t *testing.T) {
 	t.Parallel()
 
 	jobs, err := main.ReadJobs([]string{"./test/sample.hcl"})
+
 	if err != nil {
 		t.Errorf("Unexpected error reading jobs: %v", err)
 	}

metrics.go

@@ -19,6 +19,7 @@ func (m ResticMetrics) PushToGateway(url string) error {
 	err := push.New(url, "batch").
 		Gatherer(m.Registry).
 		Add()
+
 	if err != nil {
 		return fmt.Errorf("error pushing to registry %s: %w", url, err)
 	}

restic.go

@@ -11,10 +11,8 @@ import (
 	"time"
 )
 
-var (
+var ErrRestic = errors.New("restic error")
-	ErrRestic       = errors.New("restic error")
+var ErrRepoNotFound = errors.New("repository not found or uninitialized")
-	ErrRepoNotFound = errors.New("repository not found or uninitialized")
-)
 
 func lineIn(needle string, haystack []string) bool {
 	for _, line := range haystack {
@@ -74,16 +72,6 @@ func (NoOpts) ToArgs() []string {
 	return []string{}
 }
 
-type UnlockOpts struct {
-	RemoveAll bool `hcl:"RemoveAll,optional"`
-}
-
-func (uo UnlockOpts) ToArgs() (args []string) {
-	args = maybeAddArgBool(args, "--remove-all", uo.RemoveAll)
-
-	return
-}
-
 type BackupOpts struct {
 	Exclude []string `hcl:"Exclude,optional"`
 	Include []string `hcl:"Include,optional"`
@@ -205,10 +193,9 @@ type ResticGlobalOpts struct {
 	TLSClientCertFile string            `hcl:"TlsClientCertFile,optional"`
 	LimitDownload     int               `hcl:"LimitDownload,optional"`
 	LimitUpload       int               `hcl:"LimitUpload,optional"`
-	VerboseLevel      int               `hcl:"VerboseLevel,optional"`
 	Options           map[string]string `hcl:"Options,optional"`
+	VerboseLevel      int               `hcl:"VerboseLevel,optional"`
 	CleanupCache      bool              `hcl:"CleanupCache,optional"`
-	InsecureTLS       bool              `hcl:"InsecureTls,optional"`
 	NoCache           bool              `hcl:"NoCache,optional"`
 	NoLock            bool              `hcl:"NoLock,optional"`
 }
@@ -222,7 +209,6 @@ func (glo ResticGlobalOpts) ToArgs() (args []string) {
 	args = maybeAddArgInt(args, "--limit-upload", glo.LimitUpload)
 	args = maybeAddArgInt(args, "--verbose", glo.VerboseLevel)
 	args = maybeAddArgBool(args, "--cleanup-cache", glo.CleanupCache)
-	args = maybeAddArgBool(args, "--insecure-tls", glo.InsecureTLS)
 	args = maybeAddArgBool(args, "--no-cache", glo.NoCache)
 	args = maybeAddArgBool(args, "--no-lock", glo.NoLock)
 
@@ -345,12 +331,6 @@ func (rcmd Restic) Check() error {
 	return err
 }
 
-func (rcmd Restic) Unlock(unlockOpts UnlockOpts) error {
-	_, err := rcmd.RunRestic("unlock", unlockOpts)
-
-	return err
-}
-
 type Snapshot struct {
 	UID      int       `json:"uid"`
 	GID      int       `json:"gid"`

restic_test.go

@@ -32,7 +32,6 @@ func TestGlobalOptions(t *testing.T) {
 		LimitUpload:       1,
 		VerboseLevel:      1,
 		CleanupCache:      true,
-		InsecureTLS:       true,
 		NoCache:           true,
 		NoLock:            true,
 		Options: map[string]string{
@@ -49,7 +48,6 @@ func TestGlobalOptions(t *testing.T) {
 		"--limit-upload", "1",
 		"--verbose", "1",
 		"--cleanup-cache",
-		"--insecure-tls",
 		"--no-cache",
 		"--no-lock",
 		"--option", "key='a long value'",
@@ -152,20 +150,6 @@ func TestForgetOpts(t *testing.T) {
 	AssertEqual(t, "args didn't match", expected, args)
 }
 
-func TestUnlockOpts(t *testing.T) {
-	t.Parallel()
-
-	args := main.UnlockOpts{
-		RemoveAll: true,
-	}.ToArgs()
-
-	expected := []string{
-		"--remove-all",
-	}
-
-	AssertEqual(t, "args didn't match", expected, args)
-}
-
 func TestBuildEnv(t *testing.T) {
 	t.Parallel()
 
@@ -237,7 +221,7 @@ func TestResticInterface(t *testing.T) {
 	}
 
 	// Write test file to the data dir
-	err := os.WriteFile(dataFile, []byte("testing"), 0o644)
+	err := os.WriteFile(dataFile, []byte("testing"), 0644)
 	AssertEqualFail(t, "unexpected error writing to test file", nil, err)
 
 	// Make sure no existing repo is found
@@ -297,7 +281,7 @@ func TestResticInterface(t *testing.T) {
 	AssertEqualFail(t, "unexpected error checking repo", nil, err)
 
 	// Change the data file
-	err = os.WriteFile(dataFile, []byte("unexpected"), 0o644)
+	err = os.WriteFile(dataFile, []byte("unexpected"), 0644)
 	AssertEqualFail(t, "unexpected error writing to test file", nil, err)
 
 	// Check that data wrote
@@ -313,8 +297,4 @@ func TestResticInterface(t *testing.T) {
 	value, err = os.ReadFile(restoredDataFile)
 	AssertEqualFail(t, "unexpected error reading from test file", nil, err)
 	AssertEqualFail(t, "incorrect value in test file", "testing", string(value))
-
-	// Try to unlock the repo (repo shouldn't really be locked, but this should still run without error
-	err = restic.Unlock(main.UnlockOpts{}) //nolint:exhaustruct
-	AssertEqualFail(t, "unexpected error unlocking repo", nil, err)
 }

scheduler.go

@@ -13,10 +13,8 @@ import (
 	"github.com/robfig/cron/v3"
 )
 
-var (
+var jobResultsLock = sync.Mutex{}
-	jobResultsLock = sync.Mutex{}
+var jobResults = map[string]JobResult{}
-	jobResults     = map[string]JobResult{}
-)
 
 type JobResult struct {
 	JobName   string
@@ -115,8 +113,6 @@ func ScheduleAndRunJobs(jobs []Job) error {
 		defer func() {
 			ctx := scheduler.Stop()
 			<-ctx.Done()
-
-			fmt.Println("All jobs successfully stopped")
 		}()
 
 		return nil

tasks.go

@@ -6,6 +6,7 @@ import (
 	"io/fs"
 	"log"
 	"os"
+	"path"
 	"strings"
 )
 
@@ -405,6 +406,23 @@ func (t BackupFilesTask) RunRestore(cfg TaskConfig) error {
 		t.RestoreOpts = &RestoreOpts{} //nolint:exhaustruct
 	}
 
+	// If all backup paths are absolute and target is empty, use root as the restore target
+	if t.RestoreOpts.Target == "" {
+		allAbs := true
+
+		for _, backupPath := range t.Paths {
+			if !path.IsAbs(backupPath) {
+				allAbs = false
+
+				break
+			}
+		}
+
+		if allAbs {
+			t.RestoreOpts.Target = "/"
+		}
+	}
+
 	if t.snapshot == "" {
 		t.snapshot = "latest"
 	}