feat: make ControllerConfiguration easier to implement for simple cases

Now providing default implementation for most methods. Removed confusing
AbstractConfiguration and AnnotationConfiguration classes.

Author: metacosm

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

@@ -1,23 +1,38 @@
 package io.javaoperatorsdk.operator.api.config;
 
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.ControllerUtils;
 import io.javaoperatorsdk.operator.api.Controller;
+import java.lang.reflect.ParameterizedType;
 import java.util.Collections;
 import java.util.Set;
 
 public interface ControllerConfiguration<R extends CustomResource> {
 
-  String getName();
+  default String getName() {
+    return ControllerUtils.getDefaultResourceControllerName(getAssociatedControllerClassName());
+  }
 
-  String getCRDName();
+  default String getCRDName() {
+    return CustomResource.getCRDName(getCustomResourceClass());
+  }
 
-  String getFinalizer();
+  default String getFinalizer() {
+    return ControllerUtils.getDefaultFinalizerName(getCRDName());
+  }
 
-  String getLabelSelector();
+  default String getLabelSelector() {
+    return null;
+  }
 
-  boolean isGenerationAware();
+  default boolean isGenerationAware() {
+    return true;
+  }
 
-  Class<R> getCustomResourceClass();
+  default Class<R> getCustomResourceClass() {
+    ParameterizedType type = (ParameterizedType) getClass().getGenericInterfaces()[0];
+    return (Class<R>) type.getActualTypeArguments()[0];
+  }
 
   String getAssociatedControllerClassName();
 
@@ -69,7 +84,7 @@ default RetryConfiguration getRetryConfiguration() {
 
   ConfigurationService getConfigurationService();
 
-  void setConfigurationService(ConfigurationService service);
+  default void setConfigurationService(ConfigurationService service) {}
 
   default boolean useFinalizer() {
     return !Controller.NO_FINALIZER.equals(getFinalizer());

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

@@ -0,0 +1,25 @@
+package io.javaoperatorsdk.operator.api.config;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
+import org.junit.jupiter.api.Test;
+
+class ControllerConfigurationTest {
+
+  @Test
+  void getCustomResourceClass() {
+    final ControllerConfiguration<TestCustomResource> conf = new ControllerConfiguration<>() {
+      @Override
+      public String getAssociatedControllerClassName() {
+        return null;
+      }
+
+      @Override
+      public ConfigurationService getConfigurationService() {
+        return null;
+      }
+    };
+    assertEquals(TestCustomResource.class, conf.getCustomResourceClass());
+  }
+}

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

@@ -14,15 +14,13 @@
 import io.fabric8.kubernetes.client.VersionInfo;
 import io.fabric8.kubernetes.client.server.mock.EnableKubernetesMockClient;
 import io.fabric8.kubernetes.client.server.mock.KubernetesMockServer;
-import io.javaoperatorsdk.operator.ControllerUtils;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.Context;
 import io.javaoperatorsdk.operator.api.Controller;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.UpdateControl;
-import io.javaoperatorsdk.operator.api.config.AbstractConfiguration;
-import io.javaoperatorsdk.operator.api.config.AnnotationConfiguration;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.Version;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
 import java.text.ParseException;
@@ -70,14 +68,8 @@ void setUpResources() throws ParseException {
     configurationService = spy(ConfigurationService.class);
     when(configurationService.checkCRDAndValidateLocalModel()).thenReturn(false);
     when(configurationService.getVersion()).thenReturn(new Version("1", "1", new Date()));
-    when(configurationService.getConfigurationFor(any(ResourceController.class)))
-        .thenAnswer(
-            invocation -> {
-              var answer =
-                  new AnnotationConfiguration<>(MyController.class, TestCustomResource.class);
-              answer.setConfigurationService(configurationService);
-              return answer;
-            });
+    when(configurationService.getConfigurationFor(any(MyController.class))).thenReturn(
+        new MyConfiguration(configurationService, null));
   }
 
   @Test
@@ -145,30 +137,29 @@ public TestCustomResource newMyResource(String app) {
     return resource;
   }
 
-  public static class MyConfiguration extends AbstractConfiguration<TestCustomResource> {
+  public static class MyConfiguration implements ControllerConfiguration<TestCustomResource> {
 
     private final String labelSelector;
+    private final ConfigurationService service;
 
     public MyConfiguration(ConfigurationService configurationService, String labelSelector) {
-      super(MyController.class, TestCustomResource.class);
       this.labelSelector = labelSelector;
-
-      setConfigurationService(configurationService);
+      service = configurationService;
     }
 
     @Override
-    public String getFinalizer() {
-      return ControllerUtils.getDefaultFinalizerName(getCRDName());
+    public String getLabelSelector() {
+      return labelSelector;
     }
 
     @Override
-    public String getLabelSelector() {
-      return labelSelector;
+    public String getAssociatedControllerClassName() {
+      return MyController.class.getCanonicalName();
     }
 
     @Override
-    public boolean isGenerationAware() {
-      return true;
+    public ConfigurationService getConfigurationService() {
+      return service;
     }
   }
 

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

@@ -1,17 +1,68 @@
 package io.javaoperatorsdk.operator.config.runtime;
 
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.ControllerUtils;
+import io.javaoperatorsdk.operator.api.Controller;
 import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.Predicate;
 
-/** @deprecated use {@link io.javaoperatorsdk.operator.api.config.AnnotationConfiguration} */
-@Deprecated
-@SuppressWarnings("unchecked")
 public class AnnotationConfiguration<R extends CustomResource>
-    extends io.javaoperatorsdk.operator.api.config.AnnotationConfiguration<R> {
+    implements ControllerConfiguration<R> {
+
+  private final ResourceController<R> controller;
+  private final Optional<Controller> annotation;
+  private ConfigurationService service;
 
   public AnnotationConfiguration(ResourceController<R> controller) {
-    super(
-        (Class<ResourceController<R>>) controller.getClass(),
-        RuntimeControllerMetadata.getCustomResourceClass(controller));
+    this.controller = controller;
+    this.annotation = Optional.ofNullable(controller.getClass().getAnnotation(Controller.class));
+  }
+
+  @Override
+  public String getName() {
+    return ControllerUtils.getNameFor(controller);
+  }
+
+  @Override
+  public String getFinalizer() {
+    return annotation
+        .map(Controller::finalizerName)
+        .filter(Predicate.not(String::isBlank))
+        .orElse(ControllerUtils.getDefaultFinalizerName(getCRDName()));
+  }
+
+  @Override
+  public boolean isGenerationAware() {
+    return annotation.map(Controller::generationAwareEventProcessing).orElse(true);
+  }
+
+  @Override
+  public Class<R> getCustomResourceClass() {
+    return RuntimeControllerMetadata.getCustomResourceClass(controller);
+  }
+
+  @Override
+  public Set<String> getNamespaces() {
+    return Set.of(annotation.map(Controller::namespaces).orElse(new String[] {}));
+  }
+
+  @Override
+  public ConfigurationService getConfigurationService() {
+    return service;
+  }
+
+  @Override
+  public void setConfigurationService(ConfigurationService service) {
+    this.service = service;
+  }
+
+  @Override
+  public String getAssociatedControllerClassName() {
+    return controller.getClass().getCanonicalName();
   }
 }
+