Merge branch 'master' into skip-forbidden-resources

Author: alam0rt

cmd/kubectl-tree/apis.go

@@ -46,7 +46,7 @@ func findAPIs(client discovery.DiscoveryInterface) (*resourceMap, error) {
 	start := time.Now()
 	resList, err := client.ServerPreferredResources()
 	if err != nil {
-		return nil, fmt.Errorf("failed to fetch api groups from kubernetes: %w", err)
+		klog.V(1).Infof("failed to fetch api groups from kubernetes: %v\n", err)
 	}
 	klog.V(2).Infof("queried api discovery in %v", time.Since(start))
 	klog.V(3).Infof("found %d items (groups) in server-preferred APIResourceList", len(resList))
@@ -100,9 +100,16 @@ func apiNames(a metav1.APIResource, gv schema.GroupVersion) []string {
 		// TODO(ahmetb): sometimes SingularName is empty (e.g. Deployment), use lowercase Kind as fallback - investigate why
 		singularName = strings.ToLower(a.Kind)
 	}
+	names := []string{singularName}
+
 	pluralName := a.Name
+	if singularName != pluralName {
+		names = append(names, pluralName)
+	}
+
 	shortNames := a.ShortNames
-	names := append([]string{singularName, pluralName}, shortNames...)
+	names = append(names, shortNames...)
+
 	for _, n := range names {
 		fmtBare := n                                                                // e.g. deployment
 		fmtWithGroup := strings.Join([]string{n, gv.Group}, ".")                    // e.g. deployment.apps
@@ -113,3 +120,20 @@ func apiNames(a metav1.APIResource, gv schema.GroupVersion) []string {
 	}
 	return out
 }
+
+func figureOutKindName(args []string) (string, string, error) {
+	if l := len(args); l == 0 || l > 2 {
+		return "", "", fmt.Errorf("accepts between 1 and 2 arg(s), received %d", l)
+	}
+	if len(args) == 2 {
+		return args[0], args[1], nil
+	}
+	seg := strings.Split(args[0], "/")
+	if len(seg) < 2 {
+		return "", "", fmt.Errorf("specify the kubernetes object in KIND NAME or KIND/NAME form")
+	}
+	if len(seg) > 2 {
+		return "", "", fmt.Errorf("arguments in KIND/NAME form may not have more than one slash")
+	}
+	return seg[0], seg[1], nil
+}

cmd/kubectl-tree/rootcmd.go

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -22,17 +22,21 @@ import (
 	"os"
 	"strings"
 
+	"github.com/fatih/color"
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	"k8s.io/client-go/dynamic"
 	_ "k8s.io/client-go/plugin/pkg/client/auth" // combined authprovider import
+	"k8s.io/client-go/rest"
 	"k8s.io/klog"
 )
 
 const (
 	allNamespacesFlag = "all-namespaces"
+	colorFlag         = "color"
 )
 
 var cf *genericclioptions.ConfigFlags
@@ -47,7 +51,7 @@ var rootCmd = &cobra.Command{
 	Short:        "Show sub-resources of the Kubernetes object",
 	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),
+	Args:    cobra.RangeArgs(1, 2),
 	RunE:    run,
 	Version: versionString(),
 }
