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

Author: olucasfreitas

cmd/list/accessrequests/cmd.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strings"
 	"text/tabwriter"
 	"time"
 
@@ -38,6 +39,7 @@ func NewListAccessRequestsCommand() *cobra.Command {
 	}
 
 	output.AddFlag(cmd)
+	output.AddHideEmptyColumnsFlag(cmd)
 	ocm.AddOptionalClusterFlag(cmd)
 	return cmd
 }
@@ -67,40 +69,57 @@ func ListAccessRequestsRunner() rosa.CommandRunner {
 				}
 				return nil
 			}
-			writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
-			output, hasPending, pendingId := getAccessRequestsOutput(clusterId, accessRequests)
-			fmt.Fprint(writer, output)
-			if err := writer.Flush(); err != nil {
-				return err
+
+			hasPending := false
+			pendingId := "<ID>"
+			for _, accessRequest := range accessRequests {
+				if accessRequest.Status().State() == v1.AccessRequestStatePending ||
+					accessRequest.Status().State() == v1.AccessRequestStateApproved {
+					hasPending = true
+					if clusterId != "" {
+						pendingId = accessRequest.ID()
+					}
+				}
 			}
+
 			if hasPending {
 				r.Reporter.Infof("Run the following command to approve or deny the Access Request:\n\n"+
 					"   rosa create decision --access-request %s --decision Approved\n"+
 					"   rosa create decision --access-request %s --decision Denied --justification \"justification\"\n",
 					pendingId, pendingId)
 			}
-		}
-		return nil
-	}
-}
 
-func getAccessRequestsOutput(clusterId string, accessRequests []*v1.AccessRequest) (string, bool, string) {
-	output := "STATE\tID\tCLUSTER ID\tUPDATED AT\n"
-	hasPending := false
-	id := "<ID>"
-	for _, accessRequest := range accessRequests {
-		if accessRequest.Status().State() == v1.AccessRequestStatePending {
-			hasPending = true
-			if clusterId != "" {
-				id = accessRequest.ID()
+			headers := []string{"STATE", "ID", "CLUSTER ID", "UPDATED AT"}
+			var tableData [][]string
+			for _, accessRequest := range accessRequests {
+				row := []string{
+					string(accessRequest.Status().State()),
+					accessRequest.ID(),
+					accessRequest.ClusterId(),
+					accessRequest.UpdatedAt().UTC().Format(time.UnixDate),
+				}
+				tableData = append(tableData, row)
 			}
+
+			writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
+
+			if output.ShouldHideEmptyColumns() {
+				newHeaders, newData := output.RemoveEmptyColumns(headers, tableData)
+				config := output.TableConfig{
+					Separator:            "\t",
+					HasTrailingSeparator: false,
+					UseFprintln:          false,
+				}
+				output.PrintTable(writer, newHeaders, newData, config)
+			} else {
+				fmt.Fprint(writer, "STATE\tID\tCLUSTER ID\tUPDATED AT\n")
+				for _, row := range tableData {
+					fmt.Fprintf(writer, "%s\n", strings.Join(row, "\t"))
+				}
+			}
+
+			writer.Flush()
 		}
-		output += fmt.Sprintf("%s\t%s\t%s\t%s\n",
-			accessRequest.Status().State(),
-			accessRequest.ID(),
-			accessRequest.ClusterId(),
-			accessRequest.UpdatedAt().Format(time.UnixDate))
+		return nil
 	}
-
-	return output, hasPending, id
 }

cmd/list/accessrequests/cmd_test.go

@@ -2,7 +2,6 @@ package accessrequests
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"time"
 
@@ -18,23 +17,23 @@ import (
 )
 
 var (
-	accessRequestsOutput = `STATE     ID         CLUSTER ID         UPDATED AT
-Approved  mock-id-1  mock-cluster-id-1  Sat Sep 28 20:35:00 UTC 2024
-Pending   mock-id-2  mock-cluster-id-2  Sat Sep 28 20:35:00 UTC 2024
-INFO: Run the following command to approve or deny the Access Request:
+	accessRequestsOutput = `INFO: Run the following command to approve or deny the Access Request:
 
    rosa create decision --access-request <ID> --decision Approved
    rosa create decision --access-request <ID> --decision Denied --justification "justification"
 
+STATE     ID         CLUSTER ID         UPDATED AT
+Approved  mock-id-1  mock-cluster-id-1  Sat Sep 28 20:35:00 UTC 2024
+Pending   mock-id-2  mock-cluster-id-2  Sat Sep 28 20:35:00 UTC 2024
 `
-	clusterAccessRequestsOutput = `STATE    ID         CLUSTER ID       UPDATED AT
-Pending  mock-id-1  mock-cluster-id  Sat Sep 28 21:35:00 UTC 2024
-Denied   mock-id-2  mock-cluster-id  Sat Sep 28 20:35:00 UTC 2024
-INFO: Run the following command to approve or deny the Access Request:
+	clusterAccessRequestsOutput = `INFO: Run the following command to approve or deny the Access Request:
 
    rosa create decision --access-request mock-id-1 --decision Approved
    rosa create decision --access-request mock-id-1 --decision Denied --justification "justification"
 
+STATE    ID         CLUSTER ID       UPDATED AT
+Pending  mock-id-1  mock-cluster-id  Sat Sep 28 21:35:00 UTC 2024
+Denied   mock-id-2  mock-cluster-id  Sat Sep 28 20:35:00 UTC 2024
 `
 )
 
@@ -126,7 +125,6 @@ var _ = Describe("rosa attach policy", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 			stdOut, _ := t.StdOutReader.Read()
-			fmt.Println(stdOut)
 			Expect(stdOut).To(Equal(accessRequestsOutput))
 		})
 

