Merge pull request #369 from reubenmiller/refactor-generic-worker

refactor: support outputTemplate flags for non-request based commands
reubenmiller · May 15, 2024 · 9d39f87 · 9d39f87
2 parents 2821517 + d52844d
commit 9d39f87
Show file tree

Hide file tree

Showing 32 changed files with 1,030 additions and 170 deletions.
diff --git a/pkg/cmd/activitylog/list/list.manual.go b/pkg/cmd/activitylog/list/list.manual.go
@@ -108,7 +108,7 @@ func (n *CmdList) RunE(cmd *cobra.Command, args []string) error {
 	cfg.Logger.Debugf("activity log filter: path=%s, host=%s, datefrom=%s, dateto=%s", activitylog.GetPath(), filter.Host, filter.DateFrom, filter.DateTo)
 
 	err = activitylog.GetLogEntries(filter, func(line []byte) error {
-		return n.factory.WriteJSONToConsole(cfg, cmd, "", line)
+		return n.factory.WriteOutputWithoutPropertyGuess(line, cmdutil.OutputContext{})
 	})
 
 	return err

diff --git a/pkg/cmd/alarms/subscribe/subscribe.manual.go b/pkg/cmd/alarms/subscribe/subscribe.manual.go
@@ -111,7 +111,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, c8y.RealtimeAlarms(device), opts)

diff --git a/pkg/cmd/assert/text/text.manual.go b/pkg/cmd/assert/text/text.manual.go
@@ -15,7 +15,6 @@ import (
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/cmdutil"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/flags"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/iterator"
-	"github.com/reubenmiller/go-c8y-cli/v2/pkg/jsonUtilities"
 	"github.com/santhosh-tekuri/jsonschema/v5"
 	"github.com/spf13/cobra"
 )
@@ -79,11 +78,6 @@ func (n *CmdText) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	consol, err := n.factory.Console()
-	if err != nil {
-		return err
-	}
-
 	inputIterators, err := cmdutil.NewRequestInputIterators(cmd, cfg)
 	if err != nil {
 		return err
@@ -132,12 +126,8 @@ func (n *CmdText) RunE(cmd *cobra.Command, args []string) error {
 		}
 	}
 
-	writeOutput := func(isJSON bool, output []byte) {
-		if isJSON {
-			_ = n.factory.WriteJSONToConsole(cfg, cmd, "", output)
-		} else {
-			fmt.Fprintf(consol, "%s\n", output)
-		}
+	writeOutput := func(output []byte) {
+		_ = n.factory.WriteOutputWithoutPropertyGuess(output, cmdutil.OutputContext{})
 	}
 
 	totalErrors := 0
@@ -155,16 +145,14 @@ func (n *CmdText) RunE(cmd *cobra.Command, args []string) error {
 			return cmderrors.NewUserErrorWithExitCode(cmderrors.ExitAbortedWithErrors, msg)
 		}
 
-		isJSON := jsonUtilities.IsJSONObject(input)
-
 		// schema match
 		if schema != nil {
 			var val interface{}
 			_ = json.Unmarshal(input, &val)
 			err = schema.Validate(val)
 
 			if err == nil {
-				writeOutput(isJSON, input)
+				writeOutput(input)
 			} else {
 				err = fmt.Errorf("%w. input does not match json schema. got=%s, wanted=%s", cmderrors.ErrAssertion, input, n.schema)
 			}
@@ -176,7 +164,7 @@ func (n *CmdText) RunE(cmd *cobra.Command, args []string) error {
 				if !pattern.Match(input) {
 					err = fmt.Errorf("%w. input does not match pattern. got=%s, wanted=%s", cmderrors.ErrAssertion, input, n.regex)
 				} else {
-					writeOutput(isJSON, input)
+					writeOutput(input)
 				}
 			}
 		}
@@ -187,7 +175,7 @@ func (n *CmdText) RunE(cmd *cobra.Command, args []string) error {
 				if !bytes.Equal(input, []byte(n.exact)) {
 					err = fmt.Errorf("%w. input does not match. got=%s, wanted=%s", cmderrors.ErrAssertion, input, n.exact)
 				} else {
-					writeOutput(isJSON, input)
+					writeOutput(input)
 				}
 			}
 		}

