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

Author: olucasfreitas

cmd/list/accessrequests/cmd.go

@@ -2,7 +2,6 @@ package accessrequests
 
 import (
 	"context"
-	"fmt"
 	"os"
 	"text/tabwriter"
 	"time"
@@ -38,6 +37,7 @@ func NewListAccessRequestsCommand() *cobra.Command {
 	}
 
 	output.AddFlag(cmd)
+	output.AddHideEmptyColumnsFlag(cmd)
 	ocm.AddOptionalClusterFlag(cmd)
 	return cmd
 }
@@ -67,12 +67,34 @@ func ListAccessRequestsRunner() rosa.CommandRunner {
 				}
 				return nil
 			}
+
+			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)
+			}
+
+			if output.ShouldHideEmptyColumns() {
+				tableData = output.RemoveEmptyColumns(headers, tableData)
+			} else {
+				tableData = append([][]string{headers}, tableData...)
+			}
+
 			writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
-			output, hasPending, pendingId := getAccessRequestsOutput(clusterId, accessRequests)
-			fmt.Fprint(writer, output)
+			output.BuildTable(writer, "\t", tableData)
 			if err := writer.Flush(); err != nil {
 				return err
 			}
+
+			hasPending, pendingId := checkForPendingRequests(clusterId, accessRequests)
+
 			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"+
@@ -84,23 +106,22 @@ func ListAccessRequestsRunner() rosa.CommandRunner {
 	}
 }
 
-func getAccessRequestsOutput(clusterId string, accessRequests []*v1.AccessRequest) (string, bool, string) {
-	output := "STATE\tID\tCLUSTER ID\tUPDATED AT\n"
+func checkForPendingRequests(clusterId string, accessRequests []*v1.AccessRequest) (bool, string) {
 	hasPending := false
 	id := "<ID>"
 	for _, accessRequest := range accessRequests {
-		if accessRequest.Status().State() == v1.AccessRequestStatePending {
+		if accessRequest.Status().State() == v1.AccessRequestStatePending ||
+			accessRequest.Status().State() == v1.AccessRequestStateApproved {
 			hasPending = true
 			if clusterId != "" {
 				id = accessRequest.ID()
 			}
+			// Once we find the first pending/approved request for the cluster, we can break
+			// since we only need one ID for the suggestion message
+			if clusterId != "" && hasPending {
+				break
+			}
 		}
-		output += fmt.Sprintf("%s\t%s\t%s\t%s\n",
-			accessRequest.Status().State(),
-			accessRequest.ID(),
-			accessRequest.ClusterId(),
-			accessRequest.UpdatedAt().Format(time.UnixDate))
 	}
-
-	return output, hasPending, id
+	return hasPending, id
 }

cmd/list/accessrequests/cmd_test.go

@@ -2,7 +2,6 @@ package accessrequests
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"time"
 
@@ -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

@@ -17,7 +17,6 @@ limitations under the License.
 package accountroles
 
 import (
-	"fmt"
 	"os"
 	"text/tabwriter"
 	"time"
@@ -55,6 +54,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 +108,34 @@ 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",
+		tableData = append(tableData, []string{
 			accountRole.RoleName,
 			accountRole.RoleType,
 			accountRole.RoleARN,
 			accountRole.Version,
 			awsManaged,
-		)
+		})
 	}
-	writer.Flush()
+
+	if output.ShouldHideEmptyColumns() {
+		tableData = output.RemoveEmptyColumns(headers, tableData)
+	} else {
+		tableData = append([][]string{headers}, tableData...)
+	}
+
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	output.BuildTable(writer, "\t", tableData)
+	if err := writer.Flush(); err != nil {
+		_ = r.Reporter.Errorf("Failed to flush output: %v", err)
+		os.Exit(1)
+	}
+
 }

cmd/list/addon/cmd.go

