added beginning of tests

.changes/unreleased/Changed-20250228-173825.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: Changed PackageOperation to enums
+time: 2025-02-28T17:38:25.426136588-06:00

backy.code-workspace

@@ -7,6 +7,7 @@
 	],
 	"settings": {
 		"cSpell.words": [
+			"Autorestic",
 			"Cmds",
 			"CMDSTDOUT",
 			"knadh",

cmd/cron.go

@@ -18,7 +18,11 @@ var (
 func cron(cmd *cobra.Command, args []string) {
 	parseS3Config()
 
-	opts := backy.NewOpts(cfgFile, backy.EnableCron(), backy.SetLogFile(logFile), backy.SetCmdStdOut(cmdStdOut))
+	opts := backy.NewOpts(cfgFile,
+		backy.EnableCron(),
+		backy.SetLogFile(logFile),
+		backy.SetCmdStdOut(cmdStdOut))
+
 	opts.InitConfig()
 	opts.ReadConfig()
 

getCommandHelp

@@ -1,79 +1,83 @@
 #!/bin/bash
 CLI_PAGE="docs/content/cli/_index.md"
+
+BACKYCOMMAND="go run backy.go"
+
+{
 echo "---
-title: "CLI"
+title: CLI
 weight: 4
 ---
 
 This page lists documentation for the CLI.
-" > _index.md
+" 
 
-BACKYCOMMAND="go run backy.go"
-
-echo "## Backy " >> _index.md
-echo " " >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo " " >> _index.md
+echo "## Backy "
+echo " "
+echo "\`\`\`"
+eval "${BACKYCOMMAND} -h"
+echo "\`\`\`"
+echo " "
 
 
-echo "# Subcommands" >> _index.md
-echo "" >> _index.md
 
-echo "## backup" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} backup -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo "" >> _index.md
+echo "# Subcommands" 
+echo "" 
 
-echo "## cron" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} cron -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo "" >> _index.md
+echo "## backup" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} backup -h"
+echo "\`\`\`" 
+echo "" 
 
-echo "## exec" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} exec -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo "" >> _index.md
+echo "## cron" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} cron -h"
+echo "\`\`\`" 
+echo "" 
 
-echo "### exec host" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} exec host -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo "" >> _index.md
+echo "## exec" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} exec -h"
+echo "\`\`\`" 
+echo "" 
+
+echo "### exec host" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} exec host -h"
+echo "\`\`\`" 
+echo "" 
 
 
-echo "## version" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} version -h >>  _index.md"
-echo "\`\`\`" >> _index.md
-echo "" >> _index.md
+echo "## version" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} version -h"
+echo "\`\`\`" 
+echo "" 
 
-echo "## list" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} list -h >>  _index.md"
-echo "\`\`\`" >> _index.md
+echo "## list" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} list -h"
+echo "\`\`\`" 
 
-echo "## list cmds" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} list cmds -h >>  _index.md"
-echo "\`\`\`" >> _index.md
+echo "## list cmds" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} list cmds -h"
+echo "\`\`\`" 
 
-echo "## list lists" >> _index.md
-echo "" >> _index.md
-echo "\`\`\`" >> _index.md
-eval "${BACKYCOMMAND} list lists -h >>  _index.md"
-echo "\`\`\`" >> _index.md
+echo "## list lists" 
+echo "" 
+echo "\`\`\`" 
+eval "${BACKYCOMMAND} list lists -h"
+echo "\`\`\`" 
+} >> _index.md
 
 
 mv _index.md "$CLI_PAGE"

pkg/backy/backy.go

