Add json output format (#238)

* fix typo in error message

* remove unused flag

* add json output format for the responses

* fix linting

* adapt some parameters in Contribution file

* change globalflags to print to use json format

* Update internal/cmd/opensearch/credentials/create/create.go

Co-authored-by: Vicente Pinto <[email protected]>

* remove redundant error from return values of config list

* shift switch case in the outputResult function

---------

Co-authored-by: Vicente Pinto <[email protected]>

Author: GokceGK

CONTRIBUTION.md

@@ -74,7 +74,7 @@ type inputModel struct {
 }
 
 // "bar" command constructor
-func NewCmd() *cobra.Command {
+func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "bar",
 		Short: "Short description of the command (is shown in the help of parent command)",
@@ -88,13 +88,13 @@ func NewCmd() *cobra.Command {
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
-			model, err := parseInput(cmd, args)
+			model, err := parseInput(p, cmd, args)
 			if err != nil {
 				return err
 			}
 
 			// Configure API client
-			apiClient, err := client.ConfigureClient(cmd)
+			apiClient, err := client.ConfigureClient(p, cmd)
 			if err != nil {
 				return err
 			}
@@ -106,7 +106,7 @@ func NewCmd() *cobra.Command {
 				return fmt.Errorf("(...): %w", err)
 			}
 
-         projectLabel, err := projectname.GetProjectName(ctx, cmd)
+         projectLabel, err := projectname.GetProjectName(ctx, p, cmd)
 				if err != nil {
 					projectLabel = model.ProjectId
 				}
@@ -116,7 +116,7 @@ func NewCmd() *cobra.Command {
             p.Info("(...)", projectLabel)
 				return nil
          }
-			return outputResult(cmd, model.OutputFormat, instances)
+			return outputResult(p, cmd, model.OutputFormat, instances)
 		},
 	}
 
@@ -152,9 +152,9 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *foo.APIClie
 }
 
 // Output result based on the configured output format
