Implement ConfigController to return authorisation list

Author: Bingjie Liu

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/config/AuthorisationConfig.kt

@@ -0,0 +1,12 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.config
+
+import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.context.annotation.Configuration
+import org.springframework.stereotype.Component
+
+@Configuration
+@Component
+@ConfigurationProperties(prefix = "authorisation")
+class AuthorisationConfig {
+  var consumers: Map<String, List<String>> = emptyMap()
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/ConfigController.kt

@@ -0,0 +1,19 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.config.AuthorisationConfig
+
+@RestController
+@EnableConfigurationProperties(AuthorisationConfig::class)
+@RequestMapping("/v1/config")
+class ConfigController(
+  var authorisationConfig: AuthorisationConfig,
+) {
+  @GetMapping("authorisation")
+  fun getImage(): Map<String, List<String>> {
+    return authorisationConfig.consumers
+  }
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/AuthorisationFilter.kt

@@ -7,17 +7,20 @@ import jakarta.servlet.ServletRequest
 import jakarta.servlet.ServletResponse
 import jakarta.servlet.http.HttpServletRequest
 import jakarta.servlet.http.HttpServletResponse
-import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.core.annotation.Order
 import org.springframework.stereotype.Component
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.config.AuthorisationConfig
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuthoriseConsumerService
 import java.io.IOException
 
 @Component
 @Order(1)
-@ConfigurationProperties(prefix = "authorisation")
+@EnableConfigurationProperties(AuthorisationConfig::class)
 class AuthorisationFilter : Filter {
-  var consumers: Map<String, List<String>> = emptyMap()
+  @Autowired
+  lateinit var authorisationConfig: AuthorisationConfig
 
   @Throws(IOException::class, ServletException::class)
   override fun doFilter(
@@ -36,7 +39,7 @@ class AuthorisationFilter : Filter {
       return
     }
 
-    val result = authoriseConsumerService.execute(subjectDistinguishedName, consumers, requestedPath)
+    val result = authoriseConsumerService.execute(subjectDistinguishedName, authorisationConfig.consumers, requestedPath)
 
     if (!result) {
       res.sendError(HttpServletResponse.SC_FORBIDDEN, "Unable to authorise $requestedPath for $subjectDistinguishedName")

src/main/resources/application-dev.yml

@@ -63,3 +63,5 @@ authorisation:
       - "/v1/persons/.*/risks"
       - "/v1/persons/.*/licences/conditions"
       - "/v1/persons/.*/person-responsible-officer"
+    event-service:
+      - "/v1/config/authorisation"

src/main/resources/application-local.yml

@@ -53,3 +53,5 @@ authorisation:
       - "/health/readiness"
       - "/health/liveness"
       - "/info"
+    config-test:
+      - "/v1/config/authorisation"

src/main/resources/application-preprod.yml

@@ -33,3 +33,5 @@ authorisation:
     kubernetes-health-check-client:
       - "/health/liveness"
       - "/health/readiness"
+    event-service:
+      - "/v1/config/authorisation"

src/main/resources/application-prod.yml

@@ -31,3 +31,5 @@ authorisation:
     kubernetes-health-check-client:
       - "/health/liveness"
       - "/health/readiness"
+    event-service:
+      - "/v1/config/authorisation"

src/main/resources/application-test.yml

@@ -63,3 +63,6 @@ authorisation:
       - "/health/readiness"
       - "/health/liveness"
       - "/info"
+    config-test:
+      - "/v1/config/authorisation"
+

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/ConfigControllerTests.kt

@@ -0,0 +1,32 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.module.kotlin.readValue
+import io.kotest.matchers.collections.shouldContainOnly
+import io.kotest.matchers.maps.shouldHaveKeys
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
+import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.web.servlet.MockMvc
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIMockMvc
+
+@WebMvcTest(controllers = [ConfigController::class])
+@ActiveProfiles("test")
+class ConfigControllerTests(
+  @Autowired var springMockMvc: MockMvc,
+) {
+  private val basePath = "/v1/config/authorisation"
+  private val mockMvc = IntegrationAPIMockMvc(springMockMvc)
+  private val objectMapper = ObjectMapper()
+
+  @Test
+  fun `will return authorise config based on application yml`() {
+    val result = mockMvc.performAuthorisedWithCN(basePath, "config-test")
+
+    val actualConfig: Map<String, List<String>> = objectMapper.readValue(result.response.contentAsString)
+    actualConfig.shouldHaveKeys("automated-test-client")
+    actualConfig.shouldHaveKeys("config-test")
+    actualConfig["config-test"].shouldContainOnly("/v1/config/authorisation")
+  }
+}

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/helpers/IntegrationAPIHttpClient.kt

@@ -9,8 +9,11 @@ class IntegrationAPIHttpClient(
   val httpClient: HttpClient = HttpClient.newBuilder().build(),
   val baseUrl: String = "http://localhost:8080",
 ) {
-  fun performAuthorised(path: String): HttpResponse<String> {
-    val subjectDistinguishedName = "C=GB,ST=London,L=London,O=Home Office,CN=automated-test-client"
+  fun performAuthorised(
+    path: String,
+    cn: String = "automated-test-client",
+  ): HttpResponse<String> {
+    val subjectDistinguishedName = "C=GB,ST=London,L=London,O=Home Office,CN=$cn"
 
     val httpRequest =
       HttpRequest

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/helpers/IntegrationAPIMockMvc.kt

@@ -15,6 +15,14 @@ class IntegrationAPIMockMvc(
     return mockMvc.perform(MockMvcRequestBuilders.get(path).header("subject-distinguished-name", subjectDistinguishedName)).andReturn()
   }
 
+  fun performAuthorisedWithCN(
+    path: String,
+    cn: String,
+  ): MvcResult {
+    val subjectDistinguishedName = "C=GB,ST=London,L=London,O=Home Office,CN=$cn"
+    return mockMvc.perform(MockMvcRequestBuilders.get(path).header("subject-distinguished-name", subjectDistinguishedName)).andReturn()
+  }
+
   fun performUnAuthorised(path: String): MvcResult {
     return mockMvc.perform(MockMvcRequestBuilders.get(path)).andReturn()
   }

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/smoke/AuthoriseConfigTest.kt

@@ -0,0 +1,53 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.smoke
+
+import io.kotest.assertions.json.shouldEqualJson
+import io.kotest.core.spec.style.DescribeSpec
+import io.kotest.matchers.shouldBe
+import org.springframework.http.HttpStatus
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIHttpClient
+
+class AuthoriseConfigTest : DescribeSpec(
+  {
+    val httpClient = IntegrationAPIHttpClient()
+
+    it("returns authorise config") {
+
+      val response = httpClient.performAuthorised("v1/config/authorisation", "config-test")
+
+      response.statusCode().shouldBe(HttpStatus.OK.value())
+      response.body().shouldEqualJson(
+        """
+      {
+      "automated-test-client": [
+        "/v1/persons",
+        "/v1/persons/.*",
+        "/v1/persons/.*/images",
+        "/v1/images/.*",
+        "/v1/persons/.*/addresses",
+        "/v1/persons/.*/offences",
+        "/v1/persons/.*/alerts",
+        "/v1/persons/.*/sentences",
+        "/v1/persons/.*/sentences/latest-key-dates-and-adjustments",
+        "/v1/persons/.*/risks/scores",
+        "/v1/persons/.*/needs",
+        "/v1/persons/.*/risks",
+        "/v1/persons/.*/reported-adjudications",
+        "/v1/persons/.*/case-notes",
+        "/v1/persons/.*/person-responsible-officer",
+        "/v1/epf/person-details/.*/.*",
+        "/health",
+        "/health/ping",
+        "/health/readiness",
+        "/health/liveness",
+        "/info"
+      ],
+      "config-test": [
+        "/v1/config/authorisation"
+      ]
+    }
+      """.removeWhitespaceAndNewlines(),
+      )
+    }
+  },
+)