Proof that clients support gzip and deflate compression (#1713)

* Proof that clients support gzip and deflate compression

* Remove unused private methods

Author: vitalijr2

core/src/test/java/feign/client/AbstractClientTest.java

@@ -14,7 +14,8 @@
 package feign.client;
 
 import static feign.Util.UTF_8;
-import static org.assertj.core.api.Assertions.*;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.entry;
 import static org.junit.Assert.assertEquals;
 
 import feign.Client;
@@ -29,13 +30,18 @@
 import feign.Util;
 import feign.assertj.MockWebServerAssertions;
 import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.zip.DeflaterOutputStream;
+import java.util.zip.GZIPOutputStream;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
 import okhttp3.mockwebserver.RecordedRequest;
+import okio.Buffer;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -396,6 +402,60 @@ public void testAlternativeCollectionFormat() throws Exception {
         .hasOneOfPath("/?foo=bar,baz", "/?foo=bar%2Cbaz");
   }
 
+  @Test
+  public void canSupportGzip() throws Exception {
+    /* enqueue a zipped response */
+    final String responseData = "Compressed Data";
+    server.enqueue(
+        new MockResponse()
+            .addHeader("Content-Encoding", "gzip")
+            .setBody(new Buffer().write(compress(responseData))));
+
+    TestInterface api =
+        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
+
+    String result = api.get();
+
+    /* verify that the response is unzipped */
+    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
+  }
+
+  @Test
+  public void canSupportDeflate() throws Exception {
+    /* enqueue a zipped response */
+    final String responseData = "Compressed Data";
+    server.enqueue(
+        new MockResponse()
+            .addHeader("Content-Encoding", "deflate")
+            .setBody(new Buffer().write(deflate(responseData))));
+
+    TestInterface api =
+        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
+
+    String result = api.get();
+
+    /* verify that the response is unzipped */
+    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
+  }
+
+  @Test
+  public void canExceptCaseInsensitiveHeader() throws Exception {
+    /* enqueue a zipped response */
+    final String responseData = "Compressed Data";
+    server.enqueue(
+        new MockResponse()
+            .addHeader("content-encoding", "gzip")
+            .setBody(new Buffer().write(compress(responseData))));
+
+    TestInterface api =
+        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
+
+    String result = api.get();
+
+    /* verify that the response is unzipped */
+    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
+  }
+
   @SuppressWarnings("UnusedReturnValue")
   public interface TestInterface {
 
@@ -442,4 +502,22 @@ public interface TestInterface {
     @Headers({"Foo: Bar", "Foo: Baz", "Qux: ", "Content-Type: {contentType}"})
     Response postWithContentType(String body, @Param("contentType") String contentType);
   }
+
+  private byte[] compress(String data) throws Exception {
+    try (ByteArrayOutputStream bos = new ByteArrayOutputStream(data.length())) {
+      GZIPOutputStream gzipOutputStream = new GZIPOutputStream(bos);
+      gzipOutputStream.write(data.getBytes(StandardCharsets.UTF_8), 0, data.length());
+      gzipOutputStream.close();
+      return bos.toByteArray();
+    }
+  }
+
+  private byte[] deflate(String data) throws Exception {
+    try (ByteArrayOutputStream bos = new ByteArrayOutputStream(data.length())) {
+      DeflaterOutputStream deflaterOutputStream = new DeflaterOutputStream(bos);
+      deflaterOutputStream.write(data.getBytes(StandardCharsets.UTF_8), 0, data.length());
+      deflaterOutputStream.close();
+      return bos.toByteArray();
+    }
+  }
 }

core/src/test/java/feign/client/DefaultClientTest.java

@@ -22,7 +22,6 @@
 import feign.Feign;
 import feign.Feign.Builder;
 import feign.RetryableException;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.net.HttpURLConnection;
 import java.net.InetSocketAddress;
@@ -31,14 +30,10 @@
 import java.net.Proxy.Type;
 import java.net.SocketAddress;
 import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.util.zip.DeflaterOutputStream;
-import java.util.zip.GZIPOutputStream;
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLSession;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.SocketPolicy;
-import okio.Buffer;
 import org.junit.Test;
 
 /** Tests client-specific behavior, such as ensuring Content-Length is sent when specified. */
@@ -152,76 +147,4 @@ public void canCreateWithExplicitCredentials() throws Exception {
     HttpURLConnection connection = proxied.getConnection(new URL("http://www.example.com"));
     assertThat(connection).isNotNull().isInstanceOf(HttpURLConnection.class);
   }
-
-  @Test
-  public void canSupportGzip() throws Exception {
-    /* enqueue a zipped response */
-    final String responseData = "Compressed Data";
-    server.enqueue(
-        new MockResponse()
-            .addHeader("Content-Encoding", "gzip")
-            .setBody(new Buffer().write(compress(responseData))));
-
-    TestInterface api =
-        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
-
-    String result = api.get();
-
-    /* verify that the response is unzipped */
-    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
-  }
-
-  @Test
-  public void canExeptCaseInsensitiveHeader() throws Exception {
-    /* enqueue a zipped response */
-    final String responseData = "Compressed Data";
-    server.enqueue(
-        new MockResponse()
-            .addHeader("content-encoding", "gzip")
-            .setBody(new Buffer().write(compress(responseData))));
-
-    TestInterface api =
-        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
-
-    String result = api.get();
-
-    /* verify that the response is unzipped */
-    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
-  }
-
-  @Test
-  public void canSupportDeflate() throws Exception {
-    /* enqueue a zipped response */
-    final String responseData = "Compressed Data";
-    server.enqueue(
-        new MockResponse()
-            .addHeader("Content-Encoding", "deflate")
-            .setBody(new Buffer().write(deflate(responseData))));
-
-    TestInterface api =
-        newBuilder().target(TestInterface.class, "http://localhost:" + server.getPort());
-
-    String result = api.get();
-
-    /* verify that the response is unzipped */
-    assertThat(result).isNotNull().isEqualToIgnoringCase(responseData);
-  }
-
-  private byte[] compress(String data) throws Exception {
-    try (ByteArrayOutputStream bos = new ByteArrayOutputStream(data.length())) {
-      GZIPOutputStream gzipOutputStream = new GZIPOutputStream(bos);
-      gzipOutputStream.write(data.getBytes(StandardCharsets.UTF_8), 0, data.length());
-      gzipOutputStream.close();
-      return bos.toByteArray();
-    }
-  }
-
-  private byte[] deflate(String data) throws Exception {
-    try (ByteArrayOutputStream bos = new ByteArrayOutputStream(data.length())) {
-      DeflaterOutputStream deflaterOutputStream = new DeflaterOutputStream(bos);
-      deflaterOutputStream.write(data.getBytes(StandardCharsets.UTF_8), 0, data.length());
-      deflaterOutputStream.close();
-      return bos.toByteArray();
-    }
-  }
 }

