additional sample

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Author: csviri

docs/content/en/docs/documentation/reconciler.md

@@ -211,7 +211,7 @@ updated via `PrimaryUpdateAndCacheUtils`.
 
 See related integration test [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache).
 
-### Trigger reconciliation even for `Delete` events
+### Trigger reconciliation for all events
 
 TLDR; We provide an execution mode where `reconcile` method is called on every event from event source.
 
@@ -258,3 +258,4 @@ In this mode:
 - you cannot use managed dependent resources since those manage the finalizers and other logic related to the normal
   execution mode.
 
+See also [sample](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/finalizerhandling) for selectively adding finalizers for resources;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/PrimaryUpdateAndCacheUtils.java

@@ -241,25 +241,28 @@ private static <P extends HasMetadata> P pollLocalCache(
    * Adds finalizer to the primary resource from the context using JSON Patch. Retries conflicts and
    * unprocessable content (HTTP 422), see {@link
    * PrimaryUpdateAndCacheUtils#conflictRetryingPatch(KubernetesClient, HasMetadata, UnaryOperator,
-   * Predicate)} for details on retry.
+   * Predicate)} for details on retry. It does not add finalizer if there is already a finalizer or
+   * resource is marked for deletion.
    *
    * @return updated resource from the server response
    */
-  @SuppressWarnings("unchecked")
   public static <P extends HasMetadata> P addFinalizer(Context<P> context, String finalizer) {
     return addFinalizer(context.getClient(), context.getPrimaryResource(), finalizer);
   }
 
   /**
    * Adds finalizer to the resource using JSON Patch. Retries conflicts and unprocessable content
    * (HTTP 422), see {@link PrimaryUpdateAndCacheUtils#conflictRetryingPatch(KubernetesClient,
-   * HasMetadata, UnaryOperator, Predicate)} for details on retry.
+   * HasMetadata, UnaryOperator, Predicate)} for details on retry. It does not try to add finalizer
+   * if there is already a finalizer or resource is marked for deletion.
    *
    * @return updated resource from the server response
    */
