Systemd template (#75)

* extract templates

* refactoring tests and use afero

* can't use template.Must with loading external templ

* todo: finish wiring up unit and timer templates to generate

* fix for macos & windows

* small refactoring

* fix tests under windows

Author: creativeprojects

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
+        "afero",
         "crond",
         "ionice",
         "launchd",

README.md

@@ -2074,6 +2074,8 @@ None of these flags are passed on the restic command line
 * **restic-stale-lock-age**: duration
 * **min-memory**: integer (MB)
 * **scheduler**: string (`crond` is the only non-default value)
+* **systemd-unit-template**: string (file containing a go template to generate systemd unit file)
+* **systemd-timer-template**: string (file containing a go template to generate systemd timer file)
 
 `[profile]`
 

commands.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"path/filepath"
 	"runtime"
 	"runtime/debug"
 	"sort"
@@ -282,14 +281,6 @@ func showProfile(output io.Writer, c *config.Config, flags commandLineFlags, arg
 	// Display deprecation notice
 	displayProfileDeprecationNotices(profile)
 
-	// All files in the configuration are relative to the configuration file, NOT the folder where resticprofile is started
-	// So we need to fix all relative files
-	rootPath := filepath.Dir(c.GetConfigFile())
-	if rootPath != "." {
-		clog.Debugf("files in configuration are relative to '%s'", rootPath)
-	}
-	profile.SetRootPath(rootPath)
-
 	config.ShowStruct(os.Stdout, profile, flags.name)
 	fmt.Println("")
 	return nil
@@ -357,8 +348,9 @@ func flagsForProfile(flags commandLineFlags, profileName string) commandLineFlag
 // createSchedule accepts one argument from the commandline: --no-start
 func createSchedule(_ io.Writer, c *config.Config, flags commandLineFlags, args []string) error {
 	type profileJobs struct {
-		scheduler, profile string
-		jobs               []*config.ScheduleConfig
+		scheduler schedule.SchedulerType
+		profile   string
+		jobs      []*config.ScheduleConfig
 	}
 
 	allJobs := make([]profileJobs, 0, 1)
@@ -456,7 +448,7 @@ func statusSchedule(w io.Writer, c *config.Config, flags commandLineFlags, args
 	return nil
 }
 
-func statusScheduleProfile(scheduler string, profile *config.Profile, schedules []*config.ScheduleConfig, flags commandLineFlags) error {
+func statusScheduleProfile(scheduler schedule.SchedulerType, profile *config.Profile, schedules []*config.ScheduleConfig, flags commandLineFlags) error {
 	displayProfileDeprecationNotices(profile)
 
 	err := statusJobs(scheduler, flags.name, convertSchedules(schedules))
@@ -466,21 +458,21 @@ func statusScheduleProfile(scheduler string, profile *config.Profile, schedules
 	return nil
 }
 
-func getScheduleJobs(c *config.Config, flags commandLineFlags) (string, *config.Profile, []*config.ScheduleConfig, error) {
+func getScheduleJobs(c *config.Config, flags commandLineFlags) (schedule.SchedulerType, *config.Profile, []*config.ScheduleConfig, error) {
 	global, err := c.GetGlobalSection()
 	if err != nil {
-		return "", nil, nil, fmt.Errorf("cannot load global section: %w", err)
+		return nil, nil, nil, fmt.Errorf("cannot load global section: %w", err)
 	}
 
 	profile, err := c.GetProfile(flags.name)
 	if err != nil {
-		return "", nil, nil, fmt.Errorf("cannot load profile '%s': %w", flags.name, err)
+		return nil, nil, nil, fmt.Errorf("cannot load profile '%s': %w", flags.name, err)
 	}
 	if profile == nil {
-		return "", nil, nil, fmt.Errorf("profile '%s' not found", flags.name)
+		return nil, nil, nil, fmt.Errorf("profile '%s' not found", flags.name)
 	}
 
-	return global.Scheduler, profile, profile.Schedules(), nil
+	return schedule.NewSchedulerType(global), profile, profile.Schedules(), nil
 }
 
 func requireScheduleJobs(schedules []*config.ScheduleConfig, flags commandLineFlags) error {
@@ -490,10 +482,10 @@ func requireScheduleJobs(schedules []*config.ScheduleConfig, flags commandLineFl
 	return nil
 }
 
-func getRemovableScheduleJobs(c *config.Config, flags commandLineFlags) (string, *config.Profile, []schedule.Config, error) {
+func getRemovableScheduleJobs(c *config.Config, flags commandLineFlags) (schedule.SchedulerType, *config.Profile, []schedule.Config, error) {
 	scheduler, profile, schedules, err := getScheduleJobs(c, flags)
 	if err != nil {
-		return "", nil, nil, err
+		return nil, nil, nil, err
 	}
 
 	configs := convertSchedules(schedules)

commands_test.go

@@ -112,7 +112,7 @@ schedule = "daily"
 	declaredCount := 0
 
 	for _, jobConfig := range schedules {
-		scheduler := schedule.NewScheduler("", jobConfig.Title())
+		scheduler := schedule.NewScheduler(schedule.SchedulerDefaultOS{}, jobConfig.Title())
 		defer func(s schedule.Scheduler) { s.Close() }(scheduler) // Capture current ref to scheduler to be able to close it when function returns.
 
 		if jobConfig.SubTitle() == "check" {

config/confidential_test.go

@@ -85,7 +85,7 @@ func TestConfidentialURLs(t *testing.T) {
 repository = "%s"
 `, url)
 
-		profile, err := getProfile("toml", testConfig, "profile")
+		profile, err := getProfile("toml", testConfig, "profile", "")
 		assert.Nil(t, err)
 		assert.NotNil(t, profile)
 
@@ -149,7 +149,7 @@ func TestConfidentialEnvironment(t *testing.T) {
 %s = "%s"
 `, name, defaultUrl)
 
-		profile, err := getProfile("toml", testConfig, "profile")
+		profile, err := getProfile("toml", testConfig, "profile", "")
 		assert.Nil(t, err)
 		assert.NotNil(t, profile)
 
@@ -180,7 +180,7 @@ profile:
     MY_TOKEN: false
     MY_PASSWORD: "otherval"
 `
-	profile, err := getProfile("yaml", testConfig, "profile")
+	profile, err := getProfile("yaml", testConfig, "profile", "")
 	assert.Nil(t, err)
 	assert.NotNil(t, profile)
 
@@ -206,7 +206,7 @@ profile:
   env:
     MY_PASSWORD: "otherval"
 `
-	profile, err := getProfile("yaml", testConfig, "profile")
+	profile, err := getProfile("yaml", testConfig, "profile", "")
 	assert.Nil(t, err)
 	assert.NotNil(t, profile)
 
@@ -220,7 +220,7 @@ func TestGetNonConfidentialArgs(t *testing.T) {
 profile:
   repository: "` + fmt.Sprintf(repo, "password") + `"
 `
-	profile, err := getProfile("yaml", testConfig, "profile")
+	profile, err := getProfile("yaml", testConfig, "profile", "")
 	assert.NoError(t, err)
 	assert.NotNil(t, profile)
 

config/config.go

@@ -9,6 +9,7 @@ import (
 	"path/filepath"
 	"reflect"
 	"strings"
+	"sync"
 	"text/template"
 
 	"github.com/creativeprojects/clog"
@@ -55,6 +56,8 @@ var (
 		confidentialValueDecoder(),
 		sliceOfMapsToMapHookFunc(),
 	))
+
+	rootPathMessage = sync.Once{}
 )
 
 // newConfig instantiate a new Config object
@@ -127,6 +130,7 @@ func LoadFile(configFile, format string) (*Config, error) {
 }
 
 // Load configuration from reader
+// This should only be used for unit tests
 func Load(input io.Reader, format string) (*Config, error) {
 	c := newConfig(format)
 	err := c.addTemplate(input, c.configFile, true)
@@ -336,6 +340,18 @@ func (c *Config) GetGlobalSection() (*Global, error) {
 	if err != nil {
 		return nil, err
 	}
+
+	// All files in the configuration are relative to the configuration file,
+	// NOT the folder where resticprofile is started
+	// So we need to fix all relative files
+	rootPath := filepath.Dir(c.GetConfigFile())
+	if rootPath != "." {
+		rootPathMessage.Do(func() {
+			clog.Debugf("files in configuration are relative to %q", rootPath)
+		})
+	}
+	global.SetRootPath(rootPath)
+
 	return global, nil
 }
 
@@ -401,7 +417,21 @@ func (c *Config) GetProfile(profileKey string) (*Profile, error) {
 			return nil, err
 		}
 	}
-	return c.getProfile(profileKey)
+	profile, err := c.getProfile(profileKey)
+	if err != nil {
+		return nil, err
+	}
+	// profile returned CAN be nil
+	if profile == nil {
+		return nil, nil
+	}
+	// All files in the configuration are relative to the configuration file,
+	// NOT the folder where resticprofile is started
+	// So we need to fix all relative files
+	rootPath := filepath.Dir(c.GetConfigFile())
+	profile.SetRootPath(rootPath)
+
+	return profile, nil
 }
 
 // getProfile from configuration
@@ -410,6 +440,7 @@ func (c *Config) getProfile(profileKey string) (*Profile, error) {
 	var profile *Profile
 
 	if !c.IsSet(profileKey) {
+		// key not found => returns a nil profile
 		return nil, nil
 	}
 

config/flag_test.go

@@ -115,6 +115,7 @@ type testStruct struct {
 	noGlobString  string `argument:"no-glob-string" argument-type:"no-glob"`
 	emptyInt      int    `argument:"empty-int"`
 	someInt       int    `argument:"some-int"`
+	uInt          uint   `argument:"u-int"`
 	notIncluded   bool
 }
 
@@ -124,6 +125,7 @@ func TestConvertStructToArgs(t *testing.T) {
 		someBoolFalse: false,
 		emptyInt:      0,
 		someInt:       10,
+		uInt:          20,
 		emptyString:   "",
 		globString:    "test",
 		noGlobString:  "test",
@@ -134,6 +136,7 @@ func TestConvertStructToArgs(t *testing.T) {
 	assert.Equal(t, map[string][]string{
 		"some-bool-true": {},
 		"some-int":       {"10"},
+		"u-int":          {"20"},
 		"glob-string":    {"test"},
 		"no-glob-string": {"test"},
 	}, args.ToMap())
@@ -145,6 +148,7 @@ func TestConvertPointerStructToArgs(t *testing.T) {
 		someBoolFalse: false,
 		emptyInt:      0,
 		someInt:       10,
+		uInt:          20,
 		emptyString:   "",
 		globString:    "test",
 		noGlobString:  "test",
@@ -155,6 +159,7 @@ func TestConvertPointerStructToArgs(t *testing.T) {
 	assert.Equal(t, map[string][]string{
 		"some-bool-true": {},
 		"some-int":       {"10"},
+		"u-int":          {"20"},
 		"glob-string":    {"test"},
 		"no-glob-string": {"test"},
 	}, args.ToMap())

config/global.go

@@ -21,6 +21,8 @@ type Global struct {
 	MinMemory            uint64        `mapstructure:"min-memory"`
 	Scheduler            string        `mapstructure:"scheduler"`
 	LegacyArguments      bool          `mapstructure:"legacy-arguments"` // broken arguments mode (before v0.15.0)
+	SystemdUnitTemplate  string        `mapstructure:"systemd-unit-template"`
+	SystemdTimerTemplate string        `mapstructure:"systemd-timer-template"`
 }
 
 // NewGlobal instantiates a new Global with default values
@@ -34,3 +36,8 @@ func NewGlobal() *Global {
 		MinMemory:            constants.DefaultMinMemory,
 	}
 }
+
+func (p *Global) SetRootPath(rootPath string) {
+	p.SystemdUnitTemplate = fixPath(p.SystemdUnitTemplate, expandEnv, absolutePrefix(rootPath))
+	p.SystemdTimerTemplate = fixPath(p.SystemdTimerTemplate, expandEnv, absolutePrefix(rootPath))
+}

config/helpers_test.go

@@ -6,7 +6,7 @@ import (
 
 // Helpers for tests
 
-func getProfile(configFormat, configString, profileKey string) (*Profile, error) {
+func getProfile(configFormat, configString, profileKey, rootPath string) (*Profile, error) {
 	c, err := Load(bytes.NewBufferString(configString), configFormat)
 	if err != nil {
 		return nil, err
@@ -16,6 +16,9 @@ func getProfile(configFormat, configString, profileKey string) (*Profile, error)
 	if err != nil {
 		return nil, err
 	}
+	if rootPath != "" {
+		profile.SetRootPath(rootPath)
+	}
 	return profile, nil
 }