improve: naming InformerConfiguration build (#2671)

* improve: naming informer event source Signed-off-by: Attila Mészáros <a_meszaros@apple.com> * fix: add link to method Signed-off-by: Chris Laprun <claprun@redhat.com> --------- Signed-off-by: Attila Mészáros <a_meszaros@apple.com> Signed-off-by: Chris Laprun <claprun@redhat.com> Co-authored-by: Chris Laprun <claprun@redhat.com>
operator-framework · Jan 25, 2025 · b25a399 · b25a399
1 parent 3e584f6
commit b25a399
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 8 deletions.
diff --git a/.../src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java b/.../src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java
@@ -249,6 +249,7 @@ public Long getInformerListLimit() {
   @SuppressWarnings("UnusedReturnValue")
   public class Builder {
 
+    /** For internal usage only. Use {@link #build()} method for building for InformerEventSource */
     public InformerConfiguration<R> buildForController() {
       // if the informer config uses the default "same as controller" value, reset the namespaces to
       // the default set for controllers
@@ -261,7 +262,8 @@ public InformerConfiguration<R> buildForController() {
       return InformerConfiguration.this;
     }
 
-    public InformerConfiguration<R> buildForInformerEventSource() {
+    /** Build for InformerEventSource */
+    public InformerConfiguration<R> build() {
       if (namespaces == null || namespaces.isEmpty()) {
         namespaces = Constants.SAME_AS_CONTROLLER_NAMESPACES_SET;
       }

diff --git a/...ava/io/javaoperatorsdk/operator/api/config/informer/InformerEventSourceConfiguration.java b/...ava/io/javaoperatorsdk/operator/api/config/informer/InformerEventSourceConfiguration.java
@@ -219,7 +219,7 @@ public InformerEventSourceConfiguration<R> build() {
           Objects.requireNonNullElse(secondaryToPrimaryMapper,
               Mappers.fromOwnerReferences(HasMetadata.getApiVersion(primaryResourceClass),
                   HasMetadata.getKind(primaryResourceClass), false)),
-          config.buildForInformerEventSource(), kubernetesClient);
+          config.build(), kubernetesClient);
     }
   }
 }
diff --git a/...avaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentConverter.java b/...avaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentConverter.java
@@ -53,6 +53,6 @@ private InformerConfiguration<R> createInformerConfig(
           configAnnotation.annotationType());
       config = config.initFromAnnotation(informerConfig, context);
     }
-    return config.buildForInformerEventSource();
+    return config.build();
   }
 }
diff --git a/...est/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverriderTest.java b/...est/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverriderTest.java
@@ -279,7 +279,7 @@ void replaceNamedDependentResourceConfigShouldWork() {
     final var overridingInformerConfig = InformerConfiguration.builder(ConfigMap.class)
         .withNamespaces(Set.of(overriddenNS))
         .withLabelSelector(labelSelector)
-        .buildForInformerEventSource();
+        .build();
     final var overridden = ControllerConfigurationOverrider.override(configuration)
         .replacingNamedDependentResourceConfig(
             dependentResourceName,

diff --git a/...-core/src/test/java/io/javaoperatorsdk/operator/api/config/InformerConfigurationTest.java b/...-core/src/test/java/io/javaoperatorsdk/operator/api/config/InformerConfigurationTest.java
@@ -48,7 +48,7 @@ void currentNamespaceWatched() {
   @Test
   void nullLabelSelectorByDefault() {
     final var informerConfig =
-        InformerConfiguration.builder(ConfigMap.class).buildForInformerEventSource();
+        InformerConfiguration.builder(ConfigMap.class).build();
     assertNull(informerConfig.getLabelSelector());
   }
 
@@ -61,7 +61,7 @@ void shouldWatchAllNamespacesByDefaultForControllers() {
   @Test
   void shouldFollowControllerNamespacesByDefaultForInformerEventSource() {
     final var informerConfig =
-        InformerConfiguration.builder(ConfigMap.class).buildForInformerEventSource();
+        InformerConfiguration.builder(ConfigMap.class).build();
     assertTrue(informerConfig.isFollowControllerNamespacesOnChange());
   }
 

diff --git a/...src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java b/...src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java
@@ -88,7 +88,7 @@ private void initDependentResources(KubernetesClient client) {
         .forEach(dr -> dr.configureWith(new KubernetesDependentResourceConfigBuilder()
             .withKubernetesDependentInformerConfig(InformerConfiguration.builder(dr.resourceType())
                 .withLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR)
-                .buildForInformerEventSource())
+                .build())
             .build()));
   }
 

diff --git a/...c/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java b/...c/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java
@@ -98,7 +98,7 @@ private Workflow<WebPage> createDependentResourcesAndWorkflow() {
         .forEach(dr -> dr.configureWith(new KubernetesDependentResourceConfigBuilder()
             .withKubernetesDependentInformerConfig(InformerConfiguration.builder(dr.resourceType())
                 .withLabelSelector(SELECTOR + "=true")
-                .buildForInformerEventSource())
+                .build())
             .build()));
 
     // connect the dependent resources into a workflow, configuring them as we go