-  @SuppressWarnings("unchecked")
   public static <P extends HasMetadata> P addFinalizer(
       KubernetesClient client, P resource, String finalizerName) {
+    if (resource.isMarkedForDeletion() || resource.hasFinalizer(finalizerName)) {
+      return resource;
+    }
     return conflictRetryingPatch(
         client,
         resource,
@@ -273,7 +276,8 @@ public static <P extends HasMetadata> P addFinalizer(
   /**
    * Removes the target finalizer from the primary resource from the Context. Uses JSON Patch and
    * handles retries, see {@link PrimaryUpdateAndCacheUtils#conflictRetryingPatch(KubernetesClient,
-   * HasMetadata, UnaryOperator, Predicate)} for details.
+   * HasMetadata, UnaryOperator, Predicate)} for details. It does not try to remove finalizer if
+   * finalizer is not present on the resource.
    *
    * @return updated resource from the server response
    */
@@ -285,12 +289,16 @@ public static <P extends HasMetadata> P removeFinalizer(
   /**
    * Removes the target finalizer from target resource. Uses JSON Patch and handles retries, see
    * {@link PrimaryUpdateAndCacheUtils#conflictRetryingPatch(KubernetesClient, HasMetadata,
-   * UnaryOperator, Predicate)} for details.
+   * UnaryOperator, Predicate)} for details. It does not try to remove finalizer if finalizer is not
+   * present on the resource.
    *
    * @return updated resource from the server response
    */
   public static <P extends HasMetadata> P removeFinalizer(
       KubernetesClient client, P resource, String finalizerName) {
+    if (!resource.hasFinalizer(finalizerName)) {
+      return resource;
+    }
     return conflictRetryingPatch(
         client,
         resource,

…rReconcilerOnAllEventCustomResource.java …rReconcilerOnAllEventCustomResource.javaoperator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventCustomResource.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventCustomResource.java operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventCustomResource.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventCustomResource.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile;
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing;
 
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;

…ncile/TriggerReconcilerOnAllEventIT.java …nting/TriggerReconcilerOnAllEventIT.javaoperator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventIT.java operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventIT.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventIT.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile;
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing;
 
 import java.time.Duration;
 
@@ -9,9 +9,9 @@
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
 import io.javaoperatorsdk.operator.processing.retry.GenericRetry;
 
-import static io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile.TriggerReconcilerOnAllEventReconciler.ADDITIONAL_FINALIZER;
-import static io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile.TriggerReconcilerOnAllEventReconciler.FINALIZER;
-import static io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile.TriggerReconcilerOnAllEventReconciler.NO_MORE_EXCEPTION_ANNOTATION_KEY;
+import static io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing.TriggerReconcilerOnAllEventReconciler.ADDITIONAL_FINALIZER;
+import static io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing.TriggerReconcilerOnAllEventReconciler.FINALIZER;
+import static io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing.TriggerReconcilerOnAllEventReconciler.NO_MORE_EXCEPTION_ANNOTATION_KEY;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 

…iggerReconcilerOnAllEventReconciler.java …iggerReconcilerOnAllEventReconciler.javaoperator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventReconciler.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventReconciler.java operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventReconciler.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventReconciler.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile;
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing;
 
 import java.util.concurrent.atomic.AtomicInteger;
 

…ile/TriggerReconcilerOnAllEventSpec.java …ing/TriggerReconcilerOnAllEventSpec.javaoperator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventSpec.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventSpec.java operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventSpec.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/eventing/TriggerReconcilerOnAllEventSpec.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.triggerallevent.onlyreconcile;
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.eventing;
 
 public class TriggerReconcilerOnAllEventSpec {
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/finalizerhandling/SelectiveFinalizerHandlingIT.java

@@ -0,0 +1,76 @@
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.finalizerhandling;
+
+import java.time.Duration;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+/**
+ * The test showcases how manage finalizers only on some of the custom resources using
+ * `triggerReconcilerOnAllEvent` mode.
+ */
+public class SelectiveFinalizerHandlingIT {
+
+  public static final String TEST_RESOURCE2 = "test2";
+  public static final String TEST_RESOURCE1 = "test1";
+
+  @RegisterExtension
+  LocallyRunOperatorExtension extension =
+      LocallyRunOperatorExtension.builder()
+          .withReconciler(SelectiveFinalizerHandlingReconciler.class)
+          .build();
+
+  @Test
+  void addFinalizerOnlyOnSomeOfTheResources() {
+    var resource1 = extension.create(testResource(TEST_RESOURCE1, true));
+    var resource2 = extension.create(testResource(TEST_RESOURCE2, false));
+
+    await()
+        .pollDelay(Duration.ofMillis(100))
+        .untilAsserted(
+            () -> {
+              var res1 =
+                  extension.get(
+                      SelectiveFinalizerHandlingReconcilerCustomResource.class, TEST_RESOURCE1);
+              var res2 =
+                  extension.get(
+                      SelectiveFinalizerHandlingReconcilerCustomResource.class, TEST_RESOURCE2);
+
+              assertThat(res1.getFinalizers()).isNotEmpty();
+              assertThat(res2.getFinalizers()).isEmpty();
+            });
+
+    extension.delete(resource1);
+    extension.delete(resource2);
+
+    await()
+        .untilAsserted(
+            () -> {
+              var res1 =
+                  extension.get(
+                      SelectiveFinalizerHandlingReconcilerCustomResource.class, TEST_RESOURCE1);
+              var res2 =
+                  extension.get(
+                      SelectiveFinalizerHandlingReconcilerCustomResource.class, TEST_RESOURCE2);
+
+              assertThat(res1).isNull();
+              assertThat(res2).isNull();
+            });
+  }
+
+  SelectiveFinalizerHandlingReconcilerCustomResource testResource(
+      String name, boolean addFinalizer) {
+    var resource = new SelectiveFinalizerHandlingReconcilerCustomResource();
+    resource.setMetadata(new ObjectMetaBuilder().withName(name).build());
+    resource.setSpec(new SelectiveFinalizerHandlingReconcilerSpec());
+    resource.getSpec().setUseFinalizer(addFinalizer);
+
+    return resource;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/finalizerhandling/SelectiveFinalizerHandlingReconciler.java

@@ -0,0 +1,34 @@
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.finalizerhandling;
+
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.PrimaryUpdateAndCacheUtils;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+
+@ControllerConfiguration(triggerReconcilerOnAllEvent = true)
+public class SelectiveFinalizerHandlingReconciler
+    implements Reconciler<SelectiveFinalizerHandlingReconcilerCustomResource> {
+
+  public static final String FINALIZER = "finalizer.test/finalizer";
+
+  @Override
+  public UpdateControl<SelectiveFinalizerHandlingReconcilerCustomResource> reconcile(
+      SelectiveFinalizerHandlingReconcilerCustomResource resource,
+      Context<SelectiveFinalizerHandlingReconcilerCustomResource> context) {
+
+    if (context.isPrimaryResourceDeleted()) {
+      return UpdateControl.noUpdate();
+    }
+
+    if (resource.getSpec().getUseFinalizer()) {
+      PrimaryUpdateAndCacheUtils.addFinalizer(context, FINALIZER);
+    }
+
+    if (resource.isMarkedForDeletion()) {
+      PrimaryUpdateAndCacheUtils.removeFinalizer(context, FINALIZER);
+    }
+
+    return UpdateControl.noUpdate();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/finalizerhandling/SelectiveFinalizerHandlingReconcilerCustomResource.java

@@ -0,0 +1,13 @@
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.finalizerhandling;
+
+import io.fabric8.kubernetes.api.model.Namespaced;
+import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.model.annotation.Group;
+import io.fabric8.kubernetes.model.annotation.ShortNames;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+@ShortNames("saf")
+public class SelectiveFinalizerHandlingReconcilerCustomResource
+    extends CustomResource<SelectiveFinalizerHandlingReconcilerSpec, Void> implements Namespaced {}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/finalizerhandling/SelectiveFinalizerHandlingReconcilerSpec.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.baseapi.triggerallevent.finalizerhandling;
+
+public class SelectiveFinalizerHandlingReconcilerSpec {
+
+  private Boolean useFinalizer;
+
+  public Boolean getUseFinalizer() {
+    return useFinalizer;
+  }
+
+  public void setUseFinalizer(Boolean useFinalizer) {
+    this.useFinalizer = useFinalizer;
+  }
+}