fix bug with migrating annotations

kubernetes-sigs · Oct 12, 2021 · 97115d9 · 97115d9
1 parent 67c58ad
commit 97115d9
Show file tree

Hide file tree

Showing 3 changed files with 92 additions and 6 deletions.
diff --git a/kyaml/kio/byteio_reader.go b/kyaml/kio/byteio_reader.go
@@ -316,8 +316,14 @@ func (r *ByteReader) decode(originalYAML string, index int, decoder *yaml.Decode
 		r.SetAnnotations = map[string]string{}
 	}
 	if !r.OmitReaderAnnotations {
-		r.SetAnnotations[kioutil.IndexAnnotation] = fmt.Sprintf("%d", index)
-		r.SetAnnotations[kioutil.LegacyIndexAnnotation] = fmt.Sprintf("%d", index)
+		err := kioutil.CopyLegacyAnnotations(n)
+		if err != nil {
+			return nil, err
+		}
+		if val, ok := n.GetAnnotations()[kioutil.IndexAnnotation]; !ok || val == "" {
+			r.SetAnnotations[kioutil.IndexAnnotation] = fmt.Sprintf("%d", index)
+			r.SetAnnotations[kioutil.LegacyIndexAnnotation] = fmt.Sprintf("%d", index)
+		}
 
 		if r.PreserveSeqIndent {
 			// derive and add the seqindent annotation

diff --git a/kyaml/kio/kioutil/kioutil.go b/kyaml/kio/kioutil/kioutil.go
@@ -55,7 +55,8 @@ func GetFileAnnotations(rn *yaml.RNode) (string, string, error) {
 func CopyLegacyAnnotations(rn *yaml.RNode) error {
 	meta, err := rn.GetMeta()
 	if err != nil {
-		return err
+		// resource has no metadata, this should be a no-op
+		return nil
 	}
 	if err := copyAnnotations(meta, rn, LegacyPathAnnotation, PathAnnotation); err != nil {
 		return err
@@ -71,12 +72,14 @@ func CopyLegacyAnnotations(rn *yaml.RNode) error {
 
 func copyAnnotations(meta yaml.ResourceMeta, rn *yaml.RNode, legacyKey string, newKey string) error {
 	newValue := meta.Annotations[newKey]
+	legacyValue := meta.Annotations[legacyKey]
 	if newValue != "" {
-		if err := rn.PipeE(yaml.SetAnnotation(legacyKey, newValue)); err != nil {
-			return err
+		if legacyValue == "" {
+			if err := rn.PipeE(yaml.SetAnnotation(legacyKey, newValue)); err != nil {
+				return err
+			}
 		}
 	} else {
-		legacyValue := meta.Annotations[legacyKey]
 		if legacyValue != "" {
 			if err := rn.PipeE(yaml.SetAnnotation(newKey, legacyValue)); err != nil {
 				return err

diff --git a/kyaml/kio/kioutil/kioutil_test.go b/kyaml/kio/kioutil/kioutil_test.go
@@ -374,3 +374,80 @@ func TestCreatePathAnnotationValue(t *testing.T) {
 		}
 	}
 }
+
+func TestCopyLegacyAnnotations(t *testing.T) {
+	var tests = []struct {
+		input    string
+		expected string
+	}{
+		{
+			input: `apiVersion: v1
+kind: Foo
+metadata:
+  name: foobar
+  annotations:
+    config.kubernetes.io/path: 'a/b.yaml'
+    config.kubernetes.io/index: '5'
+`,
+			expected: `apiVersion: v1
+kind: Foo
+metadata:
+  name: foobar
+  annotations:
+    config.kubernetes.io/path: 'a/b.yaml'
+    config.kubernetes.io/index: '5'
+    internal.config.kubernetes.io/path: 'a/b.yaml'
+    internal.config.kubernetes.io/index: '5'
+`,
+		},
+		{
+			input: `apiVersion: v1
+kind: Foo
+metadata:
+  name: foobar
+  annotations:
+    internal.config.kubernetes.io/path: 'a/b.yaml'
+    internal.config.kubernetes.io/index: '5'
+`,
+			expected: `apiVersion: v1
+kind: Foo
+metadata:
+  name: foobar
+  annotations:
+    internal.config.kubernetes.io/path: 'a/b.yaml'
+    internal.config.kubernetes.io/index: '5'
+    config.kubernetes.io/path: 'a/b.yaml'
+    config.kubernetes.io/index: '5'
+`,
+		},
+		{
+			input: `apiVersion: v1
+kind: Foo
+metadata:
+ name: foobar
+ annotations:
+   internal.config.kubernetes.io/path: 'a/b.yaml'
+   config.kubernetes.io/path: 'c/d.yaml'
+`,
+			expected: `apiVersion: v1
+kind: Foo
+metadata:
+  name: foobar
+  annotations:
+    internal.config.kubernetes.io/path: 'a/b.yaml'
+    config.kubernetes.io/path: 'c/d.yaml'
+`,
+		},
+	}
+
+	for _, tc := range tests {
+		rw := kio.ByteReadWriter{
+			Reader:                bytes.NewBufferString(tc.input),
+			OmitReaderAnnotations: true,
+		}
+		nodes, err := rw.Read()
+		assert.NoError(t, err)
+		assert.NoError(t, kioutil.CopyLegacyAnnotations(nodes[0]))
+		assert.Equal(t, tc.expected, nodes[0].MustString())
+	}
+}