feat: extending event source context with workflow support (#2185)

also change webpage sample use workflow builder

Signed-off-by: Attila Mészáros <[email protected]>

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/EventSourceInitializer.java

@@ -1,12 +1,10 @@
 package io.javaoperatorsdk.operator.api.reconciler;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Optional;
+import java.util.*;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.workflow.Workflow;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
 
@@ -43,12 +41,30 @@ static Map<String, EventSource> nameEventSources(EventSource... eventSources) {
     return eventSourceMap;
   }
 
-  @SuppressWarnings("unchecked,rawtypes")
+  @SuppressWarnings("unchecked")
+  static <K extends HasMetadata> Map<String, EventSource> eventSourcesFromWorkflow(
+      EventSourceContext<K> context,
+      Workflow<K> workflow) {
+    Map<String, EventSource> result = new HashMap<>();
+    for (var e : workflow.getDependentResourcesByNameWithoutActivationCondition().entrySet()) {
+      var eventSource = e.getValue().eventSource(context);
+      eventSource.ifPresent(es -> result.put(e.getKey(), (EventSource) es));
+    }
+    return result;
+  }
+
+  @SuppressWarnings("rawtypes")
   static <K extends HasMetadata> Map<String, EventSource> nameEventSourcesFromDependentResource(
       EventSourceContext<K> context, DependentResource... dependentResources) {
+    return nameEventSourcesFromDependentResource(context, Arrays.asList(dependentResources));
+  }
+
+  @SuppressWarnings("unchecked,rawtypes")
+  static <K extends HasMetadata> Map<String, EventSource> nameEventSourcesFromDependentResource(
+      EventSourceContext<K> context, Collection<DependentResource> dependentResources) {
 
     if (dependentResources != null) {
-      Map<String, EventSource> eventSourceMap = new HashMap<>(dependentResources.length);
+      Map<String, EventSource> eventSourceMap = new HashMap<>(dependentResources.size());
       for (DependentResource dependentResource : dependentResources) {
         Optional<ResourceEventSource> es = dependentResource.eventSource(context);
         es.ifPresent(e -> eventSourceMap.put(generateNameFor(e), e));

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java

@@ -37,7 +37,7 @@ public static void main(String[] args) throws IOException {
         .equals(reconcilerEnvVar)) {
       operator.register(new WebPageManagedDependentsReconciler());
     } else {
-      operator.register(new WebPageStandaloneDependentsReconciler(client));
+      operator.register(new WebPageStandaloneDependentsReconciler());
     }
     operator.start();
 

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java

@@ -107,7 +107,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context<WebPage> contex
           "Creating or updating ConfigMap {} in {}",
           desiredHtmlConfigMap.getMetadata().getName(),
           ns);
-      var res = kubernetesClient.configMaps().inNamespace(ns).resource(desiredHtmlConfigMap)
+      kubernetesClient.configMaps().inNamespace(ns).resource(desiredHtmlConfigMap)
           .createOr(Replaceable::update);
     }
 

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java

@@ -7,19 +7,13 @@
 import org.slf4j.LoggerFactory;
 
 import io.fabric8.kubernetes.api.model.ConfigMap;
-import io.fabric8.kubernetes.api.model.Service;
-import io.fabric8.kubernetes.api.model.apps.Deployment;
-import io.fabric8.kubernetes.api.model.networking.v1.Ingress;
-import io.fabric8.kubernetes.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.reconciler.*;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfigBuilder;
+import io.javaoperatorsdk.operator.processing.dependent.workflow.Workflow;
+import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowBuilder;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.sample.customresource.WebPage;
-import io.javaoperatorsdk.operator.sample.dependentresource.ConfigMapDependentResource;
-import io.javaoperatorsdk.operator.sample.dependentresource.DeploymentDependentResource;
-import io.javaoperatorsdk.operator.sample.dependentresource.IngressDependentResource;
-import io.javaoperatorsdk.operator.sample.dependentresource.ServiceDependentResource;
+import io.javaoperatorsdk.operator.sample.dependentresource.*;
 
 import static io.javaoperatorsdk.operator.sample.Utils.*;
 import static io.javaoperatorsdk.operator.sample.WebPageManagedDependentsReconciler.SELECTOR;
@@ -34,19 +28,15 @@ public class WebPageStandaloneDependentsReconciler
   private static final Logger log =
       LoggerFactory.getLogger(WebPageStandaloneDependentsReconciler.class);
 
-  private KubernetesDependentResource<ConfigMap, WebPage> configMapDR;
-  private KubernetesDependentResource<Deployment, WebPage> deploymentDR;
-  private KubernetesDependentResource<Service, WebPage> serviceDR;
-  private KubernetesDependentResource<Ingress, WebPage> ingressDR;
+  private Workflow<WebPage> workflow;
 
-  public WebPageStandaloneDependentsReconciler(KubernetesClient kubernetesClient) {
-    createDependentResources(kubernetesClient);
+  public WebPageStandaloneDependentsReconciler() {
+    workflow = createDependentResourcesAndWorkflow();
   }
 
   @Override
   public Map<String, EventSource> prepareEventSources(EventSourceContext<WebPage> context) {
-    return EventSourceInitializer.nameEventSourcesFromDependentResource(context, configMapDR,
-        deploymentDR, serviceDR, ingressDR);
+    return EventSourceInitializer.eventSourcesFromWorkflow(context, workflow);
   }
 
   @Override
@@ -58,14 +48,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context<WebPage> contex
       return UpdateControl.patchStatus(setInvalidHtmlErrorMessage(webPage));
     }
 
-    Arrays.asList(configMapDR, deploymentDR, serviceDR)
-        .forEach(dr -> dr.reconcile(webPage, context));
-
-    if (Boolean.TRUE.equals(webPage.getSpec().getExposed())) {
-      ingressDR.reconcile(webPage, context);
-    } else {
-      ingressDR.delete(webPage, context);
-    }
+    workflow.reconcile(webPage, context);
 
     webPage.setStatus(
         createStatus(
@@ -80,16 +63,23 @@ public ErrorStatusUpdateControl<WebPage> updateErrorStatus(
   }
 
   @SuppressWarnings({"unchecked", "rawtypes"})
-  private void createDependentResources(KubernetesClient client) {
-    this.configMapDR = new ConfigMapDependentResource();
-    this.deploymentDR = new DeploymentDependentResource();
-    this.serviceDR = new ServiceDependentResource();
-    this.ingressDR = new IngressDependentResource();
-
-    Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR).forEach(dr -> {
-      dr.configureWith(new KubernetesDependentResourceConfigBuilder()
-          .withLabelSelector(SELECTOR + "=true").build());
-    });
+  private Workflow<WebPage> createDependentResourcesAndWorkflow() {
+    var configMapDR = new ConfigMapDependentResource();
+    var deploymentDR = new DeploymentDependentResource();
+    var serviceDR = new ServiceDependentResource();
+    var ingressDR = new IngressDependentResource();
+
+    Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR)
+        .forEach(dr -> dr.configureWith(new KubernetesDependentResourceConfigBuilder()
+            .withLabelSelector(SELECTOR + "=true").build()));
+
+    return new WorkflowBuilder<WebPage>()
+        .addDependentResource(configMapDR)
+        .addDependentResource(deploymentDR)
+        .addDependentResource(serviceDR)
+        .addDependentResource(ingressDR)
+        .withReconcilePrecondition(new ExposedIngressCondition())
+        .build();
   }
 
 

sample-operators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorStandaloneDependentResourcesE2E.java

@@ -18,7 +18,7 @@ public WebPageOperatorStandaloneDependentResourcesE2E() throws FileNotFoundExcep
       isLocal()
           ? LocallyRunOperatorExtension.builder()
               .waitForNamespaceDeletion(false)
-              .withReconciler(new WebPageStandaloneDependentsReconciler(client))
+              .withReconciler(new WebPageStandaloneDependentsReconciler())
               .build()
           : ClusterDeployedOperatorExtension.builder()
               .waitForNamespaceDeletion(false)