🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 #11781

tobiasgiese · 2025-02-01T10:52:57Z

The multiline feature in clusterctl has a bug in the multiline conditions.
If the Ready condition message has multipile lines the multiline prefix is not calculated properly.
To fix this we have to add a new logic to determine the multiline prefix for objects.

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #11782

/area clusterctl

tobiasgiese · 2025-02-01T10:53:32Z

cmd/clusterctl/cmd/describe_cluster_test.go

+				"Object/root",
+				"│                                                              2",
+				"├─Object/child1",
+				"│                                                              2",
+				"└─Object/child2",


Without the fix (where ? is no prefix)

Object/root Available: False NotAvailable 292y 1 ? 2 ├─Object/child1 Available: False NotAvailable 292y 1 │ 2 └─Object/child2 Available: False NotAvailable 292y 1 2

tobiasgiese · 2025-02-01T10:54:05Z

cmd/clusterctl/cmd/describe_cluster_test.go

+				"Object/root",
+				"├─Object/child1",
+				"└─Object/child2",
+				"  │                                                                2",
+				"  └─Object/child2.1",


Without the fix

Object/root Available: True Available 292y ├─Object/child1 Available: True Available 292y └─Object/child2 Available: False NotAvailable 292y 1 2 └─Object/child2.1

tobiasgiese · 2025-02-02T10:54:03Z

cmd/clusterctl/cmd/describe_cluster_test.go

+				"Object/root",
+				"├─Object/child1",
+				"├─Object/child2",
+				"│ │                                                                2",
+				"│ └─Object/child2.1",
+				"│                                                                  2",
+				"└─Object/child3",
+				"  │                                                                2",
+				"  └─Object/child3.1",
+				"                                                                   2",


Without the fix

Object/root Available: True Available 292y ├─Object/child1 Available: True Available 292y ├─Object/child2 Available: False NotAvailable 292y 1 │ 2 │ └─Object/child2.1 Available: False NotAvailable 292y 1 │ 2 └─Object/child3 Available: False NotAvailable 292y 1 2 └─Object/child3.1 Available: False NotAvailable 292y 1 2

sbueringer · 2025-02-03T10:29:50Z

/assign @fabriziopandini

fabriziopandini

Made a first quick pass, really appreciated the test with the example of the output before the change

cmd/clusterctl/cmd/describe_cluster.go

cmd/clusterctl/cmd/describe_cluster_test.go

cmd/clusterctl/cmd/describe_cluster.go

fabriziopandini

@tobiasgiese sorry for the delay in the review, there is one last comment to be addressed, otherwise lgtm

fabriziopandini · 2025-02-17T13:22:24Z

cmd/clusterctl/cmd/describe_cluster.go

+func getOrderedTreeObjects(objectTree *tree.ObjectTree) []ctrlclient.Object {
+	rootObjs := objectTree.GetObjectsByParent(objectTree.GetRoot().GetUID())
+	rootObjs = orderChildrenObjects(rootObjs)
+	objs := []ctrlclient.Object{objectTree.GetRoot()}
+	for _, obj := range rootObjs {
+		childrenObjs := objectTree.GetObjectsByParent(obj.GetUID())
+		childrenObjs = orderChildrenObjects(childrenObjs)
+		objs = append(objs, obj)
+		objs = append(objs, childrenObjs...)
+	}
+	return objs
+}


This doesn't work when the last node is nested two (or more) levels, e.g.

NAME REPLICAS AVAILABLE READY UP TO DATE STATUS REASON SINCE MESSAGE Cluster/classy-base-8 2/4 0 0 2 Available: False NotAvailable ... └─Workers └─MachineDeployment/classy-base-8-md1-4xc49 1/1 0 0 1 Available: False NotAvailable 55m 0 available replicas, at least 1 required (spec.strategy.rollout.maxUnavailable is 0, spec.replicas is 1) └─Machine/classy-base-8-md1-4xc49-w5696-lcdc6 1 0 0 1 ...

