feat: add validation method on interfaces instead of implementations

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -30,6 +30,20 @@ default String getFinalizerName() {
     return ReconcilerUtils.getDefaultFinalizerName(getResourceClass());
   }
 
+  static String ensureValidFinalizerName(String finalizer, String resourceTypeName) {
+    if (finalizer != null && !finalizer.isBlank()) {
+      if (ReconcilerUtils.isFinalizerValid(finalizer)) {
+        return finalizer;
+      } else {
+        throw new IllegalArgumentException(
+            finalizer
+                + " is not a valid finalizer. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers for details");
+      }
+    } else {
+      return ReconcilerUtils.getDefaultFinalizerName(resourceTypeName);
+    }
+  }
+
   default boolean isGenerationAware() {
     return true;
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultResourceConfiguration.java

@@ -1,18 +1,14 @@
 package io.javaoperatorsdk.operator.api.config;
 
-import java.util.Collection;
 import java.util.Optional;
 import java.util.Set;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
-import io.javaoperatorsdk.operator.api.reconciler.Constants;
 import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 
-import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
-
 public class DefaultResourceConfiguration<R extends HasMetadata>
     implements ResourceConfiguration<R> {
 
@@ -21,36 +17,20 @@ public class DefaultResourceConfiguration<R extends HasMetadata>
   private final Optional<OnAddFilter<R>> onAddFilter;
   private final Optional<OnUpdateFilter<R>> onUpdateFilter;
   private final Optional<GenericFilter<R>> genericFilter;
-
-
-  private String labelSelector;
-  private Set<String> namespaces;
-
-  public DefaultResourceConfiguration(String labelSelector, Class<R> resourceClass,
-      OnAddFilter<R> onAddFilter,
-      OnUpdateFilter<R> onUpdateFilter, GenericFilter<R> genericFilter, String... namespaces) {
-    this(labelSelector, resourceClass, onAddFilter, onUpdateFilter, genericFilter,
-        namespaces == null || namespaces.length == 0 ? DEFAULT_NAMESPACES_SET
-            : Set.of(namespaces));
-  }
-
-  public DefaultResourceConfiguration(String labelSelector, Class<R> resourceClass,
-      OnAddFilter<R> onAddFilter,
-      OnUpdateFilter<R> onUpdateFilter, GenericFilter<R> genericFilter, Set<String> namespaces) {
-    this(resourceClass, onAddFilter, onUpdateFilter, genericFilter, namespaces);
-    setLabelSelector(labelSelector);
-  }
+  private final String labelSelector;
+  private final Set<String> namespaces;
 
   protected DefaultResourceConfiguration(Class<R> resourceClass,
-      OnAddFilter<R> onAddFilter,
-      OnUpdateFilter<R> onUpdateFilter, GenericFilter<R> genericFilter, Set<String> namespaces) {
+      Set<String> namespaces, String labelSelector, OnAddFilter<R> onAddFilter,
+      OnUpdateFilter<R> onUpdateFilter, GenericFilter<R> genericFilter) {
     this.resourceClass = resourceClass;
     this.resourceTypeName = ReconcilerUtils.getResourceTypeName(resourceClass);
     this.onAddFilter = Optional.ofNullable(onAddFilter);
     this.onUpdateFilter = Optional.ofNullable(onUpdateFilter);
     this.genericFilter = Optional.ofNullable(genericFilter);
 
-    setNamespaces(namespaces);
+    this.namespaces = ResourceConfiguration.ensureValidNamespaces(namespaces);
+    this.labelSelector = ResourceConfiguration.ensureValidLabelSelector(labelSelector);
   }
 
   @Override
@@ -63,22 +43,11 @@ public String getLabelSelector() {
     return labelSelector;
   }
 
-  protected void setLabelSelector(String labelSelector) {
-    this.labelSelector = labelSelector;
-  }
-
   @Override
   public Set<String> getNamespaces() {
     return namespaces;
   }
 
-  protected void setNamespaces(Collection<String> namespaces) {
-    if (namespaces != null && !namespaces.isEmpty()) {
-      this.namespaces = Set.copyOf(namespaces);
-    } else {
-      this.namespaces = Constants.DEFAULT_NAMESPACES_SET;
-    }
-  }
 
   @Override
   public Class<R> getResourceClass() {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResolvedControllerConfiguration.java

@@ -8,7 +8,6 @@
 import java.util.concurrent.TimeUnit;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
@@ -29,11 +28,10 @@ public class ResolvedControllerConfiguration<P extends HasMetadata>
   private final Retry retry;
   private final RateLimiter rateLimiter;
   private final Optional<Duration> maxReconciliationInterval;
+  private final String finalizer;
 
   private ResourceEventFilter<P> eventFilter;
   private List<DependentResourceSpec> dependentResources;
-  private String finalizer;
-
 
   public ResolvedControllerConfiguration(Class<P> resourceClass, ControllerConfiguration<P> other) {
     this(resourceClass, other.getName(), other.isGenerationAware(),
@@ -78,16 +76,16 @@ protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
       RateLimiter rateLimiter, Duration maxReconciliationInterval,
       OnAddFilter<P> onAddFilter, OnUpdateFilter<P> onUpdateFilter, GenericFilter<P> genericFilter,
       Set<String> namespaces, String finalizer, String labelSelector) {
-    super(resourceClass, onAddFilter, onUpdateFilter, genericFilter, namespaces);
+    super(resourceClass, namespaces, labelSelector, onAddFilter, onUpdateFilter, genericFilter);
     this.name = name;
     this.generationAware = generationAware;
     this.associatedReconcilerClassName = associatedReconcilerClassName;
     this.retry = ensureRetry(retry);
     this.rateLimiter = ensureRateLimiter(rateLimiter);
     this.maxReconciliationInterval = Optional.ofNullable(maxReconciliationInterval);
 
-    setFinalizer(finalizer);
-    setLabelSelector(labelSelector);
+    this.finalizer =
+        ControllerConfiguration.ensureValidFinalizerName(finalizer, getResourceTypeName());
   }
 
   protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
@@ -107,20 +105,6 @@ public String getFinalizerName() {
     return finalizer;
   }
 
-  protected void setFinalizer(String finalizer) {
-    if (finalizer != null && !finalizer.isBlank()) {
-      if (ReconcilerUtils.isFinalizerValid(finalizer)) {
-        this.finalizer = finalizer;
-      } else {
-        throw new IllegalArgumentException(
-            finalizer
-                + " is not a valid finalizer. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers for details");
-      }
-    } else {
-      this.finalizer = ReconcilerUtils.getDefaultFinalizerName(getResourceTypeName());
-    }
-  }
-
   @Override
   public boolean isGenerationAware() {
     return generationAware;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java

@@ -1,5 +1,6 @@
 package io.javaoperatorsdk.operator.api.config;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.Optional;
 import java.util.Set;
@@ -45,6 +46,11 @@ default String getLabelSelector() {
     return null;
   }
 
+  static String ensureValidLabelSelector(String labelSelector) {
+    // might want to implement validation here?
+    return labelSelector;
+  }
+
   @SuppressWarnings("unchecked")
   default Class<R> getResourceClass() {
     return (Class<R>) Utils.getFirstTypeArgumentFromSuperClassOrInterface(getClass(),
@@ -88,6 +94,14 @@ static void failIfNotValid(Set<String> namespaces) {
             + Constants.WATCH_CURRENT_NAMESPACE + "'");
   }
 
+  static Set<String> ensureValidNamespaces(Collection<String> namespaces) {
+    if (namespaces != null && !namespaces.isEmpty()) {
+      return Set.copyOf(namespaces);
+    } else {
+      return Constants.DEFAULT_NAMESPACES_SET;
+    }
+  }
+
   /**
    * Computes the effective namespaces based on the set specified by the user, in particular
    * retrieves the current namespace from the client when the user specified that they wanted to

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java

@@ -39,7 +39,7 @@ protected DefaultInformerConfiguration(String labelSelector,
         OnUpdateFilter<R> onUpdateFilter,
         OnDeleteFilter<R> onDeleteFilter,
         GenericFilter<R> genericFilter) {
-      super(labelSelector, resourceClass, onAddFilter, onUpdateFilter, genericFilter, namespaces);
+      super(resourceClass, namespaces, labelSelector, onAddFilter, onUpdateFilter, genericFilter);
       this.followControllerNamespaceChanges = followControllerNamespaceChanges;
 
       this.primaryToSecondaryMapper = primaryToSecondaryMapper;