feature: multiple server support (#24)

* Add httpserver and "route" abstraction
* Support MockWebServer and Netty
* Support custom routes, i.e. users of the library may add their own routes to be served by the MockOAuth2Server

Author: tommytroen

build.gradle.kts

@@ -6,8 +6,8 @@ val logbackVersion = "1.2.3"
 val nimbusSdkVersion = "8.19.1"
 val mockWebServerVersion = "4.8.1"
 val jacksonVersion = "2.11.2"
+val nettyVersion = "4.1.56.Final"
 val junitJupiterVersion = "5.7.0-RC1"
-val konfigVersion = "1.6.10.0"
 val kotlinVersion = "1.4.0"
 val freemarkerVersion = "2.3.30"
 val kotestVersion = "4.2.5"
@@ -52,9 +52,9 @@ dependencies {
     implementation(kotlin("reflect"))
     implementation("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
     implementation("ch.qos.logback:logback-classic:$logbackVersion")
-    implementation("com.natpryce:konfig:$konfigVersion")
     api("com.squareup.okhttp3:mockwebserver:$mockWebServerVersion")
     api("com.nimbusds:oauth2-oidc-sdk:$nimbusSdkVersion")
+    implementation("io.netty:netty-all:$nettyVersion")
     implementation("io.github.microutils:kotlin-logging:$kotlinLoggingVersion")
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin:$jacksonVersion")
     implementation("org.freemarker:freemarker:$freemarkerVersion")
@@ -200,11 +200,11 @@ tasks {
         dependsOn("publish")
     }
 
-    /*withType<Sign>().configureEach {
+    withType<Sign>().configureEach {
         onlyIf {
             project.hasProperty("signatory.keyId")
         }
-    }*/
+    }
 
     withType<Wrapper> {
         gradleVersion = "6.6.1"

src/main/kotlin/no/nav/security/mock/oauth2/MockOAuth2Server.kt

@@ -11,60 +11,74 @@ import java.io.IOException
 import java.net.InetAddress
 import java.net.URI
 import java.util.UUID
-import java.util.concurrent.BlockingQueue
-import java.util.concurrent.LinkedBlockingQueue
-import no.nav.security.mock.oauth2.extensions.asOAuth2HttpRequest
+import mu.KotlinLogging
 import no.nav.security.mock.oauth2.extensions.toAuthorizationEndpointUrl
 import no.nav.security.mock.oauth2.extensions.toEndSessionEndpointUrl
 import no.nav.security.mock.oauth2.extensions.toJwksUrl
 import no.nav.security.mock.oauth2.extensions.toTokenEndpointUrl
 import no.nav.security.mock.oauth2.extensions.toWellKnownUrl
+import no.nav.security.mock.oauth2.http.MockWebServerWrapper
 import no.nav.security.mock.oauth2.http.OAuth2HttpRequestHandler
-import no.nav.security.mock.oauth2.http.OAuth2HttpResponse
+import no.nav.security.mock.oauth2.http.OAuth2HttpRouter
+import no.nav.security.mock.oauth2.http.OAuth2HttpRouter.Companion.routes
+import no.nav.security.mock.oauth2.http.Route
+import no.nav.security.mock.oauth2.http.route
 import no.nav.security.mock.oauth2.token.DefaultOAuth2TokenCallback
 import no.nav.security.mock.oauth2.token.OAuth2TokenCallback
 import okhttp3.HttpUrl
-import okhttp3.mockwebserver.Dispatcher
 import okhttp3.mockwebserver.MockResponse
-import okhttp3.mockwebserver.MockWebServer
 import okhttp3.mockwebserver.RecordedRequest
 
-// TODO make open so others can extend?
+private val log = KotlinLogging.logger { }
+
 @Suppress("unused", "MemberVisibilityCanBePrivate")
-class MockOAuth2Server(
-    val config: OAuth2Config = OAuth2Config()
+open class MockOAuth2Server(
+    val config: OAuth2Config = OAuth2Config(),
+    vararg additionalRoutes: Route
 ) {
-    private val mockWebServer: MockWebServer = MockWebServer()
+    constructor(vararg additionalRoutes: Route) : this(config = OAuth2Config(), additionalRoutes = additionalRoutes)
 
-    var dispatcher: Dispatcher = MockOAuth2Dispatcher(config)
+    private val httpServer = config.httpServer
+    private val defaultRequestHandler: OAuth2HttpRequestHandler = OAuth2HttpRequestHandler(config)
+    private val router: OAuth2HttpRouter = routes(
+        *additionalRoutes,
+        route("") {
+            defaultRequestHandler.handleRequest(it)
+        }
+    )
 
     @JvmOverloads
     @Throws(IOException::class)
-    fun start(
-        inetAddress: InetAddress = InetAddress.getByName("localhost"),
-        port: Int = 0
-    ) {
-        mockWebServer.start(inetAddress, port)
-        mockWebServer.dispatcher = dispatcher
+    fun start(inetAddress: InetAddress = InetAddress.getByName("localhost"), port: Int = 0) {
+        log.debug("attempt to start server on port=$port")
+        httpServer.start(inetAddress, port, router)
     }
 
     @Throws(IOException::class)
     fun shutdown() {
-        mockWebServer.shutdown()
+        httpServer.stop()
+    }
+
+    fun url(path: String): HttpUrl = httpServer.url(path)
+
+    @Deprecated("Use MockWebServer method/function instead", ReplaceWith("MockWebServer.enqueue()"))
+    fun enqueueResponse(response: MockResponse) {
+        throw UnsupportedOperationException("cannot enqueue MockResponse, please use the MockWebServer directly with QueueDispatcher")
     }
 
-    fun url(path: String): HttpUrl = mockWebServer.url(path)
-    fun enqueueResponse(response: MockResponse) = (dispatcher as MockOAuth2Dispatcher).enqueueResponse(response)
-    fun enqueueCallback(oAuth2TokenCallback: OAuth2TokenCallback) = (dispatcher as MockOAuth2Dispatcher).enqueueTokenCallback(oAuth2TokenCallback)
-    fun takeRequest(): RecordedRequest = mockWebServer.takeRequest()
+    fun enqueueCallback(oAuth2TokenCallback: OAuth2TokenCallback) = defaultRequestHandler.enqueueTokenCallback(oAuth2TokenCallback)
+
+    fun takeRequest(): RecordedRequest =
+        (httpServer as? MockWebServerWrapper)?.mockWebServer?.takeRequest()
+            ?: throw UnsupportedOperationException("can only takeRequest when httpServer is of type MockWebServer")
 
-    fun wellKnownUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId).toWellKnownUrl()
-    fun tokenEndpointUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId).toTokenEndpointUrl()
-    fun jwksUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId).toJwksUrl()
-    fun issuerUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId)
-    fun authorizationEndpointUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId).toAuthorizationEndpointUrl()
-    fun endSessionEndpointUrl(issuerId: String): HttpUrl = mockWebServer.url(issuerId).toEndSessionEndpointUrl()
-    fun baseUrl(): HttpUrl = mockWebServer.url("")
+    fun wellKnownUrl(issuerId: String): HttpUrl = url(issuerId).toWellKnownUrl()
+    fun tokenEndpointUrl(issuerId: String): HttpUrl = url(issuerId).toTokenEndpointUrl()
+    fun jwksUrl(issuerId: String): HttpUrl = url(issuerId).toJwksUrl()
+    fun issuerUrl(issuerId: String): HttpUrl = url(issuerId)
+    fun authorizationEndpointUrl(issuerId: String): HttpUrl = url(issuerId).toAuthorizationEndpointUrl()
+    fun endSessionEndpointUrl(issuerId: String): HttpUrl = url(issuerId).toEndSessionEndpointUrl()
+    fun baseUrl(): HttpUrl = url("")
 
     fun issueToken(issuerId: String, clientId: String, tokenCallback: OAuth2TokenCallback): SignedJWT {
         val uri = tokenEndpointUrl(issuerId)
@@ -97,29 +111,6 @@ class MockOAuth2Server(
     )
 }
 
-class MockOAuth2Dispatcher(
-    config: OAuth2Config
-) : Dispatcher() {
-    private val httpRequestHandler: OAuth2HttpRequestHandler = OAuth2HttpRequestHandler(config)
-    private val responseQueue: BlockingQueue<MockResponse> = LinkedBlockingQueue()
-
-    fun enqueueResponse(mockResponse: MockResponse) = responseQueue.add(mockResponse)
-    fun enqueueTokenCallback(oAuth2TokenCallback: OAuth2TokenCallback) = httpRequestHandler.enqueueTokenCallback(oAuth2TokenCallback)
-
-    override fun dispatch(request: RecordedRequest): MockResponse =
-        responseQueue.peek()?.let {
-            responseQueue.take()
-        } ?: mockResponse(httpRequestHandler.handleRequest(request.asOAuth2HttpRequest()))
-
-    private fun mockResponse(response: OAuth2HttpResponse): MockResponse =
-        MockResponse()
-            .setHeaders(response.headers)
-            .setResponseCode(response.status)
-            .apply {
-                response.body?.let { this.setBody(it) }
-            }
-}
-
 fun <R> withMockOAuth2Server(
     test: MockOAuth2Server.() -> R
 ): R {

src/main/kotlin/no/nav/security/mock/oauth2/OAuth2Config.kt

@@ -1,10 +1,13 @@
 package no.nav.security.mock.oauth2
 
+import no.nav.security.mock.oauth2.http.MockWebServerWrapper
+import no.nav.security.mock.oauth2.http.OAuth2HttpServer
 import no.nav.security.mock.oauth2.token.OAuth2TokenCallback
 import no.nav.security.mock.oauth2.token.OAuth2TokenProvider
 
 data class OAuth2Config(
     val interactiveLogin: Boolean = false,
     val tokenProvider: OAuth2TokenProvider = OAuth2TokenProvider(),
-    val tokenCallbacks: Set<OAuth2TokenCallback> = emptySet()
+    val tokenCallbacks: Set<OAuth2TokenCallback> = emptySet(),
+    val httpServer: OAuth2HttpServer = MockWebServerWrapper()
 )

src/main/kotlin/no/nav/security/mock/oauth2/StandaloneMockOAuth2Server.kt

@@ -1,30 +1,31 @@
 package no.nav.security.mock.oauth2
 
-import com.natpryce.konfig.ConfigurationProperties
-import com.natpryce.konfig.EnvironmentVariables
-import com.natpryce.konfig.Key
-import com.natpryce.konfig.intType
-import com.natpryce.konfig.overriding
-import com.natpryce.konfig.stringType
+import java.net.InetAddress
 import java.net.InetSocketAddress
-
-private val config = ConfigurationProperties.systemProperties() overriding
-    EnvironmentVariables()
+import no.nav.security.mock.oauth2.http.NettyWrapper
+import no.nav.security.mock.oauth2.http.OAuth2HttpResponse
+import no.nav.security.mock.oauth2.http.route
 
 data class Configuration(
     val server: Server = Server()
 ) {
     data class Server(
-        val hostname: String = config.getOrElse(Key("server.hostname", stringType), "localhost"),
-        val port: Int = config.getOrElse(Key("server.port", intType), 8080)
+        val hostname: InetAddress = "SERVER_HOSTNAME".fromEnv()?.let { InetAddress.getByName(it) } ?: InetSocketAddress(0).address,
+        val port: Int = "SERVER_PORT".fromEnv()?.toInt() ?: 8080
     )
 }
 
 fun main() {
     val config = Configuration()
     MockOAuth2Server(
         OAuth2Config(
-            interactiveLogin = true
-        )
-    ).start(InetSocketAddress(0).address, config.server.port)
+            interactiveLogin = true,
+            httpServer = NettyWrapper()
+        ),
+        route("/isalive") {
+            OAuth2HttpResponse(status = 200, body = "alive and well")
+        }
+    ).start(config.server.hostname, config.server.port)
 }
