replace binary content inside a report with placeholder text (#82)

Author: MykolaGolubyev

webtau-http-groovy/src/test/groovy/com/twosigma/webtau/http/HttpTest.groovy

@@ -324,16 +324,32 @@ class HttpTest implements HttpConfiguration {
             body.should == null
         }
 
-        http.doc.capture('empty')
+        def artifactName = 'empty'
+        http.doc.capture(artifactName)
 
-        Path docRoot = DocumentationArtifactsLocation.resolve('empty')
+        Path docRoot = DocumentationArtifactsLocation.resolve(artifactName)
         Path requestFile = docRoot.resolve("request.json")
         assertFalse(Files.exists(requestFile))
 
         Path responseFile = docRoot.resolve("response.json")
         assertFalse(Files.exists(responseFile))
     }
 
+    @Test
+    void "no files generated for binary request"() {
+        def content = [1, 2, 3] as byte[]
+        http.post("/empty", content) {
+            body.should == null
+        }
+
+        def artifactName = 'empty-binary'
+        http.doc.capture(artifactName)
+
+        Path docRoot = DocumentationArtifactsLocation.resolve(artifactName)
+        Path requestFile = docRoot.resolve("request.data")
+        assertFalse(Files.exists(requestFile))
+    }
+
     @Test
     void "no validation request"() {
         def counter = [:].withDefault { 0 }

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

@@ -34,6 +34,8 @@
 import java.util.stream.Collectors;
 
 public class HttpValidationResult implements TestStepPayload {
+    private static final String BINARY_CONTENT_PLACEHOLDER = "[binary content]";
+
     private final String fullUrl;
     private final String requestMethod;
     private HttpRequestHeader requestHeader;
@@ -176,15 +178,15 @@ public long getElapsedTime() {
         result.put("errorMessage", errorMessage);
         result.put("mismatches", mismatches);
 
+        if (requestBody != null) {
+            result.put("requestType", requestBody.type());
+            result.put("requestBody", requestBody.isBinary() ? BINARY_CONTENT_PLACEHOLDER : requestBody.asString());
+        }
+
         if (response != null) {
             result.put("responseType", response.getContentType());
             result.put("responseStatusCode", response.getStatusCode());
-            result.put("responseBody", response.getTextContent());
-        }
-
-        if (requestBody != null) {
-            result.put("requestType", requestBody.type());
-            result.put("requestBody", requestBody.asString());
+            result.put("responseBody", response.isBinary() ? BINARY_CONTENT_PLACEHOLDER : response.getTextContent());
         }
 
         if (responseBodyNode != null) {

webtau-http/src/test/groovy/com/twosigma/webtau/http/HttpValidationResultTest.groovy

@@ -17,8 +17,11 @@
 package com.twosigma.webtau.http
 
 import com.twosigma.webtau.data.traceable.CheckLevel
+import com.twosigma.webtau.data.traceable.TraceableValue
+import com.twosigma.webtau.http.binary.BinaryRequestBody
 import com.twosigma.webtau.http.datanode.DataNodeBuilder
 import com.twosigma.webtau.http.datanode.DataNodeId
+import com.twosigma.webtau.http.datanode.StructuredDataNode
 import com.twosigma.webtau.http.validation.HeaderDataNode
 import com.twosigma.webtau.http.validation.HttpValidationResult
 import com.twosigma.webtau.utils.JsonUtils
@@ -50,4 +53,30 @@ class HttpValidationResultTest {
                                                elapsedTime: 100,
                                                responseBodyChecks: [failedPaths: ['root.childA'], passedPaths:['root.childB']]])
     }
+
+    @Test
+    void "should replace binary content with placeholder"() {
+        def binaryContent = [1, 2, 3] as byte[]
+        def binaryNode = new StructuredDataNode(new DataNodeId('body'), new TraceableValue(binaryContent))
+
+        def validationResult = new HttpValidationResult('POST', 'http://site/test/url', null,
+                BinaryRequestBody.octetStream(binaryContent))
+
+        validationResult.setResponse(new HttpResponse(binaryContent: binaryContent, contentType: 'application/octet-stream', statusCode: 200))
+        validationResult.setElapsedTime(100)
+        validationResult.setResponseHeaderNode(new HeaderDataNode())
+        validationResult.setResponseBodyNode(binaryNode)
+
+        println validationResult.toMap()
+        validationResult.toMap().should equal([method: 'POST', url: 'http://site/test/url',
+                                               requestType: 'application/octet-stream',
+                                               requestBody: '[binary content]',
+                                               responseType: 'application/octet-stream',
+                                               responseBody: '[binary content]',
+                                               mismatches: [],
+                                               errorMessage: null,
+                                               responseStatusCode: 200,
+                                               elapsedTime: 100,
+                                               responseBodyChecks: [failedPaths: [], passedPaths: []]])
+    }
 }