🌱 Replace disable-echo option with echo option in clusterctl describe

cmd/clusterctl/client/describe.go

@@ -41,9 +41,9 @@ type DescribeClusterOptions struct {
 	// ShowMachineSets instructs the discovery process to include machine sets in the ObjectTree.
 	ShowMachineSets bool
 
-	// DisableNoEcho disable hiding MachineInfrastructure or BootstrapConfig objects if the object's ready condition is true
+	// Echo displays MachineInfrastructure or BootstrapConfig objects if the object's ready condition is true
 	// or it has the same Status, Severity and Reason of the parent's object ready condition (it is an echo)
-	DisableNoEcho bool
+	Echo bool
 
 	// Grouping groups machines objects in case the ready conditions
 	// have the same Status, Severity and Reason.
@@ -82,7 +82,7 @@ func (c *clusterctlClient) DescribeCluster(options DescribeClusterOptions) (*tre
 	return tree.Discovery(context.TODO(), client, options.Namespace, options.ClusterName, tree.DiscoverOptions{
 		ShowOtherConditions: options.ShowOtherConditions,
 		ShowMachineSets:     options.ShowMachineSets,
-		DisableNoEcho:       options.DisableNoEcho,
+		Echo:                options.Echo,
 		Grouping:            options.Grouping,
 	})
 }

cmd/clusterctl/client/tree/discovery.go

@@ -35,9 +35,9 @@ type DiscoverOptions struct {
 	// ShowMachineSets instructs the discovery process to include machine sets in the ObjectTree.
 	ShowMachineSets bool
 
-	// DisableNoEcho disable hiding MachineInfrastructure or BootstrapConfig objects if the object's ready condition is true
+	// Echo displays MachineInfrastructure or BootstrapConfig objects if the object's ready condition is true
 	// or it has the same Status, Severity and Reason of the parent's object ready condition (it is an echo)
-	DisableNoEcho bool
+	Echo bool
 
 	// Grouping groups machine objects in case the ready conditions
 	// have the same Status, Severity and Reason.

cmd/clusterctl/client/tree/discovery_test.go

@@ -184,8 +184,8 @@ func Test_Discovery(t *testing.T) {
 			name: "Discovery with grouping and no-echo disabled",
 			args: args{
 				discoverOptions: DiscoverOptions{
-					Grouping:      false,
-					DisableNoEcho: true,
+					Grouping: false,
+					Echo:     true,
 				},
 				objs: test.NewFakeCluster("ns1", "cluster1").
 					WithControlPlane(

cmd/clusterctl/client/tree/tree.go

@@ -39,9 +39,9 @@ type ObjectTreeOptions struct {
 	// ShowMachineSets instructs the discovery process to include machine sets in the ObjectTree.
 	ShowMachineSets bool
 
-	// DisableNoEcho disables hiding objects if the object's ready condition has the
+	// Echo displays objects if the object's ready condition has the
 	// same Status, Severity and Reason of the parent's object ready condition (it is an echo)
-	DisableNoEcho bool
+	Echo bool
 
 	// Grouping groups sibling object in case the ready conditions
 	// have the same Status, Severity and Reason
@@ -92,7 +92,7 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 	// If the object should be hidden if the object's ready condition is true ot it has the
 	// same Status, Severity and Reason of the parent's object ready condition (it is an echo),
 	// return early.
-	if addOpts.NoEcho && !od.options.DisableNoEcho {
+	if addOpts.NoEcho && !od.options.Echo {
 		if (objReady != nil && objReady.Status == corev1.ConditionTrue) || hasSameReadyStatusSeverityAndReason(parentReady, objReady) {
 			return false, false
 		}

cmd/clusterctl/client/tree/tree_test.go

@@ -580,7 +580,7 @@ func Test_Add_NoEcho(t *testing.T) {
 		{
 			name: "should add if NoEcho option is present, objects have same ReadyCondition, but NoEcho is disabled",
 			args: args{
-				treeOptions: ObjectTreeOptions{DisableNoEcho: true},
+				treeOptions: ObjectTreeOptions{Echo: true},
 				addOptions:  []AddObjectOption{NoEcho(true)},
 				obj: fakeMachine("my-machine",
 					withMachineCondition(conditions.TrueCondition(clusterv1.ReadyCondition)),

cmd/clusterctl/cmd/describe_cluster.go

@@ -56,6 +56,7 @@ type describeClusterOptions struct {
 	namespace           string
 	showOtherConditions string
 	showMachineSets     bool
+	echo                bool
 	disableNoEcho       bool
 	grouping            bool
 	disableGrouping     bool
@@ -108,8 +109,12 @@ func init() {
 	describeClusterClusterCmd.Flags().BoolVar(&dc.showMachineSets, "show-machinesets", false,
 		"Show MachineSet objects.")
 
+	describeClusterClusterCmd.Flags().BoolVar(&dc.echo, "echo", false, ""+
+		"Show MachineInfrastructure and BootstrapConfig when ready condition is true or it has the Status, Severity and Reason of the machine's object.")
 	describeClusterClusterCmd.Flags().BoolVar(&dc.disableNoEcho, "disable-no-echo", false, ""+
 		"Disable hiding of a MachineInfrastructure and BootstrapConfig when ready condition is true or it has the Status, Severity and Reason of the machine's object.")
+	_ = describeClusterClusterCmd.Flags().MarkDeprecated("disable-no-echo",
+		"use --echo instead.")
 	describeClusterClusterCmd.Flags().BoolVar(&dc.grouping, "grouping", true,
 		"Groups machines when ready condition has the same Status, Severity and Reason.")
 	describeClusterClusterCmd.Flags().BoolVar(&dc.disableGrouping, "disable-grouping", false,
@@ -141,7 +146,7 @@ func runDescribeCluster(name string) error {
 		ClusterName:         name,
 		ShowOtherConditions: dc.showOtherConditions,
 		ShowMachineSets:     dc.showMachineSets,
-		DisableNoEcho:       dc.disableNoEcho,
+		Echo:                dc.echo || dc.disableNoEcho,
 		Grouping:            dc.grouping && !dc.disableGrouping,
 	})
 	if err != nil {