@@ -63,16 +67,28 @@ func versionString() string {
 }
 
 func run(command *cobra.Command, args []string) error {
-
 	allNs, err := command.Flags().GetBool(allNamespacesFlag)
 	if err != nil {
 		allNs = false
 	}
 
+	colorArg, err := command.Flags().GetString(colorFlag)
+	if err != nil {
+		return err
+	}
+	if colorArg == "always" {
+		color.NoColor = false
+	} else if colorArg == "never" {
+		color.NoColor = true
+	} else if colorArg != "auto" {
+		return errors.Errorf("invalid value for --%s", colorFlag)
+	}
+
 	restConfig, err := cf.ToRESTConfig()
 	if err != nil {
 		return err
 	}
+	restConfig.WarningHandler = rest.NoWarnings{}
 	restConfig.QPS = 1000
 	restConfig.Burst = 1000
 	dyn, err := dynamic.NewForConfig(restConfig)
@@ -90,7 +106,10 @@ func run(command *cobra.Command, args []string) error {
 	}
 	klog.V(3).Info("completed querying APIs list")
 
-	kind, name := args[0], args[1]
+	kind, name, err := figureOutKindName(args)
+	if err != nil {
+		return err
+	}
 	klog.V(3).Infof("parsed kind=%v name=%v", kind, name)
 
 	var api apiResource
@@ -160,6 +179,7 @@ func init() {
 	cf = genericclioptions.NewConfigFlags(true)
 
 	rootCmd.Flags().BoolP(allNamespacesFlag, "A", false, "query all objects in all API groups, both namespaced and non-namespaced")
+	rootCmd.Flags().StringP(colorFlag, "c", "auto", "Enable or disable color output. This can be 'always', 'never', or 'auto' (default = use color only if using tty). The flag is overridden by the NO_COLOR env variable if set.")
 
 	cf.AddFlags(rootCmd.Flags())
 	if err := flag.Set("logtostderr", "true"); err != nil {

cmd/kubectl-tree/status.go

@@ -5,45 +5,50 @@ import (
 
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/klog"
+	"sigs.k8s.io/cli-utils/pkg/kstatus/status"
 )
 
 type ReadyStatus string // True False Unknown or ""
 type Reason string
 
-func extractStatus(obj unstructured.Unstructured) (ReadyStatus, Reason) {
+func extractStatus(obj unstructured.Unstructured) (ReadyStatus, Reason, status.Status) {
 	jsonVal, _ := json.Marshal(obj.Object["status"])
 	klog.V(6).Infof("status for object=%s/%s: %s", obj.GetKind(), obj.GetName(), string(jsonVal))
+	result, err := status.Compute(&obj)
+	if err != nil {
+		return "", "", ""
+	}
 	statusF, ok := obj.Object["status"]
 	if !ok {
-		return "", ""
+		return "", "", ""
 	}
 	statusV, ok := statusF.(map[string]interface{})
 	if !ok {
-		return "", ""
+		return "", "", ""
 	}
 	conditionsF, ok := statusV["conditions"]
 	if !ok {
-		return "", ""
+		return "", "", ""
 	}
 	conditionsV, ok := conditionsF.([]interface{})
 	if !ok {
-		return "", ""
+		return "", "", ""
 	}
 
 	for _, cond := range conditionsV {
 		condM, ok := cond.(map[string]interface{})
 		if !ok {
-			return "", ""
+			return "", "", ""
 		}
 		condType, ok := condM["type"].(string)
 		if !ok {
-			return "", ""
+			return "", "", ""
 		}
 		if condType == "Ready" {
 			condStatus, _ := condM["status"].(string)
 			condReason, _ := condM["reason"].(string)
-			return ReadyStatus(condStatus), Reason(condReason)
+			return ReadyStatus(condStatus), Reason(condReason), status.Status(result.Status.String())
 		}
 	}
-	return "", ""
+	return "", "", ""
 }

cmd/kubectl-tree/tree.go

@@ -10,6 +10,7 @@ import (
 	"github.com/gosuri/uitable"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/util/duration"
+	"sigs.k8s.io/cli-utils/pkg/kstatus/status"
 )
 
 const (
@@ -20,22 +21,23 @@ const (
 )
 
 var (
-	gray  = color.New(color.FgHiBlack)
-	red   = color.New(color.FgRed)
-	green = color.New(color.FgGreen)
+	gray   = color.New(color.FgHiBlack)
+	red    = color.New(color.FgRed)
+	yellow = color.New(color.FgYellow)
+	green  = color.New(color.FgGreen)
 )
 
 // treeView prints object hierarchy to out stream.
 func treeView(out io.Writer, objs objectDirectory, obj unstructured.Unstructured) {
 	tbl := uitable.New()
 	tbl.Separator = "  "
-	tbl.AddRow("NAMESPACE", "NAME", "READY", "REASON", "AGE")
+	tbl.AddRow("NAMESPACE", "NAME", "READY", "REASON", "STATUS", "AGE")
 	treeViewInner("", tbl, objs, obj)
 	fmt.Fprintln(color.Output, tbl)
 }
 
 func treeViewInner(prefix string, tbl *uitable.Table, objs objectDirectory, obj unstructured.Unstructured) {
-	ready, reason := extractStatus(obj)
+	ready, reason, kstatus := extractStatus(obj)
 
 	var readyColor *color.Color
 	switch ready {
@@ -50,6 +52,21 @@ func treeViewInner(prefix string, tbl *uitable.Table, objs objectDirectory, obj
 		ready = "-"
 	}
 
+	var statusColor *color.Color
+	switch kstatus {
+	case status.CurrentStatus:
+		statusColor = green
+	case status.InProgressStatus:
+		statusColor = yellow
+	case status.FailedStatus, status.TerminatingStatus:
+		statusColor = red
+	default:
+		statusColor = gray
+	}
+	if kstatus == "" {
+		kstatus = "-"
+	}
+
 	c := obj.GetCreationTimestamp()
 	age := duration.HumanDuration(time.Since(c.Time))
 	if c.IsZero() {
@@ -62,6 +79,7 @@ func treeViewInner(prefix string, tbl *uitable.Table, objs objectDirectory, obj
 		color.New(color.Bold).Sprint(obj.GetName())),
 		readyColor.Sprint(ready),
 		readyColor.Sprint(reason),
+		statusColor.Sprint(kstatus),
 		age)
 	chs := objs.ownedBy(obj.GetUID())
 	for i, child := range chs {

go.mod

@@ -3,82 +3,71 @@ module github.com/ahmetb/kubectl-tree
 go 1.22
 
 require (
-	github.com/fatih/color v1.13.0
+	github.com/fatih/color v1.15.0
 	github.com/gosuri/uitable v0.0.4
-	github.com/spf13/cobra v1.4.0
+	github.com/pkg/errors v0.9.1
+	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5
-	k8s.io/apimachinery v0.24.1
-	k8s.io/cli-runtime v0.24.1
-	k8s.io/client-go v0.24.1
+	k8s.io/apimachinery v0.27.4
+	k8s.io/cli-runtime v0.27.4
+	k8s.io/client-go v0.27.4
 	k8s.io/klog v1.0.0
+	sigs.k8s.io/cli-utils v0.35.0
 )
 
 require (
-	cloud.google.com/go v0.81.0 // indirect
-	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
-	github.com/Azure/go-autorest/autorest v0.11.18 // indirect
-	github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect
-	github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
-	github.com/Azure/go-autorest/logger v0.2.1 // indirect
-	github.com/Azure/go-autorest/tracing v0.6.0 // indirect
-	github.com/PuerkitoBio/purell v1.1.1 // indirect
-	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/emicklei/go-restful v2.9.5+incompatible // indirect
+	github.com/emicklei/go-restful/v3 v3.9.0 // indirect
 	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
-	github.com/form3tech-oss/jwt-go v3.2.3+incompatible // indirect
-	github.com/go-errors/errors v1.0.1 // indirect
-	github.com/go-logr/logr v1.2.0 // indirect
-	github.com/go-openapi/jsonpointer v0.19.5 // indirect
-	github.com/go-openapi/jsonreference v0.19.5 // indirect
-	github.com/go-openapi/swag v0.19.14 // indirect
+	github.com/go-errors/errors v1.4.2 // indirect
+	github.com/go-logr/logr v1.2.3 // indirect
+	github.com/go-openapi/jsonpointer v0.19.6 // indirect
+	github.com/go-openapi/jsonreference v0.20.1 // indirect
+	github.com/go-openapi/swag v0.22.3 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/btree v1.0.1 // indirect
 	github.com/google/gnostic v0.5.7-v3refs // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
 	github.com/google/gofuzz v1.1.0 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
-	github.com/google/uuid v1.1.2 // indirect
+	github.com/google/uuid v1.3.0 // indirect
 	github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7 // indirect
-	github.com/imdario/mergo v0.3.5 // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/liggitt/tabwriter v0.0.0-20181228230101-89fcab3d43de // indirect
-	github.com/mailru/easyjson v0.7.6 // indirect
-	github.com/mattn/go-colorable v0.1.9 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
-	github.com/mattn/go-runewidth v0.0.13 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
-	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
-	github.com/stretchr/testify v1.7.0 // indirect
-	github.com/xlab/treeprint v0.0.0-20181112141820-a009c3971eca // indirect
+	github.com/xlab/treeprint v1.1.0 // indirect
 	go.starlark.net v0.0.0-20200306205701-8dd3e2ee1dd5 // indirect
-	golang.org/x/crypto v0.0.0-20220214200702-86341886e292 // indirect
-	golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
-	golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 // indirect
-	golang.org/x/sys v0.0.0-20220209214540-3681064d5158 // indirect
-	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
-	golang.org/x/text v0.3.7 // indirect
-	golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/oauth2 v0.0.0-20220223155221-ee480838109b // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/term v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/protobuf v1.27.1 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
-	k8s.io/api v0.24.1 // indirect
-	k8s.io/klog/v2 v2.60.1 // indirect
-	k8s.io/kube-openapi v0.0.0-20220328201542-3ee0da9b0b42 // indirect
-	k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9 // indirect
-	sigs.k8s.io/json v0.0.0-20211208200746-9f7c6b3444d2 // indirect
-	sigs.k8s.io/kustomize/api v0.11.4 // indirect
-	sigs.k8s.io/kustomize/kyaml v0.13.6 // indirect
-	sigs.k8s.io/structured-merge-diff/v4 v4.2.1 // indirect
-	sigs.k8s.io/yaml v1.2.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/api v0.27.4 // indirect
+	k8s.io/klog/v2 v2.90.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f // indirect
+	k8s.io/utils v0.0.0-20230209194617-a36077c30491 // indirect
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
+	sigs.k8s.io/kustomize/api v0.13.2 // indirect
+	sigs.k8s.io/kustomize/kyaml v0.14.1 // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
+	sigs.k8s.io/yaml v1.3.0 // indirect
 )