Merge branch 'feat/allow-random-port' of github.com:marschwar/klite

CHANGELOG.md

@@ -5,6 +5,7 @@
 * jdbc: fixed usage of multiple different DataSources when there is an active transaction
 * json: TSGenerator will now use more type-safe string template types for java.time classes, e.g. `${number}-${number}-${number}` instead of `string`
 * openapi: fix compliancy: output parameter types as lowercase in OpenAPI spec
+* server: `Server(InetSocketAddress(0))` can now be used to bind to any available port.
 
 # 1.6.9
 * core: logger(name) is now accessible without a class instance context

TUTORIAL.md

@@ -39,6 +39,7 @@ fun main() {
 
 This will start a server on the default port 8080.
 You can change the listening IP and port by passing it as an argument to the `Server` constructor.
+Passing `InetSocketAddress(0)` will bind to any available port.
 
 ## Config
 

sample/test/ServerIntegrationTest.kt

@@ -14,10 +14,9 @@ import java.net.http.HttpRequest.BodyPublishers.noBody
 
 class ServerIntegrationTest {
   @Test fun requests() {
-    val port = (Math.random() * 60000 + 1000).toInt()
-    val server = sampleServer(port).apply { start(gracefulStopDelaySec = -1) }
+    val server = sampleServer(0).apply { start(gracefulStopDelaySec = -1) }
 
-    val http = JsonHttpClient("http://localhost:$port", registry = server.registry)
+    val http = JsonHttpClient("http://localhost:${server.listen.port}", registry = server.registry)
     runBlocking {
       expect(http.get<String>("/hello")).toEqual("\"Hello World\"")
       expect(http.get<String>("/hello/param/123456?query=123")).toEqual("\"Path: 123456, Query: {query=123}\"")

server/src/klite/Server.kt

@@ -18,7 +18,7 @@ import kotlin.reflect.KFunction
 import kotlin.reflect.full.primaryConstructor
 
 class Server(
-  val listen: InetSocketAddress = InetSocketAddress(Config.optional("PORT")?.toInt() ?: 8080),
+  listen: InetSocketAddress = InetSocketAddress(Config.optional("PORT")?.toInt() ?: 8080),
   val workerPool: ExecutorService = Executors.newWorkStealingPool(Config.optional("NUM_WORKERS")?.toInt() ?: getRuntime().availableProcessors()),
   override val registry: MutableRegistry = DependencyInjectingRegistry().apply {
     register<RequestLogger>()
@@ -36,12 +36,13 @@ class Server(
   private val httpExchangeCreator: KFunction<HttpExchange> = HttpExchange::class.primaryConstructor!!,
 ): RouterConfig(decorators, registry.requireAll(), registry.requireAll()), MutableRegistry by registry {
   init { currentThread().name += "/" + requestIdGenerator.prefix }
-  private val http = HttpServer.create()
   private val requestScope = CoroutineScope(SupervisorJob() + workerPool.asCoroutineDispatcher())
   private val log = logger()
 
+  private val http = HttpServer.create(listen, 0)
+  val listen: InetSocketAddress get() = http.address
+
   fun start(gracefulStopDelaySec: Int = 3) {
-    http.bind(listen, 0)
     log.info("Listening on $listen")
     http.start()
     if (gracefulStopDelaySec >= 0) getRuntime().addShutdownHook(thread(start = false) { stop(gracefulStopDelaySec) })

server/test/klite/ServerTest.kt

@@ -0,0 +1,36 @@
+package klite
+
+import ch.tutteli.atrium.api.fluent.en_GB.toBeGreaterThan
+import ch.tutteli.atrium.api.fluent.en_GB.toEqual
+import ch.tutteli.atrium.api.verbs.expect
+import org.junit.jupiter.api.Test
+import java.net.InetSocketAddress
+import kotlin.random.Random
+
+class ServerTest {
+  @Test fun `bind server to any available port`() {
+    val server = Server(listen = InetSocketAddress( 0))
+    try {
+      server.start(gracefulStopDelaySec = -1)
+      expect(server.listen.port).toBeGreaterThan(0)
+    } finally {
+      server.stop(0)
+    }
+  }
+
+  @Test fun `bind server to custom port`() {
+    val port = Random.nextInt(1024, 65535) + 1
+    val server = Server(listen = InetSocketAddress(port))
+    try {
+      server.start(gracefulStopDelaySec = -1)
+      expect(server.listen.port).toEqual(port)
+    } finally {
+      server.stop(0)
+    }
+  }
+
+  @Test fun `expose bound address if server is not started`() {
+    expect(Server().listen.port).toEqual(8080)
+  }
+}
+