Skip to content

Commit 7b6ae77

Browse files
thaJeztahthaJeztah
committed
implement treewriter
Nothing mergeable here, but this was me playing around; initially to see if we could print the format such as suggested in docker#5560 (comment) That output is shown in `TestTree`: IMAGE/TAGS ID DISK USAGE CONTENT SIZE USED alpine:latest beefdbd8a1da 13.6MB 4.09MB ├─ linux/amd64 33735bd63cf8 0B 0B ├─ linux/arm/v6 50f635c8b04d 0B 0B ├─ linux/arm/v7 f2f82d424957 0B 0B ├─ linux/arm64/v8 9cee2b382fe2 13.6MB 4.09MB ├─ linux/386 b3e87f642f5c 0B 0B ├─ linux/ppc64le c7a6800e3dc5 0B 0B ├─ linux/riscv64 80cde017a105 0B 0B └─ linux/s390x 2b5b26e09ca2 0B 0B namespace/image beefdbd8a1da 13.6MB 4.09MB ├─ namespace/image:1 beefdbd8a1da - - ├─ namespace/image:1.0 beefdbd8a1da - - ├─ namespace/image:1.0.0 beefdbd8a1da - - └─ namespace/image:latest beefdbd8a1da - - ├─ linux/amd64 33735bd63cf8 0B 0B ├─ linux/arm/v6 50f635c8b04d 0B 0B ├─ linux/arm/v7 f2f82d424957 0B 0B ├─ linux/arm64/v8 9cee2b382fe2 13.6MB 4.09MB ├─ linux/386 b3e87f642f5c 0B 0B ├─ linux/ppc64le c7a6800e3dc5 0B 0B ├─ linux/riscv64 80cde017a105 0B 0B └─ linux/s390x 2b5b26e09ca2 0B 0B internal.example.com/namespace/image beefdbd8a1da 13.6MB 4.09MB ├─ internal.example.com/namespace/image:1 beefdbd8a1da - - ├─ internal.example.com/namespace/image:1.0 beefdbd8a1da - - ├─ internal.example.com/namespace/image:1.0.0 beefdbd8a1da - - └─ internal.example.com/namespace/image:latest beefdbd8a1da - - ├─ linux/amd64 33735bd63cf8 0B 0B ├─ linux/arm/v6 50f635c8b04d 0B 0B ├─ linux/arm/v7 f2f82d424957 0B 0B ├─ linux/arm64/v8 9cee2b382fe2 13.6MB 4.09MB ├─ linux/386 b3e87f642f5c 0B 0B ├─ linux/ppc64le c7a6800e3dc5 0B 0B ├─ linux/riscv64 80cde017a105 0B 0B └─ linux/s390x 2b5b26e09ca2 0B 0B And `TestTreeNoTrunc` (non-truncated): IMAGE/TAGS ID DISK USAGE CONTENT SIZE USED alpine:latest sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d 13.6MB 4.09MB ├─ linux/amd64 sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735 0B 0B ├─ linux/arm/v6 sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be 0B 0B ├─ linux/arm/v7 sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086 0B 0B ├─ linux/arm64/v8 sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c 13.6MB 4.09MB ├─ linux/386 sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224 0B 0B ├─ linux/ppc64le sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0 0B 0B ├─ linux/riscv64 sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b 0B 0B └─ linux/s390x sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d 0B 0B namespace/image sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d 13.6MB 4.09MB ├─ namespace/image:1 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ namespace/image:1.0 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ namespace/image:1.0.0 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - └─ namespace/image:latest sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ linux/amd64 sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735 0B 0B ├─ linux/arm/v6 sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be 0B 0B ├─ linux/arm/v7 sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086 0B 0B ├─ linux/arm64/v8 sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c 13.6MB 4.09MB ├─ linux/386 sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224 0B 0B ├─ linux/ppc64le sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0 0B 0B ├─ linux/riscv64 sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b 0B 0B └─ linux/s390x sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d 0B 0B internal.example.com/namespace/image sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d 13.6MB 4.09MB ├─ internal.example.com/namespace/image:1 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ internal.example.com/namespace/image:1.0 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ internal.example.com/namespace/image:1.0.0 sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - └─ internal.example.com/namespace/image:latest sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d - - ├─ linux/amd64 sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735 0B 0B ├─ linux/arm/v6 sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be 0B 0B ├─ linux/arm/v7 sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086 0B 0B ├─ linux/arm64/v8 sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c 13.6MB 4.09MB ├─ linux/386 sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224 0B 0B ├─ linux/ppc64le sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0 0B 0B ├─ linux/riscv64 sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b 0B 0B └─ linux/s390x sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d 0B 0B The above is all without the nice color-formatting etc, but this would be handled before this; The second bit was to see if we could make the tree output more align with other output formats; - Most of our commands allow passing a `--format`, including for (e.g.) `table` - We want the tree view to also support, e.g. `--no-trunc`, which means that some columns will be wider. - If we use a tabwriter for printing, we can have it handle the column-sizing for us. - And if we do, we could let the user pass a custom format, and still print it as a tree. e.g., a format could be; --format 'tree {.Image}}\t{{.Digest}}\t{{.InUse}}' Which would output something like IMAGE ID USED alpine:latest beefdbd8a1da ✔ ├─ linux/amd64 33735bd63cf8 ├─ linux/arm/v6 50f635c8b04d ├─ linux/arm/v7 f2f82d424957 ├─ linux/arm64/v8 9cee2b382fe2 ✔ ├─ linux/386 b3e87f642f5c ├─ linux/ppc64le c7a6800e3dc5 ├─ linux/riscv64 80cde017a105 └─ linux/s390x 2b5b26e09ca2 The `TestTree` implementation is really quirky though, as it uses a `[][]string`, which won't work well if we want to make it more generic (with an "unknown" depth); probably needs some type defined that has an optional slice for child rows; those child-rows can be pre-formatted.
1 parent 32ff200 commit 7b6ae77

