Merge pull request #56 from ContainerSolutions/remove_group_and_kind

Remove group and kind

Author: csviri

README.md

@@ -48,24 +48,20 @@ The Controller implements the business logic and describes all the classes neede
 
 ```java
 @Controller(customResourceClass = WebServer.class,
-        kind = WebServerController.KIND,
-        group = WebServerController.GROUP,
+        crdName = "webservers.sample.javaoperatorsdk",
         customResourceListClass = WebServerList.class,
         customResourceDonebaleClass = WebServerDoneable.class)
 public class WebServerController implements ResourceController<WebServer> {
 
-    static final String KIND = "WebServer";
-    static final String GROUP = "sample.javaoperatorsdk";
-
     @Override
-    public boolean deleteResource(CustomService resource, Context<CustomService> context) {
+    public boolean deleteResource(CustomService resource) {
         // ... your logic ...
         return true;
     }
 
     // Return the changed resource, so it gets updated. See javadoc for details.
     @Override
-    public Optional<CustomService> createOrUpdateResource(CustomService resource, Context<CustomService> context) {
+    public Optional<CustomService> createOrUpdateResource(CustomService resource) {
         // ... your logic ...
         return resource;
     }

operator-framework/pom.xml

@@ -72,5 +72,11 @@
             <version>3.4.1</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.0.1</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

operator-framework/src/main/java/com/github/containersolutions/operator/ControllerUtils.java

@@ -6,51 +6,26 @@
 import io.fabric8.kubernetes.client.CustomResourceDoneable;
 import io.fabric8.kubernetes.client.CustomResourceList;
 
-import java.util.Optional;
-
 class ControllerUtils {
 
-    public static final String GROUP_API_DELIMITER = "/";
-
     static String getDefaultFinalizer(ResourceController controller) {
-        return getAnnotation(controller).defaultFinalizer();
+        return getAnnotation(controller).finalizerName();
     }
 
     static <R extends CustomResource> Class<R> getCustomResourceClass(ResourceController controller) {
         return (Class<R>) getAnnotation(controller).customResourceClass();
     }
 
-    static String getApiVersion(ResourceController controller) {
-        return getGroup(controller) + GROUP_API_DELIMITER + getAnnotation(controller).version();
-    }
-
-    static String getVersion(ResourceController controller) {
-        return getAnnotation(controller).version();
-    }
-
-    static Optional<String> getCrdName(ResourceController controller) {
-        String crdName = getAnnotation(controller).crdName();
-        if (crdName.isEmpty()) {
-            return Optional.empty();
-        } else {
-            return Optional.of(crdName);
-        }
-    }
-
-    static String getKind(ResourceController controller) {
-        return getAnnotation(controller).kind();
+    static String getCrdName(ResourceController controller) {
+        return getAnnotation(controller).crdName();
     }
 
     static <R extends CustomResource> Class<? extends CustomResourceList<R>> getCustomResourceListClass(ResourceController controller) {
         return (Class<? extends CustomResourceList<R>>) getAnnotation(controller).customResourceListClass();
     }
 
     static <R extends CustomResource> Class<? extends CustomResourceDoneable<R>> getCustomResourceDonebaleClass(ResourceController controller) {
-        return (Class<? extends CustomResourceDoneable<R>>) getAnnotation(controller).customResourceDonebaleClass();
-    }
-
-    private static String getGroup(ResourceController controller) {
-        return getAnnotation(controller).group();
+        return (Class<? extends CustomResourceDoneable<R>>) getAnnotation(controller).customResourceDoneableClass();
     }
 
     private static Controller getAnnotation(ResourceController controller) {

operator-framework/src/main/java/com/github/containersolutions/operator/Operator.java

@@ -4,7 +4,6 @@
 import com.github.containersolutions.operator.processing.EventDispatcher;
 import com.github.containersolutions.operator.processing.EventScheduler;
 import io.fabric8.kubernetes.api.model.apiextensions.CustomResourceDefinition;
-import io.fabric8.kubernetes.api.model.apiextensions.CustomResourceDefinitionList;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.CustomResourceDoneable;
 import io.fabric8.kubernetes.client.CustomResourceList;
@@ -18,19 +17,16 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Optional;
 
 import static com.github.containersolutions.operator.ControllerUtils.*;
 
+@SuppressWarnings("rawtypes")
 public class Operator {
 
-    private final KubernetesClient k8sClient;
+    private final static Logger log = LoggerFactory.getLogger(Operator.class);
 
-    private Map<ResourceController, EventScheduler> controllers = new HashMap<>();
+    private final KubernetesClient k8sClient;
     private Map<Class<? extends CustomResource>, CustomResourceOperationsImpl> customResourceClients = new HashMap<>();
-    private EventScheduler eventScheduler;
-
-    private final static Logger log = LoggerFactory.getLogger(Operator.class);
 
     public Operator(KubernetesClient k8sClient) {
         this.k8sClient = k8sClient;
@@ -44,36 +40,30 @@ public <R extends CustomResource> void registerController(ResourceController<R>
         registerController(controller, false, targetNamespaces);
     }
 
+    @SuppressWarnings("rawtypes")
     private <R extends CustomResource> void registerController(ResourceController<R> controller,
                                                                boolean watchAllNamespaces, String... targetNamespaces) throws OperatorException {
         Class<R> resClass = getCustomResourceClass(controller);
-        Optional<CustomResourceDefinition> crd = getCustomResourceDefinitionForController(controller);
-        String kind = ControllerUtils.getKind(controller);
-        KubernetesDeserializer.registerCustomKind(getApiVersion(controller), kind, resClass);
-
-        if (crd.isPresent()) {
-            Class<? extends CustomResourceList<R>> list = getCustomResourceListClass(controller);
-            Class<? extends CustomResourceDoneable<R>> doneable = getCustomResourceDonebaleClass(controller);
-            MixedOperation client = k8sClient.customResources(crd.get(), resClass, list, doneable);
+        CustomResourceDefinition crd = getCustomResourceDefinitionForController(controller);
+        KubernetesDeserializer.registerCustomKind(getApiVersion(crd), getKind(crd), resClass);
 
-            EventDispatcher<R> eventDispatcher =
-                    new EventDispatcher<>(controller, (CustomResourceOperationsImpl) client, client, k8sClient,
-                            ControllerUtils.getDefaultFinalizer(controller));
+        Class<? extends CustomResourceList<R>> list = getCustomResourceListClass(controller);
+        Class<? extends CustomResourceDoneable<R>> doneable = getCustomResourceDonebaleClass(controller);
+        MixedOperation client = k8sClient.customResources(crd, resClass, list, doneable);
 
-            eventScheduler = new EventScheduler(eventDispatcher);
-
-            registerWatches(controller, client, resClass, watchAllNamespaces, targetNamespaces);
-        } else {
-            throw new OperatorException("CRD '" + resClass.getSimpleName() + "' with version '"
-                    + getVersion(controller) + "' not found");
-        }
+        EventDispatcher eventDispatcher = new EventDispatcher(controller, (CustomResourceOperationsImpl) client,
+                getDefaultFinalizer(controller));
+        EventScheduler eventScheduler = new EventScheduler(eventDispatcher);
+        registerWatches(controller, client, resClass, watchAllNamespaces, targetNamespaces, eventScheduler);
     }
 
     private <R extends CustomResource> void registerWatches(ResourceController<R> controller, MixedOperation client,
                                                             Class<R> resClass,
-                                                            boolean watchAllNamespaces, String[] targetNamespaces) {
+                                                            boolean watchAllNamespaces, String[] targetNamespaces, EventScheduler eventScheduler) {
+
         CustomResourceOperationsImpl crClient = (CustomResourceOperationsImpl) client;
         if (watchAllNamespaces) {
+            // todo test this
             crClient.inAnyNamespace().watch(eventScheduler);
         } else if (targetNamespaces.length == 0) {
             client.watch(eventScheduler);
@@ -84,22 +74,17 @@ private <R extends CustomResource> void registerWatches(ResourceController<R> co
             }
         }
         customResourceClients.put(resClass, (CustomResourceOperationsImpl) client);
-        controllers.put(controller, eventScheduler);
         log.info("Registered Controller: '{}' for CRD: '{}' for namespaces: {}", controller.getClass().getSimpleName(),
                 resClass, targetNamespaces.length == 0 ? "[all/client namespace]" : Arrays.toString(targetNamespaces));
     }
 
-    private Optional<CustomResourceDefinition> getCustomResourceDefinitionForController(ResourceController controller) {
-        Optional<String> crdName = getCrdName(controller);
-        if (crdName.isPresent()) {
-            return Optional.ofNullable(k8sClient.customResourceDefinitions().withName(crdName.get()).get());
-        } else {
-            CustomResourceDefinitionList crdList = k8sClient.customResourceDefinitions().list();
-            return crdList.getItems().stream()
-                    .filter(c -> getKind(controller).equals(c.getSpec().getNames().getKind()) &&
-                            getVersion(controller).equals(c.getSpec().getVersion()))
-                    .findFirst();
+    private CustomResourceDefinition getCustomResourceDefinitionForController(ResourceController controller) {
+        String crdName = getCrdName(controller);
+        CustomResourceDefinition customResourceDefinition = k8sClient.customResourceDefinitions().withName(crdName).get();
+        if (customResourceDefinition == null) {
+            throw new OperatorException("Cannot find Custom Resource Definition with name: " + crdName);
         }
+        return customResourceDefinition;
     }
 
     public Map<Class<? extends CustomResource>, CustomResourceOperationsImpl> getCustomResourceClients() {
@@ -113,4 +98,12 @@ public void stop() {
     public <T extends CustomResource> CustomResourceOperationsImpl getCustomResourceClients(Class<T> customResourceClass) {
         return customResourceClients.get(customResourceClass);
     }
+
+    private String getKind(CustomResourceDefinition crd) {
+        return crd.getSpec().getNames().getKind();
+    }
+
+    private String getApiVersion(CustomResourceDefinition crd) {
+        return crd.getSpec().getGroup() + "/" + crd.getSpec().getVersion();
+    }
 }

operator-framework/src/main/java/com/github/containersolutions/operator/OperatorConfig.java

@@ -15,22 +15,14 @@
 
     String DEFAULT_FINALIZER = "operator.default.finalizer";
 
-    String DEFAULT_VERSION = "v1";
-
-    String version() default DEFAULT_VERSION;
-
-    String crdName() default "";
-
-    String group();
-
-    String kind();
+    String crdName();
 
     Class<? extends CustomResource> customResourceClass();
 
     Class<? extends CustomResourceList<? extends CustomResource>> customResourceListClass();
 
-    Class<? extends CustomResourceDoneable<? extends CustomResource>> customResourceDonebaleClass();
+    Class<? extends CustomResourceDoneable<? extends CustomResource>> customResourceDoneableClass();
 
-    String defaultFinalizer() default DEFAULT_FINALIZER;
+    String finalizerName() default DEFAULT_FINALIZER;
 
 }

operator-framework/src/main/java/com/github/containersolutions/operator/api/Context.java

@@ -10,23 +10,24 @@ public interface ResourceController<R extends CustomResource> {
      * 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 default finalizer is automatically removed by the framework;
      * unless the return value is false - note that this is almost never the case.
+     * Its important to have the implementation also idempotent, in the current implementation to cover all edge cases
+     * actually will be executed mostly twice.
      *
      * @param resource
-     * @param context
      * @return true - so the finalizer is automatically removed after the call.
      * false if you don't want to remove the finalizer. Note that this is ALMOST NEVER the case.
      */
-    boolean deleteResource(R resource, Context<R> context);
+    boolean deleteResource(R resource);
 
     /**
      * The implementation of this operation is required to be idempotent.
      *
      * @return The resource is updated in api server if the return value is present
-     *  within Optional. This the common use cases. However in cases, for example the operator is restarted,
-     *  and we don't want to have an update call to k8s api to be made unnecessarily, by returning an empty Optional
-     *  this update can be skipped.
-     *  <b>However we will always call an update if there is no finalizer on object and its not marked for deletion.</b>
+     * within Optional. This the common use cases. However in cases, for example the operator is restarted,
+     * and we don't want to have an update call to k8s api to be made unnecessarily, by returning an empty Optional
+     * this update can be skipped.
+     * <b>However we will always call an update if there is no finalizer on object and its not marked for deletion.</b>
      */
-    Optional<R> createOrUpdateResource(R resource, Context<R> context);
+    Optional<R> createOrUpdateResource(R resource);
 
 }