Refactor 'pgo show' functions and update help output

Issue: PGO-13

Author: tjmoore4

docs/content/reference/pgo_show_backup.md

@@ -53,9 +53,9 @@ stanza: db
 ### Options
 
 ```
-  -h, --help                      help for backup
-  -o, --output pgbackrestFormat   output format. types supported: text,json (default text)
-      --repoName string           Set the repository name for the command. example: repo1
+  -h, --help              help for backup
+  -o, --output string     output format. types supported: text,json (default "text")
+      --repoName string   Set the repository name for the command. example: repo1
 ```
 
 ### Options inherited from parent commands

docs/content/reference/pgo_show_ha.md

@@ -44,8 +44,8 @@ pgo show ha hippo --output json
 ### Options
 
 ```
-  -h, --help                   help for ha
-  -o, --output patroniFormat   output format. types supported: pretty,tsv,json,yaml (default pretty)
+  -h, --help            help for ha
+  -o, --output string   output format. types supported: pretty,tsv,json,yaml (default "pretty")
 ```
 
 ### Options inherited from parent commands

internal/cmd/show.go

@@ -87,13 +87,26 @@ HA
 
 		// Print the pgbackrest info output received.
 		cmd.Printf("BACKUP\n\n")
-		if err := newShowBackupCommand(config).RunE(cmd, args); err != nil {
+		if stdout, stderr, err := showBackup(config, args, "text", ""); err != nil {
 			return err
+		} else {
+			cmd.Printf(stdout)
+			if stderr != "" {
+				cmd.Printf("\nError returned: %s\n", stderr)
+			}
 		}
 
 		// Print the patronictl list output received.
 		cmd.Printf("\nHA\n\n")
-		return newShowHACommand(config).RunE(cmd, args)
+		if stdout, stderr, err := showHA(config, args, "pretty"); err != nil {
+			return err
+		} else {
+			cmd.Printf(stdout)
+			if stderr != "" {
+				cmd.Printf("\nError returned: %s\n", stderr)
+			}
+		}
+		return nil
 	}
 
 	return cmdShow
@@ -164,28 +177,37 @@ stanza: db
 		// handle validation.
 		repoNum := strings.TrimPrefix(repoName, "repo")
 
-		exec, err := getPrimaryExec(config, args)
-		if err != nil {
-			return err
-		}
+		stdout, stderr, err := showBackup(config, args, outputEnum.String(), repoNum)
 
-		stdout, stderr, err := Executor(exec).pgBackRestInfo(outputEnum.String(), repoNum)
-		if err != nil {
-			return err
+		if err == nil {
+			cmd.Printf(stdout)
+			if stderr != "" {
+				cmd.Printf("\nError returned: %s\n", stderr)
+			}
 		}
 
-		// Print the output received.
-		cmd.Printf(stdout)
-		if stderr != "" {
-			cmd.Printf("\nError returned: %s\n", stderr)
-		}
-
-		return nil
+		return err
 	}
 
 	return cmdShowBackup
 }
 
+// showBackup execs into the primary Pod, runs the 'pgbackrest info' command and
+// returns the command output and/or error
+func showBackup(
+	config *internal.Config,
+	args []string,
+	output string,
+	repoNum string) (string, string, error) {
+
+	exec, err := getPrimaryExec(config, args)
+	if err != nil {
+		return "", "", err
+	}
+
+	return Executor(exec).pgBackRestInfo(output, repoNum)
+}
+
 // newShowHACommand returns the output of the 'patronictl list' command.
 // - https://patroni.readthedocs.io/en/latest/patronictl.html#patronictl-list
 func newShowHACommand(config *internal.Config) *cobra.Command {
@@ -227,28 +249,35 @@ pgo show ha hippo --output json
 	// Define the 'show backup' command
 	cmdShowHA.RunE = func(cmd *cobra.Command, args []string) error {
 
-		exec, err := getPrimaryExec(config, args)
-		if err != nil {
-			return err
-		}
-
-		stdout, stderr, err := Executor(exec).patronictl("list", outputEnum.String())
-		if err != nil {
-			return err
-		}
+		stdout, stderr, err := showHA(config, args, outputEnum.String())
 
-		// Print the output received.
-		cmd.Printf(stdout)
-		if stderr != "" {
-			cmd.Printf("\nError returned: %s\n", stderr)
+		if err == nil {
+			cmd.Printf(stdout)
+			if stderr != "" {
+				cmd.Printf("\nError returned: %s\n", stderr)
+			}
 		}
 
-		return nil
+		return err
 	}
 
 	return cmdShowHA
 }
 
+// showHA execs into the primary Pod, runs the 'patronictl list' command and
+// returns the command output and/or error
+func showHA(
+	config *internal.Config,
+	args []string,
+	output string) (string, string, error) {
+	exec, err := getPrimaryExec(config, args)
+	if err != nil {
+		return "", "", err
+	}
+
+	return Executor(exec).patronictl("list", output)
+}
+
 // getPrimaryExec returns a executor function for the primary Pod to allow for
 // commands to be run against it.
 func getPrimaryExec(config *internal.Config, args []string) (

internal/util/enum.go

@@ -16,6 +16,12 @@ package util
 
 import "errors"
 
+// Define custom value types to use as flags for certain commands.
+// Cobra uses the pflag package and allows custom value types by implementing
+// the pflag.Value interface.
+// - https://github.com/spf13/pflag
+// - https://pkg.go.dev/github.com/spf13/pflag#Value
+
 // 'patroni list' output format options
 // - https://patroni.readthedocs.io/en/latest/patronictl.html#patronictl-list
 type patroniFormat string
@@ -45,7 +51,7 @@ func (e *patroniFormat) Set(v string) error {
 
 // Type is only used in help text
 func (e *patroniFormat) Type() string {
-	return "patroniFormat"
+	return "string"
 }
 
 // 'pgbackrest info' output format options
@@ -75,5 +81,5 @@ func (e *pgbackrestFormat) Set(v string) error {
 
 // Type is only used in help text
 func (e *pgbackrestFormat) Type() string {
-	return "pgbackrestFormat"
+	return "string"
 }