Compare commits

..

13 Commits

Author SHA1 Message Date
d85470459f fix home directory 2022-02-16 21:58:09 +01:00
1f69a7974a bump go version 2022-02-16 21:52:12 +01:00
db9f5dea66 1.5.4 2022-02-16 21:42:54 +01:00
75160d4d6a Merge pull request #160 from cupcakearmy/1.5.3
1.5.3
2022-02-16 21:29:10 +01:00
92feaef5bb version bump 2022-02-16 21:28:13 +01:00
2a7e233cdb only check on config if it is getting used 2022-02-16 21:22:42 +01:00
a373c07fb0 contrib 2022-02-13 16:25:51 +01:00
ec9e2aebcd 1.5.2 2022-02-13 16:25:09 +01:00
7d87160706 Merge pull request #156 from jjromannet/verbose-config-loading
Add error handling to reading of config file.
2022-02-13 16:23:05 +01:00
8e1fe6af65 Merge pull request #157 from jjromannet/fix-copy-config-file-before-overriding
Make a copy of config before overriding it
2022-02-13 16:20:46 +01:00
Jan
65ba1f6ac1 Make a copy of config before overriding it 2022-02-09 20:35:29 +01:00
Jan
6bf4953003 Add error handling to reading config file. 2022-02-09 20:26:02 +01:00
27758a03fa add help message 2021-12-22 14:45:04 +01:00
13 changed files with 129 additions and 51 deletions

View File

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.5.5] - 2022-02-16
### Changed
- Go version was updated from `1.16` to `1.17`
### Fixed
- Home directory was not being taken into account for loading configs.
## [1.5.4] - 2022-02-16
### Fixed
- Lean flag not omitting all output.
## [1.5.3] - 2022-02-16
### Fixed
- Error throwing not finding config even it's not being used.
## [1.5.2] - 2022-02-13
### Fixed
- Config loading @jjromannet
- Making a backup of the file @jjromannet
## [1.5.1] - 2021-12-06 ## [1.5.1] - 2021-12-06
### Changed ### Changed

View File

@@ -1,4 +1,4 @@
FROM golang:1.16-alpine as builder FROM golang:1.17-alpine as builder
WORKDIR /app WORKDIR /app
COPY go.* . COPY go.* .

View File

