refactor: introduce AbstractExecutionNumberRecordingReconciler

Author: metacosm

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/AbstractExecutionNumberRecordingReconciler.java

@@ -0,0 +1,29 @@
+package io.javaoperatorsdk.operator.sample;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+
+public abstract class AbstractExecutionNumberRecordingReconciler<P extends HasMetadata> implements
+    Reconciler<P>, TestExecutionInfoProvider {
+
+  private final AtomicInteger numberOfReconcileExecutions = new AtomicInteger(0);
+
+  protected int recordReconcileExecution() {
+    return numberOfReconcileExecutions.incrementAndGet();
+  }
+
+  public int getNumberOfExecutions() {
+    return numberOfReconcileExecutions.get();
+  }
+
+  @Override
+  public UpdateControl<P> reconcile(P resource, Context<P> context) throws Exception {
+    recordReconcileExecution();
+    return UpdateControl.noUpdate();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/cleanerforreconciler/CleanerForReconcilerTestReconciler.java

@@ -2,30 +2,19 @@
 
 import java.util.concurrent.atomic.AtomicInteger;
 
-import io.javaoperatorsdk.operator.api.reconciler.*;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.api.reconciler.Cleaner;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.DeleteControl;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration
 public class CleanerForReconcilerTestReconciler
-    implements Reconciler<CleanerForReconcilerCustomResource>,
-    Cleaner<CleanerForReconcilerCustomResource>,
-    TestExecutionInfoProvider {
+    extends AbstractExecutionNumberRecordingReconciler<CleanerForReconcilerCustomResource>
+    implements Cleaner<CleanerForReconcilerCustomResource> {
 
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
   private final AtomicInteger numberOfCleanupExecutions = new AtomicInteger(0);
 
-  @Override
-  public UpdateControl<CleanerForReconcilerCustomResource> reconcile(
-      CleanerForReconcilerCustomResource resource,
-      Context<CleanerForReconcilerCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
-    return UpdateControl.noUpdate();
-  }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
-
   public int getNumberOfCleanupExecutions() {
     return numberOfCleanupExecutions.get();
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/cleanermanageddependent/CleanerForManagedDependentTestReconciler.java

@@ -1,28 +1,10 @@
 package io.javaoperatorsdk.operator.sample.cleanermanageddependent;
 
-import java.util.concurrent.atomic.AtomicInteger;
-
-import io.javaoperatorsdk.operator.api.reconciler.*;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration(dependents = {@Dependent(type = ConfigMapDependentResource.class)})
 public class CleanerForManagedDependentTestReconciler
-    implements Reconciler<CleanerForManagedDependentCustomResource>,
-    TestExecutionInfoProvider {
-
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
-
-  @Override
-  public UpdateControl<CleanerForManagedDependentCustomResource> reconcile(
-      CleanerForManagedDependentCustomResource resource,
-      Context<CleanerForManagedDependentCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
-    return UpdateControl.noUpdate();
-  }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
-
+    extends AbstractExecutionNumberRecordingReconciler<CleanerForManagedDependentCustomResource> {
 }

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

@@ -1,25 +1,9 @@
 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;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @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<CustomFilteringTestResource> context) {
-    numberOfExecutions.incrementAndGet();
-    return UpdateControl.noUpdate();
-  }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
+public class CustomFilteringTestReconciler extends
+    AbstractExecutionNumberRecordingReconciler<CustomFilteringTestResource> {
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentoperationeventfiltering/DependentOperationEventFilterCustomResourceTestReconciler.java

@@ -1,32 +1,16 @@
 package io.javaoperatorsdk.operator.sample.dependentoperationeventfiltering;
 
-import java.util.concurrent.atomic.AtomicInteger;
-
-import io.javaoperatorsdk.operator.api.reconciler.*;
+import io.javaoperatorsdk.operator.api.reconciler.Constants;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration(
     namespaces = Constants.WATCH_CURRENT_NAMESPACE,
     dependents = {
         @Dependent(type = ConfigMapDependentResource.class),
     })
 public class DependentOperationEventFilterCustomResourceTestReconciler
-    implements Reconciler<DependentOperationEventFilterCustomResource>,
-    TestExecutionInfoProvider {
-
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
-
-  @Override
-  public UpdateControl<DependentOperationEventFilterCustomResource> reconcile(
-      DependentOperationEventFilterCustomResource resource,
-      Context<DependentOperationEventFilterCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
-    return UpdateControl.noUpdate();
-  }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
-
+    extends
+    AbstractExecutionNumberRecordingReconciler<DependentOperationEventFilterCustomResource> {
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/deployment/DeploymentReconciler.java

@@ -1,7 +1,6 @@
 package io.javaoperatorsdk.operator.sample.deployment;
 
 import java.util.ArrayList;
-import java.util.concurrent.atomic.AtomicInteger;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -11,25 +10,23 @@
 import io.fabric8.kubernetes.api.model.apps.DeploymentStatus;
 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;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration(labelSelector = "test=KubernetesResourceStatusUpdateIT")
 public class DeploymentReconciler
-    implements Reconciler<Deployment>, TestExecutionInfoProvider {
+    extends AbstractExecutionNumberRecordingReconciler<Deployment> {
 
   public static final String STATUS_MESSAGE = "Reconciled by DeploymentReconciler";
 
   private static final Logger log = LoggerFactory.getLogger(DeploymentReconciler.class);
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
 
   @Override
   public UpdateControl<Deployment> reconcile(
       Deployment resource, Context<Deployment> context) {
 
     log.info("Reconcile deployment: {}", resource);
-    numberOfExecutions.incrementAndGet();
+    recordReconcileExecution();
     if (resource.getStatus() == null) {
       resource.setStatus(new DeploymentStatus());
     }
@@ -47,10 +44,4 @@ public UpdateControl<Deployment> reconcile(
       return UpdateControl.noUpdate();
     }
   }
-
-
-  @Override
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/doubleupdate/DoubleUpdateTestCustomReconciler.java

@@ -1,31 +1,28 @@
 package io.javaoperatorsdk.operator.sample.doubleupdate;
 
 import java.util.HashMap;
-import java.util.concurrent.atomic.AtomicInteger;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration
 public class DoubleUpdateTestCustomReconciler
-    implements Reconciler<DoubleUpdateTestCustomResource>, TestExecutionInfoProvider {
+    extends AbstractExecutionNumberRecordingReconciler<DoubleUpdateTestCustomResource> {
 
   private static final Logger log =
       LoggerFactory.getLogger(DoubleUpdateTestCustomReconciler.class);
   public static final String TEST_ANNOTATION = "TestAnnotation";
   public static final String TEST_ANNOTATION_VALUE = "TestAnnotationValue";
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
 
   @Override
   public UpdateControl<DoubleUpdateTestCustomResource> reconcile(
       DoubleUpdateTestCustomResource resource, Context<DoubleUpdateTestCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
+    recordReconcileExecution();
 
     log.info("Value: " + resource.getSpec().getValue());
 
@@ -44,8 +41,4 @@ private void ensureStatusExists(DoubleUpdateTestCustomResource resource) {
       resource.setStatus(status);
     }
   }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/errorstatushandler/ErrorStatusHandlerTestReconciler.java

@@ -1,27 +1,28 @@
 package io.javaoperatorsdk.operator.sample.errorstatushandler;
 
-import java.util.concurrent.atomic.AtomicInteger;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import io.javaoperatorsdk.operator.api.reconciler.*;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.ErrorStatusHandler;
+import io.javaoperatorsdk.operator.api.reconciler.ErrorStatusUpdateControl;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration
 public class ErrorStatusHandlerTestReconciler
-    implements Reconciler<ErrorStatusHandlerTestCustomResource>, TestExecutionInfoProvider,
-    ErrorStatusHandler<ErrorStatusHandlerTestCustomResource> {
+    extends AbstractExecutionNumberRecordingReconciler<ErrorStatusHandlerTestCustomResource>
+    implements ErrorStatusHandler<ErrorStatusHandlerTestCustomResource> {
 
   private static final Logger log = LoggerFactory.getLogger(ErrorStatusHandlerTestReconciler.class);
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
   public static final String ERROR_STATUS_MESSAGE = "Error Retries Exceeded";
 
   @Override
   public UpdateControl<ErrorStatusHandlerTestCustomResource> reconcile(
       ErrorStatusHandlerTestCustomResource resource,
       Context<ErrorStatusHandlerTestCustomResource> context) {
-    var number = numberOfExecutions.addAndGet(1);
+    var number = recordReconcileExecution();
     var retryAttempt = -1;
     if (context.getRetryInfo().isPresent()) {
       retryAttempt = context.getRetryInfo().get().getAttemptCount();
@@ -39,10 +40,6 @@ private void ensureStatusExists(ErrorStatusHandlerTestCustomResource resource) {
     }
   }
 
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
-
   @Override
   public ErrorStatusUpdateControl<ErrorStatusHandlerTestCustomResource> updateErrorStatus(
       ErrorStatusHandlerTestCustomResource resource,

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java

@@ -1,24 +1,21 @@
 package io.javaoperatorsdk.operator.sample.event;
 
-import java.util.concurrent.atomic.AtomicInteger;
-
-import io.javaoperatorsdk.operator.api.reconciler.*;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration
 public class EventSourceTestCustomReconciler
-    implements Reconciler<EventSourceTestCustomResource>,
-    TestExecutionInfoProvider {
+    extends AbstractExecutionNumberRecordingReconciler<EventSourceTestCustomResource> {
 
   public static final int TIMER_PERIOD = 500;
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
 
   @Override
   public UpdateControl<EventSourceTestCustomResource> reconcile(
       EventSourceTestCustomResource resource, Context<EventSourceTestCustomResource> context) {
 
-    numberOfExecutions.addAndGet(1);
+    recordReconcileExecution();
     ensureStatusExists(resource);
     resource.getStatus().setState(EventSourceTestCustomResourceStatus.State.SUCCESS);
 
@@ -32,8 +29,4 @@ private void ensureStatusExists(EventSourceTestCustomResource resource) {
       resource.setStatus(status);
     }
   }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/maxinterval/MaxIntervalTestReconciler.java

@@ -1,27 +1,13 @@
 package io.javaoperatorsdk.operator.sample.maxinterval;
 
 import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicInteger;
 
-import io.javaoperatorsdk.operator.api.reconciler.*;
-import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.ReconciliationMaxInterval;
+import io.javaoperatorsdk.operator.sample.AbstractExecutionNumberRecordingReconciler;
 
 @ControllerConfiguration(reconciliationMaxInterval = @ReconciliationMaxInterval(interval = 50,
     timeUnit = TimeUnit.MILLISECONDS))
 public class MaxIntervalTestReconciler
-    implements Reconciler<MaxIntervalTestCustomResource>, TestExecutionInfoProvider {
-
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
-
-  @Override
-  public UpdateControl<MaxIntervalTestCustomResource> reconcile(
-      MaxIntervalTestCustomResource resource, Context<MaxIntervalTestCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
-    return UpdateControl.noUpdate();
-  }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
-
+    extends AbstractExecutionNumberRecordingReconciler<MaxIntervalTestCustomResource> {
 }