fix: startup resource cache access

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java

@@ -111,6 +111,10 @@ public <T extends HasMetadata> T create(T resource) {
     return kubernetesClient.resource(resource).inNamespace(namespace).create();
   }
 
+  public <T extends HasMetadata> T serverSideApply(T resource) {
+    return kubernetesClient.resource(resource).inNamespace(namespace).serverSideApply();
+  }
+
   public <T extends HasMetadata> T replace(T resource) {
     return kubernetesClient.resource(resource).inNamespace(namespace).replace();
   }

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java

@@ -54,6 +54,7 @@ public class LocallyRunOperatorExtension extends AbstractOperatorExtension {
   private final List<Class<? extends CustomResource>> additionalCustomResourceDefinitions;
   private final Map<Reconciler, RegisteredController> registeredControllers;
   private final Map<String, String> crdMappings;
+  private final Consumer<LocallyRunOperatorExtension> beforeStartHook;
 
   private LocallyRunOperatorExtension(
       List<ReconcilerSpec> reconcilers,
@@ -68,7 +69,8 @@ private LocallyRunOperatorExtension(
       Consumer<ConfigurationServiceOverrider> configurationServiceOverrider,
       Function<ExtensionContext, String> namespaceNameSupplier,
       Function<ExtensionContext, String> perClassNamespaceNameSupplier,
-      List<String> additionalCrds) {
+      List<String> additionalCrds,
+      Consumer<LocallyRunOperatorExtension> beforeStartHook) {
     super(
         infrastructure,
         infrastructureTimeout,
@@ -82,6 +84,7 @@ private LocallyRunOperatorExtension(
     this.portForwards = portForwards;
     this.localPortForwards = new ArrayList<>(portForwards.size());
     this.additionalCustomResourceDefinitions = additionalCustomResourceDefinitions;
+    this.beforeStartHook = beforeStartHook;
     configurationServiceOverrider =
         configurationServiceOverrider != null
             ? configurationServiceOverrider.andThen(
@@ -298,6 +301,10 @@ protected void before(ExtensionContext context) {
         });
     crdMappings.clear();
 
+    if (beforeStartHook != null) {
+      beforeStartHook.accept(this);
+    }
+
     LOGGER.debug("Starting the operator locally");
     this.operator.start();
   }
@@ -356,6 +363,7 @@ public static class Builder extends AbstractBuilder<Builder> {
     private final List<PortForwardSpec> portForwards;
     private final List<Class<? extends CustomResource>> additionalCustomResourceDefinitions;
     private final List<String> additionalCRDs = new ArrayList<>();
+    private Consumer<LocallyRunOperatorExtension> beforeStartHook;
     private KubernetesClient kubernetesClient;
 
     protected Builder() {
@@ -424,6 +432,15 @@ public Builder withAdditionalCRD(String... paths) {
       return this;
     }
 
+    /**
+     * Used to initialize resources when the namespace is generated but the operator is not started
+     * yet.
+     */
+    public Builder withBeforeStartHook(Consumer<LocallyRunOperatorExtension> beforeStartHook) {
+      this.beforeStartHook = beforeStartHook;
+      return this;
+    }
+
     public LocallyRunOperatorExtension build() {
       return new LocallyRunOperatorExtension(
           reconcilers,
@@ -438,7 +455,8 @@ public LocallyRunOperatorExtension build() {
           configurationServiceOverrider,
           namespaceNameSupplier,
           perClassNamespaceNameSupplier,
-          additionalCRDs);
+          additionalCRDs,
+          beforeStartHook);
     }
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/startsecondaryaccess/StartupSecondaryAccessCustomResource.java

@@ -0,0 +1,13 @@
+package io.javaoperatorsdk.operator.baseapi.startsecondaryaccess;
+
+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.ShortNames;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+@ShortNames("ssac")
+public class StartupSecondaryAccessCustomResource extends CustomResource<Void, Void>
+    implements Namespaced {}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/startsecondaryaccess/StartupSecondaryAccessIT.java

@@ -0,0 +1,53 @@
+package io.javaoperatorsdk.operator.baseapi.startsecondaryaccess;
+
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+
+import static io.javaoperatorsdk.operator.baseapi.startsecondaryaccess.StartupSecondaryAccessReconciler.LABEL_KEY;
+import static io.javaoperatorsdk.operator.baseapi.startsecondaryaccess.StartupSecondaryAccessReconciler.LABEL_VALUE;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+class StartupSecondaryAccessIT {
+
+  public static final int SECONDARY_NUMBER = 100;
+
+  @RegisterExtension
+  static LocallyRunOperatorExtension extension =
+      LocallyRunOperatorExtension.builder()
+          .withReconciler(new StartupSecondaryAccessReconciler())
+          .withBeforeStartHook(
+              ex -> {
+                var primary = new StartupSecondaryAccessCustomResource();
+                primary.setMetadata(new ObjectMetaBuilder().withName("test1").build());
+                primary = ex.serverSideApply(primary);
+
+                for (int i = 0; i < SECONDARY_NUMBER; i++) {
+                  ConfigMap cm = new ConfigMap();
+                  cm.setMetadata(
+                      new ObjectMetaBuilder()
+                          .withLabels(Map.of(LABEL_KEY, LABEL_VALUE))
+                          .withNamespace(ex.getNamespace())
+                          .withName("cm" + i)
+                          .build());
+                  cm.addOwnerReference(primary);
+                  ex.serverSideApply(cm);
+                }
+              })
+          .build();
+
+  @Test
+  void reconcilerSeeAllSecondaryResources() {
+    var reconciler = extension.getReconcilerOfType(StartupSecondaryAccessReconciler.class);
+
+    await().untilAsserted(() -> assertThat(reconciler.isReconciled()).isTrue());
+
+    assertThat(reconciler.isSecondaryAndCacheSameAmount()).isTrue();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/startsecondaryaccess/StartupSecondaryAccessReconciler.java

@@ -0,0 +1,75 @@
+package io.javaoperatorsdk.operator.baseapi.startsecondaryaccess;
+
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.javaoperatorsdk.operator.api.config.informer.InformerEventSourceConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
+
+import static io.javaoperatorsdk.operator.baseapi.startsecondaryaccess.StartupSecondaryAccessIT.SECONDARY_NUMBER;
+
+@ControllerConfiguration
+public class StartupSecondaryAccessReconciler
+    implements Reconciler<StartupSecondaryAccessCustomResource> {
+
+  private static final Logger log = LoggerFactory.getLogger(StartupSecondaryAccessReconciler.class);
+
+  public static final String LABEL_KEY = "app";
+  public static final String LABEL_VALUE = "secondary-test";
+
+  private InformerEventSource<ConfigMap, StartupSecondaryAccessCustomResource> cmInformer;
+
+  private boolean secondaryAndCacheSameAmount = true;
+  private boolean reconciled = false;
+
+  @Override
+  public UpdateControl<StartupSecondaryAccessCustomResource> reconcile(
+      StartupSecondaryAccessCustomResource resource,
+      Context<StartupSecondaryAccessCustomResource> context) {
+
+    var secondary = context.getSecondaryResources(ConfigMap.class);
+    var cached = cmInformer.list().toList();
+
+    log.info(
+        "Secondary number: {}, cached: {}, expected: {}",
+        secondary.size(),
+        cached.size(),
+        SECONDARY_NUMBER);
+
+    if (secondary.size() != cached.size()) {
+      secondaryAndCacheSameAmount = false;
+    }
+    reconciled = true;
+    return UpdateControl.noUpdate();
+  }
+
+  @Override
+  public List<EventSource<?, StartupSecondaryAccessCustomResource>> prepareEventSources(
+      EventSourceContext<StartupSecondaryAccessCustomResource> context) {
+    cmInformer =
+        new InformerEventSource<>(
+            InformerEventSourceConfiguration.from(
+                    ConfigMap.class, StartupSecondaryAccessCustomResource.class)
+                .withLabelSelector(LABEL_KEY + "=" + LABEL_VALUE)
+                .build(),
+            context);
+    return List.of(cmInformer);
+  }
+
+  public boolean isSecondaryAndCacheSameAmount() {
+    return secondaryAndCacheSameAmount;
+  }
+
+  public boolean isReconciled() {
+    return reconciled;
+  }
+}