cmd/list/accountroles/cmd.go

@@ -19,6 +19,7 @@ package accountroles
 import (
 	"fmt"
 	"os"
+	"strings"
 	"text/tabwriter"
 	"time"
 
@@ -55,6 +56,7 @@ func init() {
 		"List only account-roles that are associated with the given version.",
 	)
 	output.AddFlag(Cmd)
+	output.AddHideEmptyColumnsFlag(Cmd)
 }
 
 func run(_ *cobra.Command, _ []string) {
@@ -108,23 +110,39 @@ func run(_ *cobra.Command, _ []string) {
 		os.Exit(0)
 	}
 
-	// Create the writer that will be used to print the tabulated results:
-	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
-	fmt.Fprintf(writer, "ROLE NAME\tROLE TYPE\tROLE ARN\tOPENSHIFT VERSION\tAWS Managed\n")
+	headers := []string{"ROLE NAME", "ROLE TYPE", "ROLE ARN", "OPENSHIFT VERSION", "AWS Managed"}
+	var tableData [][]string
 	for _, accountRole := range accountRoles {
 		awsManaged := "No"
 		if accountRole.ManagedPolicy {
 			awsManaged = "Yes"
 		}
-		fmt.Fprintf(
-			writer,
-			"%s\t%s\t%s\t%s\t%s\n",
+		row := []string{
 			accountRole.RoleName,
 			accountRole.RoleType,
 			accountRole.RoleARN,
 			accountRole.Version,
 			awsManaged,
-		)
+		}
+		tableData = append(tableData, row)
+	}
+
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+
+	if output.ShouldHideEmptyColumns() {
+		newHeaders, newData := output.RemoveEmptyColumns(headers, tableData)
+		config := output.TableConfig{
+			Separator:            "\t",
+			HasTrailingSeparator: false,
+			UseFprintln:          false,
+		}
+		output.PrintTable(writer, newHeaders, newData, config)
+	} else {
+		fmt.Fprintf(writer, "ROLE NAME\tROLE TYPE\tROLE ARN\tOPENSHIFT VERSION\tAWS Managed\n")
+		for _, row := range tableData {
+			fmt.Fprintf(writer, "%s\n", strings.Join(row, "\t"))
+		}
 	}
 	writer.Flush()
+
 }

cmd/list/addon/cmd.go

@@ -19,6 +19,7 @@ package addon
 import (
 	"fmt"
 	"os"
+	"strings"
 	"text/tabwriter"
 
 	cmv1 "github.com/openshift-online/ocm-sdk-go/clustersmgmt/v1"
@@ -56,6 +57,7 @@ func init() {
 	)
 
 	output.AddFlag(Cmd)
+	output.AddHideEmptyColumnsFlag(Cmd)
 }
 
 // When no specific cluster id is provided by the user, this function lists all available AddOns
@@ -81,18 +83,38 @@ func listAllAddOns(r *rosa.Runtime) {
 		os.Exit(0)
 	}
 
-	// Create the writer that will be used to print the tabulated results:
-	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
-	fmt.Fprintf(writer, "ID\t\tNAME\t\tAVAILABILITY\n")
+	headers := []string{"ID", "NAME", "AVAILABILITY"}
+	var tableData [][]string
 	for _, addOnResource := range addOnResources {
 		availability := "unavailable"
 		if addOnResource.Available {
 			availability = "available"
 		}
-		fmt.Fprintf(writer, "%s\t\t%s\t\t%s\n", addOnResource.AddOn.ID(), addOnResource.AddOn.Name(), availability)
+		row := []string{
+			addOnResource.AddOn.ID(),
+			addOnResource.AddOn.Name(),
+			availability,
+		}
+		tableData = append(tableData, row)
 	}
