PodOperationsImpl.java

/**
 * Copyright (C) 2015 Red Hat, Inc.
 *
 * 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.fabric8.kubernetes.client.dsl.internal.core.v1;

import io.fabric8.kubernetes.api.model.Container;
import io.fabric8.kubernetes.api.model.DeleteOptions;
import io.fabric8.kubernetes.api.model.EphemeralContainer;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.Pod;
import io.fabric8.kubernetes.api.model.PodList;
import io.fabric8.kubernetes.api.model.PodSpec;
import io.fabric8.kubernetes.api.model.policy.v1beta1.Eviction;
import io.fabric8.kubernetes.api.model.policy.v1beta1.EvictionBuilder;
import io.fabric8.kubernetes.client.Client;
import io.fabric8.kubernetes.client.KubernetesClientException;
import io.fabric8.kubernetes.client.LocalPortForward;
import io.fabric8.kubernetes.client.PortForward;
import io.fabric8.kubernetes.client.dsl.BytesLimitTerminateTimeTailPrettyLoggable;
import io.fabric8.kubernetes.client.dsl.CopyOrReadable;
import io.fabric8.kubernetes.client.dsl.EphemeralContainersResource;
import io.fabric8.kubernetes.client.dsl.ExecListenable;
import io.fabric8.kubernetes.client.dsl.ExecListener;
import io.fabric8.kubernetes.client.dsl.ExecWatch;
import io.fabric8.kubernetes.client.dsl.Execable;
import io.fabric8.kubernetes.client.dsl.LogWatch;
import io.fabric8.kubernetes.client.dsl.Loggable;
import io.fabric8.kubernetes.client.dsl.PodResource;
import io.fabric8.kubernetes.client.dsl.PrettyLoggable;
import io.fabric8.kubernetes.client.dsl.TailPrettyLoggable;
import io.fabric8.kubernetes.client.dsl.TimeTailPrettyLoggable;
import io.fabric8.kubernetes.client.dsl.TtyExecErrorChannelable;
import io.fabric8.kubernetes.client.dsl.TtyExecErrorable;
import io.fabric8.kubernetes.client.dsl.TtyExecOutputErrorable;
import io.fabric8.kubernetes.client.dsl.TtyExecable;
import io.fabric8.kubernetes.client.dsl.internal.ExecWebSocketListener;
import io.fabric8.kubernetes.client.dsl.internal.HasMetadataOperation;
import io.fabric8.kubernetes.client.dsl.internal.HasMetadataOperationsImpl;
import io.fabric8.kubernetes.client.dsl.internal.LogWatchCallback;
import io.fabric8.kubernetes.client.dsl.internal.OperationContext;
import io.fabric8.kubernetes.client.dsl.internal.PodOperationContext;
import io.fabric8.kubernetes.client.dsl.internal.PodOperationContext.StreamContext;
import io.fabric8.kubernetes.client.dsl.internal.PortForwarderWebsocket;
import io.fabric8.kubernetes.client.dsl.internal.uploadable.PodUpload;
import io.fabric8.kubernetes.client.http.HttpRequest;
import io.fabric8.kubernetes.client.http.WebSocket;
import io.fabric8.kubernetes.client.lib.FilenameUtils;
import io.fabric8.kubernetes.client.utils.URLUtils;
import io.fabric8.kubernetes.client.utils.URLUtils.URLBuilder;
import io.fabric8.kubernetes.client.utils.Utils;
import io.fabric8.kubernetes.client.utils.internal.PodOperationUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.Reader;
import java.net.InetAddress;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

import static io.fabric8.kubernetes.client.utils.internal.OptionalDependencyWrapper.wrapRunWithOptionalDependency;

public class PodOperationsImpl extends HasMetadataOperation<Pod, PodList, PodResource>
    implements PodResource, EphemeralContainersResource, CopyOrReadable {

  public static final int HTTP_TOO_MANY_REQUESTS = 429;
  private static final Integer DEFAULT_POD_READY_WAIT_TIMEOUT = 5;
  private static final String[] EMPTY_COMMAND = { "/bin/sh", "-i" };
  public static final String DEFAULT_CONTAINER_ANNOTATION_NAME = "kubectl.kubernetes.io/default-container";

  static final Logger LOG = LoggerFactory.getLogger(PodOperationsImpl.class);

  private final PodOperationContext podOperationContext;

  public PodOperationsImpl(Client client) {
    this(new PodOperationContext(), HasMetadataOperationsImpl.defaultContext(client));
  }

  public PodOperationsImpl(PodOperationContext context, OperationContext superContext) {
    super(superContext.withPlural("pods"), Pod.class, PodList.class);
    this.podOperationContext = context;
  }

  @Override
  public PodOperationsImpl newInstance(OperationContext context) {
    return new PodOperationsImpl(podOperationContext, context);
  }

  public PodOperationContext getContext() {
    return podOperationContext;
  }

  protected <T> T doGetLog(Class<T> type) {
    try {
      URL url = new URL(URLUtils.join(getResourceUrl().toString(), podOperationContext.getLogParameters()));

      PodOperationUtil.waitUntilReadyOrSucceded(this,
          getContext().getReadyWaitTimeout() != null ? getContext().getReadyWaitTimeout() : DEFAULT_POD_READY_WAIT_TIMEOUT);

      return handleRawGet(url, type);
    } catch (IOException ioException) {
      throw KubernetesClientException.launderThrowable(forOperationType("doGetLog"), ioException);
    }
  }

  @Override
  public String getLog() {
    return doGetLog(String.class);
  }

  /**
   * Returns an unclosed Reader. It's the caller responsibility to close it.
   *
   * @return Reader
   */
  @Override
  public Reader getLogReader() {
    return doGetLog(Reader.class);
  }

  /**
   * Returns an unclosed InputStream. It's the caller responsibility to close it.
   *
   * @return InputStream
   */
  @Override
  public InputStream getLogInputStream() {
    return doGetLog(InputStream.class);
  }

  @Override
  public String getLog(boolean isPretty) {
    return new PodOperationsImpl(getContext().withPrettyOutput(isPretty), context).getLog();
  }

  @Override
  public LogWatch watchLog() {
    return watchLog(null);
  }

  private void checkForPiped(Object object) {
    if (object instanceof PipedOutputStream || object instanceof PipedInputStream) {
      throw new KubernetesClientException("Piped streams should not be used");
    }
  }

  @Override
  public LogWatch watchLog(OutputStream out) {
    checkForPiped(out);
    try {
      PodOperationUtil.waitUntilReadyOrSucceded(this,
          getContext().getReadyWaitTimeout() != null ? getContext().getReadyWaitTimeout() : DEFAULT_POD_READY_WAIT_TIMEOUT);
      // Issue Pod Logs HTTP request
      URL url = new URL(URLUtils.join(getResourceUrl().toString(), getContext().getLogParameters() + "&follow=true"));
      final LogWatchCallback callback = new LogWatchCallback(out, context);
      return callback.callAndWait(httpClient, url);
    } catch (IOException ioException) {
      throw KubernetesClientException.launderThrowable(forOperationType("watchLog"), ioException);
    }
  }

  @Override
  public PodOperationsImpl withReadyWaitTimeout(Integer logWaitTimeout) {
    return new PodOperationsImpl(getContext().withReadyWaitTimeout(logWaitTimeout), context);
  }

  @Override
  public Loggable withLogWaitTimeout(Integer logWaitTimeout) {
    return withReadyWaitTimeout(logWaitTimeout);
  }

  @Override
  public PortForward portForward(int port, ReadableByteChannel in, WritableByteChannel out) {
    try {
      return new PortForwarderWebsocket(httpClient, this.context.getExecutor(), getRequestConfig().getRequestTimeout())
          .forward(getResourceUrl(), port, in, out);
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(e);
    }
  }

  @Override
  public LocalPortForward portForward(int port) {
    return portForward(port, 0);
  }

  @Override
  public LocalPortForward portForward(int port, int localPort) {
    return portForward(port, null, localPort);
  }

  @Override
  public LocalPortForward portForward(int port, InetAddress localInetAddress, int localPort) {
    try {
      return new PortForwarderWebsocket(httpClient, this.context.getExecutor(), getRequestConfig().getRequestTimeout())
          .forward(getResourceUrl(), port, localInetAddress, localPort);
    } catch (MalformedURLException ex) {
      throw KubernetesClientException.launderThrowable(ex);
    }
  }

  @Override
  public boolean evict() {
    Eviction eviction = new EvictionBuilder()
        .withNewMetadata()
        .withName(getName())
        .withNamespace(getNamespace())
        .endMetadata()
        .withDeleteOptions(new DeleteOptions())
        .build();
    return handleEvict(eviction);
  }

  @Override
  public boolean evict(io.fabric8.kubernetes.api.model.policy.v1.Eviction eviction) {
    return handleEvict(eviction);
  }

  private boolean handleEvict(HasMetadata eviction) {
    try {
      if (Utils.isNullOrEmpty(eviction.getMetadata().getNamespace())) {
        throw new KubernetesClientException("Namespace not specified, but operation requires it.");
      }
      if (Utils.isNullOrEmpty(eviction.getMetadata().getName())) {
        throw new KubernetesClientException("Name not specified, but operation requires it.");
      }

      URL requestUrl = new URL(URLUtils.join(getResourceUrl().toString(), "eviction"));
      HttpRequest.Builder requestBuilder = httpClient.newHttpRequestBuilder()
          .post(JSON, getKubernetesSerialization().asJson(eviction)).url(requestUrl);
      handleResponse(requestBuilder, null);
      return true;
    } catch (KubernetesClientException e) {
      if (e.getCode() != HTTP_TOO_MANY_REQUESTS) {
        throw e;
      }
      return false;
    } catch (IOException exception) {
      throw KubernetesClientException.launderThrowable(forOperationType("evict"), exception);
    }
  }

  @Override
  public EphemeralContainersResource ephemeralContainers() {
    return new PodOperationsImpl(getContext(), context.withSubresource("ephemeralcontainers"));
  }

  @Override
  public PodOperationsImpl inContainer(
      String containerId) {
    return new PodOperationsImpl(getContext().withContainerId(containerId), context);
  }

  @Override
  public ExecWatch exec(String... command) {
    String[] actualCommands = command.length >= 1 ? command : EMPTY_COMMAND;
    try {
      URL url = getURL("exec", actualCommands);

      return setupConnectionToPod(url.toURI());
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(forOperationType("exec"), e);
    }
  }

  @Override
  public ExecWatch attach() {
    try {
      URL url = getURL("attach", null);

      return setupConnectionToPod(url.toURI());
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(forOperationType("attach"), e);
    }
  }

  private URL getURL(String operation, String[] commands) throws MalformedURLException {
    Pod fromServer = PodOperationUtil.waitUntilReadyOrSucceded(this,
        getContext().getReadyWaitTimeout() != null ? getContext().getReadyWaitTimeout() : DEFAULT_POD_READY_WAIT_TIMEOUT);

    String url = URLUtils.join(getResourceUrl().toString(), operation);
    URLBuilder httpUrlBuilder = new URLBuilder(url);
    if (commands != null) {
      for (String cmd : commands) {
        httpUrlBuilder.addQueryParameter("command", cmd);
      }
    }
    PodOperationContext contextToUse = getContext();
    contextToUse = contextToUse.withContainerId(validateOrDefaultContainerId(contextToUse.getContainerId(), fromServer));
    contextToUse.addQueryParameters(httpUrlBuilder);
    return httpUrlBuilder.build();
  }

  /**
   * If not specified, choose an appropriate default container id
   */
  String validateOrDefaultContainerId(String name, Pod pod) {
    if (pod == null) {
      pod = this.getItemOrRequireFromServer();
    }

    // spec and container null-checks are not necessary for real k8s clusters, added them to simplify some tests running in the mockserver
    PodSpec spec = pod.getSpec();
    if (spec == null) {
      spec = new PodSpec();
    }

    if (name == null) {
      List<Container> containers = spec.getContainers();
      if (containers == null || containers.isEmpty()) {
        throw new KubernetesClientException("Pod has no containers!");
      }

      name = pod.getMetadata().getAnnotations().get(DEFAULT_CONTAINER_ANNOTATION_NAME);
      if (name != null && !hasContainer(containers, name)) {
        LOG.warn("Default container {} from annotation not found in pod {}", name, pod.getMetadata().getName());
        name = null;
      }

      if (name == null) {
        name = containers.get(0).getName();
        LOG.debug("using first container {} in pod {}", name, pod.getMetadata().getName());
      }
    } else if (!hasContainer(spec.getContainers(), name) && !hasContainer(spec.getInitContainers(), name)
        && !hasEphemeralContainer(spec.getEphemeralContainers(), name)) {
      throw new KubernetesClientException(
          String.format("container %s not found in pod %s", name, pod.getMetadata().getName()));
    }

    return name;
  }

  private boolean hasContainer(List<Container> containers, String toFind) {
    return containers != null && containers.stream().map(Container::getName).anyMatch(s -> s.equals(toFind));
  }

  private boolean hasEphemeralContainer(List<EphemeralContainer> containers, String toFind) {
    return containers != null && containers.stream().map(EphemeralContainer::getName).anyMatch(s -> s.equals(toFind));
  }

  private ExecWebSocketListener setupConnectionToPod(URI uri) {
    ExecWebSocketListener execWebSocketListener = new ExecWebSocketListener(getContext(), this.context.getExecutor(),
        this.getKubernetesSerialization());
    CompletableFuture<WebSocket> startedFuture = httpClient.newWebSocketBuilder()
        .subprotocol("v4.channel.k8s.io")
        .uri(uri)
        .connectTimeout(getRequestConfig().getRequestTimeout(), TimeUnit.MILLISECONDS)
        .buildAsync(execWebSocketListener);
    startedFuture.whenComplete((w, t) -> {
      if (t != null) {
        execWebSocketListener.onError(w, t);
      }
    });
    Utils.waitUntilReadyOrFail(startedFuture, getRequestConfig().getRequestTimeout(), TimeUnit.MILLISECONDS);
    return execWebSocketListener;
  }

  @Override
  public PodOperationsImpl file(String file) {
    return new PodOperationsImpl(getContext().withFile(file), context);
  }

  @Override
  public PodOperationsImpl dir(String dir) {
    return new PodOperationsImpl(getContext().withDir(dir), context);
  }

  @Override
  public boolean copy(Path destination) {
    try {
      if (Utils.isNotNullOrEmpty(getContext().getFile())) {
        copyFile(getContext().getFile(), destination.toFile());
        return true;
      } else if (Utils.isNotNullOrEmpty(getContext().getDir())) {
        copyDir(getContext().getDir(), destination.toFile());
        return true;
      }
      throw new IllegalStateException("No file or dir has been specified");
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(e);
    }
  }

  @Override
  public boolean upload(InputStream inputStream) {
    return wrapRunWithOptionalDependency(() -> {
      try {
        return PodUpload.uploadFileData(this, inputStream);
      } catch (Exception ex) {
        throw KubernetesClientException.launderThrowable(ex);
      }
    }, "TarArchiveOutputStream is provided by commons-compress");
  }

  @Override
  public boolean upload(Path path) {
    return wrapRunWithOptionalDependency(() -> {
      try {
        return PodUpload.upload(this, path);
      } catch (Exception ex) {
        throw KubernetesClientException.launderThrowable(ex);
      }
    }, "TarArchiveOutputStream is provided by commons-compress");
  }

  @Override
  public InputStream read() {
    try {
      if (Utils.isNotNullOrEmpty(getContext().getFile())) {
        return readFile(getContext().getFile());
      } else if (Utils.isNotNullOrEmpty(getContext().getDir())) {
        return readTar(getContext().getDir());
      }
      throw new IllegalStateException("No file or dir has been specified");
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(e);
    }
  }

  private String[] readFileCommand(String source) {
    return new String[] { "sh", "-c", String.format("cat %s", shellQuote(source)) };
  }

  private InputStream readFile(String source) {
    return read(readFileCommand(source));
  }

  //
  //
  // The copy and read utilities below have been inspired by Brendan Burns copy utilities on the official kubernetes-client.
  // More specifically: https://github.com/kubernetes-client/java/pull/375
  //

  private void copyFile(String source, File target) {
    File destination = target;
    if (!destination.exists() && !destination.getParentFile().exists() && !destination.getParentFile().mkdirs()) {
      throw KubernetesClientException
          .launderThrowable(new IOException("Failed to create directory: " + destination.getParentFile()));
    }
    if (destination.isDirectory()) {
      String[] parts = source.split("\\/|\\\\");
      String filename = parts[parts.length - 1];
      destination = destination.toPath().resolve(filename).toFile();
    }

    try (OutputStream out = new BufferedOutputStream(new FileOutputStream(destination))) {
      ExecWatch w = writingOutput(out).exec(readFileCommand(source));
      w.exitCode().get();
    } catch (Exception e) {
      throw KubernetesClientException.launderThrowable(e);
    }
  }

  public InputStream readTar(String source) {
    return read("sh", "-c", "tar -cf - " + shellQuote(source));
  }

  private InputStream read(String... command) {
    ExecWatch watch = redirectingOutput().exec(command);
    return watch.getOutput();
  }

  private void copyDir(String source, File target) throws Exception {
    //Let's wrap the code to a runnable inner class to avoid NoClassDef on Option classes.
    try {
      new Runnable() {
        @Override
        public void run() {
          File destination = target;
          if (!destination.isDirectory() && !destination.mkdirs())

          {
            throw KubernetesClientException.launderThrowable(new IOException("Failed to create directory: " + destination));
          }
          try (
              InputStream is = readTar(source);
              org.apache.commons.compress.archivers.tar.TarArchiveInputStream tis = new org.apache.commons.compress.archivers.tar.TarArchiveInputStream(
                  is))

          {
            for (org.apache.commons.compress.archivers.ArchiveEntry entry = tis.getNextTarEntry(); entry != null; entry = tis
                .getNextEntry()) {
              if (tis.canReadEntryData(entry)) {
                final String normalizedEntryName = FilenameUtils.normalize(entry.getName());
                if (normalizedEntryName == null) {
                  throw new IOException("Tar entry '" + entry.getName() + "' has an invalid name");
                }
                File f = new File(destination, normalizedEntryName);
                if (entry.isDirectory()) {
                  if (!f.isDirectory() && !f.mkdirs()) {
                    throw new IOException("Failed to create directory: " + f);
                  }
                } else {
                  File parent = f.getParentFile();
                  if (!parent.isDirectory() && !parent.mkdirs()) {
                    throw new IOException("Failed to create directory: " + f);
                  }
                  Files.copy(tis, f.toPath(), StandardCopyOption.REPLACE_EXISTING);
                }
              }
            }
          } catch (Exception e) {
            throw KubernetesClientException.launderThrowable(e);
          }
        }
      }.run();
    } catch (NoClassDefFoundError e) {
      throw new KubernetesClientException(
          "TarArchiveInputStream class is provided by commons-compress, an optional dependency. To use the read/copy functionality you must explicitly add this dependency to the classpath.");
    }
  }

  @Override
  public TtyExecOutputErrorable readingInput(InputStream in) {
    checkForPiped(in);
    return new PodOperationsImpl(getContext().withIn(in), context);
  }

  @Override
  public PodOperationsImpl redirectingInput() {
    return redirectingInput(null);
  }

  @Override
  public PodOperationsImpl redirectingInput(Integer bufferSize) {
    return new PodOperationsImpl(getContext().toBuilder().redirectingIn(true).bufferSize(bufferSize).build(), context);
  }

  @Override
  public TtyExecErrorable writingOutput(OutputStream out) {
    checkForPiped(out);
    return new PodOperationsImpl(getContext().toBuilder().output(new StreamContext(out)).build(), context);
  }

  @Override
  public TtyExecErrorable redirectingOutput() {
    return new PodOperationsImpl(getContext().toBuilder().output(new StreamContext()).build(), context);
  }

  @Override
  public TtyExecErrorChannelable writingError(OutputStream err) {
    checkForPiped(err);
    return new PodOperationsImpl(getContext().toBuilder().error(new StreamContext(err)).build(), context);
  }

  @Override
  public TtyExecErrorChannelable redirectingError() {
    return new PodOperationsImpl(getContext().toBuilder().error(new StreamContext()).build(), context);
  }

  @Override
  public TtyExecable writingErrorChannel(OutputStream errChannel) {
    checkForPiped(errChannel);
    return new PodOperationsImpl(getContext().toBuilder().errorChannel(new StreamContext(errChannel)).build(), context);
  }

  @Override
  public TtyExecable redirectingErrorChannel() {
    return new PodOperationsImpl(getContext().toBuilder().errorChannel(new StreamContext()).build(), context);
  }

  @Override
  public ExecListenable withTTY() {
    return new PodOperationsImpl(getContext().withTty(true), context);
  }

  @Override
  public Loggable withPrettyOutput() {
    return new PodOperationsImpl(getContext().withPrettyOutput(true), context);
  }

  @Override
  public PrettyLoggable tailingLines(int withTailingLines) {
    return new PodOperationsImpl(getContext().withTailingLines(withTailingLines), context);
  }

  @Override
  public TailPrettyLoggable sinceTime(String sinceTimestamp) {
    return new PodOperationsImpl(getContext().withSinceTimestamp(sinceTimestamp), context);
  }

  @Override
  public TailPrettyLoggable sinceSeconds(int sinceSeconds) {
    return new PodOperationsImpl(getContext().withSinceSeconds(sinceSeconds), context);
  }

  @Override
  public TimeTailPrettyLoggable terminated() {
    return new PodOperationsImpl(getContext().withTerminatedStatus(true), context);
  }

  @Override
  public Execable usingListener(ExecListener execListener) {
    return new PodOperationsImpl(getContext().withExecListener(execListener), context);
  }

  @Override
  public BytesLimitTerminateTimeTailPrettyLoggable limitBytes(int limitBytes) {
    return new PodOperationsImpl(getContext().withLimitBytes(limitBytes), context);
  }

  @Override
  public BytesLimitTerminateTimeTailPrettyLoggable usingTimestamps() {
    return new PodOperationsImpl(getContext().withTimestamps(true), context);
  }

  public static String shellQuote(String value) {
    return "'" + value.replace("'", "'\\''") + "'";
  }

  @Override
  public PodOperationsImpl terminateOnError() {
    return new PodOperationsImpl(getContext().toBuilder().terminateOnError(true).build(), context);
  }
}