Merge pull request #1135 from brendandburns/kubectl

Clean up/refactor kubectl to share some code and add kubectl exec.

Author: k8s-ci-robot

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

@@ -12,11 +12,13 @@
 */
 package io.kubernetes.client.examples;
 
+import static io.kubernetes.client.extended.kubectl.Kubectl.exec;
 import static io.kubernetes.client.extended.kubectl.Kubectl.label;
 import static io.kubernetes.client.extended.kubectl.Kubectl.scale;
 import static io.kubernetes.client.extended.kubectl.Kubectl.version;
 
 import io.kubernetes.client.common.KubernetesObject;
+import io.kubernetes.client.extended.kubectl.KubectlExec;
 import io.kubernetes.client.extended.kubectl.exception.KubectlException;
 import io.kubernetes.client.openapi.ApiClient;
 import io.kubernetes.client.openapi.models.V1Deployment;
@@ -25,6 +27,7 @@
 import io.kubernetes.client.openapi.models.V1ReplicationController;
 import io.kubernetes.client.openapi.models.V1Service;
 import io.kubernetes.client.util.Config;
+import java.util.Arrays;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
 import org.apache.commons.cli.Option;
@@ -68,6 +71,7 @@ public static void main(String[] args)
     Options options = new Options();
     options.addOption(new Option("n", "namespace", true, "The namespace for the resource"));
     options.addOption(new Option("r", "replicas", true, "The number of replicas to scale to"));
+    options.addOption(new Option("c", "container", true, "The container in a pod to connect to"));
     DefaultParser parser = new DefaultParser();
     CommandLine cli = parser.parse(options, args);
 
@@ -104,6 +108,13 @@ public static void main(String[] args)
         }
         label(client, clazz).namespace(ns).name(name).addLabel(labelKey, labelValue);
         System.exit(0);
+      case "exec":
+        name = args[1];
+        String[] command = Arrays.copyOfRange(args, 1, args.length);
+        KubectlExec e =
+            exec(client).namespace(ns).name(name).container(cli.getOptionValue("c", ""));
+        e.execute();
+        System.exit(e.exitCode());
       default:
         System.out.println("Unknown verb: " + verb);
         System.exit(-1);

extended/src/main/java/io/kubernetes/client/extended/kubectl/Kubectl.java

@@ -92,6 +92,26 @@ public static <ApiType extends KubernetesObject> KubectlScale<ApiType> scale(
     return new KubectlScale<>(apiClient, apiTypeClass);
   }
 
+  /**
+   * Equivalent for `kubectl exec`
+   *
+   * @param apiClient The api client instance
+   * @return the kubectl exec operator
+   */
+  public static KubectlExec exec(ApiClient apiClient) {
+    return new KubectlExec(apiClient);
+  }
+
+  /**
+   * Equivalent for `kubectl exec`
+   *
+   * @param apiClient The api client instance
+   * @return the kubectl exec operator
+   */
+  public static KubectlExec exec() {
+    return exec(Configuration.getDefaultApiClient());
+  }
+
   /**
    * Executable executes a kubectl helper.
    *
@@ -107,4 +127,40 @@ public static interface Executable<OUTPUT> {
      */
     OUTPUT execute() throws KubectlException;
   }
+
+  abstract static class ResourceBuilder<T extends ResourceBuilder<T>> {
+    final ApiClient apiClient;
+    final Class<?> apiTypeClass;
+    String namespace;
+    String name;
+
+    ResourceBuilder(ApiClient client, Class<?> apiTypeClass) {
+      this.apiClient = client;
+      this.apiTypeClass = apiTypeClass;
+    }
+
+    public T name(String name) {
+      this.name = name;
+      return (T) this;
+    }
+
+    public T namespace(String namespace) {
+      this.namespace = namespace;
+      return (T) this;
+    }
+  }
+
+  abstract static class ResourceAndContainerBuilder<T extends ResourceAndContainerBuilder<T>>
+      extends ResourceBuilder<T> {
+    String container;
+
+    ResourceAndContainerBuilder(ApiClient client, Class<?> apiTypeClass) {
+      super(client, apiTypeClass);
+    }
+
+    public T container(String container) {
+      this.container = container;
+      return (T) this;
+    }
+  }
 }

extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlExec.java