-	writer.Flush()
 
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+
+	if output.ShouldHideEmptyColumns() {
+		newHeaders, newData := output.RemoveEmptyColumns(headers, tableData)
+		config := output.TableConfig{
+			Separator:            "\t\t",
+			HasTrailingSeparator: false,
+			UseFprintln:          false,
+		}
+		output.PrintTable(writer, newHeaders, newData, config)
+	} else {
+		fmt.Fprintf(writer, "ID\t\tNAME\t\tAVAILABILITY\n")
+		for _, row := range tableData {
+			fmt.Fprintf(writer, "%s\n", strings.Join(row, "\t"))
+		}
+	}
+	writer.Flush()
 	os.Exit(0)
 }
 
@@ -142,11 +164,32 @@ func listClusterAddOns(clusterKey string, r *rosa.Runtime) {
 		os.Exit(0)
 	}
 
-	// Create the writer that will be used to print the tabulated results:
-	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
-	fmt.Fprintf(writer, "ID\t\tNAME\t\tSTATE\n")
+	headers := []string{"ID", "NAME", "STATE"}
+	var tableData [][]string
 	for _, clusterAddOn := range clusterAddOns {
-		fmt.Fprintf(writer, "%s\t\t%s\t\t%s\n", clusterAddOn.ID, clusterAddOn.Name, clusterAddOn.State)
+		row := []string{
+			clusterAddOn.ID,
+			clusterAddOn.Name,
+			clusterAddOn.State,
+		}
+		tableData = append(tableData, row)
+	}
+
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+
+	if output.ShouldHideEmptyColumns() {
+		newHeaders, newData := output.RemoveEmptyColumns(headers, tableData)
+		config := output.TableConfig{
+			Separator:            "\t\t",
+			HasTrailingSeparator: false,
+			UseFprintln:          false,
+		}
+		output.PrintTable(writer, newHeaders, newData, config)
+	} else {
+		fmt.Fprintf(writer, "ID\t\tNAME\t\tSTATE\n")
+		for _, row := range tableData {
+			fmt.Fprintf(writer, "%s\n", strings.Join(row, "\t\t"))
+		}
 	}
 	writer.Flush()
 }

cmd/list/breakglasscredential/cmd.go

@@ -3,6 +3,7 @@ package breakglasscredential
 import (
 	"fmt"
 	"os"
+	"strings"
 	"text/tabwriter"
 
 	"github.com/spf13/cobra"
@@ -27,6 +28,7 @@ var Cmd = &cobra.Command{
 func init() {
 	ocm.AddClusterFlag(Cmd)
 	output.AddFlag(Cmd)
+	output.AddHideEmptyColumnsFlag(Cmd)
 }
 
 func run(cmd *cobra.Command, _ []string) {
@@ -69,18 +71,34 @@ func runWithRuntime(r *rosa.Runtime, cmd *cobra.Command) error {
 		return nil
 	}
 
-	// Create the writer that will be used to print the tabulated results:
-	writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
-
-	fmt.Fprintf(writer, "ID\tUSERNAME\tSTATUS\n")
+	headers := []string{"ID", "USERNAME", "STATUS"}
+	var tableData [][]string
 	for _, credential := range breakGlassCredentials {
-		fmt.Fprintf(writer, "%s\t%s\t%s\n",
+		row := []string{
 			credential.ID(),
 			credential.Username(),
-			credential.Status(),
-		)
+			string(credential.Status()),
+		}
+		tableData = append(tableData, row)
 	}
-	writer.Flush()
 
+	writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
+
+	if output.ShouldHideEmptyColumns() {
+		newHeaders, newData := output.RemoveEmptyColumns(headers, tableData)
+
+		config := output.TableConfig{
+			Separator:            "\t",
+			HasTrailingSeparator: false,
+			UseFprintln:          false,
+		}
+		output.PrintTable(writer, newHeaders, newData, config)
+	} else {
+		fmt.Fprintf(writer, "ID\tUSERNAME\tSTATUS\n")
+		for _, row := range tableData {
+			fmt.Fprintf(writer, "%s\n", strings.Join(row, "\t"))
+		}
+	}
+	writer.Flush()
 	return nil
 }