Compare commits

..

1 Commits

Author SHA1 Message Date
ಠ_ಠ
0e6b446c86
Merge 0a48d13d6c into bbb1c85cad 2024-02-16 20:03:42 +01:00
6 changed files with 19 additions and 37 deletions

View File

@ -34,7 +34,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
- Backup locations to multiple backends - Backup locations to multiple backends
- Snapshot policies and pruning - Snapshot policies and pruning
- Fully encrypted - Fully encrypted
- Before/after backup hooks - Pre/After hooks
- Exclude pattern/files - Exclude pattern/files
- Cron jobs for automatic backup - Cron jobs for automatic backup
- Backup & Restore docker volume - Backup & Restore docker volume

View File

@ -56,8 +56,6 @@ version: 2
extras: extras:
hooks: &foo hooks: &foo
prevalidate:
- echo "Wake up!"
before: before:
- echo "Hello" - echo "Hello"
after: after:

View File

@ -13,7 +13,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
- Backup locations to multiple backends - Backup locations to multiple backends
- Snapshot policies and pruning - Snapshot policies and pruning
- Fully encrypted - Fully encrypted
- Before/after backup hooks - Pre/After hooks
- Exclude pattern/files - Exclude pattern/files
- Cron jobs for automatic backup - Cron jobs for automatic backup
- Backup & Restore docker volumes - Backup & Restore docker volumes

View File

@ -6,28 +6,23 @@ They consist of a list of commands that will be executed in the same directory a
The following hooks groups are supported, none are required: The following hooks groups are supported, none are required:
- `prevalidate`
- `before` - `before`
- `after` - `after`
- `failure` - `failure`
- `success` - `success`
The difference between `prevalidate` and `before` hooks are that `prevalidate` is run before checking the backup location is valid, including checking that the `from` directories exist. This can be useful, for example, to mount the source filesystem that contains the directories listed in `from`.
```yml | .autorestic.yml ```yml | .autorestic.yml
locations: locations:
my-location: my-location:
from: /data from: /data
to: my-backend to: my-backend
hooks: hooks:
prevalidate:
- echo "Checks"
before: before:
- echo "One" - echo "One"
- echo "Two" - echo "Two"
- echo "Three" - echo "Three"
after: after:
- echo "Bye" - echo "Byte"
failure: failure:
- echo "Something went wrong" - echo "Something went wrong"
success: success:
@ -36,15 +31,13 @@ locations:
## Flowchart ## Flowchart
1. `prevalidate` hook 1. `before` hook
2. Check backup location 2. Run backup
3. `before` hook 3. `after` hook
4. Run backup 4. - `success` hook if no errors were found
5. `after` hook
6. - `success` hook if no errors were found
- `failure` hook if at least one error was encountered - `failure` hook if at least one error was encountered
If either the `prevalidate` or `before` hook encounters errors then the backup and `after` hooks will be skipped and only the `failed` hooks will run. If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
## Environment variables ## Environment variables

View File

@ -132,11 +132,10 @@ func (c *Config) Describe() {
tmp = "" tmp = ""
hooks := map[string][]string{ hooks := map[string][]string{
"PreValidate": l.Hooks.PreValidate, "Before": l.Hooks.Before,
"Before": l.Hooks.Before, "After": l.Hooks.After,
"After": l.Hooks.After, "Failure": l.Hooks.Failure,
"Failure": l.Hooks.Failure, "Success": l.Hooks.Success,
"Success": l.Hooks.Success,
} }
for hook, commands := range hooks { for hook, commands := range hooks {
if len(commands) > 0 { if len(commands) > 0 {

View File

@ -33,12 +33,11 @@ const (
) )
type Hooks struct { type Hooks struct {
Dir string `mapstructure:"dir"` Dir string `mapstructure:"dir"`
PreValidate HookArray `mapstructure:"prevalidate,omitempty"` Before HookArray `mapstructure:"before,omitempty"`
Before HookArray `mapstructure:"before,omitempty"` After HookArray `mapstructure:"after,omitempty"`
After HookArray `mapstructure:"after,omitempty"` Success HookArray `mapstructure:"success,omitempty"`
Success HookArray `mapstructure:"success,omitempty"` Failure HookArray `mapstructure:"failure,omitempty"`
Failure HookArray `mapstructure:"failure,omitempty"`
} }
type LocationCopy = map[string][]string type LocationCopy = map[string][]string
@ -185,18 +184,12 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
}, },
} }
// Hooks before location validation
if err := l.ExecuteHooks(l.Hooks.PreValidate, options); err != nil {
errors = append(errors, err)
goto after
}
if err := l.validate(); err != nil { if err := l.validate(); err != nil {
errors = append(errors, err) errors = append(errors, err)
goto after goto after
} }
// Hooks after location validation // Hooks
if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil { if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil {
errors = append(errors, err) errors = append(errors, err)
goto after goto after
@ -296,13 +289,12 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
} }
} }
// After backup hooks // After hooks
if err := l.ExecuteHooks(l.Hooks.After, options); err != nil { if err := l.ExecuteHooks(l.Hooks.After, options); err != nil {
errors = append(errors, err) errors = append(errors, err)
} }
after: after:
// Success/failure hooks
var commands []string var commands []string
var isSuccess = len(errors) == 0 var isSuccess = len(errors) == 0
if isSuccess { if isSuccess {