+
+fun String.fromEnv(): String? = System.getenv(this)

src/main/kotlin/no/nav/security/mock/oauth2/extensions/HttpUrlExtensions.kt

@@ -28,10 +28,18 @@ fun HttpUrl.issuerId(): String = this.pathSegments.getOrNull(0)
 fun HttpUrl.Builder.removeAllEncodedQueryParams(vararg params: String) =
     apply { params.forEach { removeAllEncodedQueryParameters(it) } }
 
+fun HttpUrl.match(path: String) =
+    path.trimPath().let {
+        this.pathSegments.containsAll(it.split("/"))
+    }
+
+fun HttpUrl.endsWith(path: String): Boolean = this.pathSegments.joinToString("/").endsWith(path.trimPath())
+
+private fun String.trimPath() = removePrefix("/").removeSuffix("/")
+
 private fun HttpUrl.withoutQuery(): HttpUrl = this.newBuilder().query(null).build()
 
 private fun HttpUrl.resolvePath(path: String): HttpUrl {
-
     return HttpUrl.Builder()
         .scheme(this.scheme)
         .host(this.host)

src/main/kotlin/no/nav/security/mock/oauth2/extensions/RecordedRequestExtensions.kt

@@ -5,4 +5,3 @@ import okhttp3.mockwebserver.RecordedRequest
 
 fun RecordedRequest.asOAuth2HttpRequest(): OAuth2HttpRequest =
     OAuth2HttpRequest(this.headers, checkNotNull(this.method), checkNotNull(this.requestUrl), this.body.copy().readUtf8())
-

src/main/kotlin/no/nav/security/mock/oauth2/http/OAuth2HttpRouter.kt

@@ -0,0 +1,59 @@
+package no.nav.security.mock.oauth2.http
+
+import mu.KotlinLogging
+import no.nav.security.mock.oauth2.extensions.endsWith
+
+private val log = KotlinLogging.logger { }
+
+typealias RequestHandler = (OAuth2HttpRequest) -> OAuth2HttpResponse
+
+interface Route : RequestHandler {
+    fun match(request: OAuth2HttpRequest): Boolean
+}
+
+class OAuth2HttpRouter(
+    private val routes: MutableList<Route> = mutableListOf()
+) : RequestHandler {
+
+    var notFoundHandler: (OAuth2HttpRequest) -> OAuth2HttpResponse = { OAuth2HttpResponse(status = 404, body = "no route found") }
+
+    override fun invoke(request: OAuth2HttpRequest): OAuth2HttpResponse = match(request)
+
+    private fun match(request: OAuth2HttpRequest): OAuth2HttpResponse =
+        routes.also {
+            log.debug("attempt to route request with url=${request.url}")
+        }.firstOrNull {
+            it.match(request)
+        }?.invoke(request)
+            ?: notFoundHandler.invoke(request)
+                .also { log.debug("no handler found, using notFoundHandler") }
+
+    companion object {
+        fun routes(vararg route: Route): OAuth2HttpRouter = OAuth2HttpRouter(mutableListOf(*route))
+    }
+}
+
+@JvmOverloads
+fun route(path: String, method: String? = null, requestHandler: RequestHandler): Route =
+    routeFromPathAndMethod(path, method, requestHandler)
+
+fun put(path: String, requestHandler: RequestHandler): Route =
+    routeFromPathAndMethod(path, "PUT", requestHandler)
+
+fun post(path: String, requestHandler: RequestHandler): Route =
+    routeFromPathAndMethod(path, "POST", requestHandler)
+
+fun get(path: String, requestHandler: RequestHandler): Route =
+    routeFromPathAndMethod(path, "GET", requestHandler)
+
+private fun routeFromPathAndMethod(path: String, method: String? = null, requestHandler: RequestHandler): Route =
+    object : Route {
+        override fun match(request: OAuth2HttpRequest): Boolean =
+            if (request.url.endsWith(path)) {
+                method?.let { it == request.method } ?: true
+            } else {
+                false
+            }
+
+        override fun invoke(request: OAuth2HttpRequest): OAuth2HttpResponse = requestHandler.invoke(request)
+    }