Merge pull request #79 from craigatk/version

(feature) Adding endpoint that shows application version

.github/workflows/release-server.yml

@@ -57,7 +57,7 @@ jobs:
           CACHE_ACCESS_KEY: ${{ secrets.CACHE_ACCESS_KEY }}
           CACHE_SECRET_KEY: ${{ secrets.CACHE_SECRET_KEY }}
         run: |
-          ./gradlew :server:server-app:assembleFull
+          ./gradlew :server:server-app:assembleFull -PreleaseVersion=${{ env.RELEASE_VERSION }}
       - name: cypress-common install
         run: |
           cd cypress-common

server/server-app/.gitignore

@@ -1,3 +1,4 @@
 src/main/resources/static
+src/main/resources/version.json
 
 .kotlintest

server/server-app/build.gradle

@@ -76,6 +76,21 @@ task copyUI(type: Copy, dependsOn: ['cleanStaticResources', ':ui:assemble']) {
 processResources.mustRunAfter(copyUI)
 shadowJar.mustRunAfter(copyUI)
 
+task writeVersion() {
+    String projectVersion = findProperty("releaseVersion") ?: version
+
+    inputs.property("projectVersion", projectVersion)
+    outputs.file("src/main/resources/version.json")
+    outputs.cacheIf { true }
+
+    doLast {
+        new File("$projectDir/src/main/resources/version.json").text = """{
+  "version": "$projectVersion"
+}"""
+    }
+}
+processResources.dependsOn(writeVersion)
+
 runShadow.dependsOn(copyUI)
 
 task assembleFull(dependsOn: ['copyUI', 'shadowJar'])

server/server-app/src/main/kotlin/projektor/Application.kt

@@ -135,6 +135,7 @@ fun Application.main() {
         testRuns(testRunService)
         testRunSystemAttributes(testRunSystemAttributesService)
         ui()
+        version()
     }
 }
 

server/server-app/src/main/kotlin/projektor/route/VersionRoutes.kt

@@ -0,0 +1,11 @@
+package projektor.route
+
+import io.ktor.http.content.defaultResource
+import io.ktor.http.content.static
+import io.ktor.routing.Route
+
+fun Route.version() {
+    static("/version") {
+        defaultResource("version.json", "/")
+    }
+}

server/server-app/src/test/kotlin/projektor/version/VersionApplicationTest.kt

@@ -0,0 +1,27 @@
+package projektor.version
+
+import io.ktor.http.HttpMethod
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.testing.handleRequest
+import io.ktor.server.testing.withTestApplication
+import io.ktor.util.KtorExperimentalAPI
+import org.junit.jupiter.api.Test
+import projektor.ApplicationTestCase
+import strikt.api.expectThat
+import strikt.assertions.contains
+import strikt.assertions.isEqualTo
+import strikt.assertions.isNotNull
+
+@KtorExperimentalAPI
+class VersionApplicationTest : ApplicationTestCase() {
+    @Test
+    fun `should provide version endpoint`() {
+        withTestApplication(::createTestApplication) {
+            handleRequest(HttpMethod.Get, "/version").apply {
+                expectThat(response.status()).isEqualTo(HttpStatusCode.OK)
+
+                expectThat(response.content).isNotNull().and { contains("version") }
+            }
+        }
+    }
+}