fix:issue-5041

Signed-off-by: cndoit18 <[email protected]>

Author: cndoit18

Diff for: changelog/fragments/helm-deepequals.yaml

@@ -0,0 +1,4 @@
+entries:
+  - description: >
+      For Helm-based operators, fixed a bug where getting a new helm release revision for every reconciliation, even there are no changes at all.
+    kind: bugfix

Diff for: internal/helm/release/manager.go

@@ -32,7 +32,6 @@ import (
 	"helm.sh/helm/v3/pkg/storage/driver"
 	apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
-	apiequality "k8s.io/apimachinery/pkg/api/equality"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -44,6 +43,7 @@ import (
 
 	"github.com/operator-framework/operator-sdk/internal/helm/internal/types"
 	"github.com/operator-framework/operator-sdk/internal/helm/manifestutil"
+	"k8s.io/apimachinery/pkg/conversion"
 )
 
 // Manager manages a Helm release. It can install, upgrade, reconcile,
@@ -135,6 +135,19 @@ func notFoundErr(err error) bool {
 	return err != nil && strings.Contains(err.Error(), "not found")
 }
 
+var equalities = conversion.EqualitiesOrDie(func(a, b *cpb.Chart) bool {
+	if a == nil || b == nil {
+		return a == nil && b == nil
+	}
+	aencode := &bytes.Buffer{}
+	bencode := &bytes.Buffer{}
+
+	_ = json.NewEncoder(aencode).Encode(a)
+	_ = json.NewEncoder(bencode).Encode(b)
+
+	return aencode.String() == bencode.String()
+})
+
 func (m manager) isUpgrade(deployedRelease *rpb.Release) bool {
 	if deployedRelease == nil {
 		return false
@@ -143,8 +156,9 @@ func (m manager) isUpgrade(deployedRelease *rpb.Release) bool {
 	// Judging whether to skip updates
 	skip := m.namespace == deployedRelease.Namespace
 	skip = skip && m.releaseName == deployedRelease.Name
-	skip = skip && apiequality.Semantic.DeepEqual(m.chart, deployedRelease.Chart)
-	skip = skip && apiequality.Semantic.DeepEqual(m.values, deployedRelease.Config)
+
+	skip = skip && equalities.DeepEqual(m.chart, deployedRelease.Chart)
+	skip = skip && equalities.DeepEqual(m.values, deployedRelease.Config)
 
 	return !skip
 }

Diff for: internal/helm/release/manager_test.go

@@ -15,6 +15,8 @@
 package release
 
 import (
+	"bytes"
+	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -247,11 +249,20 @@ func TestManagerisUpgrade(t *testing.T) {
 			name:            "different values",
 			releaseName:     "deployed",
 			releaseNs:       "deployed-ns",
-			values:          map[string]interface{}{"key": "1"},
+			values:          map[string]interface{}{"key": "1", "int": int32(1)},
 			chart:           newTestChart(t, "./testdata/simple"),
-			deployedRelease: newTestRelease(newTestChart(t, "./testdata/simple"), map[string]interface{}{"key": ""}, "deployed", "deployed-ns"),
+			deployedRelease: newTestRelease(newTestChart(t, "./testdata/simple"), map[string]interface{}{"key": "", "int": int64(1)}, "deployed", "deployed-ns"),
 			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,
+		},
 	}
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
@@ -277,9 +288,12 @@ func newTestRelease(chart *cpb.Chart, values map[string]interface{}, name, names
 	release := rpb.Mock(&rpb.MockReleaseOptions{
 		Name:      name,
 		Namespace: namespace,
-		Chart:     chart,
 		Version:   1,
 	})
+
+	buffer := &bytes.Buffer{}
+	_ = json.NewEncoder(buffer).Encode(chart)
+	_ = json.NewDecoder(buffer).Decode(release.Chart)
 	release.Config = values
 	return release
 }