-
Notifications
You must be signed in to change notification settings - Fork 260
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Httpclient gzipped response handling (#1505)
* Correct logging of gziped responses * README modified * Improvements in gzip header recognition * Fixed coverage * Rollback 'javax.' deletion * Added 'logbook.httpclient.decompress-response' flag * Formatting * Formatting * Formatting --------- Co-authored-by: Luis Costela <luis.costela@pyxis.com.uy>
- Loading branch information
1 parent
acb012d
commit ab26376
Showing
11 changed files
with
214 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
...pclient/src/test/java/org/zalando/logbook/httpclient/LogbookHttpInterceptorsGzipTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| package org.zalando.logbook.httpclient; | ||
|
|
||
| import static com.github.restdriver.clientdriver.ClientDriverRequest.Method.GET; | ||
| import static com.github.restdriver.clientdriver.ClientDriverRequest.Method.POST; | ||
| import static com.github.restdriver.clientdriver.RestClientDriver.giveEmptyResponse; | ||
| import static com.github.restdriver.clientdriver.RestClientDriver.giveResponse; | ||
| import static com.github.restdriver.clientdriver.RestClientDriver.giveResponseAsBytes; | ||
| import static com.github.restdriver.clientdriver.RestClientDriver.onRequestTo; | ||
| import static org.apache.http.HttpHeaders.CONTENT_ENCODING; | ||
| import static org.apache.http.HttpHeaders.CONTENT_TYPE; | ||
| import static org.apache.http.entity.ContentType.TEXT_PLAIN; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.verify; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.zip.GZIPOutputStream; | ||
| import javax.annotation.Nullable; | ||
| import org.apache.http.HttpResponse; | ||
| import org.apache.http.client.methods.CloseableHttpResponse; | ||
| import org.apache.http.client.methods.HttpGet; | ||
| import org.apache.http.client.methods.HttpPost; | ||
| import org.apache.http.entity.StringEntity; | ||
| import org.apache.http.impl.client.CloseableHttpClient; | ||
| import org.apache.http.impl.client.HttpClientBuilder; | ||
| import org.apache.http.util.EntityUtils; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.zalando.logbook.Correlation; | ||
| import org.zalando.logbook.Logbook; | ||
| import org.zalando.logbook.core.DefaultHttpLogFormatter; | ||
| import org.zalando.logbook.core.DefaultSink; | ||
| import org.zalando.logbook.test.TestStrategy; | ||
|
|
||
| public final class LogbookHttpInterceptorsGzipTest extends AbstractHttpTest { | ||
|
|
||
| private final Logbook logbook = Logbook.builder() | ||
| .strategy(new TestStrategy()) | ||
| .sink(new DefaultSink(new DefaultHttpLogFormatter(), writer)) | ||
| .build(); | ||
|
|
||
| private final CloseableHttpClient client = HttpClientBuilder.create() | ||
| .addInterceptorFirst(new LogbookHttpRequestInterceptor(logbook)) | ||
| .addInterceptorFirst(new LogbookHttpResponseInterceptor(true)) | ||
| .build(); | ||
|
|
||
| @AfterEach | ||
| void stop() throws IOException { | ||
| client.close(); | ||
| } | ||
|
|
||
| @Override | ||
| protected HttpResponse sendAndReceive(@Nullable final String body) throws IOException { | ||
| return sendAndReceiveWithGzipEncoding(body, "gzip"); | ||
| } | ||
|
|
||
| private CloseableHttpResponse sendAndReceiveWithGzipEncoding(String body, String encoding) throws IOException { | ||
| driver.reset(); | ||
| if (body == null) { | ||
| driver.addExpectation(onRequestTo("/").withMethod(GET), giveEmptyResponse()); | ||
| } else { | ||
| ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); | ||
| try (GZIPOutputStream gzipOutputStream = new GZIPOutputStream(outputStream)) { | ||
| gzipOutputStream.write(body.getBytes(StandardCharsets.UTF_8)); | ||
| } | ||
|
|
||
| byte[] compressedBytes = outputStream.toByteArray(); | ||
| driver.addExpectation(onRequestTo("/").withMethod(POST), | ||
| giveResponseAsBytes(new ByteArrayInputStream(compressedBytes), "text/plain").withHeader(CONTENT_ENCODING, encoding)); | ||
| } | ||
| if (body == null) { | ||
| return client.execute(new HttpGet(driver.getBaseUrl())); | ||
| } else { | ||
| final HttpPost post = new HttpPost(driver.getBaseUrl()); | ||
| post.setEntity(new StringEntity(body)); | ||
| post.setHeader(CONTENT_TYPE, TEXT_PLAIN.toString()); | ||
|
|
||
| return client.execute(post); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogResponseWithBodyGzipHeaderVariant1() throws IOException, ExecutionException, InterruptedException { | ||
| extracted("GziP"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogResponseWithBodyGzipHeaderVariant2() throws IOException, ExecutionException, InterruptedException { | ||
| extracted("GZIP"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogResponseWithBodyGzipHeaderVariant3() throws IOException, ExecutionException, InterruptedException { | ||
| extracted("x-gzip"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogResponseWithBodyGzipHeaderVariant4() throws IOException, ExecutionException, InterruptedException { | ||
| extracted("X-GZIP"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogResponseWithBodyGzipHeaderVariant5() throws IOException, ExecutionException, InterruptedException { | ||
| extracted("x-GziP"); | ||
| } | ||
|
|
||
| private void extracted(String encoding) throws IOException { | ||
| driver.addExpectation(onRequestTo("/").withMethod(POST), | ||
| giveResponse("Hello, world!", "text/plain")); | ||
|
|
||
| final HttpResponse response = sendAndReceiveWithGzipEncoding("Hello, world!", encoding); | ||
|
|
||
| assertThat(response.getStatusLine().getStatusCode()).isEqualTo(200); | ||
| assertThat(EntityUtils.toString(response.getEntity())).isEqualTo("Hello, world!"); | ||
|
|
||
| final String message = captureResponse(); | ||
|
|
||
| assertThat(message) | ||
| .startsWith("Incoming Response:") | ||
| .contains("HTTP/1.1 200 OK", "Content-Type: text/plain", "Hello, world!"); | ||
| } | ||
|
|
||
| private String captureResponse() throws IOException { | ||
| final ArgumentCaptor<String> captor = ArgumentCaptor.forClass(String.class); | ||
| verify(writer).write(any(Correlation.class), captor.capture()); | ||
| return captor.getValue(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.