Added rewrite rules tests and updated documentation

browsermob-core/src/main/java/net/lightbody/bmp/BrowserMobProxy.java

@@ -339,7 +339,7 @@ public interface BrowserMobProxy {
      * <p/>
      * For example, the following rewrite rule:
      *
-     * <pre>   {@code proxy.rewriteUrl("http://www\.(yahoo|bing)\.com\?(\w+)=(\w+)", "http://www.google.com?originalDomain=$1&$2=$3");}</pre>
+     * <pre>   {@code proxy.rewriteUrl("http://www\\.(yahoo|bing)\\.com/\\?(\\w+)=(\\w+)", "http://www.google.com/?originalDomain=$1&$2=$3");}</pre>
      *
      * will match an HTTP request (but <i>not</i> HTTPS!) to www.yahoo.com or www.bing.com with exactly 1 query parameter,
      * and replace it with a call to www.google.com with an 'originalDomain' query parameter, as well as the original query parameter.

browsermob-core/src/test/groovy/net/lightbody/bmp/proxy/RewriteRuleTest.groovy

@@ -0,0 +1,84 @@
+package net.lightbody.bmp.proxy
+
+import net.lightbody.bmp.BrowserMobProxy
+import net.lightbody.bmp.BrowserMobProxyServer
+import net.lightbody.bmp.proxy.test.util.MockServerTest
+import net.lightbody.bmp.proxy.test.util.NewProxyServerTestUtil
+import org.apache.http.client.methods.CloseableHttpResponse
+import org.apache.http.client.methods.HttpGet
+import org.junit.After
+import org.junit.Test
+import org.mockserver.matchers.Times
+
+import static org.junit.Assert.assertEquals
+import static org.mockserver.model.HttpRequest.request
+import static org.mockserver.model.HttpResponse.response
+
+class RewriteRuleTest extends MockServerTest {
+    private BrowserMobProxy proxy
+
+    @After
+    void tearDown() {
+        if (proxy?.started) {
+            proxy.abort()
+        }
+    }
+
+    @Test
+    void testRewriteHttpUrl() {
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/")
+                .withQueryStringParameter("originalDomain", "yahoo")
+                .withQueryStringParameter("param1", "value1"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(200)
+                .withBody("success"))
+
+        proxy = new BrowserMobProxyServer();
+        proxy.rewriteUrl('http://www\\.(yahoo|bing)\\.com/\\?(\\w+)=(\\w+)', 'http://localhost:' + mockServerPort + '/?originalDomain=$1&$2=$3');
+        proxy.setTrustAllServers(true)
+        proxy.start()
+
+        String requestUrl = "http://www.yahoo.com?param1=value1"
+
+        NewProxyServerTestUtil.getNewHttpClient(proxy.port).withCloseable {
+            CloseableHttpResponse response = it.execute(new HttpGet(requestUrl))
+            assertEquals("Did not receive HTTP 200 from mock server", 200, response.getStatusLine().getStatusCode())
+
+            String responseBody = NewProxyServerTestUtil.toStringAndClose(response.getEntity().getContent());
+            assertEquals("Did not receive expected response from mock server", "success", responseBody);
+        };
+    }
+
+    @Test
+    void testRewriteHttpsUrl() {
+        // HTTPS URLs cannot currently be rewritten to another domain, so verify query parameters can be rewritten
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/")
+                .withQueryStringParameter("firstParam", "param1")
+                .withQueryStringParameter("firstValue", "value1"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(200)
+                .withBody("success"))
+
+        proxy = new BrowserMobProxyServer();
+        proxy.rewriteUrl('https://localhost:' + mockServerPort + '/\\?(\\w+)=(\\w+)', 'https://localhost:' + mockServerPort + '/?firstParam=$1&firstValue=$2');
+        proxy.setTrustAllServers(true)
+        proxy.start()
+
+        String requestUrl = "https://localhost:$mockServerPort?param1=value1"
+
+        NewProxyServerTestUtil.getNewHttpClient(proxy.port).withCloseable {
+            CloseableHttpResponse response = it.execute(new HttpGet(requestUrl))
+            assertEquals("Did not receive HTTP 200 from mock server", 200, response.getStatusLine().getStatusCode())
+
+            String responseBody = NewProxyServerTestUtil.toStringAndClose(response.getEntity().getContent());
+            assertEquals("Did not receive expected response from mock server", "success", responseBody);
+        };
+    }
+}