Informer based CustomResourceEventSource and caching (#581)

feat: This is a major change and backbone of v2. We change also how the Resources are addressed both internally and from event source with CustomResourceID. Additional improvements also added.


* chore: renaming vars named k8sClient to kubernetsClient

* chore(deps): bump jandex-maven-plugin from 1.1.1 to 1.2.1 (#592)

Bumps [jandex-maven-plugin](https://github.com/wildfly/jandex-maven-plugin) from 1.1.1 to 1.2.1.
- [Release notes](https://github.com/wildfly/jandex-maven-plugin/releases)
- [Commits](wildfly/jandex-maven-plugin@1.1.1...1.2.1)

---
updated-dependencies:
- dependency-name: org.jboss.jandex:jandex-maven-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump mockito-core from 3.12.4 to 4.0.0 (#591)

Bumps [mockito-core](https://github.com/mockito/mockito) from 3.12.4 to 4.0.0.
- [Release notes](https://github.com/mockito/mockito/releases)
- [Commits](mockito/mockito@v3.12.4...v4.0.0)

---
updated-dependencies:
- dependency-name: org.mockito:mockito-core
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feature: Build PR on v2

* chore(ci): use Java 17

* chore(ci): use only Temurin distribution

* chore: add generics to PostExecutionControl to reduce IDEs noise (#594)

* chore: polish the junit5 extension (#593)

* feat: Use informers as CustomResourceEventSource backbone and cache


Co-authored-by: Ioannis Canellos <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Chris Laprun <[email protected]>
Co-authored-by: Luca Burgazzoli <[email protected]>

Author: 5 people

Diff for: .github/workflows/master-snapshot-release.yml

@@ -15,8 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [11, 16]
-        distribution: [temurin, adopt-openj9]
+        java: [ 11, 17 ]
+        distribution: [ temurin ]
         kubernetes: [ 'v1.17.13','v1.18.20','v1.19.14','v1.20.10','v1.21.4', 'v1.22.1' ]
     steps:
       - uses: actions/checkout@v2

Diff for: .github/workflows/pr.yml

@@ -8,15 +8,15 @@ concurrency:
   cancel-in-progress: true
 on:
   pull_request:
-    branches: [ master ]
+    branches: [ master, v2 ]
   workflow_dispatch:
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [ 11 ]
-        distribution: [ temurin, adopt-openj9 ]
+        java: [ 11, 17 ]
+        distribution: [ temurin ]
         kubernetes: [ 'v1.17.13','v1.18.20','v1.19.14','v1.20.10','v1.21.4', 'v1.22.1' ]
     steps:
       - uses: actions/checkout@v2

Diff for: .gitignore

@@ -10,3 +10,5 @@ target/
 
 #  VSCode
 .factorypath
+
+.mvn/wrapper/maven-wrapper.jar

Diff for: micrometer-support/src/main/java/io/javaoperatorsdk/operator/micrometer/MicrometerMetrics.java

@@ -5,6 +5,7 @@
 
 import io.javaoperatorsdk.operator.Metrics;
 import io.javaoperatorsdk.operator.processing.DefaultEventHandler.EventMonitor;
+import io.javaoperatorsdk.operator.processing.event.CustomResourceID;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Timer;
@@ -15,12 +16,12 @@ public class MicrometerMetrics implements Metrics {
   private final MeterRegistry registry;
   private final EventMonitor monitor = new EventMonitor() {
     @Override
-    public void processedEvent(String uid, Event event) {
+    public void processedEvent(CustomResourceID uid, Event event) {
       incrementProcessedEventsNumber();
     }
 
     @Override
-    public void failedEvent(String uid, Event event) {
+    public void failedEvent(CustomResourceID uid, Event event) {
       incrementControllerRetriesNumber();
     }
   };

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

@@ -18,7 +18,7 @@ public static String getNameFor(Class<? extends ResourceController> controllerCl
     final var annotation = controllerClass.getAnnotation(Controller.class);
     if (annotation != null) {
       final var name = annotation.name();
-      if (!Controller.NULL.equals(name)) {
+      if (!Controller.EMPTY_STRING.equals(name)) {
         return name;
       }
     }

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java

@@ -2,9 +2,9 @@
 
 import java.util.List;
 
-import io.fabric8.kubernetes.client.Watcher;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEvent;
+import io.javaoperatorsdk.operator.processing.event.internal.ResourceAction;
 
 public class EventListUtils {
 
@@ -13,7 +13,7 @@ public static boolean containsCustomResourceDeletedEvent(List<Event> events) {
         .anyMatch(
             e -> {
               if (e instanceof CustomResourceEvent) {
-                return ((CustomResourceEvent) e).getAction() == Watcher.Action.DELETED;
+                return ((CustomResourceEvent) e).getAction() == ResourceAction.DELETED;
               } else {
                 return false;
               }

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java

@@ -11,11 +11,11 @@
 @Target({ElementType.TYPE})
 public @interface Controller {
 
-  String NULL = "";
+  String EMPTY_STRING = "";
   String WATCH_CURRENT_NAMESPACE = "JOSDK_WATCH_CURRENT";
   String NO_FINALIZER = "JOSDK_NO_FINALIZER";
 
-  String name() default NULL;
+  String name() default EMPTY_STRING;
 
   /**
    * Optional finalizer name, if it is not provided, one will be automatically generated. If the
@@ -24,7 +24,7 @@
    *
    * @return the finalizer name
    */
-  String finalizerName() default NULL;
+  String finalizerName() default EMPTY_STRING;
 
   /**
    * If true, will dispatch new event to the controller if generation increased since the last
@@ -50,7 +50,7 @@
    *
    * @return the label selector
    */
-  String labelSelector() default NULL;
+  String labelSelector() default EMPTY_STRING;
 
 
   /**

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AbstractControllerConfiguration.java

@@ -19,7 +19,7 @@ public class DefaultControllerConfiguration<R extends CustomResource<?, ?>>
   private final RetryConfiguration retryConfiguration;
   private final String labelSelector;
   private final CustomResourceEventFilter<R> customResourceEventFilter;
-  private Class<R> customResourceClass;
+  private final Class<R> customResourceClass;
   private ConfigurationService service;
 
   public DefaultControllerConfiguration(
@@ -54,29 +54,6 @@ public DefaultControllerConfiguration(
     setConfigurationService(service);
   }
 
-  @Deprecated
-  public DefaultControllerConfiguration(
-      String associatedControllerClassName,
-      String name,
-      String crdName,
-      String finalizer,
-      boolean generationAware,
-      Set<String> namespaces,
-      RetryConfiguration retryConfiguration) {
-    this(
-        associatedControllerClassName,
-        name,
-        crdName,
-        finalizer,
-        generationAware,
-        namespaces,
-        retryConfiguration,
-        null,
-        null,
-        null,
-        null);
-  }
-
   @Override
   public String getName() {
     return name;

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultControllerConfiguration.java

@@ -26,15 +26,15 @@ public class ConfiguredController<R extends CustomResource<?, ?>> implements Res
     Closeable {
   private final ResourceController<R> controller;
   private final ControllerConfiguration<R> configuration;
-  private final KubernetesClient k8sClient;
+  private final KubernetesClient kubernetesClient;
   private EventSourceManager eventSourceManager;
 
   public ConfiguredController(ResourceController<R> controller,
       ControllerConfiguration<R> configuration,
-      KubernetesClient k8sClient) {
+      KubernetesClient kubernetesClient) {
     this.controller = controller;
     this.configuration = configuration;
-    this.k8sClient = k8sClient;
+    this.kubernetesClient = kubernetesClient;
   }
 
   @Override
@@ -140,11 +140,11 @@ public ControllerConfiguration<R> getConfiguration() {
   }
 
   public KubernetesClient getClient() {
-    return k8sClient;
+    return kubernetesClient;
   }
 
   public MixedOperation<R, KubernetesResourceList<R>, Resource<R>> getCRClient() {
-    return k8sClient.resources(configuration.getCustomResourceClass());
+    return kubernetesClient.resources(configuration.getCustomResourceClass());
   }
 
   /**
@@ -164,7 +164,8 @@ public void start() throws OperatorException {
     // check that the custom resource is known by the cluster if configured that way
     final CustomResourceDefinition crd; // todo: check proper CRD spec version based on config
     if (configuration.getConfigurationService().checkCRDAndValidateLocalModel()) {
-      crd = k8sClient.apiextensions().v1().customResourceDefinitions().withName(crdName).get();
+      crd =
+          kubernetesClient.apiextensions().v1().customResourceDefinitions().withName(crdName).get();
       if (crd == null) {
         throwMissingCRDException(crdName, specVersion, controllerName);
       }