Add test cases for Summarize() and DetermineReleaseState()

Signed-off-by: Soule BA <[email protected]>

api/v2/helmrelease_types.go

@@ -936,7 +936,7 @@ type HelmReleaseStatus struct {
 	// ObservedPostRenderersDigest is the digest for the post-renderers of
 	// the last successful reconciliation attempt.
 	// +optional
-	ObservedPostRenderersDigest string `json:"ObservedPostRenderersDigest,omitempty"`
+	ObservedPostRenderersDigest string `json:"observedPostRenderersDigest,omitempty"`
 
 	// LastAttemptedGeneration is the last generation the controller attempted
 	// to reconcile.

api/v2beta1/helmrelease_types.go

@@ -878,7 +878,7 @@ type HelmReleaseStatus struct {
 	// ObservedPostRenderersDigest is the digest for the post-renderers of
 	// the last successful reconciliation attempt.
 	// +optional
-	ObservedPostRenderersDigest string `json:"ObservedPostRenderersDigest,omitempty"`
+	ObservedPostRenderersDigest string `json:"observedPostRenderersDigest,omitempty"`
 
 	meta.ReconcileRequestStatus `json:",inline"`
 

api/v2beta2/helmrelease_types.go

@@ -956,7 +956,7 @@ type HelmReleaseStatus struct {
 	// ObservedPostRenderersDigest is the digest for the post-renderers of
 	// the last successful reconciliation attempt.
 	// +optional
-	ObservedPostRenderersDigest string `json:"ObservedPostRenderersDigest,omitempty"`
+	ObservedPostRenderersDigest string `json:"observedPostRenderersDigest,omitempty"`
 
 	// LastAttemptedGeneration is the last generation the controller attempted
 	// to reconcile.

config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml

@@ -906,11 +906,6 @@ spec:
               observedGeneration: -1
             description: HelmReleaseStatus defines the observed state of a HelmRelease.
             properties:
-              ObservedPostRenderersDigest:
-                description: |-
-                  ObservedPostRenderersDigest is the digest for the post-renderers of
-                  the last successful reconciliation attempt.
-                type: string
               conditions:
                 description: Conditions holds the conditions for the HelmRelease.
                 items:
@@ -1165,6 +1160,11 @@ spec:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
                 type: integer
+              observedPostRenderersDigest:
+                description: |-
+                  ObservedPostRenderersDigest is the digest for the post-renderers of
+                  the last successful reconciliation attempt.
+                type: string
               storageNamespace:
                 description: |-
                   StorageNamespace is the namespace of the Helm release storage for the
@@ -2129,11 +2129,6 @@ spec:
               observedGeneration: -1
             description: HelmReleaseStatus defines the observed state of a HelmRelease.
             properties:
-              ObservedPostRenderersDigest:
-                description: |-
-                  ObservedPostRenderersDigest is the digest for the post-renderers of
-                  the last successful reconciliation attempt.
-                type: string
               conditions:
                 description: Conditions holds the conditions for the HelmRelease.
                 items:
@@ -2404,6 +2399,11 @@ spec:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
                 type: integer
+              observedPostRenderersDigest:
+                description: |-
+                  ObservedPostRenderersDigest is the digest for the post-renderers of
+                  the last successful reconciliation attempt.
+                type: string
               storageNamespace:
                 description: |-
                   StorageNamespace is the namespace of the Helm release storage for the
@@ -3427,11 +3427,6 @@ spec:
               observedGeneration: -1
             description: HelmReleaseStatus defines the observed state of a HelmRelease.
             properties:
-              ObservedPostRenderersDigest:
-                description: |-
-                  ObservedPostRenderersDigest is the digest for the post-renderers of
-                  the last successful reconciliation attempt.
-                type: string
               conditions:
                 description: Conditions holds the conditions for the HelmRelease.
                 items:
@@ -3692,6 +3687,11 @@ spec:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
                 type: integer
+              observedPostRenderersDigest:
+                description: |-
+                  ObservedPostRenderersDigest is the digest for the post-renderers of
+                  the last successful reconciliation attempt.
+                type: string
               storageNamespace:
                 description: |-
                   StorageNamespace is the namespace of the Helm release storage for the

docs/api/v2/helm.md

@@ -1434,7 +1434,7 @@ int64
 </tr>
 <tr>
 <td>
-<code>ObservedPostRenderersDigest</code><br>
+<code>observedPostRenderersDigest</code><br>
 <em>
 string
 </em>

docs/spec/v2/helmreleases.md

@@ -1666,14 +1666,14 @@ The helm-controller reports an observed generation in the HelmRelease's
 `.metadata.generation` which resulted in either a [ready state](#ready-helmrelease),
 or stalled due to error it can not recover from without human intervention.
 
-### Oberved Post Renderers Digest
+### Observed Post Renderers Digest
 
 The helm-controller reports the digest for the [post renderers](#post-renderers)
 it last rendered the Helm chart with in the for a successful Helm install or
-upgrade in the `.status.ObervedPostRenderersDigest` field.
+upgrade in the `.status.observedPostRenderersDigest` field.
 
 This field is used by the controller to determine if a deployed Helm release
-is in sync with the HelmRelease `spec.PostRenderers` configuration and whether
+is in sync with the HelmRelease `spec.postRenderers` configuration and whether
 it should trigger a Helm upgrade.
 
 ### Last Attempted Config Digest
@@ -1685,7 +1685,6 @@ attempted to perform a Helm install or upgrade with in the
 The digest is used to determine if the controller should reset the
 [failure counters](#failure-counters) due to a change in the values.
 
-
 ### Last Attempted Revision
 
 The helm-controller reports the revision of the Helm chart it last attempted

internal/controller/helmrelease_controller.go

@@ -353,11 +353,13 @@ func (r *HelmReleaseReconciler) reconcileRelease(ctx context.Context, patchHelpe
 		conditions.MarkUnknown(obj, meta.ReadyCondition, meta.ProgressingReason, "reconciliation in progress")
 	}
 
-	// Attempt to adopt "legacy" v2beta1 release state on a best-effort basis.
-	// If this fails, the controller will fall back to performing an upgrade
-	// to settle on the desired state.
-	// TODO(hidde): remove this in a future release.
+	// Keep feature flagged code paths separate from the main reconciliation
+	// logic to ensure easy removal when the feature flag is removed.
 	if ok, _ := features.Enabled(features.AdoptLegacyReleases); ok {
+		// Attempt to adopt "legacy" v2beta1 release state on a best-effort basis.
+		// If this fails, the controller will fall back to performing an upgrade
+		// to settle on the desired state.
+		// TODO(hidde): remove this in a future release.
 		if err := r.adoptLegacyRelease(ctx, getter, obj); err != nil {
 			log.Error(err, "failed to adopt v2beta1 release state")
 		}

internal/controller/helmrelease_controller_test.go

@@ -1197,9 +1197,6 @@ func TestHelmReleaseReconciler_reconcileReleaseFromHelmChartSource(t *testing.T)
 		chartMock := testutil.BuildChart()
 		chartArtifact, err := testutil.SaveChartAsArtifact(chartMock, digest.SHA256, testServer.URL(), testServer.Root())
 		g.Expect(err).ToNot(HaveOccurred())
-		// copy the artifact to mutate the revision
-		ociArtifact := chartArtifact.DeepCopy()
-		ociArtifact.Revision += "@" + chartArtifact.Digest
 
 		ns, err := testEnv.CreateNamespace(context.TODO(), "mock")
 		g.Expect(err).ToNot(HaveOccurred())

internal/postrender/build.go

@@ -19,10 +19,10 @@ package postrender
 import (
 	"encoding/json"
 
+	"github.com/opencontainers/go-digest"
 	helmpostrender "helm.sh/helm/v3/pkg/postrender"
 
 	v2 "github.com/fluxcd/helm-controller/api/v2"
-	"github.com/opencontainers/go-digest"
 )
 
 // BuildPostRenderers creates the post-renderer instances from a HelmRelease

internal/reconcile/release.go

@@ -192,10 +192,12 @@ func summarize(req *Request) {
 	})
 
 	// remove stale post-renderers digest
-	req.Object.Status.ObservedPostRenderersDigest = ""
-	if req.Object.Spec.PostRenderers != nil {
-		// Update the post-renderers digest if the post-renderers exist.
-		req.Object.Status.ObservedPostRenderersDigest = postrender.Digest(digest.Canonical, req.Object.Spec.PostRenderers).String()
+	if conditions.Get(req.Object, meta.ReadyCondition).Status == metav1.ConditionTrue {
+		req.Object.Status.ObservedPostRenderersDigest = ""
+		if req.Object.Spec.PostRenderers != nil {
+			// Update the post-renderers digest if the post-renderers exist.
+			req.Object.Status.ObservedPostRenderersDigest = postrender.Digest(digest.Canonical, req.Object.Spec.PostRenderers).String()
+		}
 	}
 }