create constant for automatic rollback reason

Author: pchila

internal/pkg/agent/application/upgrade/details/details_test.go

@@ -35,9 +35,9 @@ func TestDetailsSetStateWithReason(t *testing.T) {
 	det := NewDetails("99.999.9999", StateWatching, "test_action_id")
 	require.Equal(t, StateWatching, det.State)
 
-	det.SetStateWithReason(StateRollback, "automatic rollback")
+	det.SetStateWithReason(StateRollback, ReasonWatchFailed)
 	assert.Equal(t, StateRollback, det.State)
-	assert.Equal(t, "automatic rollback", det.Metadata.Reason)
+	assert.Equal(t, ReasonWatchFailed, det.Metadata.Reason)
 }
 
 func TestDetailsFail(t *testing.T) {

internal/pkg/agent/application/upgrade/details/state.go

@@ -6,9 +6,9 @@ package details
 
 type State string
 
-// The values of these State* constants should match those enumerated for
-// upgrade_details.state in https://github.com/elastic/fleet-server/blob/main/model/openapi.yml
 const (
+	// The values of these State* constants should match those enumerated for
+	// upgrade_details.state in https://github.com/elastic/fleet-server/blob/main/model/openapi.yml
 	StateRequested   State = "UPG_REQUESTED"
 	StateScheduled   State = "UPG_SCHEDULED"
 	StateDownloading State = "UPG_DOWNLOADING"
@@ -19,4 +19,7 @@ const (
 	StateRollback    State = "UPG_ROLLBACK"
 	StateCompleted   State = "UPG_COMPLETED"
 	StateFailed      State = "UPG_FAILED"
+
+	// List of well-known reasons for state transitions
+	ReasonWatchFailed = "watch failed"
 )

internal/pkg/agent/application/upgrade/marker_watcher.go

@@ -146,7 +146,7 @@ func (mfw *MarkerFileWatcher) processMarker(currentVersion string, commit string
 		if marker.Details == nil {
 			marker.Details = details.NewDetails("unknown", details.StateRollback, marker.GetActionID())
 		} else if marker.Details.State == "" {
-			marker.Details.SetStateWithReason(details.StateRollback, "automatic rollback")
+			marker.Details.SetStateWithReason(details.StateRollback, details.ReasonWatchFailed)
 		}
 	}
 

internal/pkg/agent/cmd/watch.go

@@ -132,7 +132,7 @@ func watchCmd(log *logp.Logger, topDir string, cfg *configuration.UpgradeWatcher
 	if err := watcher.Watch(ctx, tilGrace, errorCheckInterval, log); err != nil {
 		log.Error("Error detected, proceeding to rollback: %v", err)
 
-		upgradeDetails.SetStateWithReason(details.StateRollback, "automatic rollback")
+		upgradeDetails.SetStateWithReason(details.StateRollback, details.ReasonWatchFailed)
 		err = installModifier.Rollback(ctx, log, client.New(), paths.Top(), marker.PrevVersionedHome, marker.PrevHash)
 		if err != nil {
 			log.Error("rollback failed", err)

internal/pkg/agent/cmd/watch_test.go

@@ -207,7 +207,7 @@ func Test_watchCmd(t *testing.T) {
 							TargetVersion: "4.5.6",
 							State:         details.StateRollback,
 							Metadata: details.Metadata{
-								Reason: "automatic rollback",
+								Reason: details.ReasonWatchFailed,
 							},
 						},
 						DesiredOutcome: upgrade.OUTCOME_UPGRADE,

testing/integration/ess/upgrade_rollback_test.go

@@ -145,7 +145,7 @@ inputs:
 
 			assert.Equal(t, details.StateRollback, details.State(state.UpgradeDetails.State))
 			if !startVersion.Less(*upgradetest.Version_9_1_0_SNAPSHOT) {
-				assert.Equal(t, "automatic rollback", state.UpgradeDetails.Metadata.Reason)
+				assert.Equal(t, details.ReasonWatchFailed, state.UpgradeDetails.Metadata.Reason)
 			}
 		} else {
 			t.Logf("rollback finished, status is '%s', cannot check UpgradeDetails", state.State.String())
@@ -387,7 +387,7 @@ func managedRollbackRestartTest(ctx context.Context, t *testing.T, info *define.
 		require.NotNil(t, fleetAgent.UpgradeDetails, "upgrade details not set")
 		assert.Equal(t, details.StateRollback, details.State(fleetAgent.UpgradeDetails.State))
 		if !startVersion.Less(*upgradetest.Version_9_1_0_SNAPSHOT) {
-			assert.Equal(t, "automatic rollback", fleetAgent.UpgradeDetails.Metadata.Reason)
+			assert.Equal(t, details.ReasonWatchFailed, fleetAgent.UpgradeDetails.Metadata.Reason)
 		}
 	}
 
@@ -462,7 +462,7 @@ func standaloneRollbackRestartTest(ctx context.Context, t *testing.T, startFixtu
 		require.NotNil(t, state.UpgradeDetails)
 		assert.Equal(t, details.StateRollback, details.State(state.UpgradeDetails.State))
 		if !startVersion.Less(*upgradetest.Version_9_1_0_SNAPSHOT) {
-			assert.Equal(t, "automatic rollback", state.UpgradeDetails.Metadata.Reason)
+			assert.Equal(t, details.ReasonWatchFailed, state.UpgradeDetails.Metadata.Reason)
 		}
 	}