- improve tests , docs

Author: attila.meszaros

operator-framework/src/main/java/com/github/containersolutions/operator/processing/EventDispatcher.java

@@ -39,9 +39,6 @@ public void handleEvent(CustomResourceEvent event) {
             return;
         }
         Context context = new DefaultContext(new RetryInfo(event.getRetryCount(), event.getRetryExecution().isLastExecution()));
-        /* Its interesting problem if we should call delete if received event after object is marked for deletion
-           but finalizer is not on the object. Since it can happen that there are multiple finalizers, also other events after
-           we called delete and remove finalizers already. Delete should be also idempotent, we call it now. */
         if (markedForDeletion(resource) && !ControllerUtils.hasDefaultFinalizer(resource, resourceDefaultFinalizer)) {
             return;
         }

operator-framework/src/test/java/com/github/containersolutions/operator/EventSchedulerTest.java

@@ -80,7 +80,9 @@ public void eventsAreNotExecutedConcurrentlyForSameResource() throws Interrupted
     public void generationAwareSchedulingSkipsEventsWithoutIncreasedGeneration() {
         normalDispatcherExecution();
         CustomResource resource1 = sampleResource();
+        addFinalizer(resource1);
         CustomResource resource2 = sampleResource();
+        addFinalizer(resource2);
         resource2.getMetadata().setResourceVersion("2");
 
         eventScheduler.eventReceived(Watcher.Action.MODIFIED, resource1);
@@ -93,6 +95,13 @@ public void generationAwareSchedulingSkipsEventsWithoutIncreasedGeneration() {
 
     }
 
+    private void addFinalizer(CustomResource resource) {
+        if (resource.getMetadata().getFinalizers() == null) {
+            resource.getMetadata().setFinalizers(new ArrayList<>());
+        }
+        resource.getMetadata().getFinalizers().add(Controller.DEFAULT_FINALIZER);
+    }
+
     @Test
     public void notGenerationAwareSchedulingProcessesAllEventsRegardlessOfGeneration() {
         generationUnAwareScheduler();

operator-framework/src/test/java/com/github/containersolutions/operator/SubResourceUpdateIT.java

@@ -44,6 +44,9 @@ public void updatesSubResourceStatus() {
         });
     }
 
+    /**
+     * Note that we check on controller impl if there is finalizer on execution.
+     * */
     @Test
     public void ifNoFinalizerPresentFirstAddsTheFinalizerThenExecutesControllerAgain() {
         initAndCleanup();
@@ -56,7 +59,7 @@ public void ifNoFinalizerPresentFirstAddsTheFinalizerThenExecutesControllerAgain
             // wait for sure, there are no more events
             waitXms(200);
             // there is no event on status update processed
-            assertThat(integrationTestSupport.numberOfControllerExecutions()).isEqualTo(2);
+            assertThat(integrationTestSupport.numberOfControllerExecutions()).isEqualTo(1);
         });
     }
 

operator-framework/src/test/java/com/github/containersolutions/operator/sample/TestCustomResourceController.java

@@ -51,6 +51,10 @@ public boolean deleteResource(TestCustomResource resource, Context<TestCustomRes
     public UpdateControl<TestCustomResource> createOrUpdateResource(TestCustomResource resource,
                                                                     Context<TestCustomResource> context) {
         numberOfExecutions.addAndGet(1);
+        if (!resource.getMetadata().getFinalizers().contains(Controller.DEFAULT_FINALIZER)) {
+            throw new IllegalStateException("Finalizer is not present.");
+        }
+
         ConfigMap existingConfigMap = kubernetesClient
                 .configMaps().inNamespace(resource.getMetadata().getNamespace())
                 .withName(resource.getSpec().getConfigMapName()).get();

operator-framework/src/test/java/com/github/containersolutions/operator/sample/subresource/SubResourceTestCustomResourceController.java

@@ -29,6 +29,9 @@ public boolean deleteResource(SubResourceTestCustomResource resource, Context<Su
     public UpdateControl<SubResourceTestCustomResource> createOrUpdateResource(SubResourceTestCustomResource resource,
                                                                                Context<SubResourceTestCustomResource> context) {
         numberOfExecutions.addAndGet(1);
+        if (!resource.getMetadata().getFinalizers().contains(Controller.DEFAULT_FINALIZER)) {
+            throw new IllegalStateException("Finalizer is not present.");
+        }
         log.info("Value: " + resource.getSpec().getValue());
 
         ensureStatusExists(resource);