fix with resource filter bug and related behavior update (#808)

Author: csviri

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

@@ -55,5 +55,5 @@
    * @return the list of event filters.
    */
   @SuppressWarnings("rawtypes")
-  Class<ResourceEventFilter>[] eventFilters() default {};
+  Class<? extends ResourceEventFilter>[] eventFilters() default {};
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerResourceEventSource.java

@@ -54,9 +54,7 @@ public ControllerResourceEventSource(Controller<T> controller) {
     var filters = new ResourceEventFilter[] {
         ResourceEventFilters.finalizerNeededAndApplied(),
         ResourceEventFilters.markedForDeletion(),
-        ResourceEventFilters.and(
-            controller.getConfiguration().getEventFilter(),
-            ResourceEventFilters.generationAware()),
+        ResourceEventFilters.generationAware(),
         null
     };
 
@@ -66,7 +64,11 @@ public ControllerResourceEventSource(Controller<T> controller) {
     } else {
       onceWhitelistEventFilterEventFilter = null;
     }
-    filter = ResourceEventFilters.or(filters);
+    if (controller.getConfiguration().getEventFilter() != null) {
+      filter = controller.getConfiguration().getEventFilter().and(ResourceEventFilters.or(filters));
+    } else {
+      filter = ResourceEventFilters.or(filters);
+    }
   }
 
   @Override

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/ResourceEventFilterTest.java

@@ -123,7 +123,7 @@ public void observedGenerationFiltering() {
   }
 
   @Test
-  public void eventNotFilteredByCustomPredicateIfFinalizerIsRequired() {
+  public void eventAlwaysFilteredByCustomPredicate() {
     var config = new TestControllerConfig(
         FINALIZER,
         false,
@@ -138,13 +138,7 @@ public void eventNotFilteredByCustomPredicateIfFinalizerIsRequired() {
     cr.getStatus().setConfigMapStatus("1");
 
     eventSource.eventReceived(ResourceAction.UPDATED, cr, cr);
-    verify(eventHandler, times(1)).handleEvent(any());
-
-    cr.getMetadata().setGeneration(1L);
-    cr.getStatus().setConfigMapStatus("1");
-
-    eventSource.eventReceived(ResourceAction.UPDATED, cr, cr);
-    verify(eventHandler, times(2)).handleEvent(any());
+    verify(eventHandler, times(0)).handleEvent(any());
   }
 
   private static class TestControllerConfig extends ControllerConfig<TestCustomResource> {

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java

@@ -90,7 +90,7 @@ public ResourceEventFilter<R> getEventFilter() {
           if (answer == null) {
             answer = filter;
           } else {
-            answer = filter.and(filter);
+            answer = answer.and(filter);
           }
         } catch (Exception e) {
           throw new RuntimeException(e);

operator-framework/src/test/java/io/javaoperatorsdk/operator/CustomResourceFilterIT.java

@@ -0,0 +1,51 @@
+package io.javaoperatorsdk.operator;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ObjectMeta;
+import io.javaoperatorsdk.operator.config.runtime.DefaultConfigurationService;
+import io.javaoperatorsdk.operator.junit.OperatorExtension;
+import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestReconciler;
+import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResource;
+import io.javaoperatorsdk.operator.sample.customfilter.CustomFilteringTestResourceSpec;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class CustomResourceFilterIT {
+
+  @RegisterExtension
+  OperatorExtension operator =
+      OperatorExtension.builder()
+          .withConfigurationService(DefaultConfigurationService.instance())
+          .withReconciler(new CustomFilteringTestReconciler())
+          .build();
+
+  @Test
+  public void doesCustomFiltering() throws InterruptedException {
+    var filtered1 = createTestResource("filtered1", true, false);
+    var filtered2 = createTestResource("filtered2", false, true);
+    var notFiltered = createTestResource("notfiltered", true, true);
+    operator.create(CustomFilteringTestResource.class, filtered1);
+    operator.create(CustomFilteringTestResource.class, filtered2);
+    operator.create(CustomFilteringTestResource.class, notFiltered);
+
+    Thread.sleep(300);
+
+    assertThat(
+        ((CustomFilteringTestReconciler) operator.getReconcilers().get(0)).getNumberOfExecutions())
+            .isEqualTo(1);
+  }
+
+
+  CustomFilteringTestResource createTestResource(String name, boolean filter1, boolean filter2) {
+    CustomFilteringTestResource resource = new CustomFilteringTestResource();
+    resource.setMetadata(new ObjectMeta());
+    resource.getMetadata().setName(name);
+    resource.setSpec(new CustomFilteringTestResourceSpec());
+    resource.getSpec().setFilter1(filter1);
+    resource.getSpec().setFilter2(filter2);
+    return resource;
+  }
+
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/customfilter/CustomFilteringTestReconciler.java

@@ -0,0 +1,25 @@
+package io.javaoperatorsdk.operator.sample.customfilter;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+
+@ControllerConfiguration(eventFilters = {CustomFlagFilter.class, CustomFlagFilter2.class})
+public class CustomFilteringTestReconciler implements Reconciler<CustomFilteringTestResource> {
+
+  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
+
+  @Override
+  public UpdateControl<CustomFilteringTestResource> reconcile(CustomFilteringTestResource resource,
+      Context context) {
+    numberOfExecutions.incrementAndGet();
+    return UpdateControl.noUpdate();
+  }
+
+  public int getNumberOfExecutions() {
+    return numberOfExecutions.get();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/customfilter/CustomFilteringTestResource.java

@@ -0,0 +1,15 @@
+package io.javaoperatorsdk.operator.sample.customfilter;
+
+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("cft")
+public class CustomFilteringTestResource
+    extends CustomResource<CustomFilteringTestResourceSpec, Void>
+    implements Namespaced {
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/customfilter/CustomFilteringTestResourceSpec.java

@@ -0,0 +1,26 @@
+package io.javaoperatorsdk.operator.sample.customfilter;
+
+public class CustomFilteringTestResourceSpec {
+
+  private boolean filter1;
+
+  private boolean filter2;
+
+  public boolean isFilter1() {
+    return filter1;
+  }
+
+  public CustomFilteringTestResourceSpec setFilter1(boolean filter1) {
+    this.filter1 = filter1;
+    return this;
+  }
+
+  public boolean isFilter2() {
+    return filter2;
+  }
+
+  public CustomFilteringTestResourceSpec setFilter2(boolean filter2) {
+    this.filter2 = filter2;
+    return this;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/customfilter/CustomFlagFilter.java

@@ -0,0 +1,13 @@
+package io.javaoperatorsdk.operator.sample.customfilter;
+
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
+
+public class CustomFlagFilter implements ResourceEventFilter<CustomFilteringTestResource> {
+
+  @Override
+  public boolean acceptChange(ControllerConfiguration<CustomFilteringTestResource> configuration,
+      CustomFilteringTestResource oldResource, CustomFilteringTestResource newResource) {
+    return newResource.getSpec().isFilter1();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/customfilter/CustomFlagFilter2.java

@@ -0,0 +1,13 @@
+package io.javaoperatorsdk.operator.sample.customfilter;
+
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
+
+public class CustomFlagFilter2 implements ResourceEventFilter<CustomFilteringTestResource> {
+
+  @Override
+  public boolean acceptChange(ControllerConfiguration<CustomFilteringTestResource> configuration,
+      CustomFilteringTestResource oldResource, CustomFilteringTestResource newResource) {
+    return newResource.getSpec().isFilter2();
+  }
+}