Support custom OkHttpClient on HoverflyClient (#260)

Co-authored-by: Italo Garcia <[email protected]>

Author: italomg

src/main/java/io/specto/hoverfly/junit/api/HoverflyClient.java

@@ -12,6 +12,7 @@
 import io.specto.hoverfly.junit.core.model.Journal;
 import io.specto.hoverfly.junit.core.model.Request;
 import io.specto.hoverfly.junit.core.model.Simulation;
+import okhttp3.OkHttpClient;
 
 /**
  * Http client for querying Hoverfly admin endpoints
@@ -129,6 +130,7 @@ class Builder {
         private String host = HoverflyConstants.LOCALHOST;
         private int port = HoverflyConstants.DEFAULT_ADMIN_PORT;
         private String authToken = null;
+        private OkHttpClient client = null;
 
         Builder() {
         }
@@ -157,8 +159,17 @@ public Builder withAuthToken() {
             return this;
         }
 
+        public Builder withHttpClient(OkHttpClient client) {
+            this.client = client;
+            return this;
+        }
+
         public HoverflyClient build() {
-            return new OkHttpHoverflyClient(scheme, host, port, authToken);
+            if (client == null) {
+                return new OkHttpHoverflyClient(scheme, host, port, authToken);
+            }
+
+            return new OkHttpHoverflyClient(scheme, host, port, client);
         }
     }
 

src/main/java/io/specto/hoverfly/junit/api/OkHttpHoverflyClient.java

@@ -60,6 +60,16 @@ class OkHttpHoverflyClient implements HoverflyClient {
                 .build();
     }
 
+    OkHttpHoverflyClient(String scheme, String host, int port, OkHttpClient client) {
+        OBJECT_MAPPER.registerModule(new JavaTimeModule());
+        this.client = client;
+        this.baseUrl = new HttpUrl.Builder()
+                .scheme(scheme)
+                .host(host)
+                .port(port)
+                .build();
+    }
+
     @Override
     public void setSimulation(Simulation simulation) {
         try {

src/test/java/io/specto/hoverfly/junit/api/HoverflyClientTest.java

@@ -2,6 +2,7 @@
 
 
 import io.specto.hoverfly.junit.rule.HoverflyRule;
+import okhttp3.OkHttpClient;
 import org.junit.ClassRule;
 import org.junit.Rule;
 import org.junit.Test;
@@ -55,6 +56,28 @@ public void shouldBeAbleToCreateHoverflyClientWithAuthToken() {
         assertThat(hoverflyClient.getHealth()).isTrue();
     }
 
+    @Test
+    public void shouldBeAbleToCreateHoverflyClientWithHttpClient() {
+        envVars.set("HOVERFLY_AUTH_TOKEN", "some-token");
+        hoverflyRule.simulate(dsl(
+                service("http://remote.host:12345")
+                        .get("/api/health")
+                        .willReturn(success())
+        ));
+
+        OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder();
+        OkHttpClient client = clientBuilder.build();
+
+        HoverflyClient hoverflyClient = HoverflyClient.custom()
+                .host("remote.host")
+                .port(12345)
+                .withAuthToken()
+                .withHttpClient(client)
+                .build();
+
+        assertThat(hoverflyClient.getHealth()).isTrue();
+    }
+
     @Test
     public void shouldCreateDefaultClient() {
         hoverflyRule.simulate(dsl(

src/test/java/io/specto/hoverfly/junit/api/OkHttpHoverflyClientTest.java

@@ -46,7 +46,7 @@ public class OkHttpHoverflyClientTest {
     public void setUp() {
         startDefaultHoverfly();
         HoverflyConfiguration hoverflyConfig = hoverfly.getHoverflyConfig();
-        client = new OkHttpHoverflyClient(hoverflyConfig.getScheme(), hoverflyConfig.getHost(), hoverflyConfig.getAdminPort(), null);
+        client = new OkHttpHoverflyClient(hoverflyConfig.getScheme(), hoverflyConfig.getHost(), hoverflyConfig.getAdminPort(), "");
     }
 
     @Test