feat: add WithPruneDisabled to syncoption

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

Author: MrFreezeex

pkg/sync/sync_context.go

@@ -129,6 +129,13 @@ func WithPruneConfirmed(confirmed bool) SyncOpt {
 	}
 }
 
+// WithPruneDisabled specifies if prune is globally disabled for this application
+func WithPruneDisabled(disabled bool) SyncOpt {
+	return func(ctx *syncContext) {
+		ctx.pruneDisabled = disabled
+	}
+}
+
 // WithOperationSettings allows to set sync operation settings
 func WithOperationSettings(dryRun bool, prune bool, force bool, skipHooks bool) SyncOpt {
 	return func(ctx *syncContext) {
@@ -375,6 +382,7 @@ type syncContext struct {
 	prunePropagationPolicy          *metav1.DeletionPropagation
 	pruneConfirmed                  bool
 	requiresPruneConfirmation       bool
+	pruneDisabled                   bool
 	clientSideApplyMigrationManager string
 	enableClientSideApplyMigration  bool
 
@@ -1220,7 +1228,7 @@ func (sc *syncContext) applyObject(t *syncTask, dryRun, validate bool) (common.R
 func (sc *syncContext) pruneObject(liveObj *unstructured.Unstructured, prune, dryRun bool) (common.ResultCode, string) {
 	if !prune {
 		return common.ResultCodePruneSkipped, "ignored (requires pruning)"
-	} else if resourceutil.HasAnnotationOption(liveObj, common.AnnotationSyncOptions, common.SyncOptionDisablePrune) {
+	} else if resourceutil.HasAnnotationOption(liveObj, common.AnnotationSyncOptions, common.SyncOptionDisablePrune) || sc.pruneDisabled {
 		return common.ResultCodePruneSkipped, "ignored (no prune)"
 	}
 	if dryRun {

pkg/sync/sync_context_test.go

@@ -767,6 +767,23 @@ func TestDoNotPrunePruneFalse(t *testing.T) {
 
 	phase, _, _ = syncCtx.GetState()
 	assert.Equal(t, synccommon.OperationSucceeded, phase)
+
+	// test that we can still not prune if prune is disabled on the app level
+	syncCtx.pruneDisabled = true
+	pod.SetAnnotations(map[string]string{synccommon.AnnotationSyncOptions: "Prune=true"})
+	syncCtx.Sync()
+
+	phase, _, resources = syncCtx.GetState()
+
+	assert.Equal(t, synccommon.OperationSucceeded, phase)
+	assert.Len(t, resources, 1)
+	assert.Equal(t, synccommon.ResultCodePruneSkipped, resources[0].Status)
+	assert.Equal(t, "ignored (no prune)", resources[0].Message)
+
+	syncCtx.Sync()
+
+	phase, _, _ = syncCtx.GetState()
+	assert.Equal(t, synccommon.OperationSucceeded, phase)
 }
 
 // make sure that we need confirmation to prune resources with Prune=confirm