@@ -2,6 +2,7 @@ package cmd
import ( import (
"github.com/cupcakearmy/autorestic/internal" "github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/flags"
"github.com/cupcakearmy/autorestic/internal/lock" "github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@@ -12,7 +13,7 @@ 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.`, 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) { Run: func(cmd *cobra.Command, args []string) {
internal.GetConfig() internal.GetConfig()
internal.CRON_LEAN, _ = cmd.Flags().GetBool("lean") flags.CRON_LEAN, _ = cmd.Flags().GetBool("lean")
err := lock.Lock() err := lock.Lock()
CheckErr(err) CheckErr(err)
defer lock.Unlock() defer lock.Unlock()

View File

@@ -3,9 +3,11 @@ package cmd
import ( import (
"os" "os"
"path/filepath" "path/filepath"
"strings"
"github.com/cupcakearmy/autorestic/internal" "github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
"github.com/cupcakearmy/autorestic/internal/lock" "github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra" "github.com/spf13/cobra"
@@ -27,7 +29,7 @@ var rootCmd = &cobra.Command{
Version: internal.VERSION, Version: internal.VERSION,
Use: "autorestic", Use: "autorestic",
Short: "CLI Wrapper for restic", Short: "CLI Wrapper for restic",
Long: "Documentation: https://autorestic.vercel.app", Long: "Documentation:\thttps://autorestic.vercel.app\nSupport:\thttps://discord.gg/wS7RpYTYd2",
} }
func Execute() { func Execute() {
@@ -36,8 +38,8 @@ func Execute() {
func init() { func init() {
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)") rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)")
rootCmd.PersistentFlags().BoolVar(&internal.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity") rootCmd.PersistentFlags().BoolVar(&flags.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity")
rootCmd.PersistentFlags().BoolVarP(&internal.VERBOSE, "verbose", "v", false, "verbose mode") rootCmd.PersistentFlags().BoolVarP(&flags.VERBOSE, "verbose", "v", false, "verbose mode")
rootCmd.PersistentFlags().StringVar(&internal.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary") rootCmd.PersistentFlags().StringVar(&internal.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
cobra.OnInitialize(initConfig) cobra.OnInitialize(initConfig)
} }
@@ -45,17 +47,22 @@ func init() {
func initConfig() { func initConfig() {
if ci, _ := rootCmd.Flags().GetBool("ci"); ci { if ci, _ := rootCmd.Flags().GetBool("ci"); ci {
colors.DisableColors(true) colors.DisableColors(true)
internal.VERBOSE = true flags.VERBOSE = true
} }
if cfgFile != "" { if cfgFile != "" {
viper.SetConfigFile(cfgFile) viper.SetConfigFile(cfgFile)
viper.AutomaticEnv()
if viper.ConfigFileUsed() == "" {
colors.Error.Println("cannot read config file %s\n", cfgFile)
os.Exit(1)
}
} else { } else {
viper.AddConfigPath(".") configPaths := []string{"."}
// Home // Home
if home, err := homedir.Dir(); err != nil { if home, err := homedir.Dir(); err == nil {
viper.AddConfigPath(home) configPaths = append(configPaths, home)
} }
// XDG_CONFIG_HOME // XDG_CONFIG_HOME
@@ -66,10 +73,17 @@ func initConfig() {
prefix = filepath.Join(home, ".config") prefix = filepath.Join(home, ".config")
} }
} }
viper.AddConfigPath(filepath.Join(prefix, "autorestic")) xdgConfig := filepath.Join(prefix, "autorestic")
configPaths = append(configPaths, xdgConfig)
} }
for _, cfgPath := range configPaths {
viper.SetConfigName(".autorestic") viper.AddConfigPath(cfgPath)
} }
if flags.VERBOSE {
colors.Faint.Printf("Using config paths: %s\n", strings.Join(configPaths, " "))
}
cfgFileName := ".autorestic"
viper.SetConfigName(cfgFileName)
viper.AutomaticEnv() viper.AutomaticEnv()
}
} }

View File

@@ -2,17 +2,18 @@
This amazing people helped the project! This amazing people helped the project!
- @agateblue - Docs, Pruning, S3 - @agateblue - Docs, Pruning, S3.
- @g-a-c - Update/Install bugs. - @g-a-c - Update/Install bugs.
- @david-boles - Docs - @jjromannet - Bug fixes.
- @SebDanielsson - Brew - @david-boles - Docs.
- @n194 - AUR Package - @SebDanielsson - Brew.
- @jin-park-dev - Typos - @n194 - AUR Package.
- @sumnerboy12 - Typos - @jin-park-dev - Typos.
- @FuzzyMistborn - Typos - @sumnerboy12 - Typos.
- @ChanceM - Typos - @FuzzyMistborn - Typos.
- @TheForcer - Typos - @ChanceM - Typos.
- @themorlan - Typos - @TheForcer - Typos.
- @somebox - Typos - @themorlan - Typos.
- @somebox - Typos.
> :ToCPrevNext > :ToCPrevNext

View File

@@ -10,7 +10,7 @@ For remote backups (S3, B2, GCS, etc.) it's quite easy, as you only need to moun
docker run --rm \\ docker run --rm \\
-v $(pwd):/data \\ -v $(pwd):/data \\
cupcakearmy/autorestic \\ cupcakearmy/autorestic \\
autorestic backup -va autorestic backup -va -c /data/.autorestic.yaml
``` ```
## Rclone ## Rclone

22
go.mod
View File

@@ -1,6 +1,6 @@
module github.com/cupcakearmy/autorestic module github.com/cupcakearmy/autorestic
go 1.16 go 1.17
require ( require (
github.com/blang/semver/v4 v4.0.0 github.com/blang/semver/v4 v4.0.0
@@ -12,3 +12,23 @@ require (
github.com/spf13/cobra v1.1.3 github.com/spf13/cobra v1.1.3
github.com/spf13/viper v1.7.1 github.com/spf13/viper v1.7.1
) )
require (
github.com/fsnotify/fsnotify v1.4.7 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/inconshreveable/mousetrap v1.0.0 // indirect
github.com/magiconair/properties v1.8.1 // indirect
github.com/mattn/go-colorable v0.1.8 // indirect
github.com/mattn/go-isatty v0.0.12 // indirect
github.com/mitchellh/mapstructure v1.1.2 // indirect
github.com/pelletier/go-toml v1.2.0 // indirect
github.com/spf13/afero v1.1.2 // indirect
github.com/spf13/cast v1.3.0 // indirect
github.com/spf13/jwalterweatherman v1.0.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/subosito/gotenv v1.2.0 // indirect
golang.org/x/sys v0.0.0-20210331175145-43e1dd70ce54 // indirect
golang.org/x/text v0.3.2 // indirect
gopkg.in/ini.v1 v1.51.0 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
)

View File

@@ -9,6 +9,7 @@ import (
"strings" "strings"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
) )
type BackendRest struct { type BackendRest struct {
@@ -128,7 +129,7 @@ func (b Backend) validate() error {
// If not initialize // If not initialize
colors.Body.Printf("Initializing backend \"%s\"...\n", b.name) colors.Body.Printf("Initializing backend \"%s\"...\n", b.name)
out, err := ExecuteResticCommand(options, "init") out, err := ExecuteResticCommand(options, "init")
if VERBOSE { if flags.VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
} }
return err return err
@@ -146,7 +147,7 @@ func (b Backend) Exec(args []string) error {
colors.Error.Println(out) colors.Error.Println(out)
return err return err
} }
if VERBOSE { if flags.VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
} }
return nil return nil

View File

@@ -9,6 +9,7 @@ import (
"sync" "sync"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
"github.com/cupcakearmy/autorestic/internal/lock" "github.com/cupcakearmy/autorestic/internal/lock"
"github.com/joho/godotenv" "github.com/joho/godotenv"
"github.com/mitchellh/go-homedir" "github.com/mitchellh/go-homedir"
@@ -16,11 +17,7 @@ import (
"github.com/spf13/viper" "github.com/spf13/viper"
) )
const VERSION = "1.5.1" const VERSION = "1.5.5"
var CI bool = false
var VERBOSE bool = false
var CRON_LEAN bool = false
type OptionMap map[string][]interface{} type OptionMap map[string][]interface{}
type Options map[string]OptionMap type Options map[string]OptionMap
@@ -52,18 +49,23 @@ func GetConfig() *Config {
if config == nil { if config == nil {
once.Do(func() { once.Do(func() {
if err := viper.ReadInConfig(); err == nil { if err := viper.ReadInConfig(); err == nil {
if !CRON_LEAN {
absConfig, _ := filepath.Abs(viper.ConfigFileUsed()) absConfig, _ := filepath.Abs(viper.ConfigFileUsed())
if !flags.CRON_LEAN {
colors.Faint.Println("Using config: \t", absConfig) colors.Faint.Println("Using config: \t", absConfig)
}
// Load env file // Load env file
envFile := filepath.Join(filepath.Dir(absConfig), ".autorestic.env") envFile := filepath.Join(filepath.Dir(absConfig), ".autorestic.env")
err = godotenv.Load(envFile) err = godotenv.Load(envFile)
if err == nil { if err == nil {
colors.Faint.Println("Using env:\t", envFile) colors.Faint.Println("Using env:\t", envFile)
} }
}
} else { } else {
return cfgFileName := ".autorestic"
colors.Error.Println(
fmt.Sprintf(
"cannot find configuration file '%s.yml' or '%s.yaml'.",
cfgFileName, cfgFileName))
os.Exit(1)
} }
var versionConfig interface{} var versionConfig interface{}
@@ -259,7 +261,7 @@ func (c *Config) SaveConfig() error {
if err := CopyFile(file, file+".old"); err != nil { if err := CopyFile(file, file+".old"); err != nil {
return err return err
} }
colors.Secondary.Println("Saved a backup copy of your file next the the original.") colors.Secondary.Println("Saved a backup copy of your file next to the original.")
viper.Set("backends", c.Backends) viper.Set("backends", c.Backends)
viper.Set("locations", c.Locations) viper.Set("locations", c.Locations)

5
internal/flags/flags.go Normal file
View File

@@ -0,0 +1,5 @@
package flags
var CI bool = false
var VERBOSE bool = false
var CRON_LEAN bool = false

View File

@@ -9,6 +9,7 @@ import (
"time" "time"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
"github.com/cupcakearmy/autorestic/internal/lock" "github.com/cupcakearmy/autorestic/internal/lock"
"github.com/cupcakearmy/autorestic/internal/metadata" "github.com/cupcakearmy/autorestic/internal/metadata"
"github.com/robfig/cron" "github.com/robfig/cron"
@@ -108,7 +109,7 @@ func (l Location) ExecuteHooks(commands []string, options ExecuteOptions) error
colors.Error.Println(out) colors.Error.Println(out)
return err return err
} }
if VERBOSE { if flags.VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
} }
} }
@@ -227,7 +228,7 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
options.Envs[k+"_"+fmt.Sprint(i)] = v options.Envs[k+"_"+fmt.Sprint(i)] = v
options.Envs[k+"_"+strings.ToUpper(backend.name)] = v options.Envs[k+"_"+strings.ToUpper(backend.name)] = v
} }
if VERBOSE { if flags.VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
} }
} }
@@ -276,7 +277,7 @@ func (l Location) Forget(prune bool, dry bool) error {
} }
cmd = append(cmd, combineOptions("forget", l, backend)...) cmd = append(cmd, combineOptions("forget", l, backend)...)
out, err := ExecuteResticCommand(options, cmd...) out, err := ExecuteResticCommand(options, cmd...)
if VERBOSE { if flags.VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
} }
if err != nil { if err != nil {
@@ -367,7 +368,7 @@ func (l Location) RunCron() error {
lock.SetCron(l.name, now.Unix()) lock.SetCron(l.name, now.Unix())
l.Backup(true, "") l.Backup(true, "")
} else { } else {
if !CRON_LEAN { if !flags.CRON_LEAN {
colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name) colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)
} }
} }

