Moves check for a free socket to SocketUtil class

Author: EBichel

rest-client-driver/src/test/java/com/github/restdriver/clientdriver/integration/ChooseOwnPortTest.java

@@ -20,7 +20,6 @@
 import static org.hamcrest.Matchers.*;
 
 import java.io.IOException;
-import java.net.ServerSocket;
 
 import org.apache.commons.io.IOUtils;
 import org.apache.http.HttpResponse;
@@ -29,6 +28,7 @@
 import org.apache.http.impl.client.DefaultHttpClient;
 import org.junit.Test;
 
+import com.github.restdriver.SocketUtil;
 import com.github.restdriver.clientdriver.ClientDriver;
 import com.github.restdriver.clientdriver.ClientDriverFactory;
 import com.github.restdriver.clientdriver.exception.ClientDriverSetupException;
@@ -43,7 +43,7 @@ public class ChooseOwnPortTest {
     @Test
     public void userCanChooseOwnPort() throws IOException {
 
-        int portNum = getFreePort();
+        int portNum = SocketUtil.getFreePort();
 
         ClientDriver driver = new ClientDriverFactory().createClientDriver(portNum);
         driver.addExpectation(onRequestTo("/url"), giveResponse("hello", "text/plain"));
@@ -60,7 +60,7 @@ public void userCanChooseOwnPort() throws IOException {
     @Test(expected = ClientDriverSetupException.class)
     public void correctExceptionIsThrownIfPortIsUnavailable() throws IOException {
 
-        int portNum = getFreePort();
+        int portNum = SocketUtil.getFreePort();
 
         // one of these must throw an exception.
         new ClientDriverFactory().createClientDriver(portNum);
@@ -76,23 +76,4 @@ public void jettyFindsFreePortItself() {
 
     }
 
-    /*
-     * Gets a free port on localhost for binding to.
-     * 
-     * @see "http://chaoticjava.com/posts/retrieving-a-free-port-for-socket-binding/"
-     * 
-     * @return The port number.
-     */
-    public static int getFreePort() {
-        try {
-            ServerSocket server = new ServerSocket(0);
-            int port = server.getLocalPort();
-            server.close();
-            return port;
-
-        } catch (IOException ioe) {
-            throw new ClientDriverSetupException(
-                    "IOException finding free port", ioe);
-        }
-    }
 }

rest-driver-shared/src/main/java/com/github/restdriver/SocketUtil.java

@@ -0,0 +1,33 @@
+package com.github.restdriver;
+
+import java.io.IOException;
+import java.net.ServerSocket;
+
+
+/**
+ * Utility class to retrieve a free port number.
+ *
+ * @author bichel
+ *
+ */
+public final class SocketUtil {
+
+    private SocketUtil() {
+
+    }
+
+    /**
+     * Gets a free port on localhost for binding to.
+     *
+     * @see "http://chaoticjava.com/posts/retrieving-a-free-port-for-socket-binding/"
+     *
+     * @return The port number.
+     */
+    public static int getFreePort() throws IOException {
+            ServerSocket server = new ServerSocket(0);
+            int port = server.getLocalPort();
+            server.close();
+            return port;
+    }
+
+}

rest-server-driver/src/test/java/com/github/restdriver/serverdriver/acceptance/HttpProblemsAcceptanceTest.java

@@ -17,9 +17,11 @@
 
 import static com.github.restdriver.serverdriver.RestServerDriver.*;
 
+import java.io.IOException;
+
 import org.junit.Test;
 
-import com.github.restdriver.clientdriver.ClientDriver;
+import com.github.restdriver.SocketUtil;
 import com.github.restdriver.serverdriver.http.exception.RuntimeClientProtocolException;
 import com.github.restdriver.serverdriver.http.exception.RuntimeHttpHostConnectException;
 import com.github.restdriver.serverdriver.http.exception.RuntimeUnknownHostException;
@@ -42,8 +44,8 @@ public void getWithInvalidProtocolThrowsException() {
     }
 
     @Test(expected = RuntimeHttpHostConnectException.class)
-    public void noServerListeningThrowsException() {
-        get("http://localhost:" + ClientDriver.getFreePort());
+    public void noServerListeningThrowsException() throws IOException {
+        get("http://localhost:" + SocketUtil.getFreePort());
     }
 
 }

rest-server-driver/src/test/java/com/github/restdriver/serverdriver/acceptance/ProxyAcceptanceTest.java

@@ -33,7 +33,7 @@
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
-import com.github.restdriver.clientdriver.ClientDriver;
+import com.github.restdriver.SocketUtil;
 import com.github.restdriver.clientdriver.ClientDriverRequest;
 import com.github.restdriver.clientdriver.ClientDriverResponse;
 import com.github.restdriver.clientdriver.ClientDriverRule;
@@ -53,10 +53,10 @@ public class ProxyAcceptanceTest {
     public ExpectedException thrown = ExpectedException.none();
 
     @Test
-    public void testWithSpecifiedProxyFailsIfProxyIsNotAvailable() {
+    public void testWithSpecifiedProxyFailsIfProxyIsNotAvailable() throws IOException {
         thrown.expect(RuntimeHttpHostConnectException.class);
         driver.addExpectation(new ClientDriverRequest("/foo"), new ClientDriverResponse("Content", "text/plain"));
-        get(driver.getBaseUrl() + "/foo", usingProxy("localhost", ClientDriver.getFreePort()));
+        get(driver.getBaseUrl() + "/foo", usingProxy("localhost", SocketUtil.getFreePort()));
     }
 
     @Test
@@ -76,9 +76,9 @@ public void testWithNoProxyDoesntTryToUseAProxy() {
     }
 
     @Test
-    public void whenMultipleProxiesAreSpecifiedLastOneWinsNoProxy() {
+    public void whenMultipleProxiesAreSpecifiedLastOneWinsNoProxy() throws IOException {
         driver.addExpectation(new ClientDriverRequest("/foo"), new ClientDriverResponse("Content", "text/plain"));
-        get(driver.getBaseUrl() + "/foo", usingProxy("localhost", ClientDriver.getFreePort()), notUsingProxy());
+        get(driver.getBaseUrl() + "/foo", usingProxy("localhost", SocketUtil.getFreePort()), notUsingProxy());
         assertThat(proxyHits, is(0));
     }
 
@@ -149,7 +149,7 @@ public void systemProxyUsesNoProxyIfNoSystemPropertiesSet() {
     private void startLocalProxy() {
         try {
 
-            int port = ClientDriver.getFreePort();
+            int port = SocketUtil.getFreePort();
 
             proxyServer = new Server(port);
             ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS);