Adding a GET /config route to expose the current configuration.

jameskbride · Jun 20, 2024 · 819f176 · 819f176
1 parent cae29b6
commit 819f176
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 18 deletions.
diff --git a/src/main/kotlin/com/jameskbride/localsns/Main.kt b/src/main/kotlin/com/jameskbride/localsns/Main.kt
@@ -1,13 +1,10 @@
 package com.jameskbride.localsns
 
-import com.fasterxml.jackson.module.kotlin.registerKotlinModule
 import com.jameskbride.localsns.models.Configuration
 import com.typesafe.config.ConfigFactory
 import io.vertx.core.AsyncResult
 import io.vertx.core.Vertx
 import io.vertx.core.buffer.Buffer
-import io.vertx.core.json.JsonObject
-import io.vertx.core.json.jackson.DatabindCodec
 import org.apache.camel.impl.DefaultCamelContext
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
@@ -22,7 +19,12 @@ class Main {
         fun main(args: Array<String>) {
             configureObjectMappers()
             val config = ConfigFactory.load()
-            logger.info("Starting local-sns-${config.getValue("version").unwrapped()}")
+            val version = config.getValue("version").unwrapped()
+            logger.info("Starting local-sns-$version")
+            val httpInterface = getHttpInterface(config)
+            val port = getPort(config)
+            logger.info("Health endpoint: http://$httpInterface:$port/health")
+            logger.info("Configuration endpoint: http://${httpInterface}:$port/config")
             val vertx = Vertx.vertx()
             val dbPath = getDbPath(config)
             vertx.fileSystem()
@@ -72,18 +74,10 @@ class Main {
 
         private fun readConfiguration(result: AsyncResult<Buffer>): Configuration {
             val configFile = result.result()
-            val jsonConfig = JsonObject(configFile)
+            val jsonConfig = toJsonConfig(configFile)
             logger.info("Loading configuration: $jsonConfig")
 
             return jsonConfig.mapTo(Configuration::class.java)
         }
-
-        private fun configureObjectMappers() {
-            val mapper = DatabindCodec.mapper()
-            mapper.registerKotlinModule()
-
-            val prettyMapper = DatabindCodec.prettyMapper()
-            prettyMapper.registerKotlinModule()
-        }
     }
 }
diff --git a/src/main/kotlin/com/jameskbride/localsns/routes/configRoute.kt b/src/main/kotlin/com/jameskbride/localsns/routes/configRoute.kt
@@ -0,0 +1,19 @@
+package com.jameskbride.localsns.routes
+
+import com.jameskbride.localsns.getDbOutputPath
+import com.jameskbride.localsns.toJsonConfig
+import com.typesafe.config.ConfigFactory
+import io.vertx.core.Vertx
+import io.vertx.ext.web.RoutingContext
+
+val configRoute: (RoutingContext) -> Unit = { ctx: RoutingContext ->
+    val config = ConfigFactory.load()
+    val vertx = Vertx.vertx()
+    val dbPath = getDbOutputPath(config)
+    val dbFile = vertx.fileSystem().readFileBlocking(dbPath)
+    val configuration = toJsonConfig(dbFile)
+    ctx.request().response()
+        .setStatusCode(200)
+        .putHeader("context-type", "application/json")
+        .end(configuration.toString())
+}
diff --git a/src/main/kotlin/com/jameskbride/localsns/utils.kt b/src/main/kotlin/com/jameskbride/localsns/utils.kt
@@ -1,9 +1,13 @@
 package com.jameskbride.localsns
 
+import com.fasterxml.jackson.module.kotlin.registerKotlinModule
 import com.jameskbride.localsns.models.Subscription
 import com.jameskbride.localsns.models.Topic
 import com.typesafe.config.Config
 import io.vertx.core.Vertx
+import io.vertx.core.buffer.Buffer
+import io.vertx.core.json.JsonObject
+import io.vertx.core.json.jackson.DatabindCodec
 import io.vertx.core.shareddata.LocalMap
 import io.vertx.ext.web.RoutingContext
 import org.apache.logging.log4j.Logger
@@ -19,12 +23,27 @@ fun getDbPath(config: Config): String? =
 fun getDbOutputPath(config: Config): String =
     System.getenv("DB_OUTPUT_PATH") ?: config.getString("db.outputPath")
 
+fun toJsonConfig(configFile: Buffer?) = JsonObject(configFile)
+
 fun getAwsAccountId(config: Config): String =
     System.getenv("AWS_ACCOUNT_ID") ?: config.getString("aws.accountId")
 
 fun getAwsRegion(config: Config): String =
     System.getenv("AWS_DEFAULT_REGION") ?: config.getString("aws.region")
 
+fun getPort(config: Config): Int {
+    val httpPortEnv = System.getenv("HTTP_PORT")
+    val port = if (httpPortEnv !== null) {
+        Integer.parseInt(httpPortEnv)
+    } else {
+        config.getInt("http.port")
+    }
+    return port
+}
+
+fun getHttpInterface(config: Config): String? =
+    System.getenv("HTTP_INTERFACE") ?: config.getString("http.interface")
+
 fun getTopicsMap(vertx: Vertx): LocalMap<String, Topic>? =
     vertx.sharedData().getLocalMap("topics")
 
@@ -51,3 +70,11 @@ fun getFormAttribute(
     ctx: RoutingContext,
     attribute: String
 ): String? = ctx.request().getFormAttribute(attribute)
+
+fun configureObjectMappers() {
+    val mapper = DatabindCodec.mapper()
+    mapper.registerKotlinModule()
+
+    val prettyMapper = DatabindCodec.prettyMapper()
+    prettyMapper.registerKotlinModule()
+}
diff --git a/src/main/kotlin/com/jameskbride/localsns/verticles/MainVerticle.kt b/src/main/kotlin/com/jameskbride/localsns/verticles/MainVerticle.kt
@@ -1,5 +1,8 @@
 package com.jameskbride.localsns.verticles
 
+import com.jameskbride.localsns.getHttpInterface
+import com.jameskbride.localsns.getPort
+import com.jameskbride.localsns.routes.configRoute
 import com.jameskbride.localsns.routes.getRoute
 import com.jameskbride.localsns.routes.healthRoute
 import com.typesafe.config.ConfigFactory
@@ -21,13 +24,11 @@ class MainVerticle : AbstractVerticle() {
     router.route().handler(BodyHandler.create())
     router.route("/").handler(getRoute)
     router.route("/health").handler(healthRoute)
+    router.route("/config").handler(configRoute)
 
     val config = ConfigFactory.load()
-    val httpInterface = System.getenv("HTTP_INTERFACE") ?: config.getString("http.interface")
-    val httpPortEnv = System.getenv("HTTP_PORT")
-    val port = if (httpPortEnv !== null) {
-      Integer.parseInt(httpPortEnv)
-    } else { config.getInt("http.port") }
+    val httpInterface = getHttpInterface(config)
+    val port = getPort(config)
 
     val socketAddress = inetSocketAddress(port, httpInterface)
 

diff --git a/src/test/kotlin/com/jameskbride/localsns/BaseTest.kt b/src/test/kotlin/com/jameskbride/localsns/BaseTest.kt
@@ -3,6 +3,7 @@ package com.jameskbride.localsns
 import com.jameskbride.localsns.models.Topic
 import com.typesafe.config.ConfigFactory
 import khttp.post
+import khttp.get
 import khttp.responses.Response
 import org.jsoup.Jsoup
 import org.jsoup.nodes.Element
@@ -23,6 +24,11 @@ open class BaseTest {
         }
     }
 
+    fun getCurrentConfig(): Response {
+        val baseUrl = getBaseUrl()
+        return get("$baseUrl/config")
+    }
+
     protected fun createValidArn(resourceName: String) =
         "arn:aws:sns:us-east-1:123456789012:${resourceName}"
 

diff --git a/src/test/kotlin/com/jameskbride/localsns/ConfigRouteTest.kt b/src/test/kotlin/com/jameskbride/localsns/ConfigRouteTest.kt
@@ -0,0 +1,39 @@
+package com.jameskbride.localsns;
+
+import com.jameskbride.localsns.models.Configuration
+import com.jameskbride.localsns.verticles.MainVerticle
+import io.vertx.core.Vertx
+import io.vertx.junit5.VertxExtension
+import io.vertx.junit5.VertxTestContext
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+
+@ExtendWith(VertxExtension::class)
+class ConfigRouteTest: BaseTest() {
+
+    @BeforeEach
+    fun setup(vertx:Vertx, testContext:VertxTestContext) {
+        configureObjectMappers()
+        vertx.deployVerticle(MainVerticle(), testContext.succeeding { _ -> testContext.completeNow() })
+    }
+
+    @Test
+    fun `it returns the configuration`(testContext:VertxTestContext) {
+        val response = getCurrentConfig()
+
+        assertEquals(200, response.statusCode)
+        val text = response.text
+        val jsonConfig = io.vertx.core.json.JsonObject(text)
+        assertTrue(jsonConfig.containsKey("topics"))
+        assertTrue(jsonConfig.containsKey("subscriptions"))
+        assertTrue(jsonConfig.containsKey("timestamp"))
+        assertTrue(jsonConfig.containsKey("version"))
+
+        jsonConfig.mapTo(Configuration::class.java)
+
+        testContext.completeNow()
+    }
+}