Track action in snapshots

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>

Author: matheuscscp

api/v2/helmrelease_types.go

@@ -1195,6 +1195,12 @@ const (
 	ReleaseActionInstall ReleaseAction = "install"
 	// ReleaseActionUpgrade represents a Helm upgrade action.
 	ReleaseActionUpgrade ReleaseAction = "upgrade"
+	// ReleaseActionRollback represents a Helm rollback action.
+	ReleaseActionRollback ReleaseAction = "rollback"
+	// ReleaseActionUninstall represents a Helm uninstall action.
+	ReleaseActionUninstall ReleaseAction = "uninstall"
+	// ReleaseActionUninstallRemediation represents a Helm uninstall action for remediation.
+	ReleaseActionUninstallRemediation ReleaseAction = "uninstall-remediation"
 )
 
 // HelmReleaseStatus defines the observed state of a HelmRelease.

api/v2/snapshot_types.go

@@ -135,8 +135,8 @@ func (in *Snapshots) TruncateIgnoringPreviousSnapshots() {
 // as managed by the controller.
 type Snapshot struct {
 	// APIVersion is the API version of the Snapshot.
-	// Provisional: when the calculation method of the Digest field is changed,
-	// this field will be used to distinguish between the old and new methods.
+	// When the calculation method of the Digest field is changed, this
+	// field will be used to distinguish between the old and new methods.
 	// +optional
 	APIVersion string `json:"apiVersion,omitempty"`
 	// Digest is the checksum of the release object in storage.
@@ -155,6 +155,9 @@ type Snapshot struct {
 	// Status is the current state of the release.
 	// +required
 	Status string `json:"status"`
+	// Action is the action that resulted in this snapshot being created.
+	// +optional
+	Action ReleaseAction `json:"action,omitempty"`
 	// ChartName is the chart name of the release object in storage.
 	// +required
 	ChartName string `json:"chartName"`
@@ -248,6 +251,14 @@ func (in *Snapshot) Targets(name, namespace string, version int) bool {
 	return false
 }
 
+// GetAction returns the ReleaseAction for the Snapshot.
+func (in *Snapshot) GetAction() ReleaseAction {
+	if in == nil {
+		return ""
+	}
+	return in.Action
+}
+
 // TestHookStatus holds the status information for a test hook as observed
 // to be run by the controller.
 type TestHookStatus struct {

api/v2/snapshot_types_test.go

@@ -297,6 +297,57 @@ func TestSnapshots_Truncate(t *testing.T) {
 	}
 }
 
+func TestSnapshot_GetAction(t *testing.T) {
+	tests := []struct {
+		name     string
+		snapshot *Snapshot
+		want     ReleaseAction
+	}{
+		{
+			name:     "nil snapshot",
+			snapshot: nil,
+			want:     "",
+		},
+		{
+			name:     "empty action",
+			snapshot: &Snapshot{},
+			want:     "",
+		},
+		{
+			name:     "install action",
+			snapshot: &Snapshot{Action: ReleaseActionInstall},
+			want:     ReleaseActionInstall,
+		},
+		{
+			name:     "upgrade action",
+			snapshot: &Snapshot{Action: ReleaseActionUpgrade},
+			want:     ReleaseActionUpgrade,
+		},
+		{
+			name:     "rollback action",
+			snapshot: &Snapshot{Action: ReleaseActionRollback},
+			want:     ReleaseActionRollback,
+		},
+		{
+			name:     "uninstall action",
+			snapshot: &Snapshot{Action: ReleaseActionUninstall},
+			want:     ReleaseActionUninstall,
+		},
+		{
+			name:     "uninstall-remediation action",
+			snapshot: &Snapshot{Action: ReleaseActionUninstallRemediation},
+			want:     ReleaseActionUninstallRemediation,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.snapshot.GetAction(); got != tt.want {
+				t.Errorf("GetAction() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
 func TestSnapshots_TruncateIgnoringPreviousSnapshots(t *testing.T) {
 	tests := []struct {
 		name string

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

@@ -1203,11 +1203,15 @@ spec:
                     Snapshot captures a point-in-time copy of the status information for a Helm release,
                     as managed by the controller.
                   properties:
+                    action:
+                      description: Action is the action that resulted in this snapshot
+                        being created.
+                      type: string
                     apiVersion:
                       description: |-
                         APIVersion is the API version of the Snapshot.
-                        Provisional: when the calculation method of the Digest field is changed,
-                        this field will be used to distinguish between the old and new methods.
+                        When the calculation method of the Digest field is changed, this
+                        field will be used to distinguish between the old and new methods.
                       type: string
                     appVersion:
                       description: AppVersion is the chart app version of the release
@@ -2550,11 +2554,15 @@ spec:
                     Snapshot captures a point-in-time copy of the status information for a Helm release,
                     as managed by the controller.
                   properties:
+                    action:
+                      description: Action is the action that resulted in this snapshot
+                        being created.
+                      type: string
                     apiVersion:
                       description: |-
                         APIVersion is the API version of the Snapshot.
-                        Provisional: when the calculation method of the Digest field is changed,
-                        this field will be used to distinguish between the old and new methods.
+                        When the calculation method of the Digest field is changed, this
+                        field will be used to distinguish between the old and new methods.
                       type: string
                     appVersion:
                       description: AppVersion is the chart app version of the release

docs/api/v2/helm.md

@@ -2408,7 +2408,8 @@ Kustomize
 (<code>string</code> alias)</h3>
 <p>
 (<em>Appears on:</em>
-<a href="#helm.toolkit.fluxcd.io/v2.HelmReleaseStatus">HelmReleaseStatus</a>)
+<a href="#helm.toolkit.fluxcd.io/v2.HelmReleaseStatus">HelmReleaseStatus</a>, 
+<a href="#helm.toolkit.fluxcd.io/v2.Snapshot">Snapshot</a>)
 </p>
 <p>ReleaseAction is the action to perform a Helm release.</p>
 <h3 id="helm.toolkit.fluxcd.io/v2.Remediation">Remediation
@@ -2676,8 +2677,8 @@ string
 <td>
 <em>(Optional)</em>
 <p>APIVersion is the API version of the Snapshot.
-Provisional: when the calculation method of the Digest field is changed,
-this field will be used to distinguish between the old and new methods.</p>
+When the calculation method of the Digest field is changed, this
+field will be used to distinguish between the old and new methods.</p>
 </td>
 </tr>
 <tr>
@@ -2738,6 +2739,20 @@ string
 </tr>
 <tr>
 <td>
+<code>action</code><br>
+<em>
+<a href="#helm.toolkit.fluxcd.io/v2.ReleaseAction">
+ReleaseAction
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Action is the action that resulted in this snapshot being created.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>chartName</code><br>
 <em>
 string

docs/spec/v2/helmreleases.md

@@ -1954,6 +1954,7 @@ status:
       namespace: podinfo
       ociDigest: sha256:0cc9a8446c95009ef382f5eade883a67c257f77d50f84e78ecef2aac9428d1e5
       status: deployed
+      action: upgrade
       testHooks:
         podinfo-grpc-test-goyey:
           lastCompleted: "2024-05-07T04:55:11Z"
@@ -1971,6 +1972,7 @@ status:
       namespace: podinfo
       ociDigest: sha256:cdd538a0167e4b51152b71a477e51eb6737553510ce8797dbcc537e1342311bb
       status: superseded
+      action: install
       testHooks:
         podinfo-grpc-test-q0ucx:
           lastCompleted: "2024-05-07T04:54:25Z"

internal/reconcile/install.go

@@ -96,7 +96,9 @@ func (r *Install) Reconcile(ctx context.Context, req *Request) error {
 	req.Object.Status.LastAttemptedReleaseActionDuration = &metav1.Duration{Duration: time.Since(startTime)}
 
 	// Record the history of releases observed during the install.
-	obsReleases.recordOnObject(req.Object, mutateOCIDigest)
+	obsReleases.recordOnObject(req.Object,
+		mutateOCIDigest,
+		mutateAction(v2.ReleaseActionInstall))
 
 	if err != nil {
 		r.failure(req, logBuf, err)

internal/reconcile/install_test.go

@@ -100,7 +100,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[0])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 			expectInventory: func(namespace string) *v2.ResourceInventory {
@@ -125,7 +129,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[0])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 			expectFailures:        1,
@@ -184,7 +192,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[1])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[1])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 		},
@@ -212,7 +224,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[0])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 		},
@@ -235,7 +251,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[0])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 		},
@@ -251,7 +271,11 @@ func TestInstall_Reconcile(t *testing.T) {
 			},
 			expectHistory: func(releases []*helmrelease.Release) v2.Snapshots {
 				return v2.Snapshots{
-					release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+					func() *v2.Snapshot {
+						obs := release.ObserveRelease(releases[0])
+						obs.Action = v2.ReleaseActionInstall
+						return release.ObservedToSnapshot(obs)
+					}(),
 				}
 			},
 			expectInventory: func(namespace string) *v2.ResourceInventory {
@@ -374,8 +398,10 @@ func TestInstall_Reconcile_withSubchartWithCRDs(t *testing.T) {
 	}
 
 	expectHistory := func(releases []*helmrelease.Release) v2.Snapshots {
+		obs := release.ObserveRelease(releases[0])
+		obs.Action = v2.ReleaseActionInstall
 		return v2.Snapshots{
-			release.ObservedToSnapshot(release.ObserveRelease(releases[0])),
+			release.ObservedToSnapshot(obs),
 		}
 	}
 

internal/reconcile/release.go

@@ -113,9 +113,19 @@ func mutateOCIDigest(obj *v2.HelmRelease, obs release.Observation) release.Obser
 	return obs
 }
 
-func releaseToObservation(rls *helmreleasev1.Release, snapshot *v2.Snapshot) release.Observation {
+func mutateAction(action v2.ReleaseAction) func(obj *v2.HelmRelease, obs release.Observation) release.Observation {
+	return func(obj *v2.HelmRelease, obs release.Observation) release.Observation {
+		obs.Action = action
+		return obs
+	}
+}
+
+func releaseToObservation(rls *helmreleasev1.Release,
+	snapshot *v2.Snapshot, action v2.ReleaseAction) release.Observation {
+
 	obs := release.ObserveRelease(rls)
 	obs.OCIDigest = snapshot.OCIDigest
+	obs.Action = action
 	return obs
 }