tests for ready condition

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowReconcileExecutor.java

@@ -11,6 +11,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.workflow.condition.ReadyCondition;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.condition.ReconcileCondition;
 
 public class WorkflowReconcileExecutor<P extends HasMetadata> {
@@ -108,6 +109,10 @@ private synchronized void handleNodeExecutionFinish(DependentResourceNode depend
     }
   }
 
+  private synchronized void updateStatusForNotReady(ReadyCondition<?, P> readyCondition) {
+    readyCondition.addNotReadyStatusInfo(primary);
+  }
+
   private boolean ownOrParentsReconcileConditionNotMet(
       DependentResourceNode<?, ?> dependentResourceNode) {
     return reconcileConditionOrParentsConditionNotMet.contains(dependentResourceNode) ||
@@ -143,6 +148,8 @@ public void run() {
                   .isMet(dependentResource, primary, context)) {
             handleDependents = false;
             reconciledButNotReady.add(dependentResourceNode);
+            // needs to be synced
+            updateStatusForNotReady(dependentResourceNode.getReadyCondition().get());
           }
         }
         alreadyReconciled.add(dependentResourceNode);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/condition/ReadyCondition.java

@@ -8,4 +8,11 @@ public interface ReadyCondition<R, P extends HasMetadata> {
 
   boolean isMet(DependentResource<R, P> dependentResource, P primary, Context<P> context);
 
+  /**
+   * If condition not met, the primary resource status might be updated by overriding this method.
+   * In case there are multiple conditions in a workflow it is updated multiple times.
+   *
+   * @param primary
+   */
+  default void addNotReadyStatusInfo(P primary) {}
 }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowTest.java

@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import io.javaoperatorsdk.operator.AggregatedOperatorException;
@@ -13,6 +14,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.builder.WorkflowBuilder;
+import io.javaoperatorsdk.operator.processing.dependent.workflow.condition.ReadyCondition;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.condition.ReconcileCondition;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
 
@@ -21,11 +23,31 @@
 
 class WorkflowTest {
 
+  public static final String NOT_READY_YET = "NOT READY YET";
   private ReconcileCondition met_reconcile_condition =
       (dependentResource, primary, context) -> true;
   private ReconcileCondition not_met_reconcile_condition =
       (dependentResource, primary, context) -> false;
 
+  private ReadyCondition<String, TestCustomResource> metReadyCondition =
+      (dependentResource, primary, context) -> true;
+  private ReadyCondition<String, TestCustomResource> notMetReadyCondition =
+      (dependentResource, primary, context) -> false;
+
+  private ReadyCondition<String, TestCustomResource> notMetReadyConditionWithStatusUpdate =
+      new ReadyCondition<>() {
+        @Override
+        public boolean isMet(DependentResource<String, TestCustomResource> dependentResource,
+            TestCustomResource primary, Context<TestCustomResource> context) {
+          return false;
+        }
+
+        @Override
+        public void addNotReadyStatusInfo(TestCustomResource primary) {
+          primary.getStatus().setConfigMapStatus(NOT_READY_YET);
+        }
+      };
+
   public static final String VALUE = "value";
   private List<ReconcileRecord> executionHistory =
       Collections.synchronizedList(new ArrayList<>());
@@ -233,6 +255,59 @@ void oneDependsOnConditionNotMet() {
     assertThat(executionHistory).notReconciled(dr2);
   }
 
+  @Test
+  void readyConditionTrivialCase() {
+    var workflow = new WorkflowBuilder<TestCustomResource>()
+        .addDependent(dr1).withReadyCondition(metReadyCondition).build()
+        .addDependent(dr2).dependsOn(dr1).build()
+        .build();
+
+    workflow.reconcile(new TestCustomResource(), null);
+
+    assertThat(executionHistory).reconciledInOrder(dr1, dr2);
+  }
+
+  @Test
+  void readyConditionNotMetTrivialCase() {
+    var workflow = new WorkflowBuilder<TestCustomResource>()
+        .addDependent(dr1).withReadyCondition(notMetReadyCondition).build()
+        .addDependent(dr2).dependsOn(dr1).build()
+        .build();
+
+    workflow.reconcile(new TestCustomResource(), null);
+
+    assertThat(executionHistory).reconciled(dr1).notReconciled(dr2);
+  }
+
+  @Test
+  void readyConditionNotMetStatusUpdates() {
+    var workflow = new WorkflowBuilder<TestCustomResource>()
+        .addDependent(dr1).withReadyCondition(notMetReadyConditionWithStatusUpdate).build()
+        .addDependent(dr2).dependsOn(dr1).build()
+        .build();
+
+    var cr = new TestCustomResource();
+    workflow.reconcile(cr, null);
+
+    assertThat(executionHistory).reconciled(dr1).notReconciled(dr2);
+    Assertions.assertThat(cr.getStatus().getConfigMapStatus()).isEqualTo(NOT_READY_YET);
+  }
+
+  @Test
+  void readyConditionNotMetInOneParent() {
+    TestDependent dr3 = new TestDependent("DR_3");
+
+    var workflow = new WorkflowBuilder<TestCustomResource>()
+        .addDependent(dr1).withReadyCondition(notMetReadyCondition).build()
+        .addDependent(dr2).build()
+        .addDependent(dr3).dependsOn(dr1, dr2).build()
+        .build();
+
+    workflow.reconcile(new TestCustomResource(), null);
+
+    assertThat(executionHistory).reconciled(dr1, dr2).notReconciled(dr3);
+  }
+
   private class TestDependent implements DependentResource<String, TestCustomResource> {
 
     private String name;