Merge pull request #636 from yue9944882/refactor/informer-call-generator

k8s-ci-robot · web-flow · commit 79fbdcfa4412 · 2019-07-25T11:50:45.000-07:00
[Refactor] Add Call-generator interface throwing checked ApiException
diff --git a/examples/src/main/java/io/kubernetes/client/examples/InformerExample.java b/examples/src/main/java/io/kubernetes/client/examples/InformerExample.java
@@ -1,7 +1,6 @@
 package io.kubernetes.client.examples;
 
 import io.kubernetes.client.ApiClient;
-import io.kubernetes.client.ApiException;
 import io.kubernetes.client.Configuration;
 import io.kubernetes.client.apis.CoreV1Api;
 import io.kubernetes.client.informer.*;
@@ -35,21 +34,17 @@ public static void main(String[] args) throws Exception {
     SharedIndexInformer<V1Node> nodeInformer =
         factory.sharedIndexInformerFor(
             (CallGeneratorParams params) -> {
-              try {
-                return coreV1Api.listNodeCall(
-                    null,
-                    null,
-                    null,
-                    null,
-                    null,
-                    params.resourceVersion,
-                    params.timeoutSeconds,
-                    params.watch,
-                    null,
-                    null);
-              } catch (ApiException e) {
-                throw new RuntimeException(e);
-              }
+              return coreV1Api.listNodeCall(
+                  null,
+                  null,
+                  null,
+                  null,
+                  null,
+                  params.resourceVersion,
+                  params.timeoutSeconds,
+                  params.watch,
+                  null,
+                  null);
             },
             V1Node.class,
             V1NodeList.class);
diff --git a/util/pom.xml b/util/pom.xml
@@ -92,7 +92,7 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>2.13.0</version>
+            <version>2.23.4</version>
             <scope>test</scope>
         </dependency>
         <dependency>
diff --git a/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java b/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java
@@ -4,6 +4,7 @@
 import com.squareup.okhttp.Call;
 import io.kubernetes.client.*;
 import io.kubernetes.client.informer.impl.DefaultSharedIndexInformer;
+import io.kubernetes.client.util.CallGenerator;
 import io.kubernetes.client.util.CallGeneratorParams;
 import io.kubernetes.client.util.Watch;
 import io.kubernetes.client.util.common.Collections;
@@ -13,7 +14,6 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
-import java.util.function.Function;
 
 /** SharedInformerFactory class constructs and caches informers for api types. */
 public class SharedInformerFactory {
@@ -51,7 +51,7 @@ public SharedInformerFactory(ExecutorService threadPool) {
    * @return the shared index informer
    */
   public synchronized <ApiType, ApiListType> SharedIndexInformer<ApiType> sharedIndexInformerFor(
-      Function<CallGeneratorParams, Call> callGenerator,
+      CallGenerator callGenerator,
       Class<ApiType> apiTypeClass,
       Class<ApiListType> apiListTypeClass) {
     return sharedIndexInformerFor(callGenerator, apiTypeClass, apiListTypeClass, 0);
@@ -70,7 +70,7 @@ public synchronized <ApiType, ApiListType> SharedIndexInformer<ApiType> sharedIn
    * @return the shared index informer
    */
   public synchronized <ApiType, ApiListType> SharedIndexInformer<ApiType> sharedIndexInformerFor(
-      Function<CallGeneratorParams, Call> callGenerator,
+      CallGenerator callGenerator,
       Class<ApiType> apiTypeClass,
       Class<ApiListType> apiListTypeClass,
       long resyncPeriodInMillis) {
@@ -84,20 +84,20 @@ public synchronized <ApiType, ApiListType> SharedIndexInformer<ApiType> sharedIn
   }
 
   private <ApiType, ApiListType> ListerWatcher<ApiType, ApiListType> listerWatcherFor(
-      Function<CallGeneratorParams, Call> callGenerator,
+      CallGenerator callGenerator,
       Class<ApiType> apiTypeClass,
       Class<ApiListType> apiListTypeClass) {
     ApiClient apiClient = Configuration.getDefaultApiClient();
     return new ListerWatcher<ApiType, ApiListType>() {
       @Override
       public ApiListType list(CallGeneratorParams params) throws ApiException {
-        Call call = callGenerator.apply(params);
+        Call call = callGenerator.generate(params);
         return (ApiListType) apiClient.execute(call, apiListTypeClass).getData();
       }
 
       @Override
       public Watch<ApiType> watch(CallGeneratorParams params) throws ApiException {
-        Call call = callGenerator.apply(params);
+        Call call = callGenerator.generate(params);
         return Watch.createWatch(
             apiClient,
             call,
@@ -106,6 +106,19 @@ public Watch<ApiType> watch(CallGeneratorParams params) throws ApiException {
     };
   }
 
+  /**
+   * Gets existing shared index informer, return null if the requesting informer is never
+   * constructed.
+   *
+   * @param <ApiType> the type parameter
+   * @param apiTypeClass the api type class
+   * @return the existing shared index informer
+   */
+  public synchronized <ApiType> SharedIndexInformer<ApiType> getExistingSharedIndexInformer(
+      Class<ApiType> apiTypeClass) {
+    return this.informers.get(TypeToken.get(apiTypeClass).getType());
+  }
+
   /** Start all registered informers. */
   public synchronized void startAllRegisteredInformers() {
     if (Collections.isEmptyMap(informers)) {
diff --git a/util/src/main/java/io/kubernetes/client/util/CallGenerator.java b/util/src/main/java/io/kubernetes/client/util/CallGenerator.java
@@ -0,0 +1,25 @@
+package io.kubernetes.client.util;
+
+import com.squareup.okhttp.Call;
+import io.kubernetes.client.ApiException;
+
+/**
+ * The interface Call generator. It's for homogenizing client interface so that we can invoke a
+ * generized adaptor interface elsewhere.
+ *
+ * <p>For example, we can adapt list-node interface from CoreV1Api package like:
+ *
+ * <p>(CallGeneratorParams params) -> { return coreV1Api.listNodeCall( null, null, null, null, null,
+ * params.resourceVersion, params.timeoutSeconds, params.watch, null, null); },
+ */
+@FunctionalInterface
+public interface CallGenerator {
+  /**
+   * Generate call.
+   *
+   * @param params the params
+   * @return the call
+   * @throws ApiException the api exception
+   */
+  Call generate(CallGeneratorParams params) throws ApiException;
+}
diff --git a/util/src/test/java/io/kubernetes/client/informer/SharedInformerFactoryTest.java b/util/src/test/java/io/kubernetes/client/informer/SharedInformerFactoryTest.java
@@ -1,6 +1,5 @@
 package io.kubernetes.client.informer;
 
-import io.kubernetes.client.ApiException;
 import io.kubernetes.client.apis.CoreV1Api;
 import io.kubernetes.client.models.V1Namespace;
 import io.kubernetes.client.models.V1NamespaceList;
@@ -14,21 +13,17 @@ public void shutdownInformerFactoryInstantlyAfterStarting() {
     SharedInformerFactory factory = new SharedInformerFactory();
     factory.sharedIndexInformerFor(
         (CallGeneratorParams params) -> {
-          try {
-            return api.listNamespaceCall(
-                null,
-                null,
-                null,
-                null,
-                null,
-                params.resourceVersion,
-                params.timeoutSeconds,
-                params.watch,
-                null,
-                null);
-          } catch (ApiException e) {
-            throw new RuntimeException(e);
-          }
+          return api.listNamespaceCall(
+              null,
+              null,
+              null,
+              null,
+              null,
+              params.resourceVersion,
+              params.timeoutSeconds,
+              params.watch,
+              null,
+              null);
         },
         V1Namespace.class,
         V1NamespaceList.class);
