OCTOPUS-345 Add end-point to get version names (#17)

octopusden · Sep 20, 2023 · 0763230 · 0763230
1 parent 02a14ed
commit 0763230
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 0 deletions.
diff --git a/...tlin/org/octopusden/octopus/components/registry/client/ComponentsRegistryServiceClient.kt b/...tlin/org/octopusden/octopus/components/registry/client/ComponentsRegistryServiceClient.kt
@@ -95,6 +95,9 @@ interface ComponentsRegistryServiceClient {
     @RequestLine("GET rest/api/2/common/supported-groups")
     fun getSupportedGroupIds(): Set<String>
 
+    @RequestLine("GET rest/api/2/common/version-names")
+    fun getVersionNames(): Map<String, String>
+
     @RequestLine("GET rest/api/2/components-registry/service/status")
     fun getServiceStatus(): ServiceStatusDTO
 

diff --git a/...opusden/octopus/components/registry/client/impl/ClassicComponentsRegistryServiceClient.kt b/...opusden/octopus/components/registry/client/impl/ClassicComponentsRegistryServiceClient.kt
@@ -91,6 +91,9 @@ class ClassicComponentsRegistryServiceClient(
     override fun getSupportedGroupIds(): Set<String> =
         client.getSupportedGroupIds()
 
+    override fun getVersionNames(): Map<String, String> =
+        client.getVersionNames()
+
     override fun getServiceStatus(): ServiceStatusDTO =
         client.getServiceStatus()
 

diff --git a/...n/org/octopusden/octopus/components/registry/client/ComponentRegistryServiceClientTest.kt b/...n/org/octopusden/octopus/components/registry/client/ComponentRegistryServiceClientTest.kt
@@ -104,6 +104,8 @@ class ComponentRegistryServiceClientTest : BaseComponentsRegistryServiceTest() {
 
     override fun getSupportedGroupIds(): Set<String> = componentsRegistryClient.getSupportedGroupIds()
 
+    override fun getVersionNames(): Map<String, String> = componentsRegistryClient.getVersionNames()
+
     override fun getDependencyAliasToComponentMapping(): Map<String, String> =
         componentsRegistryClient.getDependencyAliasToComponentMapping()
 

diff --git a/...kotlin/org/octopusden/octopus/components/registry/server/controller/CommonControllerV2.kt b/...kotlin/org/octopusden/octopus/components/registry/server/controller/CommonControllerV2.kt
@@ -34,4 +34,13 @@ class CommonControllerV2(
     fun getSupportedGroupIds(): Set<String> {
         return configHelper.supportedGroupIds().toSet()
     }
+
+    @GetMapping("version-names", produces = [MediaType.APPLICATION_JSON_VALUE])
+    fun getVersionNames(): Map<String, String> {
+        return mapOf(
+            "service-branch" to configHelper.serviceBranch(),
+            "service" to configHelper.service(),
+            "minor" to configHelper.minor(),
+        )
+    }
 }
diff --git a/.../octopusden/octopus/components/registry/server/ComponentsRegistryServiceControllerTest.kt b/.../octopusden/octopus/components/registry/server/ComponentsRegistryServiceControllerTest.kt
@@ -62,6 +62,16 @@ class ComponentsRegistryServiceControllerTest : BaseComponentsRegistryServiceTes
             .response
             .toObject(object : TypeReference<Set<String>>() {})
 
+    override fun getVersionNames(): Map<String, String> =
+        mvc.perform(
+            MockMvcRequestBuilders.get(URI.create("/rest/api/2/common/version-names"))
+                .accept(APPLICATION_JSON)
+        )
+            .andExpect(status().isOk)
+            .andReturn()
+            .response
+            .toObject(object : TypeReference<Map<String, String>>() {})
+
     override fun getDependencyAliasToComponentMapping() =
         mvc.perform(
             MockMvcRequestBuilders.get(URI.create("/rest/api/2/common/dependency-aliases"))

diff --git a/...tlin/org/octopusden/octopus/components/registry/test/BaseComponentsRegistryServiceTest.kt b/...tlin/org/octopusden/octopus/components/registry/test/BaseComponentsRegistryServiceTest.kt
@@ -87,6 +87,7 @@ abstract class BaseComponentsRegistryServiceTest {
     //common
     protected abstract fun getAllJiraComponentVersionRanges(): Collection<JiraComponentVersionRangeDTO>
     protected abstract fun getSupportedGroupIds(): Set<String>
+    abstract fun getVersionNames(): Map<String, String>
     protected abstract fun getDependencyAliasToComponentMapping(): Map<String, String>
 
     protected abstract fun getComponentV1(component: String): ComponentV1
@@ -133,6 +134,15 @@ abstract class BaseComponentsRegistryServiceTest {
         Assertions.assertEquals(Arrays.asList("org.octopusden.octopus", "io.bcomponent").sorted(), getSupportedGroupIds().sorted())
     }
 
+    @Test
+    fun testVersionNames() {
+        val map = getVersionNames()
+        Assertions.assertEquals(3, map.size)
+        Assertions.assertEquals("serviceCBranch", map["service-branch"])
+        Assertions.assertEquals("serviceC", map["service"])
+        Assertions.assertEquals("minorC", map["minor"])
+    }
+
     @Test
     fun testGetDependencyAliasToComponentMapping() {
         Assertions.assertEquals(