[bug] Support multiple template colours in lakectl console output (#9642)

* [bug] Support multiple template colours in lakectl console output

Now e.g. `{{... | bold | red}}` formats both both _and_ red (previously this
would only be red).

* [bug] ColoredText.Add does _not_ modify c

Thanks, Copilot!

Author: arielshaqed

cmd/lakectl/cmd/common_helpers.go

@@ -88,23 +88,54 @@ type Pagination struct {
 	After   string
 }
 
+// ColoredText is text with an array of colors applied to it.  Without it go-pretty cannot
+// render combinations, e.g. bold-green.
+type ColoredText struct {
+	Colors text.Colors
+	Text   interface{} // Usually just a string, but anything goes
+}
+
+// String converts c to a string with ANSI control codes.
+func (c ColoredText) String() string {
+	return c.Colors.Sprint(c.Text)
+}
+
+// Add returns c with color added to it.
+func (c ColoredText) Add(color text.Color) ColoredText {
+	return ColoredText{
+		Colors: append(c.Colors, color),
+		Text:   c.Text,
+	}
+}
+
+// Colored returns text as ColoredText with no Color if it is not already ColoredText.
+func Colored(text interface{}) ColoredText {
+	if c, ok := text.(ColoredText); ok {
+		return c
+	}
+	return ColoredText{Colors: nil, Text: text}
+}
+
 func WriteTo(tpl string, data interface{}, w io.Writer) {
 	templ := template.New("output")
 	templ.Funcs(template.FuncMap{
-		"red": func(arg interface{}) string {
-			return text.FgHiRed.Sprint(arg)
+		"red": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.FgHiRed)
+		},
+		"yellow": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.FgHiYellow)
 		},
-		"yellow": func(arg interface{}) string {
-			return text.FgHiYellow.Sprint(arg)
+		"green": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.FgHiGreen)
 		},
-		"green": func(arg interface{}) string {
-			return text.FgHiGreen.Sprint(arg)
+		"blue": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.FgHiBlue)
 		},
-		"blue": func(arg interface{}) string {
-			return text.FgHiBlue.Sprint(arg)
+		"bold": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.Bold)
 		},
-		"bold": func(arg interface{}) string {
-			return text.Bold.Sprint(arg)
+		"underline": func(arg interface{}) ColoredText {
+			return Colored(arg).Add(text.Underline)
 		},
 		"date": func(ts int64) string {
 			return time.Unix(ts, 0).String()

cmd/lakectl/cmd/common_helpers_test.go

@@ -1,7 +1,10 @@
 package cmd
 
 import (
+	"strings"
 	"testing"
+
+	"github.com/jedib0t/go-pretty/v6/text"
 )
 
 func TestIsValidAccessKeyID(t *testing.T) {
@@ -52,3 +55,38 @@ func TestIsValidSecretAccessKey(t *testing.T) {
 		})
 	}
 }
+
+func TestColors(t *testing.T) {
+	text.EnableColors()
+	defer text.DisableColors()
+	tests := []struct {
+		name     string
+		template string
+		want     string
+	}{
+		{name: "plain", template: `abc`, want: "abc"},
+		{name: "red", template: `{{"abc" | red}}def`, want: "\x1b[91mabc\x1b[0mdef"},
+		{name: "yellow", template: `{{"abc" | yellow}}def`, want: "\x1b[93mabc\x1b[0mdef"},
+		{name: "green", template: `{{"abc" | green}}def`, want: "\x1b[92mabc\x1b[0mdef"},
+		{name: "blue", template: `{{"abc" | blue}}def`, want: "\x1b[94mabc\x1b[0mdef"},
+		{name: "bold", template: `{{"abc" | bold}}def`, want: "\x1b[1mabc\x1b[0mdef"},
+		{name: "underline", template: `{{"abc" | underline}}def`, want: "\x1b[4mabc\x1b[0mdef"},
+		{name: "boldgreen", template: `{{"abc" | bold | green}}def`, want: "\x1b[1;92mabc\x1b[0mdef"},
+		{name: "greenbold", template: `{{"abc" | green | bold}}def`, want: "\x1b[92;1mabc\x1b[0mdef"},
+		{name: "redunderline", template: `{{"abc" | red | underline}}def`, want: "\x1b[91;4mabc\x1b[0mdef"},
+		{name: "red-number", template: `{{2 | red}}`, want: "\x1b[91m2\x1b[0m"},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			w := strings.Builder{}
+			WriteTo(tc.template, nil, &w)
+			got := w.String()
+			if got != tc.want {
+				t.Errorf("%s got %q want %q", tc.template, got, tc.want)
+			}
+			// Show off the nice colors!
+			t.Log(got)
+		})
+	}
+}