Simplified and polished mock webserver code. (#404)

Author: EranBoudjnah

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/rule/WebServerRule.kt

@@ -1,30 +1,27 @@
 package com.mitteloupe.whoami.test.rule
 
 import com.mitteloupe.whoami.test.annotation.ServerRequestResponse
-import com.mitteloupe.whoami.test.server.ResponseDispatcher
+import com.mitteloupe.whoami.test.server.ResponseBinder
 import com.mitteloupe.whoami.test.server.ResponseStore
 import org.junit.rules.TestRule
 import org.junit.runner.Description
 import org.junit.runners.model.Statement
 
 class WebServerRule(
-    private val lazyMockDispatchers: Lazy<Collection<ResponseDispatcher>>,
-    private val lazyResponseStore: Lazy<ResponseStore>,
-    private val mockWebServerUrlProvider: () -> String = { "" }
+    private val lazyMockDispatchers: Lazy<Collection<ResponseBinder>>,
+    private val lazyResponseStore: Lazy<ResponseStore>
 ) : TestRule {
     override fun apply(base: Statement, description: Description): Statement =
         WebServerInitializationStatement(
             lazyMockDispatchers,
             lazyResponseStore,
-            mockWebServerUrlProvider,
             base,
             description
         )
 
     private class WebServerInitializationStatement(
-        private val lazyMockDispatchers: Lazy<Collection<ResponseDispatcher>>,
+        private val lazyMockDispatchers: Lazy<Collection<ResponseBinder>>,
         private val lazyResponseStore: Lazy<ResponseStore>,
-        private val mockWebServerUrlProvider: () -> String = { "" },
         private val base: Statement,
         private val description: Description
     ) : Statement() {
@@ -42,7 +39,7 @@ class WebServerRule(
 
             mockDispatchers.forEach { dispatcher ->
                 requestResponses.forEach { requestResponse ->
-                    dispatcher.addResponse(requestResponse.request, requestResponse.response)
+                    dispatcher.bindResponse(requestResponse.request, requestResponse.response)
                 }
             }
             val stubbedResponseKeys = requestResponses.map { requestResponse ->
@@ -52,7 +49,7 @@ class WebServerRule(
             base.evaluate()
 
             val usedResponseKeys = mockDispatchers.flatMap { dispatcher ->
-                dispatcher.usedResponseKeys
+                dispatcher.usedEndpoints
             }.toSet()
 
             val unusedResponseKeys = stubbedResponseKeys - usedResponseKeys
@@ -61,7 +58,7 @@ class WebServerRule(
                     unusedResponseKeys.joinToString("]\n[") + "]"
             }
 
-            mockDispatchers.forEach(ResponseDispatcher::reset)
+            mockDispatchers.forEach(ResponseBinder::reset)
         }
 
         private fun Description.requestResponseIds() =

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/MockDispatcher.kt

@@ -11,8 +11,8 @@ import okhttp3.mockwebserver.RecordedRequest
 
 class MockDispatcher :
     Dispatcher(),
-    ResponseDispatcher {
-    override val usedResponseKeys: Set<String>
+    ResponseBinder {
+    override val usedEndpoints: Set<String>
         field = mutableSetOf<String>()
 
     private val responses = mutableMapOf<String, MockResponseContents>()
@@ -21,18 +21,18 @@ class MockDispatcher :
 
     override var onWebSocketMessage: (String) -> Unit = {}
 
-    override fun reset() {
-        responses.clear()
-        usedResponseKeys.clear()
+    override fun bindResponse(request: MockRequest, response: MockResponseContents) {
+        responses[request.url] = response
     }
 
-    override fun addResponse(request: MockRequest, response: MockResponseContents) {
-        responses[request.url] = response
+    override fun reset() {
+        responses.clear()
+        usedEndpoints.clear()
     }
 
     override fun dispatch(request: RecordedRequest): MockResponse {
         val endPoint = request.path!!.substringBefore("?")
-        usedResponseKeys.add(endPoint)
+        usedEndpoints.add(endPoint)
         val response = responses[endPoint]?.mockResponse(this) ?: ServerResponse(code = 404)
         return if (response.upgradeToWebSocket) {
             MockResponse().withWebSocketUpgrade(
@@ -51,7 +51,7 @@ class MockDispatcher :
                 }
             )
         } else {
-            return MockResponse().apply {
+            MockResponse().apply {
                 headers = Headers.headersOf(*response.headers.toArray())
             }.setResponseCode(response.code)
                 .setBody(response.body)

…whoami/test/server/ResponseDispatcher.kt …upe/whoami/test/server/ResponseBinder.ktarchitecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/ResponseDispatcher.kt renamed to architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/ResponseBinder.kt architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/ResponseDispatcher.kt renamed to architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/ResponseBinder.kt

@@ -2,12 +2,12 @@ package com.mitteloupe.whoami.test.server
 
 import com.mitteloupe.whoami.test.server.response.MockResponseContents
 
-interface ResponseDispatcher {
+interface ResponseBinder {
     var onWebSocketMessage: (String) -> Unit
 
-    fun reset()
+    val usedEndpoints: Set<String>
 
-    fun addResponse(request: MockRequest, response: MockResponseContents)
+    fun bindResponse(request: MockRequest, response: MockResponseContents)
 
-    val usedResponseKeys: Set<String>
+    fun reset()
 }

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/response/ErrorResponse.kt

@@ -1,11 +1,11 @@
 package com.mitteloupe.whoami.test.server.response
 
-import com.mitteloupe.whoami.test.server.ResponseDispatcher
+import com.mitteloupe.whoami.test.server.ResponseBinder
 import com.mitteloupe.whoami.test.server.ServerResponse
 
 sealed class ErrorResponse {
     object NotFound : MockResponseContents {
-        override fun mockResponse(responseDispatcher: ResponseDispatcher) = ServerResponse(
+        override fun mockResponse(responseBinder: ResponseBinder) = ServerResponse(
             code = 404
         )
     }

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/response/MockResponseContents.kt

@@ -1,8 +1,8 @@
 package com.mitteloupe.whoami.test.server.response
 
-import com.mitteloupe.whoami.test.server.ResponseDispatcher
+import com.mitteloupe.whoami.test.server.ResponseBinder
 import com.mitteloupe.whoami.test.server.ServerResponse
 
 interface MockResponseContents {
-    fun mockResponse(responseDispatcher: ResponseDispatcher): ServerResponse
+    fun mockResponse(responseBinder: ResponseBinder): ServerResponse
 }

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/response/SequenceResponse.kt

@@ -1,17 +1,17 @@
 package com.mitteloupe.whoami.test.server.response
 
-import com.mitteloupe.whoami.test.server.ResponseDispatcher
+import com.mitteloupe.whoami.test.server.ResponseBinder
 import com.mitteloupe.whoami.test.server.ServerResponse
 
 class SequenceResponse(private vararg val mockResponses: MockResponseContents) :
     MockResponseContents {
     private var responseIndex = 0
-    override fun mockResponse(responseDispatcher: ResponseDispatcher): ServerResponse {
+    override fun mockResponse(responseBinder: ResponseBinder): ServerResponse {
         val mockResponse = mockResponses[responseIndex]
         responseIndex++
         if (responseIndex == mockResponses.size) {
             responseIndex = 0
         }
-        return mockResponse.mockResponse(responseDispatcher)
+        return mockResponse.mockResponse(responseBinder)
     }
 }

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/server/response/SimpleResponse.kt

@@ -1,7 +1,7 @@
 package com.mitteloupe.whoami.test.server.response
 
 import com.mitteloupe.whoami.test.asset.assetReader
-import com.mitteloupe.whoami.test.server.ResponseDispatcher
+import com.mitteloupe.whoami.test.server.ResponseBinder
 import com.mitteloupe.whoami.test.server.ServerResponse
 
 data class SimpleResponse(
@@ -18,7 +18,7 @@ data class SimpleResponse(
         }
     }
 
-    override fun mockResponse(responseDispatcher: ResponseDispatcher) = ServerResponse(
+    override fun mockResponse(responseBinder: ResponseBinder) = ServerResponse(
         code = responseCode,
         headers = headers,
         body = responseBody

architecture/instrumentation-test/src/main/java/com/mitteloupe/whoami/test/test/BaseTest.kt

@@ -62,7 +62,7 @@ abstract class BaseTest {
     private val webServerRule = WebServerRule(
         lazy { listOf(mockDispatcher) },
         lazy { responseStore }
-    ) { mockWebServerProvider.serverUrl }
+    )
 
     private val localStoreRule = LocalStoreRule(
         lazy { sharedPreferences },