feat: add GetReleaseChecksum method and update UpgradeRelease signature (#583)

Signed-off-by: Evsyukov Denis <[email protected]>

Author: juev

pkg/helm/client/client.go

@@ -1,12 +1,15 @@
 package client
 
-import "github.com/flant/addon-operator/pkg/utils"
+import (
+	"github.com/flant/addon-operator/pkg/utils"
+)
 
 type HelmClient interface {
 	LastReleaseStatus(releaseName string) (string, string, error)
-	UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, namespace string) error
+	UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, labels map[string]string, namespace string) error
 	Render(releaseName string, chart string, valuesPaths []string, setValues []string, namespace string, debug bool) (string, error)
 	GetReleaseValues(releaseName string) (utils.Values, error)
+	GetReleaseChecksum(releaseName string) (string, error)
 	DeleteRelease(releaseName string) error
 	ListReleasesNames() ([]string, error)
 	IsReleaseExists(releaseName string) (bool, error)

pkg/helm/helm3/helm3.go

@@ -145,7 +145,7 @@ func (h *Helm3Client) LastReleaseStatus(releaseName string) (string /*revision*/
 	return revision, status, nil
 }
 
-func (h *Helm3Client) UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, namespace string) error {
+func (h *Helm3Client) UpgradeRelease(releaseName string, chart string, valuesPaths []string, setValues []string, _ map[string]string, namespace string) error {
 	args := []string{
 		"upgrade", releaseName, chart,
 		"--install",
@@ -210,6 +210,20 @@ func (h *Helm3Client) GetReleaseValues(releaseName string) (utils.Values, error)
 	return values, nil
 }
 
+func (h *Helm3Client) GetReleaseChecksum(releaseName string) (string, error) {
+	args := []string{
+		"get", "manifest", releaseName,
+		"--namespace", h.Namespace,
+	}
+	stdout, stderr, err := h.cmd(args...)
+	if err != nil {
+		return "", fmt.Errorf("cannot get manifest of helm release %s: %s\n%s %s", releaseName, err, stdout, stderr)
+	}
+
+	checksum := utils.CalculateStringsChecksum(stdout)
+	return checksum, nil
+}
+
 func (h *Helm3Client) DeleteRelease(releaseName string) error {
 	h.Logger.Debug("helm release: execute helm uninstall", slog.String("release", releaseName))
 

pkg/helm/helm3lib/helm3lib.go

@@ -160,15 +160,15 @@ func (h *LibClient) LastReleaseStatus(releaseName string) (string /*revision*/,
 	return strconv.FormatInt(int64(lastRelease.Version), 10), lastRelease.Info.Status.String(), nil
 }
 
-func (h *LibClient) UpgradeRelease(releaseName string, chartName string, valuesPaths []string, setValues []string, namespace string) error {
-	err := h.upgradeRelease(releaseName, chartName, valuesPaths, setValues, namespace)
+func (h *LibClient) UpgradeRelease(releaseName string, chartName string, valuesPaths []string, setValues []string, labels map[string]string, namespace string) error {
+	err := h.upgradeRelease(releaseName, chartName, valuesPaths, setValues, labels, namespace)
 	if err != nil {
 		// helm validation can fail because FeatureGate was enabled for example
 		// handling this case we can reinitialize kubeClient and repeat one more time by backoff
 		if err := actionConfigInit(h.Logger); err != nil {
 			return err
 		}
-		return h.upgradeRelease(releaseName, chartName, valuesPaths, setValues, namespace)
+		return h.upgradeRelease(releaseName, chartName, valuesPaths, setValues, labels, namespace)
 	}
 	h.Logger.Debug("helm release upgraded", slog.String("version", releaseName))
 	return nil
@@ -178,7 +178,7 @@ func (h *LibClient) hasLabelsToApply() bool {
 	return len(h.labels) > 0
 }
 
-func (h *LibClient) upgradeRelease(releaseName string, chartName string, valuesPaths []string, setValues []string, namespace string) error {
+func (h *LibClient) upgradeRelease(releaseName string, chartName string, valuesPaths []string, setValues []string, labels map[string]string, namespace string) error {
 	upg := action.NewUpgrade(actionConfig)
 	if namespace != "" {
 		upg.Namespace = namespace
@@ -191,6 +191,7 @@ func (h *LibClient) upgradeRelease(releaseName string, chartName string, valuesP
 	upg.SkipCRDs = true
 	upg.MaxHistory = int(options.HistoryMax)
 	upg.Timeout = options.Timeout
+	upg.Labels = labels
 
 	chart, err := loader.Load(chartName)
 	if err != nil {
@@ -240,6 +241,7 @@ func (h *LibClient) upgradeRelease(releaseName string, chartName string, valuesP
 		instClient.Timeout = options.Timeout
 		instClient.ReleaseName = releaseName
 		instClient.UseReleaseName = true
+		instClient.Labels = labels
 
 		_, err = instClient.Run(chart, resultValues)
 		return err
@@ -356,6 +358,30 @@ func (h *LibClient) GetReleaseValues(releaseName string) (utils.Values, error) {
 	return gv.Run(releaseName)
 }
 
+func (h *LibClient) GetReleaseChecksum(releaseName string) (string, error) {
+	gv := action.NewGet(actionConfig)
+	rel, err := gv.Run(releaseName)
+	if err != nil {
+		return "", fmt.Errorf("helm get failed: %s", err)
+	}
+	if checksum, ok := rel.Labels["moduleChecksum"]; ok {
+		return checksum, nil
+	}
+
+	// fallback to old behavior
+	releaseValues, err := h.GetReleaseValues(releaseName)
+	if err != nil {
+		return "", fmt.Errorf("helm get failed: %s", err)
+	}
+	if recordedChecksum, hasKey := releaseValues["_addonOperatorModuleChecksum"]; hasKey {
+		if recordedChecksumStr, ok := recordedChecksum.(string); ok {
+			return recordedChecksumStr, nil
+		}
+	}
+
+	return "", fmt.Errorf("moduleChecksum label not found in release %s", releaseName)
+}
+
 func (h *LibClient) DeleteRelease(releaseName string) error {
 	h.Logger.Debug("helm release: execute helm uninstall", slog.String("release", releaseName))
 

pkg/helm/helm3lib/helm3lib_test.go

@@ -38,7 +38,7 @@ func TestHelm3LibUpgradeDelete(t *testing.T) {
 
 	cl := initHelmClient(t)
 
-	err := cl.UpgradeRelease("test-release", "testdata/chart", nil, nil, cl.Namespace)
+	err := cl.UpgradeRelease("test-release", "testdata/chart", nil, nil, nil, cl.Namespace)
 	g.Expect(err).ShouldNot(HaveOccurred())
 
 	releases, err := cl.ListReleasesNames()

pkg/helm/helm_test.go

@@ -51,7 +51,7 @@ func TestHelmFactory(t *testing.T) {
 		g.Expect(err).ShouldNot(HaveOccurred())
 		g.Expect(isExists).Should(BeFalse(), "should not found release in the empty cluster")
 
-		err = helmCl.UpgradeRelease("test-release", "helm3lib/testdata/chart", nil, nil, namespace)
+		err = helmCl.UpgradeRelease("test-release", "helm3lib/testdata/chart", nil, nil, nil, namespace)
 		g.Expect(err).ShouldNot(HaveOccurred())
 
 		releasesAfterUpgrade, err := helmCl.ListReleasesNames()

pkg/helm/test/mock/mock.go

@@ -44,7 +44,11 @@ func (c *Client) GetReleaseValues(_ string) (utils.Values, error) {
 	return make(utils.Values), nil
 }
 
-func (c *Client) UpgradeRelease(_, _ string, _ []string, _ []string, _ string) error {
+func (c *Client) GetReleaseChecksum(_ string) (string, error) {
+	return "23857cb313d15f43960f4daa7013804e", nil
+}
+
+func (c *Client) UpgradeRelease(_, _ string, _ []string, _ []string, _ map[string]string, _ string) error {
 	c.UpgradeReleaseExecuted = true
 	return nil
 }

pkg/module_manager/models/modules/helm.go

@@ -272,7 +272,10 @@ func (hm *HelmModule) RunHelmInstall(logLabels map[string]string) error {
 			helmReleaseName,
 			hm.path,
 			[]string{valuesPath},
-			[]string{fmt.Sprintf("_addonOperatorModuleChecksum=%s", checksum)},
+			[]string{},
+			map[string]string{
+				"moduleChecksum": checksum,
+			},
 			hm.defaultNamespace,
 		)
 	}()
@@ -311,32 +314,22 @@ func (hm *HelmModule) shouldRunHelmUpgrade(helmClient client.HelmClient, release
 	}
 
 	// Get values for a non-failed release.
-	releaseValues, err := helmClient.GetReleaseValues(releaseName)
+	recordedChecksum, err := helmClient.GetReleaseChecksum(releaseName)
 	if err != nil {
 		logEntry.Debug("helm release get values error, no upgrade",
 			slog.String("release", releaseName),
 			log.Err(err))
 		return false, err
 	}
 
-	// Run helm upgrade if there is no stored checksum
-	recordedChecksum, hasKey := releaseValues["_addonOperatorModuleChecksum"]
-	if !hasKey {
-		logEntry.Debug("helm release has no saved checksum of values: should run upgrade",
-			slog.String("release", releaseName))
-		return true, nil
-	}
-
 	// Calculate a checksum of current values and compare to a stored checksum.
 	// Run helm upgrade if checksum is changed.
-	if recordedChecksumStr, ok := recordedChecksum.(string); ok {
-		if recordedChecksumStr != checksum {
-			logEntry.Debug("helm release checksum is changed: should run upgrade",
-				slog.String("release", releaseName),
-				slog.String("checksum", recordedChecksumStr),
-				slog.String("newChecksum", checksum))
-			return true, nil
-		}
+	if recordedChecksum != checksum {
+		logEntry.Debug("helm release checksum is changed: should run upgrade",
+			slog.String("release", releaseName),
+			slog.String("checksum", recordedChecksum),
+			slog.String("newChecksum", checksum))
+		return true, nil
 	}
 
 	// Check if there are absent resources