feat: extract interfaces for optional behavior of DependentResource (#949)

metacosm · web-flow · commit 73dc44543ea5 · 2022-02-17T11:17:44.000+01:00
* feat: extract EventSourceProvider interface to clean up common use case

* feat: extract DependentResourceConfigurator interface

* feat: showcase configuration change
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java
@@ -157,7 +157,7 @@ public <R extends HasMetadata> void register(Reconciler<R> reconciler,
    * @param <R> the {@code HasMetadata} type associated with the reconciler
    */
   public <R extends HasMetadata> void register(Reconciler<R> reconciler,
-      Consumer<ControllerConfigurationOverrider> configOverrider) {
+      Consumer<ControllerConfigurationOverrider<R>> configOverrider) {
     final var controllerConfiguration = configurationService.getConfigurationFor(reconciler);
     var configToOverride = ControllerConfigurationOverrider.override(controllerConfiguration);
     configOverrider.accept(configToOverride);
@@ -195,7 +195,8 @@ public synchronized void stop() {
       started = false;
     }
 
-    public synchronized void add(Controller controller) {
+    @SuppressWarnings("unchecked")
+    synchronized void add(Controller controller) {
       final var configuration = controller.getConfiguration();
       final var resourceTypeName = ReconcilerUtils
           .getResourceTypeNameWithVersion(configuration.getResourceClass());
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverrider.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverrider.java
@@ -11,6 +11,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
 
+@SuppressWarnings({"rawtypes", "unchecked", "unused"})
 public class ControllerConfigurationOverrider<R extends HasMetadata> {
 
   private String finalizer;
@@ -21,7 +22,7 @@ public class ControllerConfigurationOverrider<R extends HasMetadata> {
   private ResourceEventFilter<R> customResourcePredicate;
   private final ControllerConfiguration<R> original;
   private Duration reconciliationMaxInterval;
-  private List<DependentResourceSpec> dependentResourceSpecs;
+  private final List<DependentResourceSpec> dependentResourceSpecs;
 
   private ControllerConfigurationOverrider(ControllerConfiguration<R> original) {
     finalizer = original.getFinalizer();
@@ -89,7 +90,7 @@ public ControllerConfigurationOverrider<R> withReconciliationMaxInterval(
   }
 
   public void replaceDependentResourceConfig(
-      Class<? extends DependentResource<?, R, ?>> dependentResourceClass,
+      Class<? extends DependentResource<?, R>> dependentResourceClass,
       Object dependentResourceConfig) {
 
     var currentConfig =
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceSpec.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceSpec.java
@@ -4,7 +4,7 @@
 
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 
-public class DependentResourceSpec<T extends DependentResource<?, ?, C>, C> {
+public class DependentResourceSpec<T extends DependentResource<?, ?>, C> {
 
   private final Class<T> dependentResourceClass;
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/AbstractDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/AbstractDependentResource.java
@@ -4,7 +4,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 public abstract class AbstractDependentResource<R, P extends HasMetadata, C>
-    implements DependentResource<R, P, C> {
+    implements DependentResource<R, P> {
 
   @Override
   public void reconcile(P primary, Context context) {
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResource.java
@@ -4,18 +4,11 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
-import io.javaoperatorsdk.operator.processing.event.source.EventSource;
-
-public interface DependentResource<R, P extends HasMetadata, C> {
-
-  Optional<EventSource> eventSource(EventSourceContext<P> context);
 
+public interface DependentResource<R, P extends HasMetadata> {
   void reconcile(P primary, Context context);
 
   void delete(P primary, Context context);
 
   Optional<R> getResource(P primaryResource);
-
-  default void configureWith(C config) {}
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResourceConfigurator.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResourceConfigurator.java
@@ -0,0 +1,5 @@
+package io.javaoperatorsdk.operator.api.reconciler.dependent;
+
+public interface DependentResourceConfigurator<C> {
+  void configureWith(C config);
+}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/EventSourceProvider.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/EventSourceProvider.java
@@ -0,0 +1,10 @@
+package io.javaoperatorsdk.operator.api.reconciler.dependent;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+
+public interface EventSourceProvider<P extends HasMetadata> {
+
+  EventSource eventSource(EventSourceContext<P> context);
+}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceManager.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceManager.java
@@ -21,6 +21,8 @@
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfigurator;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.KubernetesClientAware;
 import io.javaoperatorsdk.operator.processing.Controller;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
@@ -49,11 +51,11 @@ public List<EventSource> prepareEventSources(EventSourceContext<P> context) {
         dependentResources.stream()
             .map(
                 drc -> {
-                  final var dependentResource =
-                      createAndConfigureFrom(drc, context.getClient());
-                  dependentResource
-                      .eventSource(context)
-                      .ifPresent(es -> sources.add((EventSource) es));
+                  final var dependentResource = createAndConfigureFrom(drc, context.getClient());
+                  if (dependentResource instanceof EventSourceProvider) {
+                    EventSourceProvider provider = (EventSourceProvider) dependentResource;
+                    sources.add(provider.eventSource(context));
+                  }
                   return dependentResource;
                 })
             .collect(Collectors.toList());
@@ -87,11 +89,16 @@ private DependentResource createAndConfigureFrom(DependentResourceSpec dependent
       DependentResource dependentResource =
           (DependentResource) dependentResourceSpec.getDependentResourceClass()
               .getConstructor().newInstance();
+
       if (dependentResource instanceof KubernetesClientAware) {
         ((KubernetesClientAware) dependentResource).setKubernetesClient(client);
       }
-      dependentResourceSpec.getDependentResourceConfiguration()
-          .ifPresent(dependentResource::configureWith);
+
+      if (dependentResource instanceof DependentResourceConfigurator) {
+        final var configurator = (DependentResourceConfigurator) dependentResource;
+        dependentResourceSpec.getDependentResourceConfiguration()
+            .ifPresent(configurator::configureWith);
+      }
       return dependentResource;
     } catch (InstantiationException | NoSuchMethodException | IllegalAccessException
         | InvocationTargetException e) {
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java
@@ -14,6 +14,8 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.AbstractDependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfigurator;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.KubernetesClientAware;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
@@ -24,7 +26,8 @@
 
 public abstract class KubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends AbstractDependentResource<R, P, KubernetesDependentResourceConfig>
-    implements KubernetesClientAware {
+    implements KubernetesClientAware, EventSourceProvider<P>,
+    DependentResourceConfigurator<KubernetesDependentResourceConfig> {
 
   private static final Logger log = LoggerFactory.getLogger(KubernetesDependentResource.class);
 
@@ -61,7 +64,7 @@ private void configureWith(ConfigurationService configService, String labelSelec
 
   /**
    * Use to share informers between event more resources.
-   * 
+   *
    * @param configurationService get configs
    * @param informerEventSource informer to use
    * @param addOwnerReference to the created resource
@@ -108,15 +111,15 @@ protected R update(R actual, R target, P primary, Context context) {
   }
 
   @Override
-  public Optional<EventSource> eventSource(EventSourceContext<P> context) {
+  public EventSource eventSource(EventSourceContext<P> context) {
     initResourceMatcherIfNotSet(context.getConfigurationService());
     if (informerEventSource == null) {
       configureWith(context.getConfigurationService(), null, null,
           KubernetesDependent.ADD_OWNER_REFERENCE_DEFAULT);
       log.warn("Using default configuration for " + resourceType().getSimpleName()
           + " KubernetesDependentResource, call configureWith to provide configuration");
     }
-    return Optional.of(informerEventSource);
+    return informerEventSource;
   }
 
   public KubernetesDependentResource<R, P> setInformerEventSource(
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/standalonedependent/StandaloneDependentTestReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/standalonedependent/StandaloneDependentTestReconciler.java
@@ -29,7 +29,7 @@ public StandaloneDependentTestReconciler() {
   @Override
   public List<EventSource> prepareEventSources(
       EventSourceContext<StandaloneDependentTestCustomResource> context) {
-    return List.of(configMapDependent.eventSource(context).get());
+    return List.of(configMapDependent.eventSource(context));
   }
 
   @Override
diff --git a/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/MySQLSchemaOperator.java b/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/MySQLSchemaOperator.java
@@ -35,10 +35,11 @@ public static void main(String[] args) throws IOException {
 
     MySQLSchemaReconciler schemaReconciler = new MySQLSchemaReconciler();
 
+    // override the default configuration
     operator.register(schemaReconciler,
         configOverrider -> configOverrider.replaceDependentResourceConfig(
             SchemaDependentResource.class,
-            new ResourcePollerConfig(500, MySQLDbConfig.loadFromEnvironmentVars())));
+            new ResourcePollerConfig(300, MySQLDbConfig.loadFromEnvironmentVars())));
     operator.installShutdownHook();
     operator.start();
 
diff --git a/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/SchemaDependentResource.java b/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/SchemaDependentResource.java
@@ -8,15 +8,19 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.AbstractDependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfigurator;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.polling.PerResourcePollingEventSource;
 import io.javaoperatorsdk.operator.sample.schema.Schema;
 import io.javaoperatorsdk.operator.sample.schema.SchemaService;
 
 import static java.lang.String.format;
 
-public class SchemaDependentResource extends
-    AbstractDependentResource<Schema, MySQLSchema, ResourcePollerConfig> {
+public class SchemaDependentResource
+    extends AbstractDependentResource<Schema, MySQLSchema, ResourcePollerConfig>
+    implements EventSourceProvider<MySQLSchema>,
+    DependentResourceConfigurator<ResourcePollerConfig> {
 
   private MySQLDbConfig dbConfig;
   private int pollPeriod = 500;
@@ -28,13 +32,13 @@ public void configureWith(ResourcePollerConfig config) {
   }
 
   @Override
-  public Optional<EventSource> eventSource(EventSourceContext<MySQLSchema> context) {
+  public EventSource eventSource(EventSourceContext<MySQLSchema> context) {
     if (dbConfig == null) {
       dbConfig = MySQLDbConfig.loadFromEnvironmentVars();
     }
-    return Optional.of(new PerResourcePollingEventSource<>(
+    return new PerResourcePollingEventSource<>(
         new SchemaPollingResourceSupplier(dbConfig), context.getPrimaryCache(), pollPeriod,
-        Schema.class));
+        Schema.class);
   }
 
   @Override
diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java
@@ -40,11 +40,10 @@ public WebPageReconciler(KubernetesClient kubernetesClient) {
 
   @Override
   public List<EventSource> prepareEventSources(EventSourceContext<WebPage> context) {
-    List<EventSource> eventSources = new ArrayList<>(3);
-    configMapDR.eventSource(context).ifPresent(eventSources::add);
-    deploymentDR.eventSource(context).ifPresent(eventSources::add);
-    serviceDR.eventSource(context).ifPresent(eventSources::add);
-    return eventSources;
+    return List.of(
+        configMapDR.eventSource(context),
+        deploymentDR.eventSource(context),
+        serviceDR.eventSource(context));
   }
 
   @Override

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public StandaloneDependentTestReconciler() {`
`29`	`29`	`@Override`
`30`	`30`	`public List<EventSource> prepareEventSources(`
`31`	`31`	`EventSourceContext<StandaloneDependentTestCustomResource> context) {`
`32`		`- return List.of(configMapDependent.eventSource(context).get());`
	`32`	`+ return List.of(configMapDependent.eventSource(context));`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`