fix(engine): correctly set prune confirmation message in setRunningPhase

setRunningPhase was overwriting the message when it receives an empty
list of tasks while we were setting the message before setRunningPhase
was called which broke the prune confirmation message since commit
95d19f2.

This moves the message logic in setRunningPhase with the rest of the message
logic and remove the tasks filtering when the sync is pending to allow
retrieving the pruning tasks and construct the message indicating to
wait for pruning confirmation.

Also add a unit test covering this recently broken behavior

Signed-off-by: Arthur Outhenin-Chalandre <arthur.outhenin-chalandre@ledger.fr>

Author: MrFreezeex

gitops-engine/pkg/sync/sync_context.go

@@ -397,6 +397,26 @@ func (sc *syncContext) setRunningPhase(tasks syncTasks, isPendingDeletion bool)
 		return
 	}
 
+	{
+		// Check for prune tasks pending confirmation
+		if !sc.pruneConfirmed {
+			var resources []string
+			for _, task := range tasks {
+				if task.isPrune() && resourceutil.HasAnnotationOption(task.liveObj, common.AnnotationSyncOptions, common.SyncOptionPruneRequireConfirm) {
+					resources = append(resources, fmt.Sprintf("%s/%s/%s", task.obj().GetAPIVersion(), task.obj().GetKind(), task.name()))
+				}
+			}
+			if len(resources) > 0 {
+				andMessage := ""
+				if len(resources) > 1 {
+					andMessage = fmt.Sprintf(" and %d more resources", len(resources)-1)
+				}
+				sc.setOperationPhase(common.OperationRunning, fmt.Sprintf("Waiting for pruning confirmation of %s%s", resources[0], andMessage))
+				return
+			}
+		}
+	}
+
 	hooks, resources := tasks.Split(func(task *syncTask) bool { return task.isHook() })
 
 	reason := "completion of hook"
@@ -1487,20 +1507,11 @@ func (sc *syncContext) runTasks(tasks syncTasks, dryRun bool) runState {
 	// prune first
 	{
 		if !sc.pruneConfirmed {
-			var resources []string
 			for _, task := range pruneTasks {
 				if resourceutil.HasAnnotationOption(task.liveObj, common.AnnotationSyncOptions, common.SyncOptionPruneRequireConfirm) {
-					resources = append(resources, fmt.Sprintf("%s/%s/%s", task.obj().GetAPIVersion(), task.obj().GetKind(), task.name()))
-				}
-			}
-			if len(resources) > 0 {
-				sc.log.WithValues("resources", resources).Info("Prune requires confirmation")
-				andMessage := ""
-				if len(resources) > 1 {
-					andMessage = fmt.Sprintf(" and %d more resources", len(resources)-1)
+					sc.log.WithValues("task", task).Info("Prune requires confirmation")
+					return pending
 				}
-				sc.message = fmt.Sprintf("Waiting for pruning confirmation of %s%s", resources[0], andMessage)
-				return pending
 			}
 		}
 

gitops-engine/pkg/sync/sync_context_test.go

@@ -850,6 +850,33 @@ func TestDoNotPrunePruneFalse(t *testing.T) {
 	assert.Equal(t, synccommon.OperationSucceeded, phase)
 }
 
+func TestPruneConfirm(t *testing.T) {
+	syncCtx := newTestSyncCtx(nil, WithOperationSettings(false, true, false, false))
+	pod := testingutils.NewPod()
+	pod.SetAnnotations(map[string]string{synccommon.AnnotationSyncOptions: "Prune=confirm"})
+	pod.SetNamespace(testingutils.FakeArgoCDNamespace)
+	syncCtx.resources = groupResources(ReconciliationResult{
+		Live:   []*unstructured.Unstructured{pod},
+		Target: []*unstructured.Unstructured{nil},
+	})
+
+	syncCtx.Sync()
+	phase, msg, resources := syncCtx.GetState()
+
+	assert.Equal(t, synccommon.OperationRunning, phase)
+	assert.Empty(t, resources)
+	assert.Equal(t, "Waiting for pruning confirmation of v1/Pod/my-pod", msg)
+
+	syncCtx.pruneConfirmed = true
+	syncCtx.Sync()
+
+	phase, _, resources = syncCtx.GetState()
+	assert.Equal(t, synccommon.OperationSucceeded, phase)
+	assert.Len(t, resources, 1)
+	assert.Equal(t, synccommon.ResultCodePruned, resources[0].Status)
+	assert.Equal(t, "pruned", resources[0].Message)
+}
+
 // // make sure Validate=false means we don't validate
 func TestSyncOptionValidate(t *testing.T) {
 	tests := []struct {