File tree

2 files changed

+149
-0
lines changed

2 files changed

+149
-0
lines changed

‎cli/command/formatter/treewriter/treewriter.go

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
package treewriter
2+
3+
import (
4+
"bytes"
5+
"fmt"
6+
"strings"
7+
8+
"github.com/docker/cli/cli/command/formatter/tabwriter"
9+
)
10+
11+
func PrintTree(header []string, rows [][]string) {
12+
// TODO(thaJeztah): using [][]string doesn't work well for this; we should
13+
// create a type for this that has "optional" child records that we can
14+
// recurse over to build the tree.
15+
tree := make([][]string, 0, len(rows))
16+
tree = append(tree, header)
17+
tree = append(tree, rows...)
18+
19+
buf := bytes.NewBuffer(nil)
20+
tw := tabwriter.NewWriter(buf, 20, 1, 3, ' ', 0)
21+
for rowNum, cols := range tree {
22+
if len(cols) == 0 {
23+
continue
24+
}
25+
26+
// The treePrefix is basically what makes it a "tree" when printing.
27+
// We shouldn't need to have "columns" though, only know about nesting
28+
// level, and otherwise have a pre-formatted, tab-terminated string
29+
// for each row.
30+
var treePrefix string
31+
treePrefix, cols = cols[0], cols[1:]
32+
if treePrefix == "" {
33+
// Start of new group
34+
if rowNum > 1 {
35+
// Print an empty line between groups. We need to write a tab
36+
// for each column for the tab-writer to give all groups equal
37+
// widths.
38+
//
39+
// FIXME(thaJeztah): if we pass rows as a pre-formatted string,
40+
// instead of a []string, we need to know the number of columns
41+
// (probably counting number of tabs would do the trick).
42+
_, _ = fmt.Fprintln(tw, strings.Repeat("\t", len(cols)))
43+
}
44+
_, _ = fmt.Fprintln(tw, strings.Join(cols, "\t"))
45+
} else {
46+
_, _ = fmt.Fprintln(tw, treePrefix, strings.Join(cols, "\t"))
47+
}
48+
49+
}
50+
_ = tw.Flush()
51+
fmt.Println(buf.String())
52+
}

