Merge pull request #1284 from yue9944882/feat/spring-controller-factory-bean

Provide a factory bean approach to configure the informer/reconcilers in spring context

Author: k8s-ci-robot

examples/src/main/java/io/kubernetes/client/examples/SpringControllerExample.java

@@ -24,6 +24,8 @@
 import io.kubernetes.client.openapi.models.V1NodeList;
 import io.kubernetes.client.openapi.models.V1Pod;
 import io.kubernetes.client.openapi.models.V1PodList;
+import io.kubernetes.client.spring.extended.controller.KubernetesInformerConfigurer;
+import io.kubernetes.client.spring.extended.controller.KubernetesReconcilerConfigurer;
 import io.kubernetes.client.spring.extended.controller.annotation.*;
 import io.kubernetes.client.util.ClientBuilder;
 import java.io.IOException;
@@ -33,7 +35,6 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 @SpringBootApplication
@@ -44,11 +45,6 @@ public static void main(String[] args) {
   }
 
   @Configuration
-  @ComponentScan(
-      basePackages = "io.kubernetes.client.spring.extended.controller") // Scanning beans under this
-  // package is
-  // *REQUIRED* for informers/reconciler
-  // injections.
   public static class AppConfig {
 
     @Bean
@@ -64,6 +60,21 @@ public CommandLineRunner commandLineRunner(
       };
     }
 
+    // *REQUIRED*
+    // Configurer components that registers informers to the informer-factory in the context.
+    @Bean
+    public KubernetesInformerConfigurer kubernetesInformerConfigurer(ApiClient apiClient) {
+      return new KubernetesInformerConfigurer(apiClient);
+    }
+
+    // *REQUIRED*
+    // Configurer components that registers reconciler to the controller-manager in the context.
+    @Bean
+    public KubernetesReconcilerConfigurer kubernetesReconcilerConfigurer(
+        SharedInformerFactory sharedInformerFactory) {
+      return new KubernetesReconcilerConfigurer(sharedInformerFactory);
+    }
+
     // *OPTIONAL*
     // Injecting and customize your ApiClient, if not specified, fallbacks to {@link
     // io.kubernetes.client.util.ClientBuilder#standard}

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesInformerConfigurer.java

