mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-12-23 00:36:25 +00:00
Compare commits
2 Commits
5ed1af31e0
...
5e98d4b362
Author | SHA1 | Date | |
---|---|---|---|
|
5e98d4b362 | ||
|
d243c924cc |
@ -21,53 +21,55 @@ func runCmd(t *testing.T, args ...string) error {
|
||||
}
|
||||
|
||||
func TestBackupCmd(t *testing.T) {
|
||||
workDir := t.TempDir()
|
||||
t.Run("simple local backup and restore", func(t *testing.T) {
|
||||
workDir := t.TempDir()
|
||||
|
||||
// Prepare content to be backed up
|
||||
locationDir := path.Join(workDir, "my-location")
|
||||
err := os.Mkdir(locationDir, 0750)
|
||||
assert.Nil(t, err)
|
||||
err = os.WriteFile(path.Join(locationDir, "back-me-up.txt"), []byte("hello world"), 0640)
|
||||
assert.Nil(t, err)
|
||||
// Prepare content to be backed up
|
||||
locationDir := path.Join(workDir, "my-location")
|
||||
err := os.Mkdir(locationDir, 0750)
|
||||
assert.Nil(t, err)
|
||||
err = os.WriteFile(path.Join(locationDir, "back-me-up.txt"), []byte("hello world"), 0640)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Write config file
|
||||
config, err := yaml.Marshal(map[string]interface{}{
|
||||
"version": 2,
|
||||
"locations": map[string]map[string]interface{}{
|
||||
"my-location": {
|
||||
"type": "local",
|
||||
"from": []string{locationDir},
|
||||
"to": []string{"test"},
|
||||
// Write config file
|
||||
config, err := yaml.Marshal(map[string]interface{}{
|
||||
"version": 2,
|
||||
"locations": map[string]map[string]interface{}{
|
||||
"my-location": {
|
||||
"type": "local",
|
||||
"from": []string{locationDir},
|
||||
"to": []string{"test"},
|
||||
},
|
||||
},
|
||||
},
|
||||
"backends": map[string]map[string]interface{}{
|
||||
"test": {
|
||||
"type": "local",
|
||||
"path": path.Join(workDir, "test-backend"),
|
||||
"key": "supersecret",
|
||||
"backends": map[string]map[string]interface{}{
|
||||
"test": {
|
||||
"type": "local",
|
||||
"path": path.Join(workDir, "test-backend"),
|
||||
"key": "supersecret",
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
assert.Nil(t, err)
|
||||
configPath := path.Join(workDir, ".autorestic.yml")
|
||||
err = os.WriteFile(configPath, config, 0640)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Init repo (not initialized by default)
|
||||
err = runCmd(t, "exec", "--ci", "-a", "-c", configPath, "init")
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Do the backup
|
||||
err = runCmd(t, "backup", "--ci", "-a", "-c", configPath)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Restore in a separate dir
|
||||
restoreDir := path.Join(workDir, "restore")
|
||||
err = runCmd(t, "restore", "--ci", "-c", configPath, "-l", "my-location", "--to", restoreDir)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Check restored file
|
||||
restoredContent, err := os.ReadFile(path.Join(restoreDir, locationDir, "back-me-up.txt"))
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, "hello world", string(restoredContent))
|
||||
})
|
||||
assert.Nil(t, err)
|
||||
configPath := path.Join(workDir, ".autorestic.yml")
|
||||
err = os.WriteFile(configPath, config, 0640)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Init repo (not initialized by default)
|
||||
err = runCmd(t, "exec", "--ci", "-a", "-c", configPath, "init")
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Do the backup
|
||||
err = runCmd(t, "backup", "--ci", "-a", "-c", configPath)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Restore in a separate dir
|
||||
restoreDir := path.Join(workDir, "restore")
|
||||
err = runCmd(t, "restore", "--ci", "-c", configPath, "-l", "my-location", "--to", restoreDir)
|
||||
assert.Nil(t, err)
|
||||
|
||||
// Check restored file
|
||||
restoredContent, err := os.ReadFile(path.Join(restoreDir, locationDir, "back-me-up.txt"))
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, "hello world", string(restoredContent))
|
||||
}
|
||||
|
@ -38,19 +38,3 @@ backends:
|
||||
```
|
||||
|
||||
With this setting, if a key is missing, `autorestic` will crash instead of generating a new key and updating your config file.
|
||||
|
||||
## Automatic Backend Initialization
|
||||
|
||||
`autorestic` is able to automatically initialize backends for you. This is done by setting `init: true` in the config for a given backend. For example:
|
||||
|
||||
```yaml | .autorestic.yml
|
||||
backend:
|
||||
foo:
|
||||
type: ...
|
||||
path: ...
|
||||
init: true
|
||||
```
|
||||
|
||||
When you set `init: true` on a backend config, `autorestic` will automatically initialize the underlying `restic` repository that powers the backend if it's not already initialized. In practice, this means that the backend will be initialized the first time it is being backed up to.
|
||||
|
||||
This option is helpful in cases where you want to automate the configuration of `autorestic`. This means that instead of running `autorestic exec init -b ...` manually when you create a new backend, you can let `autorestic` initialize it for you.
|
||||
|
2
go.mod
2
go.mod
@ -12,7 +12,6 @@ require (
|
||||
github.com/spf13/cobra v1.4.0
|
||||
github.com/spf13/viper v1.11.0
|
||||
github.com/stretchr/testify v1.9.0
|
||||
gopkg.in/yaml.v3 v3.0.1
|
||||
)
|
||||
|
||||
require (
|
||||
@ -36,4 +35,5 @@ require (
|
||||
golang.org/x/text v0.3.8 // indirect
|
||||
gopkg.in/ini.v1 v1.66.4 // indirect
|
||||
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
@ -24,7 +24,6 @@ type Backend struct {
|
||||
Path string `mapstructure:"path,omitempty"`
|
||||
Key string `mapstructure:"key,omitempty"`
|
||||
RequireKey bool `mapstructure:"requireKey,omitempty"`
|
||||
Init bool `mapstructure:"init,omitempty"`
|
||||
Env map[string]string `mapstructure:"env,omitempty"`
|
||||
Rest BackendRest `mapstructure:"rest,omitempty"`
|
||||
Options Options `mapstructure:"options,omitempty"`
|
||||
@ -131,44 +130,20 @@ func (b Backend) validate() error {
|
||||
return err
|
||||
}
|
||||
options := ExecuteOptions{Envs: env, Silent: true}
|
||||
|
||||
err = b.EnsureInit()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Check if already initialized
|
||||
cmd := []string{"check"}
|
||||
cmd = append(cmd, combineBackendOptions("check", b)...)
|
||||
_, _, err = ExecuteResticCommand(options, cmd...)
|
||||
return err
|
||||
}
|
||||
|
||||
// EnsureInit initializes the backend if it is not already initialized
|
||||
func (b Backend) EnsureInit() error {
|
||||
env, err := b.getEnv()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
options := ExecuteOptions{Envs: env, Silent: true}
|
||||
|
||||
checkInitCmd := []string{"cat", "config"}
|
||||
checkInitCmd = append(checkInitCmd, combineBackendOptions("cat", b)...)
|
||||
_, _, err = ExecuteResticCommand(options, checkInitCmd...)
|
||||
|
||||
// Note that `restic` has a special exit code (10) to indicate that the
|
||||
// repository does not exist. This exit code was introduced in `restic@0.17.0`
|
||||
// on 2024-07-26. We're not using it here because this is a too recent and
|
||||
// people on older versions of `restic` won't have this feature work correctly.
|
||||
// See: https://restic.readthedocs.io/en/latest/075_scripting.html#exit-codes
|
||||
if err != nil {
|
||||
if err == nil {
|
||||
return nil
|
||||
} else {
|
||||
// If not initialize
|
||||
colors.Body.Printf("Initializing backend \"%s\"...\n", b.name)
|
||||
initCmd := []string{"init"}
|
||||
initCmd = append(initCmd, combineBackendOptions("init", b)...)
|
||||
_, _, err := ExecuteResticCommand(options, initCmd...)
|
||||
cmd := []string{"init"}
|
||||
cmd = append(cmd, combineBackendOptions("init", b)...)
|
||||
_, _, err := ExecuteResticCommand(options, cmd...)
|
||||
return err
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
func (b Backend) Exec(args []string) error {
|
||||
|
@ -3,10 +3,8 @@ package internal
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path"
|
||||
"testing"
|
||||
|
||||
"github.com/cupcakearmy/autorestic/internal/flags"
|
||||
"github.com/spf13/viper"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
@ -265,69 +263,3 @@ func TestValidate(t *testing.T) {
|
||||
assert.EqualError(t, err, "backend foo requires a key but none was provided")
|
||||
})
|
||||
}
|
||||
|
||||
func TestValidateInitsRepo(t *testing.T) {
|
||||
// This is normally initialized by the cobra commands but they don't run in
|
||||
// this test so we do it ourselves.
|
||||
flags.RESTIC_BIN = "restic"
|
||||
|
||||
workDir := t.TempDir()
|
||||
|
||||
b := Backend{
|
||||
name: "test",
|
||||
Type: "local",
|
||||
Path: path.Join(workDir, "backend"),
|
||||
Key: "supersecret",
|
||||
}
|
||||
|
||||
config = &Config{Backends: map[string]Backend{"test": b}}
|
||||
defer func() { config = nil }()
|
||||
|
||||
// Check should fail because the repo doesn't exist
|
||||
err := b.Exec([]string{"check"})
|
||||
assert.Error(t, err)
|
||||
|
||||
err = b.validate()
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Check should pass now
|
||||
err = b.Exec([]string{"check"})
|
||||
assert.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestEnsureInit(t *testing.T) {
|
||||
// This is normally initialized by the cobra commands but they don't run in
|
||||
// this test so we do it ourselves.
|
||||
flags.RESTIC_BIN = "restic"
|
||||
|
||||
workDir := t.TempDir()
|
||||
|
||||
b := Backend{
|
||||
name: "test",
|
||||
Type: "local",
|
||||
Path: path.Join(workDir, "backend"),
|
||||
Key: "supersecret",
|
||||
}
|
||||
|
||||
config = &Config{Backends: map[string]Backend{"test": b}}
|
||||
defer func() { config = nil }()
|
||||
|
||||
// Check should fail because the repo doesn't exist
|
||||
err := b.Exec([]string{"check"})
|
||||
assert.Error(t, err)
|
||||
|
||||
err = b.EnsureInit()
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Check should pass now
|
||||
err = b.Exec([]string{"check"})
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Run again to make sure it's idempotent
|
||||
err = b.EnsureInit()
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Check should still pass
|
||||
err = b.Exec([]string{"check"})
|
||||
assert.NoError(t, err)
|
||||
}
|
||||
|
@ -222,14 +222,6 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
|
||||
continue
|
||||
}
|
||||
|
||||
if backend.Init {
|
||||
err = backend.EnsureInit()
|
||||
if err != nil {
|
||||
errors = append(errors, err)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
cmd := []string{"backup"}
|
||||
cmd = append(cmd, combineAllOptions("backup", l, backend)...)
|
||||
if cron {
|
||||
|
Loading…
Reference in New Issue
Block a user