@@ -17,7 +17,6 @@ limitations under the License.
 package addon
 
 import (
-	"fmt"
 	"os"
 	"text/tabwriter"
 
@@ -56,6 +55,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 +81,34 @@ 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)
+	}
+
+	if output.ShouldHideEmptyColumns() {
+		tableData = output.RemoveEmptyColumns(headers, tableData)
+	} else {
+		tableData = append([][]string{headers}, tableData...)
 	}
-	writer.Flush()
 
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	output.BuildTable(writer, "\t\t", tableData)
+
+	if err := writer.Flush(); err != nil {
+		_ = r.Reporter.Errorf("Failed to flush output: %v", err)
+		os.Exit(1)
+	}
 	os.Exit(0)
 }
 
@@ -142,13 +158,31 @@ 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)
+	}
+
+	if output.ShouldHideEmptyColumns() {
+		tableData = output.RemoveEmptyColumns(headers, tableData)
+	} else {
+		tableData = append([][]string{headers}, tableData...)
+	}
+
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	output.BuildTable(writer, "\t\t", tableData)
+
+	if err := writer.Flush(); err != nil {
+		_ = r.Reporter.Errorf("Failed to flush output: %v", err)
+		os.Exit(1)
 	}
-	writer.Flush()
 }
 
 func run(_ *cobra.Command, _ []string) {

cmd/list/breakglasscredential/cmd.go

@@ -27,6 +27,7 @@ var Cmd = &cobra.Command{
 func init() {
 	ocm.AddClusterFlag(Cmd)
 	output.AddFlag(Cmd)
+	output.AddHideEmptyColumnsFlag(Cmd)
 }
 
 func run(cmd *cobra.Command, _ []string) {
@@ -69,18 +70,28 @@ 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)
+	}
+
+	if output.ShouldHideEmptyColumns() {
+		tableData = output.RemoveEmptyColumns(headers, tableData)
+	} else {
+		tableData = append([][]string{headers}, tableData...)
 	}
-	writer.Flush()
 
+	writer := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
+	output.BuildTable(writer, "\t", tableData)
+
+	if err := writer.Flush(); err != nil {
+		return err
+	}
 	return nil
 }

cmd/list/cluster/cmd.go

@@ -17,7 +17,6 @@ limitations under the License.
 package cluster
 
 import (
-	"fmt"
 	"os"
 	"text/tabwriter"
 
@@ -52,6 +51,7 @@ func init() {
 	flags.SortFlags = false
 
 	output.AddFlag(Cmd)
+	output.AddHideEmptyColumnsFlag(Cmd)
 	flags.BoolVarP(&args.listAll, "all", "a", false, "List all clusters across different AWS "+
 		"accounts under the same Red Hat organization")
 	flags.StringVar(&args.accountRoleArn, "account-role-arn", "", "List all clusters "+
@@ -107,25 +107,37 @@ 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, "ID\tNAME\tSTATE\tTOPOLOGY\n")
+	headers := []string{"ID", "NAME", "STATE", "TOPOLOGY"}
+	var tableData [][]string
 	for _, cluster := range clusters {
-		typeOutput := "Classic"
+		typeOutput := ""
 		if cluster.AWS() != nil && cluster.AWS().STS() != nil && cluster.AWS().STS().Enabled() {
 			typeOutput = "Classic (STS)"
 		}
 		if cluster.Hypershift().Enabled() {
 			typeOutput = "Hosted CP"
 		}
-		fmt.Fprintf(
-			writer,
-			"%s\t%s\t%s\t%s\n",
+
+		row := []string{
 			cluster.ID(),
 			cluster.Name(),
-			cluster.State(),
+			string(cluster.State()),
 			typeOutput,
-		)
+		}
+		tableData = append(tableData, row)
+	}
+
+	if output.ShouldHideEmptyColumns() {
+		tableData = output.RemoveEmptyColumns(headers, tableData)
+	} else {
+		tableData = append([][]string{headers}, tableData...)
+	}
+
+	writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	output.BuildTable(writer, "\t", tableData)
+
+	if err := writer.Flush(); err != nil {
+		_ = r.Reporter.Errorf("Failed to flush output: %v", err)
+		os.Exit(1)
 	}
-	writer.Flush()
 }