fix: use finalizer and deletion marker methods from HasMetadata

Fixes #317

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

@@ -1,6 +1,5 @@
 package io.javaoperatorsdk.operator;
 
-import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.api.Controller;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import java.util.Locale;
@@ -13,11 +12,6 @@ public static String getDefaultFinalizerName(String crdName) {
     return crdName + FINALIZER_NAME_SUFFIX;
   }
 
-  public static boolean hasGivenFinalizer(CustomResource resource, String finalizer) {
-    return resource.getMetadata().getFinalizers() != null
-        && resource.getMetadata().getFinalizers().contains(finalizer);
-  }
-
   public static String getNameFor(Class<? extends ResourceController> controllerClass) {
     // if the controller annotation has a name attribute, use it
     final var annotation = controllerClass.getAnnotation(Controller.class);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java

@@ -3,21 +3,18 @@
 import static io.javaoperatorsdk.operator.EventListUtils.containsCustomResourceDeletedEvent;
 import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getUID;
 import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getVersion;
-import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.markedForDeletion;
 
 import io.fabric8.kubernetes.api.model.KubernetesResourceList;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
-import io.javaoperatorsdk.operator.ControllerUtils;
 import io.javaoperatorsdk.operator.api.Context;
 import io.javaoperatorsdk.operator.api.DefaultContext;
 import io.javaoperatorsdk.operator.api.DeleteControl;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.UpdateControl;
 import io.javaoperatorsdk.operator.processing.event.EventList;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
-import java.util.ArrayList;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -65,8 +62,7 @@ private PostExecutionControl handleDispatch(ExecutionScope executionScope) {
           getVersion(resource));
       return PostExecutionControl.defaultDispatch();
     }
