fix(iaas): print valid JSON/YAML output for list cmds

docs/stackit_security-group_list.md

@@ -13,18 +13,25 @@ stackit security-group list [flags]
 ### Examples
 
 ```
-  List all groups
+  Lists all security groups
   $ stackit security-group list
 
-  List groups with labels
+  Lists security groups with labels
   $ stackit security-group list --label-selector label1=value1,label2=value2
+
+  Lists all security groups in JSON format
+  $ stackit security-group list --output-format json
+
+  Lists up to 10 security groups
+  $ stackit security-group list --limit 10
 ```
 
 ### Options
 
 ```
   -h, --help                    Help for "stackit security-group list"
       --label-selector string   Filter by label
+      --limit int               Maximum number of entries to list
 ```
 
 ### Options inherited from parent commands

internal/cmd/affinity-groups/list/list.go

@@ -18,6 +18,7 @@ import (
 	"github.com/stackitcloud/stackit-cli/internal/pkg/flags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/print"
+	"github.com/stackitcloud/stackit-cli/internal/pkg/projectname"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/services/iaas/client"
 )
 
@@ -63,16 +64,19 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 			if err != nil {
 				return fmt.Errorf("list affinity groups: %w", err)
 			}
+			items := result.GetItems()
 
-			if items := result.Items; items != nil {
-				if model.Limit != nil && len(*items) > int(*model.Limit) {
-					*items = (*items)[:*model.Limit]
-				}
-				return outputResult(params.Printer, *model, *items)
+			projectLabel, err := projectname.GetProjectName(ctx, params.Printer, params.CliVersion, cmd)
+			if err != nil {
+				params.Printer.Debug(print.ErrorLevel, "get project name: %v", err)
+				projectLabel = model.ProjectId
 			}
 
-			params.Printer.Outputln("No affinity groups found")
-			return nil
+			// Truncate Output
+			if model.Limit != nil && len(items) > int(*model.Limit) {
+				items = items[:*model.Limit]
+			}
+			return outputResult(params.Printer, model.OutputFormat, projectLabel, items)
 		},
 	}
 	configureFlags(cmd)
@@ -110,13 +114,12 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 	return &model, nil
 }
 
