fix(iaas): print valid JSON/YAML output for list cmds by j1n-o9r · Pull Request #1365 · stackitcloud/stackit-cli

j1n-o9r · 2026-04-13T09:57:50Z

Description

relates to STACKITCLI-241 / #893

Addition: I encountered a missing --limit-flag within the stackit security-group list command and directly fixed this after consulting @marceljk

Testing Instructions

Test for every list command that is changed (like f.e. stackit server list) if the command returns the expected outputs like:

stackit server list -> Expected: No servers found for project "xxx"
stackit server list --output-format json -> Should output valid JSON
stackit server list --output-format yaml -> Should output valid YAML

Mock responses if testing against API is not possible.

Checklist

Issue was linked above
Code format was applied: make fmt
Examples were added / adjusted (see e.g. here)
Docs are up-to-date: make generate-docs (will be checked by CI)
Unit tests got implemented or updated
Unit tests are passing: make test (will be checked by CI)
No linter issues: make lint (will be checked by CI)

rubenhoenle · 2026-04-14T08:23:56Z

Missing:

stackit-cli/internal/cmd/security-group/list/list.go

Line 72 in 83cf194

params.Printer.Info("No security groups found for project %q", projectLabel)
stackit-cli/internal/cmd/public-ip/list/list.go

Line 88 in 83cf194

params.Printer.Info("No public IPs found for project %q\n", projectLabel)
stackit-cli/internal/cmd/volume/list/list.go

Line 85 in 83cf194

params.Printer.Info("No volumes found for project %q\n", projectLabel)
stackit-cli/internal/cmd/volume/performance-class/list/list.go

Line 86 in 83cf194

params.Printer.Info("No volume performance class found for project %q\n", projectLabel)
stackit-cli/internal/cmd/volume/snapshot/list/list.go

Line 82 in 83cf194

params.Printer.Info("No snapshots found for project %q\n", projectLabel)
stackit-cli/internal/cmd/key-pair/list/list.go

Line 81 in 83cf194

params.Printer.Info("No key pairs found\n")
stackit-cli/internal/cmd/image/list/list.go

Line 91 in 83cf194

params.Printer.Info("No images found for project %q", projectLabel)
stackit-cli/internal/cmd/affinity-groups/list/list.go

Line 74 in 83cf194

params.Printer.Outputln("No affinity groups found")

... and maybe more. Please check carefully 😅

j1n-o9r · 2026-04-15T07:24:10Z

Missing:

stackit-cli/internal/cmd/security-group/list/list.go

Line 72 in 83cf194

params.Printer.Info("No security groups found for project %q", projectLabel)

stackit-cli/internal/cmd/public-ip/list/list.go

Line 88 in 83cf194

params.Printer.Info("No public IPs found for project %q\n", projectLabel)

stackit-cli/internal/cmd/volume/list/list.go

Line 85 in 83cf194

params.Printer.Info("No volumes found for project %q\n", projectLabel)

stackit-cli/internal/cmd/volume/performance-class/list/list.go

Line 86 in 83cf194

params.Printer.Info("No volume performance class found for project %q\n", projectLabel)

stackit-cli/internal/cmd/volume/snapshot/list/list.go

Line 82 in 83cf194

params.Printer.Info("No snapshots found for project %q\n", projectLabel)

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

Line 81 in 83cf194

params.Printer.Info("No key pairs found\n")

stackit-cli/internal/cmd/image/list/list.go

Line 91 in 83cf194

params.Printer.Info("No images found for project %q", projectLabel)

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

Line 74 in 83cf194

params.Printer.Outputln("No affinity groups found")

... and maybe more. Please check carefully 😅

Sorry, I mistakenly understood the examples in the ticket as acceptance criteria and did not check the other resources. I will go through all and add the missing parts.😅

rubenhoenle · 2026-04-20T17:42:00Z

@j1n-o9r We currently have a lot of merge conflicts here, could you please resolve them before one of the collegues starts with a review? 😅

… any items via outputResult function instead of returning nil bluntly. adapted tests therefore.

… feedback

…ions

rubenhoenle · 2026-04-22T13:39:52Z

 }

