feat: introduce ResourceOwner to be unify type and resource retrieval

Author: metacosm

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

@@ -32,7 +32,7 @@ public Optional<RetryInfo> getRetryInfo() {
   public <T> Optional<T> getSecondaryResource(Class<T> expectedType, String eventSourceName) {
     return controller.getEventSourceManager()
         .getResourceEventSourceFor(expectedType, eventSourceName)
-        .flatMap(es -> es.getAssociated(primaryResource));
+        .flatMap(es -> es.getAssociatedResource(primaryResource));
   }
 
   @Override

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

@@ -1,17 +1,16 @@
 package io.javaoperatorsdk.operator.api.reconciler.dependent;
 
-import java.util.Optional;
-
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.processing.ResourceOwner;
 
 /**
  * An interface to implement and provide dependent resource support.
  *
  * @param <R> the dependent resource type
  * @param <P> the associated primary resource type
  */
-public interface DependentResource<R, P extends HasMetadata> {
+public interface DependentResource<R, P extends HasMetadata> extends ResourceOwner<R, P> {
 
   /**
    * Reconciles the dependent resource given the desired primary state
@@ -22,23 +21,6 @@ public interface DependentResource<R, P extends HasMetadata> {
    */
   ReconcileResult<R> reconcile(P primary, Context<P> context);
 
-  /**
-   * Retrieves the dependent resource associated with the specified primary one
-   *
-   * @param primaryResource the primary resource for which we want to retrieve the secondary
-   *        resource
-   * @return an {@link Optional} containing the secondary resource or {@link Optional#empty()} if it
-   *         doesn't exist
-   */
-  Optional<R> getResource(P primaryResource);
-
-  /**
-   * Retrieves the resource type associated with this DependentResource
-   *
-   * @return the resource type associated with this DependentResource
-   */
-  Class<R> resourceType();
-
   /**
    * Computes a default name for the specified DependentResource class
    *

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

@@ -0,0 +1,24 @@
+package io.javaoperatorsdk.operator.processing;
+
+import java.util.Optional;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+
+public interface ResourceOwner<R, P extends HasMetadata> {
+
+  /**
+   * Retrieves the resource type associated with this ResourceOwner
+   *
+   * @return the resource type associated with this ResourceOwner
+   */
+  Class<R> resourceType();
+
+  /**
+   * Retrieves the resource associated with the specified primary one
+   *
+   * @param primary the primary resource for which we want to retrieve the secondary resource
+   * @return an {@link Optional} containing the secondary resource or {@link Optional#empty()} if it
+   *         doesn't exist
+   */
+  Optional<R> getAssociatedResource(P primary);
+}

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

@@ -28,7 +28,7 @@ public AbstractDependentResource() {
 
   @Override
   public ReconcileResult<R> reconcile(P primary, Context<P> context) {
-    var maybeActual = getResource(primary);
+    var maybeActual = getAssociatedResource(primary);
     if (creatable || updatable) {
       if (maybeActual.isEmpty()) {
         if (creatable) {

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

@@ -10,9 +10,11 @@
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
 
-public abstract class AbstractEventSourceHolderDependentResource<R, P extends HasMetadata, T extends EventSource>
-    extends AbstractDependentResource<R, P> implements EventSource, EventSourceProvider<P> {
+public abstract class AbstractEventSourceHolderDependentResource<R, P extends HasMetadata, T extends ResourceEventSource<R, P>>
+    extends AbstractDependentResource<R, P>
+    implements ResourceEventSource<R, P>, EventSourceProvider<P> {
   private T eventSource;
   private boolean isFilteringEventSource;
   private boolean isCacheFillerEventSource;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractCachingDependentResource.java

@@ -16,7 +16,7 @@ protected AbstractCachingDependentResource(Class<R> resourceType) {
   }
 
   public Optional<R> fetchResource(P primaryResource) {
-    return eventSource().getAssociated(primaryResource);
+    return eventSource().getAssociatedResource(primaryResource);
   }
 
   @Override
@@ -25,7 +25,7 @@ public Class<R> resourceType() {
   }
 
   @Override
-  public Optional<R> getResource(P primaryResource) {
-    return eventSource().getAssociated(primaryResource);
+  public Optional<R> getAssociatedResource(P primaryResource) {
+    return eventSource().getAssociatedResource(primaryResource);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java

@@ -31,7 +31,7 @@ public AbstractSimpleDependentResource(UpdatableCache<R> cache) {
   }
 
   @Override
-  public Optional<R> getResource(HasMetadata primaryResource) {
+  public Optional<R> getAssociatedResource(HasMetadata primaryResource) {
     return cache.get(ResourceID.fromResource(primaryResource));
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java

@@ -97,7 +97,7 @@ public Result<R> match(R actualResource, P primary, Context<P> context) {
 
   public void delete(P primary, Context<P> context) {
     if (!addOwnerReference()) {
-      var resource = getResource(primary);
+      var resource = getAssociatedResource(primary);
       resource.ifPresent(r -> client.resource(r).delete());
     }
   }
@@ -134,8 +134,8 @@ public Class<R> resourceType() {
   }
 
   @Override
-  public Optional<R> getResource(P primaryResource) {
-    return eventSource().getAssociated(primaryResource);
+  public Optional<R> getAssociatedResource(P primaryResource) {
+    return eventSource().getAssociatedResource(primaryResource);
   }
 
   @Override

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

@@ -86,7 +86,7 @@ private void logEventSourceEvent(NamedEventSource eventSource, String event) {
       if (eventSource instanceof ResourceEventSource) {
         ResourceEventSource source = (ResourceEventSource) eventSource;
         log.debug("{} event source {} for {}", event, eventSource.name(),
-            source.getResourceClass());
+            source.resourceType());
       } else {
         log.debug("{} event source {}", event, eventSource.name());
       }
@@ -171,12 +171,12 @@ public ControllerResourceEventSource<R> getControllerResourceEventSource() {
     return eventSources.controllerResourceEventSource();
   }
 
-  public <S> Optional<ResourceEventSource<R, S>> getResourceEventSourceFor(
+  public <S> Optional<ResourceEventSource<S, R>> getResourceEventSourceFor(
       Class<S> dependentType) {
     return getResourceEventSourceFor(dependentType, null);
   }
 
-  public <S> Optional<ResourceEventSource<R, S>> getResourceEventSourceFor(
+  public <S> Optional<ResourceEventSource<S, R>> getResourceEventSourceFor(
       Class<S> dependentType, String qualifier) {
     if (dependentType == null) {
       return Optional.empty();

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

@@ -9,6 +9,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.Controller;
+import io.javaoperatorsdk.operator.processing.ResourceOwner;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ControllerResourceEventSource;
@@ -68,8 +69,8 @@ public void add(String name, EventSource eventSource) {
 
   @SuppressWarnings("rawtypes")
   private Class<?> getDependentType(EventSource source) {
-    return source instanceof ResourceEventSource
-        ? ((ResourceEventSource) source).getResourceClass()
+    return source instanceof ResourceOwner
+        ? ((ResourceOwner) source).resourceType()
         : source.getClass();
   }
 
@@ -84,7 +85,7 @@ private String keyFor(Class<?> dependentType) {
     // this is needed so that these sources are set when informer sources start so that events can
     // properly be processed
     if (controllerResourceEventSource != null
-        && key.equals(controllerResourceEventSource.getResourceClass().getCanonicalName())) {
+        && key.equals(controllerResourceEventSource.resourceType().getCanonicalName())) {
       key = 1 + "-" + key;
     } else if (key.equals(retryAndRescheduleTimerEventSource.getClass().getCanonicalName())) {
       key = 0 + "-" + key;
@@ -93,7 +94,7 @@ private String keyFor(Class<?> dependentType) {
   }
 
   @SuppressWarnings("unchecked")
-  public <S> ResourceEventSource<R, S> get(Class<S> dependentType, String name) {
+  public <S> ResourceEventSource<S, R> get(Class<S> dependentType, String name) {
     final var sourcesForType = sources.get(keyFor(dependentType));
     if (sourcesForType == null || sourcesForType.isEmpty()) {
       return null;
@@ -122,8 +123,8 @@ public <S> ResourceEventSource<R, S> get(Class<S> dependentType, String name) {
           + keyAsString(dependentType, name) + " is not a "
           + ResourceEventSource.class.getSimpleName());
     }
-    final var res = (ResourceEventSource<R, S>) source;
-    final var resourceClass = res.getResourceClass();
+    final var res = (ResourceEventSource<S, R>) source;
+    final var resourceClass = res.resourceType();
     if (!resourceClass.isAssignableFrom(dependentType)) {
       throw new IllegalArgumentException(source + " associated with "
           + keyAsString(dependentType, name)

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/AbstractResourceEventSource.java

@@ -4,15 +4,15 @@
 
 public abstract class AbstractResourceEventSource<P extends HasMetadata, R>
     extends AbstractEventSource
-    implements ResourceEventSource<P, R> {
+    implements ResourceEventSource<R, P> {
   private final Class<R> resourceClass;
 
   protected AbstractResourceEventSource(Class<R> resourceClass) {
     this.resourceClass = resourceClass;
   }
 
   @Override
-  public Class<R> getResourceClass() {
+  public Class<R> resourceType() {
     return resourceClass;
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CachingEventSource.java

@@ -54,7 +54,7 @@ public Optional<R> getCachedValue(ResourceID resourceID) {
   }
 
   @Override
-  public Optional<R> getAssociated(P primary) {
+  public Optional<R> getAssociatedResource(P primary) {
     return cache.get(ResourceID.fromResource(primary));
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/ResourceEventSource.java

@@ -1,12 +1,9 @@
 package io.javaoperatorsdk.operator.processing.event.source;
 
-import java.util.Optional;
-
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.ResourceOwner;
 
-public interface ResourceEventSource<P extends HasMetadata, R> extends EventSource {
-
-  Class<R> getResourceClass();
+public interface ResourceEventSource<R, P extends HasMetadata> extends EventSource,
+    ResourceOwner<R, P> {
 
-  Optional<R> getAssociated(P primary);
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerResourceEventSource.java

@@ -29,6 +29,7 @@ public class ControllerResourceEventSource<T extends HasMetadata>
   private final Controller<T> controller;
   private final ResourceEventFilter<T> filter;
 
+  @SuppressWarnings("unchecked")
   public ControllerResourceEventSource(Controller<T> controller) {
     super(controller.getCRClient(), controller.getConfiguration());
     this.controller = controller;
@@ -101,7 +102,7 @@ private void handleKubernetesClientException(Exception e) {
   }
 
   @Override
-  public Optional<T> getAssociated(T primary) {
+  public Optional<T> getAssociatedResource(T primary) {
     return get(ResourceID.fromResource(primary));
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java

@@ -152,7 +152,7 @@ private void propagateEvent(R object) {
    * @return the informed resource associated with the specified primary resource
    */
   @Override
-  public Optional<R> getAssociated(P resource) {
+  public Optional<R> getAssociatedResource(P resource) {
     final var id = configuration.getAssociatedResourceIdentifier().associatedSecondaryID(resource);
     return get(id);
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java

@@ -93,7 +93,7 @@ public Optional<R> get(ResourceID resourceID) {
   }
 
   @Override
-  public Optional<R> getAssociated(P primary) {
+  public Optional<R> getAssociatedResource(P primary) {
     return get(ResourceID.fromResource(primary));
   }
 
@@ -119,9 +119,7 @@ public Stream<R> list(String namespace, Predicate<R> predicate) {
     return manager().list(namespace, predicate);
   }
 
-  ManagedInformerEventSource<R, P, C> setTemporalResourceCache(
-      TemporaryResourceCache<R> temporaryResourceCache) {
+  void setTemporalResourceCache(TemporaryResourceCache<R> temporaryResourceCache) {
     this.temporaryResourceCache = temporaryResourceCache;
-    return this;
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PerResourcePollingEventSource.java

@@ -132,7 +132,7 @@ public void run() {
    * @return the related resource for this event source
    */
   @Override
-  public Optional<R> getAssociated(P primary) {
+  public Optional<R> getAssociatedResource(P primary) {
     return getValueFromCacheOrSupplier(ResourceID.fromResource(primary));
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PollingEventSource.java

@@ -1,6 +1,9 @@
 package io.javaoperatorsdk.operator.processing.event.source.polling;
 
-import java.util.*;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Timer;
+import java.util.TimerTask;
 import java.util.function.Supplier;
 
 import org.slf4j.Logger;
@@ -95,7 +98,7 @@ public void stop() throws OperatorException {
    * @return related resource
    */
   @Override
-  public Optional<R> getAssociated(P primary) {
+  public Optional<R> getAssociatedResource(P primary) {
     return getCachedValue(ResourceID.fromResource(primary));
   }
 }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/UtilsTest.java

@@ -98,7 +98,7 @@ public ReconcileResult<Deployment> reconcile(TestCustomResource primary,
     }
 
     @Override
-    public Optional<Deployment> getResource(TestCustomResource primaryResource) {
+    public Optional<Deployment> getAssociatedResource(TestCustomResource primaryResource) {
       return Optional.empty();
     }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResourceTest.java

@@ -45,14 +45,14 @@ void getsTheResourceFromSupplyIfReconciling() {
     simpleDependentResource.reconcile(TestUtils.testCustomResource1(), null);
 
     verify(supplierMock, times(1)).get();
-    assertThat(simpleDependentResource.getResource(TestUtils.testCustomResource1()))
+    assertThat(simpleDependentResource.getAssociatedResource(TestUtils.testCustomResource1()))
         .isPresent()
         .isEqualTo(Optional.of(SampleExternalResource.testResource1()));
   }
 
   @Test
   void getResourceReadsTheResourceFromCache() {
-    simpleDependentResource.getResource(TestUtils.testCustomResource1());
+    simpleDependentResource.getAssociatedResource(TestUtils.testCustomResource1());
 
     verify(supplierMock, times(0)).get();
     verify(updatableCacheMock, times(1)).get(any());