chore: add json/yaml output to CLI

obot-platform · Nov 13, 2024 · c04c290 · c04c290
1 parent f309fe9
commit c04c290
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 21 deletions.
diff --git a/pkg/cli/agents.go b/pkg/cli/agents.go
@@ -9,9 +9,10 @@ import (
 )
 
 type Agents struct {
-	root  *Otto8
-	Quiet bool `usage:"Only print IDs of agents" short:"q"`
-	Wide  bool `usage:"Print more information" short:"w"`
+	root   *Otto8
+	Quiet  bool   `usage:"Only print IDs of agents" short:"q"`
+	Wide   bool   `usage:"Print more information" short:"w"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
 }
 
 func (l *Agents) Customize(cmd *cobra.Command) {
@@ -24,6 +25,10 @@ func (l *Agents) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if ok, err := output(l.Output, agents); ok || err != nil {
+		return err
+	}
+
 	if l.Quiet {
 		for _, agent := range agents.Items {
 			fmt.Println(agent.ID)

diff --git a/pkg/cli/output.go b/pkg/cli/output.go
@@ -0,0 +1,30 @@
+package cli
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"sigs.k8s.io/yaml"
+)
+
+func output(format string, obj any) (bool, error) {
+	if format == "" || format == "table" {
+		return false, nil
+	}
+	switch format {
+	case "json":
+		enc := json.NewEncoder(os.Stdout)
+		enc.SetIndent("", "  ")
+		return true, enc.Encode(obj)
+	case "yaml":
+		data, err := yaml.Marshal(obj)
+		if err != nil {
+			return false, err
+		}
+		_, err = os.Stdout.Write(data)
+		return true, err
+	default:
+		return false, fmt.Errorf("unsupported output format: %s", format)
+	}
+}
diff --git a/pkg/cli/root.go b/pkg/cli/root.go
@@ -56,7 +56,7 @@ func New() *cobra.Command {
 		cmd.Command(&Tools{root: root},
 			&ToolUnregister{root: root},
 			&ToolRegister{root: root},
-			&StepTemplateUpdate{root: root}),
+			&ToolUpdate{root: root}),
 		&Webhooks{root: root},
 		&Server{},
 		&Version{},

diff --git a/pkg/cli/runs.go b/pkg/cli/runs.go
@@ -14,9 +14,10 @@ import (
 
 type Runs struct {
 	root   *Otto8
-	Wide   bool `usage:"Print more information" short:"w"`
-	Quiet  bool `usage:"Only print IDs of runs" short:"q"`
-	Follow bool `usage:"Follow the output of runs" short:"f"`
+	Wide   bool   `usage:"Print more information" short:"w"`
+	Quiet  bool   `usage:"Only print IDs of runs" short:"q"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
+	Follow bool   `usage:"Follow the output of runs" short:"f"`
 }
 
 func (l *Runs) Customize(cmd *cobra.Command) {
@@ -110,6 +111,9 @@ func (l *Runs) Run(cmd *cobra.Command, args []string) error {
 		if err != nil {
 			return err
 		}
+		if ok, err := output(l.Output, runs); ok || err != nil {
+			return err
+		}
 		list = sliceToIter(runs.Items)
 	}
 

diff --git a/pkg/cli/threads.go b/pkg/cli/threads.go
@@ -9,9 +9,10 @@ import (
 )
 
 type Threads struct {
-	root  *Otto8
-	Quiet bool `usage:"Only print IDs of threads" short:"q"`
-	Wide  bool `usage:"Print more information" short:"w"`
+	root   *Otto8
+	Quiet  bool   `usage:"Only print IDs of threads" short:"q"`
+	Wide   bool   `usage:"Print more information" short:"w"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
 }
 
 func (l *Threads) Customize(cmd *cobra.Command) {
@@ -25,11 +26,16 @@ func (l *Threads) Run(cmd *cobra.Command, args []string) error {
 	if len(args) > 0 {
 		opts.AgentID = args[0]
 	}
+
 	threads, err := l.root.Client.ListThreads(cmd.Context(), opts)
 	if err != nil {
 		return err
 	}
 
+	if ok, err := output(l.Output, threads); ok || err != nil {
+		return err
+	}
+
 	if l.Quiet {
 		for _, thread := range threads.Items {
 			fmt.Println(thread.ID)

diff --git a/pkg/cli/tools.go b/pkg/cli/tools.go
@@ -8,8 +8,9 @@ import (
 )
 
 type Tools struct {
-	root  *Otto8
-	Quiet bool `usage:"Only print IDs of tools" short:"q"`
+	root   *Otto8
+	Quiet  bool   `usage:"Only print IDs of tools" short:"q"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
 }
 
 func (l *Tools) Customize(cmd *cobra.Command) {
@@ -24,6 +25,10 @@ func (l *Tools) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if ok, err := output(l.Output, toolRefs); ok || err != nil {
+		return err
+	}
+
 	if l.Quiet {
 		for _, toolRef := range toolRefs.Items {
 			fmt.Println(toolRef.ID)

diff --git a/pkg/cli/steptemplates_update.go → pkg/cli/tools_update.go b/pkg/cli/steptemplates_update.go → pkg/cli/tools_update.go
@@ -6,17 +6,17 @@ import (
 	"github.com/spf13/cobra"
 )
 
-type StepTemplateUpdate struct {
+type ToolUpdate struct {
 	root  *Otto8
 	Quiet bool `usage:"Only print IDs of updated step template" short:"q"`
 }
 
-func (l *StepTemplateUpdate) Customize(cmd *cobra.Command) {
+func (l *ToolUpdate) Customize(cmd *cobra.Command) {
 	cmd.Use = "update [flags] NAME REFERENCE"
 	cmd.Args = cobra.ExactArgs(2)
 }
 
-func (l *StepTemplateUpdate) Run(cmd *cobra.Command, args []string) error {
+func (l *ToolUpdate) Run(cmd *cobra.Command, args []string) error {
 	tr, err := l.root.Client.UpdateToolReference(cmd.Context(), args[0], args[1])
 	if err != nil {
 		return err

diff --git a/pkg/cli/webhooks.go b/pkg/cli/webhooks.go
@@ -8,9 +8,10 @@ import (
 )
 
 type Webhooks struct {
-	root  *Otto8
-	Quiet bool `usage:"Only print IDs of agents" short:"q"`
-	Wide  bool `usage:"Print more information" short:"w"`
+	root   *Otto8
+	Quiet  bool   `usage:"Only print IDs of agents" short:"q"`
+	Wide   bool   `usage:"Print more information" short:"w"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
 }
 
 func (l *Webhooks) Customize(cmd *cobra.Command) {
@@ -23,6 +24,10 @@ func (l *Webhooks) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if ok, err := output(l.Output, whs); ok || err != nil {
+		return err
+	}
+
 	if l.Quiet {
 		for _, webhook := range whs.Items {
 			fmt.Println(webhook.ID)

diff --git a/pkg/cli/workflows.go b/pkg/cli/workflows.go
@@ -9,9 +9,10 @@ import (
 )
 
 type Workflows struct {
-	root  *Otto8
-	Quiet bool `usage:"Only print IDs of agents" short:"q"`
-	Wide  bool `usage:"Print more information" short:"w"`
+	root   *Otto8
+	Quiet  bool   `usage:"Only print IDs of agents" short:"q"`
+	Wide   bool   `usage:"Print more information" short:"w"`
+	Output string `usage:"Output format (table, json, yaml)" short:"o" default:"table"`
 }
 
 func (l *Workflows) Customize(cmd *cobra.Command) {
@@ -24,6 +25,10 @@ func (l *Workflows) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if ok, err := output(l.Output, wfs); ok || err != nil {
+		return err
+	}
+
 	if l.Quiet {
 		for _, agent := range wfs.Items {
 			fmt.Println(agent.ID)