Manage name changes (prefix/suffix) via YAML annotations rather than …

…via in-memory-only fields.
kubernetes-sigs · Jan 11, 2021 · bd4580d · bd4580d
1 parent ea5d08b
commit bd4580d
Show file tree

Hide file tree

Showing 34 changed files with 538 additions and 60 deletions.
diff --git a/api/builtins/HashTransformer.go b/api/builtins/HashTransformer.go
diff --git a/api/builtins/NamespaceTransformer.go b/api/builtins/NamespaceTransformer.go
diff --git a/api/builtins/PatchTransformer.go b/api/builtins/PatchTransformer.go
diff --git a/api/builtins/PrefixSuffixTransformer.go b/api/builtins/PrefixSuffixTransformer.go
diff --git a/api/internal/accumulator/namereferencetransformer_test.go b/api/internal/accumulator/namereferencetransformer_test.go
@@ -721,6 +721,7 @@ func TestNameReferenceNamespace(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
+	m.RemoveIdAnnotations()
 	if err = expected.ErrorIfNotEqualLists(m); err != nil {
 		t.Fatalf("actual doesn't match expected: %v", err)
 	}
@@ -882,6 +883,7 @@ func TestNameReferenceClusterWide(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
+	m.RemoveIdAnnotations()
 	if err = expected.ErrorIfNotEqualLists(m); err != nil {
 		t.Fatalf("actual doesn't match expected: %v", err)
 	}
@@ -1008,6 +1010,7 @@ func TestNameReferenceNamespaceTransformation(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
+	m.RemoveIdAnnotations()
 	if err = expected.ErrorIfNotEqualLists(m); err != nil {
 		t.Fatalf("actual doesn't match expected: %v", err)
 	}
@@ -1044,6 +1047,7 @@ func TestNameReferenceCandidateSelection(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
+	m.RemoveIdAnnotations()
 	if err = expected.ErrorIfNotEqualLists(m); err != nil {
 		t.Fatalf("actual doesn't match expected: %v", err)
 	}

diff --git a/api/internal/accumulator/resaccumulator_test.go b/api/internal/accumulator/resaccumulator_test.go
@@ -355,7 +355,8 @@ func TestResolveVarsWithNoambiguation(t *testing.T) {
 	// went through a prefix transformer.
 	r := m.GetByIndex(1)
 	r.AddNamePrefix("sub-")
-	r.SetName("sub-backendOne") // original name remains "backendOne"
+	r.SetName("sub-backendOne")
+	r.SetOriginalName("backendOne", true)
 
 	err = ra2.AppendAll(m)
 	if err != nil {

diff --git a/api/internal/plugins/execplugin/execplugin_test.go b/api/internal/plugins/execplugin/execplugin_test.go
@@ -45,6 +45,7 @@ s/$BAR/bar baz/g
 			"argsFromFile": "sed-input.txt",
 		})
 
+	pluginConfig.RemoveIdAnnotations()
 	p := NewExecPlugin(
 		pLdr.AbsolutePluginPath(
 			konfig.DisabledPluginConfig(),

diff --git a/api/internal/target/kusttarget_test.go b/api/internal/target/kusttarget_test.go
@@ -244,13 +244,15 @@ metadata:
 			t.Fatalf("unexpected error %v", err)
 		}
 	}
+	assert.NoError(t, expected.RemoveIdAnnotations())
 	expYaml, err := expected.AsYaml()
 	assert.NoError(t, err)
 
 	kt := makeKustTargetWithRf(t, th.GetFSys(), "/whatever", pvd)
 	assert.NoError(t, kt.Load())
 	actual, err := kt.MakeCustomizedResMap()
 	assert.NoError(t, err)
+	assert.NoError(t, actual.RemoveIdAnnotations())
 	actYaml, err := actual.AsYaml()
 	assert.NoError(t, err)
 	assert.Equal(t, expYaml, actYaml)

diff --git a/api/krusty/kustomizer.go b/api/krusty/kustomizer.go
@@ -93,5 +93,9 @@ func (b *Kustomizer) Run(path string) (resmap.ResMap, error) {
 		}
 		t.Transform(m)
 	}
+	err = m.RemoveIdAnnotations()
+	if err != nil {
+		return nil, err
+	}
 	return m, nil
 }
diff --git a/api/krusty/transformerplugin_test.go b/api/krusty/transformerplugin_test.go
@@ -80,7 +80,7 @@ data:
 `)
 
 	m := th.Run("/app", th.MakeOptionsPluginsEnabled())
-	th.AssertActualEqualsExpected(m, `
+	th.AssertActualEqualsExpectedNoIdAnnotations(m, `
 apiVersion: v1
 data:
   foo: foo

diff --git a/api/resmap/factory_test.go b/api/resmap/factory_test.go
@@ -389,7 +389,6 @@ spec:
 
 	rm, err := rmF.ConflatePatches([]*resource.Resource{r1, r2})
 	assert.NoError(t, err)
-
 	yml, err = rm.AsYaml()
 	assert.NoError(t, err)
 

diff --git a/api/resmap/resmap.go b/api/resmap/resmap.go
@@ -245,4 +245,6 @@ type ResMap interface {
 	// selected set of resources.
 	ApplySmPatch(
 		selectedSet *resource.IdSet, patch *resource.Resource) error
+
+	RemoveIdAnnotations() error
 }
diff --git a/api/resmap/reswrangler.go b/api/resmap/reswrangler.go
@@ -589,6 +589,7 @@ func (m *resWrangler) ApplySmPatch(
 		patchCopy.SetName(res.GetName())
 		patchCopy.SetNamespace(res.GetNamespace())
 		patchCopy.SetGvk(res.GetGvk())
+		patchCopy.SetOriginalName(res.GetOriginalName(), true)
 		err := res.ApplySmPatch(patchCopy)
 		if err != nil {
 			// Check for an error string from UnmarshalJSON that's indicative
@@ -619,3 +620,13 @@ func (m *resWrangler) ApplySmPatch(
 	m.AppendAll(newRm)
 	return nil
 }
+
+func (m *resWrangler) RemoveIdAnnotations() error {
+	for _, r := range m.Resources() {
+		err := r.RemoveIdAnnotations()
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
diff --git a/api/resmap/reswrangler_test.go b/api/resmap/reswrangler_test.go
@@ -745,7 +745,6 @@ rules:
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
-
 	rnodes, err := rm.ToRNodeSlice()
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
@@ -999,6 +998,7 @@ spec:
 				return
 			}
 			assert.False(t, tc.errorExpected)
+			assert.NoError(t, m.RemoveIdAnnotations())
 			yml, err := m.AsYaml()
 			assert.NoError(t, err)
 			assert.Equal(t, strings.Join(tc.expected, "---\n"), string(yml))
@@ -1111,6 +1111,7 @@ $patch: delete
 			assert.NoError(t, err, name)
 			assert.NoError(t, m.ApplySmPatch(idSet, p), name)
 			assert.Equal(t, tc.finalMapSize, m.Size(), name)
+			assert.NoError(t, m.RemoveIdAnnotations())
 			yml, err := m.AsYaml()
 			assert.NoError(t, err, name)
 			assert.Equal(t, tc.expected, string(yml), name)

diff --git a/api/resource/factory.go b/api/resource/factory.go
@@ -35,17 +35,17 @@ 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)
+	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)
+	return rf.makeOne(rf.kf.FromMap(m), nil).SetOriginalNs(n, true)
 }
 
 // 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).setOriginalName(n)
+	return rf.makeOne(rf.kf.FromMap(m), nil).SetOriginalNs(ns, true).SetOriginalName(n, true)
 }
 
 // FromMapAndOption returns a new instance of Resource with given options.
@@ -72,7 +72,7 @@ func (rf *Factory) makeOne(
 		kunStr:  u,
 		options: o,
 	}
-	return r.setOriginalName(r.kunStr.GetName()).setOriginalNs(r.GetNamespace())
+	return r
 }
 
 // SliceFromPatches returns a slice of resources given a patch path
@@ -157,7 +157,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.originalName = names[i]
+		res.SetOriginalName(names[i], true)
 	}
 	return result, nil
 }