Add inventory name as an attribute to event and json format, and remove unused functions and constants.

Author: chunglu-chou

thirdparty/cli-utils/status/cmdstatus.go

@@ -42,10 +42,6 @@ const (
 	Current = "current"
 	Deleted = "deleted"
 	Forever = "forever"
-	// printing parameters
-	colorCyan  = "\033[36m"
-	colorReset = "\033[0m"
-	separator  = "-----------------------------------------"
 )
 
 var (
@@ -77,7 +73,7 @@ func NewRunner(ctx context.Context, factory util.Factory) *Runner {
 		"How long to wait before exiting")
 	c.Flags().BoolVar(&r.list, "list", false, "List status of all packages or not")
 	c.Flags().StringVar(&r.inventoryNames, "inv-name", "", "names of targeted inventory: inv1,inv2,...")
-	c.Flags().StringVar(&r.namespaces, "namespace", "", "names of targeted namespaces: ns1,ns2,...")
+	c.Flags().StringVar(&r.namespaces, "namespaces", "", "names of targeted namespaces: ns1,ns2,...")
 	c.Flags().StringVar(&r.status, "status", "", "targeted status: st1,st2...")
 	return r
 }
@@ -365,7 +361,7 @@ func (r *Runner) runE(c *cobra.Command, args []string) error {
 // ResourceStatusCollector that will cancel the context (using the cancelFunc)
 // when all resources have reached the desired status.
 func desiredStatusNotifierFunc(cancelFunc context.CancelFunc,
-		desired kstatus.Status) collector.ObserverFunc {
+	desired kstatus.Status) collector.ObserverFunc {
 	return func(rsc *collector.ResourceStatusCollector, _ event.Event) {
 		var rss []*event.ResourceStatus
 		for _, rs := range rsc.ResourceStatuses {

thirdparty/cli-utils/status/printers/list/base.go

@@ -15,25 +15,29 @@
 package list
 
 import (
+	"encoding/json"
+	"fmt"
+	"strings"
+	"time"
+
 	"sigs.k8s.io/cli-utils/pkg/apply/event"
 	"sigs.k8s.io/cli-utils/pkg/kstatus/polling/collector"
 	pollevent "sigs.k8s.io/cli-utils/pkg/kstatus/polling/event"
 	"sigs.k8s.io/cli-utils/pkg/object"
 	"sigs.k8s.io/cli-utils/pkg/print/list"
+	"sigs.k8s.io/cli-utils/pkg/printers"
 )
 
 // BaseListPrinter implements the Printer interface and outputs the resource
 // status information as a list of events as they happen.
 type BaseListPrinter struct {
 	Formatter list.Formatter
+	Format    string
 	Data      *PrintData
 }
 
 // PrintData records data required for printing
 type PrintData struct {
-	// IndexResourceMap map[int]object.ObjMetadata
-	// IndexGroupMap    map[int]string
-	// MaxElement       int
 	Identifiers object.ObjMetadataSet
 	InvNameMap  map[object.ObjMetadata]string
 	StatusSet   map[string]bool
@@ -53,7 +57,7 @@ func (ep *BaseListPrinter) PrintError(e error) error {
 // every event and is responsible for stopping the poller when appropriate.
 // This function will block.
 func (ep *BaseListPrinter) Print(ch <-chan pollevent.Event, identifiers []object.ObjMetadata,
-	cancelFunc collector.ObserverFunc) error {
+		cancelFunc collector.ObserverFunc) error {
 	coll := collector.NewResourceStatusCollector(identifiers)
 	// The actual work is done by the collector, which will invoke the
 	// callback on every event. In the callback we print the status
@@ -80,15 +84,50 @@ func (ep *BaseListPrinter) printStatusEvent(se pollevent.Event) error {
 	switch se.Type {
 	case pollevent.ResourceUpdateEvent:
 		id := se.Resource.Identifier
-		return ep.Formatter.FormatStatusEvent(event.StatusEvent{
-			Identifier:       id,
-			Resource:         se.Resource.Resource,
-			PollResourceInfo: se.Resource,
-		})
+		var invName string
+		var ok bool
+		if invName, ok = ep.Data.InvNameMap[id]; !ok {
+			return fmt.Errorf("Resource not found\n")
+		}
+		// filter out status that are not assigned
+		statusString := se.Resource.Status.String()
+		if _, ok := ep.Data.StatusSet[strings.ToLower(statusString)]; len(ep.Data.StatusSet) != 0 && !ok {
+			return nil
+		}
+		switch ep.Format {
+		case printers.EventsPrinter:
+			_, err := fmt.Printf("%s/%s/%s/%s is %s: %s\n", invName,
+				strings.ToLower(id.GroupKind.String()), id.Namespace, id.Name, statusString, se.Resource.Message)
+			return err
+		case printers.JSONPrinter:
+			eventInfo := ep.createJsonObj(id)
+			eventInfo["inventory-name"] = invName
+			eventInfo["status"] = statusString
+			eventInfo["message"] = se.Resource.Message
+			b, err := json.Marshal(eventInfo)
+			if err != nil {
+				return err
+			}
+			_, err = fmt.Println(string(b))
+			return err
+		default:
+			return fmt.Errorf("No such printer type\n")
+		}
 	case pollevent.ErrorEvent:
 		return ep.Formatter.FormatErrorEvent(event.ErrorEvent{
 			Err: se.Error,
 		})
 	}
 	return nil
 }
+
+func (ep *BaseListPrinter) createJsonObj(id object.ObjMetadata) map[string]interface{} {
+	return map[string]interface{}{
+		"group":     id.GroupKind.Group,
+		"kind":      id.GroupKind.Kind,
+		"namespace": id.Namespace,
+		"name":      id.Name,
+		"timestamp": time.Now().UTC().Format(time.RFC3339),
+		"type":      "status",
+	}
+}

thirdparty/cli-utils/status/printers/printers.go

@@ -23,11 +23,13 @@ func CreatePrinter(printerType string, ioStreams genericclioptions.IOStreams, pr
 	case printers.JSONPrinter:
 		return &list.BaseListPrinter{
 			Formatter: json.NewFormatter(ioStreams, common.DryRunNone),
+			Format:    printers.JSONPrinter,
 			Data:      printData,
 		}, nil
 	default:
 		return &list.BaseListPrinter{
 			Formatter: events.NewFormatter(ioStreams, common.DryRunNone),
+			Format:    printers.EventsPrinter,
 			Data:      printData,
 		}, nil
 	}

thirdparty/cli-utils/status/printers/table/table_printer.go

@@ -20,8 +20,6 @@ import (
 const (
 	// updateInterval defines how often the printer will update the UI.
 	updateInterval = 1 * time.Second
-	// separator for grouping
-	separator = "-----------------------------------------"
 )
 
 // tablePrinter is an implementation of the Printer interface that outputs
@@ -34,21 +32,9 @@ type tablePrinter struct {
 
 // NewTablePrinter returns a new instance of the tablePrinter.
 func NewTablePrinter(ioStreams genericclioptions.IOStreams, printData *list.PrintData) *tablePrinter {
-	/*invNameMap := make(map[object.ObjMetadata]string)
-	var currGroup string
-	for i := 0; i < printData.MaxElement; i++ {
-		if text, ok := printData.IndexGroupMap[i]; ok {
-			if text != separator {
-				currGroup = text
-			}
-		} else {
-			invNameMap[printData.IndexResourceMap[i]] = currGroup
-		}
-	}*/
 	return &tablePrinter{
 		ioStreams: ioStreams,
 		printData: printData,
-		// invNameMap: invNameMap,
 	}
 }