googlehttpclient/README.md

@@ -2,7 +2,7 @@
 
 This module is a feign [Client](https://github.com/OpenFeign/feign/blob/master/core/src/main/java/feign/Client.java) to use the java [Google Http Client](https://github.com/googleapis/google-http-java-client).
 
-To use this, add to your classpath (via maven, or otherwise). Then cofigure Feign to use the GoogleHttpClient:
+To use this, add to your classpath (via maven, or otherwise). Then configure Feign to use the GoogleHttpClient:
 
 ```java
 GitHub github = Feign.builder()

googlehttpclient/src/test/java/feign/googlehttpclient/GoogleHttpClientTest.java

@@ -13,6 +13,8 @@
  */
 package feign.googlehttpclient;
 
+import static org.junit.Assume.assumeFalse;
+
 import feign.Feign;
 import feign.Feign.Builder;
 import feign.client.AbstractClientTest;
@@ -33,4 +35,23 @@ public void testPatch() {}
 
   @Override
   public void parsesUnauthorizedResponseBody() {}
+
+  /*
+   * Google HTTP client with NetHttpTransport does not support gzip and deflate compression
+   * out-of-the-box. You can replace the transport with Apache HTTP Client.
+   */
+  @Override
+  public void canSupportGzip() throws Exception {
+    assumeFalse("Google HTTP client client do not support gzip compression", false);
+  }
+
+  @Override
+  public void canSupportDeflate() throws Exception {
+    assumeFalse("Google HTTP client client do not support deflate compression", false);
+  }
+
+  @Override
+  public void canExceptCaseInsensitiveHeader() throws Exception {
+    assumeFalse("Google HTTP client client do not support gzip compression", false);
+  }
 }

jaxrs2/src/test/java/feign/jaxrs2/JAXRSClientTest.java

@@ -16,6 +16,7 @@
 import static feign.Util.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assume.assumeFalse;
 
 import feign.*;
 import feign.Feign.Builder;
@@ -150,6 +151,24 @@ public void testConsumesMultipleWithContentTypeHeaderAndBody() throws Exception
         .hasMethod("POST");
   }
 
+  /*
+   * JaxRS does not support gzip and deflate compression out-of-the-box.
+   */
+  @Override
+  public void canSupportGzip() throws Exception {
+    assumeFalse("JaxRS client do not support gzip compression", false);
+  }
+
+  @Override
+  public void canSupportDeflate() throws Exception {
+    assumeFalse("JaxRS client do not support deflate compression", false);
+  }
+
+  @Override
+  public void canExceptCaseInsensitiveHeader() throws Exception {
+    assumeFalse("JaxRS client do not support gzip compression", false);
+  }
+
   public interface JaxRSClientTestInterface {
 
     @RequestLine("GET /")

okhttp/src/test/java/feign/okhttp/OkHttpClientTest.java

@@ -14,6 +14,7 @@
 package feign.okhttp;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assume.assumeFalse;
 
 import feign.Feign;
 import feign.Feign.Builder;
@@ -103,6 +104,27 @@ public void testFollowRedirect() throws Exception {
     assertEquals(expectedBody, payload);
   }
 
+  /*
+   * OkHTTP does not support gzip and deflate compression out-of-the-box. But you can add an
+   * interceptor that implies it, see
+   * https://stackoverflow.com/questions/51901333/okhttp-3-how-to-decompress-gzip-deflate-response-
+   * manually-using-java-android
+   */
+  @Override
+  public void canSupportGzip() throws Exception {
+    assumeFalse("OkHTTP client do not support gzip compression", false);
+  }
+
+  @Override
+  public void canSupportDeflate() throws Exception {
+    assumeFalse("OkHTTP client do not support deflate compression", false);
+  }
+
+  @Override
+  public void canExceptCaseInsensitiveHeader() throws Exception {
+    assumeFalse("OkHTTP client do not support gzip compression", false);
+  }
+
   public interface OkHttpClientTestInterface {
 
     @RequestLine("GET /")