@@ -68,7 +68,7 @@ func (command *Command) RunCmd(cmdCtxLogger zerolog.Logger, opts *ConfigOpts) ([
 	} else {
 
 		// Handle package operations
-		if command.Type == PackageCT && command.PackageOperation == "checkVersion" {
+		if command.Type == PackageCT && command.PackageOperation == PackOppCheckVersion {
 			cmdCtxLogger.Info().Str("package", command.PackageName).Msg("Checking package versions")
 
 			// Execute the package version command

pkg/backy/config.go

@@ -585,7 +585,7 @@ func processCmds(opts *ConfigOpts) error {
 			if cmd.PackageManager == "" {
 				return fmt.Errorf("package manager is required for package command %s", cmd.PackageName)
 			}
-			if cmd.PackageOperation == "" {
+			if cmd.PackageOperation.String() == "" {
 				return fmt.Errorf("package operation is required for package command %s", cmd.PackageName)
 			}
 			if cmd.PackageName == "" {
@@ -594,15 +594,16 @@ func processCmds(opts *ConfigOpts) error {
 			var err error
 
 			// Validate the operation
-			switch cmd.PackageOperation {
-			case "install", "remove", "upgrade", "checkVersion":
+			if cmd.PackageOperation.IsAPackageOperation() {
+
 				cmd.pkgMan, err = pkgman.PackageManagerFactory(cmd.PackageManager, pkgman.WithoutAuth())
 				if err != nil {
 					return err
 				}
-			default:
+			} else {
 				return fmt.Errorf("unsupported package operation %s for command %s", cmd.PackageOperation, cmd.Name)
 			}
+
 		}
 
 		// Parse user commands

pkg/backy/packageoperation_enumer.go

@@ -0,0 +1,145 @@
+// Code generated by "enumer -linecomment -yaml -text -json -type=PackageOperation"; DO NOT EDIT.
+
+package backy
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+)
+
+const _PackageOperationName = "installupgradepurgeremovecheckVersionisInstalled"
+
+var _PackageOperationIndex = [...]uint8{0, 0, 7, 14, 19, 25, 37, 48}
+
+const _PackageOperationLowerName = "installupgradepurgeremovecheckversionisinstalled"
+
+func (i PackageOperation) String() string {
+	if i < 0 || i >= PackageOperation(len(_PackageOperationIndex)-1) {
+		return fmt.Sprintf("PackageOperation(%d)", i)
+	}
+	return _PackageOperationName[_PackageOperationIndex[i]:_PackageOperationIndex[i+1]]
+}
+
+// An "invalid array index" compiler error signifies that the constant values have changed.
+// Re-run the stringer command to generate them again.
+func _PackageOperationNoOp() {
+	var x [1]struct{}
+	_ = x[DefaultPO-(0)]
+	_ = x[PackOppInstall-(1)]
+	_ = x[PackOppUpgrade-(2)]
+	_ = x[PackOppPurge-(3)]
+	_ = x[PackOppRemove-(4)]
+	_ = x[PackOppCheckVersion-(5)]
+	_ = x[PackOppIsInstalled-(6)]
+}
+
+var _PackageOperationValues = []PackageOperation{DefaultPO, PackOppInstall, PackOppUpgrade, PackOppPurge, PackOppRemove, PackOppCheckVersion, PackOppIsInstalled}
+
+var _PackageOperationNameToValueMap = map[string]PackageOperation{
+	_PackageOperationName[0:0]:        DefaultPO,
+	_PackageOperationLowerName[0:0]:   DefaultPO,
+	_PackageOperationName[0:7]:        PackOppInstall,
+	_PackageOperationLowerName[0:7]:   PackOppInstall,
+	_PackageOperationName[7:14]:       PackOppUpgrade,
+	_PackageOperationLowerName[7:14]:  PackOppUpgrade,
+	_PackageOperationName[14:19]:      PackOppPurge,
+	_PackageOperationLowerName[14:19]: PackOppPurge,
+	_PackageOperationName[19:25]:      PackOppRemove,
+	_PackageOperationLowerName[19:25]: PackOppRemove,
+	_PackageOperationName[25:37]:      PackOppCheckVersion,
+	_PackageOperationLowerName[25:37]: PackOppCheckVersion,
+	_PackageOperationName[37:48]:      PackOppIsInstalled,
+	_PackageOperationLowerName[37:48]: PackOppIsInstalled,
+}
+
+var _PackageOperationNames = []string{
+	_PackageOperationName[0:0],
+	_PackageOperationName[0:7],
+	_PackageOperationName[7:14],
+	_PackageOperationName[14:19],
+	_PackageOperationName[19:25],
+	_PackageOperationName[25:37],
+	_PackageOperationName[37:48],
+}
+
+// PackageOperationString retrieves an enum value from the enum constants string name.
+// Throws an error if the param is not part of the enum.
+func PackageOperationString(s string) (PackageOperation, error) {
+	if val, ok := _PackageOperationNameToValueMap[s]; ok {
+		return val, nil
+	}
+
+	if val, ok := _PackageOperationNameToValueMap[strings.ToLower(s)]; ok {
+		return val, nil
+	}
+	return 0, fmt.Errorf("%s does not belong to PackageOperation values", s)
+}
+
+// PackageOperationValues returns all values of the enum
+func PackageOperationValues() []PackageOperation {
+	return _PackageOperationValues
+}
+
+// PackageOperationStrings returns a slice of all String values of the enum
+func PackageOperationStrings() []string {
+	strs := make([]string, len(_PackageOperationNames))
+	copy(strs, _PackageOperationNames)
+	return strs
+}
+
+// IsAPackageOperation returns "true" if the value is listed in the enum definition. "false" otherwise
+func (i PackageOperation) IsAPackageOperation() bool {
+	for _, v := range _PackageOperationValues {
+		if i == v {
+			return true
+		}
+	}
+	return false
+}
+
+// MarshalJSON implements the json.Marshaler interface for PackageOperation
+func (i PackageOperation) MarshalJSON() ([]byte, error) {
+	return json.Marshal(i.String())
+}
+
+// UnmarshalJSON implements the json.Unmarshaler interface for PackageOperation
+func (i *PackageOperation) UnmarshalJSON(data []byte) error {
+	var s string
+	if err := json.Unmarshal(data, &s); err != nil {
+		return fmt.Errorf("PackageOperation should be a string, got %s", data)
+	}
+
+	var err error
+	*i, err = PackageOperationString(s)
+	return err
+}
+
+// MarshalText implements the encoding.TextMarshaler interface for PackageOperation
+func (i PackageOperation) MarshalText() ([]byte, error) {
+	return []byte(i.String()), nil
+}
+
+// UnmarshalText implements the encoding.TextUnmarshaler interface for PackageOperation
+func (i *PackageOperation) UnmarshalText(text []byte) error {
+	var err error
+	*i, err = PackageOperationString(string(text))
+	return err
+}
+
+// MarshalYAML implements a YAML Marshaler for PackageOperation
+func (i PackageOperation) MarshalYAML() (interface{}, error) {
+	return i.String(), nil
+}
+
+// UnmarshalYAML implements a YAML Unmarshaler for PackageOperation
+func (i *PackageOperation) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var s string
+	if err := unmarshal(&s); err != nil {
+		return err
+	}
+
+	var err error
+	*i, err = PackageOperationString(s)
+	return err
+}

pkg/backy/ssh.go

@@ -538,7 +538,7 @@ func (command *Command) RunCmdSSH(cmdCtxLogger zerolog.Logger, opts *ConfigOpts)
 	case ScriptFileCT:
 		return command.runScriptFile(commandSession, cmdCtxLogger, &cmdOutBuf)
 	case PackageCT:
-		if command.PackageOperation == "checkVersion" {
+		if command.PackageOperation == PackOppCheckVersion {
 			commandSession.Stderr = nil
 			// Execute the package version command remotely
 			// Parse the output of package version command

pkg/backy/types.go

@@ -106,7 +106,7 @@ type (
 		PackageVersion string `yaml:"packageVersion,omitempty"`
 
 		// PackageOperation specifies the action for package-related commands (e.g., "install" or "remove")
-		PackageOperation string `yaml:"packageOperation,omitempty"`
+		PackageOperation PackageOperation `yaml:"packageOperation,omitempty"`
 
 		pkgMan pkgman.PackageManager
 
@@ -293,7 +293,10 @@ type (
 		ListName string // Name of the command list
 		Error    error  // Error encountered, if any
 	}
-	CommandType int
+
+	// use ints so we can use enums
+	CommandType      int
+	PackageOperation int
 )
 
 //go:generate go run github.com/dmarkham/enumer -linecomment -yaml -text -json -type=CommandType
@@ -305,3 +308,14 @@ const (
 	PackageCT                         // package
 	UserCT                            // user
 )
+
+//go:generate go run github.com/dmarkham/enumer -linecomment -yaml -text -json -type=PackageOperation
+const (
+	DefaultPO           PackageOperation = iota //
+	PackOppInstall                              // install
+	PackOppUpgrade                              // upgrade
+	PackOppPurge                                // purge
+	PackOppRemove                               // remove
+	PackOppCheckVersion                         // checkVersion
+	PackOppIsInstalled                          // isInstalled
+)

pkg/backy/utils.go

@@ -277,13 +277,13 @@ func getCommandTypeAndSetCommandInfo(command *Command) *Command {
 	if command.Type == PackageCT && !command.packageCmdSet {
 		command.packageCmdSet = true
 		switch command.PackageOperation {
-		case "install":
+		case PackOppInstall:
 			command.Cmd, command.Args = command.pkgMan.Install(command.PackageName, command.PackageVersion, command.Args)
-		case "remove":
+		case PackOppRemove:
 			command.Cmd, command.Args = command.pkgMan.Remove(command.PackageName, command.Args)
-		case "upgrade":
+		case PackOppUpgrade:
 			command.Cmd, command.Args = command.pkgMan.Upgrade(command.PackageName, command.PackageVersion)
-		case "checkVersion":
+		case PackOppCheckVersion:
 			command.Cmd, command.Args = command.pkgMan.CheckVersion(command.PackageName, command.PackageVersion)
 		}
 	}

tests/backy.yaml

@@ -0,0 +1,18 @@
+commands:
+  echoTestPass:
+    cmd: echo
+    shell: bash
+    Args: hello world
+
+  runRemoteShellScriptSuccess:
+    cmd: 
+
+
+  packageCommandSuccess:
+    packageName: docker-ce
+    Args:
+      - docker-ce-cli
+    packageManager: apt
+    packageOperation: install
+
+