mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2025-09-06 02:20:39 +00:00
Compare commits
17 Commits
v1.8.3
...
59b2393127
Author | SHA1 | Date | |
---|---|---|---|
|
59b2393127 | ||
|
de0862a3dd | ||
|
c9a1474297 | ||
|
0fdf9c77ae | ||
|
8de8d0070e | ||
|
ccca7c850f | ||
|
f7d28b486c | ||
|
6895df1c83 | ||
|
8a773856de | ||
|
41e4e4a5f3 | ||
|
6424c64304 | ||
|
d39dafaef1 | ||
|
5a0f7e94f4 | ||
|
6a60d02759 | ||
1f7240c6a0 | |||
|
51a8298f2a | ||
|
f6aa45fd6c |
24
.github/workflows/ci.yml
vendored
Normal file
24
.github/workflows/ci.yml
vendored
Normal file
@@ -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 .
|
@@ -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.2
|
||||
RUN apk add --no-cache rclone bash curl docker-cli
|
||||
COPY --from=builder /app/autorestic /usr/bin/autorestic
|
||||
ENTRYPOINT []
|
||||
|
@@ -6,7 +6,6 @@ import (
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -15,9 +14,9 @@ var backupCmd = &cobra.Command{
|
||||
Short: "Create backups for given locations",
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
selected, err := internal.GetAllOrSelected(cmd, false)
|
||||
CheckErr(err)
|
||||
|
@@ -3,7 +3,6 @@ package cmd
|
||||
import (
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -12,9 +11,9 @@ var checkCmd = &cobra.Command{
|
||||
Short: "Check if everything is setup",
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
CheckErr(internal.CheckConfig())
|
||||
|
||||
|
@@ -3,7 +3,6 @@ package cmd
|
||||
import (
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -13,9 +12,9 @@ var cronCmd = &cobra.Command{
|
||||
Long: `Intended to be mainly triggered by an automated system like systemd or crontab. For each location checks if a cron backup is due and runs it.`,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
err = internal.RunCron()
|
||||
CheckErr(err)
|
||||
|
@@ -5,7 +5,6 @@ import (
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -14,9 +13,9 @@ var execCmd = &cobra.Command{
|
||||
Short: "Execute arbitrary native restic commands for given backends",
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
selected, err := internal.GetAllOrSelected(cmd, true)
|
||||
CheckErr(err)
|
||||
|
@@ -2,7 +2,6 @@ package cmd
|
||||
|
||||
import (
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -11,9 +10,9 @@ var forgetCmd = &cobra.Command{
|
||||
Short: "Forget and optionally prune snapshots according the specified policies",
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
selected, err := internal.GetAllOrSelected(cmd, false)
|
||||
CheckErr(err)
|
||||
|
@@ -4,7 +4,6 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -14,9 +13,9 @@ var restoreCmd = &cobra.Command{
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
internal.GetConfig()
|
||||
err := lock.Lock()
|
||||
err := internal.Lock()
|
||||
CheckErr(err)
|
||||
defer lock.Unlock()
|
||||
defer internal.Unlock()
|
||||
|
||||
location, _ := cmd.Flags().GetString("location")
|
||||
l, ok := internal.GetLocation(location)
|
||||
|
@@ -8,7 +8,6 @@ import (
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
homedir "github.com/mitchellh/go-homedir"
|
||||
@@ -18,7 +17,7 @@ import (
|
||||
func CheckErr(err error) {
|
||||
if err != nil {
|
||||
colors.Error.Fprintln(os.Stderr, "Error:", err)
|
||||
lock.Unlock()
|
||||
internal.Unlock()
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
@@ -42,6 +41,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, "lockfile", "", "specify a custom path for the lockfile (defaults to .autorestic.lock.yml next to the loaded autorestic config file)")
|
||||
cobra.OnInitialize(initConfig)
|
||||
}
|
||||
|
||||
|
@@ -9,7 +9,6 @@ import (
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
@@ -33,7 +32,7 @@ To check you can run "ps aux | grep autorestic".`,
|
||||
}
|
||||
}
|
||||
|
||||
err := lock.Unlock()
|
||||
err := internal.Unlock()
|
||||
if err != nil {
|
||||
colors.Error.Println("Could not unlock:", err)
|
||||
return
|
||||
|
@@ -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",
|
||||
|
@@ -3,6 +3,7 @@
|
||||
"quick": "Quick Start",
|
||||
"installation": "Installation",
|
||||
"config": "Configuration",
|
||||
"lockfile": "Lockfile",
|
||||
"location": "Locations",
|
||||
"backend": "Backend",
|
||||
"cli": "CLI",
|
||||
|
@@ -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`
|
||||
|
||||
Specify the path for the [lockfile](../lockfile.md) used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
|
||||
|
||||
```bash
|
||||
autorestic --lockfile /path/to/my/.autorestic.lock.yml
|
||||
```
|
||||
|
@@ -18,7 +18,7 @@ services:
|
||||
|
||||
```yaml | .autorestic.yml
|
||||
locations:
|
||||
foo:
|
||||
hello:
|
||||
from: my-data
|
||||
type: volume
|
||||
# ...
|
||||
|
14
docs/pages/lockfile.md
Normal file
14
docs/pages/lockfile.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Lockfile
|
||||
|
||||
Under the hood, `autorestic` uses a lockfile to ensure that only one instance is running and to keep track of when [cronjobs](./location/cron.md) were last run.
|
||||
|
||||
By default, the lockfile is stored next to your [configuration file](./config.md) as `.autorestic.lock.yml`. In other words, if your config file is located at `/some/path/.autorestic.yml`, then the lockfile will be located at `/some/path/.autorestic.lock.yml`.
|
||||
|
||||
## Customization
|
||||
|
||||
The path to the lockfile can be customized if need be. This can be done is a few ways:
|
||||
|
||||
1. Using the `--lockfile ...` command line flag
|
||||
1. Setting `lockfile: ...` in the configuration file
|
||||
|
||||
Note that `autorestic` will check for a customized lockfile path in the order listed above. This means that if you specify a lockfile path in multiple places, the method that's higher in the list will win.
|
@@ -1,5 +1,5 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e -o pipefail
|
||||
shopt -s nocaseglob
|
||||
|
||||
OUT_FILE=/usr/local/bin/autorestic
|
||||
|
@@ -14,19 +14,19 @@ import (
|
||||
)
|
||||
|
||||
type BackendRest struct {
|
||||
User string `mapstructure:"user,omitempty"`
|
||||
Password string `mapstructure:"password,omitempty"`
|
||||
User string `mapstructure:"user,omitempty" yaml:"user,omitempty"`
|
||||
Password string `mapstructure:"password,omitempty" yaml:"password,omitempty"`
|
||||
}
|
||||
|
||||
type Backend struct {
|
||||
name string
|
||||
Type string `mapstructure:"type,omitempty"`
|
||||
Path string `mapstructure:"path,omitempty"`
|
||||
Key string `mapstructure:"key,omitempty"`
|
||||
RequireKey bool `mapstructure:"requireKey,omitempty"`
|
||||
Env map[string]string `mapstructure:"env,omitempty"`
|
||||
Rest BackendRest `mapstructure:"rest,omitempty"`
|
||||
Options Options `mapstructure:"options,omitempty"`
|
||||
Type string `mapstructure:"type,omitempty" yaml:"type,omitempty"`
|
||||
Path string `mapstructure:"path,omitempty" yaml:"path,omitempty"`
|
||||
Key string `mapstructure:"key,omitempty" yaml:"key,omitempty"`
|
||||
RequireKey bool `mapstructure:"requireKey,omitempty" yaml:"requireKey,omitempty"`
|
||||
Env map[string]string `mapstructure:"env,omitempty" yaml:"env,omitempty"`
|
||||
Rest BackendRest `mapstructure:"rest,omitempty" yaml:"rest,omitempty"`
|
||||
Options Options `mapstructure:"options,omitempty" yaml:"options,omitempty"`
|
||||
}
|
||||
|
||||
func GetBackend(name string) (Backend, bool) {
|
||||
|
@@ -10,7 +10,6 @@ import (
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/joho/godotenv"
|
||||
"github.com/mitchellh/go-homedir"
|
||||
"github.com/spf13/cobra"
|
||||
@@ -23,11 +22,12 @@ type OptionMap map[string][]interface{}
|
||||
type Options map[string]OptionMap
|
||||
|
||||
type Config struct {
|
||||
Version string `mapstructure:"version"`
|
||||
Extras interface{} `mapstructure:"extras"`
|
||||
Locations map[string]Location `mapstructure:"locations"`
|
||||
Backends map[string]Backend `mapstructure:"backends"`
|
||||
Global Options `mapstructure:"global"`
|
||||
Version string `mapstructure:"version" yaml:"version"`
|
||||
Lockfile string `mapstructure:"lockfile,omitempty" yaml:"lockfile,omitempty"`
|
||||
Extras interface{} `mapstructure:"extras" yaml:"extras"`
|
||||
Locations map[string]Location `mapstructure:"locations" yaml:"locations"`
|
||||
Backends map[string]Backend `mapstructure:"backends" yaml:"backends"`
|
||||
Global Options `mapstructure:"global" yaml:"global"`
|
||||
}
|
||||
|
||||
var once sync.Once
|
||||
@@ -40,7 +40,7 @@ func exitConfig(err error, msg string) {
|
||||
if msg != "" {
|
||||
colors.Error.Println(msg)
|
||||
}
|
||||
lock.Unlock()
|
||||
Unlock()
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
|
@@ -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()
|
||||
|
||||
|
@@ -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
|
||||
}
|
||||
|
@@ -1,9 +1,10 @@
|
||||
package flags
|
||||
|
||||
var (
|
||||
CI bool = false
|
||||
VERBOSE bool = false
|
||||
CRON_LEAN bool = false
|
||||
RESTIC_BIN string
|
||||
CI bool = false
|
||||
VERBOSE bool = false
|
||||
CRON_LEAN bool = false
|
||||
RESTIC_BIN string
|
||||
DOCKER_IMAGE string
|
||||
LOCKFILE string
|
||||
)
|
||||
|
@@ -1,6 +1,7 @@
|
||||
package internal
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
@@ -10,7 +11,6 @@ import (
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/cupcakearmy/autorestic/internal/metadata"
|
||||
"github.com/robfig/cron"
|
||||
)
|
||||
@@ -33,26 +33,26 @@ 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" yaml:"dir"`
|
||||
PreValidate HookArray `mapstructure:"prevalidate,omitempty" yaml:"prevalidate,omitempty"`
|
||||
Before HookArray `mapstructure:"before,omitempty" yaml:"before,omitempty"`
|
||||
After HookArray `mapstructure:"after,omitempty" yaml:"after,omitempty"`
|
||||
Success HookArray `mapstructure:"success,omitempty" yaml:"success,omitempty"`
|
||||
Failure HookArray `mapstructure:"failure,omitempty" yaml:"failure,omitempty"`
|
||||
}
|
||||
|
||||
type LocationCopy = map[string][]string
|
||||
|
||||
type Location struct {
|
||||
name string `mapstructure:",omitempty"`
|
||||
From []string `mapstructure:"from,omitempty"`
|
||||
Type string `mapstructure:"type,omitempty"`
|
||||
To []string `mapstructure:"to,omitempty"`
|
||||
Hooks Hooks `mapstructure:"hooks,omitempty"`
|
||||
Cron string `mapstructure:"cron,omitempty"`
|
||||
Options Options `mapstructure:"options,omitempty"`
|
||||
ForgetOption LocationForgetOption `mapstructure:"forget,omitempty"`
|
||||
CopyOption LocationCopy `mapstructure:"copy,omitempty"`
|
||||
name string `mapstructure:",omitempty" yaml:",omitempty"`
|
||||
From []string `mapstructure:"from,omitempty" yaml:"from,omitempty"`
|
||||
Type string `mapstructure:"type,omitempty" yaml:"type,omitempty"`
|
||||
To []string `mapstructure:"to,omitempty" yaml:"to,omitempty"`
|
||||
Hooks Hooks `mapstructure:"hooks,omitempty" yaml:"hooks,omitempty"`
|
||||
Cron string `mapstructure:"cron,omitempty" yaml:"cron,omitempty"`
|
||||
Options Options `mapstructure:"options,omitempty" yaml:"options,omitempty"`
|
||||
ForgetOption LocationForgetOption `mapstructure:"forget,omitempty" yaml:"forget,omitempty"`
|
||||
CopyOption LocationCopy `mapstructure:"copy,omitempty" yaml:"copy,omitempty"`
|
||||
}
|
||||
|
||||
func GetLocation(name string) (Location, bool) {
|
||||
@@ -441,12 +441,15 @@ func (l Location) RunCron() error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
last := time.Unix(lock.GetCron(l.name), 0)
|
||||
last := time.Unix(GetCron(l.name), 0)
|
||||
next := schedule.Next(last)
|
||||
now := time.Now()
|
||||
if now.After(next) {
|
||||
lock.SetCron(l.name, now.Unix())
|
||||
l.Backup(true, "")
|
||||
SetCron(l.name, now.Unix())
|
||||
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)
|
||||
|
@@ -1,8 +1,9 @@
|
||||
package lock
|
||||
package internal
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal/colors"
|
||||
@@ -12,24 +13,47 @@ import (
|
||||
|
||||
var lock *viper.Viper
|
||||
var file string
|
||||
var once sync.Once
|
||||
var lockOnce sync.Once
|
||||
|
||||
const (
|
||||
RUNNING = "running"
|
||||
)
|
||||
|
||||
// getLockfilePath returns the path to the lockfile. The path for the lockfile
|
||||
// can be sources from multiple places If flags.LOCKFILE is set, its value is
|
||||
// used; if the config has the `lockfile` option set, its value is used;
|
||||
// otherwise the path is generated relative to the config file.
|
||||
func getLockfilePath() string {
|
||||
if flags.LOCKFILE != "" {
|
||||
abs, err := filepath.Abs(flags.LOCKFILE)
|
||||
if err != nil {
|
||||
return flags.LOCKFILE
|
||||
}
|
||||
return abs
|
||||
}
|
||||
|
||||
if lockfile := GetConfig().Lockfile; lockfile != "" {
|
||||
abs, err := filepath.Abs(lockfile)
|
||||
if err != nil {
|
||||
return lockfile
|
||||
}
|
||||
return abs
|
||||
}
|
||||
|
||||
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() {
|
||||
lockOnce.Do(func() {
|
||||
lock = viper.New()
|
||||
lock.SetDefault("running", false)
|
||||
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")
|
||||
file = getLockfilePath()
|
||||
if !flags.CRON_LEAN {
|
||||
colors.Faint.Println("Using lock:\t", file)
|
||||
}
|
@@ -1,30 +1,88 @@
|
||||
package lock
|
||||
package internal
|
||||
|
||||
import (
|
||||
"log"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path"
|
||||
"strconv"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/spf13/viper"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
var testDirectory = "autorestic_test_tmp"
|
||||
|
||||
// All tests must share the same lock file as it is only initialized once
|
||||
func setup(t *testing.T) {
|
||||
d, err := os.MkdirTemp("", testDirectory)
|
||||
if err != nil {
|
||||
log.Fatalf("error creating temp dir: %v", err)
|
||||
return
|
||||
}
|
||||
// set config file location
|
||||
viper.SetConfigFile(d + "/.autorestic.yml")
|
||||
|
||||
t.Cleanup(func() {
|
||||
os.RemoveAll(d)
|
||||
t.Helper()
|
||||
cleanup := func() {
|
||||
flags.LOCKFILE = ""
|
||||
config = nil
|
||||
once = sync.Once{}
|
||||
viper.Reset()
|
||||
}
|
||||
|
||||
cleanup()
|
||||
d := t.TempDir()
|
||||
viper.SetConfigFile(d + "/.autorestic.yml")
|
||||
viper.Set("version", 2)
|
||||
viper.WriteConfig()
|
||||
|
||||
t.Cleanup(cleanup)
|
||||
}
|
||||
|
||||
func TestGetLockfilePath(t *testing.T) {
|
||||
t.Run("user specified", func(t *testing.T) {
|
||||
testCases := []struct {
|
||||
name string
|
||||
flag string
|
||||
config string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "flag and config",
|
||||
flag: "/flag.lock.yml",
|
||||
config: "/config.lock.yml",
|
||||
expected: "/flag.lock.yml",
|
||||
},
|
||||
{
|
||||
name: "flag only",
|
||||
flag: "/flag.lock.yml",
|
||||
config: "",
|
||||
expected: "/flag.lock.yml",
|
||||
},
|
||||
{
|
||||
name: "config only",
|
||||
flag: "",
|
||||
config: "/config.lock.yml",
|
||||
expected: "/config.lock.yml",
|
||||
},
|
||||
}
|
||||
for _, testCase := range testCases {
|
||||
t.Run(testCase.name, func(t *testing.T) {
|
||||
setup(t)
|
||||
flags.LOCKFILE = testCase.flag
|
||||
if testCase.config != "" {
|
||||
viper.Set("lockfile", testCase.config)
|
||||
err := viper.WriteConfig()
|
||||
assert.NoError(t, err)
|
||||
}
|
||||
|
||||
p := getLockfilePath()
|
||||
assert.Equal(t, testCase.expected, p)
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("default", func(t *testing.T) {
|
||||
setup(t)
|
||||
|
||||
configPath := viper.ConfigFileUsed()
|
||||
expectedLockfile := path.Join(path.Dir(configPath), ".autorestic.lock.yml")
|
||||
|
||||
p := getLockfilePath()
|
||||
assert.Equal(t, expectedLockfile, p)
|
||||
})
|
||||
}
|
||||
|
4
main.go
4
main.go
@@ -22,7 +22,7 @@ import (
|
||||
"syscall"
|
||||
|
||||
"github.com/cupcakearmy/autorestic/cmd"
|
||||
"github.com/cupcakearmy/autorestic/internal/lock"
|
||||
"github.com/cupcakearmy/autorestic/internal"
|
||||
)
|
||||
|
||||
func handleCtrlC() {
|
||||
@@ -31,7 +31,7 @@ func handleCtrlC() {
|
||||
go func() {
|
||||
sig := <-c
|
||||
fmt.Println("Signal:", sig)
|
||||
lock.Unlock()
|
||||
internal.Unlock()
|
||||
os.Exit(0)
|
||||
}()
|
||||
}
|
||||
|
Reference in New Issue
Block a user