Utlity naming for Event Sources (#1098)

Author: csviri

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

@@ -1,5 +1,6 @@
 package io.javaoperatorsdk.operator.api.reconciler;
 
+import java.util.HashMap;
 import java.util.Map;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
@@ -23,4 +24,18 @@ public interface EventSourceInitializer<P extends HasMetadata> {
    */
   Map<String, EventSource> prepareEventSources(EventSourceContext<P> context);
 
+  /**
+   * Utility method to easily create map with default names of event sources.
+   *
+   * @param eventSources to name
+   * @return even source with default names
+   */
+  static Map<String, EventSource> defaultNamedEventSources(EventSource... eventSources) {
+    Map<String, EventSource> eventSourceMap = new HashMap<>(eventSources.length);
+    for (EventSource eventSource : eventSources) {
+      eventSourceMap.put(EventSource.defaultNameFor(eventSource), eventSource);
+    }
+    return eventSourceMap;
+  }
+
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/createupdateeventfilter/CreateUpdateEventFilterTestReconciler.java

@@ -106,7 +106,7 @@ public Map<String, EventSource> prepareEventSources(
             .withLabelSelector("integrationtest = " + this.getClass().getSimpleName())
             .build();
     informerEventSource = new InformerEventSource<>(informerConfiguration, client);
-    return Map.of("test-informer", informerEventSource);
+    return EventSourceInitializer.defaultNamedEventSources(informerEventSource);
   }
 
   @Override

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java

@@ -46,7 +46,8 @@ public Map<String, EventSource> prepareEventSources(
             .withPrimaryResourcesRetriever(Mappers.fromAnnotation(RELATED_RESOURCE_NAME))
             .build();
 
-    return Map.of("test-informer", new InformerEventSource<>(config, context));
+    return EventSourceInitializer
+        .defaultNamedEventSources(new InformerEventSource<>(config, context));
   }
 
   @Override

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/standalonedependent/StandaloneDependentTestReconciler.java

@@ -39,7 +39,8 @@ public StandaloneDependentTestReconciler() {
   @Override
   public Map<String, EventSource> prepareEventSources(
       EventSourceContext<StandaloneDependentTestCustomResource> context) {
-    return Map.of("deployment", deploymentDependent.initEventSource(context));
+    return EventSourceInitializer
+        .defaultNamedEventSources(deploymentDependent.initEventSource(context));
   }
 
   @Override

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/WebappReconciler.java

@@ -72,7 +72,8 @@ public Map<String, EventSource> prepareEventSources(EventSourceContext<Webapp> c
             .withPrimaryResourcesRetriever(webappsMatchingTomcatName)
             .withAssociatedSecondaryResourceIdentifier(tomcatFromWebAppSpec)
             .build();
-    return Map.of("tomcat-informer", new InformerEventSource<>(configuration, context));
+    return EventSourceInitializer
+        .defaultNamedEventSources(new InformerEventSource<>(configuration, context));
   }
 
   /**

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

@@ -65,7 +65,8 @@ public Map<String, EventSource> prepareEventSources(EventSourceContext<WebPage>
         new InformerEventSource<>(InformerConfiguration.from(context, Service.class)
             .withLabelSelector(LOW_LEVEL_LABEL_KEY)
             .build(), context);
-    return Map.of("configmap", configMapEventSource, "deployment", deploymentEventSource, "service",
+    return EventSourceInitializer.defaultNamedEventSources(configMapEventSource,
+        deploymentEventSource,
         serviceEventSource);
   }
 

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

@@ -1,13 +1,14 @@
 package io.javaoperatorsdk.operator.sample;
 
+import java.util.Arrays;
 import java.util.Map;
-import java.util.Map.Entry;
-import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import io.fabric8.kubernetes.api.model.HasMetadata;
+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.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
@@ -37,50 +38,49 @@ public class WebPageStandaloneDependentsReconciler
   private static final Logger log =
       LoggerFactory.getLogger(WebPageStandaloneDependentsReconciler.class);
 
-  private final Map<String, KubernetesDependentResource<?, WebPage>> dependentResources;
+  private KubernetesDependentResource<ConfigMap, WebPage> configMapDR;
+  private KubernetesDependentResource<Deployment, WebPage> deploymentDR;
+  private KubernetesDependentResource<Service, WebPage> serviceDR;
 
   public WebPageStandaloneDependentsReconciler(KubernetesClient kubernetesClient) {
-    dependentResources = Map.of(
-        "configmap", new ConfigMapDependentResource(),
-        "deployment", new DeploymentDependentResource(),
-        "service", new ServiceDependentResource());
-    final var config = new KubernetesDependentResourceConfig()
-        .setLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR);
-    dependentResources.values().forEach(dr -> {
-      dr.setKubernetesClient(kubernetesClient);
-      dr.configureWith(config);
-    });
+    createDependentResources(kubernetesClient);
   }
 
   @Override
   public Map<String, EventSource> prepareEventSources(EventSourceContext<WebPage> context) {
-    return dependentResources.entrySet().stream()
-        .collect(Collectors.toUnmodifiableMap(Entry::getKey, Entry::getValue));
+    return EventSourceInitializer.defaultNamedEventSources(configMapDR.initEventSource(context),
+        deploymentDR.initEventSource(context), serviceDR.initEventSource(context));
   }
 
   @Override
   public UpdateControl<WebPage> reconcile(WebPage webPage, Context<WebPage> context)
       throws Exception {
     simulateErrorIfRequested(webPage);
 
-    dependentResources.values().forEach(dr -> dr.reconcile(webPage, context));
+    Arrays.asList(configMapDR, deploymentDR, serviceDR)
+        .forEach(dr -> dr.reconcile(webPage, context));
 
-    webPage.setStatus(createStatus(getConfigMapName(webPage)));
+    webPage.setStatus(
+        createStatus(
+            configMapDR.getAssociatedResource(webPage).orElseThrow().getMetadata().getName()));
     return UpdateControl.updateStatus(webPage);
   }
 
-  private String getConfigMapName(WebPage webPage) {
-    return dependent("configmap").getAssociatedResource(webPage).orElseThrow().getMetadata()
-        .getName();
-  }
-
   @Override
   public ErrorStatusUpdateControl<WebPage> updateErrorStatus(
       WebPage resource, Context<WebPage> retryInfo, Exception e) {
     return handleError(resource, e);
   }
 
-  private KubernetesDependentResource<? extends HasMetadata, WebPage> dependent(String name) {
-    return dependentResources.get(name);
+  private void createDependentResources(KubernetesClient client) {
+    this.configMapDR = new ConfigMapDependentResource();
+    this.deploymentDR = new DeploymentDependentResource();
+    this.serviceDR = new ServiceDependentResource();
+
+    Arrays.asList(configMapDR, deploymentDR, serviceDR).forEach(dr -> {
+      dr.setKubernetesClient(client);
+      dr.configureWith(new KubernetesDependentResourceConfig()
+          .setLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR));
+    });
   }
 }