Merge pull request zalando#166 from zalando/feature/curl

Added curl request formatter

Author: whiskeysierra

README.md

@@ -247,6 +247,26 @@ a JSON response body will **not** be escaped and represented as a string:
 }
 ```
 
+##### cURL
+
+*cURL* is an alternative formatting style, provided by the `CurlHttpLogFormatter` which will render requests as 
+executable [`cURL`](https://curl.haxx.se/) commands. Unlike JSON, it is primarily designed for humans. 
+
+
+###### Request
+
+```bash
+curl -v -X GET 'http://localhost/test' -H 'Accept: application/json'
+```
+
+###### Response
+
+See [HTTP](#http) or provide own fallback for responses:
+
+```java
+new CurlHttpLogFormatter(new JsonHttpLogFormatter());
+```
+
 #### Writing
 
 Writing defines where formatted requests and responses are written to. Logbook comes with three implementations: 
@@ -385,7 +405,7 @@ The following tables show the available configuration:
 |--------------------------------|------------------------------------------------------------------|-------------------------------|
 | `logbook.exclude`              | Exclude certain URLs                                             | `[]`                          |
 | `logbook.filter.enabled`       | Enable the [`LogbookFilter(s)`](#servlet)                        | `true`                        |
-| `logbook.format.style`         | [Formatting style](#formatting) (`http` or `json`)               | `json`                        |
+| `logbook.format.style`         | [Formatting style](#formatting) (`http`, `json` or `curl`)       | `json`                        |
 | `logbook.obfuscate.headers`    | List of header names that need obfuscation                       | `[Authorization]`             |
 | `logbook.obfuscate.parameters` | List of parameter names that need obfuscation                    | `[access_token]`              |
 | `logbook.write.category`       | Changes the category of the [`DefaultHttpLogWriter`](#logger)    | `org.zalando.logbook.Logbook` |

logbook-core/src/main/java/org/zalando/logbook/CurlHttpLogFormatter.java

@@ -0,0 +1,67 @@
+package org.zalando.logbook;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.stream.Collectors.joining;
+
+/**
+ * Formats requests as cURL commands.
+ */
+public final class CurlHttpLogFormatter implements HttpLogFormatter {
+
+    private final HttpLogFormatter fallback;
+
+    public CurlHttpLogFormatter() {
+        this(new DefaultHttpLogFormatter());
+    }
+
+    public CurlHttpLogFormatter(final HttpLogFormatter fallback) {
+        this.fallback = fallback;
+    }
+
+    @Override
+    public String format(final Precorrelation<HttpRequest> precorrelation) throws IOException {
+        final HttpRequest request = precorrelation.getRequest();
+        final List<String> command = new ArrayList<>();
+
+        command.add("curl");
+        command.add("-v"); // TODO optional?
+
+        command.add("-X");
+        command.add(request.getMethod());
+
+        command.add(quote(request.getRequestUri()));
+
+        request.getHeaders().forEach((header, values) -> {
+            values.forEach(value -> {
+                command.add("-H");
+                command.add(quote(header + ": " + value));
+            });
+        });
+
+        final String body = request.getBodyAsString();
+
+        if (!body.isEmpty()) {
+            command.add("--data-binary");
+            command.add(quote(body));
+        }
+
+        return command.stream().collect(joining(" "));
+    }
+
+    private static String quote(final String s) {
+        return "'" + escape(s) + "'";
+    }
+
+    private static String escape(final String s) {
+        return s.replace("'", "\\'");
+    }
+
+    @Override
+    public String format(final Correlation<HttpRequest, HttpResponse> correlation) throws IOException {
+        return fallback.format(correlation);
+    }
+
+}

logbook-core/src/test/java/org/zalando/logbook/CurlHttpLogFormatterTest.java

@@ -0,0 +1,80 @@
+package org.zalando.logbook;
+
+import org.junit.Test;
+import org.zalando.logbook.DefaultLogbook.SimpleCorrelation;
+import org.zalando.logbook.DefaultLogbook.SimplePrecorrelation;
+
+import java.io.IOException;
+
+import static org.hamcrest.Matchers.is;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+
+public final class CurlHttpLogFormatterTest {
+
+    @Test
+    public void shouldLogRequest() throws IOException {
+        final String correlationId = "c9408eaa-677d-11e5-9457-10ddb1ee7671";
+        final HttpRequest request = MockHttpRequest.create()
+                .withProtocolVersion("HTTP/1.0")
+                .withOrigin(Origin.REMOTE)
+                .withPath("/test")
+                .withQuery("limit=1")
+                .withHeaders(MockHeaders.of(
+                        "Accept", "application/json",
+                        "Content-Type", "text/plain"))
+                .withBodyAsString("Hello, world!");
+
+        final HttpLogFormatter unit = new CurlHttpLogFormatter();
+        final String curl = unit.format(new SimplePrecorrelation<>(correlationId, request));
+
+        assertThat(curl, is("curl -v -X GET 'http://localhost/test?limit=1' -H 'Accept: application/json' -H 'Content-Type: text/plain' --data-binary 'Hello, world!'"));
+    }
+
+    @Test
+    public void shouldLogRequestWithoutBody() throws IOException {
+        final String correlationId = "0eae9f6c-6824-11e5-8b0a-10ddb1ee7671";
+        final HttpRequest request = MockHttpRequest.create()
+                .withPath("/test")
+                .withHeaders(MockHeaders.of("Accept", "application/json"));
+
+        final HttpLogFormatter unit = new CurlHttpLogFormatter();
+        final String curl = unit.format(new SimplePrecorrelation<>(correlationId, request));
+
+        assertThat(curl, is("curl -v -X GET 'http://localhost/test' -H 'Accept: application/json'"));
+    }
+
+    @Test
+    public void shouldEscape() throws IOException {
+        final String correlationId = "c9408eaa-677d-11e5-9457-10ddb1ee7671";
+        final HttpRequest request = MockHttpRequest.create()
+                .withProtocolVersion("HTTP/1.0")
+                .withOrigin(Origin.REMOTE)
+                .withPath("/test")
+                .withQuery("char='")
+                .withHeaders(MockHeaders.of(
+                        "Foo'Bar", "Baz"
+                ))
+                .withBodyAsString("{\"message\":\"Hello, 'world'!\"}");
+
+        final HttpLogFormatter unit = new CurlHttpLogFormatter();
+        final String curl = unit.format(new SimplePrecorrelation<>(correlationId, request));
+
+        assertThat(curl, is("curl -v -X GET 'http://localhost/test?char=\\'' -H 'Foo\\'Bar: Baz' --data-binary '{\"message\":\"Hello, \\'world\\'!\"}'"));
+    }
+
+    @Test
+    public void shouldDelegateLogResponse() throws IOException {
+        final HttpLogFormatter fallback = mock(HttpLogFormatter.class);
+        final HttpLogFormatter unit = new CurlHttpLogFormatter(fallback);
+
+        final Correlation<HttpRequest, HttpResponse> correlation = new SimpleCorrelation<>(
+                "3881ae92-6824-11e5-921b-10ddb1ee7671", MockHttpRequest.create(), MockHttpResponse.create());
+
+        unit.format(correlation);
+
+        verify(fallback).format(correlation);
+    }
+
+}

logbook-spring-boot-starter/src/main/java/org/zalando/logbook/spring/LogbookAutoConfiguration.java

@@ -24,6 +24,7 @@
 import org.zalando.logbook.BodyFilters;
 import org.zalando.logbook.ChunkingHttpLogWriter;
 import org.zalando.logbook.Conditions;
+import org.zalando.logbook.CurlHttpLogFormatter;
 import org.zalando.logbook.DefaultHttpLogFormatter;
 import org.zalando.logbook.DefaultHttpLogWriter;
 import org.zalando.logbook.DefaultHttpLogWriter.Level;
@@ -175,6 +176,13 @@ public HttpLogFormatter httpFormatter() {
         return new DefaultHttpLogFormatter();
     }
 
+    @Bean
+    @ConditionalOnMissingBean(HttpLogFormatter.class)
+    @ConditionalOnProperty(name = "logbook.format.style", havingValue = "curl")
+    public HttpLogFormatter curlFormatter() {
+        return new CurlHttpLogFormatter();
+    }
+
     @Bean
     @ConditionalOnBean(ObjectMapper.class)
     @ConditionalOnMissingBean(HttpLogFormatter.class)

logbook-spring-boot-starter/src/test/java/org/zalando/logbook/spring/FormatStyleCurlTest.java

@@ -0,0 +1,61 @@
+package org.zalando.logbook.spring;
+
+import org.hamcrest.Matcher;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.zalando.logbook.HttpLogWriter;
+import org.zalando.logbook.Logbook;
+import org.zalando.logbook.MockRawHttpRequest;
+import org.zalando.logbook.Precorrelation;
+
+import java.io.IOException;
+import java.util.function.Function;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.is;
+import static org.hobsoft.hamcrest.compose.ComposeMatchers.hasFeature;
+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 static org.mockito.hamcrest.MockitoHamcrest.argThat;
+
+@SpringBootTest(
+        classes = {Application.class, FormatStyleCurlTest.TestConfiguration.class},
+        properties = "logbook.format.style = curl")
+public final class FormatStyleCurlTest extends AbstractTest {
+
+    @Configuration
+    public static class TestConfiguration {
+
+        @Bean
+        public HttpLogWriter writer() throws IOException {
+            final HttpLogWriter writer = mock(HttpLogWriter.class);
+            when(writer.isActive(any())).thenReturn(true);
+            return writer;
+        }
+
+    }
+
+    @Autowired
+    private Logbook logbook;
+
+    @Autowired
+    private HttpLogWriter writer;
+
+    @Test
+    public void shouldUseHttpFormatter() throws IOException {
+        logbook.write(MockRawHttpRequest.create());
+
+        verify(writer).writeRequest(argThat(isCurlFormatter()));
+    }
+
+    private Matcher<Precorrelation<String>> isCurlFormatter() {
+        final Function<Precorrelation<String>, String> getRequest = Precorrelation::getRequest;
+        return hasFeature("request", getRequest, is("curl -v -X GET 'http://localhost/'"));
+    }
+
+}