Properly use checksum and ordered checksum

Signed-off-by: Hidde Beydals <hidde@hhh.computer>

Author: hiddeco

api/v2beta1/helmrelease_types.go

@@ -945,6 +945,8 @@ func HelmReleaseReady(hr HelmRelease) HelmRelease {
 
 // HelmReleaseAttempted registers an attempt of the given HelmRelease with the given state.
 // and returns the modified HelmRelease and a boolean indicating a state change.
+//
+// Deprecated: in favor of HelmReleaseChanged and HelmReleaseRecordAttempt.
 func HelmReleaseAttempted(hr HelmRelease, revision string, releaseRevision int, valuesChecksum string) (HelmRelease, bool) {
 	changed := hr.Status.LastAttemptedRevision != revision ||
 		hr.Status.LastReleaseRevision != releaseRevision ||
@@ -956,6 +958,31 @@ func HelmReleaseAttempted(hr HelmRelease, revision string, releaseRevision int,
 	return hr, changed
 }
 
+// HelmReleaseChanged returns if the HelmRelease has changed compared to the
+// provided values.
+func HelmReleaseChanged(hr HelmRelease, revision string, releaseRevision int, valuesChecksums ...string) bool {
+	return hr.Status.LastAttemptedRevision != revision ||
+		hr.Status.LastReleaseRevision != releaseRevision ||
+		!inStringSlice(hr.Status.LastAttemptedValuesChecksum, valuesChecksums)
+}
+
+// HelmReleaseRecordAttempt returns an attempt of the given HelmRelease with the
+// given state in the Status of the provided object.
+func HelmReleaseRecordAttempt(hr *HelmRelease, revision string, releaseRevision int, valuesChecksum string) {
+	hr.Status.LastAttemptedRevision = revision
+	hr.Status.LastReleaseRevision = releaseRevision
+	hr.Status.LastAttemptedValuesChecksum = valuesChecksum
+}
+
+func inStringSlice(str string, s []string) bool {
+	for _, v := range s {
+		if str == v {
+			return true
+		}
+	}
+	return false
+}
+
 func resetFailureCounts(hr *HelmRelease) {
 	hr.Status.Failures = 0
 	hr.Status.InstallFailures = 0

internal/controllers/helmrelease_controller.go

@@ -322,17 +322,15 @@ func (r *HelmReleaseReconciler) reconcileRelease(ctx context.Context,
 		return v2.HelmReleaseNotReady(hr, v2.GetLastReleaseFailedReason, "failed to get last release revision"), err
 	}
 
-	// Register the current release attempt.
+	// Detect divergence between release in storage and HelmRelease spec.
 	revision := chart.Metadata.Version
 	releaseRevision := util.ReleaseRevision(rel)
-	valuesChecksum := util.ValuesChecksum(values)
-	hr, hasNewState := v2.HelmReleaseAttempted(hr, revision, releaseRevision, valuesChecksum)
+	// TODO: deprecate "unordered" checksum.
+	valuesChecksum := util.OrderedValuesChecksum(values)
+	hasNewState := v2.HelmReleaseChanged(hr, revision, releaseRevision, util.ValuesChecksum(values), valuesChecksum)
 
-	if hasNewState {
-		// If there is a change, check on ordered checksum.
-		valuesChecksum = util.OrderedValuesChecksum(values)
-		hr, hasNewState = v2.HelmReleaseAttempted(hr, revision, releaseRevision, valuesChecksum)
-	}
+	// Register the current release attempt.
+	v2.HelmReleaseRecordAttempt(&hr, revision, releaseRevision, valuesChecksum)
 
 	// Run diff against current cluster state.
 	if !hasNewState && rel != nil {