‎cli/command/formatter/treewriter/treewriter_test.go

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
package treewriter
2+
3+
import (
4+
"testing"
5+
)
6+
7+
func TestTree(t *testing.T) {
8+
var rows [][]string
9+
rows = append(rows, [][]string{
10+
{"", "alpine:latest", "beefdbd8a1da", "13.6MB", "4.09MB"},
11+
{"├─", "linux/amd64", "33735bd63cf8", "0B", "0B"},
12+
{"├─", "linux/arm/v6", "50f635c8b04d", "0B", "0B"},
13+
{"├─", "linux/arm/v7", "f2f82d424957", "0B", "0B"},
14+
{"├─", "linux/arm64/v8", "9cee2b382fe2", "13.6MB", "4.09MB"},
15+
{"├─", "linux/386", "b3e87f642f5c", "0B", "0B"},
16+
{"├─", "linux/ppc64le", "c7a6800e3dc5", "0B", "0B"},
17+
{"├─", "linux/riscv64", "80cde017a105", "0B", "0B"},
18+
{"└─", "linux/s390x", "2b5b26e09ca2", "0B", "0B"},
19+
20+
{"", "namespace/image", "beefdbd8a1da", "13.6MB", "4.09MB"},
21+
{"├─", "namespace/image:1", "beefdbd8a1da", "-", "-"},
22+
{"├─", "namespace/image:1.0", "beefdbd8a1da", "-", "-"},
23+
{"├─", "namespace/image:1.0.0", "beefdbd8a1da", "-", "-"},
24+
{"└─", "namespace/image:latest", "beefdbd8a1da", "-", "-"},
25+
{" ├─", "linux/amd64", "33735bd63cf8", "0B", "0B"},
26+
{" ├─", "linux/arm/v6", "50f635c8b04d", "0B", "0B"},
27+
{" ├─", "linux/arm/v7", "f2f82d424957", "0B", "0B"},
28+
{" ├─", "linux/arm64/v8", "9cee2b382fe2", "13.6MB", "4.09MB"},
29+
{" ├─", "linux/386", "b3e87f642f5c", "0B", "0B"},
30+
{" ├─", "linux/ppc64le", "c7a6800e3dc5", "0B", "0B"},
31+
{" ├─", "linux/riscv64", "80cde017a105", "0B", "0B"},
32+
{" └─", "linux/s390x", "2b5b26e09ca2", "0B", "0B"},
33+
34+
{"", "internal.example.com/namespace/image", "beefdbd8a1da", "13.6MB", "4.09MB"},
35+
{"├─", "internal.example.com/namespace/image:1", "beefdbd8a1da", "-", "-"},
36+
{"├─", "internal.example.com/namespace/image:1.0", "beefdbd8a1da", "-", "-"},
37+
{"├─", "internal.example.com/namespace/image:1.0.0", "beefdbd8a1da", "-", "-"},
38+
{"└─", "internal.example.com/namespace/image:latest", "beefdbd8a1da", "-", "-"},
39+
{" ├─", "linux/amd64", "33735bd63cf8", "0B", "0B"},
40+
{" ├─", "linux/arm/v6", "50f635c8b04d", "0B", "0B"},
41+
{" ├─", "linux/arm/v7", "f2f82d424957", "0B", "0B"},
42+
{" ├─", "linux/arm64/v8", "9cee2b382fe2", "13.6MB", "4.09MB"},
43+
{" ├─", "linux/386", "b3e87f642f5c", "0B", "0B"},
44+
{" ├─", "linux/ppc64le", "c7a6800e3dc5", "0B", "0B"},
45+
{" ├─", "linux/riscv64", "80cde017a105", "0B", "0B"},
46+
{" └─", "linux/s390x", "2b5b26e09ca2", "0B", "0B"},
47+
}...)
48+
49+
header := []string{"IMAGE/TAGS", "ID", "DISK USAGE", "CONTENT SIZE", "USED"}
50+
PrintTree(header, rows)
51+
}
52+
53+
func TestTreeNoTrunc(t *testing.T) {
54+
var rows [][]string
55+
rows = append(rows, [][]string{
56+
{"", "alpine:latest", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "13.6MB", "4.09MB"},
57+
{"├─", "linux/amd64", "sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735", "0B", "0B"},
58+
{"├─", "linux/arm/v6", "sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be", "0B", "0B"},
59+
{"├─", "linux/arm/v7", "sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086", "0B", "0B"},
60+
{"├─", "linux/arm64/v8", "sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c", "13.6MB", "4.09MB"},
61+
{"├─", "linux/386", "sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224", "0B", "0B"},
62+
{"├─", "linux/ppc64le", "sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0", "0B", "0B"},
63+
{"├─", "linux/riscv64", "sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b", "0B", "0B"},
64+
{"└─", "linux/s390x", "sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d", "0B", "0B"},
65+
66+
{"", "namespace/image", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "13.6MB", "4.09MB"},
67+
{"├─", "namespace/image:1", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
68+
{"├─", "namespace/image:1.0", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
69+
{"├─", "namespace/image:1.0.0", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
70+
{"└─", "namespace/image:latest", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
71+
{" ├─", "linux/amd64", "sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735", "0B", "0B"},
72+
{" ├─", "linux/arm/v6", "sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be", "0B", "0B"},
73+
{" ├─", "linux/arm/v7", "sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086", "0B", "0B"},
74+
{" ├─", "linux/arm64/v8", "sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c", "13.6MB", "4.09MB"},
75+
{" ├─", "linux/386", "sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224", "0B", "0B"},
76+
{" ├─", "linux/ppc64le", "sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0", "0B", "0B"},
77+
{" ├─", "linux/riscv64", "sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b", "0B", "0B"},
78+
{" └─", "linux/s390x", "sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d", "0B", "0B"},
79+
80+
{"", "internal.example.com/namespace/image", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "13.6MB", "4.09MB"},
81+
{"├─", "internal.example.com/namespace/image:1", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
82+
{"├─", "internal.example.com/namespace/image:1.0", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
83+
{"├─", "internal.example.com/namespace/image:1.0.0", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
84+
{"└─", "internal.example.com/namespace/image:latest", "sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d", "-", "-"},
85+
{" ├─", "linux/amd64", "sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735", "0B", "0B"},
86+
{" ├─", "linux/arm/v6", "sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be", "0B", "0B"},
87+
{" ├─", "linux/arm/v7", "sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086", "0B", "0B"},
88+
{" ├─", "linux/arm64/v8", "sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c", "13.6MB", "4.09MB"},
89+
{" ├─", "linux/386", "sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224", "0B", "0B"},
90+
{" ├─", "linux/ppc64le", "sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0", "0B", "0B"},
91+
{" ├─", "linux/riscv64", "sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b", "0B", "0B"},
92+
{" └─", "linux/s390x", "sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d", "0B", "0B"},
93+
}...)
94+
95+
header := []string{"IMAGE/TAGS", "ID", "DISK USAGE", "CONTENT SIZE", "USED"}
96+
PrintTree(header, rows)
97+
}

0 commit comments

Comments
 (0)