working version with colors

Signed-off-by: Ahmet Alp Balkan <[email protected]>

Author: ahmetb

cmd/kubectl-tree/query.go

@@ -8,7 +8,8 @@ import (
 	"sync"
 )
 
-func QueryResources(client dynamic.Interface, apis []apiResource) ([]unstructured.Unstructured, error) {
+// getAllResources finds all API objects in specified API resources in all namespaces (or non-namespaced).
+func getAllResources(client dynamic.Interface, apis []apiResource) ([]unstructured.Unstructured, error) {
 	var mu sync.Mutex
 	var wg sync.WaitGroup
 	var out []unstructured.Unstructured
@@ -46,7 +47,6 @@ func queryAPI(client dynamic.Interface, api apiResource) ([]unstructured.Unstruc
 		}
 		out = append(out, resp.Items...)
 
-		fmt.Printf("found %d objects in %s (next=%s)\n", len(resp.Items), api.GroupVersionResource(), resp.GetContinue())
 		next = resp.GetContinue()
 		if next == "" {
 			break

cmd/kubectl-tree/relationship.go

@@ -3,13 +3,16 @@ package main
 import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/types"
+	"sort"
 )
 
+// objectDirectory stores objects and owner relationships between them.
 type objectDirectory struct {
 	items     map[types.UID]unstructured.Unstructured
 	ownership map[types.UID]map[types.UID]bool
 }
 
+// newObjectDirectory builds object lookup and hierarchy.
 func newObjectDirectory(objs []unstructured.Unstructured) objectDirectory {
 	v := objectDirectory{
 		items:     make(map[types.UID]unstructured.Unstructured),
@@ -27,12 +30,33 @@ func newObjectDirectory(objs []unstructured.Unstructured) objectDirectory {
 	return v
 }
 
+// getObject finds object by ID, since objectDirectory is built with specified objects, id should exist in there.
 func (od objectDirectory) getObject(id types.UID) unstructured.Unstructured { return od.items[id] }
 
-func (od objectDirectory) ownedBy(ownerID types.UID) []types.UID {
-	var out []types.UID
-	for k := range od.ownership[ownerID] {
-		out = append(out, k)
+// ownedBy returns objects directly owned by specified id, sorted by Kind, then by Name, then by Namespace.
+func (od objectDirectory) ownedBy(id types.UID) []unstructured.Unstructured {
+	var out sortedObjects
+	for k := range od.ownership[id] {
+		out = append(out, od.getObject(k))
 	}
+	sort.Sort(out)
 	return out
 }
+
+// sortedObjects sorts objects by Kind, then by Name, then by Namespace.
+type sortedObjects []unstructured.Unstructured
+
+func (s sortedObjects) Len() int { return len(s) }
+
+func (s sortedObjects) Less(i, j int) bool {
+	a, b := s[i], s[j]
+	if a.GetKind() != b.GetKind() {
+		return a.GetKind() < b.GetKind()
+	}
+	if a.GetName() != b.GetName() {
+		return a.GetName() < b.GetName()
+	}
+	return a.GetNamespace() < b.GetNamespace()
+}
+
+func (s sortedObjects) Swap(i, j int) { s[i], s[j] = s[j], s[i] }

cmd/kubectl-tree/rootcmd.go

@@ -30,7 +30,8 @@ var cf *genericclioptions.ConfigFlags
 var rootCmd = &cobra.Command{
 	Use:     "kubectl tree",
 	Short:   "Show sub-resources of the Kubernetes object",
-	Example: "  kubectl tree deployment my-app", // TODO add more examples about disambiguation etc
+	Example: "  kubectl tree deployment my-app\n" +
+		"  kubectl tree kservice.v1.serving.knative.dev my-app", // TODO add more examples about disambiguation etc
 	Args:    cobra.MinimumNArgs(2),
 	RunE:    run,
 }
@@ -68,21 +69,15 @@ func run(cmd *cobra.Command, args []string) error {
 			strings.Join(names, ", "))
 	}
 
-	fmt.Printf("kind=%#v name=%s\n", apiRes[0], name)
-	if *cf.Namespace == "" {
-		*cf.Namespace = "default" // TODO(ahmetb) figure out how to have this auto-set by kubeconfig w/ cli override
-	}
-
 	obj, err := dyn.Resource(apiRes[0].GroupVersionResource()).Namespace(*cf.Namespace).Get(name, metav1.GetOptions{})
 	if err != nil {
 		return fmt.Errorf("failed to get: %w", err)
 	}
 
-	apiObjects, err := QueryResources(dyn, apis.resources())
+	apiObjects, err := getAllResources(dyn, apis.resources())
 	if err != nil {
 		return fmt.Errorf("error while querying api objects: %w", err)
 	}
-	fmt.Printf("%d api objects found\n", len(apiObjects))
 
 	objs := newObjectDirectory(apiObjects)
 	if len(objs.ownership[obj.GetUID()]) == 0 {

cmd/kubectl-tree/status.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+)
+
+type ReadyStatus string // True False Unknown or ""
+type Reason string
+
+func extractStatus(obj unstructured.Unstructured) (ReadyStatus, Reason) {
+	statusF, ok := obj.Object["status"]
+	if !ok {
+		return "", ""
+	}
+	statusV, ok := statusF.(map[string]interface{})
+	if !ok {
+		return "", ""
+	}
+	conditionsF, ok := statusV["conditions"]
+	if !ok {
+		return "", ""
+	}
+	conditionsV, ok := conditionsF.([]interface{})
+	if !ok {
+		return "", ""
+	}
+
+	for _, cond := range conditionsV {
+		condM, ok := cond.(map[string]interface{})
+		if !ok  {
+			return "", ""
+		}
+		condType, ok := condM["type"].(string)
+		if !ok {
+			return "", ""
+		}
+		if condType == "Ready" {
+			condStatus, _ := condM["status"].(string)
+			condReason, _ := condM["reason"].(string)
+			return ReadyStatus(condStatus), Reason(condReason)
+		}
+	}
+	return "", ""
+}

cmd/kubectl-tree/tree.go

@@ -2,17 +2,80 @@ package main
 
 import (
 	"fmt"
+	"github.com/fatih/color"
+	"github.com/gosuri/uitable"
 	"io"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"strings"
 )
 
+const (
+	firstElemPrefix = `├─`
+	lastElemPrefix  = `└─`
+	indent          = "  "
+	pipe            = `│ `
+)
+
+var (
+	gray  = color.New(color.FgHiBlack)
+	red   = color.New(color.FgRed)
+	green = color.New(color.FgGreen)
+)
+
+// treeView prints object hierarchy to out stream.
 func treeView(out io.Writer, objs objectDirectory, obj unstructured.Unstructured) {
-	treeViewInner("", out, objs, obj)
+	tbl := uitable.New()
+	tbl.AddRow("NAMESPACE", "NAME", "READY", "REASON")
+	treeViewInner("", tbl, objs, obj)
+	fmt.Fprintln(out, tbl)
 }
 
-func treeViewInner(prefix string, out io.Writer, objs objectDirectory, obj unstructured.Unstructured) {
-	fmt.Fprintf(out, prefix+"%s/%s (#%s#)\n", obj.GetKind(), obj.GetName(),obj.GetUID())
-	for _, child := range objs.ownedBy(obj.GetUID()) {
-		treeViewInner(prefix+"  ", out, objs, objs.getObject(child))
+func treeViewInner(prefix string, tbl *uitable.Table, objs objectDirectory, obj unstructured.Unstructured) {
+	ready, reason := extractStatus(obj)
+
+	var readyColor *color.Color
+	switch ready {
+	case "True":
+		readyColor = green
+	case "False", "Unknown":
+		readyColor = red
+	default:
+		readyColor = gray
+	}
+	if ready == "" {
+		ready = "-"
+	}
+
+	tbl.AddRow(obj.GetNamespace(), fmt.Sprintf("%s%s/%s",
+		gray.Sprint(printPrefix(prefix)),
+		gray.Sprint(obj.GetKind()),
+		color.New(color.Bold).Sprint(obj.GetName())),
+		readyColor.Sprint(ready),
+		readyColor.Sprint(reason))
+	chs := objs.ownedBy(obj.GetUID())
+	for i, child := range chs {
+		var p string
+		switch i {
+		case len(chs) - 1:
+			p = prefix + lastElemPrefix
+		default:
+			p = prefix + firstElemPrefix
+		}
+		treeViewInner(p, tbl, objs, child)
+	}
+}
+
+func printPrefix(p string) string {
+	if strings.HasSuffix(p, firstElemPrefix) {
+		p = strings.Replace(p, firstElemPrefix, pipe, strings.Count(p, firstElemPrefix)-1)
+	} else {
+		p = strings.ReplaceAll(p, firstElemPrefix, pipe)
+	}
+
+	if strings.HasSuffix(p, lastElemPrefix) {
+		p = strings.Replace(p, lastElemPrefix, strings.Repeat(" ", len([]rune(lastElemPrefix))), strings.Count(p, lastElemPrefix)-1)
+	} else {
+		p = strings.ReplaceAll(p, lastElemPrefix, strings.Repeat(" ", len([]rune(lastElemPrefix))))
 	}
+	return p
 }

go.mod

@@ -7,13 +7,15 @@ require (
 	github.com/cppforlife/go-cli-ui v0.0.0-20181113222104-5a69326440e8 // indirect
 	github.com/emicklei/go-restful v2.9.6+incompatible // indirect
 	github.com/evanphx/json-patch v4.5.0+incompatible // indirect
-	github.com/fatih/color v1.7.0 // indirect
+	github.com/fatih/color v1.7.0
 	github.com/googleapis/gnostic v0.3.0 // indirect
+	github.com/gosuri/uitable v0.0.4
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/imdario/mergo v0.3.7 // indirect
 	github.com/k14s/kapp v0.16.0 // indirect
 	github.com/mattn/go-colorable v0.1.4 // indirect
 	github.com/mattn/go-isatty v0.0.11 // indirect
+	github.com/mattn/go-runewidth v0.0.7 // indirect
 	github.com/spf13/cobra v0.0.5
 	github.com/vito/go-interact v1.0.0 // indirect
 	golang.org/x/crypto v0.0.0-20191206172530-e9b2fee46413 // indirect

go.sum

@@ -100,6 +100,8 @@ github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d/go.mod h1:sJBsC
 github.com/googleapis/gnostic v0.3.0 h1:CcQijm0XKekKjP/YCz28LXVSpgguuB+nCxaSjCe09y0=
 github.com/googleapis/gnostic v0.3.0/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY=
 github.com/gophercloud/gophercloud v0.1.0/go.mod h1:vxM41WHh5uqHVBMZHzuwNOHh8XEoIEcSTewFxm1c5g8=
+github.com/gosuri/uitable v0.0.4 h1:IG2xLKRvErL3uhY6e1BylFzG+aJiwQviDDTfOKeKTpY=
+github.com/gosuri/uitable v0.0.4/go.mod h1:tKR86bXuXPZazfOTG1FIzvjIdXzd0mo4Vtn16vt0PJo=
 github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA=
 github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 h1:+ngKgrYPPJrOjhax5N+uePQ0Fh1Z7PheYoUI/0nzkPA=
 github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA=
@@ -142,6 +144,8 @@ github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVc
 github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
 github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
+github.com/mattn/go-runewidth v0.0.7 h1:Ei8KR0497xHyKJPAv59M1dkC+rOZCMBJ+t3fZ+twI54=
+github.com/mattn/go-runewidth v0.0.7/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=