-    if ((markedForDeletion(resource)
-        && !ControllerUtils.hasGivenFinalizer(resource, resourceFinalizer))) {
+    if ((resource.isMarkedForDeletion() && !resource.hasFinalizer(resourceFinalizer))) {
       log.debug(
           "Skipping event dispatching since its marked for deletion but has no finalizer: {}",
           executionScope);
@@ -77,7 +73,7 @@ private PostExecutionControl handleDispatch(ExecutionScope executionScope) {
             eventSourceManager,
             new EventList(executionScope.getEvents()),
             executionScope.getRetryInfo());
-    if (markedForDeletion(resource)) {
+    if (resource.isMarkedForDeletion()) {
       return handleDelete(resource, context);
     } else {
       return handleCreateOrUpdate(executionScope, resource, context);
@@ -86,8 +82,7 @@ private PostExecutionControl handleDispatch(ExecutionScope executionScope) {
 
   private PostExecutionControl handleCreateOrUpdate(
       ExecutionScope executionScope, CustomResource resource, Context context) {
-    if (!ControllerUtils.hasGivenFinalizer(resource, resourceFinalizer)
-        && !markedForDeletion(resource)) {
+    if (!resource.hasFinalizer(resourceFinalizer) && !resource.isMarkedForDeletion()) {
       /*  We always add the finalizer if missing and not marked for deletion.
          We execute the controller processing only for processing the event sent as a results
          of the finalizer add. This will make sure that the resources are not created before
@@ -133,7 +128,7 @@ private PostExecutionControl handleDelete(CustomResource resource, Context conte
         getUID(resource),
         getVersion(resource));
     DeleteControl deleteControl = controller.deleteResource(resource, context);
-    boolean hasFinalizer = ControllerUtils.hasGivenFinalizer(resource, resourceFinalizer);
+    boolean hasFinalizer = resource.hasFinalizer(resourceFinalizer);
     if (deleteControl == DeleteControl.DEFAULT_DELETE && hasFinalizer) {
       CustomResource customResource = removeFinalizer(resource);
       return PostExecutionControl.customResourceUpdated(customResource);
@@ -151,7 +146,7 @@ private PostExecutionControl handleDelete(CustomResource resource, Context conte
   private void updateCustomResourceWithFinalizer(CustomResource resource) {
     log.debug(
         "Adding finalizer for resource: {} version: {}", getUID(resource), getVersion(resource));
-    addFinalizerIfNotPresent(resource);
+    resource.addFinalizer(resourceFinalizer);
     replace(resource);
   }
 
@@ -166,7 +161,7 @@ private CustomResource removeFinalizer(CustomResource resource) {
         "Removing finalizer on resource: {} with version: {}",
         getUID(resource),
         getVersion(resource));
-    resource.getMetadata().getFinalizers().remove(resourceFinalizer);
+    resource.removeFinalizer(resourceFinalizer);
     return customResourceFacade.replaceWithLock(resource);
   }
 
@@ -178,17 +173,6 @@ private CustomResource replace(CustomResource resource) {
     return customResourceFacade.replaceWithLock(resource);
   }
 
-  private void addFinalizerIfNotPresent(CustomResource resource) {
-    if (!ControllerUtils.hasGivenFinalizer(resource, resourceFinalizer)
-        && !markedForDeletion(resource)) {
-      log.info("Adding finalizer to {}", resource.getMetadata());
-      if (resource.getMetadata().getFinalizers() == null) {
-        resource.getMetadata().setFinalizers(new ArrayList<>(1));
-      }
-      resource.getMetadata().getFinalizers().add(resourceFinalizer);
-    }
-  }
-
   // created to support unit testing
   public static class CustomResourceFacade<R extends CustomResource> {
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/KubernetesResourceUtils.java

@@ -1,7 +1,6 @@
 package io.javaoperatorsdk.operator.processing;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.client.CustomResource;
 
 public class KubernetesResourceUtils {
 
@@ -12,9 +11,4 @@ public static String getUID(HasMetadata customResource) {
   public static String getVersion(HasMetadata customResource) {
     return customResource.getMetadata().getResourceVersion();
   }
-
-  public static boolean markedForDeletion(CustomResource resource) {
-    return resource.getMetadata().getDeletionTimestamp() != null
-        && !resource.getMetadata().getDeletionTimestamp().isEmpty();
-  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEventSource.java

@@ -2,14 +2,12 @@
 
 import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getUID;
 import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getVersion;
-import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.markedForDeletion;
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.Watcher;
 import io.fabric8.kubernetes.client.WatcherException;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.internal.CustomResourceOperationsImpl;
-import io.javaoperatorsdk.operator.ControllerUtils;
 import io.javaoperatorsdk.operator.processing.CustomResourceCache;
 import io.javaoperatorsdk.operator.processing.KubernetesResourceUtils;
 import io.javaoperatorsdk.operator.processing.event.AbstractEventSource;
@@ -115,7 +113,7 @@ public void eventReceived(Watcher.Action action, CustomResource customResource)
   }
 
   private void markLastGenerationProcessed(CustomResource resource) {
-    if (generationAware && ControllerUtils.hasGivenFinalizer(resource, resourceFinalizer)) {
+    if (generationAware && resource.hasFinalizer(resourceFinalizer)) {
       lastGenerationProcessedSuccessfully.put(
           KubernetesResourceUtils.getUID(resource), resource.getMetadata().getGeneration());
     }
@@ -126,7 +124,7 @@ private boolean skipBecauseOfGenerations(CustomResource customResource) {
       return false;
     }
     // if CR being deleted generation is naturally not changing, so we process all the events
-    if (markedForDeletion(customResource)) {
+    if (customResource.isMarkedForDeletion()) {
       return false;
     }
     if (!largerGenerationThenProcessedBefore(customResource)) {

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/EventDispatcherTest.java

@@ -33,7 +33,7 @@
 
 class EventDispatcherTest {
 
-  private static final String DEFAULT_FINALIZER = "finalizer";
+  private static final String DEFAULT_FINALIZER = "javaoperatorsdk.io/finalizer";
   private CustomResource testCustomResource;
   private EventDispatcher eventDispatcher;
   private ResourceController<CustomResource> controller = mock(ResourceController.class);