feat(test): adds findAvailablePort for test server...

Author: Aliaksie

mcp-spring/mcp-spring-webflux/src/test/java/io/modelcontextprotocol/server/TestUtil.java

@@ -0,0 +1,31 @@
+/*
+* Copyright 2025 - 2025 the original author or authors.
+*/
+package io.modelcontextprotocol.server;
+
+import java.io.IOException;
+import java.net.InetSocketAddress;
+import java.net.ServerSocket;
+
+public class TestUtil {
+
+	TestUtil() {
+		// Prevent instantiation
+	}
+
+	/**
+	 * Finds an available port on the local machine.
+	 * @return an available port number
+	 * @throws IllegalStateException if no available port can be found
+	 */
+	public static int findAvailablePort() {
+		try (final ServerSocket socket = new ServerSocket()) {
+			socket.bind(new InetSocketAddress(0));
+			return socket.getLocalPort();
+		}
+		catch (final IOException e) {
+			throw new IllegalStateException("Cannot bind to an available port!", e);
+		}
+	}
+
+}

mcp-spring/mcp-spring-webflux/src/test/java/io/modelcontextprotocol/server/WebFluxSseMcpAsyncServerTests.java

@@ -23,7 +23,7 @@
 @Timeout(15) // Giving extra time beyond the client timeout
 class WebFluxSseMcpAsyncServerTests extends AbstractMcpAsyncServerTests {
 
-	private static final int PORT = 8181;
+	private static final int PORT = TestUtil.findAvailablePort();
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 

mcp-spring/mcp-spring-webflux/src/test/java/io/modelcontextprotocol/server/WebFluxSseMcpSyncServerTests.java

@@ -23,7 +23,7 @@
 @Timeout(15) // Giving extra time beyond the client timeout
 class WebFluxSseMcpSyncServerTests extends AbstractMcpSyncServerTests {
 
-	private static final int PORT = 8182;
+	private static final int PORT = TestUtil.findAvailablePort();
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 

mcp-spring/mcp-spring-webmvc/src/test/java/io/modelcontextprotocol/server/TomcatTestUtil.java

@@ -3,6 +3,10 @@
 */
 package io.modelcontextprotocol.server;
 
+import java.io.IOException;
+import java.net.InetSocketAddress;
+import java.net.ServerSocket;
+
 import org.apache.catalina.Context;
 import org.apache.catalina.startup.Tomcat;
 
@@ -14,10 +18,14 @@
  */
 public class TomcatTestUtil {
 
+	TomcatTestUtil() {
+		// Prevent instantiation
+	}
+
 	public record TomcatServer(Tomcat tomcat, AnnotationConfigWebApplicationContext appContext) {
 	}
 
-	public TomcatServer createTomcatServer(String contextPath, int port, Class<?> componentClass) {
+	public static TomcatServer createTomcatServer(String contextPath, int port, Class<?> componentClass) {
 
 		// Set up Tomcat first
 		var tomcat = new Tomcat();
@@ -57,4 +65,19 @@ public TomcatServer createTomcatServer(String contextPath, int port, Class<?> co
 		return new TomcatServer(tomcat, appContext);
 	}
 
+	/**
+	 * Finds an available port on the local machine.
+	 * @return an available port number
+	 * @throws IllegalStateException if no available port can be found
+	 */
+	public static int findAvailablePort() {
+		try (final ServerSocket socket = new ServerSocket()) {
+			socket.bind(new InetSocketAddress(0));
+			return socket.getLocalPort();
+		}
+		catch (final IOException e) {
+			throw new IllegalStateException("Cannot bind to an available port!", e);
+		}
+	}
+
 }

mcp-spring/mcp-spring-webmvc/src/test/java/io/modelcontextprotocol/server/WebMvcSseAsyncServerTransportTests.java

@@ -25,7 +25,7 @@ class WebMvcSseAsyncServerTransportTests extends AbstractMcpAsyncServerTests {
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 
-	private static final int PORT = 8181;
+	private static final int PORT = TomcatTestUtil.findAvailablePort();
 
 	private Tomcat tomcat;
 
@@ -73,7 +73,6 @@ protected McpServerTransportProvider createMcpTransportProvider() {
 
 		// Create DispatcherServlet with our Spring context
 		DispatcherServlet dispatcherServlet = new DispatcherServlet(appContext);
-		// dispatcherServlet.setThrowExceptionIfNoHandlerFound(true);
 
 		// Add servlet to Tomcat and get the wrapper
 		var wrapper = Tomcat.addServlet(context, "dispatcherServlet", dispatcherServlet);

mcp-spring/mcp-spring-webmvc/src/test/java/io/modelcontextprotocol/server/WebMvcSseCustomContextPathTests.java

@@ -22,11 +22,11 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-public class WebMvcSseCustomContextPathTests {
+class WebMvcSseCustomContextPathTests {
 
 	private static final String CUSTOM_CONTEXT_PATH = "/app/1";
 
-	private static final int PORT = 8183;
+	private static final int PORT = TomcatTestUtil.findAvailablePort();
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 
@@ -39,11 +39,11 @@ public class WebMvcSseCustomContextPathTests {
 	@BeforeEach
 	public void before() {
 
-		tomcatServer = new TomcatTestUtil().createTomcatServer(CUSTOM_CONTEXT_PATH, PORT, TestConfig.class);
+		tomcatServer = TomcatTestUtil.createTomcatServer(CUSTOM_CONTEXT_PATH, PORT, TestConfig.class);
 
 		try {
 			tomcatServer.tomcat().start();
-			assertThat(tomcatServer.tomcat().getServer().getState() == LifecycleState.STARTED);
+			assertThat(tomcatServer.tomcat().getServer().getState()).isEqualTo(LifecycleState.STARTED);
 		}
 		catch (Exception e) {
 			throw new RuntimeException("Failed to start Tomcat", e);

mcp-spring/mcp-spring-webmvc/src/test/java/io/modelcontextprotocol/server/WebMvcSseIntegrationTests.java

@@ -46,7 +46,7 @@
 
 class WebMvcSseIntegrationTests {
 
-	private static final int PORT = 8183;
+	private static final int PORT = TomcatTestUtil.findAvailablePort();
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 
@@ -75,7 +75,7 @@ public RouterFunction<ServerResponse> routerFunction(WebMvcSseServerTransportPro
 	@BeforeEach
 	public void before() {
 
-		tomcatServer = new TomcatTestUtil().createTomcatServer("", PORT, TestConfig.class);
+		tomcatServer = TomcatTestUtil.createTomcatServer("", PORT, TestConfig.class);
 
 		try {
 			tomcatServer.tomcat().start();
@@ -142,7 +142,7 @@ void testCreateMessageWithoutSamplingCapabilities() {
 	}
 
 	@Test
-	void testCreateMessageSuccess() throws InterruptedException {
+	void testCreateMessageSuccess() {
 
 		// Client
 

mcp-spring/mcp-spring-webmvc/src/test/java/io/modelcontextprotocol/server/WebMvcSseSyncServerTransportTests.java

@@ -24,7 +24,7 @@ class WebMvcSseSyncServerTransportTests extends AbstractMcpSyncServerTests {
 
 	private static final String MESSAGE_ENDPOINT = "/mcp/message";
 
-	private static final int PORT = 8181;
+	private static final int PORT = TomcatTestUtil.findAvailablePort();
 
 	private Tomcat tomcat;
 
@@ -72,7 +72,6 @@ protected WebMvcSseServerTransportProvider createMcpTransportProvider() {
 
 		// Create DispatcherServlet with our Spring context
 		DispatcherServlet dispatcherServlet = new DispatcherServlet(appContext);
-		// dispatcherServlet.setThrowExceptionIfNoHandlerFound(true);
 
 		// Add servlet to Tomcat and get the wrapper
 		var wrapper = Tomcat.addServlet(context, "dispatcherServlet", dispatcherServlet);