OCM-1520 | feat: Add --hide-empty-columns flag to rosa list commands by olucasfreitas · Pull Request #2983 · openshift/rosa

olucasfreitas · 2025-08-21T01:56:48Z

Details

This PR improves the UX when listing resources by introducing a new --hide-empty-columns flag that automatically hides columns containing no data across all rows, making the output cleaner and more readable.

The flag has been added to the following rosa list commands:

accessrequests
accountroles
addon
breakglasscredential
cluster
dnsdomains
gates
iamserviceaccounts
idp
ingress
instancetypes
ocmroles
oidcconfig
operatorroles
region
service
upgrade

Note: The following commands do NOT have this flag:

list machinepools - Already has built-in auto-hide empty columns logic
list version, list userroles, list user, list rhRegion, list tuningconfigs, list oidcprovider, list kubeletconfig, list externalauthprovider - These maintain their original behavior

Default Behavior (All Columns Shown)

Run any supported list command without the flag:
```
./rosa list clusters
```

You should see all columns displayed, including empty ones:

ID          NAME        STATE  TOPOLOGY  REGION      PROVIDER  VERSION
1a2b3c4d    my-cluster  ready            us-east-1   aws       4.14.0
5e6f7g8h    test-rosa   ready            us-west-2   aws       4.13.5

Using --hide-empty-columns Flag

Run the same command with the flag:

./rosa list clusters --hide-empty-columns

Empty columns (like TOPOLOGY in this example) should be automatically hidden:

ID          NAME        STATE  REGION      PROVIDER  VERSION
1a2b3c4d    my-cluster  ready  us-east-1   aws       4.14.0
5e6f7g8h    test-rosa   ready  us-west-2   aws       4.13.5

New behavior of the '--all'

The --all flag shows the 3 additional columns (AZ TYPE, WIN-LI ENABLED, DEDICATED HOST) but still hides empty columns:

./rosa list machinepools --cluster <cluster-name> --all

Example output:

ID       AUTOSCALING  REPLICAS  INSTANCE TYPE  SPOT INSTANCES  DISK SIZE  AZ TYPE   WIN-LI ENABLED  DEDICATED HOST
workers  No           3         m5.xlarge      No              default    Standard  No              No

Ticket

Closes [OCM-1520]

openshift-ci · 2025-08-21T01:57:08Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: olucasfreitas
Once this PR has been reviewed and has the lgtm label, please assign gdbranco for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

codecov · 2025-08-21T02:21:47Z

Codecov Report

❌ Patch coverage is 26.70807% with 354 lines in your changes missing coverage. Please review.
✅ Project coverage is 27.76%. Comparing base (8f44abd) to head (fc6c0ed).
⚠️ Report is 254 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/output/table_filter.go	50.00%	47 Missing and 3 partials ⚠️
cmd/list/addon/cmd.go	3.03%	32 Missing ⚠️
cmd/list/operatorroles/cmd.go	3.57%	27 Missing ⚠️
cmd/list/gates/cmd.go	3.70%	26 Missing ⚠️
pkg/machinepool/machinepool.go	46.93%	25 Missing and 1 partial ⚠️
cmd/list/idp/cmd.go	4.16%	23 Missing ⚠️
cmd/list/ocmroles/cmd.go	5.00%	19 Missing ⚠️
cmd/list/ingress/cmd.go	5.26%	18 Missing ⚠️
cmd/list/service/cmd.go	5.55%	17 Missing ⚠️
cmd/list/cluster/cmd.go	6.25%	15 Missing ⚠️
... and 10 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2983      +/-   ##
==========================================
+ Coverage   27.37%   27.76%   +0.39%     
==========================================
  Files         306      317      +11     
  Lines       34350    35291     +941     
==========================================
+ Hits         9403     9799     +396     
- Misses      24301    24832     +531     
- Partials      646      660      +14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

hunterkepley

Overall looks much better than the original write, left some comments- will wait for you to make changes before doing review on the pkg/output files introduced since they may change

cmd/list/accessrequests/cmd.go

cmd/list/accessrequests/cmd_test.go

cmd/list/accountroles/cmd.go

pkg/machinepool/machinepool_test.go

pkg/machinepool/machinepool.go

olucasfreitas · 2025-08-27T20:29:53Z

@hunterkepley addressed all the comments in the new commit

hunterkepley

