Merge d332f4476b into 48fa20b482

Bumps restic/restic from 0.17.2 to 0.17.3.

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

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.21'
+      - run: go test -v ./...
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.21'
+      - run: go build -v .

Dockerfile

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

docs/package.json

@@ -1,7 +1,8 @@
 {
   "scripts": {
     "build": "NEXT_TELEMETRY_DISABLED=1 next build",
-    "dev": "NEXT_TELEMETRY_DISABLED=1 next"
+    "dev": "NEXT_TELEMETRY_DISABLED=1 next",
+    "start": "NEXT_TELEMETRY_DISABLED=1 next start"
   },
   "dependencies": {
     "next": "^14.2.7",

docs/pages/location/cron.md

@@ -34,7 +34,7 @@ Then paste this at the bottom of the file and save it. Note that in this specifi
 
 ```bash
 # This is required, as it otherwise cannot find restic as a command.
-PATH="/usr/local/bin:/usr/bin:/bin"
+PATH="/usr/local/bin:$PATH"
 
 # Example running every 5 minutes
 */5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron

docs/pages/location/docker.md

@@ -18,7 +18,7 @@ services:
 
 ```yaml | .autorestic.yml
 locations:
-  foo:
+  hello:
     from: my-data
     type: volume
     # ...

install.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e -o pipefail
 shopt -s nocaseglob
 
 OUT_FILE=/usr/local/bin/autorestic

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/cron.go

@@ -1,12 +1,22 @@
 package internal
 
+import (
+	"errors"
+	"fmt"
+)
+
 func RunCron() error {
 	c := GetConfig()
+	var errs []error
 	for name, l := range c.Locations {
 		l.name = name
 		if err := l.RunCron(); err != nil {
-			return err
+			errs = append(errs, err)
 		}
 	}
+
+	if len(errs) > 0 {
+		return fmt.Errorf("Encountered errors during cron process:\n%w", errors.Join(errs...))
+	}
 	return nil
 }

internal/location.go

@@ -1,6 +1,7 @@
 package internal
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -33,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) {
@@ -446,7 +447,10 @@ func (l Location) RunCron() error {
 	now := time.Now()
 	if now.After(next) {
 		lock.SetCron(l.name, now.Unix())
-		l.Backup(true, "")
+		errs := l.Backup(true, "")
+		if len(errs) > 0 {
+			return fmt.Errorf("Failed to backup location \"%s\":\n%w", l.name, errors.Join(errs...))
+		}
 	} else {
 		if !flags.CRON_LEAN {
 			colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)