diff --git a/pkg/cmd/cmd.go b/pkg/cmd/cmd.go
@@ -399,6 +399,9 @@ func Initialize() (*root.CmdRoot, error) {
 
 	rootCmd := root.NewCmdRoot(cmdFactory, buildVersion, "")
 
+	// Add reference to root command
+	cmdFactory.SetCommand(rootCmd.Command)
+
 	tableOptions := &console.TableOptions{
 		MinColumnWidth:           configHandler.ViewColumnMinWidth(),
 		MaxColumnWidth:           configHandler.ViewColumnMaxWidth(),

diff --git a/pkg/cmd/devices/assert/factory/factory.manual.go b/pkg/cmd/devices/assert/factory/factory.manual.go
@@ -13,7 +13,6 @@ import (
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/completion"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/desiredstate"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/flags"
-	"github.com/reubenmiller/go-c8y-cli/v2/pkg/jsonUtilities"
 	"github.com/reubenmiller/go-c8y/pkg/c8y"
 	"github.com/spf13/cobra"
 )
@@ -48,10 +47,6 @@ func NewAssertCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateChecker)
 		if err != nil {
 			return err
 		}
-		consol, err := f.Console()
-		if err != nil {
-			return err
-		}
 
 		inputIterators, err := cmdutil.NewRequestInputIterators(cmd, cfg)
 		if err != nil {
@@ -111,12 +106,7 @@ func NewAssertCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateChecker)
 
 			if err == nil {
 				outValue := h.GetValue(result, input)
-
-				if jsonUtilities.IsJSONObject(outValue) {
-					_ = f.WriteJSONToConsole(cfg, cmd, "", outValue)
-				} else {
-					fmt.Fprintf(consol, "%s\n", outValue)
-				}
+				_ = f.WriteOutputWithoutPropertyGuess(outValue, cmdutil.OutputContext{})
 			}
 
 			if err != nil {
@@ -167,10 +157,6 @@ func NewAssertDeviceCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateCh
 		if err != nil {
 			return err
 		}
-		consol, err := f.Console()
-		if err != nil {
-			return err
-		}
 
 		inputIterators, err := cmdutil.NewRequestInputIterators(cmd, cfg)
 		if err != nil {
@@ -230,12 +216,7 @@ func NewAssertDeviceCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateCh
 
 			if err == nil {
 				outValue := h.GetValue(result, input)
-
-				if jsonUtilities.IsJSONObject(outValue) {
-					_ = f.WriteJSONToConsole(cfg, cmd, "", outValue)
-				} else {
-					fmt.Fprintf(consol, "%s\n", outValue)
-				}
+				_ = f.WriteOutputWithoutPropertyGuess(outValue, cmdutil.OutputContext{})
 			}
 
 			if err != nil {

diff --git a/pkg/cmd/events/subscribe/subscribe.manual.go b/pkg/cmd/events/subscribe/subscribe.manual.go
@@ -111,7 +111,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, c8y.RealtimeEvents(device), opts)

diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go
@@ -57,11 +57,6 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
 				if len(cmds) == 0 {
 					return cmderrors.NewSystemError("no installed extensions found")
 				}
-				cfg, err := f.Config()
-
-				if err != nil {
-					return err
-				}
 
 				for _, c := range cmds {
 					ext := map[string]interface{}{}
@@ -88,7 +83,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
 						return cmderrors.NewUserError("Settings error. ", err)
 					}
 
-					if err := f.WriteJSONToConsole(cfg, cmd, "", rowText); err != nil {
+					if err := f.WriteOutputWithoutPropertyGuess(rowText, cmdutil.OutputContext{}); err != nil {
 						return cmderrors.NewSystemError("Failed to write to console. ", err)
 					}
 				}

diff --git a/pkg/cmd/inventory/assert/factory/factory.manual.go b/pkg/cmd/inventory/assert/factory/factory.manual.go
@@ -12,7 +12,6 @@ import (
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/completion"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/desiredstate"
 	"github.com/reubenmiller/go-c8y-cli/v2/pkg/flags"
-	"github.com/reubenmiller/go-c8y-cli/v2/pkg/jsonUtilities"
 	"github.com/reubenmiller/go-c8y/pkg/c8y"
 	"github.com/spf13/cobra"
 )
@@ -47,10 +46,6 @@ func NewAssertCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateChecker)
 		if err != nil {
 			return err
 		}
-		consol, err := f.Console()
-		if err != nil {
-			return err
-		}
 
 		inputIterators, err := cmdutil.NewRequestInputIterators(cmd, cfg)
 		if err != nil {
@@ -113,12 +108,7 @@ func NewAssertCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateChecker)
 				result, err = desiredstate.WaitForWithRetries(retries, interval, duration, state)
 				if err == nil {
 					outValue := h.GetValue(result, input)
-
-					if jsonUtilities.IsJSONObject(outValue) {
-						_ = f.WriteJSONToConsole(cfg, cmd, "", outValue)
-					} else {
-						fmt.Fprintf(consol, "%s\n", outValue)
-					}
+					_ = f.WriteOutputWithoutPropertyGuess(outValue, cmdutil.OutputContext{})
 				}
 			} else {
 				err = inputErr
@@ -176,10 +166,6 @@ func NewAssertDeviceCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateCh
 		if err != nil {
 			return err
 		}
-		consol, err := f.Console()
-		if err != nil {
-			return err
-		}
 
 		inputIterators, err := cmdutil.NewRequestInputIterators(cmd, cfg)
 		if err != nil {
@@ -242,12 +228,7 @@ func NewAssertDeviceCmdFactory(cmd *cobra.Command, f *cmdutil.Factory, h StateCh
 				result, err = desiredstate.WaitForWithRetries(retries, interval, duration, state)
 				if err == nil {
 					outValue := h.GetValue(result, input)
-
-					if jsonUtilities.IsJSONObject(outValue) {
-						_ = f.WriteJSONToConsole(cfg, cmd, "", outValue)
-					} else {
-						fmt.Fprintf(consol, "%s\n", outValue)
-					}
+					_ = f.WriteOutputWithoutPropertyGuess(outValue, cmdutil.OutputContext{})
 				}
 			} else {
 				err = inputErr

diff --git a/pkg/cmd/inventory/subscribe/subscribe.manual.go b/pkg/cmd/inventory/subscribe/subscribe.manual.go
@@ -109,7 +109,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, c8y.RealtimeManagedObjects(device), opts)

diff --git a/pkg/cmd/inventory/wait/wait.manual.go b/pkg/cmd/inventory/wait/wait.manual.go
@@ -131,7 +131,7 @@ func (n *CmdWait) RunE(cmd *cobra.Command, args []string) error {
 		result, err := desiredstate.WaitFor(interval, duration, state)
 
 		if v, ok := result.(*c8y.ManagedObject); ok {
-			_ = n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(v.Item.Raw))
+			_ = n.factory.WriteOutputWithoutPropertyGuess([]byte(v.Item.Raw), cmdutil.OutputContext{})
 		}
 
 		if err != nil {

diff --git a/pkg/cmd/measurements/subscribe/subscribe.manual.go b/pkg/cmd/measurements/subscribe/subscribe.manual.go
@@ -111,7 +111,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, c8y.RealtimeMeasurements(device), opts)

diff --git a/pkg/cmd/notification2/subscriptions/subscribe/subscribe.manual.go b/pkg/cmd/notification2/subscriptions/subscribe/subscribe.manual.go
@@ -167,7 +167,7 @@ func (n *SubscribeCmd) RunE(cmd *cobra.Command, args []string) error {
 			}
 
 			if isMatch {
-				if err := n.factory.WriteJSONToConsole(cfg, cmd, "", msg.Payload); err != nil {
+				if err := n.factory.WriteOutputWithoutPropertyGuess(msg.Payload, cmdutil.OutputContext{}); err != nil {
 					cfg.Logger.Warnf("Could not process line. only json lines are accepted. %s", err)
 				}
 			}

diff --git a/pkg/cmd/operations/subscribe/subscribe.manual.go b/pkg/cmd/operations/subscribe/subscribe.manual.go
@@ -109,7 +109,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, c8y.RealtimeOperations(device), opts)

diff --git a/pkg/cmd/operations/wait/wait.manual.go b/pkg/cmd/operations/wait/wait.manual.go
@@ -126,7 +126,8 @@ func (n *CmdWait) RunE(cmd *cobra.Command, args []string) error {
 			if v.FailureReason != "" {
 				cfg.Logger.Warnf("Failure reason: %s", v.FailureReason)
 			}
-			_ = n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(v.Item.Raw))
+
+			_ = n.factory.WriteOutputWithoutPropertyGuess([]byte(v.Item.Raw), cmdutil.OutputContext{})
 		}
 
 		if err != nil {

diff --git a/pkg/cmd/realtime/subscribe/subscribe.manual.go b/pkg/cmd/realtime/subscribe/subscribe.manual.go
@@ -70,10 +70,6 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	cfg, err := n.factory.Config()
-	if err != nil {
-		return err
-	}
 	log, err := n.factory.Logger()
 	if err != nil {
 		return err
@@ -87,7 +83,7 @@ func (n *CmdSubscribe) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.Subscribe(client, log, n.flagChannel, opts)

diff --git a/pkg/cmd/realtime/subscribeall/subscribeall.manual.go b/pkg/cmd/realtime/subscribeall/subscribeall.manual.go
@@ -110,7 +110,7 @@ func (n *CmdSubscribeAll) RunE(cmd *cobra.Command, args []string) error {
 		MaxMessages: n.flagCount,
 		ActionTypes: n.actionTypes,
 		OnMessage: func(msg string) error {
-			return n.factory.WriteJSONToConsole(cfg, cmd, "", []byte(msg))
+			return n.factory.WriteOutputWithoutPropertyGuess([]byte(msg), cmdutil.OutputContext{})
 		},
 	}
 	return c8ysubscribe.SubscribeMultiple(client, log, patterns, opts)

diff --git a/pkg/cmd/sessions/get/get.manual.go b/pkg/cmd/sessions/get/get.manual.go
@@ -86,5 +86,5 @@ func (n *CmdGetSession) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	return n.factory.WriteJSONToConsole(cfg, cmd, "", b)
+	return n.factory.WriteOutputWithoutPropertyGuess(b, cmdutil.OutputContext{})
 }
diff --git a/pkg/cmd/settings/list/list.manual.go b/pkg/cmd/settings/list/list.manual.go
@@ -91,5 +91,10 @@ func (n *CmdList) listSettings(cmd *cobra.Command, args []string) error {
 		return cmderrors.NewUserError("Settings error. ", err)
 	}
 
-	return n.factory.WriteJSONToConsole(cfg, cmd, settingsPrefix, responseText)
+	commonOptions, err := cfg.GetOutputCommonOptions(cmd)
+	if err != nil {
+		return err
+	}
+	commonOptions.ResultProperty = settingsPrefix
+	return n.factory.WriteOutput(responseText, cmdutil.OutputContext{}, &commonOptions)
 }