-func outputResult(cmd *cobra.Command, outputFormat string, resources []foo.Resource) error {
+func outputResult(p *print.Printer, cmd *cobra.Command, outputFormat string, resources []foo.Resource) error {
 	switch outputFormat {
-	case globalflags.JSONOutputFormat:
+	case print.JSONOutputFormat:
 		details, err := json.MarshalIndent(resources, "", "  ")
 		if err != nil {
 			return fmt.Errorf("marshal resource list: %w", err)
@@ -177,7 +177,7 @@ func outputResult(cmd *cobra.Command, outputFormat string, resources []foo.Resou
 }
 ```
 
-Please remeber to always add unit tests for `parseInput`, `buildRequest` (in `bar_test.go`), and any other util functions used.
+Please remember to always add unit tests for `parseInput`, `buildRequest` (in `bar_test.go`), and any other util functions used.
 
 If the new command `bar` is the first command in the CLI using a STACKIT service `foo`, please refer to [Onboarding a new STACKIT service](./CONTRIBUTION.md/#onboarding-a-new-stackit-service).
 

internal/cmd/argus/instance/create/create.go

@@ -2,6 +2,7 @@ package create
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 
@@ -102,12 +103,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				s.Stop()
 			}
 
-			operationState := "Created"
-			if model.Async {
-				operationState = "Triggered creation of"
-			}
-			p.Outputf("%s instance for project %q. Instance ID: %s\n", operationState, projectLabel, instanceId)
-			return nil
+			return outputResult(p, model, projectLabel, resp)
 		},
 	}
 	configureFlags(cmd)
@@ -190,3 +186,23 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient argusClient)
 	})
 	return req, nil
 }
+
+func outputResult(p *print.Printer, model *inputModel, projectLabel string, resp *argus.CreateInstanceResponse) error {
+	switch model.OutputFormat {
+	case print.JSONOutputFormat:
+		details, err := json.MarshalIndent(resp, "", "  ")
+		if err != nil {
+			return fmt.Errorf("marshal Argus instance: %w", err)
+		}
+		p.Outputln(string(details))
+
+		return nil
+	default:
+		operationState := "Created"
+		if model.Async {
+			operationState = "Triggered creation of"
+		}
+		p.Outputf("%s instance for project %q. Instance ID: %s\n", operationState, projectLabel, *resp.InstanceId)
+		return nil
+	}
+}

internal/cmd/config/list/list.go

@@ -1,7 +1,9 @@
 package list
 
 import (
+	"encoding/json"
 	"fmt"
+
 	"slices"
 	"sort"
 	"strconv"
@@ -10,13 +12,18 @@ import (
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/config"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
+	"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/print"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/tables"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
+type inputModel struct {
+	*globalflags.GlobalFlagModel
+}
+
 func NewCmd(p *print.Printer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "list",
@@ -35,56 +42,82 @@ func NewCmd(p *print.Printer) *cobra.Command {
 			examples.NewExample(
 				`List your active configuration`,
 				"$ stackit config list"),
+			examples.NewExample(
+				`List your active configuration in a json format`,
+				"$ stackit config list --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			configData := viper.AllSettings()
 
-			// Sort the config options by key
-			configKeys := make([]string, 0, len(configData))
-			for k := range configData {
-				configKeys = append(configKeys, k)
-			}
-			sort.Strings(configKeys)
+			model := parseInput(p, cmd)
+			return outputResult(p, model.OutputFormat, configData)
+		},
+	}
+	return cmd
+}
 
-			table := tables.NewTable()
-			table.SetHeader("NAME", "VALUE")
-			for _, key := range configKeys {
-				value := configData[key]
+func parseInput(p *print.Printer, cmd *cobra.Command) *inputModel {
+	globalFlags := globalflags.Parse(p, cmd)
 
-				// Convert value to string
-				// (Assuming value is either string or bool)
-				valueString, ok := value.(string)
-				if !ok {
-					valueBool, ok := value.(bool)
-					if !ok {
-						continue
-					}
-					valueString = strconv.FormatBool(valueBool)
-				}
+	return &inputModel{
+		GlobalFlagModel: globalFlags,
+	}
+}
 
-				// Don't show unset values
-				if valueString == "" {
-					continue
-				}
+func outputResult(p *print.Printer, outputFormat string, configData map[string]any) error {
+	switch outputFormat {
+	case print.JSONOutputFormat:
+		details, err := json.MarshalIndent(configData, "", "  ")
+		if err != nil {
+			return fmt.Errorf("marshal config list: %w", err)
+		}
+		p.Outputln(string(details))
+		return nil
+	default:
+		// Sort the config options by key
+		configKeys := make([]string, 0, len(configData))
+		for k := range configData {
+			configKeys = append(configKeys, k)
+		}
+		sort.Strings(configKeys)
 
-				// Don't show unsupported (deprecated or user-inputted) configuration options
-				// that might be present in the config file
-				if !slices.Contains(config.ConfigKeys, key) {
+		table := tables.NewTable()
+		table.SetHeader("NAME", "VALUE")
+		for _, key := range configKeys {
+			value := configData[key]
+
+			// Convert value to string
+			// (Assuming value is either string or bool)
+			valueString, ok := value.(string)
+			if !ok {
+				valueBool, ok := value.(bool)
+				if !ok {
 					continue
 				}
+				valueString = strconv.FormatBool(valueBool)
+			}
 
-				// Replace "_" with "-" to match the flags
-				key = strings.ReplaceAll(key, "_", "-")
-
-				table.AddRow(key, valueString)
-				table.AddSeparator()
+			// Don't show unset values
+			if valueString == "" {
+				continue
 			}
-			err := table.Display(p)
-			if err != nil {
-				return fmt.Errorf("render table: %w", err)
+
+			// Don't show unsupported (deprecated or user-inputted) configuration options
+			// that might be present in the config file
+			if !slices.Contains(config.ConfigKeys, key) {
+				continue
 			}
-			return nil
-		},
+
+			// Replace "_" with "-" to match the flags
+			key = strings.ReplaceAll(key, "_", "-")
+
+			table.AddRow(key, valueString)
+			table.AddSeparator()
+		}
+		err := table.Display(p)
+		if err != nil {
+			return fmt.Errorf("render table: %w", err)
+		}
+		return nil
 	}
-	return cmd
 }

internal/cmd/curl/curl.go

@@ -212,7 +212,7 @@ func outputResponse(p *print.Printer, model *inputModel, resp *http.Response) er
 	}
 	respBody, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return fmt.Errorf("read respose body: %w", err)
+		return fmt.Errorf("read response body: %w", err)
 	}
 	output = append(output, respBody...)
 

internal/cmd/dns/record-set/create/create.go

@@ -2,6 +2,7 @@ package create
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
@@ -98,12 +99,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				s.Stop()
 			}
 
-			operationState := "Created"
-			if model.Async {
-				operationState = "Triggered creation of"
-			}
-			p.Outputf("%s record set for zone %s. Record set ID: %s\n", operationState, zoneLabel, recordSetId)
-			return nil
+			return outputResult(p, model, zoneLabel, resp)
 		},
 	}
 	configureFlags(cmd)
@@ -157,3 +153,23 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *dns.APIClie
 	})
 	return req
 }
+
+func outputResult(p *print.Printer, model *inputModel, zoneLabel string, resp *dns.RecordSetResponse) error {
+	switch model.OutputFormat {
+	case print.JSONOutputFormat:
+		details, err := json.MarshalIndent(resp, "", "  ")
+		if err != nil {
+			return fmt.Errorf("marshal DNS record-set: %w", err)
+		}
+		p.Outputln(string(details))
+
+		return nil
+	default:
+		operationState := "Created"
+		if model.Async {
+			operationState = "Triggered creation of"
+		}
+		p.Outputf("%s record set for zone %s. Record set ID: %s\n", operationState, zoneLabel, *resp.Rrset.Id)
+		return nil
+	}
+}

internal/cmd/dns/zone/create/create.go

@@ -2,6 +2,7 @@ package create
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
@@ -112,12 +113,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				s.Stop()
 			}
 
-			operationState := "Created"
-			if model.Async {
-				operationState = "Triggered creation of"
-			}
-			p.Outputf("%s zone for project %q. Zone ID: %s\n", operationState, projectLabel, zoneId)
-			return nil
+			return outputResult(p, model, projectLabel, resp)
 		},
 	}
 	configureFlags(cmd)
@@ -186,3 +182,23 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *dns.APIClie
 	})
 	return req
 }
+
+func outputResult(p *print.Printer, model *inputModel, projectLabel string, resp *dns.ZoneResponse) error {
+	switch model.OutputFormat {
+	case print.JSONOutputFormat:
+		details, err := json.MarshalIndent(resp, "", "  ")
+		if err != nil {
+			return fmt.Errorf("marshal DNS zone: %w", err)
+		}
+		p.Outputln(string(details))
+
+		return nil
+	default:
+		operationState := "Created"
+		if model.Async {
+			operationState = "Triggered creation of"
+		}
+		p.Outputf("%s zone for project %q. Zone ID: %s\n", operationState, projectLabel, *resp.Zone.Id)
+		return nil
+	}
+}