Skip to content

Commit

Permalink
Use yaml package for (un)marshaling custom values
Browse files Browse the repository at this point in the history 
Signed-off-by: Atanas Dinov <[email protected]>
  • Loading branch information
@atanasdinov
atanasdinov committed Sep 9, 2024
1 parent 3ff187e commit ab0f1f7
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 38 deletions.
2 changes: 1 addition & 1 deletion go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ require (
github.com/onsi/gomega v1.34.2
github.com/rancher/system-upgrade-controller/pkg/apis v0.0.0-20240612205712-57605e3390c0
github.com/stretchr/testify v1.9.0
gopkg.in/yaml.v3 v3.0.1
helm.sh/helm/v3 v3.15.4
k8s.io/api v0.31.0
k8s.io/apiextensions-apiserver v0.31.0
Expand Down Expand Up @@ -90,7 +91,6 @@ require (
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
Expand Down
6 changes: 4 additions & 2 deletions internal/controller/helm.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import (
lifecyclev1alpha1 "github.com/suse-edge/upgrade-controller/api/v1alpha1"
"github.com/suse-edge/upgrade-controller/internal/upgrade"

"gopkg.in/yaml.v3"

helmcattlev1 "github.com/k3s-io/helm-controller/pkg/apis/helm.cattle.io/v1"
helmrelease "helm.sh/helm/v3/pkg/release"
helmutil "helm.sh/helm/v3/pkg/releaseutil"
Expand Down Expand Up @@ -150,7 +152,7 @@ func mergeHelmValues(installedValues any, releaseValues, userValues *apiextensio
switch installed := installedValues.(type) {
case string:
if installed != "" {
if err := json.Unmarshal([]byte(installed), &values); err != nil {
if err := yaml.Unmarshal([]byte(installed), &values); err != nil {
return nil, fmt.Errorf("unmarshaling installed chart values: %w", err)
}
}
Expand Down Expand Up @@ -186,7 +188,7 @@ func mergeHelmValues(installedValues any, releaseValues, userValues *apiextensio
return nil, nil
}

v, err := json.Marshal(values)
v, err := yaml.Marshal(values)
if err != nil {
return nil, fmt.Errorf("marshaling chart values: %w", err)
}
Expand Down
149 changes: 114 additions & 35 deletions internal/controller/helm_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package controller
import (
"testing"

"gopkg.in/yaml.v3"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -77,32 +78,26 @@ func Test_MergeMaps(t *testing.T) {
}

func Test_MergeHelmValues(t *testing.T) {
installedValuesStr := `{
"global": {
"ironicIP": "147.28.230.5"
},
"metal3-ironic": {
"service": {
"type": "LoadBalancer"
},
"persistence": {
"ironic": {
"storageClass": "longhorn"
}
}
}
}`
installedValuesStr := `global:
ironicIP: 147.28.230.5
metal3-ironic:
service:
type: LoadBalancer
persistence:
ironic:
storageClass: longhorn
`

installedValuesMap := map[string]interface{}{
"global": map[string]interface{}{
installedValuesMap := map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.5",
},
"metal3-ironic": map[string]interface{}{
"service": map[string]interface{}{
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]interface{}{
"ironic": map[string]interface{}{
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "longhorn",
},
},
Expand All @@ -114,7 +109,7 @@ func Test_MergeHelmValues(t *testing.T) {
installedValues any
releaseValues *apiextensionsv1.JSON
userValues *apiextensionsv1.JSON
expectedValues []byte
expectedValues map[string]any
expectedErr string
}{
{
Expand All @@ -125,54 +120,116 @@ func Test_MergeHelmValues(t *testing.T) {
{
name: "Empty installed values string, empty release values",
installedValues: "",
expectedValues: nil,
},
{
name: "Empty installed values string, non-empty release values",
installedValues: "",
releaseValues: &apiextensionsv1.JSON{
Raw: []byte(`{"global": {"ironicIP": "147.28.230.5"}}`),
},
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.5"}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.5",
},
},
},
{
name: "Non-empty installed values string, empty release values",
installedValues: installedValuesStr,
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.5"},"metal3-ironic":{"persistence":{"ironic":{"storageClass":"longhorn"}},"service":{"type":"LoadBalancer"}}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.5",
},
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "longhorn",
},
},
},
},
},
{
name: "Non-empty installed values string, non-empty release values",
installedValues: installedValuesStr,
releaseValues: &apiextensionsv1.JSON{
Raw: []byte(`{"global": {"ironicIP": "147.28.230.105"}}`),
},
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.105"},"metal3-ironic":{"persistence":{"ironic":{"storageClass":"longhorn"}},"service":{"type":"LoadBalancer"}}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.105",
},
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "longhorn",
},
},
},
},
},
{
name: "Empty installed values map, empty release values",
installedValues: map[string]interface{}{},
expectedValues: nil,
installedValues: map[string]any{},
},
{
name: "Empty installed values map, non-empty release values",
installedValues: map[string]interface{}{},
installedValues: map[string]any{},
releaseValues: &apiextensionsv1.JSON{
Raw: []byte(`{"global": {"ironicIP": "147.28.230.5"}}`),
},
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.5"}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.5",
},
},
},
{
name: "Non-empty installed values map, empty release values",
installedValues: installedValuesMap,
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.5"},"metal3-ironic":{"persistence":{"ironic":{"storageClass":"longhorn"}},"service":{"type":"LoadBalancer"}}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.5",
},
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "longhorn",
},
},
},
},
},
{
name: "Non-empty installed values map, non-empty release values",
installedValues: installedValuesMap,
releaseValues: &apiextensionsv1.JSON{
Raw: []byte(`{"global": {"ironicIP": "147.28.230.105"}}`),
},
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.105"},"metal3-ironic":{"persistence":{"ironic":{"storageClass":"longhorn"}},"service":{"type":"LoadBalancer"}}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.105",
},
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "longhorn",
},
},
},
},
},
{
name: "Non-empty installed values map, non-empty release values, non-empty user values",
Expand All @@ -183,12 +240,26 @@ func Test_MergeHelmValues(t *testing.T) {
userValues: &apiextensionsv1.JSON{
Raw: []byte(`{"metal3-ironic": {"persistence": {"ironic": {"storageClass": "local-path-provisioner"}}}}`),
},
expectedValues: []byte(`{"global":{"ironicIP":"147.28.230.105"},"metal3-ironic":{"persistence":{"ironic":{"storageClass":"local-path-provisioner"}},"service":{"type":"LoadBalancer"}}}`),
expectedValues: map[string]any{
"global": map[string]any{
"ironicIP": "147.28.230.105",
},
"metal3-ironic": map[string]any{
"service": map[string]any{
"type": "LoadBalancer",
},
"persistence": map[string]any{
"ironic": map[string]any{
"storageClass": "local-path-provisioner",
},
},
},
},
},
{
name: "Invalid installed values string",
installedValues: "{",
expectedErr: "unmarshaling installed chart values: unexpected end of JSON input",
expectedErr: "unmarshaling installed chart values: yaml: line 1: did not find expected node content",
},
{
name: "Invalid release values",
Expand All @@ -215,9 +286,17 @@ func Test_MergeHelmValues(t *testing.T) {
require.Error(t, err)
assert.EqualError(t, err, test.expectedErr)
assert.Nil(t, values)
return
}

require.NoError(t, err)

if len(test.expectedValues) == 0 {
assert.Nil(t, values)
} else {
b, err := yaml.Marshal(test.expectedValues)
require.NoError(t, err)
assert.Equal(t, string(test.expectedValues), string(values))
assert.Equal(t, string(b), string(values))
}
})
}
Expand Down

0 comments on commit ab0f1f7

Please sign in to comment.