Add test for empty list of prisons has no access.

Author: ben-madley-mt

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

@@ -54,7 +54,7 @@ class PrisonController(
   )
   fun getPerson(
     @PathVariable hmppsId: String,
-    @RequestAttribute filters: ConsumerFilters?
+    @RequestAttribute filters: ConsumerFilters?,
   ): DataResponse<Person?> {
     val response = getPersonService.getPrisoner(hmppsId, filters)
 

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/roleconfig/ConsumerFilters.kt

@@ -1,13 +1,14 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.roleconfig
 
 data class ConsumerFilters(
-  val prisons: List<String>?
+  val prisons: List<String>?,
 ) {
-  fun matchesPrison(
-    prisonId: String?,
-  ): Boolean = matchesFilterList(prisons, prisonId)
+  fun matchesPrison(prisonId: String?): Boolean = matchesFilterList(prisons, prisonId)
 
-  private fun matchesFilterList(filterList: List<String>?, value: String?): Boolean {
+  private fun matchesFilterList(
+    filterList: List<String>?,
+    value: String?,
+  ): Boolean {
     if (filterList == null) {
       return true
     }

src/main/resources/application-integration-test.yml

@@ -99,4 +99,8 @@ authorisation:
       filters:
         prisons:
           - ABC
-# TODO: Some sort of test that prisons: with no list blocks all prisons
+    no-prisons:
+      include:
+        - "/v1/prison/prisoners/[^/]*$"
+      filters:
+        prisons:

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

@@ -3,7 +3,6 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1.prison
 import io.kotest.core.spec.style.DescribeSpec
 import io.kotest.matchers.shouldBe
 import org.mockito.Mockito
-import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.eq
 import org.mockito.kotlin.times

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/FiltersExtractionFilterTest.kt

@@ -43,7 +43,7 @@ class FiltersExtractionFilterTest {
     val mockResponse = mock(HttpServletResponse::class.java)
     val mockChain = mock(FilterChain::class.java)
 
-    val expectedFilters = ConsumerFilters(prisons=listOf("filter-1", "filter-2"))
+    val expectedFilters = ConsumerFilters(prisons = listOf("filter-1", "filter-2"))
     authorisationConfig.consumers = mapOf("consumer-name" to ConsumerConfig(include = null, filters = expectedFilters))
 
     // Act
@@ -62,7 +62,7 @@ class FiltersExtractionFilterTest {
     val mockResponse = mock(HttpServletResponse::class.java)
     val mockChain = mock(FilterChain::class.java)
 
-    val expectedFilters = ConsumerFilters(prisons=listOf("filter-1", "filter-2"))
+    val expectedFilters = ConsumerFilters(prisons = listOf("filter-1", "filter-2"))
     authorisationConfig.consumers = mapOf("consumer-name" to ConsumerConfig(include = null, filters = expectedFilters))
 
     // Act

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/prison/PrisonIntegrationTest.kt

@@ -31,6 +31,16 @@ class PrisonIntegrationTest : IntegrationTestBase() {
       .andExpect(status().isNotFound)
   }
 
+  @Test
+  fun `return a 404 for if consumer has empty list of prisons`() {
+    val headers = HttpHeaders()
+    headers.set("subject-distinguished-name", "C=GB,ST=London,L=London,O=Home Office,CN=no-prisons")
+    mockMvc.perform(
+      get("$basePrisonPath/prisoners/$hmppsId").headers(headers),
+    )
+      .andExpect(status().isNotFound)
+  }
+
   @Test
   fun `return multiple prisoners when querying by complex parameters`() {
     callApi("$basePrisonPath/prisoners?first_name=$firstName&last_name=$lastName&dateOfBirth=$dateOfBirth")

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonServiceTest.kt

@@ -40,7 +40,7 @@ internal class GetPersonServiceTest(
 
       val nomsNumber = "N1234PS"
       val prisoner = POSPrisoner(firstName = "Jim", lastName = "Brown", dateOfBirth = LocalDate.of(1992, 12, 3), prisonerNumber = nomsNumber)
-      val blankConsumerFilters = ConsumerFilters(prisons=null)
+      val blankConsumerFilters = ConsumerFilters(prisons = null)
 
       beforeEach {
         Mockito.reset(prisonerOffenderSearchGateway)
@@ -197,7 +197,7 @@ internal class GetPersonServiceTest(
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(wrongPrisonHmppsId))
           .thenReturn(Response(data = POSPrisoner(firstName = "Test", lastName = "Person", prisonId = "XYZ")))
 
-        val result = getPersonService.getPrisoner(wrongPrisonHmppsId, ConsumerFilters(prisons=listOf("ABC")))
+        val result = getPersonService.getPrisoner(wrongPrisonHmppsId, ConsumerFilters(prisons = listOf("ABC")))
 
         result.data.shouldBe(null)
         result.errors.shouldBe(listOf(UpstreamApiError(UpstreamApi.PRISONER_OFFENDER_SEARCH, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Not found")))
@@ -210,7 +210,7 @@ internal class GetPersonServiceTest(
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(correctPrisonHmppsId))
           .thenReturn(Response(data = posPrisoner))
 
-        val result = getPersonService.getPrisoner(correctPrisonHmppsId, ConsumerFilters(prisons=listOf(prisonId)))
+        val result = getPersonService.getPrisoner(correctPrisonHmppsId, ConsumerFilters(prisons = listOf(prisonId)))
 
         result.data.shouldBeTypeOf<Person>()
         result.data!!.firstName.shouldBe(posPrisoner.firstName)
@@ -226,7 +226,7 @@ internal class GetPersonServiceTest(
           Response(data = POSPrisoner(firstName = "Sam", lastName = "Mills")),
         )
 
-        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons=null))
+        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons = null))
 
         result.data.shouldBeTypeOf<Person>()
         result.data!!.firstName.shouldBe(person.firstName)
@@ -239,7 +239,7 @@ internal class GetPersonServiceTest(
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(validHmppsId))
           .thenReturn(Response(data = POSPrisoner(firstName = "Test", lastName = "Person", prisonId = "XYZ")))
 
-        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons=emptyList()))
+        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons = emptyList()))
 
         result.data.shouldBe(null)
         result.errors.shouldBe(listOf(UpstreamApiError(UpstreamApi.PRISONER_OFFENDER_SEARCH, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Not found")))
@@ -250,7 +250,7 @@ internal class GetPersonServiceTest(
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(validHmppsId))
           .thenReturn(Response(data = POSPrisoner(firstName = "Test", lastName = "Person")))
 
-        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons=listOf("ABC")))
+        val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons = listOf("ABC")))
 
         result.data.shouldBe(null)
         result.errors.shouldBe(listOf(UpstreamApiError(UpstreamApi.PRISONER_OFFENDER_SEARCH, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Not found")))