@@ -0,0 +1,40 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package io.kubernetes.client.spring.extended.controller;
+
+import io.kubernetes.client.openapi.ApiClient;
+import org.springframework.beans.factory.FactoryBean;
+
+/**
+ * KubernetesInformerConfigurer will register a {@link KubernetesInformerFactoryProcessor} into the
+ * context.
+ */
+public class KubernetesInformerConfigurer
+    implements FactoryBean<KubernetesInformerFactoryProcessor> {
+
+  private final ApiClient apiClient;
+
+  public KubernetesInformerConfigurer(ApiClient apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  @Override
+  public KubernetesInformerFactoryProcessor getObject() throws Exception {
+    return new KubernetesInformerFactoryProcessor(apiClient);
+  }
+
+  @Override
+  public Class<?> getObjectType() {
+    return KubernetesInformerFactoryProcessor.class;
+  }
+}

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesInformerFactoryProcessor.java

@@ -57,6 +57,12 @@ public class KubernetesInformerFactoryProcessor
 
   private BeanDefinitionRegistry beanDefinitionRegistry;
 
+  private ApiClient apiClient = null;
+
+  public KubernetesInformerFactoryProcessor(ApiClient apiClient) {
+    this.apiClient = apiClient;
+  }
+
   @Override
   public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
       throws BeansException {
@@ -80,20 +86,22 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
       return;
     }
 
-    ApiClient apiClient;
-    try {
-      apiClient = beanFactory.getBean(ApiClient.class);
-    } catch (NoSuchBeanDefinitionException e) {
-      log.info("No ApiClient bean found, falling-back to default initialization..");
+    if (this.apiClient == null) {
       try {
-        apiClient = ClientBuilder.standard().build();
-      } catch (IOException ex) {
-        log.error("failed initializing ApiClient", ex);
-        return;
+        this.apiClient = beanFactory.getBean(ApiClient.class);
+      } catch (NoSuchBeanDefinitionException e) {
+        log.info("No ApiClient bean found, falling-back to default initialization..");
+        try {
+          this.apiClient = ClientBuilder.standard().build();
+        } catch (IOException ex) {
+          log.error("failed initializing ApiClient", ex);
+          return;
+        }
       }
     }
-    apiClient.setHttpClient(
-        apiClient.getHttpClient().newBuilder().readTimeout(Duration.ZERO).build());
+
+    this.apiClient.setHttpClient(
+        this.apiClient.getHttpClient().newBuilder().readTimeout(Duration.ZERO).build());
 
     SharedInformerFactory sharedInformerFactory = beanFactory.getBean(SharedInformerFactory.class);
     KubernetesInformers kubernetesInformers =

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesReconcilerConfigurer.java

@@ -0,0 +1,39 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package io.kubernetes.client.spring.extended.controller;
+
+import io.kubernetes.client.informer.SharedInformerFactory;
+import org.springframework.beans.factory.FactoryBean;
+
+/**
+ * KubernetesReconcilerConfigurer will register a {@link KubernetesReconcilerProcessor} into the
+ * context.
+ */
+public class KubernetesReconcilerConfigurer implements FactoryBean<KubernetesReconcilerProcessor> {
+
+  private final SharedInformerFactory sharedInformerFactory;
+
+  public KubernetesReconcilerConfigurer(SharedInformerFactory sharedInformerFactory) {
+    this.sharedInformerFactory = sharedInformerFactory;
+  }
+
+  @Override
+  public KubernetesReconcilerProcessor getObject() throws Exception {
+    return new KubernetesReconcilerProcessor(sharedInformerFactory);
+  }
+
+  @Override
+  public Class<?> getObjectType() {
+    return KubernetesReconcilerProcessor.class;
+  }
+}

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesReconcilerProcessor.java

@@ -65,6 +65,12 @@ public class KubernetesReconcilerProcessor implements BeanFactoryPostProcessor,
 
   private ExecutorService controllerManagerDaemon = Executors.newSingleThreadExecutor();
 
+  private SharedInformerFactory sharedInformerFactory;
+
+  public KubernetesReconcilerProcessor(SharedInformerFactory sharedInformerFactory) {
+    this.sharedInformerFactory = sharedInformerFactory;
+  }
+
   @Override
   public int getOrder() {
     return KubernetesInformerFactoryProcessor.ORDER + 1;
@@ -73,14 +79,16 @@ public int getOrder() {
   @Override
   public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
       throws BeansException {
-    SharedInformerFactory sharedInformerFactory = beanFactory.getBean(SharedInformerFactory.class);
+    if (this.sharedInformerFactory == null) {
+      this.sharedInformerFactory = beanFactory.getBean(SharedInformerFactory.class);
+    }
     String[] names = beanFactory.getBeanNamesForType(Reconciler.class);
     for (String name : names) {
       Reconciler reconciler = (Reconciler) beanFactory.getBean(name);
       KubernetesReconciler kubernetesReconciler =
           reconciler.getClass().getAnnotation(KubernetesReconciler.class);
       String reconcilerName = kubernetesReconciler.value();
-      Controller controller = buildController(sharedInformerFactory, reconciler);
+      Controller controller = buildController(this.sharedInformerFactory, reconciler);
       beanFactory.registerSingleton(reconcilerName, controller);
     }
   }

spring/src/test/java/io/kubernetes/client/spring/extended/controller/KubernetesInformerCreatorTest.java

@@ -70,6 +70,11 @@ public SharedInformerFactory sharedInformerFactory() {
       return new TestSharedInformerFactory();
     }
 
+    @Bean
+    public KubernetesInformerConfigurer kubernetesInformerConfigurer(ApiClient apiClient) {
+      return new KubernetesInformerConfigurer(apiClient);
+    }
+
     @KubernetesInformers({
       @KubernetesInformer(
           apiTypeClass = V1Pod.class,

spring/src/test/java/io/kubernetes/client/spring/extended/controller/KubernetesReconcilerCreatorTest.java

@@ -71,6 +71,12 @@ public TestReconciler podReconciler(
         Lister<V1ConfigMap> configMapLister) {
       return new TestReconciler(podInformer, podLister, configMapLister);
     }
+
+    @Bean
+    public KubernetesReconcilerConfigurer kubernetesReconcilerConfigurer(
+        SharedInformerFactory sharedInformerFactory) {
+      return new KubernetesReconcilerConfigurer(sharedInformerFactory);
+    }
   }
 
   @KubernetesReconciler(

spring/src/test/java/io/kubernetes/client/spring/extended/controller/TestApplication.java

@@ -13,8 +13,6 @@
 package io.kubernetes.client.spring.extended.controller;
 
 import org.springframework.boot.SpringBootConfiguration;
-import org.springframework.context.annotation.ComponentScan;
 
 @SpringBootConfiguration
-@ComponentScan("io.kubernetes.client.spring.extended.controller")
 public class TestApplication {}