image/tree: Chips to represent "in use"/"attested"

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

Author: vvoland

cli/command/image/push.go

@@ -8,14 +8,14 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
-	"strings"
 
 	"github.com/containerd/platforms"
 	"github.com/distribution/reference"
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/cli/cli/command/completion"
 	"github.com/docker/cli/cli/streams"
+	"github.com/docker/cli/internal/tui"
 	"github.com/docker/docker/api/types/auxprogress"
 	"github.com/docker/docker/api/types/image"
 	registrytypes "github.com/docker/docker/api/types/registry"
@@ -132,7 +132,6 @@ To push the complete multi-platform image, remove the --platform flag.
 
 	defer func() {
 		for _, note := range notes {
-			fmt.Fprintln(dockerCli.Err(), "")
 			printNote(dockerCli, note)
 		}
 	}()
@@ -185,23 +184,5 @@ func handleAux(dockerCli command.Cli) func(jm jsonmessage.JSONMessage) {
 }
 
 func printNote(dockerCli command.Cli, format string, args ...any) {
-	if dockerCli.Err().IsTerminal() {
-		format = strings.ReplaceAll(format, "--platform", aec.Bold.Apply("--platform"))
-	}
-
-	header := " Info -> "
-	padding := len(header)
-	if dockerCli.Err().IsTerminal() {
-		padding = len("i Info > ")
-		header = aec.Bold.Apply(aec.LightCyanB.Apply(aec.BlackF.Apply("i")) + " " + aec.LightCyanF.Apply("Info → "))
-	}
-
-	_, _ = fmt.Fprint(dockerCli.Err(), header)
-	s := fmt.Sprintf(format, args...)
-	for idx, line := range strings.Split(s, "\n") {
-		if idx > 0 {
-			_, _ = fmt.Fprint(dockerCli.Err(), strings.Repeat(" ", padding))
-		}
-		_, _ = fmt.Fprintln(dockerCli.Err(), aec.Italic.Apply(line))
-	}
+	tui.PrintNote(dockerCli.Err(), format, args...)
 }

cli/command/image/tree.go

