Merge pull request #3460 from monopole/fix3412

Fix 3412, retaining quotes in configmap data fields

api/filters/annotations/annotations.go

@@ -24,7 +24,7 @@ type Filter struct {
 var _ kio.Filter = Filter{}
 
 func (f Filter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error) {
-	keys := filtersutil.SortedMapKeys(f.Annotations)
+	keys := yaml.SortedMapKeys(f.Annotations)
 	_, err := kio.FilterAll(yaml.FilterFunc(
 		func(node *yaml.RNode) (*yaml.RNode, error) {
 			for _, k := range keys {

api/filters/filtersutil/filtersutil.go

@@ -1,21 +0,0 @@
-// Copyright 2019 The Kubernetes Authors.
-// SPDX-License-Identifier: Apache-2.0
-
-package filtersutil
-
-import (
-	"sort"
-)
-
-// SortedMapKeys returns a sorted slice of keys to the given map.
-// Writing this function never gets old.
-func SortedMapKeys(m map[string]string) []string {
-	keys := make([]string, len(m))
-	i := 0
-	for k := range m {
-		keys[i] = k
-		i++
-	}
-	sort.Strings(keys)
-	return keys
-}

api/filters/labels/labels.go

@@ -25,7 +25,7 @@ type Filter struct {
 var _ kio.Filter = Filter{}
 
 func (f Filter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error) {
-	keys := filtersutil.SortedMapKeys(f.Labels)
+	keys := yaml.SortedMapKeys(f.Labels)
 	_, err := kio.FilterAll(yaml.FilterFunc(
 		func(node *yaml.RNode) (*yaml.RNode, error) {
 			for _, k := range keys {

api/internal/generators/configmap.go

@@ -4,7 +4,6 @@
 package generators
 
 import (
-	"sigs.k8s.io/kustomize/api/filters/filtersutil"
 	"sigs.k8s.io/kustomize/api/ifc"
 	"sigs.k8s.io/kustomize/api/types"
 	"sigs.k8s.io/kustomize/kyaml/yaml"
@@ -38,14 +37,9 @@ func MakeConfigMap(
 	if err != nil {
 		return nil, err
 	}
-	for _, k := range filtersutil.SortedMapKeys(m) {
-		fldName, vrN := makeConfigMapValueRNode(m[k])
-		if _, err = rn.Pipe(
-			yaml.LookupCreate(yaml.MappingNode, fldName),
-			yaml.SetField(k, vrN)); err != nil {
-			return nil, err
-		}
+	if err = rn.LoadMapIntoConfigMapData(m); err != nil {
+		return nil, err
 	}
 	copyLabelsAndAnnotations(rn, args.Options)
-	return rn, err
+	return rn, nil
 }

api/internal/generators/secret.go

@@ -4,7 +4,6 @@
 package generators
 
 import (
-	"sigs.k8s.io/kustomize/api/filters/filtersutil"
 	"sigs.k8s.io/kustomize/api/ifc"
 	"sigs.k8s.io/kustomize/api/types"
 	"sigs.k8s.io/kustomize/kyaml/yaml"
@@ -51,14 +50,9 @@ func MakeSecret(
 	if err != nil {
 		return nil, err
 	}
-	for _, k := range filtersutil.SortedMapKeys(m) {
-		vrN := makeSecretValueRNode(m[k])
-		if _, err = rn.Pipe(
-			yaml.LookupCreate(yaml.MappingNode, yaml.DataField),
-			yaml.SetField(k, vrN)); err != nil {
-			return nil, err
-		}
+	if err = rn.LoadMapIntoSecretData(m); err != nil {
+		return nil, err
 	}
 	copyLabelsAndAnnotations(rn, args.Options)
-	return rn, err
+	return rn, nil
 }

api/internal/generators/utils.go

@@ -4,13 +4,9 @@
 package generators
 
 import (
-	"encoding/base64"
 	"fmt"
-	"strings"
-	"unicode/utf8"
 
 	"github.com/go-errors/errors"
-	"sigs.k8s.io/kustomize/api/filters/filtersutil"
 	"sigs.k8s.io/kustomize/api/ifc"
 	"sigs.k8s.io/kustomize/api/types"
 	"sigs.k8s.io/kustomize/kyaml/yaml"
@@ -66,13 +62,13 @@ func copyLabelsAndAnnotations(
 	if opts == nil {
 		return nil
 	}
-	for _, k := range filtersutil.SortedMapKeys(opts.Labels) {
+	for _, k := range yaml.SortedMapKeys(opts.Labels) {
 		v := opts.Labels[k]
 		if _, err := rn.Pipe(yaml.SetLabel(k, v)); err != nil {
 			return err
 		}
 	}
-	for _, k := range filtersutil.SortedMapKeys(opts.Annotations) {
+	for _, k := range yaml.SortedMapKeys(opts.Annotations) {
 		v := opts.Annotations[k]
 		if _, err := rn.Pipe(yaml.SetAnnotation(k, v)); err != nil {
 			return err
@@ -80,60 +76,3 @@ func copyLabelsAndAnnotations(
 	}
 	return nil
 }
-
-// In a secret, all data is base64 encoded, regardless of its conformance
-// or lack thereof to UTF-8.
-func makeSecretValueRNode(s string) *yaml.RNode {
-	yN := &yaml.Node{Kind: yaml.ScalarNode}
-	// Purposely don't use YAML tags to identify the data as being plain text or
-	// binary.  It kubernetes Secrets the values in the `data` map are expected
-	// to be base64 encoded, and in ConfigMaps that same can be said for the
-	// values in the `binaryData` field.
-	yN.Tag = yaml.NodeTagString
-	yN.Value = encodeBase64(s)
-	if strings.Contains(yN.Value, "\n") {
-		yN.Style = yaml.LiteralStyle
-	}
-	return yaml.NewRNode(yN)
-}
-
-func makeConfigMapValueRNode(s string) (field string, rN *yaml.RNode) {
-	yN := &yaml.Node{Kind: yaml.ScalarNode}
-	yN.Tag = yaml.NodeTagString
-	if utf8.ValidString(s) {
-		field = yaml.DataField
-		yN.Value = s
-	} else {
-		field = yaml.BinaryDataField
-		yN.Value = encodeBase64(s)
-	}
-	if strings.Contains(yN.Value, "\n") {
-		yN.Style = yaml.LiteralStyle
-	}
-	return field, yaml.NewRNode(yN)
-}
-
-// encodeBase64 encodes s as base64 that is broken up into multiple lines
-// as appropriate for the resulting length.
-func encodeBase64(s string) string {
-	const lineLen = 70
-	encLen := base64.StdEncoding.EncodedLen(len(s))
-	lines := encLen/lineLen + 1
-	buf := make([]byte, encLen*2+lines)
-	in := buf[0:encLen]
-	out := buf[encLen:]
-	base64.StdEncoding.Encode(in, []byte(s))
-	k := 0
-	for i := 0; i < len(in); i += lineLen {
-		j := i + lineLen
-		if j > len(in) {
-			j = len(in)
-		}
-		k += copy(out[k:], in[i:j])
-		if lines > 1 {
-			out[k] = '\n'
-			k++
-		}
-	}
-	return string(out[:k])
-}

api/krusty/configmaps_test.go

@@ -74,20 +74,16 @@ configMapGenerator:
 `)
 	opts := th.MakeDefaultOptions()
 	m := th.Run("overlay", opts)
-	expFmt := `apiVersion: v1
+	th.AssertActualEqualsExpected(m, `apiVersion: v1
 data:
-  crisis: %s
+  crisis: "true"
   fruit: Indian Gooseberry
-  month: %s
-  year: %s
+  month: "12"
+  year: "2020"
 kind: ConfigMap
 metadata:
-  name: bob-%s
-`
-	th.AssertActualEqualsExpected(
-		m, opts.IfApiMachineryElseKyaml(
-			fmt.Sprintf(expFmt, `"true"`, `"12"`, `"2020"`, `bk46gm59c6`),
-			fmt.Sprintf(expFmt, `true`, `12`, `2020`, `bkmtk2t2fb`)))
+  name: bob-bk46gm59c6
+`)
 }
 
 // Generate a Secret and a ConfigMap from the same data

kyaml/yaml/datamap.go

@@ -0,0 +1,105 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package yaml
+
+import (
+	"encoding/base64"
+	"sort"
+	"strings"
+	"unicode/utf8"
+)
+
+// SortedMapKeys returns a sorted slice of keys to the given map.
+// Writing this function never gets old.
+func SortedMapKeys(m map[string]string) []string {
+	keys := make([]string, len(m))
+	i := 0
+	for k := range m {
+		keys[i] = k
+		i++
+	}
+	sort.Strings(keys)
+	return keys
+}
+
+func (rn *RNode) LoadMapIntoConfigMapData(m map[string]string) error {
+	for _, k := range SortedMapKeys(m) {
+		fldName, vrN := makeConfigMapValueRNode(m[k])
+		if _, err := rn.Pipe(
+			LookupCreate(MappingNode, fldName),
+			SetField(k, vrN)); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func makeConfigMapValueRNode(s string) (field string, rN *RNode) {
+	yN := &Node{Kind: ScalarNode}
+	yN.Tag = NodeTagString
+	if utf8.ValidString(s) {
+		field = DataField
+		yN.Value = s
+	} else {
+		field = BinaryDataField
+		yN.Value = encodeBase64(s)
+	}
+	if strings.Contains(yN.Value, "\n") {
+		yN.Style = LiteralStyle
+	}
+	return field, NewRNode(yN)
+}
+
+func (rn *RNode) LoadMapIntoSecretData(m map[string]string) error {
+	for _, k := range SortedMapKeys(m) {
+		vrN := makeSecretValueRNode(m[k])
+		if _, err := rn.Pipe(
+			LookupCreate(MappingNode, DataField),
+			SetField(k, vrN)); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// In a secret, all data is base64 encoded, regardless of its conformance
+// or lack thereof to UTF-8.
+func makeSecretValueRNode(s string) *RNode {
+	yN := &Node{Kind: ScalarNode}
+	// Purposely don't use YAML tags to identify the data as being plain text or
+	// binary.  It kubernetes Secrets the values in the `data` map are expected
+	// to be base64 encoded, and in ConfigMaps that same can be said for the
+	// values in the `binaryData` field.
+	yN.Tag = NodeTagString
+	yN.Value = encodeBase64(s)
+	if strings.Contains(yN.Value, "\n") {
+		yN.Style = LiteralStyle
+	}
+	return NewRNode(yN)
+}
+
+// encodeBase64 encodes s as base64 that is broken up into multiple lines
+// as appropriate for the resulting length.
+func encodeBase64(s string) string {
+	const lineLen = 70
+	encLen := base64.StdEncoding.EncodedLen(len(s))
+	lines := encLen/lineLen + 1
+	buf := make([]byte, encLen*2+lines)
+	in := buf[0:encLen]
+	out := buf[encLen:]
+	base64.StdEncoding.Encode(in, []byte(s))
+	k := 0
+	for i := 0; i < len(in); i += lineLen {
+		j := i + lineLen
+		if j > len(in) {
+			j = len(in)
+		}
+		k += copy(out[k:], in[i:j])
+		if lines > 1 {
+			out[k] = '\n'
+			k++
+		}
+	}
+	return string(out[:k])
+}

kyaml/yaml/datamap_test.go

@@ -1,10 +1,13 @@
-package filtersutil_test
+// Copyright 2021 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package yaml_test
 
 import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	"sigs.k8s.io/kustomize/api/filters/filtersutil"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
 )
 
 func TestSortedKeys(t *testing.T) {
@@ -23,9 +26,10 @@ func TestSortedKeys(t *testing.T) {
 			expected: []string{"a", "b", "c"}},
 	}
 	for tn, tc := range testCases {
+		tc := tc
 		t.Run(tn, func(t *testing.T) {
 			if !assert.Equal(t,
-				filtersutil.SortedMapKeys(tc.input),
+				yaml.SortedMapKeys(tc.input),
 				tc.expected) {
 				t.FailNow()
 			}

kyaml/yaml/rnode.go

@@ -435,13 +435,13 @@ func (rn *RNode) SetDataMap(m map[string]string) {
 	if rn == nil {
 		log.Fatal("cannot set data map on nil Rnode")
 	}
+	if err := rn.PipeE(Clear(DataField)); err != nil {
+		log.Fatal(err)
+	}
 	if len(m) == 0 {
-		if err := rn.PipeE(Clear(DataField)); err != nil {
-			log.Fatal(err)
-		}
 		return
 	}
-	if err := rn.SetMapField(NewMapRNode(&m), DataField); err != nil {
+	if err := rn.LoadMapIntoConfigMapData(m); err != nil {
 		log.Fatal(err)
 	}
 }