Get doneable class from mapping

Author: Soroosh Sarabadani

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

@@ -4,7 +4,6 @@
 import io.fabric8.kubernetes.client.CustomResourceDoneable;
 import io.javaoperatorsdk.operator.api.Controller;
 import io.javaoperatorsdk.operator.api.ResourceController;
-import org.apache.commons.lang3.ClassUtils;
 
 import java.util.Map;
 
@@ -13,12 +12,21 @@ public class ControllerUtils {
 
     private static final String FINALIZER_NAME_SUFFIX = "/finalizer";
     public static final String CONTROLLERS_RESOURCE_PATH = "javaoperatorsdk/controllers";
+    public static final String DONEABLES_RESOURCE_PATH = "javaoperatorsdk/doneables";
     private static Map<Class<? extends ResourceController>, Class<? extends CustomResource>> controllerToCustomResourceMappings;
+    private static Map<Class<? extends CustomResource>, Class<? extends CustomResourceDoneable>> resourceToDoneableMappings;
+
 
     static {
-        controllerToCustomResourceMappings =
-                ControllerToCustomResourceMappingsProvider
-                        .provide(CONTROLLERS_RESOURCE_PATH);
+        controllerToCustomResourceMappings = ClassMappingProvider
+                .provide(CONTROLLERS_RESOURCE_PATH,
+                        ResourceController.class,
+                        CustomResource.class);
+        resourceToDoneableMappings = ClassMappingProvider
+                .provide(DONEABLES_RESOURCE_PATH,
+                        CustomResource.class,
+                        CustomResourceDoneable.class
+                );
     }
 
     static String getFinalizer(ResourceController controller) {
@@ -53,13 +61,12 @@ static String getCrdName(ResourceController controller) {
 
     public static <T extends CustomResource> Class<? extends CustomResourceDoneable<T>>
     getCustomResourceDoneableClass(ResourceController<T> controller) {
-        try {
-            final Class<T> customResourceClass = getCustomResourceClass(controller);
-            return (Class<? extends CustomResourceDoneable<T>>) ClassUtils.getClass(customResourceClass.getCanonicalName() + "Doneable");
-        } catch (ClassNotFoundException e) {
-            e.printStackTrace();
-            return null;
+        final Class<T> customResourceClass = getCustomResourceClass(controller);
+        final Class<? extends CustomResourceDoneable<T>> doneableClass = (Class<? extends CustomResourceDoneable<T>>) resourceToDoneableMappings.get(customResourceClass);
+        if (doneableClass == null) {
+            throw new RuntimeException(String.format("No matching Doneable class found for %s", customResourceClass));
         }
+        return doneableClass;
     }
 
     private static Controller getAnnotation(ResourceController<?> controller) {

operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/annotation/ControllerAnnotationProcessor.java

@@ -22,20 +22,24 @@
 import java.util.stream.Collectors;
 
 import static io.javaoperatorsdk.operator.ControllerUtils.CONTROLLERS_RESOURCE_PATH;
+import static io.javaoperatorsdk.operator.ControllerUtils.DONEABLES_RESOURCE_PATH;
 
 @SupportedAnnotationTypes(
         "io.javaoperatorsdk.operator.api.Controller")
 @SupportedSourceVersion(SourceVersion.RELEASE_8)
 @AutoService(Processor.class)
 public class ControllerAnnotationProcessor extends AbstractProcessor {
-    private ControllersResourceWriter controllersResourceWriter;
+    private AccumulativeMappingWriter controllersResourceWriter;
+    private AccumulativeMappingWriter doneablesResourceWriter;
     private Set<String> generatedDoneableClassFiles = new HashSet<>();
 
     @Override
     public synchronized void init(ProcessingEnvironment processingEnv) {
         super.init(processingEnv);
-        controllersResourceWriter = new ControllersResourceWriter(processingEnv);
-        controllersResourceWriter.loadExistingMappings();
+        controllersResourceWriter = new AccumulativeMappingWriter(CONTROLLERS_RESOURCE_PATH, processingEnv)
+                .loadExistingMappings();
+        doneablesResourceWriter = new AccumulativeMappingWriter(DONEABLES_RESOURCE_PATH, processingEnv)
+                .loadExistingMappings();
     }
 
     @Override
@@ -51,6 +55,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         } finally {
             if (roundEnv.processingOver()) {
                 controllersResourceWriter.flush();
+                doneablesResourceWriter.flush();
             }
         }
         return true;
@@ -71,7 +76,7 @@ private void generateDoneableClass(TypeElement controllerClassSymbol) {
             if (!generatedDoneableClassFiles.add(destinationClassFileName)) {
                 processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,
                         String.format(
-                                "%s already exist! adding the mapping to the %s",
+                                "%s already exists! adding the mapping to the %s",
                                 destinationClassFileName,
                                 CONTROLLERS_RESOURCE_PATH)
                 );
@@ -98,9 +103,11 @@ private void generateDoneableClass(TypeElement controllerClassSymbol) {
                         .build();
 
                 final PackageElement packageElement = processingEnv.getElementUtils().getPackageOf(customerResourceTypeElement);
-                JavaFile file = JavaFile.builder(packageElement.getQualifiedName().toString(), typeSpec)
+                final var packageQualifiedName = packageElement.getQualifiedName().toString();
+                JavaFile file = JavaFile.builder(packageQualifiedName, typeSpec)
                         .build();
                 file.writeTo(out);
+                doneablesResourceWriter.add(customResourceType.toString(), makeQualifiedClassName(packageQualifiedName, doneableClassName));
             }
         } catch (Exception ioException) {
             ioException.printStackTrace();
@@ -137,4 +144,11 @@ private List<DeclaredType> collectAllInterfaces(TypeElement element) {
             return null;
         }
     }
+
+    private String makeQualifiedClassName(String packageName, String className) {
+        if (packageName.equals("")) {
+            return className;
+        }
+        return packageName + "." + className;
+    }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/ControllerUtilsTest.java

@@ -1,5 +1,6 @@
 package io.javaoperatorsdk.operator;
 
+import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.CustomResourceDoneable;
 import io.javaoperatorsdk.operator.api.*;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
@@ -23,15 +24,18 @@ public void returnsValuesFromControllerAnnotationFinalizer() {
     }
 
     @Controller(crdName = "test.crd", finalizerName = CUSTOM_FINALIZER_NAME)
-    static class TestCustomFinalizerController implements ResourceController<TestCustomResource> {
+    static class TestCustomFinalizerController implements ResourceController<TestCustomFinalizerController.InnerCustomResource> {
+        public class InnerCustomResource extends CustomResource {
+        }
 
         @Override
-        public DeleteControl deleteResource(TestCustomResource resource, Context<TestCustomResource> context) {
+        public DeleteControl deleteResource(TestCustomFinalizerController.InnerCustomResource resource, Context<InnerCustomResource> context) {
             return DeleteControl.DEFAULT_DELETE;
         }
 
         @Override
-        public UpdateControl<TestCustomResource> createOrUpdateResource(TestCustomResource resource, Context<TestCustomResource> context) {
+        public UpdateControl<TestCustomFinalizerController.InnerCustomResource> createOrUpdateResource(InnerCustomResource resource,
+                                                                                                       Context<InnerCustomResource> context) {
             return null;
         }
     }
@@ -40,4 +44,11 @@ public UpdateControl<TestCustomResource> createOrUpdateResource(TestCustomResour
     public void returnCustomerFinalizerNameIfSet() {
         assertEquals(CUSTOM_FINALIZER_NAME, ControllerUtils.getFinalizer(new TestCustomFinalizerController()));
     }
+
+    @Test
+    public void supportsInnerClassCustomResources() {
+        assertDoesNotThrow(() -> {
+            ControllerUtils.getCustomResourceDoneableClass(new TestCustomFinalizerController());
+        });
+    }
 }