mirror of https://github.com/helm/helm
this was partially fixed in #6430 but the fix only worked for values without nesting. this PR fixes it. this is done by doing a deep copy of values rather than a top level keys copy. deep copy ensures values are not mutated during coalesce() execution which leads to bugs like #6659 the deep copy code has been copied from: https://gist.github.com/soroushjp/0ec92102641ddfc3ad5515ca76405f4d which is in turn inspired by this stackoverflow answer: http://stackoverflow.com/a/28579297/1366283 Signed-off-by: Karuppiah Natarajan <karuppiah7890@gmail.com>pull/6661/head
parent
e7413bd61c
commit
dfed8ab5e3
@ -0,0 +1,39 @@
|
|||||||
|
package deepcopy
|
||||||
|
|
||||||
|
// DeepCopyMap a function for deep copying map[string]interface{}
|
||||||
|
// values. Inspired by:
|
||||||
|
// https://gist.github.com/soroushjp/0ec92102641ddfc3ad5515ca76405f4d by Soroush Pour
|
||||||
|
// The gist code is MIT licensed
|
||||||
|
// which in turn has been inspired by the StackOverflow answer at:
|
||||||
|
// http://stackoverflow.com/a/28579297/1366283
|
||||||
|
//
|
||||||
|
// Uses the golang.org/pkg/encoding/gob package to do this and therefore has the
|
||||||
|
// same caveats.
|
||||||
|
// See: https://blog.golang.org/gobs-of-data
|
||||||
|
// See: https://golang.org/pkg/encoding/gob/
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/gob"
|
||||||
|
)
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
gob.Register(map[string]interface{}{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map performs a deep copy of the given map m.
|
||||||
|
func Map(m map[string]interface{}) (map[string]interface{}, error) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
enc := gob.NewEncoder(&buf)
|
||||||
|
dec := gob.NewDecoder(&buf)
|
||||||
|
err := enc.Encode(m)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var mapCopy map[string]interface{}
|
||||||
|
err = dec.Decode(&mapCopy)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return mapCopy, nil
|
||||||
|
}
|
@ -0,0 +1,130 @@
|
|||||||
|
package deepcopy_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"helm.sh/helm/v3/internal/third_party/deepcopy"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCopyMap(t *testing.T) {
|
||||||
|
testCases := []struct {
|
||||||
|
// original and expectedOriginal are the same value in each test case. We do
|
||||||
|
// this to avoid unintentionally asserting against a mutated
|
||||||
|
// expectedOriginal and having the test pass erroneously. We also do not
|
||||||
|
// want to rely on the deep copy function we are testing to ensure this does
|
||||||
|
// not happen.
|
||||||
|
original map[string]interface{}
|
||||||
|
transformer func(m map[string]interface{}) map[string]interface{}
|
||||||
|
expectedCopy map[string]interface{}
|
||||||
|
expectedOriginal map[string]interface{}
|
||||||
|
}{
|
||||||
|
// reassignment of entire map, should be okay even without deep copy.
|
||||||
|
{
|
||||||
|
original: nil,
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
return map[string]interface{}{}
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{},
|
||||||
|
expectedOriginal: nil,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
expectedCopy: nil,
|
||||||
|
expectedOriginal: map[string]interface{}{},
|
||||||
|
},
|
||||||
|
// mutation of map
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
m["foo"] = "bar"
|
||||||
|
return m
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
expectedOriginal: map[string]interface{}{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
m["foo"] = "car"
|
||||||
|
return m
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{
|
||||||
|
"foo": "car",
|
||||||
|
},
|
||||||
|
expectedOriginal: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// mutation of nested maps
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
m["foo"] = map[string]interface{}{
|
||||||
|
"biz": "baz",
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{
|
||||||
|
"foo": map[string]interface{}{
|
||||||
|
"biz": "baz",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
expectedOriginal: map[string]interface{}{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{
|
||||||
|
"foo": map[string]interface{}{
|
||||||
|
"biz": "booz",
|
||||||
|
"gaz": "gooz",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
m["foo"] = map[string]interface{}{
|
||||||
|
"biz": "baz",
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{
|
||||||
|
"foo": map[string]interface{}{
|
||||||
|
"biz": "baz",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
expectedOriginal: map[string]interface{}{
|
||||||
|
"foo": map[string]interface{}{
|
||||||
|
"biz": "booz",
|
||||||
|
"gaz": "gooz",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// mutation of slice values
|
||||||
|
{
|
||||||
|
original: map[string]interface{}{
|
||||||
|
"foo": []string{"biz", "baz"},
|
||||||
|
},
|
||||||
|
transformer: func(m map[string]interface{}) map[string]interface{} {
|
||||||
|
m["foo"].([]string)[0] = "hiz"
|
||||||
|
return m
|
||||||
|
},
|
||||||
|
expectedCopy: map[string]interface{}{
|
||||||
|
"foo": []string{"hiz", "baz"},
|
||||||
|
},
|
||||||
|
expectedOriginal: map[string]interface{}{
|
||||||
|
"foo": []string{"biz", "baz"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for i, tc := range testCases {
|
||||||
|
mapCopy, err := deepcopy.Map(tc.original)
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Exactly(t, tc.expectedCopy, tc.transformer(mapCopy), "copy was not mutated. test case: %d", i)
|
||||||
|
assert.Exactly(t, tc.expectedOriginal, tc.original, "original was mutated. test case: %d", i)
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in new issue