|
| 1 | +package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1.person |
| 2 | + |
| 3 | +import io.kotest.core.spec.style.DescribeSpec |
| 4 | +import io.kotest.matchers.shouldBe |
| 5 | +import io.kotest.matchers.string.shouldContain |
| 6 | +import org.mockito.Mockito |
| 7 | +import org.mockito.internal.verification.VerificationModeFactory |
| 8 | +import org.mockito.kotlin.doThrow |
| 9 | +import org.mockito.kotlin.verify |
| 10 | +import org.mockito.kotlin.whenever |
| 11 | +import org.springframework.beans.factory.annotation.Autowired |
| 12 | +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest |
| 13 | +import org.springframework.boot.test.mock.mockito.MockBean |
| 14 | +import org.springframework.http.HttpStatus |
| 15 | +import org.springframework.test.context.ActiveProfiles |
| 16 | +import org.springframework.test.web.servlet.MockMvc |
| 17 | +import org.springframework.web.reactive.function.client.WebClientResponseException |
| 18 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines |
| 19 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIMockMvc |
| 20 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonProtectedCharacteristics |
| 21 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response |
| 22 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi |
| 23 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError |
| 24 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetProtectedCharacteristicsService |
| 25 | +import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuditService |
| 26 | +import java.net.URLEncoder |
| 27 | +import java.nio.charset.StandardCharsets |
| 28 | + |
| 29 | +@WebMvcTest(controllers = [ProtectedCharacteristicsController::class]) |
| 30 | +@ActiveProfiles("test") |
| 31 | +internal class ProtectedCharacteristicsControllerTest( |
| 32 | + @Autowired var springMockMvc: MockMvc, |
| 33 | + @MockBean val getProtectedCharacteristicsService: GetProtectedCharacteristicsService, |
| 34 | + @MockBean val auditService: AuditService, |
| 35 | +) : DescribeSpec( |
| 36 | + { |
| 37 | + val hmppsId = "9999/11111A" |
| 38 | + val encodedHmppsId = URLEncoder.encode(hmppsId, StandardCharsets.UTF_8) |
| 39 | + val path = "/v1/persons/$encodedHmppsId/protected-characteristics" |
| 40 | + val mockMvc = IntegrationAPIMockMvc(springMockMvc) |
| 41 | + |
| 42 | + describe("GET $path") { |
| 43 | + beforeTest { |
| 44 | + Mockito.reset(getProtectedCharacteristicsService) |
| 45 | + Mockito.reset(auditService) |
| 46 | + whenever(getProtectedCharacteristicsService.execute(hmppsId)).thenReturn( |
| 47 | + Response( |
| 48 | + data = |
| 49 | + PersonProtectedCharacteristics(35, "Female", "Unknown", "British", "British", "None", emptyList()), |
| 50 | + ), |
| 51 | + ) |
| 52 | + } |
| 53 | + |
| 54 | + it("returns a 200 OK status code") { |
| 55 | + val result = mockMvc.performAuthorised(path) |
| 56 | + |
| 57 | + result.response.status.shouldBe(HttpStatus.OK.value()) |
| 58 | + } |
| 59 | + |
| 60 | + it("gets the offences for a person with the matching ID") { |
| 61 | + mockMvc.performAuthorised(path) |
| 62 | + |
| 63 | + verify(getProtectedCharacteristicsService, VerificationModeFactory.times(1)).execute(hmppsId) |
| 64 | + } |
| 65 | + |
| 66 | + it("returns the offences for a person with the matching ID") { |
| 67 | + val result = mockMvc.performAuthorised(path) |
| 68 | + |
| 69 | + result.response.contentAsString.shouldContain( |
| 70 | + """ |
| 71 | + "data": |
| 72 | + { |
| 73 | + "age": 35, |
| 74 | + "gender": "Female", |
| 75 | + "sexualOrientation": "Unknown", |
| 76 | + "ethnicity": "British", |
| 77 | + "nationality": "British", |
| 78 | + "religion": "None", |
| 79 | + "disabilities": [], |
| 80 | + "maritalStatus": null, |
| 81 | + "reasonableAdjustments": [ |
| 82 | + ] |
| 83 | + } |
| 84 | + |
| 85 | + """.removeWhitespaceAndNewlines(), |
| 86 | + ) |
| 87 | + } |
| 88 | + it("logs audit") { |
| 89 | + mockMvc.performAuthorised(path) |
| 90 | + |
| 91 | + verify( |
| 92 | + auditService, |
| 93 | + VerificationModeFactory.times(1), |
| 94 | + ).createEvent("GET_PERSON_PROTECTED_CHARACTERISTICS", mapOf("hmppsId" to hmppsId)) |
| 95 | + } |
| 96 | + |
| 97 | + it("returns an empty list embedded in a JSON object when no offences are found") { |
| 98 | + val hmppsIdForPersonWithNoOffences = "0000/11111A" |
| 99 | + val encodedHmppsIdForPersonWithNoOffences = |
| 100 | + URLEncoder.encode(hmppsIdForPersonWithNoOffences, StandardCharsets.UTF_8) |
| 101 | + val offencesPath = "/v1/persons/$encodedHmppsIdForPersonWithNoOffences/protected-characteristics" |
| 102 | + |
| 103 | + whenever(getProtectedCharacteristicsService.execute(hmppsIdForPersonWithNoOffences)).thenReturn( |
| 104 | + Response( |
| 105 | + data = null, |
| 106 | + ), |
| 107 | + ) |
| 108 | + |
| 109 | + val result = mockMvc.performAuthorised(offencesPath) |
| 110 | + |
| 111 | + result.response.contentAsString.shouldContain("\"data\":null".removeWhitespaceAndNewlines()) |
| 112 | + } |
| 113 | + |
| 114 | + it("returns a 404 NOT FOUND status code when person isn't found in the upstream API") { |
| 115 | + whenever(getProtectedCharacteristicsService.execute(hmppsId)).thenReturn( |
| 116 | + Response( |
| 117 | + data = null, |
| 118 | + errors = |
| 119 | + listOf( |
| 120 | + UpstreamApiError( |
| 121 | + causedBy = UpstreamApi.NOMIS, |
| 122 | + type = UpstreamApiError.Type.ENTITY_NOT_FOUND, |
| 123 | + ), |
| 124 | + ), |
| 125 | + ), |
| 126 | + ) |
| 127 | + |
| 128 | + val result = mockMvc.performAuthorised(path) |
| 129 | + |
| 130 | + result.response.status.shouldBe(HttpStatus.NOT_FOUND.value()) |
| 131 | + } |
| 132 | + |
| 133 | + it("fails with the appropriate error when an upstream service is down") { |
| 134 | + whenever(getProtectedCharacteristicsService.execute(hmppsId)).doThrow( |
| 135 | + WebClientResponseException(500, "MockError", null, null, null, null), |
| 136 | + ) |
| 137 | + |
| 138 | + val response = mockMvc.performAuthorised("$path?page=1&perPage=10") |
| 139 | + |
| 140 | + assert(response.response.status == 500) |
| 141 | + assert( |
| 142 | + response.response.contentAsString.equals( |
| 143 | + "{\"status\":500,\"errorCode\":null,\"userMessage\":\"500 MockError\",\"developerMessage\":\"Unable to complete request as an upstream service is not responding\",\"moreInfo\":null}", |
| 144 | + ), |
| 145 | + ) |
| 146 | + } |
| 147 | + } |
| 148 | + }, |
| 149 | + ) |
0 commit comments