Return -1 port for non-listening WebServers

Update `WebServer` implementations to return -1 from `getPort()` if
the server  isn't listening on a port. This aligns the implementations
with the interface Javadoc.

See gh-24606
This commit is contained in:
Stefan Partusch
2020-12-23 15:24:51 +01:00
committed by Phillip Webb
parent 2ad9a47d08
commit 5c61df3131
6 changed files with 28 additions and 6 deletions

View File

@@ -275,11 +275,13 @@ public class JettyWebServer implements WebServer {
@Override
public int getPort() {
Connector[] connectors = this.server.getConnectors();
Integer localPort = -1;
for (Connector connector : connectors) {
// Probably only one...
return getLocalPort(connector);
localPort = getLocalPort(connector);
break;
}
return 0;
return (localPort > 0) ? localPort : -1;
}
@Override

View File

@@ -192,7 +192,7 @@ public class NettyWebServer implements WebServer {
if (this.disposableServer != null) {
return this.disposableServer.port();
}
return 0;
return -1;
}
}

View File

@@ -364,7 +364,7 @@ public class TomcatWebServer implements WebServer {
if (connector != null) {
return connector.getLocalPort();
}
return 0;
return -1;
}
private String getContextPath() {

View File

@@ -295,7 +295,7 @@ public class UndertowWebServer implements WebServer {
public int getPort() {
List<Port> ports = getActualPorts();
if (ports.isEmpty()) {
return 0;
return -1;
}
return ports.get(0).getNumber();
}

View File

@@ -115,6 +115,16 @@ public abstract class AbstractReactiveWebServerFactoryTests {
assertThat(this.webServer.getPort()).isEqualTo(specificPort);
}
@Test
void portIsMinusOneWhenConnectionIsClosed() {
AbstractReactiveWebServerFactory factory = getFactory();
this.webServer = factory.getWebServer(new EchoHandler());
this.webServer.start();
assertThat(this.webServer.getPort()).isGreaterThan(0);
this.webServer.stop();
assertThat(this.webServer.getPort()).isEqualTo(-1);
}
@Test
void basicSslFromClassPath() {
testBasicSslWithKeyStore("classpath:test.jks", "password");

View File

@@ -250,7 +250,7 @@ public abstract class AbstractServletWebServerFactoryTests {
factory.setPort(-1);
this.webServer = factory.getWebServer(exampleServletRegistration());
this.webServer.start();
assertThat(this.webServer.getPort()).isLessThan(0); // Jetty is -2
assertThat(this.webServer.getPort()).isEqualTo(-1);
}
@Test
@@ -300,6 +300,16 @@ public abstract class AbstractServletWebServerFactoryTests {
assertThat(servlet.getInitCount()).isEqualTo(1);
}
@Test
void portIsMinusOneWhenConnectionIsClosed() {
AbstractServletWebServerFactory factory = getFactory();
this.webServer = factory.getWebServer();
this.webServer.start();
assertThat(this.webServer.getPort()).isGreaterThan(0);
this.webServer.stop();
assertThat(this.webServer.getPort()).isEqualTo(-1);
}
@Test
void specificPort() throws Exception {
AbstractServletWebServerFactory factory = getFactory();