fix: clean up controller default name generation

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

@@ -1,8 +1,6 @@
 package io.javaoperatorsdk.operator;
 
 import io.fabric8.kubernetes.client.CustomResource;
-import io.javaoperatorsdk.operator.api.ResourceController;
-import java.util.Locale;
 
 public class ControllerUtils {
 
@@ -16,20 +14,4 @@ public static boolean hasGivenFinalizer(CustomResource resource, String finalize
     return resource.getMetadata().getFinalizers() != null
         && resource.getMetadata().getFinalizers().contains(finalizer);
   }
-
-  public static String getDefaultNameFor(ResourceController controller) {
-    return getDefaultNameFor(controller.getClass());
-  }
-
-  public static String getDefaultNameFor(Class<? extends ResourceController> controllerClass) {
-    return getDefaultResourceControllerName(controllerClass.getSimpleName());
-  }
-
-  public static String getDefaultResourceControllerName(String rcControllerClassName) {
-    final var lastDot = rcControllerClassName.lastIndexOf('.');
-    if (lastDot > 0) {
-      rcControllerClassName = rcControllerClassName.substring(lastDot);
-    }
-    return rcControllerClassName.toLowerCase(Locale.ROOT);
-  }
 }

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

@@ -40,10 +40,12 @@ public interface ResourceController<R extends CustomResource> {
   default void init(EventSourceManager eventSourceManager) {}
 
   default String getName() {
-    final var clazz = getClass();
+    return getNameFor(this);
+  }
 
+  static String getNameFor(Class<? extends ResourceController> controllerClass) {
     // if the controller annotation has a name attribute, use it
-    final var annotation = clazz.getAnnotation(Controller.class);
+    final var annotation = controllerClass.getAnnotation(Controller.class);
     if (annotation != null) {
       final var name = annotation.name();
       if (!Controller.NULL.equals(name)) {
@@ -52,6 +54,27 @@ default String getName() {
     }
 
     // otherwise, use the lower-cased full class name
-    return clazz.getCanonicalName().toLowerCase(Locale.ROOT);
+    return getDefaultNameFor(controllerClass);
+  }
+
+  static String getNameFor(ResourceController controller) {
+    return getNameFor(controller.getClass());
+  }
+
+  static String getDefaultNameFor(ResourceController controller) {
+    return getDefaultNameFor(controller.getClass());
+  }
+
+  static String getDefaultNameFor(Class<? extends ResourceController> controllerClass) {
+    return getDefaultResourceControllerName(controllerClass.getSimpleName());
+  }
+
+  static String getDefaultResourceControllerName(String rcControllerClassName) {
+    // if the name is fully qualified, extract the simple class name
+    final var lastDot = rcControllerClassName.lastIndexOf('.');
+    if (lastDot > 0) {
+      rcControllerClassName = rcControllerClassName.substring(lastDot);
+    }
+    return rcControllerClassName.toLowerCase(Locale.ROOT);
   }
 }

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

@@ -0,0 +1,32 @@
+package io.javaoperatorsdk.operator.api.config;
+
+import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.ResourceController;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+public abstract class AbstractConfigurationService implements ConfigurationService {
+
+  protected final Map<String, ControllerConfiguration> configurations = new ConcurrentHashMap<>();
+
+  protected <R extends CustomResource> void register(ControllerConfiguration<R> config) {
+    final var name = config.getName();
+    final var existing = configurations.get(name);
+    if (existing != null) {
+      throw new IllegalArgumentException(
+          "Controller name '"
+              + name
+              + "' is used by both "
+              + existing.getAssociatedControllerClassName()
+              + " and "
+              + config.getAssociatedControllerClassName());
+    }
+    configurations.put(name, config);
+  }
+
+  @Override
+  public <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
+      ResourceController<R> controller) {
+    return configurations.get(controller.getName());
+  }
+}

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

@@ -21,6 +21,8 @@ public interface ControllerConfiguration<R extends CustomResource> {
 
   Class<? extends CustomResourceDoneable<R>> getDoneableClass();
 
+  String getAssociatedControllerClassName();
+
   default boolean isClusterScoped() {
     return false;
   }

operator-framework-quarkus-extension/deployment/src/main/java/io/javaoperatorsdk/quarkus/extension/deployment/QuarkusExtensionProcessor.java

@@ -95,8 +95,9 @@ private ControllerConfiguration createControllerConfiguration(
             .filter(t -> t.name().equals(RESOURCE_CONTROLLER))
             .findFirst()
             .map(Type::asParameterizedType)
-            .orElseThrow(); // shouldn't happen since we're only dealing with ResourceController
-    // implementors already
+            // shouldn't happen since we're only dealing with ResourceController implementors
+            // already
+            .orElseThrow();
     final var crType = rcInterface.arguments().get(0).name().toString();
 
     // create ResourceController bean
@@ -137,11 +138,14 @@ private ControllerConfiguration createControllerConfiguration(
             controllerAnnotation, "crdName", AnnotationValue::asString, EXCEPTION_SUPPLIER);
     final var configuration =
         new QuarkusControllerConfiguration(
+            resourceControllerClassName,
             valueOrDefault(
                 controllerAnnotation,
                 "name",
                 AnnotationValue::asString,
-                () -> ControllerUtils.getDefaultResourceControllerName(info.simpleName())),
+                () ->
+                    ResourceController.getDefaultResourceControllerName(
+                        resourceControllerClassName)),
             crdName,
             valueOrDefault(
                 controllerAnnotation,

operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusConfigurationService.java

@@ -1,36 +1,21 @@
 package io.javaoperatorsdk.quarkus.extension;
 
 import io.fabric8.kubernetes.client.Config;
-import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.KubernetesClient;
-import io.javaoperatorsdk.operator.api.ResourceController;
-import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.AbstractConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
-import java.util.Collections;
 import java.util.List;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
 import javax.inject.Inject;
 
-public class QuarkusConfigurationService implements ConfigurationService {
-  private final Map<String, ControllerConfiguration> controllerConfigurations;
+public class QuarkusConfigurationService extends AbstractConfigurationService {
   @Inject KubernetesClient client;
 
   public QuarkusConfigurationService(List<ControllerConfiguration> configurations) {
     if (configurations != null && !configurations.isEmpty()) {
-      controllerConfigurations = new ConcurrentHashMap<>(configurations.size());
-      configurations.forEach(c -> controllerConfigurations.put(c.getName(), c));
-    } else {
-      controllerConfigurations = Collections.emptyMap();
+      configurations.forEach(this::register);
     }
   }
 
-  @Override
-  public <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
-      ResourceController<R> controller) {
-    return controllerConfigurations.get(controller.getName());
-  }
-
   @Override
   public Config getClientConfiguration() {
     return client.getConfiguration();

operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusControllerConfiguration.java

@@ -10,6 +10,7 @@
 
 public class QuarkusControllerConfiguration<R extends CustomResource>
     implements ControllerConfiguration<R> {
+  private final String associatedControllerClassName;
   private final String name;
   private final String crdName;
   private final String finalizer;
@@ -23,6 +24,7 @@ public class QuarkusControllerConfiguration<R extends CustomResource>
 
   @RecordableConstructor
   public QuarkusControllerConfiguration(
+      String associatedControllerClassName,
       String name,
       String crdName,
       String finalizer,
@@ -32,6 +34,7 @@ public QuarkusControllerConfiguration(
       String crClass,
       String doneableClassName,
       RetryConfiguration retryConfiguration) {
+    this.associatedControllerClassName = associatedControllerClassName;
     this.name = name;
     this.crdName = crdName;
     this.finalizer = finalizer;
@@ -87,23 +90,27 @@ public boolean isGenerationAware() {
 
   @Override
   public Class<R> getCustomResourceClass() {
-    try {
-      return (Class<R>) Thread.currentThread().getContextClassLoader().loadClass(crClass);
-    } catch (ClassNotFoundException e) {
-      throw new IllegalArgumentException("Couldn't find class " + crClass);
-    }
+    return (Class<R>) loadClass(crClass);
   }
 
   @Override
   public Class<? extends CustomResourceDoneable<R>> getDoneableClass() {
+    return (Class<? extends CustomResourceDoneable<R>>) loadClass(doneableClassName);
+  }
+
+  private Class<?> loadClass(String className) {
     try {
-      return (Class<CustomResourceDoneable<R>>)
-          Thread.currentThread().getContextClassLoader().loadClass(doneableClassName);
+      return Thread.currentThread().getContextClassLoader().loadClass(className);
     } catch (ClassNotFoundException e) {
-      throw new IllegalArgumentException("Couldn't find class " + doneableClassName);
+      throw new IllegalArgumentException("Couldn't find class " + className);
     }
   }
 
+  @Override
+  public String getAssociatedControllerClassName() {
+    return associatedControllerClassName;
+  }
+
   @Override
   public boolean isClusterScoped() {
     return clusterScoped;

operator-framework-spring-boot-starter/src/main/java/io/javaoperatorsdk/operator/springboot/starter/OperatorAutoConfiguration.java

@@ -8,15 +8,12 @@
 import io.fabric8.openshift.client.DefaultOpenShiftClient;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.ResourceController;
-import io.javaoperatorsdk.operator.api.config.ConfigurationService;
-import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.config.AbstractConfigurationService;
 import io.javaoperatorsdk.operator.api.config.RetryConfiguration;
 import io.javaoperatorsdk.operator.config.runtime.AnnotationConfiguration;
 import java.util.List;
-import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -25,9 +22,8 @@
 
 @Configuration
 @EnableConfigurationProperties({OperatorConfigurationProperties.class})
-public class OperatorAutoConfiguration implements ConfigurationService {
+public class OperatorAutoConfiguration extends AbstractConfigurationService {
   @Autowired private OperatorConfigurationProperties configuration;
-  private final Map<String, ControllerConfiguration> controllers = new ConcurrentHashMap<>();
 
   @Bean
   @ConditionalOnMissingBean
@@ -60,18 +56,12 @@ public Operator operator(
 
   private ResourceController<?> processController(ResourceController<?> controller) {
     final var controllerPropertiesMap = configuration.getControllers();
-    var controllerProps = controllerPropertiesMap.get(controller.getName());
-    final var cfg = new ConfigurationWrapper(controller, controllerProps);
-    this.controllers.put(controller.getName(), cfg);
+    final var name = controller.getName();
+    var controllerProps = controllerPropertiesMap.get(name);
+    register(new ConfigurationWrapper(controller, controllerProps));
     return controller;
   }
 
-  @Override
-  public <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
-      ResourceController<R> controller) {
-    return controllers.get(controller.getName());
-  }
-
   private static class ConfigurationWrapper<R extends CustomResource>
       extends AnnotationConfiguration<R> {
     private final Optional<ControllerProperties> properties;

operator-framework-spring-boot-starter/src/test/java/io/javaoperatorsdk/operator/springboot/starter/AutoConfigurationTest.java

@@ -5,7 +5,6 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import io.fabric8.kubernetes.client.KubernetesClient;
-import io.javaoperatorsdk.operator.ControllerUtils;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import java.util.List;
@@ -39,10 +38,7 @@ public void loadsKubernetesClientPropertiesProperly() {
   @Test
   public void loadsRetryPropertiesProperly() {
     final var retryProperties =
-        config
-            .getControllers()
-            .get(ControllerUtils.getDefaultNameFor(TestController.class))
-            .getRetry();
+        config.getControllers().get(ResourceController.getNameFor(TestController.class)).getRetry();
     assertEquals(3, retryProperties.getMaxAttempts());
     assertEquals(1000, retryProperties.getInitialInterval());
     assertEquals(1.5, retryProperties.getIntervalMultiplier());

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

@@ -21,8 +21,7 @@ public AnnotationConfiguration(ResourceController<R> controller) {
 
   @Override
   public String getName() {
-    final var name = annotation.name();
-    return Controller.NULL.equals(name) ? ControllerUtils.getDefaultNameFor(controller) : name;
+    return controller.getName();
   }
 
   @Override
@@ -63,4 +62,9 @@ public boolean isClusterScoped() {
   public Set<String> getNamespaces() {
     return Set.of(annotation.namespaces());
   }
+
+  @Override
+  public String getAssociatedControllerClassName() {
+    return controller.getClass().getCanonicalName();
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java

@@ -2,15 +2,13 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.config.AbstractConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
 
-public class DefaultConfigurationService implements ConfigurationService {
+public class DefaultConfigurationService extends AbstractConfigurationService {
 
   private static final ConfigurationService instance = new DefaultConfigurationService();
-  private final Map<String, ControllerConfiguration> configurations = new ConcurrentHashMap<>();
 
   public static ConfigurationService instance() {
     return instance;
@@ -19,15 +17,12 @@ public static ConfigurationService instance() {
   @Override
   public <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
       ResourceController<R> controller) {
-    if (controller == null) {
-      return null;
+    var config = super.getConfigurationFor(controller);
+    if (config == null) {
+      // create the the configuration on demand and register it
+      config = new AnnotationConfiguration(controller);
+      register(config);
     }
-    final var name = controller.getName();
-    var configuration = configurations.get(name);
-    if (configuration == null) {
-      configuration = new AnnotationConfiguration(controller);
-      configurations.put(name, configuration);
-    }
-    return configuration;
+    return config;
   }
 }