Merge pull request #544 from yue9944882/bugfix/intercept-patch-format-contenttype

Fixes patch format to support various patch formats

Author: k8s-ci-robot

kubernetes/src/main/java/io/kubernetes/client/ApiClient.java

@@ -73,6 +73,10 @@ public class ApiClient {
 
     private HttpLoggingInterceptor loggingInterceptor;
 
+    public static final String PATCH_FORMAT_JSON_PATCH = "application/json-patch+json";
+    public static final String PATCH_FORMAT_JSON_MERGE_PATCH = "application/merge-patch+json";
+    public static final String PATCH_FORMAT_STRATEGIC_MERGE_PATCH = "application/strategic-merge-patch+json";
+
     /*
      * Constructor for ApiClient
      */

util/src/main/java/io/kubernetes/client/util/ClientBuilder.java

@@ -21,6 +21,8 @@
 import static io.kubernetes.client.util.KubeConfig.KUBECONFIG;
 import static io.kubernetes.client.util.KubeConfig.KUBEDIR;
 
+import com.google.common.base.Strings;
+import com.squareup.okhttp.*;
 import io.kubernetes.client.ApiClient;
 import io.kubernetes.client.util.credentials.AccessTokenAuthentication;
 import io.kubernetes.client.util.credentials.Authentication;
@@ -43,6 +45,7 @@ public class ClientBuilder {
   private String basePath = Config.DEFAULT_FALLBACK_HOST;
   private byte[] caCertBytes = null;
   private boolean verifyingSsl = true;
+  private String overridePatchFormat;
   private Authentication authentication;
 
   /**
@@ -272,6 +275,15 @@ public ClientBuilder setVerifyingSsl(boolean verifyingSsl) {
     return this;
   }
 
+  public String overridePatchFormat() {
+    return overridePatchFormat;
+  }
+
+  public ClientBuilder setOverridePatchFormat(String patchFormat) {
+    this.overridePatchFormat = patchFormat;
+    return this;
+  }
+
   public ApiClient build() {
     final ApiClient client = new ApiClient();
 
@@ -301,6 +313,31 @@ public ApiClient build() {
       client.setSslCaCert(new ByteArrayInputStream(caCertBytes));
     }
 
+    if (!Strings.isNullOrEmpty(overridePatchFormat)) {
+      client
+          .getHttpClient()
+          .interceptors()
+          .add(
+              new Interceptor() {
+                @Override
+                public Response intercept(Chain chain) throws IOException {
+                  Request request = chain.request();
+
+                  if ("PATCH".equals(request.method())) {
+
+                    Request newRequest =
+                        request
+                            .newBuilder()
+                            .patch(
+                                new ProxyContentTypeRequestBody(
+                                    request.body(), overridePatchFormat))
+                            .build();
+                    return chain.proceed(newRequest);
+                  }
+                  return chain.proceed(request);
+                }
+              });
+    }
     return client;
   }
 }

util/src/main/java/io/kubernetes/client/util/ProxyContentTypeRequestBody.java

@@ -0,0 +1,36 @@
+/** Alipay.com Inc. Copyright (c) 2004-2019 All Rights Reserved. */
+package io.kubernetes.client.util;
+
+import com.google.common.base.Strings;
+import com.squareup.okhttp.MediaType;
+import com.squareup.okhttp.RequestBody;
+import java.io.IOException;
+import okio.BufferedSink;
+
+public class ProxyContentTypeRequestBody extends RequestBody {
+
+  private String overridePatchFormat;
+  private RequestBody delegateRequestBody;
+
+  public ProxyContentTypeRequestBody(RequestBody delegateRequestBody) {
+    this.delegateRequestBody = delegateRequestBody;
+  }
+
+  public ProxyContentTypeRequestBody(RequestBody delegateRequestBody, String patchFormat) {
+    this(delegateRequestBody);
+    this.overridePatchFormat = patchFormat;
+  }
+
+  @Override
+  public MediaType contentType() {
+    if (!Strings.isNullOrEmpty(overridePatchFormat)) {
+      return MediaType.parse(overridePatchFormat);
+    }
+    return delegateRequestBody.contentType();
+  }
+
+  @Override
+  public void writeTo(BufferedSink bufferedSink) throws IOException {
+    delegateRequestBody.writeTo(bufferedSink);
+  }
+}

util/src/test/java/io/kubernetes/client/util/ClientBuilderPatchTest.java

@@ -0,0 +1,72 @@
+/*
+Copyright 2017 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.util;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.*;
+
+import com.github.tomakehurst.wiremock.client.WireMock;
+import com.github.tomakehurst.wiremock.junit.WireMockRule;
+import com.squareup.okhttp.Call;
+import io.kubernetes.client.ApiClient;
+import io.kubernetes.client.ApiException;
+import java.io.IOException;
+import java.util.HashMap;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+
+/** Tests for the ConfigBuilder helper class */
+public class ClientBuilderPatchTest {
+
+  private ApiClient client;
+  private static final int PORT = 8089;
+
+  @Rule public WireMockRule wireMockRule = new WireMockRule(PORT);
+
+  @Before
+  public void setup() throws IOException {
+    client =
+        new ClientBuilder()
+            .setBasePath("http://localhost:" + PORT)
+            .setOverridePatchFormat(ApiClient.PATCH_FORMAT_STRATEGIC_MERGE_PATCH)
+            .build();
+  }
+
+  @Test
+  public void testOverridePatchFormatInterceptor() throws IOException, ApiException {
+    stubFor(
+        patch(urlPathEqualTo("/apis"))
+            .willReturn(
+                aResponse()
+                    .withStatus(200)
+                    .withHeader("Content-Type", ApiClient.PATCH_FORMAT_STRATEGIC_MERGE_PATCH)
+                    .withBody("{}")));
+    Call call =
+        client.buildCall(
+            "/apis",
+            "PATCH",
+            null,
+            null,
+            null,
+            new HashMap<>(),
+            new HashMap<>(),
+            new String[] {},
+            null);
+    client.execute(call);
+
+    WireMock.verify(
+        1,
+        patchRequestedFor(urlPathEqualTo("/apis"))
+            .withHeader("Content-Type", equalTo(ApiClient.PATCH_FORMAT_STRATEGIC_MERGE_PATCH)));
+  }
+}

util/src/test/java/io/kubernetes/client/util/ClientBuilderTest.java

@@ -12,6 +12,7 @@
  */
 package io.kubernetes.client.util;
 
+import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static org.hamcrest.core.Is.is;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
@@ -20,6 +21,7 @@
 
 import com.google.common.io.Resources;
 import io.kubernetes.client.ApiClient;
+import io.kubernetes.client.ApiException;
 import io.kubernetes.client.util.credentials.Authentication;
 import java.io.File;
 import java.io.IOException;
@@ -162,4 +164,12 @@ public void testSslCertCaBad() throws Exception {
             .setCertificateAuthority(Files.readAllBytes(Paths.get(INVALID_SSL_CA_CERT_PATH)))
             .build();
   }
+
+  @Test
+  public void testOverridePatchFormat() throws IOException, ApiException {
+    final ApiClient client =
+        new ClientBuilder()
+            .setOverridePatchFormat(ApiClient.PATCH_FORMAT_STRATEGIC_MERGE_PATCH)
+            .build();
+  }
 }