feat!: allow config override when registering a controller

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -5,6 +5,7 @@
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.processing.CustomResourceCache;
 import io.javaoperatorsdk.operator.processing.DefaultEventHandler;
 import io.javaoperatorsdk.operator.processing.EventDispatcher;
@@ -30,31 +31,30 @@ public Operator(KubernetesClient k8sClient, ConfigurationService configurationSe
 
   public <R extends CustomResource> void register(ResourceController<R> controller)
       throws OperatorException {
-    final var configuration = configurationService.getConfigurationFor(controller);
-    if (configuration == null) {
+    register(controller, null);
+  }
+
+  public <R extends CustomResource> void register(
+      ResourceController<R> controller, ControllerConfiguration<R> configuration)
+      throws OperatorException {
+    final var existing = configurationService.getConfigurationFor(controller);
+    if (existing == null) {
       log.warn(
           "Skipping registration of {} controller named {} because its configuration cannot be found.\n"
               + "Known controllers are: {}",
           controller.getClass().getCanonicalName(),
           ControllerUtils.getNameFor(controller),
           configurationService.getKnownControllerNames());
     } else {
+      if (configuration == null) {
+        configuration = existing;
+      }
       final var retry = GenericRetry.fromConfiguration(configuration.getRetryConfiguration());
       final var targetNamespaces = configuration.getNamespaces().toArray(new String[] {});
       registerController(controller, configuration.watchAllNamespaces(), retry, targetNamespaces);
     }
   }
 
-  // currently only used by IntegrationTestSupport but this should also disappear as by default the
-  // controllers should register into the current namespace the client is connected to which should
-  // work as expected for tests, in particular if we want to start testing using random namespace
-  // names
-  <R extends CustomResource> void registerController(
-      ResourceController<R> controller, Retry retry, String... targetNamespaces)
-      throws OperatorException {
-    registerController(controller, false, retry, targetNamespaces);
-  }
-
   @SuppressWarnings("rawtypes")
   private <R extends CustomResource> void registerController(
       ResourceController<R> controller,

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

@@ -12,9 +12,9 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
-import io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext;
 import io.fabric8.kubernetes.client.utils.Serialization;
 import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider;
 import io.javaoperatorsdk.operator.config.runtime.DefaultConfigurationService;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
@@ -46,8 +46,7 @@ public void initialize(
       KubernetesClient k8sClient, ResourceController controller, String crdPath, Retry retry) {
     log.info("Initializing integration test in namespace {}", TEST_NAMESPACE);
     this.k8sClient = k8sClient;
-    CustomResourceDefinition crd = loadCRDAndApplyToCluster(crdPath);
-    CustomResourceDefinitionContext crdContext = CustomResourceDefinitionContext.fromCrd(crd);
+    loadCRDAndApplyToCluster(crdPath);
     this.controller = controller;
 
     final var configurationService = DefaultConfigurationService.instance();
@@ -56,16 +55,18 @@ public void initialize(
     final var customResourceClass = config.getCustomResourceClass();
     this.crOperations = k8sClient.customResources(customResourceClass);
 
-    if (k8sClient.namespaces().withName(TEST_NAMESPACE).get() == null) {
-      k8sClient
-          .namespaces()
-          .create(
-              new NamespaceBuilder()
-                  .withMetadata(new ObjectMetaBuilder().withName(TEST_NAMESPACE).build())
-                  .build());
+    final var namespaces = k8sClient.namespaces();
+    if (namespaces.withName(TEST_NAMESPACE).get() == null) {
+      namespaces.create(
+          new NamespaceBuilder().withNewMetadata().withName(TEST_NAMESPACE).endMetadata().build());
     }
     operator = new Operator(k8sClient, configurationService);
-    operator.registerController(controller, retry, TEST_NAMESPACE);
+    final var overriddenConfig =
+        ControllerConfigurationOverrider.override(config).settingNamespace(TEST_NAMESPACE);
+    if (retry != null) {
+      overriddenConfig.withRetry(retry);
+    }
+    operator.register(controller, overriddenConfig.build());
     log.info("Operator is running with {}", controller.getClass().getCanonicalName());
   }