Support multiline conditions

Author: fabriziopandini

cmd/clusterctl/cmd/describe_cluster.go

@@ -20,6 +20,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"regexp"
 	"sort"
 	"strings"
 	"time"
@@ -284,6 +285,11 @@ func addObjectRowV1Beta2(prefix string, tbl *tablewriter.Table, objectTree *tree
 	// - The object's ready condition + counters
 	// - The object's up to date condition + counters
 	// - Condition "REASON", "SINCE", "MESSAGE"
+	msg := strings.Split(rowDescriptor.message, "\n")
+	msg0 := ""
+	if len(msg) > 1 {
+		msg0 = msg[0]
+	}
 	tbl.Append([]string{
 		fmt.Sprintf("%s%s", gray.Sprint(prefix), name),
 		rowDescriptor.replicas,
@@ -293,7 +299,20 @@ func addObjectRowV1Beta2(prefix string, tbl *tablewriter.Table, objectTree *tree
 		rowDescriptor.status,
 		rowDescriptor.reason,
 		rowDescriptor.age,
-		rowDescriptor.message})
+		msg0})
+
+	for _, m := range msg[1:] {
+		tbl.Append([]string{
+			fmt.Sprintf("%s", getMultilinePrefix(gray.Sprint(prefix))),
+			"",
+			"",
+			"",
+			"",
+			"",
+			"",
+			"",
+			m})
+	}
 
 	// If it is required to show all the conditions for the object, add a row for each object's conditions.
 	if tree.IsShowConditionsObject(obj) {
@@ -407,17 +426,36 @@ func addOtherConditionsV1Beta2(prefix string, tbl *tablewriter.Table, objectTree
 		}
 
 		childPrefix := getChildPrefix(prefix+childrenPipe+filler, i, len(conditions))
-		color, status, age, reason, message := v1Beta2ConditionInfo(condition, positivePolarity)
+		_, status, age, reason, message := v1Beta2ConditionInfo(condition, positivePolarity)
+
+		msg := strings.Split(message, "\n")
+		msg0 := ""
+		if len(msg) > 1 {
+			msg0 = msg[0]
+		}
 		tbl.Append([]string{
 			fmt.Sprintf("%s%s", gray.Sprint(childPrefix), cyan.Sprint(condition.Type)),
 			"",
 			"",
 			"",
 			"",
-			color.Sprint(status),
-			color.Sprint(reason),
-			color.Sprint(age),
-			color.Sprint(message)})
+			status,
+			reason,
+			age,
+			msg0})
+
+		for _, m := range msg[1:] {
+			tbl.Append([]string{
+				fmt.Sprintf("%s", gray.Sprint(getMultilinePrefix(childPrefix))),
+				"",
+				"",
+				"",
+				"",
+				"",
+				"",
+				"",
+				m})
+		}
 	}
 }
 
@@ -466,6 +504,20 @@ func getChildPrefix(currentPrefix string, childIndex, childCount int) string {
 	return nextPrefix + lastElemPrefix
 }
 
+// getMultilinePrefix return the tree view prefix for a multiline condition.
+func getMultilinePrefix(currentPrefix string) string {
+	// All ├─ should be replaced by |, so all the existing hierarchic dependencies are carried on
+	if strings.HasSuffix(currentPrefix, firstElemPrefix) {
+		return strings.TrimSuffix(currentPrefix, firstElemPrefix) + pipe
+	}
+	// All └─ should be replaced by " " because we are under the last element of the tree (nothing to carry on)
+	if strings.HasSuffix(currentPrefix, lastElemPrefix) {
+		return strings.TrimSuffix(currentPrefix, lastElemPrefix)
+	}
+
+	return "?"
+}
+
 // getRowName returns the object name in the tree view according to following rules:
 // - group objects are represented as #of objects kind, e.g. 3 Machines...
 // - other virtual objects are represented using the object name, e.g. Workers, or meta name if provided.