-func outputResult(p *print.Printer, model inputModel, items []iaas.AffinityGroup) error {
-	var outputFormat string


Why did you change this and the method signature?

It looked weird at first glance that the signature differed from all other outputResult functions. I also could not see a benefit from passing the model into the function. Furthermore I also think the state that is checked in the function will not happen, since if the input model will be nil and the outputResult function cannot be called. But maybe I am overseeing something here. Should I change it to the old signature?

rubenhoenle · 2026-04-22T13:42:22Z

 			description: "empty",
-			model:       inputModel{},
-			response:    []iaas.AffinityGroup{},
+			args:        args{},


You changed that testcase with that change. The response parameter was an empty slice before, now it's nil.

Valid testcase, but be aware what you're doing here. As commented above the question is why you changed the method signature at all? 😄

Thank you for reminding that the case differs, honestly I don't know if I was aware of that when editing but I am now. 😄

I would suggest maybe having both cases tested.

rubenhoenle · 2026-04-22T13:45:37Z

-				return nil
+			items := resp.GetItems()
+
+			projectLabel, err := projectname.GetProjectName(ctx, params.Printer, params.CliVersion, cmd)


see above, please remove this

rubenhoenle · 2026-04-22T13:45:48Z

 			params := testparams.NewTestParams()

-			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.keyPairs); (err != nil) != tt.wantErr {
+			if err := outputResult(params.Printer, tt.args.outputFormat, tt.args.projectLabel, tt.args.keyPairs); (err != nil) != tt.wantErr {


revert pls, see above

rubenhoenle · 2026-04-22T13:52:45Z

+			}
+
+			if orgLabel == "" {
+				orgLabel = *model.OrganizationId


Take care: potential nil pointer de-reference. May result in a panic.

Actually the organization id flag is required:

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

Line 119 in 47f322d

err := flags.MarkFlagsRequired(cmd, organizationIdFlag)

So I would suggest you mark it as a string type instead of a string pointer (*string) in the model struct

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

Line 35 in 47f322d

OrganizationId *string

Seems like this was implemented poorly in the past. If you correct it you don't have to take care here of the nil pointer de-reference at all. 😅

rubenhoenle · 2026-04-22T13:53:18Z

-				return nil
+			items := resp.GetItems()
+
+			var networkAreaLabel string


Suggested change

var networkAreaLabel string

rubenhoenle · 2026-04-22T13:53:26Z

+			items := resp.GetItems()
+
+			var networkAreaLabel string
+			networkAreaLabel, err = iaasUtils.GetNetworkAreaName(ctx, apiClient, *model.OrganizationId, *model.NetworkAreaId)


Suggested change

networkAreaLabel, err = iaasUtils.GetNetworkAreaName(ctx, apiClient, *model.OrganizationId, *model.NetworkAreaId)

networkAreaLabel, err := iaasUtils.GetNetworkAreaName(ctx, apiClient, *model.OrganizationId, *model.NetworkAreaId)

rubenhoenle · 2026-04-22T13:54:36Z

+			networkAreaLabel, err = iaasUtils.GetNetworkAreaName(ctx, apiClient, *model.OrganizationId, *model.NetworkAreaId)
+			if err != nil {
+				params.Printer.Debug(print.ErrorLevel, "get organization name: %v", err)
+				networkAreaLabel = *model.NetworkAreaId


Same here. Potential nil pointer de-reference. The networkAreaIdFlag is marked as required. So change it's type from *string to string in the model struct please.

rubenhoenle · 2026-04-22T13:55:08Z

+func outputResult(p *print.Printer, outputFormat, networkAreaLabel string, networkRanges []iaas.NetworkRange) error {
 	return p.OutputResult(outputFormat, networkRanges, func() error {
+		if len(networkRanges) == 0 {
+			p.Outputf("No network ranges found for SNA %q\n", networkAreaLabel)


Suggested change

p.Outputf("No network ranges found for SNA %q\n", networkAreaLabel)

p.Outputf("No network ranges found for STACKIT network area %q\n", networkAreaLabel)

rubenhoenle · 2026-04-22T13:56:14Z

 			}

-			return nil
+			// Truncate output


Nice catch, thanks!

Co-authored-by: Ruben Hönle <git@hoenle.xyz>

…o deal with nil values since it is required anyways

… string for not having to deal with nil values since it is required anyways

j1n-o9r marked this pull request as ready for review April 13, 2026 15:07

j1n-o9r requested a review from a team as a code owner April 13, 2026 15:07

j1n-o9r marked this pull request as draft April 15, 2026 12:52

j1n-o9r force-pushed the fix/STACKITCLI-241-iaas-json-list-output branch 2 times, most recently from fadd859 to eaa4afb Compare April 22, 2026 10:26

j1n-o9r added 22 commits April 22, 2026 12:28

fix returning empty server array in case the response does not return…

70b932b

… any items via outputResult function instead of returning nil bluntly. adapted tests therefore.

adapted outputResult signature to comply to linter

14cca95

switched to getter for retrieving the items

972a75e

adapted printing behavior to align with expected behavior

7f78cf8

change printing to defined output instead of stderr

936bb00

adapted network list command to align to expectations

07bb839

remove unnecessary normalization of nil value in response items after…

f015fae

… feedback

adapted network-area list command to align to expectations

7fb466a

removed redundant check

2e13f98

adapted affinity list command to align to expectations

fd6ccb0

adapted image list command to align to expectations

6752d88

adapted key pair list command to align to expectations

3f6a8be

fixed debug print in key pair list command

8e34092

move project label retrieval

51fb3e1

adapted public ip list command to align to expectations

4661dc5

adapted security group list command to align to expectations

e0db653

added missing --limit flag for list security groups command

b3afc4b

adapted volumes list command to align to expectations

f8d2829

adapted volume snapshots list command to align to expectations

bf4718f

adapted volume performance class list command to align to expectations

a888af1

adapted volume backups list command to align to expectations

02db11e

fixed order of params

42eafa4

j1n-o9r added 8 commits April 22, 2026 12:33

adapted network area network ranges list command to align to expectat…

48e9f80

…ions

adapted network area routes list command to align to expectations

b663d3d

adapted security group rules list command to align to expectations

777630a

adapted server machine-types list command to align to expectations

8885e05

adapted server network-interfaces list command to align to expectations

e72a115

adapted server service accounts list command to align to expectations

4083b93

adapted server volumes list command to align to expectations

ee1b411

removed unnecessary check in public ip

9b8c40d

j1n-o9r force-pushed the fix/STACKITCLI-241-iaas-json-list-output branch from eaa4afb to 9b8c40d Compare April 22, 2026 10:35

j1n-o9r added 2 commits April 22, 2026 13:39

regenerate docs

de440de

fixed linter issue

f25cdc0

j1n-o9r marked this pull request as ready for review April 22, 2026 11:46

rubenhoenle reviewed Apr 22, 2026

View reviewed changes

Comment thread internal/cmd/key-pair/list/list.go Outdated

rubenhoenle reviewed Apr 22, 2026

View reviewed changes

Comment thread internal/cmd/security-group/list/list.go

}

return nil

// Truncate output

Copy link
Copy Markdown

Member

rubenhoenle Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks!

j1n-o9r and others added 7 commits April 22, 2026 16:11

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

2a3e7ee

Co-authored-by: Ruben Hönle <git@hoenle.xyz>

(fix): remove mistakenly added project label from key pairs list command

884f8c7

(fix): made orgLabel in model from pointer to string for not having t…

d24108d

…o deal with nil values since it is required anyways

(fix): remove unnecessarily declaring variable with explicit statement

dac4b2a

(fix): made OrganizationId and NetworkAreaId in model from pointer to…

3e80ea6

… string for not having to deal with nil values since it is required anyways

(fix): changed print statement to not contain abbreviation

68c108c

(fix): added test suggestion

81e4c72

	networkAreaLabel, err = iaasUtils.GetNetworkAreaName(ctx, apiClient, model.OrganizationId, model.NetworkAreaId)
	networkAreaLabel, err := iaasUtils.GetNetworkAreaName(ctx, apiClient, model.OrganizationId, model.NetworkAreaId)

	p.Outputf("No network ranges found for SNA %q\n", networkAreaLabel)
	p.Outputf("No network ranges found for STACKIT network area %q\n", networkAreaLabel)

Conversation

j1n-o9r commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing Instructions

Checklist

Uh oh!

rubenhoenle commented Apr 14, 2026

Uh oh!

j1n-o9r commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rubenhoenle commented Apr 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j1n-o9r Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j1n-o9r Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

j1n-o9r commented Apr 13, 2026 •

edited

Loading

j1n-o9r commented Apr 15, 2026 •

edited

Loading

j1n-o9r Apr 22, 2026 •

edited

Loading

j1n-o9r Apr 22, 2026 •

edited

Loading