-func outputResult(p *print.Printer, model inputModel, items []iaas.AffinityGroup) error {
-	var outputFormat string
-	if model.GlobalFlagModel != nil {
-		outputFormat = model.OutputFormat
-	}
-
+func outputResult(p *print.Printer, outputFormat, projectLabel string, items []iaas.AffinityGroup) error {
 	return p.OutputResult(outputFormat, items, func() error {
+		if len(items) == 0 {
+			p.Outputf("No affinity groups found for project %q\n", projectLabel)
+			return nil
+		}
 		table := tables.NewTable()
 		table.SetHeader("ID", "NAME", "POLICY")
 		for _, item := range items {

internal/cmd/affinity-groups/list/list_test.go

@@ -141,23 +141,40 @@ func TestBuildRequest(t *testing.T) {
 }
 
 func TestOutputResult(t *testing.T) {
+	type args struct {
+		outputFormat string
+		projectLabel string
+		instances    []iaas.AffinityGroup
+	}
 	tests := []struct {
 		description string
-		model       inputModel
-		response    []iaas.AffinityGroup
+		args        args
 		isValid     bool
 	}{
 		{
 			description: "empty",
-			model:       inputModel{},
-			response:    []iaas.AffinityGroup{},
+			args:        args{},
 			isValid:     true,
 		},
+		{
+			description: "empty slice",
+			args: args{
+				instances: []iaas.AffinityGroup{},
+			},
+			isValid: true,
+		},
+		{
+			description: "empty affinity group in slice",
+			args: args{
+				instances: []iaas.AffinityGroup{{}},
+			},
+			isValid: true,
+		},
 	}
 	params := testparams.NewTestParams()
 	for _, tt := range tests {
 		t.Run(tt.description, func(t *testing.T) {
-			err := outputResult(params.Printer, tt.model, tt.response)
+			err := outputResult(params.Printer, tt.args.outputFormat, tt.args.projectLabel, tt.args.instances)
 			if err != nil {
 				if !tt.isValid {
 					return

internal/cmd/image/list/list.go

@@ -81,21 +81,18 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 
 			// Call API
 			request := buildRequest(ctx, model, apiClient)
-
 			response, err := request.Execute()
 			if err != nil {
 				return fmt.Errorf("list images: %w", err)
 			}
+			items := response.GetItems()
 
-			if items := response.GetItems(); len(items) == 0 {
-				params.Printer.Info("No images found for project %q", projectLabel)
-			} else {
-				if model.Limit != nil && len(items) > int(*model.Limit) {
-					items = (items)[:*model.Limit]
-				}
-				if err := outputResult(params.Printer, model.OutputFormat, items); err != nil {
-					return fmt.Errorf("output images: %w", err)
-				}
+			// Truncate output
+			if model.Limit != nil && len(items) > int(*model.Limit) {
+				items = (items)[:*model.Limit]
+			}
+			if err := outputResult(params.Printer, model.OutputFormat, projectLabel, items); err != nil {
+				return fmt.Errorf("output images: %w", err)
 			}
 
 			return nil
@@ -149,8 +146,12 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
 	return request
 }
 
-func outputResult(p *print.Printer, outputFormat string, items []iaas.Image) error {
+func outputResult(p *print.Printer, outputFormat, projectLabel string, items []iaas.Image) error {
 	return p.OutputResult(outputFormat, items, func() error {
+		if len(items) == 0 {
+			p.Outputf("No images found for project %q\n", projectLabel)
+			return nil
+		}
 		table := tables.NewTable()
 		table.SetHeader("ID", "NAME", "OS", "ARCHITECTURE", "DISTRIBUTION", "VERSION", "SCOPE", "OWNER", "LABELS")
 		for i := range items {

internal/cmd/image/list/list_test.go

@@ -188,6 +188,7 @@ func TestBuildRequest(t *testing.T) {
 func Test_outputResult(t *testing.T) {
 	type args struct {
 		outputFormat string
+		projectLabel string
 		items        []iaas.Image
 	}
 	tests := []struct {
@@ -215,7 +216,7 @@ func Test_outputResult(t *testing.T) {
 	params := testparams.NewTestParams()
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.items); (err != nil) != tt.wantErr {
+			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.projectLabel, tt.args.items); (err != nil) != tt.wantErr {
 				t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})

internal/cmd/key-pair/list/list.go

@@ -77,12 +77,9 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 				return fmt.Errorf("list key pairs: %w", err)
 			}
 
-			if resp.Items == nil || len(*resp.Items) == 0 {
-				params.Printer.Info("No key pairs found\n")
-				return nil
-			}
+			items := resp.GetItems()
 
-			items := *resp.Items
+			// Truncate output
 			if model.Limit != nil && len(items) > int(*model.Limit) {
 				items = items[:*model.Limit]
 			}
@@ -130,6 +127,11 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APICli
 
 func outputResult(p *print.Printer, outputFormat string, keyPairs []iaas.Keypair) error {
 	return p.OutputResult(outputFormat, keyPairs, func() error {
+		if len(keyPairs) == 0 {
+			p.Outputf("No key pairs found\n")
+			return nil
+		}
+
 		table := tables.NewTable()
 		table.SetHeader("KEY PAIR NAME", "LABELS", "FINGERPRINT", "CREATED AT", "UPDATED AT")
 

internal/cmd/network-area/list/list.go

@@ -32,7 +32,7 @@ const (
 type inputModel struct {
 	*globalflags.GlobalFlagModel
 	Limit          *int64
-	OrganizationId *string
+	OrganizationId string
 	LabelSelector  *string
 }
 
@@ -80,31 +80,30 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
 				return fmt.Errorf("list network areas: %w", err)
 			}
 
-			if resp.Items == nil || len(*resp.Items) == 0 {
-				var orgLabel string
-				rmApiClient, err := rmClient.ConfigureClient(params.Printer, params.CliVersion)
-				if err == nil {
-					orgLabel, err = rmUtils.GetOrganizationName(ctx, rmApiClient, *model.OrganizationId)
-					if err != nil {
-						params.Printer.Debug(print.ErrorLevel, "get organization name: %v", err)
-						orgLabel = *model.OrganizationId
-					} else if orgLabel == "" {
-						orgLabel = *model.OrganizationId
-					}
-				} else {
-					params.Printer.Debug(print.ErrorLevel, "configure resource manager client: %v", err)
+			items := resp.GetItems()
+
+			var orgLabel string
+			rmApiClient, err := rmClient.ConfigureClient(params.Printer, params.CliVersion)
+			if err == nil {
+				orgLabel, err = rmUtils.GetOrganizationName(ctx, rmApiClient, model.OrganizationId)
+				if err != nil {
+					params.Printer.Debug(print.ErrorLevel, "get organization name: %v", err)
+					orgLabel = model.OrganizationId
 				}
-				params.Printer.Info("No STACKIT Network Areas found for organization %q\n", orgLabel)
-				return nil
+			} else {
+				params.Printer.Debug(print.ErrorLevel, "configure resource manager client: %v", err)
+			}
+
+			if orgLabel == "" {
+				orgLabel = model.OrganizationId
 			}
 
 			// Truncate output
-			items := *resp.Items
 			if model.Limit != nil && len(items) > int(*model.Limit) {
 				items = items[:*model.Limit]
 			}
 
-			return outputResult(params.Printer, model.OutputFormat, items)
+			return outputResult(params.Printer, model.OutputFormat, orgLabel, items)
 		},
 	}
 	configureFlags(cmd)
@@ -133,7 +132,7 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 	model := inputModel{
 		GlobalFlagModel: globalFlags,
 		Limit:           limit,
-		OrganizationId:  flags.FlagToStringPointer(p, cmd, organizationIdFlag),
+		OrganizationId:  flags.FlagToStringValue(p, cmd, organizationIdFlag),
 		LabelSelector:   flags.FlagToStringPointer(p, cmd, labelSelectorFlag),
 	}
 
@@ -142,15 +141,20 @@ func parseInput(p *print.Printer, cmd *cobra.Command, _ []string) (*inputModel,
 }
 
 func buildRequest(ctx context.Context, model *inputModel, apiClient *iaas.APIClient) iaas.ApiListNetworkAreasRequest {
-	req := apiClient.ListNetworkAreas(ctx, *model.OrganizationId)
+	req := apiClient.ListNetworkAreas(ctx, model.OrganizationId)
 	if model.LabelSelector != nil {
 		req = req.LabelSelector(*model.LabelSelector)
 	}
 	return req
 }
 
-func outputResult(p *print.Printer, outputFormat string, networkAreas []iaas.NetworkArea) error {
+func outputResult(p *print.Printer, outputFormat, orgLabel string, networkAreas []iaas.NetworkArea) error {
 	return p.OutputResult(outputFormat, networkAreas, func() error {
+		if len(networkAreas) == 0 {
+			p.Outputf("No STACKIT Network Areas found for organization %q\n", orgLabel)
+			return nil
+		}
+
 		table := tables.NewTable()
 		table.SetHeader("ID", "Name", "# Attached Projects")
 

internal/cmd/network-area/list/list_test.go

@@ -39,7 +39,7 @@ func fixtureInputModel(mods ...func(model *inputModel)) *inputModel {
 		GlobalFlagModel: &globalflags.GlobalFlagModel{
 			Verbosity: globalflags.VerbosityDefault,
 		},
-		OrganizationId: &testOrganizationId,
+		OrganizationId: testOrganizationId,
 		Limit:          utils.Ptr(int64(10)),
 		LabelSelector:  utils.Ptr(testLabelSelector),
 	}
@@ -167,6 +167,7 @@ func TestBuildRequest(t *testing.T) {
 func TestOutputResult(t *testing.T) {
 	type args struct {
 		outputFormat string
+		orgLabel     string
 		networkAreas []iaas.NetworkArea
 	}
 	tests := []struct {
@@ -197,7 +198,7 @@ func TestOutputResult(t *testing.T) {
 	params := testparams.NewTestParams()
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.networkAreas); (err != nil) != tt.wantErr {
+			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.orgLabel, tt.args.networkAreas); (err != nil) != tt.wantErr {
 				t.Errorf("outputResult() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})