@@ -10,11 +10,13 @@ import (
 	"github.com/containerd/platforms"
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/cli/cli/streams"
+	"github.com/docker/cli/internal/tui"
 	"github.com/docker/docker/api/types/filters"
 	imagetypes "github.com/docker/docker/api/types/image"
 	"github.com/docker/docker/pkg/stringid"
 	"github.com/docker/go-units"
 	"github.com/morikuni/aec"
+	"github.com/opencontainers/go-digest"
 )
 
 type treeOptions struct {
@@ -42,6 +44,8 @@ func runTree(ctx context.Context, dockerCLI command.Cli, opts treeOptions) error
 	view := treeView{
 		images: make([]topImage, 0, len(images)),
 	}
+	attested := make(map[digest.Digest]bool)
+
 	for _, img := range images {
 		details := imageDetails{
 			ID:        img.ID,
@@ -52,6 +56,10 @@ func runTree(ctx context.Context, dockerCLI command.Cli, opts treeOptions) error
 		var totalContent int64
 		children := make([]subImage, 0, len(img.Manifests))
 		for _, im := range img.Manifests {
+			if im.Kind == imagetypes.ManifestKindAttestation {
+				attested[im.AttestationData.For] = true
+				continue
+			}
 			if im.Kind != imagetypes.ManifestKindImage {
 				continue
 			}
@@ -89,6 +97,15 @@ func runTree(ctx context.Context, dockerCLI command.Cli, opts treeOptions) error
 		})
 	}
 
+	for _, img := range view.images {
+		for idx, sub := range img.Children {
+			if attested[digest.Digest(sub.Details.ID)] {
+				sub.Details.Attested = true
+				img.Children[idx] = sub
+			}
+		}
+	}
+
 	sort.Slice(view.images, func(i, j int) bool {
 		return view.images[i].created > view.images[j].created
 	})
@@ -101,6 +118,7 @@ type imageDetails struct {
 	DiskUsage   string
 	InUse       bool
 	ContentSize string
+	Attested    bool
 }
 
 type topImage struct {
@@ -119,6 +137,7 @@ type subImage struct {
 
 const columnSpacing = 3
 
+//nolint:gocyclo
 func printImageTree(dockerCLI command.Cli, view treeView) error {
 	out := dockerCLI.Out()
 	_, width := out.GetTtySize()
@@ -133,18 +152,45 @@ func printImageTree(dockerCLI command.Cli, view treeView) error {
 	headerColor := aec.NewBuilder(aec.DefaultF, aec.Bold).ANSI
 	topNameColor := aec.NewBuilder(aec.BlueF, aec.Bold).ANSI
 	normalColor := aec.NewBuilder(aec.DefaultF).ANSI
-	greenColor := aec.NewBuilder(aec.GreenF).ANSI
 	untaggedColor := aec.NewBuilder(aec.Faint).ANSI
+	var noneColor aec.ANSI = noColor{}
 	if !out.IsTerminal() {
 		headerColor = noColor{}
 		topNameColor = noColor{}
 		normalColor = noColor{}
-		greenColor = noColor{}
 		warningColor = noColor{}
 		untaggedColor = noColor{}
 	}
+	isTerm := out.IsTerminal()
 
 	_, _ = fmt.Fprintln(out, warningColor.Apply("WARNING: This is an experimental feature. The output may change and shouldn't be depended on."))
+
+	chipAttested := tui.Printable{
+		Plain: "A",
+		Fancy: tui.Chip(233, 49, " A "),
+	}
+	chipInUse := tui.Printable{
+		Plain: "U",
+		Fancy: tui.Chip(255, 177, " U "),
+	}
+
+	var legend string
+	// Print legend
+	legend += tui.Printable{
+		Plain: "ADDITIONAL Legend: ",
+		Fancy: aec.Bold.Apply("Legend → "),
+	}.String(isTerm)
+	legend += chipAttested.String(isTerm)
+	legend += " Attested | "
+	legend += chipInUse.String(isTerm)
+	legend += " In Use"
+
+	r := int(width) - countChars(legend)
+	if r < 0 {
+		r = 0
+	}
+	_, _ = fmt.Fprintln(out, strings.Repeat(" ", r)+legend)
+
 	_, _ = fmt.Fprintln(out, "")
 
 	columns := []imgColumn{
@@ -178,15 +224,19 @@ func printImageTree(dockerCLI command.Cli, view treeView) error {
 			},
 		},
 		{
-			Title: "In Use",
-			Align: alignCenter,
-			Width: 6,
-			Color: &greenColor,
+			Title: "Additional",
+			Align: alignLeft,
+			Width: len("Additional"),
+			Color: &noneColor,
 			DetailsValue: func(d *imageDetails) string {
+				var out string
+				if d.Attested {
+					out += chipAttested.String(isTerm)
+				}
 				if d.InUse {
-					return "✔"
+					out += chipInUse.String(isTerm)
 				}
-				return " "
+				return out
 			},
 		},
 	}
@@ -307,11 +357,28 @@ type imgColumn struct {
 }
 
 func truncateRunes(s string, length int) string {
-	runes := []rune(s)
-	if len(runes) > length {
-		return string(runes[:length-3]) + "..."
+	out := make([]rune, 0, length)
+	ln := 0
+	inEscape := false
+	for _, r := range s {
+		if r == '\x1b' {
+			inEscape = true
+			continue
+		}
+		if inEscape {
+			if r == 'm' {
+				inEscape = false
+			}
+			continue
+		}
+
+		ln += 1
+		if ln == length-3 {
+			return string(out) + "..."
+		}
+		out = append(out, r)
 	}
-	return s
+	return string(out)
 }
 
 func (h imgColumn) Print(clr aec.ANSI, s string) string {
@@ -325,8 +392,26 @@ func (h imgColumn) Print(clr aec.ANSI, s string) string {
 	return h.PrintL(clr, s)
 }
 
+func cleanANSI(s string) string {
+	for {
+		start := strings.Index(s, "\x1b")
+		if start == -1 {
+			return s
+		}
+		end := strings.Index(s[start:], "m")
+		if end == -1 {
+			return s
+		}
+		s = s[:start] + s[start+end+1:]
+	}
+}
+
+func countChars(s string) int {
+	return utf8.RuneCountInString(cleanANSI(s))
+}
+
 func (h imgColumn) PrintC(clr aec.ANSI, s string) string {
-	ln := utf8.RuneCountInString(s)
+	ln := countChars(s)
 
 	if ln > h.Width {
 		return clr.Apply(truncateRunes(s, h.Width))
@@ -341,7 +426,7 @@ func (h imgColumn) PrintC(clr aec.ANSI, s string) string {
 }
 
 func (h imgColumn) PrintL(clr aec.ANSI, s string) string {
-	ln := utf8.RuneCountInString(s)
+	ln := countChars(s)
 	if ln > h.Width {
 		return clr.Apply(truncateRunes(s, h.Width))
 	}
@@ -350,7 +435,7 @@ func (h imgColumn) PrintL(clr aec.ANSI, s string) string {
 }
 
 func (h imgColumn) PrintR(clr aec.ANSI, s string) string {
-	ln := utf8.RuneCountInString(s)
+	ln := countChars(s)
 	if ln > h.Width {
 		return clr.Apply(truncateRunes(s, h.Width))
 	}

cli/command/image/tree_test.go

@@ -0,0 +1,19 @@
+package image
+
+import (
+	"testing"
+
+	"github.com/docker/cli/internal/tui"
+	"gotest.tools/v3/assert"
+	is "gotest.tools/v3/assert/cmp"
+)
+
+func TestTruncateRunes(t *testing.T) {
+	a := tui.Chip(0, 0, " A ")
+
+	assert.Check(t, is.Equal(countChars(a), 3))
+
+	b := tui.Chip(0, 0, " B ")
+
+	assert.Check(t, is.Equal(countChars(a+b), 6))
+}

internal/tui/chip.go

@@ -0,0 +1,9 @@
+package tui
+
+import "strconv"
+
+func Chip(fg, bg int, content string) string {
+	fgAnsi := "\x1b[38;5;" + strconv.Itoa(fg) + "m"
+	bgAnsi := "\x1b[48;5;" + strconv.Itoa(bg) + "m"
+	return fgAnsi + bgAnsi + content + "\x1b[0m"
+}

internal/tui/colors.go

@@ -0,0 +1,14 @@
+package tui
+
+import (
+	"github.com/morikuni/aec"
+)
+
+var (
+	ColorTitle     = aec.NewBuilder(aec.DefaultF, aec.Bold).ANSI
+	ColorPrimary   = aec.NewBuilder(aec.DefaultF, aec.Bold).ANSI
+	ColorSecondary = aec.NewBuilder(aec.DefaultF).ANSI
+	ColorTertiary  = aec.NewBuilder(aec.DefaultF, aec.Faint).ANSI
+	ColorLink      = aec.NewBuilder(aec.LightCyanF, aec.Underline).ANSI
+	ColorFlag      = aec.NewBuilder(aec.Bold).ANSI
+)

internal/tui/note.go

@@ -0,0 +1,36 @@
+package tui
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/docker/cli/cli/streams"
+	"github.com/morikuni/aec"
+)
+
+func PrintNote(out *streams.Out, format string, args ...any) {
+	if out.IsTerminal() {
+		format = strings.ReplaceAll(format, "--platform", ColorFlag.Apply("--platform"))
+	}
+
+	header := " Info -> "
+	padding := len(header)
+	if out.IsTerminal() {
+		padding = len("i Info > ")
+		header = aec.Bold.Apply(aec.LightCyanB.Apply(aec.BlackF.Apply("i")) + " " + aec.LightCyanF.Apply("Info → "))
+	}
+
+	_, _ = fmt.Fprint(out, "\n", header)
+	s := fmt.Sprintf(format, args...)
+	for idx, line := range strings.Split(s, "\n") {
+		if idx > 0 {
+			_, _ = fmt.Fprint(out, strings.Repeat(" ", padding))
+		}
+
+		l := line
+		if out.IsTerminal() {
+			l = aec.Italic.Apply(l)
+		}
+		_, _ = fmt.Fprintln(out, l)
+	}
+}

internal/tui/printable.go

@@ -0,0 +1,27 @@
+package tui
+
+import (
+	"fmt"
+
+	"github.com/docker/cli/cli/streams"
+)
+
+type Printable struct {
+	Plain string
+	Fancy string
+}
+
+func (p Printable) String(isTerminal bool) string {
+	if isTerminal {
+		return p.Fancy
+	}
+	return p.Plain
+}
+
+func (p Printable) Print(out *streams.Out) {
+	if out.IsTerminal() {
+		_, _ = fmt.Fprint(out, p.Fancy)
+	} else {
+		_, _ = fmt.Fprint(out, p.Plain)
+	}
+}