Improve Expectation integration test (#3084)

Signed-off-by: David Sondermann <david.sondermann@hivemq.com>

Author: Donnerbart

docs/content/en/blog/releases/v5-2-release.md

@@ -99,7 +99,6 @@ public class MyReconciler implements Reconciler<MyResource> {
 
     @Override
     public UpdateControl<MyResource> reconcile(MyResource primary, Context<MyResource> context) {
-
         // Exit early if expectation is not yet fulfilled or timed out
         if (expectationManager.ongoingExpectationPresent(primary, context)) {
             return UpdateControl.noUpdate();
@@ -109,7 +108,7 @@ public class MyReconciler implements Reconciler<MyResource> {
         if (deployment.isEmpty()) {
             createDeployment(primary, context);
             expectationManager.setExpectation(
-                primary, Duration.ofSeconds(30), deploymentReadyExpectation(context));
+                primary, Duration.ofSeconds(30), deploymentReadyExpectation());
             return UpdateControl.noUpdate();
         }
 

docs/content/en/docs/documentation/reconciler.md

@@ -286,7 +286,6 @@ public class ExpectationReconciler implements Reconciler<ExpectationCustomResour
     @Override
     public UpdateControl<ExpectationCustomResource> reconcile(
             ExpectationCustomResource primary, Context<ExpectationCustomResource> context) {
-
         // exiting asap if there is an expectation that is not timed out neither fulfilled yet
         if (expectationManager.ongoingExpectationPresent(primary, context)) {
             return UpdateControl.noUpdate();
@@ -296,13 +295,13 @@ public class ExpectationReconciler implements Reconciler<ExpectationCustomResour
         if (deployment.isEmpty()) {
             createDeployment(primary, context);
             expectationManager.setExpectation(
-                    primary, Duration.ofSeconds(timeout), deploymentReadyExpectation(context));
+                    primary, Duration.ofSeconds(timeout), deploymentReadyExpectation());
             return UpdateControl.noUpdate();
         } else {
-            // checks if the expectation if it is fulfilled, and also removes it.
-            //In your logic, you might add a next expectation based on your workflow.
-            // Expectations have a name, so you can easily distinguish them if there is more of them.
-            var res = expectationManager.checkExpectation("deploymentReadyExpectation",primary, context);
+            // Checks the expectation and removes it once it is fulfilled.
+            // In your logic you might add a next expectation based on your workflow.
+            // Expectations have a name, so you can easily distinguish multiple expectations.
+            var res = expectationManager.checkExpectation("deploymentReadyExpectation", primary, context);
             if (res.isFulfilled()) {
                 return pathchStatusWithMessage(primary, DEPLOYMENT_READY);
             } else if (res.isTimedOut()) {
@@ -311,10 +310,6 @@ public class ExpectationReconciler implements Reconciler<ExpectationCustomResour
             }
         }
         return UpdateControl.noUpdate();
-        
     }
 }
 ```
-
-
-

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/expectation/ExpectationIT.java

@@ -15,6 +15,8 @@
  */
 package io.javaoperatorsdk.operator.baseapi.expectation;
 
+import java.time.Duration;
+
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -35,7 +37,7 @@ class ExpectationIT {
 
   @Test
   void testExpectation() {
-    extension.getReconcilerOfType(ExpectationReconciler.class).setTimeout(30000L);
+    extension.getReconcilerOfType(ExpectationReconciler.class).setTimeout(Duration.ofSeconds(30));
     var res = testResource();
     extension.create(res);
 
@@ -50,7 +52,7 @@ void testExpectation() {
 
   @Test
   void expectationTimeouts() {
-    extension.getReconcilerOfType(ExpectationReconciler.class).setTimeout(300L);
+    extension.getReconcilerOfType(ExpectationReconciler.class).setTimeout(Duration.ofMillis(300));
     var res = testResource();
     extension.create(res);
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/expectation/ExpectationReconciler.java

@@ -18,6 +18,7 @@
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.atomic.AtomicReference;
 
 import io.fabric8.kubernetes.api.model.ContainerBuilder;
 import io.fabric8.kubernetes.api.model.ContainerPortBuilder;
@@ -45,17 +46,21 @@ public class ExpectationReconciler implements Reconciler<ExpectationCustomResour
   public static final String DEPLOYMENT_READY = "Deployment ready";
   public static final String DEPLOYMENT_TIMEOUT = "Deployment timeout";
   public static final String DEPLOYMENT_READY_EXPECTATION_NAME = "deploymentReadyExpectation";
+
   private final ExpectationManager<ExpectationCustomResource> expectationManager =
       new ExpectationManager<>();
+  private final AtomicReference<Duration> timeoutRef =
+      new AtomicReference<>(Duration.ofSeconds(30));
 
-  private volatile Long timeout = 30000l;
+  public void setTimeout(Duration timeout) {
+    timeoutRef.set(timeout);
+  }
 
   @Override
   public UpdateControl<ExpectationCustomResource> reconcile(
       ExpectationCustomResource primary, Context<ExpectationCustomResource> context) {
-
     // cleans up expectation manager for the resource on delete event
-    // in case of cleaner interface used, this can done also there.
+    // in case of cleaner interface used, this can be done also there
     if (context.isPrimaryResourceDeleted()) {
       expectationManager.removeExpectation(primary);
     }
@@ -70,53 +75,41 @@ public UpdateControl<ExpectationCustomResource> reconcile(
       createDeployment(primary, context);
       var set =
           expectationManager.checkAndSetExpectation(
-              primary, context, Duration.ofSeconds(timeout), deploymentReadyExpectation(context));
+              primary, context, timeoutRef.get(), deploymentReadyExpectation());
       if (set) {
         return UpdateControl.noUpdate();
       }
     } else {
-      // checks the expectation if it is fulfilled also removes it,
-      // in your logic you might add a next expectation based on your workflow
-      // Expectations have a name, so you can easily distinguish them if there is more of them.
+      // Checks the expectation and removes it once it is fulfilled.
+      // In your logic you might add a next expectation based on your workflow.
+      // Expectations have a name, so you can easily distinguish multiple expectations.
       var res =
           expectationManager.checkExpectation(DEPLOYMENT_READY_EXPECTATION_NAME, primary, context);
-      // Note that this happens only once, since if the expectation is fulfilled, it is also removed
-      // from the manager.
+      // note that this happens only once, since if the expectation is fulfilled, it is also removed
+      // from the manager
       if (res.isFulfilled()) {
-        return pathchStatusWithMessage(primary, DEPLOYMENT_READY);
+        return patchStatusWithMessage(primary, DEPLOYMENT_READY);
       } else if (res.isTimedOut()) {
         // you might add some other timeout handling here
-        return pathchStatusWithMessage(primary, DEPLOYMENT_TIMEOUT);
+        return patchStatusWithMessage(primary, DEPLOYMENT_TIMEOUT);
       }
     }
     return UpdateControl.noUpdate();
   }
 
-  private static UpdateControl<ExpectationCustomResource> pathchStatusWithMessage(
-      ExpectationCustomResource primary, String message) {
-    primary.setStatus(new ExpectationCustomResourceStatus());
-    primary.getStatus().setMessage(message);
-    return UpdateControl.patchStatus(primary);
-  }
-
-  private static Expectation<ExpectationCustomResource> deploymentReadyExpectation(
-      Context<ExpectationCustomResource> context) {
-    return Expectation.createExpectation(
-        DEPLOYMENT_READY_EXPECTATION_NAME,
-        (p, c) ->
-            context
-                .getSecondaryResource(Deployment.class)
-                .map(
-                    ad ->
-                        ad.getStatus() != null
-                            && ad.getStatus().getReadyReplicas() != null
-                            && ad.getStatus().getReadyReplicas() == 3)
-                .orElse(false));
+  @Override
+  public List<EventSource<?, ExpectationCustomResource>> prepareEventSources(
+      EventSourceContext<ExpectationCustomResource> context) {
+    return List.of(
+        new InformerEventSource<>(
+            InformerEventSourceConfiguration.from(Deployment.class, ExpectationCustomResource.class)
+                .build(),
+            context));
   }
 
-  private Deployment createDeployment(
+  private static void createDeployment(
       ExpectationCustomResource primary, Context<ExpectationCustomResource> context) {
-    var d =
+    var deployment =
         new DeploymentBuilder()
             .withMetadata(
                 new ObjectMetaBuilder()
@@ -147,21 +140,28 @@ private Deployment createDeployment(
                             .build())
                     .build())
             .build();
-    d.addOwnerReference(primary);
-    return context.getClient().resource(d).serverSideApply();
+    deployment.addOwnerReference(primary);
+    context.getClient().resource(deployment).serverSideApply();
   }
 
-  @Override
-  public List<EventSource<?, ExpectationCustomResource>> prepareEventSources(
-      EventSourceContext<ExpectationCustomResource> context) {
-    return List.of(
-        new InformerEventSource<>(
-            InformerEventSourceConfiguration.from(Deployment.class, ExpectationCustomResource.class)
-                .build(),
-            context));
+  private static Expectation<ExpectationCustomResource> deploymentReadyExpectation() {
+    return Expectation.createExpectation(
+        DEPLOYMENT_READY_EXPECTATION_NAME,
+        (primary, context) ->
+            context
+                .getSecondaryResource(Deployment.class)
+                .map(
+                    ad ->
+                        ad.getStatus() != null
+                            && ad.getStatus().getReadyReplicas() != null
+                            && ad.getStatus().getReadyReplicas() == 3)
+                .orElse(false));
   }
 
-  public void setTimeout(Long timeout) {
-    this.timeout = timeout;
+  private static UpdateControl<ExpectationCustomResource> patchStatusWithMessage(
+      ExpectationCustomResource primary, String message) {
+    primary.setStatus(new ExpectationCustomResourceStatus());
+    primary.getStatus().setMessage(message);
+    return UpdateControl.patchStatus(primary);
   }
 }