Merge pull request #136 from browserup/issue-131-har-default-values

dpowell · web-flow · commit a88a28b5802a · 2019-07-26T16:17:52.000-04:00
Issue-131 har default values
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarContent.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarContent.java
@@ -13,10 +13,10 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarContent {
 
-    private Long size;
+    private Long size = 0L;
     private Long compression;
-    private String mimeType;
-    private String text;
+    private String mimeType = "";
+    private String text = "";
     private String encoding;
     private String comment;
 
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarCookie.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarCookie.java
@@ -15,8 +15,8 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarCookie {
 
-    private String name;
-    private String value;
+    private String name = "";
+    private String value = "";
     private String path;
     private String domain;
     private Date expires;
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarCreatorBrowser.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarCreatorBrowser.java
@@ -13,8 +13,8 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarCreatorBrowser {
 
-    private String name;
-    private String version;
+    private String name = "";
+    private String version = "";
     private String comment;
 
     /**
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarEntry.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarEntry.java
@@ -20,8 +20,8 @@
 public class HarEntry {
 
     private String pageref;
-    private Date startedDateTime;
-    private Integer time;
+    private Date startedDateTime = new Date();
+    private Integer time = 0;
     private HarRequest request;
     private HarResponse response;
     private HarCache cache;
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarLog.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarLog.java
@@ -63,9 +63,6 @@ public void setCreator(HarCreatorBrowser creator) {
      * @return Information about the browser used.
      */
     public HarCreatorBrowser getBrowser() {
-        if (browser == null) {
-            browser = new HarCreatorBrowser();
-        }
         return browser;
     }
 
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPage.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPage.java
@@ -19,9 +19,9 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarPage {
 
-    private Date startedDateTime;
-    private String id;
-    private String title;
+    private Date startedDateTime = new Date();
+    private String id = "";
+    private String title = "";
     private HarPageTiming pageTimings;
     private String comment;
     private Map<String, Object> additional = new HashMap<>();
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPostData.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPostData.java
@@ -15,9 +15,9 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarPostData {
 
-    private String mimeType;
+    private String mimeType = "";
     private List<HarPostDataParam> params = new ArrayList<>();
-    private String text;
+    private String text = "";
     private String comment;
 
     /**
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPostDataParam.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarPostDataParam.java
@@ -13,7 +13,7 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class HarPostDataParam {
 
-    private String name;
+    private String name = "";
     private String value;
     private String fileName;
     private String contentType;
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarRequest.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarRequest.java
@@ -21,9 +21,9 @@ public class HarRequest {
 
     protected static final Long DEFAULT_SIZE = -1L;
 
-    private HttpMethod method;
-    private String url;
-    private String httpVersion;
+    private HttpMethod method = HttpMethod.GET;
+    private String url = "";
+    private String httpVersion = "HTTP/1.1";
     private List<HarCookie> cookies;
     private List<HarHeader> headers;
     private List<HarQueryParam> queryString;
diff --git a/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarResponse.java b/browserup-proxy-core/src/main/java/com/browserup/harreader/model/HarResponse.java
@@ -18,12 +18,12 @@ public class HarResponse {
     protected static final Long DEFAULT_SIZE = -1L;
 
     private HttpStatus status;
-    private String statusText;
-    private String httpVersion;
+    private String statusText = "";
+    private String httpVersion = "HTTP/1.1";
     private List<HarCookie> cookies;
     private List<HarHeader> headers;
     private HarContent content;
-    private String redirectURL;
+    private String redirectURL = "";
     private Long headersSize;
     private Long bodySize;
     private String comment;
diff --git a/browserup-proxy-core/src/test/groovy/com/browserup/bup/proxy/HarValidationTest.groovy b/browserup-proxy-core/src/test/groovy/com/browserup/bup/proxy/HarValidationTest.groovy
@@ -0,0 +1,202 @@
+/*
+ * Modifications Copyright (c) 2019 BrowserUp, Inc.
+ */
+
+package com.browserup.bup.proxy
+
+import com.browserup.bup.BrowserUpProxy
+import com.browserup.bup.BrowserUpProxyServer
+import com.browserup.bup.filters.util.HarCaptureUtil
+import com.browserup.bup.proxy.dns.AdvancedHostResolver
+import com.browserup.bup.proxy.test.util.MockServerTest
+import com.browserup.bup.proxy.test.util.NewProxyServerTestUtil
+import com.browserup.harreader.model.*
+import com.github.tomakehurst.wiremock.client.WireMock
+import com.google.common.collect.Iterables
+import org.apache.http.client.config.RequestConfig
+import org.apache.http.client.methods.CloseableHttpResponse
+import org.apache.http.client.methods.HttpGet
+import org.hamcrest.Matcher
+import org.hamcrest.core.Every
+import org.junit.After
+import org.junit.Test
+import org.mockito.invocation.InvocationOnMock
+import org.mockito.stubbing.Answer
+
+import java.text.SimpleDateFormat
+import java.util.concurrent.TimeUnit
+
+import static com.github.tomakehurst.wiremock.client.WireMock.*
+import static org.hamcrest.Matchers.*
+import static org.junit.Assert.*
+import static org.mockito.Mockito.mock
+import static org.mockito.Mockito.when
+
+class HarValidationTest extends MockServerTest {
+    private BrowserUpProxy proxy
+
+    @After
+    void tearDown() {
+        if (proxy?.started) {
+            proxy.abort()
+        }
+    }
+
+    @Test
+    void testDefaultValuesOfMockedHarResponse() {
+        def stubUrl = "/testUrl.*"
+        stubFor(get(urlMatching(stubUrl)).willReturn(ok()))
+
+        proxy = new BrowserUpProxyServer()
+        proxy.start()
+
+        proxy.newHar()
+
+        def requestUrl = "http://localhost:${mockServerPort}/testUrl"
+
+        NewProxyServerTestUtil.getNewHttpClient(proxy.port).withCloseable {
+            NewProxyServerTestUtil.toStringAndClose(it.execute(new HttpGet(requestUrl)).getEntity().getContent())
+        }
+
+        Thread.sleep(500)
+        def har = proxy.getHar()
+
+        assertNotNull("Expected not null log creator name", har.log.creator.name)
+        assertNotNull("Expected not null log creator version", har.log.creator.version)
+
+        har.log.pages.each {
+            assertNotNull("Expected not null har log pages id", it.id)
+            assertNotNull("Expected not null har log pages title", it.title)
+            assertNotNull("Expected not null har log pages startedDateTime", it.startedDateTime)
+            assertNotNull("Expected not null har log pages pageTimings", it.pageTimings)
+        }
+
+        har.log.entries.each {
+            assertNotNull("Expected not null har entries startedDateTime", it.startedDateTime)
+            assertNotNull("Expected not null har entries time", it.time)
+            assertNotNull("Expected not null har entries request", it.request)
+            assertNotNull("Expected not null har entries response", it.response)
+            assertNotNull("Expected not null har entries cache", it.cache)
+            assertNotNull("Expected not null har entries timings", it.timings)
+
+            assertNotNull("Expected not null har entries requests method", it.request.method)
+            assertNotNull("Expected not null har entries requests url", it.request.url)
+            assertNotNull("Expected not null har entries requests httpVersion", it.request.httpVersion)
+            assertNotNull("Expected not null har entries requests cookies", it.request.cookies)
+            assertNotNull("Expected not null har entries requests headers", it.request.headers)
+            assertNotNull("Expected not null har entries requests queryString", it.request.queryString)
+            assertNotNull("Expected not null har entries requests headersSize", it.request.headersSize)
+            assertNotNull("Expected not null har entries requests bodySize", it.request.bodySize)
+
+            assertNotNull("Expected not null har entries responses status", it.response.status)
+            assertNotNull("Expected not null har entries responses statusText", it.response.statusText)
+            assertNotNull("Expected not null har entries responses httpVersion", it.response.httpVersion)
+            assertNotNull("Expected not null har entries responses cookies", it.response.cookies)
+            assertNotNull("Expected not null har entries responses content", it.response.content)
+            assertNotNull("Expected not null har entries responses redirectURL", it.response.redirectURL)
+            assertNotNull("Expected not null har entries responses headersSize", it.response.headersSize)
+            assertNotNull("Expected not null har entries responses bodySize", it.response.bodySize)
+
+            it.response.cookies.each { cookie ->
+                assertNotNull("Expected not null har entries responses cookies name", cookie.name)
+                assertNotNull("Expected not null har entries responses cookies value", cookie.value)
+            }
+
+            assertNotNull("Expected not null har entries requests postData mimeType", it.request.postData.mimeType)
+            assertNotNull("Expected not null har entries requests postData params", it.request.postData.params)
+            assertNotNull("Expected not null har entries requests postData text", it.request.postData.text)
+
+            it.request.postData.params.each { param ->
+                assertNotNull("Expected not null har entries requests postData params name", param.name)
+            }
+
+            assertNotNull("Expected not null har entries responses content size", it.response.content.size)
+            assertNotNull("Expected not null har entries responses content mimeType", it.response.content.mimeType)
+            assertNotNull("Expected not null har entries responses content text", it.response.content.text)
+
+            assertNotNull("Expected not null har entries timings send", it.timings.send)
+            assertNotNull("Expected not null har entries timings wait", it.timings.wait)
+            assertNotNull("Expected not null har entries timings receive", it.timings.receive)
+        }
+        verify(1, getRequestedFor(urlMatching(stubUrl)))
+    }
+
+    @Test
+    void testDefaultValuesOfDefaultHar() {
+        def har = new Har()
+        def harLog = new HarLog()
+        def harPage = new HarPage()
+        def harEntry = new HarEntry()
+        def harResponse = new HarResponse()
+        def harRequest = new HarRequest()
+        def harPostData = new HarPostData()
+        harPostData.params = Collections.singletonList(new HarPostDataParam())
+
+        harResponse.cookies = Collections.singletonList(new HarCookie())
+        harRequest.postData = harPostData
+        harEntry.request = harRequest
+        harEntry.response = harResponse
+        harLog.creator = new HarCreatorBrowser()
+        harLog.pages = Collections.singletonList(harPage)
+        harLog.entries = Collections.singletonList(harEntry)
+        har.log = harLog
+
+        assertNotNull("Expected not null log creator name", har.log.creator.name)
+        assertNotNull("Expected not null log creator version", har.log.creator.version)
+
+        har.log.pages.each {
+            assertNotNull("Expected not null har log pages id", it.id)
+            assertNotNull("Expected not null har log pages title", it.title)
+            assertNotNull("Expected not null har log pages startedDateTime", it.startedDateTime)
+            assertNotNull("Expected not null har log pages pageTimings", it.pageTimings)
+        }
+
+        har.log.entries.each {
+            assertNotNull("Expected not null har entries startedDateTime", it.startedDateTime)
+            assertNotNull("Expected not null har entries time", it.time)
+            assertNotNull("Expected not null har entries request", it.request)
+            assertNotNull("Expected not null har entries response", it.response)
+            assertNotNull("Expected not null har entries cache", it.cache)
+            assertNotNull("Expected not null har entries timings", it.timings)
+
+            assertNotNull("Expected not null har entries requests method", it.request.method)
+            assertNotNull("Expected not null har entries requests url", it.request.url)
+            assertNotNull("Expected not null har entries requests httpVersion", it.request.httpVersion)
+            assertNotNull("Expected not null har entries requests cookies", it.request.cookies)
+            assertNotNull("Expected not null har entries requests headers", it.request.headers)
+            assertNotNull("Expected not null har entries requests queryString", it.request.queryString)
+            assertNotNull("Expected not null har entries requests headersSize", it.request.headersSize)
+            assertNotNull("Expected not null har entries requests bodySize", it.request.bodySize)
+
+            assertNotNull("Expected not null har entries responses status", it.response.status)
+            assertNotNull("Expected not null har entries responses statusText", it.response.statusText)
+            assertNotNull("Expected not null har entries responses httpVersion", it.response.httpVersion)
+            assertNotNull("Expected not null har entries responses cookies", it.response.cookies)
+            assertNotNull("Expected not null har entries responses content", it.response.content)
+            assertNotNull("Expected not null har entries responses redirectURL", it.response.redirectURL)
+            assertNotNull("Expected not null har entries responses headersSize", it.response.headersSize)
+            assertNotNull("Expected not null har entries responses bodySize", it.response.bodySize)
+
+            it.response.cookies.each { cookie ->
+                assertNotNull("Expected not null har entries responses cookies name", cookie.name)
+                assertNotNull("Expected not null har entries responses cookies value", cookie.value)
+            }
+
+            assertNotNull("Expected not null har entries requests postData mimeType", it.request.postData.mimeType)
+            assertNotNull("Expected not null har entries requests postData params", it.request.postData.params)
+            assertNotNull("Expected not null har entries requests postData text", it.request.postData.text)
+
+            it.request.postData.params.each { param ->
+                assertNotNull("Expected not null har entries requests postData params name", param.name)
+            }
+
+            assertNotNull("Expected not null har entries responses content size", it.response.content.size)
+            assertNotNull("Expected not null har entries responses content mimeType", it.response.content.mimeType)
+            assertNotNull("Expected not null har entries responses content text", it.response.content.text)
+
+            assertNotNull("Expected not null har entries timings send", it.timings.send)
+            assertNotNull("Expected not null har entries timings wait", it.timings.wait)
+            assertNotNull("Expected not null har entries timings receive", it.timings.receive)
+        }
+    }
+}
diff --git a/browserup-proxy-core/src/test/groovy/com/browserup/bup/proxy/NewHarTest.groovy b/browserup-proxy-core/src/test/groovy/com/browserup/bup/proxy/NewHarTest.groovy
@@ -262,7 +262,7 @@ class NewHarTest extends MockServerTest {
 
         assertEquals("Expected to capture response mimeType in HAR", responseContentType, content.mimeType)
 
-        assertNull("Expected to not capture body content in HAR", content.text)
+        assertEquals("Expected to not capture body content in HAR", "", content.text)
 
         verify(1, getRequestedFor(urlEqualTo(stubUrl)))
     }
diff --git a/browserup-proxy-core/src/test/java/com/browserup/harreader/model/HarLogTest.java b/browserup-proxy-core/src/test/java/com/browserup/harreader/model/HarLogTest.java
@@ -63,7 +63,7 @@ public void testCreatorNull() {
     public void testBrowserNull() {
         HarLog log = new HarLog();
         log.setBrowser(null);
-        Assert.assertNotNull(log.getBrowser());
+        Assert.assertNull(log.getBrowser());
     }
 
     @Test
diff --git a/browserup-proxy-dist/src/main/resources/bup-logging.yaml b/browserup-proxy-dist/src/main/resources/bup-logging.yaml
diff --git a/browserup-proxy-rest/src/test/groovy/com/browserup/bup/proxy/rest/FindMostRecentEntryRestTest.groovy b/browserup-proxy-rest/src/test/groovy/com/browserup/bup/proxy/rest/FindMostRecentEntryRestTest.groovy
@@ -18,6 +18,7 @@ import org.junit.Test
 
 import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor
 import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo
+import static org.junit.Assert.assertEquals
 import static org.junit.Assert.assertNotNull
 import static org.junit.Assert.assertNull
 import static org.junit.Assert.assertThat
@@ -96,7 +97,7 @@ class FindMostRecentEntryRestTest extends BaseRestTest {
             uri.query = [urlPattern: urlPatternNotToMatchUrl]
             response.success = { HttpResponseDecorator resp ->
                 def actualEntry = new ObjectMapper().readValue(resp.entity.content, HarEntry) as HarEntry
-                assertNull('Expected to find empty entry', actualEntry.startedDateTime)
+                assertEquals('Expected to find empty entry', "", actualEntry.request.url)
             }
         }
 
diff --git a/browserup-proxy-rest/src/test/groovy/com/browserup/bup/proxy/rest/ValidateHarRestTest.groovy b/browserup-proxy-rest/src/test/groovy/com/browserup/bup/proxy/rest/ValidateHarRestTest.groovy

Original file line number	Diff line number	Diff line change
`@@ -63,9 +63,6 @@ public void setCreator(HarCreatorBrowser creator) {`
`63`	`63`	`* @return Information about the browser used.`
`64`	`64`	`*/`
`65`	`65`	`public HarCreatorBrowser getBrowser() {`
`66`		`- if (browser == null) {`
`67`		`- browser = new HarCreatorBrowser();`
`68`		`- }`
`69`	`66`	`return browser;`
`70`	`67`	`}`
`71`	`68`