Some more comments, looking good 🙂 Noticed a couple of improvements which could be made to lessen the LoC committed for this effort, as well as a couple Go things that would be useful

cmd/list/accessrequests/cmd.go

cmd/list/accountroles/cmd.go

olucasfreitas · 2025-08-28T20:56:16Z

@hunterkepley new comments addressed on the new commit

hunterkepley

Some suggestions on the implementation of BuildTable as well as the edge case

cmd/list/accessrequests/cmd_test.go

cmd/list/accessrequests/cmd.go

cmd/list/accountroles/cmd.go

pkg/machinepool/machinepool.go

pkg/output/table_filter.go

hunterkepley · 2025-09-05T14:47:04Z

Here's a Go Playground showing the solution I came up with for a list of separators: https://go.dev/play/p/2qUevkuSUUz

We can pass the table data- including the new string separator list, allowing the custom format we require for some commands -into this and it will build a usable output to pass into a tabwriter, with less LoC

olucasfreitas · 2025-09-14T02:48:53Z

/retest

olucasfreitas · 2025-09-15T11:40:43Z

/test coverage

hunterkepley

some more comments, will do a more in-depth review after these are addressed since it may change up other things im worried about

pkg/output/table_filter.go

hunterkepley · 2025-09-15T18:39:41Z

pkg/output/table_filter.go

+		if len(row) == 0 {
+			continue
+		}


I'm curious, is there a case where we would expect the length of a row to be 0 in the middle of a table?

for what i understood here, empty rows can occur in real-world data

Could you provide an example?

Data Import with Blank Lines

// CSV parsing or API responses might produce: tableData := [][]string{ {"ID", "Name", "Status"}, {"1", "Alice", "Active"}, {}, // Blank line in source data {"2", "Bob", "Pending"}, }

Important Distinction

// These are different: emptyRow := []string{} // Length 0 - gets skipped ✓ blankRow := []string{"", "", ""} // Length 3 - displays with spacing

Hey Lucas, thanks for explaining the logic here;

I was more-so asking for a 'real world' example, such as one coming from the ROSA CLI. My thoughts are, that this may not be possible for our tables in the ROSA CLI, just by design. We add data generally when data exists, so there should be at least one value in each row (for loops over resource lists add data by nature causes this)

BUT- im asking for examples because I want to see if I might be wrong here, and if there's a list command which can produce empty rows

For example, if we list access requests - we use the API to fetch a list of the cluster's access requests. Then we loop through those

This pattern is pretty common across all list commands, where we fetch data before listing, since that data is generally not available locally on the user's machine

Hopefully that makes senes, LMK if you have questions

Oh, now I got it, I'm gonna run through some commands a send you the data here

So, I ran through the commands, and I stand corrected, no cases in where this can happen showed up for me, thanks for the explanation here, I addressed the changes on this commit e397f65

hunterkepley · 2025-09-15T18:45:02Z

pkg/output/table_filter.go

+	separators := make([]string, maxCols)
+	for i := range separators {
+		separators[i] = separator
+	}
+
+	BuildTableWithSeparators(writer, separators, tableData)


#2983 (comment)

In this comment I talked about having support for separators which have different separators at different parts of the table. For example, val1\tval2\t\tval3

It seems like you have support for it now, but did not actually support it, instead wrapping it in a function which makes a copy of a single separator that was passed in

If we could make that functional, and get the original separators back in the command which have unique separator values per column, that would be great

For example, list machinepools

Improved this on the last commit

@olucasfreitas im afraid this was virtually unchanged from the last commit

Worked on this on this commit 3f5390f

hunterkepley · 2025-09-15T18:49:20Z

@olucasfreitas
#2983 (comment)

What is MOCK MODE? I don't see it in this PR or in the CLI? 😄

olucasfreitas · 2025-09-17T13:19:28Z

@hunterkepley the mock mode was something I added only for testing, to activate the mock responses on the command

hunterkepley · 2025-09-17T19:32:05Z

the mock mode was something I added only for testing, to activate the mock responses on the command

@olucasfreitas You made an entire mock mode only for testing this feature?

olucasfreitas · 2025-09-17T20:04:41Z

@hunterkepley was actually pretty simple, not an ENTIRE mock mode as you maybe thought

olucasfreitas · 2025-09-17T20:07:42Z

/retest

hunterkepley

