fix: clean up controller default name generation

Fixes #279

Author: metacosm

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

@@ -6,6 +6,23 @@
 
 public interface ResourceController<R extends CustomResource> {
 
+  static String getDefaultNameFor(ResourceController controller) {
+    return getDefaultNameFor(controller.getClass());
+  }
+
+  static String getDefaultNameFor(Class<? extends ResourceController> controllerClass) {
+    return getDefaultResourceControllerName(controllerClass.getCanonicalName());
+  }
+
+  static String getDefaultResourceControllerName(String rcControllerClassName) {
+    if (rcControllerClassName.indexOf('.') < 0) {
+      throw new IllegalArgumentException(
+          "Must provide a fully-qualified resource controller class name, was: "
+              + rcControllerClassName);
+    }
+    return rcControllerClassName.toLowerCase(Locale.ROOT);
+  }
+
   /**
    * The implementation should delete the associated component(s). Note that this is method is
    * called when an object is marked for deletion. After its executed the custom resource finalizer
@@ -52,6 +69,6 @@ default String getName() {
     }
 
     // otherwise, use the lower-cased full class name
-    return clazz.getCanonicalName().toLowerCase(Locale.ROOT);
+    return getDefaultNameFor(this);
   }
 }

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

@@ -141,7 +141,7 @@ private ControllerConfiguration createControllerConfiguration(
                 controllerAnnotation,
                 "name",
                 AnnotationValue::asString,
-                () -> ControllerUtils.getDefaultResourceControllerName(info.simpleName())),
+                () -> ResourceController.getDefaultResourceControllerName(info.name().toString())),
             crdName,
             valueOrDefault(
                 controllerAnnotation,

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;
@@ -41,7 +40,7 @@ public void loadsRetryPropertiesProperly() {
     final var retryProperties =
         config
             .getControllers()
-            .get(ControllerUtils.getDefaultNameFor(TestController.class))
+            .get(ResourceController.getDefaultNameFor(TestController.class))
             .getRetry();
     assertEquals(3, retryProperties.getMaxAttempts());
     assertEquals(1000, retryProperties.getInitialInterval());

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

@@ -22,7 +22,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.NULL.equals(name) ? ResourceController.getDefaultNameFor(controller) : name;
   }
 
   @Override