feat: rename context to EventSourceContext, provide KubernetesClient access (#796)

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/EventSourceInitializationContext.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/EventSourceContext.java

@@ -1,24 +1,27 @@
 package io.javaoperatorsdk.operator.api.reconciler;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceCache;
 
 /**
- * Contextual information made available to prepare event sources.
+ * Contextual information made available to event sources.
  *
  * @param <P> the type associated with the primary resource that is handled by your reconciler
  */
-public class EventSourceInitializationContext<P extends HasMetadata> {
+public class EventSourceContext<P extends HasMetadata> {
 
   private final ResourceCache<P> primaryCache;
   private final ConfigurationService configurationService;
+  private final KubernetesClient client;
 
-  public EventSourceInitializationContext(ResourceCache<P> primaryCache,
-      ConfigurationService configurationService) {
+  public EventSourceContext(ResourceCache<P> primaryCache,
+      ConfigurationService configurationService, KubernetesClient client) {
     this.primaryCache = primaryCache;
     this.configurationService = configurationService;
+    this.client = client;
   }
 
   /**
@@ -42,4 +45,15 @@ public ResourceCache<P> getPrimaryCache() {
   public ConfigurationService getConfigurationService() {
     return configurationService;
   }
+
+  /**
+   * Provides access to the {@link KubernetesClient} used by the current
+   * {@link io.javaoperatorsdk.operator.Operator} instance.
+   * 
+   * @return the {@link KubernetesClient} used by the current
+   *         {@link io.javaoperatorsdk.operator.Operator} instance.
+   */
+  public KubernetesClient getClient() {
+    return client;
+  }
 }

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

@@ -16,9 +16,9 @@ public interface EventSourceInitializer<P extends HasMetadata> {
   /**
    * Prepares a list of {@link EventSource} implementations to be registered by the SDK.
    * 
-   * @param context a {@link EventSourceInitializationContext} providing access to information
-   *        useful to event sources
+   * @param context a {@link EventSourceContext} providing access to information useful to event
+   *        sources
    */
-  List<EventSource> prepareEventSources(EventSourceInitializationContext<P> context);
+  List<EventSource> prepareEventSources(EventSourceContext<P> context);
 
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java

@@ -20,7 +20,7 @@
 import io.javaoperatorsdk.operator.api.monitoring.Metrics.ControllerExecution;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.DeleteControl;
-import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializationContext;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
@@ -108,7 +108,7 @@ private Metrics metrics() {
   }
 
   @Override
-  public List<EventSource> prepareEventSources(EventSourceInitializationContext<R> context) {
+  public List<EventSource> prepareEventSources(EventSourceContext<R> context) {
     throw new UnsupportedOperationException("This method should never be called directly");
   }
 
@@ -182,9 +182,9 @@ public void start() throws OperatorException {
       eventSourceManager = new EventSourceManager<>(this);
       if (reconciler instanceof EventSourceInitializer) {
         ((EventSourceInitializer<R>) reconciler)
-            .prepareEventSources(new EventSourceInitializationContext<>(
+            .prepareEventSources(new EventSourceContext<>(
                 eventSourceManager.getControllerResourceEventSource().getResourceCache(),
-                configurationService()))
+                configurationService(), kubernetesClient))
             .forEach(eventSourceManager::registerEventSource);
       }
       if (failOnMissingCurrentNS()) {

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

@@ -9,7 +9,7 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
-import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializationContext;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
@@ -39,7 +39,7 @@ public class InformerEventSourceTestCustomReconciler implements
 
   @Override
   public List<EventSource> prepareEventSources(
-      EventSourceInitializationContext<InformerEventSourceTestCustomResource> context) {
+      EventSourceContext<InformerEventSourceTestCustomResource> context) {
     return List.of(new InformerEventSource<>(kubernetesClient, ConfigMap.class,
         Mappers.fromAnnotation(RELATED_RESOURCE_NAME)));
   }

sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/MySQLSchemaReconciler.java

@@ -42,7 +42,7 @@ public MySQLSchemaReconciler(KubernetesClient kubernetesClient, MySQLDbConfig my
 
   @Override
   public List<EventSource> prepareEventSources(
-      EventSourceInitializationContext<MySQLSchema> context) {
+      EventSourceContext<MySQLSchema> context) {
     return List.of(new PerResourcePollingEventSource<>(
         new SchemaPollingResourceSupplier(mysqlDbConfig), context.getPrimaryCache(), POLL_PERIOD,
         Schema.class));

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

@@ -18,7 +18,7 @@
 import io.fabric8.kubernetes.client.utils.Serialization;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
-import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializationContext;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
@@ -45,7 +45,7 @@ public TomcatReconciler(KubernetesClient client) {
   }
 
   @Override
-  public List<EventSource> prepareEventSources(EventSourceInitializationContext<Tomcat> context) {
+  public List<EventSource> prepareEventSources(EventSourceContext<Tomcat> context) {
     SharedIndexInformer<Deployment> deploymentInformer =
         kubernetesClient.apps().deployments().inAnyNamespace()
             .withLabel("app.kubernetes.io/managed-by", "tomcat-operator")

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

@@ -20,16 +20,14 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.DeleteControl;
-import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializationContext;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceInitializer;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
 
-import okhttp3.Response;
-
 @ControllerConfiguration
 public class WebappReconciler implements Reconciler<Webapp>, EventSourceInitializer<Webapp> {
 
@@ -42,7 +40,7 @@ public WebappReconciler(KubernetesClient kubernetesClient) {
   }
 
   @Override
-  public List<EventSource> prepareEventSources(EventSourceInitializationContext<Webapp> context) {
+  public List<EventSource> prepareEventSources(EventSourceContext<Webapp> context) {
     return List.of(new InformerEventSource<>(
         kubernetesClient, Tomcat.class, t -> {
           // To create an event to a related WebApp resource and trigger the reconciliation