feat: add owner reference automatic config (#1083)

csviri · web-flow · commit 4e350ec5518b · 2022-03-25T08:35:06.000+01:00
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AnnotationControllerConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AnnotationControllerConfiguration.java
@@ -156,13 +156,8 @@ public static <T> T valueOrDefault(
                   this.getNamespaces().toArray(new String[0]));
           final var labelSelector =
               Utils.valueOrDefault(kubeDependent, KubernetesDependent::labelSelector, null);
-          final var addOwnerReference =
-              Utils.valueOrDefault(
-                  kubeDependent,
-                  KubernetesDependent::addOwnerReference,
-                  KubernetesDependent.ADD_OWNER_REFERENCE_DEFAULT);
           config =
-              new KubernetesDependentResourceConfig(addOwnerReference, namespaces, labelSelector);
+              new KubernetesDependentResourceConfig(namespaces, labelSelector);
         }
         specs.add(new DependentResourceSpec(dependentType, config));
       }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java
@@ -12,8 +12,9 @@ public abstract class AbstractDependentResource<R, P extends HasMetadata>
     implements DependentResource<R, P> {
   private static final Logger log = LoggerFactory.getLogger(AbstractDependentResource.class);
 
-  private final boolean creatable = this instanceof Creator;
-  private final boolean updatable = this instanceof Updater;
+  protected final boolean creatable = this instanceof Creator;
+  protected final boolean updatable = this instanceof Updater;
+  protected final boolean deletable = this instanceof Deleter;
   protected Creator<R, P> creator;
   protected Updater<R, P> updater;
 
@@ -25,20 +26,18 @@ public AbstractDependentResource() {
 
   @Override
   public ReconcileResult<R> reconcile(P primary, Context<P> context) {
-    final var isCreatable = isCreatable(primary, context);
-    final var isUpdatable = isUpdatable(primary, context);
     var maybeActual = getResource(primary);
-    if (isCreatable || isUpdatable) {
+    if (creatable || updatable) {
       if (maybeActual.isEmpty()) {
-        if (isCreatable) {
+        if (creatable) {
           var desired = desired(primary, context);
           log.debug("Creating dependent {} for primary {}", desired, primary);
           var createdResource = handleCreate(desired, primary, context);
           return ReconcileResult.resourceCreated(createdResource);
         }
       } else {
         final var actual = maybeActual.get();
-        if (isUpdatable) {
+        if (updatable) {
           final var match = updater.match(actual, primary, context);
           if (!match.matched()) {
             final var desired = match.computedDesired().orElse(desired(primary, context));
@@ -149,15 +148,4 @@ protected R desired(P primary, Context<P> context) {
     throw new IllegalStateException(
         "desired method must be implemented if this DependentResource can be created and/or updated");
   }
-
-  @SuppressWarnings("unused")
-  protected boolean isCreatable(P primary, Context<P> context) {
-    return creatable;
-  }
-
-  @SuppressWarnings("unused")
-  protected boolean isUpdatable(P primary, Context<P> context) {
-    return updatable;
-  }
-
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependent.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependent.java
@@ -11,10 +11,6 @@
 @Target({ElementType.TYPE})
 public @interface KubernetesDependent {
 
-  boolean ADD_OWNER_REFERENCE_DEFAULT = true;
-
-  boolean addOwnerReference() default ADD_OWNER_REFERENCE_DEFAULT;
-
   /**
    * Specified which namespaces this Controller monitors for custom resources events. If no
    * namespace is specified then the controller will monitor the namespaces configured for the
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
@@ -37,7 +37,6 @@ public abstract class KubernetesDependentResource<R extends HasMetadata, P exten
 
   protected KubernetesClient client;
   private InformerEventSource<R, P> informerEventSource;
-  private boolean addOwnerReference;
   private final Matcher<R, P> matcher;
   private final ResourceUpdatePreProcessor<R> processor;
   private final Class<R> resourceType;
@@ -55,12 +54,11 @@ public KubernetesDependentResource(Class<R> resourceType) {
 
   @Override
   public void configureWith(KubernetesDependentResourceConfig config) {
-    configureWith(config.labelSelector(), Set.of(config.namespaces()), config.addOwnerReference());
+    configureWith(config.labelSelector(), Set.of(config.namespaces()));
   }
 
   @SuppressWarnings("unchecked")
-  private void configureWith(String labelSelector, Set<String> namespaces,
-      boolean addOwnerReference) {
+  private void configureWith(String labelSelector, Set<String> namespaces) {
     final var primaryResourcesRetriever =
         (this instanceof SecondaryToPrimaryMapper) ? (SecondaryToPrimaryMapper<R>) this
             : Mappers.fromOwnerReference();
@@ -75,20 +73,18 @@ private void configureWith(String labelSelector, Set<String> namespaces,
             .withPrimaryResourcesRetriever(primaryResourcesRetriever)
             .withAssociatedSecondaryResourceIdentifier(secondaryResourceIdentifier)
             .build();
-    configureWith(new InformerEventSource<>(ic, client), addOwnerReference);
+    configureWith(new InformerEventSource<>(ic, client));
   }
 
   /**
    * Use to share informers between event more resources.
    *
-   * @param informerEventSource informer to use
-   * @param addOwnerReference to the created resource
+   * @param informerEventSource informer to use*
    */
   public void configureWith(
-      InformerEventSource<R, P> informerEventSource,
-      boolean addOwnerReference) {
+      InformerEventSource<R, P> informerEventSource) {
     this.informerEventSource = informerEventSource;
-    this.addOwnerReference = addOwnerReference;
+
   }
 
   public R create(R target, P primary, Context<P> context) {
@@ -105,7 +101,7 @@ public Result<R> match(R actualResource, P primary, Context<P> context) {
   }
 
   public void delete(P primary, Context<P> context) {
-    if (!addOwnerReference) {
+    if (!addOwnerReference()) {
       var resource = getResource(primary);
       resource.ifPresent(r -> client.resource(r).delete());
     }
@@ -118,7 +114,7 @@ protected NonNamespaceOperation<R, KubernetesResourceList<R>, Resource<R>> prepa
         actionName,
         desired.getClass(),
         ResourceID.fromResource(desired));
-    if (addOwnerReference) {
+    if (addOwnerReference()) {
       desired.addOwnerReference(primary);
     }
     Class<R> targetClass = (Class<R>) desired.getClass();
@@ -128,7 +124,7 @@ protected NonNamespaceOperation<R, KubernetesResourceList<R>, Resource<R>> prepa
   @Override
   public EventSource initEventSource(EventSourceContext<P> context) {
     if (informerEventSource == null) {
-      configureWith(null, null, KubernetesDependent.ADD_OWNER_REFERENCE_DEFAULT);
+      configureWith(null, null);
       log.warn("Using default configuration for " + resourceType().getSimpleName()
           + " KubernetesDependentResource, call configureWith to provide configuration");
     }
@@ -141,6 +137,10 @@ public KubernetesDependentResource<R, P> setInformerEventSource(
     return this;
   }
 
+  protected boolean addOwnerReference() {
+    return creatable && !deletable;
+  }
+
   @Override
   public Class<R> resourceType() {
     return resourceType;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java
@@ -1,29 +1,20 @@
 package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
 
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.EMPTY_STRING;
-import static io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent.ADD_OWNER_REFERENCE_DEFAULT;
 
 public class KubernetesDependentResourceConfig {
 
-  private boolean addOwnerReference = ADD_OWNER_REFERENCE_DEFAULT;
   private String[] namespaces = new String[0];
   private String labelSelector = EMPTY_STRING;
 
   public KubernetesDependentResourceConfig() {}
 
-  public KubernetesDependentResourceConfig(boolean addOwnerReference, String[] namespaces,
+  public KubernetesDependentResourceConfig(String[] namespaces,
       String labelSelector) {
-    this.addOwnerReference = addOwnerReference;
     this.namespaces = namespaces;
     this.labelSelector = labelSelector;
   }
 
-  public KubernetesDependentResourceConfig setAddOwnerReference(
-      boolean addOwnerReference) {
-    this.addOwnerReference = addOwnerReference;
-    return this;
-  }
-
   public KubernetesDependentResourceConfig setNamespaces(String[] namespaces) {
     this.namespaces = namespaces;
     return this;
@@ -34,10 +25,6 @@ public KubernetesDependentResourceConfig setLabelSelector(String labelSelector)
     return this;
   }
 
-  public boolean addOwnerReference() {
-    return addOwnerReference;
-  }
-
   public String[] namespaces() {
     return namespaces;
   }
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/cleanermanageddependent/ConfigMapDependentResource.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/cleanermanageddependent/ConfigMapDependentResource.java
@@ -38,6 +38,11 @@ public void delete(CleanerForManagedDependentCustomResource primary,
     numberOfCleanupExecutions.incrementAndGet();
   }
 
+  @Override
+  protected boolean addOwnerReference() {
+    return true;
+  }
+
   public static int getNumberOfCleanupExecutions() {
     return numberOfCleanupExecutions.get();
   }
diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java
@@ -3,7 +3,7 @@
 import io.fabric8.kubernetes.api.model.ConfigMapVolumeSourceBuilder;
 import io.fabric8.kubernetes.api.model.apps.Deployment;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
@@ -12,7 +12,7 @@
 
 // this annotation only activates when using managed dependents and is not otherwise needed
 @KubernetesDependent(labelSelector = WebPageManagedDependentsReconciler.SELECTOR)
-class DeploymentDependentResource extends CRUDKubernetesDependentResource<Deployment, WebPage> {
+class DeploymentDependentResource extends CRUKubernetesDependentResource<Deployment, WebPage> {
 
   public DeploymentDependentResource() {
     super(Deployment.class);
diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java
@@ -5,7 +5,7 @@
 
 import io.fabric8.kubernetes.api.model.Service;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
@@ -14,7 +14,7 @@
 
 // this annotation only activates when using managed dependents and is not otherwise needed
 @KubernetesDependent(labelSelector = WebPageManagedDependentsReconciler.SELECTOR)
-class ServiceDependentResource extends CRUDKubernetesDependentResource<Service, WebPage> {
+class ServiceDependentResource extends CRUKubernetesDependentResource<Service, WebPage> {
 
   public ServiceDependentResource() {
     super(Service.class);

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,11 @@ public void delete(CleanerForManagedDependentCustomResource primary,`
`38`	`38`	`numberOfCleanupExecutions.incrementAndGet();`
`39`	`39`	`}`
`40`	`40`
	`41`	`+ @Override`
	`42`	`+ protected boolean addOwnerReference() {`
	`43`	`+ return true;`
	`44`	`+ }`
	`45`	`+`
`41`	`46`	`public static int getNumberOfCleanupExecutions() {`
`42`	`47`	`return numberOfCleanupExecutions.get();`
`43`	`48`	`}`