Refactored resource to store all previous names and namespaces

api/resource/factory.go

@@ -11,6 +11,7 @@ import (
 
 	"sigs.k8s.io/kustomize/api/ifc"
 	"sigs.k8s.io/kustomize/api/internal/kusterr"
+	"sigs.k8s.io/kustomize/api/resid"
 	"sigs.k8s.io/kustomize/api/types"
 )
 
@@ -35,17 +36,12 @@ func (rf *Factory) FromMap(m map[string]interface{}) *Resource {
 
 // FromMapWithName returns a new instance with the given "original" name.
 func (rf *Factory) FromMapWithName(n string, m map[string]interface{}) *Resource {
-	return rf.makeOne(rf.kf.FromMap(m), nil).SetOriginalName(n, true)
-}
-
-// FromMapWithNamespace returns a new instance with the given "original" namespace.
-func (rf *Factory) FromMapWithNamespace(n string, m map[string]interface{}) *Resource {
-	return rf.makeOne(rf.kf.FromMap(m), nil).SetOriginalNs(n, true)
+	return rf.FromMapWithNamespaceAndName(resid.DefaultNamespace, n, m)
 }
 
 // FromMapWithNamespaceAndName returns a new instance with the given "original" namespace.
 func (rf *Factory) FromMapWithNamespaceAndName(ns string, n string, m map[string]interface{}) *Resource {
-	return rf.makeOne(rf.kf.FromMap(m), nil).SetOriginalNs(ns, true).SetOriginalName(n, true)
+	return rf.makeOne(rf.kf.FromMap(m), nil).setPreviousNamespaceAndName(ns, n)
 }
 
 // FromMapAndOption returns a new instance of Resource with given options.
@@ -157,7 +153,7 @@ func (rf *Factory) SliceFromBytesWithNames(names []string, in []byte) ([]*Resour
 		return nil, fmt.Errorf("number of names doesn't match number of resources")
 	}
 	for i, res := range result {
-		res.SetOriginalName(names[i], true)
+		res.setPreviousNamespaceAndName("", names[i])
 	}
 	return result, nil
 }

api/resource/resource.go

@@ -32,18 +32,29 @@ type Resource struct {
 }
 
 const (
-	buildAnnotationOriginalName      = konfig.ConfigAnnoDomain + "/originalName"
+	buildAnnotationPreviousName      = konfig.ConfigAnnoDomain + "/originalName"
 	buildAnnotationPrefixes          = konfig.ConfigAnnoDomain + "/prefixes"
 	buildAnnotationSuffixes          = konfig.ConfigAnnoDomain + "/suffixes"
-	buildAnnotationOriginalNamespace = konfig.ConfigAnnoDomain + "/originalNs"
+	buildAnnotationPreviousNamespace = konfig.ConfigAnnoDomain + "/originalNs"
 )
 
