feat: Do not wait for workload to be ready when using --output flag (#488)

Signed-off-by: Wendy Arango <warango@vmware.com>

Author: Wendy Maria Arango Chavarria

pkg/cli-runtime/printer/resource.go

@@ -96,7 +96,14 @@ func OutputResource(obj Object, format OutputFormat, scheme *runtime.Scheme) (st
 	if err != nil {
 		return "", err
 	}
-	return printObject(copy, format)
+	u, err := runtime.DefaultUnstructuredConverter.ToUnstructured(copy)
+	if err != nil {
+		return "", err
+	}
+
+	unstructured.RemoveNestedField(u, "metadata", "managedFields")
+
+	return printObject(u, format)
 }
 
 func OutputResources(objList []Object, format OutputFormat, scheme *runtime.Scheme) (string, error) {

pkg/cli-runtime/printer/resource_test.go

@@ -325,8 +325,6 @@ metadata:
   generation: 1
   labels:
     name: value
-  managedFields:
-  - manager: tanzu
   name: my-workload
   namespace: default
   ownerReferences:
@@ -395,24 +393,24 @@ status:
 		},
 		want: `
 {
-	"kind": "Workload",
 	"apiVersion": "carto.run/v1alpha1",
+	"kind": "Workload",
 	"metadata": {
-		"name": "my-workload",
-		"namespace": "default",
-		"selfLink": "/default/my-workload",
-		"uid": "uid-xyz",
-		"resourceVersion": "999",
-		"generation": 1,
+		"annotations": {
+			"name": "value"
+		},
 		"creationTimestamp": "2021-09-10T15:00:00Z",
-		"deletionTimestamp": "2021-09-10T15:00:00Z",
 		"deletionGracePeriodSeconds": 5,
+		"deletionTimestamp": "2021-09-10T15:00:00Z",
+		"finalizers": [
+			"my.finalizer"
+		],
+		"generation": 1,
 		"labels": {
 			"name": "value"
 		},
-		"annotations": {
-			"name": "value"
-		},
+		"name": "my-workload",
+		"namespace": "default",
 		"ownerReferences": [
 			{
 				"apiVersion": "v1",
@@ -421,24 +419,19 @@ status:
 				"uid": ""
 			}
 		],
-		"finalizers": [
-			"my.finalizer"
-		],
-		"managedFields": [
-			{
-				"manager": "tanzu"
-			}
-		]
+		"resourceVersion": "999",
+		"selfLink": "/default/my-workload",
+		"uid": "uid-xyz"
 	},
 	"spec": {},
 	"status": {
 		"conditions": [
 			{
-				"type": "Ready",
-				"status": "True",
 				"lastTransitionTime": "2019-06-29T01:44:05Z",
+				"message": "a hopefully informative message about what went wrong",
 				"reason": "No printing status",
-				"message": "a hopefully informative message about what went wrong"
+				"status": "True",
+				"type": "Ready"
 			}
 		],
 		"supplyChainRef": {}

pkg/commands/workload.go

@@ -746,27 +746,14 @@ func (opts *WorkloadOptions) WaitToBeReady(c *cli.Config, workload *cartov1alpha
 		func(ctx context.Context) error {
 			clientWithWatch, err := watch.GetWatcher(ctx, c)
 			if err != nil {
-				panic(err)
+				return err
 			}
 			return wait.UntilCondition(ctx, clientWithWatch, types.NamespacedName{Name: workload.Name, Namespace: workload.Namespace}, &cartov1alpha1.WorkloadList{}, cartov1alpha1.WorkloadReadyConditionFunc)
 		},
 	}
 	return workers
 }
 
-func (opts *WorkloadOptions) WaitError(ctx context.Context, c *cli.Config, workload *cartov1alpha1.Workload, workers []wait.Worker) error {
-	if err := wait.Race(ctx, opts.WaitTimeout, workers); err != nil {
-		if err == context.DeadlineExceeded {
-			c.Printf("%s timeout after %s waiting for %q to become ready\n", printer.Serrorf("Error:"), opts.WaitTimeout, workload.Name)
-			return cli.SilenceError(err)
-		}
-		c.Eprintf("%s %s\n", printer.Serrorf("Error:"), err)
-		return cli.SilenceError(err)
-	}
-
-	return nil
-}
-
 func (opts *WorkloadOptions) DefineFlags(ctx context.Context, c *cli.Config, cmd *cobra.Command) {
 	cli.NamespaceFlag(ctx, cmd, c, &opts.Namespace)
 	cmd.Flags().StringVarP(&opts.FilePath, cli.StripDash(flags.FilePathFlagName), "f", "", "`file path` containing the description of a single workload, other flags are layered on top of this resource. Use value \"-\" to read from stdin")

pkg/commands/workload_apply.go

@@ -34,6 +34,7 @@ import (
 	"github.com/vmware-tanzu/apps-cli-plugin/pkg/cli-runtime/wait"
 	"github.com/vmware-tanzu/apps-cli-plugin/pkg/completion"
 	"github.com/vmware-tanzu/apps-cli-plugin/pkg/flags"
+	"github.com/vmware-tanzu/apps-cli-plugin/pkg/printer"
 )
 
 type WorkloadApplyOptions struct {
@@ -206,45 +207,55 @@ func (opts *WorkloadApplyOptions) Exec(ctx context.Context, c *cli.Config) error
 		}
 	}
 
-	var workers []wait.Worker
-	if opts.Output != "" && okToApply {
-		workers = opts.WaitToBeReady(c, workload)
-		if err := opts.WaitError(ctx, c, workload, workers); err != nil {
-			return err
-		}
-		// once the workload is ready, get it as is in the cluster
-		if err := c.Get(ctx, client.ObjectKey{Namespace: opts.Namespace, Name: opts.Name}, workload); err != nil {
-			return err
-		}
-		if err := opts.OutputWorkload(c, workload); err != nil {
-			return err
-		}
-
-		return nil
-	}
-
-	anyTail := opts.Tail || opts.TailTimestamps
-	if okToApply && (opts.Wait || anyTail) {
-		c.Infof("Waiting for workload %q to become ready...\n", opts.Name)
-
-		workers = opts.WaitToBeReady(c, workload)
+	if okToApply {
+		anyTail := opts.Tail || opts.TailTimestamps
+		if opts.Wait || anyTail {
+			cli.PrintPrompt(shouldPrint, c.Infof, "Waiting for workload %q to become ready...\n", opts.Name)
+
+			workers := opts.WaitToBeReady(c, workload)
+
+			if anyTail {
+				workers = append(workers, func(ctx context.Context) error {
+					selector, err := labels.Parse(fmt.Sprintf("%s=%s", cartov1alpha1.WorkloadLabelName, workload.Name))
+					if err != nil {
+						return err
+					}
+					containers := []string{}
+					return logs.Tail(ctx, c, opts.Namespace, selector, containers, time.Minute, opts.TailTimestamps)
+				})
+			}
 
-		if anyTail {
-			workers = append(workers, func(ctx context.Context) error {
-				selector, err := labels.Parse(fmt.Sprintf("%s=%s", cartov1alpha1.WorkloadLabelName, workload.Name))
-				if err != nil {
-					panic(err)
+			err := wait.Race(ctx, opts.WaitTimeout, workers)
+			// print wait error only if output is not set or it was not used with --yes
+			if err != nil {
+				if err == context.DeadlineExceeded {
+					cli.PrintPrompt(shouldPrint, c.Printf, "%s timeout after %s waiting for %q to become ready\n", printer.Serrorf("Error:"), opts.WaitTimeout, workload.Name)
+				} else {
+					cli.PrintPrompt(shouldPrint, c.Eprintf, "%s %s\n", printer.Serrorf("Error:"), err)
 				}
-				containers := []string{}
-				return logs.Tail(ctx, c, opts.Namespace, selector, containers, time.Minute, opts.TailTimestamps)
-			})
-		}
+			}
+			// do not return if --output is set
+			// because workload has to be printed despite it's in a failing state
+			if err != nil && opts.Output == "" {
+				return cli.SilenceError(err)
+			}
 
-		if err := opts.WaitError(ctx, c, workload, workers); err != nil {
-			return err
+			// since there is a possibility that wait failed but did not return
+			// make sure this prompt is printed only if there is no error
+			if err == nil {
+				cli.PrintPrompt(shouldPrint, c.Infof, "Workload %q is ready\n\n", workload.Name)
+			}
 		}
 
-		c.Infof("Workload %q is ready\n\n", workload.Name)
+		if opts.Output != "" {
+			// once the workload is applied, get it as is in the cluster
+			if err := c.Get(ctx, client.ObjectKey{Namespace: opts.Namespace, Name: opts.Name}, workload); err != nil {
+				return err
+			}
+			if err := opts.OutputWorkload(c, workload); err != nil {
+				return err
+			}
+		}
 	}
 
 	return nil