retry improvements and tests

Author: csviri

operator-framework/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -84,7 +84,7 @@ private <R extends CustomResource> void registerController(
             customResourceCache, eventDispatcher, controller.getClass().getName(), retry);
     DefaultEventSourceManager eventSourceManager =
         new DefaultEventSourceManager(defaultEventHandler, retry != null);
-    defaultEventHandler.setDefaultEventSourceManager(eventSourceManager);
+    defaultEventHandler.setEventSourceManager(eventSourceManager);
     eventDispatcher.setEventSourceManager(eventSourceManager);
 
     customResourceClients.put(resClass, (CustomResourceOperationsImpl) client);

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/Context.java

@@ -3,10 +3,13 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.processing.event.EventList;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
+import java.util.Optional;
 
 public interface Context<T extends CustomResource> {
 
   EventSourceManager getEventSourceManager();
 
   EventList getEvents();
+
+  Optional<RetryInfo> getRetryInfo();
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java

@@ -3,13 +3,17 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.processing.event.EventList;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
+import java.util.Optional;
 
 public class DefaultContext<T extends CustomResource> implements Context<T> {
 
+  private final RetryInfo retryInfo;
   private final EventList events;
   private final EventSourceManager eventSourceManager;
 
-  public DefaultContext(EventSourceManager eventSourceManager, EventList events) {
+  public DefaultContext(
+      EventSourceManager eventSourceManager, EventList events, RetryInfo retryInfo) {
+    this.retryInfo = retryInfo;
     this.events = events;
     this.eventSourceManager = eventSourceManager;
   }
@@ -23,4 +27,9 @@ public EventSourceManager getEventSourceManager() {
   public EventList getEvents() {
     return events;
   }
+
+  @Override
+  public Optional<RetryInfo> getRetryInfo() {
+    return Optional.ofNullable(retryInfo);
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/RetryInfo.java

@@ -2,19 +2,24 @@
 
 public class RetryInfo {
 
-  private int retryNumber;
+  private int attemptIndex;
   private boolean lastAttempt;
 
   public RetryInfo(int retryNumber, boolean lastAttempt) {
-    this.retryNumber = retryNumber;
+    this.attemptIndex = retryNumber;
     this.lastAttempt = lastAttempt;
   }
 
-  public int getRetryNumber() {
-    return retryNumber;
+  public int getAttemptIndex() {
+    return attemptIndex;
   }
 
   public boolean isLastAttempt() {
     return lastAttempt;
   }
+
+  @Override
+  public String toString() {
+    return "RetryInfo{" + "attemptIndex=" + attemptIndex + ", lastAttempt=" + lastAttempt + '}';
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java

@@ -5,6 +5,7 @@
 import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getVersion;
 
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.RetryInfo;
 import io.javaoperatorsdk.operator.processing.event.DefaultEventSourceManager;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
@@ -35,7 +36,7 @@ public class DefaultEventHandler implements EventHandler {
   private final EventDispatcher eventDispatcher;
   private final Retry retry;
   private final Map<String, RetryExecution> retryState = new HashMap<>();
-  private DefaultEventSourceManager defaultEventSourceManager;
+  private DefaultEventSourceManager eventSourceManager;
 
   private final ReentrantLock lock = new ReentrantLock();
 
@@ -59,8 +60,8 @@ public Thread newThread(Runnable runnable) {
             });
   }
 
-  public void setDefaultEventSourceManager(DefaultEventSourceManager defaultEventSourceManager) {
-    this.defaultEventSourceManager = defaultEventSourceManager;
+  public void setEventSourceManager(DefaultEventSourceManager eventSourceManager) {
+    this.eventSourceManager = eventSourceManager;
   }
 
   @Override
@@ -86,7 +87,8 @@ private void executeBufferedEvents(String customResourceUid) {
       ExecutionScope executionScope =
           new ExecutionScope(
               eventBuffer.getAndRemoveEventsForExecution(customResourceUid),
-              latestCustomResource.get());
+              latestCustomResource.get(),
+              retryInfo(customResourceUid));
       log.debug("Executing events for custom resource. Scope: {}", executionScope);
       executor.execute(new ExecutionConsumer(executionScope, eventDispatcher, this));
     } else {
@@ -100,6 +102,15 @@ private void executeBufferedEvents(String customResourceUid) {
     }
   }
 
+  private RetryInfo retryInfo(String customResourceUid) {
+    RetryExecution retryExecution = retryState.get(customResourceUid);
+    if (retryExecution != null) {
+      return new RetryInfo(retryExecution.getCurrentAttemptIndex(), retryExecution.isLastAttempt());
+    } else {
+      return null;
+    }
+  }
+
   void eventProcessingFinished(
       ExecutionScope executionScope, PostExecutionControl postExecutionControl) {
     try {
@@ -143,14 +154,14 @@ private void handleRetryOnException(ExecutionScope executionScope) {
     Optional<Long> nextDelay = execution.nextDelay();
     nextDelay.ifPresent(
         delay ->
-            defaultEventSourceManager
+            eventSourceManager
                 .getRetryTimerEventSource()
                 .scheduleOnce(executionScope.getCustomResource(), delay));
   }
 
   private void markSuccessfulExecutionRegardingRetry(ExecutionScope executionScope) {
     retryState.remove(executionScope.getCustomResourceUid());
-    defaultEventSourceManager
+    eventSourceManager
         .getRetryTimerEventSource()
         .cancelOnceSchedule(executionScope.getCustomResourceUid());
   }
@@ -200,7 +211,7 @@ private void cacheUpdatedResourceIfChanged(
   }
 
   private void cleanupAfterDeletedEvent(String customResourceUid) {
-    defaultEventSourceManager.cleanup(customResourceUid);
+    eventSourceManager.cleanup(customResourceUid);
     eventBuffer.cleanup(customResourceUid);
     customResourceCache.cleanup(customResourceUid);
   }

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

@@ -66,7 +66,10 @@ private PostExecutionControl handleDispatch(ExecutionScope executionScope) {
       return PostExecutionControl.defaultDispatch();
     }
     Context context =
-        new DefaultContext(eventSourceManager, new EventList(executionScope.getEvents()));
+        new DefaultContext(
+            eventSourceManager,
+            new EventList(executionScope.getEvents()),
+            executionScope.getRetryInfo());
     if (markedForDeletion(resource)) {
       return handleDelete(resource, context);
     } else {

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/ExecutionScope.java

@@ -1,6 +1,7 @@
 package io.javaoperatorsdk.operator.processing;
 
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.RetryInfo;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import java.util.List;
 
@@ -10,9 +11,12 @@ public class ExecutionScope {
   // the latest custom resource from cache
   private CustomResource customResource;
 
-  public ExecutionScope(List<Event> list, CustomResource customResource) {
+  private RetryInfo retryInfo;
+
+  public ExecutionScope(List<Event> list, CustomResource customResource, RetryInfo retryInfo) {
     this.events = list;
     this.customResource = customResource;
+    this.retryInfo = retryInfo;
   }
 
   public List<Event> getEvents() {
@@ -38,4 +42,8 @@ public String toString() {
         + customResource.getMetadata().getResourceVersion()
         + '}';
   }
+
+  public RetryInfo getRetryInfo() {
+    return retryInfo;
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetryExecution.java

@@ -29,7 +29,12 @@ public Optional<Long> nextDelay() {
   }
 
   @Override
-  public boolean isLastExecution() {
+  public boolean isLastAttempt() {
     return genericRetry.getMaxAttempts() > -1 && lastAttemptIndex >= genericRetry.getMaxAttempts();
   }
+
+  @Override
+  public int getCurrentAttemptIndex() {
+    return lastAttemptIndex;
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/retry/RetryExecution.java

@@ -16,5 +16,7 @@ public interface RetryExecution {
    * @return true, if the last returned delay is, the last returned values, thus there will be no
    *     further retry
    */
-  boolean isLastExecution();
+  boolean isLastAttempt();
+
+  int getCurrentAttemptIndex();
 }

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

@@ -1,13 +1,12 @@
 package io.javaoperatorsdk.operator;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.Mockito.*;
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.Watcher;
-import io.javaoperatorsdk.operator.api.DeleteControl;
-import io.javaoperatorsdk.operator.api.ResourceController;
-import io.javaoperatorsdk.operator.api.UpdateControl;
+import io.javaoperatorsdk.operator.api.*;
 import io.javaoperatorsdk.operator.processing.EventDispatcher;
 import io.javaoperatorsdk.operator.processing.ExecutionScope;
 import io.javaoperatorsdk.operator.processing.event.Event;
@@ -18,6 +17,7 @@
 import java.util.List;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.mockito.ArgumentCaptor;
 import org.mockito.ArgumentMatchers;
 
 class EventDispatcherTest {
@@ -177,6 +177,20 @@ void executeControllerRegardlessGenerationInNonGenerationAwareMode() {
     verify(controller, times(2)).createOrUpdateResource(eq(testCustomResource), any());
   }
 
+  @Test
+  void propagatesRetryInfoToContext() {
+    eventDispatcher.handleExecution(
+        new ExecutionScope(Arrays.asList(), testCustomResource, new RetryInfo(2, true)));
+
+    ArgumentCaptor<Context<CustomResource>> contextArgumentCaptor =
+        ArgumentCaptor.forClass(Context.class);
+    verify(controller, times(1))
+        .createOrUpdateResource(eq(testCustomResource), contextArgumentCaptor.capture());
+    Context<CustomResource> context = contextArgumentCaptor.getValue();
+    assertThat(context.getRetryInfo().get().getAttemptIndex()).isEqualTo(2);
+    assertThat(context.getRetryInfo().get().isLastAttempt()).isEqualTo(true);
+  }
+
   private void markForDeletion(CustomResource customResource) {
     customResource.getMetadata().setDeletionTimestamp("2019-8-10");
   }
@@ -191,6 +205,6 @@ public ExecutionScope executionScopeWithCREvent(
     List<Event> eventList = new ArrayList<>(1 + otherEvents.length);
     eventList.add(event);
     eventList.addAll(Arrays.asList(otherEvents));
-    return new ExecutionScope(eventList, resource);
+    return new ExecutionScope(eventList, resource, null);
   }
 }