View File

@@ -6,6 +6,7 @@ import (
"sync" "sync"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
"github.com/spf13/viper" "github.com/spf13/viper"
) )
@@ -25,7 +26,9 @@ func getLock() *viper.Viper {
os.Exit(1) os.Exit(1)
} }
file = path.Join(path.Dir(p), ".autorestic.lock.yml") file = path.Join(path.Dir(p), ".autorestic.lock.yml")
if !flags.CRON_LEAN {
colors.Faint.Println("Using lock:\t", file) colors.Faint.Println("Using lock:\t", file)
}
lock.SetConfigFile(file) lock.SetConfigFile(file)
lock.SetConfigType("yml") lock.SetConfigType("yml")
lock.ReadInConfig() lock.ReadInConfig()

View File

@@ -8,6 +8,7 @@ import (
"os/exec" "os/exec"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/flags"
) )
var RESTIC_BIN string var RESTIC_BIN string
@@ -36,7 +37,7 @@ func ExecuteCommand(options ExecuteOptions, args ...string) (string, error) {
cmd.Env = env cmd.Env = env
cmd.Dir = options.Dir cmd.Dir = options.Dir
if VERBOSE { if flags.VERBOSE {
colors.Faint.Printf("> Executing: %s\n", cmd) colors.Faint.Printf("> Executing: %s\n", cmd)
} }
@@ -60,13 +61,13 @@ func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error
} }
func CopyFile(from, to string) error { func CopyFile(from, to string) error {
original, err := os.Open("original.txt") original, err := os.Open(from)
if err != nil { if err != nil {
return nil return nil
} }
defer original.Close() defer original.Close()
new, err := os.Create("new.txt") new, err := os.Create(to)
if err != nil { if err != nil {
return nil return nil
} }