comments on integration tests

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

Author: csviri

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventIT.java

@@ -51,7 +51,9 @@ void eventsPresent() {
             () -> {
               var r = getResource();
               assertThat(r).isNull();
+              // check if reconciler also triggered when delete event received
               assertThat(reconciler.isDeleteEventPresent()).isTrue();
+              // also when it was marked for deletion
               assertThat(reconciler.isEventOnMarkedForDeletion()).isTrue();
             });
   }
@@ -96,6 +98,10 @@ void retriesExceptionOnDeleteEvent() {
             });
   }
 
+  /**
+   * Checks if we receive event even after our finalizer is removed but there is an additional
+   * finalizer
+   */
   @Test
   void additionalFinalizer() {
     var reconciler = extension.getReconcilerOfType(TriggerReconcilerOnAllEventReconciler.class);
@@ -129,6 +135,10 @@ void additionalFinalizer() {
             });
   }
 
+  // tests the situation where we received a delete event, but there is an exception during
+  // reconiliation
+  // what is retried, but during retry we receive an additional event, that should instantly
+  // trigger the reconciliation again when current finished.
   @Test
   void additionalEventDuringRetryOnDeleteEvent() {
 
@@ -154,9 +164,11 @@ void additionalEventDuringRetryOnDeleteEvent() {
               assertThat(reconciler.isWaiting());
             });
 
+    // trigger reconciliation while waiting in reconciler
     res = getResource();
     res.getMetadata().getAnnotations().put("my-annotation", "true");
     extension.update(res);
+    // continue reconciliation
     reconciler.setContinuerOnRetryWait(true);
 
     await()
@@ -188,7 +200,6 @@ void additionalEventDuringRetryOnDeleteEvent() {
 
   @Test
   void additionalEventAfterExhaustedRetry() {
-
     var reconciler = extension.getReconcilerOfType(TriggerReconcilerOnAllEventReconciler.class);
     reconciler.setThrowExceptionIfNoAnnotation(true);
     var res = testResource();
@@ -203,6 +214,7 @@ void additionalEventAfterExhaustedRetry() {
               assertThat(reconciler.getEventCount()).isEqualTo(MAX_RETRY_ATTEMPTS + 1);
             });
 
+    // this also triggers the reconciliation
     addNoMoreExceptionAnnotation();
 
     await()

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/triggerallevent/onlyreconcile/TriggerReconcilerOnAllEventReconciler.java

@@ -15,29 +15,34 @@
 public class TriggerReconcilerOnAllEventReconciler
     implements Reconciler<TriggerReconcilerOnAllEventCustomResource> {
 
+  public static final String FINALIZER = "all.event.mode/finalizer";
+  public static final String ADDITIONAL_FINALIZER = "all.event.mode/finalizer2";
+  public static final String NO_MORE_EXCEPTION_ANNOTATION_KEY = "no.more.exception";
+
   private static final Logger log =
       LoggerFactory.getLogger(TriggerReconcilerOnAllEventReconciler.class);
 
+  // control flags to throw exceptions in certain situations
   private volatile boolean throwExceptionOnFirstDeleteEvent = false;
   private volatile boolean throwExceptionIfNoAnnotation = false;
 
+  // flags for managing wait within reconciliation,
+  // so we can send an update while reconciliation is in progress
   private volatile boolean waitAfterFirstRetry = false;
   private volatile boolean continuerOnRetryWait = false;
   private volatile boolean waiting = false;
 
+  // control flag to throw an exception on first delete event
   private volatile boolean isFirstDeleteEvent = true;
+  // control if the reconciler should add / remove the finalizer
+  private volatile boolean useFinalizer = true;
 
-  public static final String FINALIZER = "all.event.mode/finalizer";
-  public static final String ADDITIONAL_FINALIZER = "all.event.mode/finalizer2";
-  public static final String NO_MORE_EXCEPTION_ANNOTATION_KEY = "no.more.exception";
-
-  protected volatile boolean useFinalizer = true;
-
-  private final AtomicInteger eventCounter = new AtomicInteger(0);
-
+  // flags to flip if reconciled primary resource in certain state
   private boolean deleteEventPresent = false;
   private boolean eventOnMarkedForDeletion = false;
   private boolean resourceEventPresent = false;
+  // counter for how many times the reconciler has been called
+  private final AtomicInteger reconciliationCounter = new AtomicInteger(0);
 
   @Override
   public UpdateControl<TriggerReconcilerOnAllEventCustomResource> reconcile(
@@ -143,11 +148,11 @@ public void setWaiting(boolean waiting) {
   }
 
   public int getEventCount() {
-    return eventCounter.get();
+    return reconciliationCounter.get();
   }
 
   public void increaseEventCount() {
-    eventCounter.incrementAndGet();
+    reconciliationCounter.incrementAndGet();
   }
 
   public boolean getUseFinalizer() {