Merge branch 'main' into next

Author: csviri

Diff for: docs/documentation/dependent-resources.md

@@ -7,11 +7,6 @@ permalink: /docs/dependent-resources
 
 # Dependent Resources
 
-DISCLAIMER: The Dependent Resource support is a relatively new feature, while we strove to cover
-what we anticipate will be the most common use cases, the implementation is not simple and might
-still evolve. As a result, some APIs could be a subject of change in the future. However,
-non-backwards compatible changes are expected to be trivial to migrate to.
-
 ## Motivations and Goals
 
 Most operators need to deal with secondary resources when trying to realize the desired state

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventProcessor.java

@@ -146,7 +146,12 @@ private void submitReconciliationExecution(ResourceState state) {
             controllerUnderExecution,
             maybeLatest.isPresent());
         if (maybeLatest.isEmpty()) {
-          log.debug("no custom resource found in cache for resource id: {}", resourceID);
+          // there can be multiple reasons why the primary resource is not present, one is that the
+          // informer is currently disconnected from k8s api server, but will eventually receive the
+          // resource. Other is that simply there is no primary resource present for an event, this
+          // might indicate issue with the implementation, but could happen also naturally, thus
+          // this is not necessarily a problem.
+          log.debug("no primary resource found in cache with resource id: {}", resourceID);
         }
       }
     } finally {

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java

@@ -300,7 +300,7 @@ public void setConfigurationService(ConfigurationService configurationService) {
     super.setConfigurationService(configurationService);
 
     cache.addIndexers(indexerBuffer);
-    indexerBuffer = null;
+    indexerBuffer = new HashMap<>();
   }
 
   @Override

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentReInitializationIT.java

@@ -0,0 +1,39 @@
+package io.javaoperatorsdk.operator;
+
+import org.junit.jupiter.api.Test;
+
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+import io.javaoperatorsdk.operator.sample.dependentreinitialization.ConfigMapDependentResource;
+import io.javaoperatorsdk.operator.sample.dependentreinitialization.DependentReInitializationCustomResource;
+import io.javaoperatorsdk.operator.sample.dependentreinitialization.DependentReInitializationReconciler;
+
+class DependentReInitializationIT {
+
+  /**
+   * In case dependent resource is managed by CDI (like in Quarkus) can be handy that the instance
+   * is reused in tests.
+   */
+  @Test
+  void dependentCanDeReInitialized() {
+    var client = new KubernetesClientBuilder().build();
+    LocallyRunOperatorExtension.applyCrd(DependentReInitializationCustomResource.class, client);
+
+    var dependent = new ConfigMapDependentResource();
+
+    startEndStopOperator(client, dependent);
+    startEndStopOperator(client, dependent);
+  }
+
+  private static void startEndStopOperator(KubernetesClient client,
+      ConfigMapDependentResource dependent) {
+    Operator o1 = new Operator(o -> o
+        .withCloseClientOnStop(false)
+        .withKubernetesClient(client));
+    o1.register(new DependentReInitializationReconciler(dependent, client));
+    o1.start();
+    o1.stop();
+  }
+
+}

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerErrorHandlerStartIT.java

@@ -0,0 +1,47 @@
+package io.javaoperatorsdk.operator;
+
+import java.time.Duration;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.client.ConfigBuilder;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+
+class InformerErrorHandlerStartIT {
+  /**
+   * Test showcases that the operator starts even if there is no access right for some resource.
+   */
+  @Test
+  @Timeout(5)
+  void operatorStart() {
+    KubernetesClient client = new KubernetesClientBuilder()
+        .withConfig(new ConfigBuilder()
+            .withImpersonateUsername("user-with-no-rights")
+            .build())
+        .build();
+
+    Operator operator = new Operator(o -> o
+        .withKubernetesClient(client)
+        .withStopOnInformerErrorDuringStartup(false)
+        .withCacheSyncTimeout(Duration.ofSeconds(2)));
+    operator.register(new ConfigMapReconciler());
+    operator.start();
+  }
+
+  @ControllerConfiguration
+  public static class ConfigMapReconciler implements Reconciler<ConfigMap> {
+    @Override
+    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context)
+        throws Exception {
+      return UpdateControl.noUpdate();
+    }
+  }
+
+}

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentreinitialization/ConfigMapDependentResource.java

@@ -0,0 +1,29 @@
+package io.javaoperatorsdk.operator.sample.dependentreinitialization;
+
+import java.util.Map;
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
+
+public class ConfigMapDependentResource
+    extends CRUDKubernetesDependentResource<ConfigMap, DependentReInitializationCustomResource> {
+
+  public ConfigMapDependentResource() {
+    super(ConfigMap.class);
+  }
+
+  @Override
+  protected ConfigMap desired(DependentReInitializationCustomResource primary,
+      Context<DependentReInitializationCustomResource> context) {
+    return new ConfigMapBuilder()
+        .withMetadata(new ObjectMetaBuilder()
+            .withName(primary.getMetadata().getName())
+            .withNamespace(primary.getMetadata().getNamespace())
+            .build())
+        .withData(Map.of("key", "val"))
+        .build();
+  }
+}

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentreinitialization/DependentReInitializationCustomResource.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.sample.dependentreinitialization;
+
+import io.fabric8.kubernetes.api.model.Namespaced;
+import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.model.annotation.Group;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+public class DependentReInitializationCustomResource
+    extends CustomResource<Void, Void>
+    implements Namespaced {
+
+}

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentreinitialization/DependentReInitializationReconciler.java

@@ -0,0 +1,38 @@
+package io.javaoperatorsdk.operator.sample.dependentreinitialization;
+
+import java.util.Map;
+
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.javaoperatorsdk.operator.api.reconciler.*;
+import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+
+@ControllerConfiguration
+public class DependentReInitializationReconciler
+    implements Reconciler<DependentReInitializationCustomResource>,
+    EventSourceInitializer<DependentReInitializationCustomResource> {
+
+  private final ConfigMapDependentResource configMapDependentResource;
+
+  public DependentReInitializationReconciler(ConfigMapDependentResource dependentResource,
+      KubernetesClient client) {
+    this.configMapDependentResource = dependentResource;
+    this.configMapDependentResource.setKubernetesClient(client);
+  }
+
+  @Override
+  public UpdateControl<DependentReInitializationCustomResource> reconcile(
+      DependentReInitializationCustomResource resource,
+      Context<DependentReInitializationCustomResource> context) throws Exception {
+    configMapDependentResource.reconcile(resource, context);
+    return UpdateControl.noUpdate();
+  }
+
+  @Override
+  public Map<String, EventSource> prepareEventSources(
+      EventSourceContext<DependentReInitializationCustomResource> context) {
+    return EventSourceInitializer.nameEventSourcesFromDependentResource(context,
+        configMapDependentResource);
+  }
+
+
+}

Diff for: pom.xml

@@ -47,7 +47,7 @@
         <fabric8-client.version>6.7.2</fabric8-client.version>
         <slf4j.version>1.7.36</slf4j.version>
         <log4j.version>2.20.0</log4j.version>
-        <mokito.version>5.4.0</mokito.version>
+        <mokito.version>5.5.0</mokito.version>
         <commons-lang3.version>3.13.0</commons-lang3.version>
         <compile-testing.version>0.19</compile-testing.version>
         <javapoet.version>1.13.0</javapoet.version>