http doc captures binary responses

Author: MykolaGolubyev

webtau-http/src/main/java/com/twosigma/webtau/http/Http.java

@@ -467,7 +467,7 @@ private Integer defaultExpectedStatusCodeByRequest(HttpValidationResult validati
                 return 201;
             case "PUT":
             case "DELETE":
-                return validationResult.hasContent() ? 200 : 204;
+                return validationResult.hasResponseContent() ? 200 : 204;
             default:
                 return 200;
         }

webtau-http/src/main/java/com/twosigma/webtau/http/HttpDocumentation.java

@@ -25,55 +25,95 @@
 
 public class HttpDocumentation {
     public void capture(String artifactName) {
-        Path path = DocumentationArtifactsLocation.resolve(artifactName);
+        Capture capture = new Capture(artifactName);
+        capture.capture();
+    }
+
+    private static class Capture {
+        private final Path path;
+        private final HttpValidationResult lastValidationResult;
+
+        public Capture(String artifactName) {
+            this.path = DocumentationArtifactsLocation.resolve(artifactName);
 
-        HttpValidationResult lastValidationResult = Http.http.getLastValidationResult();
-        if (lastValidationResult == null) {
-            throw new IllegalStateException("no http calls were made yet");
+            this.lastValidationResult = Http.http.getLastValidationResult();
+            if (this.lastValidationResult == null) {
+                throw new IllegalStateException("no http calls were made yet");
+            }
         }
 
-        String requestHeader = lastValidationResult.getRequestHeader().toString();
-        if (! requestHeader.isEmpty()) {
-            FileUtils.writeTextContent(path.resolve("request.header.txt"),
-                    requestHeader);
+        public void capture() {
+            captureRequestHeader();
+            captureRequestBody();
+            captureResponseBody();
+            capturePaths();
         }
 
-        if (lastValidationResult.getRequestType() != null
-                && !lastValidationResult.isRequestBinary()
-                && lastValidationResult.notNullOrEmptyRequestContent()) {
+        private void captureRequestHeader() {
+            String requestHeader = lastValidationResult.getRequestHeader().toString();
+            if (! requestHeader.isEmpty()) {
+                FileUtils.writeTextContent(path.resolve("request.header.txt"),
+                        requestHeader);
+            }
+        }
+
+        private void captureRequestBody() {
+            if (lastValidationResult.getRequestType() == null
+                    || lastValidationResult.isRequestBinary()
+                    || lastValidationResult.nullOrEmptyRequestContent()) {
+                return;
+            }
+
             String fileName = "request." + fileExtensionForType(lastValidationResult.getRequestType());
             FileUtils.writeTextContent(path.resolve(fileName),
                     prettyPrintContent(lastValidationResult.getRequestType(),
                             lastValidationResult.getRequestContent()));
         }
 
-        if (lastValidationResult.getResponseType() != null
-                && lastValidationResult.notNullOrEmptyResponseTextContent()) {
+        private void captureResponseBody() {
+            if (lastValidationResult.getResponseType() == null || !lastValidationResult.hasResponseContent()) {
+                return;
+            }
+
             String fileName = "response." + fileExtensionForType(lastValidationResult.getResponseType());
-            FileUtils.writeTextContent(path.resolve(fileName),
-                    prettyPrintContent(lastValidationResult.getResponseType(),
-                            lastValidationResult.getResponseTextContent()));
+            Path fullPath = path.resolve(fileName);
+
+            if (lastValidationResult.getResponse().isBinary()) {
+                FileUtils.writeBinaryContent(fullPath, lastValidationResult.getResponse().getBinaryContent());
+            } else {
+                FileUtils.writeTextContent(fullPath,
+                        prettyPrintContent(lastValidationResult.getResponseType(),
+                                lastValidationResult.getResponseTextContent()));
+            }
         }
 
-        if (lastValidationResult.getPassedPaths() != null) {
+        private void capturePaths() {
+            if (lastValidationResult.getPassedPaths() == null) {
+                return;
+            }
+
             FileUtils.writeTextContent(path.resolve("paths.json"),
                     JsonUtils.serialize(lastValidationResult.getPassedPaths()));
         }
     }
 
-    private String fileExtensionForType(String type) {
+    private static String fileExtensionForType(String type) {
+        if (type.contains("/pdf")) {
+            return "pdf";
+        }
+
         return isJson(type) ? "json" : "data";
     }
 
-    private String prettyPrintContent(String type, String content) {
+    private static String prettyPrintContent(String type, String content) {
         if (isJson(type)) {
             return JsonUtils.serializePrettyPrint(JsonUtils.deserialize(content));
         }
 
         return content;
     }
 
-    private boolean isJson(String type) {
+    private static boolean isJson(String type) {
         return type.contains("json");
     }
 }

webtau-http/src/main/java/com/twosigma/webtau/http/HttpResponse.java

@@ -73,6 +73,10 @@ public boolean isText() {
         return contentType.startsWith("text/");
     }
 
+    public boolean isPdf() {
+        return contentType.contains("/pdf");
+    }
+
     public boolean isBinary() {
         return !isJson() && !isXml() && !isText() && !contentType.isEmpty();
     }

webtau-http/src/main/java/com/twosigma/webtau/http/validation/HttpValidationResult.java

@@ -106,19 +106,15 @@ public String getRequestContent() {
         return requestBody != null ? requestBody.asString() : null;
     }
 
-    public boolean notNullOrEmptyRequestContent() {
-        return StringUtils.notNullOrEmpty(getRequestContent());
+    public boolean nullOrEmptyRequestContent() {
+        return StringUtils.nullOrEmpty(getRequestContent());
     }
 
     public String getResponseTextContent() {
         return response.getTextContent();
     }
 
-    public boolean notNullOrEmptyResponseTextContent() {
-        return StringUtils.notNullOrEmpty(response.getTextContent());
-    }
-
-    public boolean hasContent() {
+    public boolean hasResponseContent() {
         return response.hasContent();
     }
 

webtau-utils/src/main/java/com/twosigma/webtau/utils/FileUtils.java

@@ -29,13 +29,13 @@ private FileUtils() {
     }
 
     public static void writeTextContent(Path path, String text) {
-        try {
-            Path parent = path.toAbsolutePath().getParent();
-            if (parent != null) {
-                Files.createDirectories(parent);
-            }
+        writeBinaryContent(path, text.getBytes());
+    }
 
-            Files.write(path, text.getBytes());
+    public static void writeBinaryContent(Path path, byte[] content) {
+        try {
+            createDirs(path);
+            Files.write(path, content);
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
@@ -72,4 +72,11 @@ public static Path existingPathOrThrow(Path... paths) {
                 new RuntimeException("can't find any of the following files:\n" +
                         nonNull.stream().map(Path::toString).collect(Collectors.joining("\n"))));
     }
+
+    private static void createDirs(Path path) throws IOException {
+        Path parent = path.toAbsolutePath().getParent();
+        if (parent != null) {
+            Files.createDirectories(parent);
+        }
+    }
 }