PodLogsTest.java

/*
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;

import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.models.V1Container;
import io.kubernetes.client.openapi.models.V1ObjectMeta;
import io.kubernetes.client.openapi.models.V1Pod;
import io.kubernetes.client.openapi.models.V1PodSpec;
import io.kubernetes.client.util.ClientBuilder;
import io.kubernetes.client.util.Streams;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import okhttp3.Call;
import okhttp3.Response;
import okhttp3.ResponseBody;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

/** Tests for the PodLogs helper class */
class PodLogsTest {
  private String namespace;
  private String podName;
  private String container;

  private ApiClient client;

  @RegisterExtension
  static WireMockExtension apiServer =
      WireMockExtension.newInstance().options(options().dynamicPort()).build();

  @BeforeEach
  void setup() {
    client = new ClientBuilder().setBasePath("http://localhost:" + apiServer.getPort()).build();

    namespace = "default";
    podName = "apod";
    container = "container";
  }

  @Test
  void notFound() throws ApiException, IOException {
    V1Pod pod =
        new V1Pod()
            .metadata(new V1ObjectMeta().name(podName).namespace(namespace))
            .spec(
                new V1PodSpec()
                    .containers(Arrays.asList(new V1Container().name(container).image("nginx"))));

    apiServer.stubFor(
        get(urlPathEqualTo("/api/v1/namespaces/" + namespace + "/pods/" + podName + "/log"))
            .willReturn(
                aResponse()
                    .withStatus(404)
                    .withHeader("Content-Type", "text/plain")
                    .withBody("Not Found")));

    PodLogs logs = new PodLogs(client);
    boolean thrown = false;
    try {
      logs.streamNamespacedPodLog(pod);
    } catch (ApiException ex) {
      assertThat(ex.getCode()).isEqualTo(404);
      thrown = true;
    }
    assertThat(thrown).isTrue();
    apiServer.verify(
        getRequestedFor(
                urlPathEqualTo("/api/v1/namespaces/" + namespace + "/pods/" + podName + "/log"))
            .withQueryParam("container", equalTo(container))
            .withQueryParam("follow", equalTo("true"))
            .withQueryParam("pretty", equalTo("false"))
            .withQueryParam("previous", equalTo("false"))
            .withQueryParam("timestamps", equalTo("false")));
  }

  @Test
  void stream() throws ApiException, IOException {
    V1Pod pod =
        new V1Pod()
            .metadata(new V1ObjectMeta().name(podName).namespace(namespace))
            .spec(
                new V1PodSpec()
                    .containers(Arrays.asList(new V1Container().name(container).image("nginx"))));

    String content = "this is some\n content for \n various logs \n done";

    apiServer.stubFor(
        get(urlPathEqualTo("/api/v1/namespaces/" + namespace + "/pods/" + podName + "/log"))
            .willReturn(
                aResponse()
                    .withStatus(200)
                    .withHeader("Content-Type", "text/plain")
                    .withBody(content)));

    PodLogs logs = new PodLogs(client);
    InputStream is = logs.streamNamespacedPodLog(pod);

    apiServer.verify(
        getRequestedFor(
                urlPathEqualTo("/api/v1/namespaces/" + namespace + "/pods/" + podName + "/log"))
            .withQueryParam("container", equalTo(container))
            .withQueryParam("follow", equalTo("true"))
            .withQueryParam("pretty", equalTo("false"))
            .withQueryParam("previous", equalTo("false"))
            .withQueryParam("timestamps", equalTo("false")));

    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    Streams.copy(is, bos);
    assertThat(bos).hasToString(content);
  }

  @Test
  void responseClosedOnError() throws ApiException, IOException {
    V1Pod pod =
        new V1Pod()
            .metadata(new V1ObjectMeta().name(podName).namespace(namespace))
            .spec(
                new V1PodSpec()
                    .containers(Arrays.asList(new V1Container().name(container).image("nginx"))));

    ApiClient mockClient = mock(ApiClient.class);
    Call mockCall = mock(Call.class);
    Response mockResponse = mock(Response.class);

    when(mockClient.escapeString(any())).thenReturn("foo");
    when(mockClient.buildCall(any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any()))
        .thenReturn(mockCall);
    when(mockCall.execute()).thenReturn(mockResponse);
    when(mockResponse.isSuccessful()).thenReturn(false);
    when(mockResponse.code()).thenReturn(404);
    when(mockResponse.body()).thenReturn(mock(ResponseBody.class));

    PodLogs logs = new PodLogs(mockClient);
    boolean thrown;
    try (InputStream ignored = logs.streamNamespacedPodLog(pod)) {
      thrown = false;
    } catch (ApiException ex) {
      assertThat(ex.getCode()).isEqualTo(404);
      thrown = true;
    }

    assertThat(thrown).isTrue();
    verify(mockResponse).close();
  }
}