breaking changes to keys

.gitignore

@@ -3,4 +3,10 @@ dist/
 .codegpt
 
 *.log
-*.sh
+*.sh
+*.yaml
+*.yml
+
+
++.changie.yaml
++.changes/

docs/content/config/command-lists.md

@@ -2,7 +2,7 @@
 title: "Command Lists"
 weight: 2
 description: >
-  This page tells you how to get use command lists.
+  This page tells you how to use command lists.
 ---
 
 Command lists are for executing commands in sequence and getting notifications from them.
@@ -11,8 +11,8 @@ The top-level object key can be anything you want but not the same as another.
 
 Lists can go in a separate file. Command lists should be in a separate file if:
 
-1. key 'cmd-lists.file' is specified
-2. lists.yml or lists.yaml is found in the same directory as the backy config file
+1. key 'cmdLists.file' is specified
+2. lists.yml or lists.yaml is found in the same directory as the backy config file (this includes remote config files as of v0.7.0)
 
 {{% notice info %}}
 The lists file is also checked in remote resources. 
@@ -70,14 +70,14 @@ Name is optional. If name is not defined, name will be the object's map key.
 
 Backy also has a cron mode, so one can run `backy cron` and start a process that schedules jobs to run at times defined in the configuration file.
 
-Adding `cron: 0 0 1 * * *` to a `cmd-lists` object will schedule the list at 1 in the morning. See [https://crontab.guru/](https://crontab.guru/) for reference.
+Adding `cron: 0 0 1 * * *` to a `cmdLists` object will schedule the list at 1 in the morning. See [https://crontab.guru/](https://crontab.guru/) for reference.
 
 {{% notice tip %}}
 Note: Backy uses the second field of cron, so add anything except `*` to the beginning of a regular cron expression.
 {{% /notice %}}
 
 ```yaml {lineNos="true" wrap="true" title="yaml"}
-cmd-lists:
+cmdLists:
   docker-container-backup: # this can be any name you want
     # all commands have to be defined
     order:

docs/content/getting-started/config.md

@@ -48,7 +48,7 @@ commands:
 To execute groups of commands in sequence, use a list configuration.
 
 ```yaml
-cmd-lists:
+cmdLists:
   cmds-to-run: # this can be any name you want
     # all commands have to be defined in the commands section
     order:
@@ -97,7 +97,7 @@ hosts:
 
 The notifications object can have two forms.
 
-For more, [see the notification object documentation](/config/notifications). The top-level map key is id that has to be referenced by the `cmd-lists` key `notifications`.
+For more, [see the notification object documentation](/config/notifications). The top-level map key is id that has to be referenced by the `cmdLists` key `notifications`.
 
 ```yaml
 notifications:

pkg/backy/config.go

@@ -90,7 +90,6 @@ func (opts *ConfigOpts) InitConfig() {
 	} else {
 		loadDefaultConfigFiles(fetcher, configFiles, backyKoanf, opts)
 	}
-
 	opts.koanf = backyKoanf
 }
 
@@ -117,7 +116,9 @@ func loadDefaultConfigFiles(fetcher remotefetcher.RemoteFetcher, configFiles []s
 
 		if data != nil {
 			if err := k.Load(rawbytes.Provider(data), yaml.Parser()); err == nil {
-				continue
+				break
+			} else {
+				logging.ExitWithMSG(fmt.Sprintf("error loading config from file %s: %v", c, err), 1, &opts.Logger)
 			}
 		}
 	}
@@ -230,7 +231,7 @@ func setupLogger(opts *ConfigOpts) zerolog.Logger {
 
 func unmarshalConfig(k *koanf.Koanf, key string, target interface{}, log zerolog.Logger) {
 	if err := k.UnmarshalWithConf(key, target, koanf.UnmarshalConf{Tag: "yaml"}); err != nil {
-		logging.ExitWithMSG(fmt.Sprintf("error unmarshalling %s struct: %v", key, err), 1, &log)
+		logging.ExitWithMSG(fmt.Sprintf("error unmarshalling key %s into struct: %v", key, err), 1, &log)
 	}
 }
 
@@ -274,10 +275,13 @@ func loadCommandLists(opts *ConfigOpts, backyKoanf *koanf.Koanf) {
 	// if config file is remote, use the directory of the remote file
 	if isRemoteURL(opts.ConfigFilePath) {
 		_, u = getRemoteDir(opts.ConfigFilePath)
+		// // Still use local list files if a remote config file is used, but use them last
 		listConfigFiles = []string{u.JoinPath("lists.yml").String(), u.JoinPath("lists.yaml").String()}
 	} else {
 		backyConfigFileDir = path.Dir(opts.ConfigFilePath)
+		// println("backyConfigFileDir", backyConfigFileDir)
 		listConfigFiles = []string{
+			// "./lists.yml", "./lists.yaml",
 			path.Join(backyConfigFileDir, "lists.yml"),
 			path.Join(backyConfigFileDir, "lists.yaml"),
 		}
@@ -291,9 +295,9 @@ func loadCommandLists(opts *ConfigOpts, backyKoanf *koanf.Koanf) {
 		}
 	}
 
-	if backyKoanf.Exists("cmd-lists") {
-		unmarshalConfig(backyKoanf, "cmd-lists", &opts.CmdConfigLists, opts.Logger)
-		if backyKoanf.Exists("cmd-lists.file") {
+	if backyKoanf.Exists("cmdLists") {
+		unmarshalConfig(backyKoanf, "cmdLists", &opts.CmdConfigLists, opts.Logger)
+		if backyKoanf.Exists("cmdLists.file") {
 			loadCmdListsFile(backyKoanf, listsConfig, opts)
 		}
 	}
@@ -319,6 +323,7 @@ func loadListConfigFile(filePath string, k *koanf.Koanf, opts *ConfigOpts) bool
 	if err != nil {
 		// if file not found, ignore
 		if errors.Is(err, remotefetcher.ErrIgnoreFileNotFound) {
+			println("File not found", filePath)
 			return true
 		}
 
@@ -334,12 +339,13 @@ func loadListConfigFile(filePath string, k *koanf.Koanf, opts *ConfigOpts) bool
 		return false
 	}
 
+	unmarshalConfig(k, "cmdLists", &opts.CmdConfigLists, opts.Logger)
 	opts.CmdListFile = filePath
 	return true
 }
 
 func loadCmdListsFile(backyKoanf *koanf.Koanf, listsConfig *koanf.Koanf, opts *ConfigOpts) {
-	opts.CmdListFile = strings.TrimSpace(backyKoanf.String("cmd-lists.file"))
+	opts.CmdListFile = strings.TrimSpace(backyKoanf.String("cmdLists.file"))
 	if !path.IsAbs(opts.CmdListFile) {
 		opts.CmdListFile = path.Join(path.Dir(opts.ConfigFilePath), opts.CmdListFile)
 	}
@@ -359,14 +365,16 @@ func loadCmdListsFile(backyKoanf *koanf.Koanf, listsConfig *koanf.Koanf, opts *C
 		logging.ExitWithMSG(fmt.Sprintf("error loading config: %v", err), 1, &opts.Logger)
 	}
 
-	unmarshalConfig(listsConfig, "cmd-lists", &opts.CmdConfigLists, opts.Logger)
+	unmarshalConfig(listsConfig, "cmdLists", &opts.CmdConfigLists, opts.Logger)
 	opts.Logger.Info().Str("using lists config file", opts.CmdListFile).Send()
 }
 
 func validateCommandLists(opts *ConfigOpts) {
 	var cmdNotFoundSliceErr []error
 	for cmdListName, cmdList := range opts.CmdConfigLists {
+		// if cron is enabled and cron is not set, delete the list
 		if opts.cronEnabled && strings.TrimSpace(cmdList.Cron) == "" {
+			opts.Logger.Debug().Str("cron", "enabled").Str("list", cmdListName).Msg("cron not set, deleting list")
 			delete(opts.CmdConfigLists, cmdListName)
 			continue
 		}
@@ -406,9 +414,9 @@ func getLoggingKeyFromConfig(key string) string {
 	return fmt.Sprintf("logging.%s", key)
 }
 
-func getCmdListFromConfig(list string) string {
-	return fmt.Sprintf("cmd-lists.%s", list)
-}
+// func getCmdListFromConfig(list string) string {
+// 	return fmt.Sprintf("cmdLists.%s", list)
+// }
 
 func (opts *ConfigOpts) setupVault() error {
 	if !opts.koanf.Bool("vault.enabled") {

pkg/backy/cron.go

@@ -17,10 +17,7 @@ func (opts *ConfigOpts) Cron() {
 	s := gocron.NewScheduler(time.Local)
 	s.TagsUnique()
 	cmdLists := opts.CmdConfigLists
-	for listName, config := range cmdLists {
-		if config.Name == "" {
-			config.Name = listName
-		}
+	for _, config := range cmdLists {
 
 		cron := strings.TrimSpace(config.Cron)
 		if cron != "" {

pkg/backy/types.go

@@ -187,7 +187,7 @@ type (
 
 		// CmdConfigLists holds the lists of commands to be run in order.
 		// Key is the command list name.
-		CmdConfigLists map[string]*CmdList `yaml:"cmd-lists"`
+		CmdConfigLists map[string]*CmdList `yaml:"cmdLists"`
 
 		// Hosts holds the Host config.
 		// key is the host.