seems there were a missed comment or 2 from the last round of review, id like to address those first before going to deep on another (but I did add some comments)

hunterkepley · 2025-09-18T14:52:22Z

pkg/machinepool/machinepool_test.go

+			headers, tableData := getNodePoolsData(cluster.NodePools().Slice())
+			out := formatTableString(headers, tableData)
+
+			expectedOutput := fmt.Sprintf("ID\tAUTOSCALING\tREPLICAS\tINSTANCE TYPE\tLABELS\tTAINTS\tAVAILABILITY ZONE\tSUBNET\tDISK SIZE\tVERSION\tAUTOREPAIR\n"+


You are still not taking into account different separators within a single table

Worked on this on this commit 3f5390f

hunterkepley · 2025-09-18T14:54:18Z

pkg/output/table_filter.go

+	return true
+}
+
+type ColumnFilterFunc func(columnIdx int) bool


Why was this introduced?

This was created to support the new FilterColumns function, which needed a way to let callers specify custom logic for which columns to keep or remove. I did this for the flexibility, reusability and composability

Cool yeah that makes sense,

I did have a question about this:

// Use FilterColumns with a predicate that keeps non-empty columns newHeaders, newTableData := FilterColumns(headers, tableData, func(columnIdx int) bool { return !CheckIfColumnIsEmpty(columnIdx, tableData) })

I see that this is used twice, to filter columns based on !CheckIfColumnIsEmpty

I think this is greatly useful if we had different types of filtering to be done, but in our case here I see we have only CheckIfColumnIsEmpty

My thoughts are, that we can get rid of the type here, and instead of passing a function into FilterColumns, we can directly call CheckIfColumnIsEmpty. WDYT?

OH- another note;

The current design has it so tableData is passed into both FilterColumns and the function being passed in.

// Use FilterColumns with a predicate that keeps non-empty columns newHeaders, newTableData := FilterColumns(headers, tableData, func(columnIdx int) bool { return !CheckIfColumnIsEmpty(columnIdx, tableData) })

Looking at this again, we can see that. Sadly, this means this data (no matter how large or small) is tripled in memory every time this is called (once for the first duplication to pass into the function, and a second one for the CheckIfColumnIsEmpty func

While the memory part may not seem like a big deal at first, we have to think about the fact that some tables can be very long. And we have the ability to control the pagination with the CLI commands usually

My thoughts are, that we can get rid of the type here, and instead of passing a function into FilterColumns, we can directly call CheckIfColumnIsEmpty. WDYT?

I do agree with this, makes this much simpler to understand and the implementation cleaner too

While the memory part may not seem like a big deal at first, we have to think about the fact that some tables can be very long. And we have the ability to control the pagination with the CLI commands usually

Did not think of this, thanks for the explanation, will take a look into to fixing it on a new commit

Hopefully addressed on 75d64ee

hunterkepley · 2025-09-18T14:55:27Z

pkg/output/table_filter.go

+	separators := make([]string, maxCols)
+	for i := range separators {
+		separators[i] = separator
+	}
+
+	BuildTableWithSeparators(writer, separators, tableData)


@olucasfreitas im afraid this was virtually unchanged from the last commit

hunterkepley · 2025-09-18T15:03:32Z

pkg/machinepool/machinepool.go

+	// Get headers and data
+	headers, tableData := getMachinePoolsData(r, machinePools, args)
 	if isHypershift {
-		finalStringToOutput = getNodePoolsString(nodePools)
+		headers, tableData = getNodePoolsData(nodePools)
+	}


In the original functions (getMachinePoolsString and getNodePoolsString), we return a string such as

test1\ttest2\ttest3\nval1\tval2\tval3\n

Couldn't we convert this into a list and not change the original functions?

Worked on this on this commit 3f5390f

hunterkepley · 2025-09-29T19:45:20Z

Oh it looks like it may have squashed- be sure to check this page for replies on comments, the old ones won't show up on the Files changed tab if the code was changed during the squash 🙂

olucasfreitas · 2025-10-01T13:36:29Z

/retest

olucasfreitas · 2025-10-02T16:11:10Z

/retest

hunterkepley

will continue review tomorrow- please feel free to go ahead and make the change I suggested a it will help out with my review

hunterkepley · 2025-10-08T20:04:00Z

pkg/machinepool/machinepool.go

+	return headers, tableData
+}

-	// Write header


