Skip to content

fix(helm): Fix the problem of determining whether the helm chart is upgraded or not #5059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions internal/helm/release/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,22 +156,29 @@ func equalJSONStruct(a, b interface{}) (bool, error) {
return aBuf.String() == bBuf.String(), err
}

func (m manager) getCandidateRelease(namespace, name string, chart *cpb.Chart,
values map[string]interface{}) (*rpb.Release, error) {
upgrade := action.NewUpgrade(m.actionConfig)
upgrade.Namespace = namespace
upgrade.DryRun = true
return upgrade.Run(name, chart, values)
}

func (m manager) isUpgrade(deployedRelease *rpb.Release) (bool, error) {
if deployedRelease == nil {
return false, nil
}

// Judging whether to skip updates
skip := m.namespace == deployedRelease.Namespace
skip = skip && m.releaseName == deployedRelease.Name

ok, err := equalJSONStruct(m.chart, deployedRelease.Chart)
candidateRelease, err := m.getCandidateRelease(m.namespace, m.releaseName, m.chart, m.values)
if err != nil {
return false, err
}
skip = skip && ok

ok, err = equalJSONStruct(m.values, deployedRelease.Config)
skip, err := equalJSONStruct(candidateRelease.Chart, deployedRelease.Chart)
if err != nil {
return false, err
}
ok, err := equalJSONStruct(candidateRelease.Config, deployedRelease.Config)
return !(skip && ok), err
}

Expand Down
113 changes: 59 additions & 54 deletions internal/helm/release/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,17 @@
package release

import (
"bytes"
"encoding/json"
"io/ioutil"
"testing"

"github.com/stretchr/testify/assert"
"helm.sh/helm/v3/pkg/action"
cpb "helm.sh/helm/v3/pkg/chart"
lpb "helm.sh/helm/v3/pkg/chart/loader"
rpb "helm.sh/helm/v3/pkg/release"
"helm.sh/helm/v3/pkg/chartutil"
kubefake "helm.sh/helm/v3/pkg/kube/fake"
"helm.sh/helm/v3/pkg/storage"
"helm.sh/helm/v3/pkg/storage/driver"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down Expand Up @@ -219,49 +222,54 @@ func TestManagerGenerateStrategicMergePatch(t *testing.T) {

func TestManagerisUpgrade(t *testing.T) {
tests := []struct {
name string
releaseName string
releaseNs string
values map[string]interface{}
chart *cpb.Chart
deployedRelease *rpb.Release
want bool
name string
releaseName string
releaseNs string
deployValues map[string]interface{}
values map[string]interface{}
deployChart *cpb.Chart
chart *cpb.Chart
want bool
}{
{
name: "ok",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: map[string]interface{}{"key": "value"},
chart: newTestChart(t, "./testdata/simple"),
deployedRelease: newTestRelease(newTestChart(t, "./testdata/simple"), map[string]interface{}{"key": "value"}, "deployed", "deployed-ns"),
want: false,
name: "ok",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: map[string]interface{}{"key": "value"},
deployValues: map[string]interface{}{"key": "value"},
chart: newTestChart(t, "./testdata/simple"),
deployChart: newTestChart(t, "./testdata/simple"),
want: false,
},
{
name: "different chart",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: map[string]interface{}{"key": "value"},
chart: newTestChart(t, "./testdata/simple"),
deployedRelease: newTestRelease(newTestChart(t, "./testdata/simpledf"), map[string]interface{}{"key": "value"}, "deployed", "deployed-ns"),
want: true,
name: "different chart",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: map[string]interface{}{"key": "value"},
deployValues: map[string]interface{}{"key": "value"},
chart: newTestChart(t, "./testdata/simple"),
deployChart: newTestChart(t, "./testdata/simpledf"),
want: true,
},
{
name: "different values",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: map[string]interface{}{"key": "1", "int": int32(1)},
chart: newTestChart(t, "./testdata/simple"),
deployedRelease: newTestRelease(newTestChart(t, "./testdata/simple"), map[string]interface{}{"key": "", "int": int64(1)}, "deployed", "deployed-ns"),
want: true,
name: "different values",
releaseName: "deployed",
releaseNs: "deployed-ns",
deployValues: map[string]interface{}{"key": "1"},
values: map[string]interface{}{"key": "1", "int": int32(1)},
chart: newTestChart(t, "./testdata/simple"),
deployChart: newTestChart(t, "./testdata/simple"),
want: true,
},
{
name: "nil values",
releaseName: "deployed",
releaseNs: "deployed-ns",
values: nil,
chart: newTestChart(t, "./testdata/simple"),
deployedRelease: newTestRelease(newTestChart(t, "./testdata/simple"), map[string]interface{}{}, "deployed", "deployed-ns"),
want: false,
name: "nil values",
releaseName: "deployed",
releaseNs: "deployed-ns",
deployValues: map[string]interface{}{},
values: nil,
chart: newTestChart(t, "./testdata/simple"),
deployChart: newTestChart(t, "./testdata/simple"),
want: false,
},
}
for _, test := range tests {
Expand All @@ -271,10 +279,21 @@ func TestManagerisUpgrade(t *testing.T) {
namespace: test.releaseNs,
values: test.values,
chart: test.chart,
actionConfig: &action.Configuration{
Releases: storage.Init(driver.NewMemory()),
KubeClient: &kubefake.FailingKubeClient{PrintingKubeClient: kubefake.PrintingKubeClient{Out: ioutil.Discard}},
Capabilities: chartutil.DefaultCapabilities,
Log: t.Logf,
},
}
isUpgrade, err := m.isUpgrade(test.deployedRelease)
install := action.NewInstall(m.actionConfig)
install.Namespace = test.releaseNs
install.ReleaseName = test.releaseName
deployedRelease, err := install.Run(test.deployChart, test.deployValues)
assert.Nil(t, err)
isUpgrade, err := m.isUpgrade(deployedRelease)
assert.Equal(t, test.want, isUpgrade)
assert.Equal(t, nil, err)
assert.Nil(t, err)
})
}
}
Expand All @@ -284,17 +303,3 @@ func newTestChart(t *testing.T, path string) *cpb.Chart {
assert.Nil(t, err)
return chart
}

func newTestRelease(chart *cpb.Chart, values map[string]interface{}, name, namespace string) *rpb.Release { // nolint: unparam
release := rpb.Mock(&rpb.MockReleaseOptions{
Name: name,
Namespace: namespace,
Version: 1,
})

buffer := &bytes.Buffer{}
_ = json.NewEncoder(buffer).Encode(chart)
_ = json.NewDecoder(buffer).Decode(release.Chart)
release.Config = values
return release
}