(the line right after MachineDeployment doesn't have the right prefix)

I would also suggest that we compute the last node once up in the call stack (instead of recomputing it many time) and then pass it around

If nested multiple times it's even worse - let me fix that

Object/root Available: True Available 292y └─Object/child1 Available: True Available 292y └─Object/child2 Available: False NotAvailable 292y 1 2 └─Object/child3 Available: False NotAvailable 292y 1 │ 2 └─Object/child4 Available: False NotAvailable 292y 1 2

I would also suggest that we compute the last node once up in the call stack (instead of recomputing it many time) and then pass it around

I don't know if this is possible as addObjectRowV1Beta2() is a recursion. If we only want to compute it once we can add a new field e.g. orderedItems to the ObjectTree.

Edit: we can just put the last object as an annotation to the root object on the first call, sounds reasonable to me.

I added 2 more test cases and a new getRootMultiLineObjectPrefix() function - see the diff. It now calculates each parent separately. We can think of using the same logic for the prefixes, but this can be done in a follow-up IMO.
WDYT @fabriziopandini? If you say that we should avoid computing the prefix for each multiline object we can think of an alternative. Maybe it is not worth the effort.

k8s-ci-robot · 2025-02-24T14:42:09Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:

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

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

The multiline feature in clusterctl has a bug in the multiline conditions. If the Ready condition message has multipile lines the multiline prefix is not calculated properly. To fix this we have to add a new logic to determine the multiline prefix for objects. Signed-off-by: Tobias Giese <[email protected]> Co-authored-by: fabriziopandini <[email protected]>

tobiasgiese · 2025-02-24T14:59:04Z

cmd/clusterctl/cmd/describe_cluster_test.go

+				"Object/root                    Available: True",
+				"└─Object/child1                Available: True",
+				"  └─Object/child2              Available: False",
+				"    │                                                                2",
+				"    └─Object/child3            Available: False",
+				"      │                                                              2",
+				"      └─Object/child4          Available: False",
+				"                                                                     2",


Without the fix

Object/root Available: True Available 292y └─Object/child1 Available: True Available 292y └─Object/child2 Available: False NotAvailable 292y 1 2 └─Object/child3 Available: False NotAvailable 292y 1 2 └─Object/child4 Available: False NotAvailable 292y 1 2

tobiasgiese · 2025-02-24T14:59:18Z

cmd/clusterctl/cmd/describe_cluster_test.go

+				"Object/root                    Available: True   Available     292y",
+				"├─Object/child1                Available: True   Available     292y",
+				"│ └─Object/child2              Available: False  NotAvailable  292y  1",
+				"│   │                                                                2",
+				"│   └─Object/child3            Available: False  NotAvailable  292y  1",
+				"│     │                                                              2",
+				"│     └─Object/child4          Available: False  NotAvailable  292y  1",
+				"│                                                                    2",
+				"└─Object/child5                Available: False  NotAvailable  292y  1",
+				"                                                                     2",


Without the fix

Object/root Available: True Available 292y ├─Object/child1 Available: True Available 292y │ └─Object/child2 Available: False NotAvailable 292y 1 │ 2 │ └─Object/child3 Available: False NotAvailable 292y 1 │ 2 │ └─Object/child4 Available: False NotAvailable 292y 1 │ 2 └─Object/child5 Available: False NotAvailable 292y 1 2

k8s-ci-robot added the area/clusterctl Issues or PRs related to clusterctl label Feb 1, 2025

k8s-ci-robot requested review from jackfrancis and JoelSpeed February 1, 2025 10:53

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 1, 2025

tobiasgiese commented Feb 1, 2025

View reviewed changes

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch 4 times, most recently from 7f71cbc to 79b13f5 Compare February 1, 2025 11:17

tobiasgiese changed the title ~~🐛 Fix multiline Ready condition in clusterctl describe~~ 🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 Feb 1, 2025

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch 5 times, most recently from c8bfa74 to 8c38475 Compare February 2, 2025 10:52

tobiasgiese commented Feb 2, 2025

View reviewed changes

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch 4 times, most recently from ac341c5 to 3aa0b3b Compare February 2, 2025 11:32

k8s-ci-robot assigned fabriziopandini Feb 3, 2025

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch from 3aa0b3b to eac73ac Compare February 5, 2025 08:21

fabriziopandini reviewed Feb 5, 2025

View reviewed changes

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch from eac73ac to 3c489c9 Compare February 5, 2025 10:28

fabriziopandini reviewed Feb 17, 2025

View reviewed changes

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch from 3c489c9 to dcc6b19 Compare February 24, 2025 14:41

tobiasgiese force-pushed the fix-multiline-parent-conditions-tests branch from dcc6b19 to b7e974d Compare February 24, 2025 14:48

tobiasgiese commented Feb 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 #11781

🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 #11781

tobiasgiese commented Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 2, 2025

sbueringer commented Feb 3, 2025

fabriziopandini left a comment

fabriziopandini left a comment

fabriziopandini Feb 17, 2025

tobiasgiese Feb 17, 2025

tobiasgiese Feb 17, 2025 •

edited

Loading

tobiasgiese Feb 24, 2025 •

edited

Loading

k8s-ci-robot commented Feb 24, 2025

tobiasgiese Feb 24, 2025

tobiasgiese Feb 24, 2025

🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 #11781

Are you sure you want to change the base?

🐛 Fix multiline Ready condition in clusterctl describe for v1beta2 #11781

Conversation

tobiasgiese commented Feb 1, 2025 • edited Loading

tobiasgiese Feb 1, 2025 • edited Loading

Choose a reason for hiding this comment

tobiasgiese Feb 1, 2025 • edited Loading

Choose a reason for hiding this comment

tobiasgiese Feb 2, 2025

Choose a reason for hiding this comment

sbueringer commented Feb 3, 2025

fabriziopandini left a comment

Choose a reason for hiding this comment

fabriziopandini left a comment

Choose a reason for hiding this comment

fabriziopandini Feb 17, 2025

Choose a reason for hiding this comment

tobiasgiese Feb 17, 2025

Choose a reason for hiding this comment

tobiasgiese Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

tobiasgiese Feb 24, 2025 • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 24, 2025

tobiasgiese Feb 24, 2025

Choose a reason for hiding this comment

tobiasgiese Feb 24, 2025

Choose a reason for hiding this comment

tobiasgiese commented Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 1, 2025 •

edited

Loading

tobiasgiese Feb 17, 2025 •

edited

Loading

tobiasgiese Feb 24, 2025 •

edited

Loading