Hey I think we need to include unique separators for the nodepool output- you can see here that the original separator list has a mix of \t\t and \t

It seems support was added for it in the last commit but it was not implemented in the actual command yet (still using a single separator \t for this command for example)

@hunterkepley adress this on the new commit, please take a look when you can

@olucasfreitas Hey it looks like this wasn't changed- the BuildTableWithSeparators function is not called in the machinepool command still

it looks like it's only used in tests

Sorry, I forgot to push the rest of the changes, please check it again

openshift-ci · 2025-10-15T17:01:22Z

@olucasfreitas: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-bot · 2026-01-20T01:00:18Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-merge-robot · 2026-01-20T01:00:29Z

PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci bot requested review from ciaranRoche and gdbranco August 21, 2025 01:57

hunterkepley reviewed Aug 26, 2025

View reviewed changes

olucasfreitas force-pushed the OCM-1520 branch from dd91dc0 to cbf08f0 Compare August 27, 2025 20:28

olucasfreitas force-pushed the OCM-1520 branch 2 times, most recently from ef825a0 to eb6702d Compare August 27, 2025 21:45

olucasfreitas requested a review from hunterkepley August 28, 2025 17:01

hunterkepley reviewed Aug 28, 2025

View reviewed changes

cmd/list/accessrequests/cmd.go Outdated Show resolved Hide resolved

cmd/list/accessrequests/cmd.go Outdated Show resolved Hide resolved

cmd/list/accountroles/cmd.go Outdated Show resolved Hide resolved

cmd/list/accountroles/cmd.go Outdated Show resolved Hide resolved

olucasfreitas force-pushed the OCM-1520 branch 2 times, most recently from 2f270f0 to bdf62a6 Compare August 28, 2025 20:55

olucasfreitas requested a review from hunterkepley August 28, 2025 20:56

hunterkepley reviewed Sep 5, 2025

View reviewed changes

olucasfreitas force-pushed the OCM-1520 branch from bdf62a6 to cec4bd1 Compare September 11, 2025 19:53

olucasfreitas requested a review from hunterkepley September 15, 2025 11:48

hunterkepley reviewed Sep 15, 2025

View reviewed changes

olucasfreitas force-pushed the OCM-1520 branch from cec4bd1 to 7de32b5 Compare September 17, 2025 20:04

hunterkepley reviewed Sep 18, 2025

View reviewed changes

olucasfreitas force-pushed the OCM-1520 branch from 7de32b5 to 3f5390f Compare September 29, 2025 14:28

olucasfreitas requested a review from hunterkepley September 29, 2025 14:29

olucasfreitas force-pushed the OCM-1520 branch from 3f5390f to e4f2322 Compare September 29, 2025 14:34

hunterkepley reviewed Oct 8, 2025

View reviewed changes

OCM-1520 | feat: Add --hide-empty-columns flag to rosa list commands

fc6c0ed

olucasfreitas force-pushed the OCM-1520 branch from bea53d8 to fc6c0ed Compare October 15, 2025 16:28

olucasfreitas requested a review from hunterkepley October 21, 2025 13:21

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 20, 2026

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 20, 2026

Conversation

olucasfreitas commented Aug 21, 2025

Details

Default Behavior (All Columns Shown)

Using --hide-empty-columns Flag

New behavior of the '--all'

Ticket

Uh oh!

openshift-ci bot commented Aug 21, 2025

Uh oh!

codecov bot commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

hunterkepley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

olucasfreitas commented Aug 27, 2025

Uh oh!

hunterkepley left a comment • 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!

Uh oh!

Uh oh!

Uh oh!

olucasfreitas commented Aug 28, 2025

Uh oh!

hunterkepley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hunterkepley commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

olucasfreitas commented Sep 14, 2025

Uh oh!

olucasfreitas commented Sep 15, 2025

Uh oh!

hunterkepley left a comment

Choose a reason for hiding this comment

Uh oh!

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!

hunterkepley Sep 29, 2025 • 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!

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

codecov bot commented Aug 21, 2025 •

edited

Loading

hunterkepley left a comment •

edited

Loading

hunterkepley commented Sep 5, 2025 •

edited

Loading

hunterkepley Sep 29, 2025 •

edited

Loading

olucasfreitas Sep 29, 2025 •

edited

Loading

hunterkepley Sep 29, 2025 •

edited

Loading