refactor: make Workflow and ManagedWorkflow more easily reusable

Author: metacosm

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

@@ -22,18 +22,18 @@ public class DefaultManagedWorkflow<P extends HasMetadata> implements ManagedWor
 
   private final Set<String> topLevelResources;
   private final Set<String> bottomLevelResources;
-  private final List<DependentResourceSpec<?, ?>> specs;
+  private final List<DependentResourceSpec<?, ?>> orderedSpecs;
   private final boolean hasCleaner;
 
-  DefaultManagedWorkflow(List<DependentResourceSpec<?, ?>> dependentResourceSpecs,
+  protected DefaultManagedWorkflow(List<DependentResourceSpec<?, ?>> orderedSpecs,
       boolean hasCleaner) {
     this.hasCleaner = hasCleaner;
-    topLevelResources = new HashSet<>(dependentResourceSpecs.size());
-    bottomLevelResources = dependentResourceSpecs.stream()
+    topLevelResources = new HashSet<>(orderedSpecs.size());
+    bottomLevelResources = orderedSpecs.stream()
         .map(DependentResourceSpec::getName)
         .collect(Collectors.toSet());
-    specs = dependentResourceSpecs;
-    dependentResourceSpecs.forEach(spec -> {
+    this.orderedSpecs = orderedSpecs;
+    orderedSpecs.forEach(spec -> {
       // add cycle detection?
       if (spec.getDependsOn().isEmpty()) {
         topLevelResources.add(spec.getName());
@@ -45,16 +45,22 @@ public class DefaultManagedWorkflow<P extends HasMetadata> implements ManagedWor
     });
   }
 
-  Set<String> getTopLevelResources() {
+  @Override
+  @SuppressWarnings("unused")
+  public List<DependentResourceSpec<?, ?>> getOrderedSpecs() {
+    return orderedSpecs;
+  }
+
+  protected Set<String> getTopLevelResources() {
     return topLevelResources;
   }
 
-  Set<String> getBottomLevelResources() {
+  protected Set<String> getBottomLevelResources() {
     return bottomLevelResources;
   }
 
   List<String> nodeNames() {
-    return specs.stream().map(DependentResourceSpec::getName).collect(Collectors.toList());
+    return orderedSpecs.stream().map(DependentResourceSpec::getName).collect(Collectors.toList());
   }
 
   @Override
@@ -64,15 +70,15 @@ public boolean hasCleaner() {
 
   @Override
   public boolean isEmpty() {
-    return specs.isEmpty();
+    return orderedSpecs.isEmpty();
   }
 
   @Override
   @SuppressWarnings("unchecked")
   public Workflow<P> resolve(KubernetesClient client,
       ControllerConfiguration<P> configuration) {
-    final var alreadyResolved = new HashMap<String, DependentResourceNode>(specs.size());
-    for (DependentResourceSpec spec : specs) {
+    final var alreadyResolved = new HashMap<String, DependentResourceNode>(orderedSpecs.size());
+    for (DependentResourceSpec spec : orderedSpecs) {
       final var node = new DependentResourceNode(spec.getName(),
           spec.getReconcileCondition(),
           spec.getDeletePostCondition(),

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

@@ -52,7 +52,7 @@ public class DefaultWorkflow<P extends HasMetadata> implements Workflow<P> {
     }
   }
 
-  DefaultWorkflow(Map<String, DependentResourceNode> dependentResourceNodes,
+  protected DefaultWorkflow(Map<String, DependentResourceNode> dependentResourceNodes,
       Set<DependentResourceNode> bottomLevelResource, Set<DependentResourceNode> topLevelResources,
       boolean throwExceptionAutomatically,
       boolean hasCleaner) {

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

@@ -1,14 +1,27 @@
 package io.javaoperatorsdk.operator.processing.dependent.workflow;
 
+import java.util.Collections;
+import java.util.List;
+
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 
 public interface ManagedWorkflow<P extends HasMetadata> {
 
-  boolean hasCleaner();
+  @SuppressWarnings("unused")
+  default List<DependentResourceSpec<?, ?>> getOrderedSpecs() {
+    return Collections.emptyList();
+  }
+
+  default boolean hasCleaner() {
+    return false;
+  }
 
-  boolean isEmpty();
+  default boolean isEmpty() {
+    return true;
+  }
 
   Workflow<P> resolve(KubernetesClient client, ControllerConfiguration<P> configuration);
 }

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

@@ -1,5 +1,6 @@
 package io.javaoperatorsdk.operator.processing.dependent.workflow;
 
+import java.util.Collections;
 import java.util.Map;
 import java.util.Set;
 
@@ -11,20 +12,34 @@ public interface Workflow<P extends HasMetadata> {
 
   boolean THROW_EXCEPTION_AUTOMATICALLY_DEFAULT = true;
 
-  WorkflowReconcileResult reconcile(P primary, Context<P> context);
+  default WorkflowReconcileResult reconcile(P primary, Context<P> context) {
+    throw new UnsupportedOperationException("Implement this");
+  }
 
-  WorkflowCleanupResult cleanup(P primary, Context<P> context);
+  default WorkflowCleanupResult cleanup(P primary, Context<P> context) {
+    throw new UnsupportedOperationException("Implement this");
+  }
 
   @SuppressWarnings("rawtypes")
-  Set<DependentResourceNode> getTopLevelDependentResources();
+  default Set<DependentResourceNode> getTopLevelDependentResources() {
+    return Collections.emptySet();
+  }
 
   @SuppressWarnings("rawtypes")
-  Set<DependentResourceNode> getBottomLevelResource();
+  default Set<DependentResourceNode> getBottomLevelResource() {
+    return Collections.emptySet();
+  }
 
-  boolean hasCleaner();
+  default boolean hasCleaner() {
+    return false;
+  }
 
-  boolean isEmpty();
+  default boolean isEmpty() {
+    return true;
+  }
 
   @SuppressWarnings("rawtypes")
-  Map<String, DependentResource> getDependentResourcesByName();
+  default Map<String, DependentResource> getDependentResourcesByName() {
+    return Collections.emptyMap();
+  }
 }