@@ -544,11 +596,11 @@ func newV1beta2RowDescriptor(obj ctrlclient.Object) v1beta2RowDescriptor {
 		}
 
 		if available := tree.GetAvailableV1Beta2Condition(obj); available != nil {
-			availableColor, availableStatus, availableAge, availableReason, availableMessage := v1Beta2ConditionInfo(*available, true)
-			v.status = availableColor.Sprintf("Available: %s", availableStatus)
-			v.reason = availableColor.Sprint(availableReason)
-			v.age = availableColor.Sprint(availableAge)
-			v.message = availableColor.Sprint(availableMessage)
+			_, availableStatus, availableAge, availableReason, availableMessage := v1Beta2ConditionInfo(*available, true)
+			v.status = fmt.Sprintf("Available: %s", availableStatus)
+			v.reason = availableReason
+			v.age = availableAge
+			v.message = availableMessage
 		}
 	case *clusterv1.MachineDeployment:
 		md := obj.(*clusterv1.MachineDeployment)
@@ -604,11 +656,11 @@ func newV1beta2RowDescriptor(obj ctrlclient.Object) v1beta2RowDescriptor {
 
 		v.readyCounters = "0"
 		if ready := tree.GetReadyV1Beta2Condition(obj); ready != nil {
-			readyColor, readyStatus, readyAge, readyReason, readyMessage := v1Beta2ConditionInfo(*ready, true)
-			v.status = readyColor.Sprintf("Ready: %s", readyStatus)
-			v.reason = readyColor.Sprint(readyReason)
-			v.age = readyColor.Sprint(readyAge)
-			v.message = readyColor.Sprint(readyMessage)
+			_, readyStatus, readyAge, readyReason, readyMessage := v1Beta2ConditionInfo(*ready, true)
+			v.status = fmt.Sprintf("Ready: %s", readyStatus)
+			v.reason = readyReason
+			v.age = readyAge
+			v.message = readyMessage
 			if ready.Status == metav1.ConditionTrue {
 				v.readyCounters = "1"
 			}
@@ -623,8 +675,8 @@ func newV1beta2RowDescriptor(obj ctrlclient.Object) v1beta2RowDescriptor {
 
 	case *unstructured.Unstructured:
 		if ready := tree.GetReadyV1Beta2Condition(obj); ready != nil {
-			readyColor, readyStatus, readyAge, readyReason, readyMessage := v1Beta2ConditionInfo(*ready, true)
-			v.status = readyColor.Sprintf("Ready: %s", readyStatus)
+			_, readyStatus, readyAge, readyReason, readyMessage := v1Beta2ConditionInfo(*ready, true)
+			v.status = fmt.Sprintf("Ready: %s", readyStatus)
 			v.reason = readyReason
 			v.age = readyAge
 			v.message = readyMessage
@@ -686,15 +738,40 @@ func v1Beta2ConditionInfo(c metav1.Condition, positivePolarity bool) (color *col
 	status = string(c.Status)
 	reason = c.Reason
 	age = duration.HumanDuration(time.Since(c.LastTransitionTime.Time))
-	message = c.Message
+	message = formatParagraph(c.Message, 100)
 
-	// Eventually cut the message to keep the table dimension under control.
-	if len(message) > 100 {
-		message = fmt.Sprintf("%s ...", message[:100])
-	}
 	return
 }
 
+var re = regexp.MustCompile("[\\s]+")
+
+func formatParagraph(text string, maxWidth int) string {
+	lines := []string{}
+	for _, l := range strings.Split(text, "\n") {
+		tmp := ""
+		for _, c := range []rune(l) {
+			if c == ' ' {
+				tmp += " "
+				continue
+			}
+			break
+		}
+		for _, w := range re.Split(l, -1) {
+			if len(tmp)+len(w) < maxWidth {
+				if strings.TrimSpace(tmp) != "" {
+					tmp += " "
+				}
+				tmp += w
+				continue
+			}
+			lines = append(lines, tmp)
+			tmp = w
+		}
+		lines = append(lines, tmp)
+	}
+	return strings.Join(lines, "\n")
+}
+
 // conditionDescriptor contains all the info for representing a condition.
 type conditionDescriptor struct {
 	readyColor *color.Color

cmd/clusterctl/cmd/describe_cluster_test.go

@@ -35,6 +35,12 @@ import (
 	"sigs.k8s.io/cluster-api/util/conditions"
 )
 
+func Test_foo(t *testing.T) {
+	txt := "Hello, world!\n * This is another line with a long text that I would like to get splitted into two lines."
+	p := formatParagraph(txt, 50)
+	fmt.Println(p)
+}
+
 func Test_getRowName(t *testing.T) {
 	tests := []struct {
 		name   string