BAEL-4504: Move find free port to networking-3

2020-10-11 10:22:42 +02:00
parent 0d6bfccdfd
commit f75c33684a
3 changed files with 213 additions and 0 deletions
--- a/core-java-modules/core-java-networking-3/src/test/java/com/baeldung/socket/FindFreePortUnitTest.java
+++ b/core-java-modules/core-java-networking-3/src/test/java/com/baeldung/socket/FindFreePortUnitTest.java
@@ -0,0 +1,146 @@
+package com.baeldung.socket;
+
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.startup.Tomcat;
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.util.SocketUtils;
+
+import java.io.IOException;
+import java.net.ServerSocket;
+
+import static org.assertj.core.api.Assertions.*;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class FindFreePortUnitTest {
+
+    private static int FREE_PORT_NUMBER;
+    private static int[] FREE_PORT_RANGE;
+
+    @BeforeAll
+    public static void getExplicitFreePortNumberAndRange() {
+        try (ServerSocket serverSocket = new ServerSocket(0);) {
+            FREE_PORT_NUMBER = serverSocket.getLocalPort();
+            FREE_PORT_RANGE = new int[] {FREE_PORT_NUMBER, FREE_PORT_NUMBER + 1, FREE_PORT_NUMBER + 2};
+        } catch (IOException e) {
+            fail("No free port is available");
+        }
+    }
+
+    @Test
+    public void givenExplicitFreePort_whenCreatingServerSocket_thenThatPortIsAssigned() {
+        try (ServerSocket serverSocket = new ServerSocket(FREE_PORT_NUMBER);) {
+            assertThat(serverSocket).isNotNull();
+            assertThat(serverSocket.getLocalPort()).isEqualTo(FREE_PORT_NUMBER);
+        } catch (IOException e) {
+            fail("Port is not available");
+        }
+    }
+
+    @Test
+    public void givenExplicitOccupiedPort_whenCreatingServerSocket_thenExceptionIsThrown() {
+        try (ServerSocket serverSocket = new ServerSocket(FREE_PORT_NUMBER)) {
+            new ServerSocket(FREE_PORT_NUMBER);
+            fail("Same port cannot be used twice");
+        } catch (IOException e) {
+            assertThat(e).hasMessageContaining("Address already in use");
+        }
+    }
+
+    @Test
+    public void givenExplicitPortRange_whenCreatingServerSocket_thenOnePortIsAssigned() {
+        for (int port : FREE_PORT_RANGE) {
+            try (ServerSocket serverSocket = new ServerSocket(port)) {
+                assertThat(serverSocket).isNotNull();
+                assertThat(serverSocket.getLocalPort()).isGreaterThan(0);
+                return;
+            } catch (IOException e) {
+                assertThat(e).hasMessageContaining("Address already in use");
+            }
+        }
+        fail("No free port in the range found");
+    }
+
+    @Test
+    public void givenPortZero_whenCreatingServerSocket_thenFreePortIsAssigned() {
+        try (ServerSocket serverSocket = new ServerSocket(0)) {
+            assertThat(serverSocket).isNotNull();
+            assertThat(serverSocket.getLocalPort()).isGreaterThan(0);
+        } catch (IOException e) {
+            fail("Port is not available");
+        }
+    }
+
+    @Test
+    public void givenAvailableTcpPort_whenCreatingServerSocket_thenThatPortIsAssigned() {
+        int port = SocketUtils.findAvailableTcpPort();
+        try (ServerSocket serverSocket = new ServerSocket(port)) {
+            assertThat(serverSocket).isNotNull();
+            assertThat(serverSocket.getLocalPort()).isGreaterThan(0);
+        } catch (IOException e) {
+            fail("Port is not available");
+        }
+    }
+
+    @Test
+    public void givenNoPortDefined_whenCreatingJettyServer_thenFreePortIsAssigned() {
+        Server jettyServer = new Server();
+        ServerConnector serverConnector = new ServerConnector(jettyServer);
+        jettyServer.addConnector(serverConnector);
+        try {
+            jettyServer.start();
+            assertThat(serverConnector.getLocalPort()).isGreaterThan(0);
+            jettyServer.stop();
+            jettyServer.destroy();
+        } catch (Exception e) {
+            fail("Failed to start Jetty server");
+        }
+    }
+
+    @Test
+    public void givenExplicitFreePort_whenCreatingJettyServer_thenThatPortIsAssigned() {
+        Server jettyServer = new Server();
+        ServerConnector serverConnector = new ServerConnector(jettyServer);
+        serverConnector.setPort(FREE_PORT_NUMBER);
+        jettyServer.addConnector(serverConnector);
+        try {
+            jettyServer.start();
+            assertThat(serverConnector.getLocalPort()).isEqualTo(FREE_PORT_NUMBER);
+            jettyServer.stop();
+            jettyServer.destroy();
+        } catch (Exception e) {
+            fail("Failed to start Jetty server");
+        }
+    }
+
+    @Test
+    public void givenPortZero_whenCreatingTomcatServer_thenFreePortIsAssigned() {
+        Tomcat tomcatServer = new Tomcat();
+        tomcatServer.setPort(0);
+        try {
+            tomcatServer.start();
+            assertThat(tomcatServer.getConnector().getLocalPort()).isGreaterThan(0);
+            tomcatServer.stop();
+            tomcatServer.destroy();
+        } catch (LifecycleException e) {
+            fail("Failed to start Tomcat server");
+        }
+    }
+
+    @Test
+    public void givenExplicitFreePort_whenCreatingTomcatServer_thenThatPortIsAssigned() {
+        Tomcat tomcatServer = new Tomcat();
+        tomcatServer.setPort(FREE_PORT_NUMBER);
+        try {
+            tomcatServer.start();
+            assertThat(tomcatServer.getConnector().getLocalPort()).isEqualTo(FREE_PORT_NUMBER);
+            tomcatServer.stop();
+            tomcatServer.destroy();
+        } catch (LifecycleException e) {
+            fail("Failed to start Tomcat server");
+        }
+    }
+
+}