@@ -0,0 +1,88 @@
+/*
+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.extended.kubectl;
+
+import com.google.common.io.ByteStreams;
+import io.kubernetes.client.Exec;
+import io.kubernetes.client.extended.kubectl.exception.KubectlException;
+import io.kubernetes.client.openapi.ApiClient;
+import io.kubernetes.client.openapi.ApiException;
+import io.kubernetes.client.openapi.models.V1ObjectMeta;
+import io.kubernetes.client.openapi.models.V1Pod;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+public class KubectlExec extends Kubectl.ResourceAndContainerBuilder<KubectlExec>
+    implements Kubectl.Executable<V1Pod> {
+  private String[] command;
+  private boolean stdin;
+  private boolean tty;
+  private int result;
+
+  KubectlExec(ApiClient client) {
+    super(client, V1Pod.class);
+  }
+
+  public KubectlExec command(String[] command) {
+    this.command = command;
+    return this;
+  }
+
+  public KubectlExec stdin(boolean stdin) {
+    this.stdin = stdin;
+    return this;
+  }
+
+  public KubectlExec tty(boolean tty) {
+    this.tty = tty;
+    return this;
+  }
+
+  public int exitCode() {
+    return result;
+  }
+
+  @Override
+  public V1Pod execute() throws KubectlException {
+    V1Pod pod = new V1Pod().metadata(new V1ObjectMeta().name(name).namespace(namespace));
+
+    Exec exec = new Exec(apiClient);
+    try {
+      Process proc = exec.exec(pod, command, container, stdin, tty);
+      copyAsync(proc.getInputStream(), System.out);
+      copyAsync(proc.getErrorStream(), System.err);
+      if (stdin) {
+        copyAsync(System.in, proc.getOutputStream());
+      }
+      this.result = proc.waitFor();
+    } catch (InterruptedException | ApiException | IOException ex) {
+      throw new KubectlException(ex);
+    }
+    return pod;
+  }
+
+  private static void copyAsync(InputStream in, OutputStream out) {
+    new Thread(
+            new Runnable() {
+              public void run() {
+                try {
+                  ByteStreams.copy(in, out);
+                } catch (IOException ex) {
+                  ex.printStackTrace();
+                }
+              }
+            })
+        .start();
+  }
+}

extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlLabel.java

@@ -23,23 +23,16 @@
 import java.util.Map;
 import org.apache.commons.lang.StringUtils;
 
-public class KubectlLabel<ApiType extends KubernetesObject> implements Kubectl.Executable<ApiType> {
-
-  private final ApiClient apiClient;
-  private final Class<ApiType> apiTypeClass;
+public class KubectlLabel<ApiType extends KubernetesObject>
+    extends Kubectl.ResourceBuilder<KubectlLabel<ApiType>> implements Kubectl.Executable<ApiType> {
   private final Map<String, String> addingLabels;
-
   private String apiGroup;
   private String apiVersion;
   private String resourceNamePlural;
 
-  private String namespace;
-  private String name;
-
   KubectlLabel(ApiClient apiClient, Class<ApiType> apiTypeClass) {
+    super(apiClient, apiTypeClass);
     this.addingLabels = new HashMap<>();
-    this.apiTypeClass = apiTypeClass;
-    this.apiClient = apiClient;
   }
 
   public KubectlLabel<ApiType> apiGroup(String apiGroup) {
@@ -57,16 +50,6 @@ public KubectlLabel<ApiType> resourceNamePlural(String resourceNamePlural) {
     return this;
   }
 
-  public KubectlLabel<ApiType> namespace(String namespace) {
-    this.namespace = namespace;
-    return this;
-  }
-
-  public KubectlLabel<ApiType> name(String name) {
-    this.name = name;
-    return this;
-  }
-
   public KubectlLabel<ApiType> addLabel(String key, String value) {
     this.addingLabels.put(key, value);
     return this;
@@ -81,7 +64,7 @@ public ApiType execute() throws KubectlException {
     verifyArguments();
     GenericKubernetesApi<ApiType, KubernetesListObject> api =
         new GenericKubernetesApi<>(
-            apiTypeClass,
+            (Class<ApiType>) apiTypeClass,
             KubernetesListObject.class,
             apiGroup,
             apiVersion,

extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlScale.java

@@ -22,31 +22,17 @@
 import io.kubernetes.client.openapi.models.V1ReplicaSet;
 import io.kubernetes.client.util.PatchUtils;
 
-public class KubectlScale<ApiType extends KubernetesObject> implements Kubectl.Executable<ApiType> {
-  private final ApiClient apiClient;
-  private final Class<ApiType> apiTypeClass;
+public class KubectlScale<ApiType extends KubernetesObject>
+    extends Kubectl.ResourceBuilder<KubectlScale<ApiType>> implements Kubectl.Executable<ApiType> {
   private final AppsV1Api api;
-  private String namespace;
-  private String name;
   private int replicas;
 
   KubectlScale(ApiClient client, Class<ApiType> apiTypeClass) {
-    this.apiClient = client;
-    this.apiTypeClass = apiTypeClass;
+    super(client, apiTypeClass);
     this.api = new AppsV1Api(client);
     this.replicas = -1;
   }
 
-  public KubectlScale<ApiType> name(String name) {
-    this.name = name;
-    return this;
-  }
-
-  public KubectlScale<ApiType> namespace(String namespace) {
-    this.namespace = namespace;
-    return this;
-  }
-
   public KubectlScale<ApiType> replicas(int replicas) {
     this.replicas = replicas;
     return this;
@@ -62,7 +48,7 @@ public ApiType execute() throws KubectlException {
     try {
       if (apiTypeClass.equals(V1Deployment.class)) {
         return PatchUtils.patch(
-            apiTypeClass,
+            (Class<ApiType>) apiTypeClass,
             () ->
                 api.patchNamespacedDeploymentCall(
                     name,
@@ -77,7 +63,7 @@ public ApiType execute() throws KubectlException {
             this.apiClient);
       } else if (apiTypeClass.equals(V1ReplicaSet.class)) {
         return PatchUtils.patch(
-            apiTypeClass,
+            (Class<ApiType>) apiTypeClass,
             () ->
                 api.patchNamespacedReplicaSetCall(
                     name, namespace, new V1Patch(jsonPatchStr), null, null, null, null, null),

extended/src/test/java/io/kubernetes/client/extended/kubectl/KubectlScaleTest.java

@@ -71,12 +71,9 @@ public void testKubectlScaleReplicaSetShouldWork() throws KubectlException {
                 aResponse()
                     .withStatus(200)
                     .withBody("{\"metadata\":{\"name\":\"foo\",\"namespace\":\"default\"}}")));
-    V1ReplicaSet scaled =
-        Kubectl.scale(apiClient, V1ReplicaSet.class)
-            .name("foo")
-            .namespace("default")
-            .replicas(4)
-            .execute();
+    KubectlScale<V1ReplicaSet> s =
+        Kubectl.scale(apiClient, V1ReplicaSet.class).replicas(4).name("foo").namespace("default");
+    V1ReplicaSet scaled = s.execute();
     wireMockRule.verify(
         1,
         patchRequestedFor(urlPathEqualTo("/apis/apps/v1/namespaces/default/replicasets/foo"))