+var buildAnnotations = []string{
+	buildAnnotationPreviousName,
+	buildAnnotationPrefixes,
+	buildAnnotationSuffixes,
+	buildAnnotationPreviousNamespace,
+}
+
 func (r *Resource) ResetPrimaryData(incoming *Resource) {
 	r.kunStr = incoming.Copy()
 }
 
 func (r *Resource) GetAnnotations() map[string]string {
-	return r.kunStr.GetAnnotations()
+	annotations := r.kunStr.GetAnnotations()
+	if annotations == nil {
+		return make(map[string]string)
+	}
+	return annotations
 }
 
 func (r *Resource) Copy() ifc.Kunstructured {
@@ -146,8 +157,6 @@ func (r *Resource) UnmarshalJSON(s []byte) error {
 type ResCtx interface {
 	AddNamePrefix(p string)
 	AddNameSuffix(s string)
-	GetOutermostNamePrefix() string
-	GetOutermostNameSuffix() string
 	GetNamePrefixes() []string
 	GetNameSuffixes() []string
 }
@@ -252,22 +261,19 @@ func copyStringSlice(s []string) []string {
 
 // Implements ResCtx AddNamePrefix
 func (r *Resource) AddNamePrefix(p string) {
-	r.addAdditiveAnnotation(buildAnnotationPrefixes, p)
+	r.appendCsvAnnotation(buildAnnotationPrefixes, p)
 }
 
 // Implements ResCtx AddNameSuffix
 func (r *Resource) AddNameSuffix(s string) {
-	r.addAdditiveAnnotation(buildAnnotationSuffixes, s)
+	r.appendCsvAnnotation(buildAnnotationSuffixes, s)
 }
 
-func (r *Resource) addAdditiveAnnotation(name, value string) {
+func (r *Resource) appendCsvAnnotation(name, value string) {
 	if value == "" {
 		return
 	}
 	annotations := r.GetAnnotations()
-	if annotations == nil {
-		annotations = make(map[string]string)
-	}
 	if existing, ok := annotations[name]; ok {
 		annotations[name] = existing + "," + value
 	} else {
@@ -312,26 +318,20 @@ func SameEndingSubarray(shortest, longest []string) bool {
 
 // Implements ResCtx GetNamePrefixes
 func (r *Resource) GetNamePrefixes() []string {
-	annotations := r.GetAnnotations()
-	if _, ok := annotations[buildAnnotationPrefixes]; !ok {
-		return nil
-	}
-	return strings.Split(annotations[buildAnnotationPrefixes], ",")
+	return r.getCsvAnnotation(buildAnnotationPrefixes)
 }
 
 // Implements ResCtx GetNameSuffixes
 func (r *Resource) GetNameSuffixes() []string {
-	annotations := r.GetAnnotations()
-	if _, ok := annotations[buildAnnotationSuffixes]; !ok {
-		return nil
-	}
-	return strings.Split(annotations[buildAnnotationSuffixes], ",")
+	return r.getCsvAnnotation(buildAnnotationSuffixes)
 }
 
-// OutermostPrefixSuffixEquals returns true if both resources
-// outer suffix and prefix matches.
-func (r *Resource) OutermostPrefixSuffixEquals(o ResCtx) bool {
-	return (r.GetOutermostNamePrefix() == o.GetOutermostNamePrefix()) && (r.GetOutermostNameSuffix() == o.GetOutermostNameSuffix())
+func (r *Resource) getCsvAnnotation(name string) []string {
+	annotations := r.GetAnnotations()
+	if _, ok := annotations[name]; !ok {
+		return nil
+	}
+	return strings.Split(annotations[name], ",")
 }
 
 // PrefixesSuffixesEquals is conceptually doing the same task
@@ -349,57 +349,20 @@ func (r *Resource) RemoveBuildAnnotations() {
 	if len(annotations) == 0 {
 		return
 	}
-	delete(annotations, buildAnnotationOriginalName)
-	delete(annotations, buildAnnotationPrefixes)
-	delete(annotations, buildAnnotationSuffixes)
-	delete(annotations, buildAnnotationOriginalNamespace)
-	r.SetAnnotations(annotations)
-}
-
-func (r *Resource) GetOriginalName() string {
-	annotations := r.GetAnnotations()
-	if name, ok := annotations[buildAnnotationOriginalName]; ok {
-		return name
-	}
-	return r.kunStr.GetName()
-}
-
-func (r *Resource) SetOriginalName(n string, overwrite bool) *Resource {
-	annotations := r.GetAnnotations()
-	if annotations == nil {
-		annotations = make(map[string]string)
-	}
-	if _, ok := annotations[buildAnnotationOriginalName]; !ok || overwrite {
-		annotations[buildAnnotationOriginalName] = n
-	}
-	r.kunStr.SetAnnotations(annotations)
-	return r
-}
-
-func (r *Resource) GetOriginalNs() string {
-	annotations := r.GetAnnotations()
-	if ns, ok := annotations[buildAnnotationOriginalNamespace]; ok {
-		return ns
-	}
-	ns := r.GetNamespace()
-	if ns == "default" {
-		return ""
-	}
-	return ns
-}
-
-func (r *Resource) SetOriginalNs(n string, overwrite bool) *Resource {
-	if n == "" {
-		n = "default"
-	}
-	annotations := r.GetAnnotations()
-	if annotations == nil {
-		annotations = make(map[string]string)
-	}
-	if _, ok := annotations[buildAnnotationOriginalNamespace]; !ok || overwrite {
-		annotations[buildAnnotationOriginalNamespace] = n
+	for _, a := range buildAnnotations {
+		delete(annotations, a)
 	}
 	r.SetAnnotations(annotations)
+}
+
+func (r *Resource) setPreviousNamespaceAndName(ns string, n string) *Resource {
+	// name
+	r.appendCsvAnnotation(buildAnnotationPreviousName, n)
+	// namespace
+	if ns == "" {
+		ns = resid.DefaultNamespace
+	}
+	r.appendCsvAnnotation(buildAnnotationPreviousNamespace, ns)
 	return r
 }
 
@@ -456,10 +419,36 @@ func (r *Resource) GetNamespace() string {
 
 // OrgId returns the original, immutable ResId for the resource.
 // This doesn't have to be unique in a ResMap.
-// TODO: compute this once and save it in the resource.
 func (r *Resource) OrgId() resid.ResId {
-	return resid.NewResIdWithNamespace(
-		r.GetGvk(), r.GetOriginalName(), r.GetOriginalNs())
+	ids := r.PrevIds()
+	if len(ids) > 0 {
+		return ids[0]
+	}
+	return r.CurId()
+}
+
+// PrevIds returns a list of ResIds that includes every
+// previous ResId the resource has had through all of its
+// GVKN transformations, in the order that it had that ID.
+// The returned array does not include the resource's current
+// ID.
+// If there are no previous IDs, this will return nil.
+func (r *Resource) PrevIds() []resid.ResId {
+	var ids []resid.ResId
+
+	// names and ns should always be the same length
+	names := r.getCsvAnnotation(buildAnnotationPreviousName)
+	ns := r.getCsvAnnotation(buildAnnotationPreviousNamespace)
+	for i := range names {
+		ids = append(ids, resid.NewResIdWithNamespace(
+			r.GetGvk(), names[i], ns[i]))
+	}
+	return ids
+}
+
+// StorePreviousId stores the resource's current ID via build annotations.
+func (r *Resource) StorePreviousId() {
+	r.setPreviousNamespaceAndName(r.GetNamespace(), r.GetName())
 }
 
 // CurId returns a ResId for the resource using the

api/resource/resource_test.go

@@ -695,322 +695,165 @@ spec:
 	}
 }
 
-func TestSetOriginalNameAndNs(t *testing.T) {
-	input := `apiVersion: apps/v1
+func TestResource_StorePreviousId(t *testing.T) {
+	tests := map[string]struct {
+		input    string
+		newName  string
+		newNs    string
+		expected string
+	}{
+		"default namespace, first previous name": {
+			input: `apiVersion: apps/v1
 kind: Secret
 metadata:
- name: newName`
-
-	factory := provider.NewDefaultDepProvider().GetResourceFactory()
-	resources, err := factory.SliceFromBytes([]byte(input))
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	res := resources[0]
-	res.SetOriginalName("oldName", false)
-	res.SetOriginalNs("default", false)
-
-	expected := `apiVersion: apps/v1
+  name: oldName
+`,
+			newName: "newName",
+			newNs:   "",
+			expected: `apiVersion: apps/v1
 kind: Secret
 metadata:
   annotations:
     config.kubernetes.io/originalName: oldName
     config.kubernetes.io/originalNs: default
   name: newName
-`
-	bytes, err := res.AsYAML()
-	if err != nil {
-		t.Fatal(err)
+`,
+		},
+
+		"default namespace, second previous name": {
+			input: `apiVersion: apps/v1
+kind: Secret
+metadata:
+  annotations:
+    config.kubernetes.io/originalName: oldName
+    config.kubernetes.io/originalNs: default
+  name: oldName2
+`,
+			newName: "newName",
+			newNs:   "",
+			expected: `apiVersion: apps/v1
+kind: Secret
+metadata:
+  annotations:
+    config.kubernetes.io/originalName: oldName,oldName2
+    config.kubernetes.io/originalNs: default,default
+  name: newName
+`,
+		},
+
+		"non-default namespace": {
+			input: `apiVersion: apps/v1
+kind: Secret
+metadata:
+  annotations:
+    config.kubernetes.io/originalName: oldName
+    config.kubernetes.io/originalNs: default
+  name: oldName2
+  namespace: oldNamespace
+`,
+			newName: "newName",
+			newNs:   "newNamespace",
+			expected: `apiVersion: apps/v1
+kind: Secret
+metadata:
+  annotations:
+    config.kubernetes.io/originalName: oldName,oldName2
+    config.kubernetes.io/originalNs: default,oldNamespace
+  name: newName
+  namespace: newNamespace
+`,
+		},
+	}
+	factory := provider.NewDefaultDepProvider().GetResourceFactory()
+	for i := range tests {
+		test := tests[i]
+		t.Run(i, func(t *testing.T) {
+			resources, err := factory.SliceFromBytes([]byte(test.input))
+			if !assert.NoError(t, err) || len(resources) == 0 {
+				t.FailNow()
+			}
+			r := resources[0]
+			r.StorePreviousId()
+			r.SetName(test.newName)
+			if test.newNs != "" {
+				r.SetNamespace(test.newNs)
+			}
+			bytes, err := r.AsYAML()
+			if !assert.NoError(t, err) {
+				t.FailNow()
+			}
+			assert.Equal(t, test.expected, string(bytes))
+		})
 	}
-	assert.Equal(t, expected, string(bytes))
 }
 
-func TestGetOriginalName(t *testing.T) {
-	tests := []struct {
+func TestResource_PrevIds(t *testing.T) {
+	tests := map[string]struct {
 		input    string
-		expected string
+		expected []resid.ResId
 	}{
-		{
-			// no name annotation, return the name
+		"no previous IDs": {
 			input: `apiVersion: apps/v1
 kind: Secret
 metadata:
-  name: mySecret`,
-			expected: "mySecret",
+  name: name
+`,
+			expected: nil,
 		},
 
-		{
-			// return name from name annotation
+		"one previous ID": {
 			input: `apiVersion: apps/v1
 kind: Secret
 metadata:
   annotations:
     config.kubernetes.io/originalName: oldName
-  name: newName`,
-			expected: "oldName",
-		},
-	}
-
-	for _, test := range tests {
-		factory := provider.NewDefaultDepProvider().GetResourceFactory()
-		resources, err := factory.SliceFromBytes([]byte(test.input))
-		if err != nil {
-			t.Fatal(err)
-		}
-		assert.Equal(t, test.expected, resources[0].GetOriginalName())
-	}
-}
-
-func TestSetOriginalName(t *testing.T) {
-	tests := []struct {
-		input        string
-		originalName string
-		overwrite    bool
-		expected     string
-	}{
-		{
-			// no original name set, overwrite is false
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: newName`,
-			originalName: "oldName",
-			overwrite:    false,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalName: oldName
+    config.kubernetes.io/originalNs: default
   name: newName
 `,
+			expected: []resid.ResId{
+				{
+					Gvk:       resid.Gvk{Group: "apps", Version: "v1", Kind: "Secret"},
+					Name:      "oldName",
+					Namespace: resid.DefaultNamespace,
+				},
+			},
 		},
 
-		{
-			// no original name set, overwrite is true
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: newName`,
-			originalName: "oldName",
-			overwrite:    true,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalName: oldName
-  name: newName
-`,
-		},
-
-		{
-			// original name is set, overwrite is false, resource shouldn't change
+		"two ids": {
 			input: `apiVersion: apps/v1
 kind: Secret
 metadata:
   annotations:
-    config.kubernetes.io/originalName: oldName
-  name: newName`,
-			originalName: "newOriginalName",
-			overwrite:    false,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalName: oldName
-  name: newName
-`,
-		},
-
-		{
-			// original name is set, overwrite is true, resource should change
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalName: oldName
-  name: newName`,
-			originalName: "newOriginalName",
-			overwrite:    true,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalName: newOriginalName
-  name: newName
-`,
-		},
-	}
-
-	for _, test := range tests {
-		factory := provider.NewDefaultDepProvider().GetResourceFactory()
-		resources, err := factory.SliceFromBytes([]byte(test.input))
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		res := resources[0]
-		res.SetOriginalName(test.originalName, test.overwrite)
-
-		bytes, err := res.AsYAML()
-		if err != nil {
-			t.Fatal(err)
-		}
-		assert.Equal(t, test.expected, string(bytes))
-	}
-}
-
-func TestGetOriginalNs(t *testing.T) {
-	tests := []struct {
-		input    string
-		expected string
-	}{
-		{
-			// no namespace, return default
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: mySecret`,
-			expected: "",
-		},
-
-		{
-			// return old namespace
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: mySecret
-  namespace: myNamespace`,
-			expected: "oldNamespace",
-		},
-
-		{
-			// return namespace
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: mySecret
-  namespace: myNamespace`,
-			expected: "myNamespace",
-		},
-	}
-
-	for _, test := range tests {
-		factory := provider.NewDefaultDepProvider().GetResourceFactory()
-		resources, err := factory.SliceFromBytes([]byte(test.input))
-		if err != nil {
-			t.Fatal(err)
-		}
-		assert.Equal(t, test.expected, resources[0].GetOriginalNs())
-	}
-}
-
-func TestSetOriginalNs(t *testing.T) {
-	tests := []struct {
-		input      string
-		originalNs string
-		overwrite  bool
-		expected   string
-	}{
-		{
-			// no original namespace set, overwrite is false
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: newName
-  namespace: newNamespace`,
-			originalNs: "oldNamespace",
-			overwrite:  false,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: newName
-  namespace: newNamespace
-`,
-		},
-
-		{
-			// no original name set, overwrite is true
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  name: newName
-  namespace: newNamespace`,
-
-			originalNs: "oldNamespace",
-			overwrite:  true,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: newName
-  namespace: newNamespace
-`,
-		},
-
-		{
-			// original name is set, overwrite is false, resource shouldn't change
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: newName
-  namespace: newNamespace`,
-			originalNs: "newOriginalNamespace",
-			overwrite:  false,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: newName
-  namespace: newNamespace
-`,
-		},
-
-		{
-			// original name is set, overwrite is true, resource should change
-			input: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: oldNamespace
-  name: newName
-  namespace: newNamespace`,
-			originalNs: "newOriginalNamespace",
-			overwrite:  true,
-			expected: `apiVersion: apps/v1
-kind: Secret
-metadata:
-  annotations:
-    config.kubernetes.io/originalNs: newOriginalNamespace
+    config.kubernetes.io/originalName: oldName,oldName2
+    config.kubernetes.io/originalNs: default,oldNamespace
   name: newName
   namespace: newNamespace
 `,
+			expected: []resid.ResId{
+				{
+					Gvk:       resid.Gvk{Group: "apps", Version: "v1", Kind: "Secret"},
+					Name:      "oldName",
+					Namespace: resid.DefaultNamespace,
+				},
+				{
+					Gvk:       resid.Gvk{Group: "apps", Version: "v1", Kind: "Secret"},
+					Name:      "oldName2",
+					Namespace: "oldNamespace",
+				},
+			},
 		},
 	}
-
-	for _, test := range tests {
-		factory := provider.NewDefaultDepProvider().GetResourceFactory()
-		resources, err := factory.SliceFromBytes([]byte(test.input))
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		res := resources[0]
-		res.SetOriginalNs(test.originalNs, test.overwrite)
-
-		bytes, err := res.AsYAML()
-		if err != nil {
-			t.Fatal(err)
-		}
-		assert.Equal(t, test.expected, string(bytes))
+	factory := provider.NewDefaultDepProvider().GetResourceFactory()
+	for i := range tests {
+		test := tests[i]
+		t.Run(i, func(t *testing.T) {
+			resources, err := factory.SliceFromBytes([]byte(test.input))
+			if !assert.NoError(t, err) || len(resources) == 0 {
+				t.FailNow()
+			}
+			r := resources[0]
+			assert.Equal(t, test.expected, r.PrevIds())
+		})
 	}
 }