feat: Add --update-strategy flag to change apply behavior when contents from file is applied (#402)

- This is an initial commit, the first part that is creating the flag, allow autocompletion and adding the warning message for this new breaking change.
- Added fields validation (usage of --filepath with --update-strategy
and `merge`, `replace` as only accepted values for --update-strategy)
- Add unit tests for fields validation
- Add logic for flag behavior
- Amend the workload assignation when replacing
- Add --update-strategy to options when updating workload from file

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

Author: Wendy Maria Arango Chavarria

docs/command-reference/tanzu_apps_workload_apply.md

@@ -63,6 +63,7 @@ tanzu apps workload apply --file workload.yaml
       --tail                           show logs while waiting for workload to become ready
       --tail-timestamp                 show logs and add timestamp to each log line while waiting for workload to become ready
   -t, --type type                      distinguish workload type
+      --update-strategy string         specify configuration file update strategy (supported strategies: merge, replace) (default "merge")
       --wait                           waits for workload to become ready
       --wait-timeout duration          timeout for workload to become ready when waiting (default 10m0s)
   -y, --yes                            accept all prompts

docs/command-reference/tanzu_apps_workload_tail.md

@@ -25,7 +25,7 @@ tanzu apps workload tail my-workload --since 1h
       --component name   workload component name (e.g. build)
   -h, --help             help for tail
   -n, --namespace name   kubernetes namespace (defaulted from kube config)
-      --since duration   time duration to start reading logs from (default 1s)
+      --since duration   time duration to start reading logs from (default 1m0s)
   -t, --timestamp        print timestamp for each log line
 ```
 

docs/commands-details/workload_create_update_apply.md

@@ -398,36 +398,23 @@ Create workload:
 </details>
 
 ### `--image`, `-i`
-Sets the OSI image to be used as the workload application source instead of a git repository
+Sets the OCI image to be used as the workload application source instead of a git repository
 
  <details><summary>Example</summary>
 
 ```bash
 tanzu apps workload apply spring-pet-clinic --image private.repo.domain.com/spring-pet-clinic --type web
 Create workload:
-       1 + |---
-       2 + |apiVersion: carto.run/v1alpha1
-       3 + |kind: Workload
-       4 + |metadata:
-       5 + |  labels:
-       6 + |    apps.tanzu.vmware.com/workload-type: web
-       7 + |  name: spring-pet-clinic
-       8 + |  namespace: default
-       9 + |spec:
-      10 + |  build:
-      11 + |    env:
-      12 + |    - name: JAVA_VERSION
-      13 + |      value: "1.8"
-      14 + |  params:
-      15 + |  - name: server
-      16 + |    value:
-      17 + |      management-port: 9190
-      18 + |      port: 9090
-      19 + |  source:
-      20 + |    git:
-      21 + |      ref:
-      22 + |        tag: tap-1.1
-      23 + |      url: https://github.com/sample-accelerators/spring-petclinic
+      1 + |---
+      2 + |apiVersion: carto.run/v1alpha1
+      3 + |kind: Workload
+      4 + |metadata:
+      5 + |  labels:
+      6 + |    apps.tanzu.vmware.com/workload-type: web
+      7 + |  name: spring-pet-clinic
+      8 + |  namespace: default
+      9 + |spec:
+     10 + |  image: private.repo.domain.com/spring-pet-clinic
 
 ? Do you want to create this workload? [yN]
 ```

pkg/apis/cartographer/v1alpha1/workload_helpers.go

@@ -21,6 +21,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"reflect"
 
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
@@ -97,6 +98,20 @@ func (w *WorkloadSpec) MergeServiceAccountName(serviceAccountName string) {
 	w.ServiceAccountName = serviceAccountNamePtr
 }
 
+func (w *Workload) ReplaceMetadata(updates *Workload) {
+	if updates != nil && !reflect.DeepEqual(updates.ObjectMeta, (metav1.ObjectMeta{})) {
+		wldMeta := w.GetObjectMeta()
+		updatesMeta := updates.GetObjectMeta()
+
+		// assign the system populated fields to the new workload
+		wldMeta.SetResourceVersion(updatesMeta.GetResourceVersion())
+		wldMeta.SetUID(updatesMeta.GetUID())
+		wldMeta.SetGeneration(updatesMeta.GetGeneration())
+		wldMeta.SetCreationTimestamp(updatesMeta.GetCreationTimestamp())
+		wldMeta.SetDeletionTimestamp(updatesMeta.GetDeletionTimestamp())
+	}
+}
+
 func (w *Workload) Merge(updates *Workload) {
 	for k, v := range updates.Annotations {
 		w.MergeAnnotations(k, v)

pkg/apis/cartographer/v1alpha1/workload_test.go

@@ -21,12 +21,14 @@ import (
 	"fmt"
 	"os"
 	"testing"
+	"time"
 
 	"github.com/google/go-cmp/cmp"
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
 
 	"github.com/vmware-tanzu/apps-cli-plugin/pkg/apis"
 	cli "github.com/vmware-tanzu/apps-cli-plugin/pkg/cli-runtime"
@@ -190,6 +192,255 @@ func TestWorkload_MergeServiceAccountName(t *testing.T) {
 	}
 }
 
+func TestWorkload_ReplaceMetadata(t *testing.T) {
+	tests := []struct {
+		name   string
+		seed   *Workload
+		update *Workload
+		want   *Workload
+	}{{
+		name:   "empty",
+		seed:   &Workload{},
+		update: &Workload{},
+		want:   &Workload{},
+	}, {
+		name: "add all metadata to new workload",
+		seed: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+		update: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				UID:               types.UID("uid-xyz"),
+				ResourceVersion:   "999",
+				Generation:        1,
+				CreationTimestamp: metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp: &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+			},
+		},
+		want: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				UID:                        types.UID("uid-xyz"),
+				ResourceVersion:            "999",
+				Generation:                 1,
+				CreationTimestamp:          metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp:          &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+	}, {
+		name: "overwrite workload metadata",
+		seed: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				UID:                        types.UID("uid-xyz"),
+				ResourceVersion:            "111",
+				Generation:                 1,
+				CreationTimestamp:          metav1.Date(2018, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp:          &metav1.Time{Time: time.Date(2020, 6, 29, 01, 44, 05, 0, time.UTC)},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+		update: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				UID:               types.UID("uid-xyz"),
+				ResourceVersion:   "999",
+				Generation:        1,
+				CreationTimestamp: metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp: &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+			},
+		},
+		want: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				UID:                        types.UID("uid-xyz"),
+				ResourceVersion:            "999",
+				Generation:                 1,
+				CreationTimestamp:          metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp:          &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+	}, {
+		name: "do not update to empty metadata",
+		seed: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				UID:                        types.UID("uid-xyz"),
+				ResourceVersion:            "999",
+				Generation:                 1,
+				CreationTimestamp:          metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp:          &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+		update: &Workload{
+			ObjectMeta: metav1.ObjectMeta{},
+		},
+		want: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-workload",
+				Namespace: "default",
+				Annotations: map[string]string{
+					"name": "value",
+				},
+				Labels: map[string]string{
+					"name": "value",
+				},
+				UID:                        types.UID("uid-xyz"),
+				ResourceVersion:            "999",
+				Generation:                 1,
+				CreationTimestamp:          metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp:          &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+				Finalizers:                 []string{"my.finalizer"},
+				DeletionGracePeriodSeconds: &[]int64{5}[0],
+				ManagedFields: []metav1.ManagedFieldsEntry{
+					{Manager: "tanzu"},
+				},
+				SelfLink: "/default/my-workload",
+				OwnerReferences: []metav1.OwnerReference{
+					{
+						APIVersion: "v1",
+						Kind:       "Pod",
+						Name:       "workload-owner",
+					},
+				},
+			},
+		},
+	}, {
+		name: "return only updated system populated fields",
+		seed: &Workload{
+			ObjectMeta: metav1.ObjectMeta{},
+		},
+		update: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				UID:               types.UID("uid-xyz"),
+				ResourceVersion:   "999",
+				Generation:        1,
+				CreationTimestamp: metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp: &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+			},
+		},
+		want: &Workload{
+			ObjectMeta: metav1.ObjectMeta{
+				UID:               types.UID("uid-xyz"),
+				ResourceVersion:   "999",
+				Generation:        1,
+				CreationTimestamp: metav1.Date(2019, time.September, 10, 15, 00, 00, 00, time.UTC),
+				DeletionTimestamp: &metav1.Time{Time: time.Date(2021, 6, 29, 01, 44, 05, 0, time.UTC)},
+			},
+		},
+	}}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			got := test.seed.DeepCopy()
+			got.ReplaceMetadata(test.update)
+			if diff := cmp.Diff(test.want, got); diff != "" {
+				t.Errorf("Merge() (-want, +got) = %v", diff)
+			}
+		})
+	}
+}
+
 func TestWorkload_Validate(t *testing.T) {
 	tests := []struct {
 		name     string

pkg/cli-runtime/testing/command_table.go

@@ -163,11 +163,11 @@ type CommandTestCase struct {
 	// lifecycle
 
 	// Prepare is called before the command is executed. It is intended to prepare that broader
-	// environment before the specific table record is executed. For example, chaning the working
+	// environment before the specific table record is executed. For example, changing the working
 	// directory or setting mock expectations.
 	Prepare func(t *testing.T, ctx context.Context, config *cli.Config, tc *CommandTestCase) (context.Context, error)
 	// CleanUp is called after the table record is finished and all defined assertions complete.
-	// It is indended to clean up any state created in the Prepare step or during the test
+	// It is intended to clean up any state created in the Prepare step or during the test
 	// execution, or to make assertions for mocks.
 	CleanUp func(t *testing.T, ctx context.Context, config *cli.Config, tc *CommandTestCase) error
 	// WithConsoleInteractions receives function with an expect.Console that can be used to send characters and verify the output send to a fake console.