Merge branch 'main' into HIA-721

Author: AlexHerbertMadeTech

docs/guides/setting-up-a-new-consumer.md

@@ -12,14 +12,17 @@ per environment.
 - [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
 - [Access to Cloud Platform’s Kubernetes cluster](https://user-guide.cloud-platform.service.justice.gov.uk/documentation/getting-started/kubectl-config.html#installing-kubectl)
 
+As a pre-requisite to create a client certificate by running the script below, please ensure that:
+- You are logged in so that you can access AWS resources via the CLI.
+- Verify that you have all your AWS credentials ready by opening the config file in the ".aws" directory.
+
 ## Create a client certificate
 
-1. Run the [generate-client-certificate.sh](/scripts/client_certificates/generate.sh) script with the name of the environment and client.
+Run the [generate-client-certificate.sh](/scripts/client_certificates/generate.sh) script with the name of the environment and client.
 
 ```bash
 make generate-client-certificate
 ```
-
 This will output three files in the ./scripts/client_certificates directory:
 
 - a private key e.g. `dev-nhs-client.key`
@@ -114,3 +117,14 @@ kubectl -n hmpps-integration-api-[environment] get secrets [your queue secret na
 5. Create new [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) branch 
 6. Update terraform to load the secret value from AWS and update filter_policy value. Follow [Example](https://github.com/ministryofjustice/cloud-platform-environments/pull/22111/files). Note: The name of aws_secretsmanager_secret module has to be same as the secret name created from step 4/5 above. 
 7. Follow steps 3-8 in [Create an API key](#create-an-api-key) to merge branch to main. 
+
+## Create a new endpoint for a client
+
+### Create basic infrastructure
+Within the [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) and the namespace of the environment:
+
+1. Create a branch.
+2. Add a new API Gateway resource, a SQS method, a SQS method response, and an integration. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22695/files)
+3. Ensure that all the permissions are up-to-date and add a new role and policy for your new resource. Example: [iam.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22787/files#diff-a376622fa4a4c2fd9404d5ee4221487259264608a0cbe36b99c150c472558f29)
+4. Check that the integration is pointing to the right queue. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22795/files)
+5. Deploy and test (do not use Postman, rather use a GET cURL command with "x-api-key" as your header.)

openapi.yml

@@ -96,6 +96,11 @@ paths:
                 type: object
                 properties:
                   data:
+                    type: object
+                    properties:
+                      prisonerOffenderSearch:
+                        $ref: "#/components/schemas/Person"
+                      probationOffenderSearch:
                         $ref: "#/components/schemas/Person"
         "404":
           description: Failed to find a person with the provided HMPPS ID.
@@ -1722,45 +1727,44 @@ components:
         firstName:
           type: string
           example: Arthur
-          description: first name
+          description: First name
         middleName:
           type: string
           example: John
           nullable: true
-          description: middle name
+          description: Middle name
         lastName:
           type: string
           example: Morgan
-          description: last name
+          description: Last name
         dateOfBirth:
           type: string
           format: date
           example: 1965-12-01
-          description: date of birth
+          description: Date of birth
         gender:
           type: string
           example: Male
-          description: gender
+          description: Gender
         ethnicity:
           type: string
           example: "White: Eng./Welsh/Scot./N.Irish/British"
-          description: ethnicity
+          nullable: true
+          description: Ethnicity
         aliases:
           type: array
-          minItems: 0
           items:
             $ref: "#/components/schemas/Alias"
-          description: list of aliases
+          description: List of aliases
         identifiers:
           $ref: "#/components/schemas/Identifiers"
         pncId:
           type: string
-          example: 2008/0545166T
           description: An identifier from the Police National Computer (PNC)
         hmppsId:
           type: string
-          example: X00001
-          description: Currently a hmppsId is a CRN identifier however this will change in the future to be a new unique Hmpps identifier
+          example: 2008/0545166T
+          description: Hmpps identifier
         contactDetails:
           $ref: "#/components/schemas/ContactDetails"
     PersonResponsibleOfficerName:
@@ -1902,7 +1906,6 @@ components:
           nullable: true
         prison:
           $ref: "#/components/schemas/Prison"
-
     Punishment:
       type: object
       properties:

scripts/client_certificates/generate.sh

@@ -51,8 +51,8 @@ upload_backup() {
   aws s3api put-object --bucket "$bucket" --key "$client_folder/" --acl private
   aws s3 cp "$file_path" "s3://$path/client.pem"
   aws s3 cp ./"$environment"-"$client"-client.pem "s3://$path/client.pem"
-  aws s3 cp ./truststore.key "s3://$path/truststore.key"
-  aws s3 cp ./truststore.pem "s3://$path/truststore.pem"
+  aws s3 cp ./"$environment"-"$client"-client.csr "s3://$path/client.csr"
+  aws s3 cp ./"$environment"-"$client"-client.key "s3://$path/client.key"
 
   aws configure set aws_access_key_id ""
   aws configure set aws_secret_access_key ""

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

@@ -61,16 +61,17 @@ class PersonController(
   @GetMapping("{encodedHmppsId}")
   fun getPerson(
     @PathVariable encodedHmppsId: String,
-  ): Map<String, Person?> {
+  ): Map<String, Map<String, Person?>> {
     val hmppsId = encodedHmppsId.decodeUrlCharacters()
-    val response = getPersonService.execute(hmppsId)
+    val response = getPersonService.getCombinedDataForPerson(hmppsId)
 
     if (response.hasErrorCausedBy(ENTITY_NOT_FOUND, causedBy = UpstreamApi.PROBATION_OFFENDER_SEARCH)) {
       throw EntityNotFoundException("Could not find person with id: $hmppsId")
     }
 
     auditService.createEvent("GET_PERSON_DETAILS", mapOf("hmppsId" to hmppsId))
-    return mapOf("data" to response.data)
+    val data = response.data.mapValues { it.value }
+    return mapOf("data" to data)
   }
 
   @GetMapping("{encodedHmppsId}/images")

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonService.kt

@@ -2,17 +2,48 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.services
 
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.stereotype.Service
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.PrisonerOffenderSearchGateway
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.ProbationOffenderSearchGateway
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 
 @Service
 class GetPersonService(
   @Autowired val probationOffenderSearchGateway: ProbationOffenderSearchGateway,
+  @Autowired val prisonerOffenderSearchGateway: PrisonerOffenderSearchGateway,
 ) {
   fun execute(hmppsId: String): Response<Person?> {
     val personFromProbationOffenderSearch = probationOffenderSearchGateway.getPerson(id = hmppsId)
 
     return Response(data = personFromProbationOffenderSearch.data, errors = personFromProbationOffenderSearch.errors)
   }
+
+  fun getCombinedDataForPerson(hmppsId: String): Response<Map<String, Person?>> {
+    val probationResponse = probationOffenderSearchGateway.getPerson(id = hmppsId)
+
+    val prisonResponse =
+      probationResponse.data?.identifiers?.nomisNumber?.let {
+        prisonerOffenderSearchGateway.getPrisonOffender(nomsNumber = it)
+      }
+
+    return if (prisonResponse != null) {
+      Response(
+        data =
+          mapOf(
+            "prisonerOffenderSearch" to prisonResponse.data?.toPerson(),
+            "probationOffenderSearch" to probationResponse.data,
+          ),
+        errors = prisonResponse.errors + probationResponse.errors,
+      )
+    } else {
+      Response(
+        data =
+          mapOf(
+            "prisonerOffenderSearch" to null,
+            "probationOffenderSearch" to probationResponse.data,
+          ),
+        errors = probationResponse.errors,
+      )
+    }
+  }
 }

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

@@ -20,12 +20,14 @@ import org.springframework.web.reactive.function.client.WebClientResponseExcepti
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIMockMvc
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ContactDetailsWithEmailAndPhone
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Identifiers
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ImageMetadata
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PhoneNumber
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisoneroffendersearch.POSPrisoner
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetImageMetadataForPersonService
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetPersonService
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetPersonsService
@@ -222,12 +224,20 @@ internal class PersonControllerTest(
       }
 
       describe("GET $basePath/{id}") {
-        val person = Person("Silly", "Sobbers")
+        val probationOffenderSearch = Person("Sam", "Smith", identifiers = Identifiers(nomisNumber = "1234ABC"))
+        val prisonOffenderSearch = POSPrisoner("Kim", "Kardashian")
+        val prisonResponse = Response(data = prisonOffenderSearch, errors = emptyList())
 
         beforeTest {
           Mockito.reset(getPersonService)
           Mockito.reset(auditService)
-          whenever(getPersonService.execute(hmppsId)).thenReturn(Response(data = person))
+
+          val personMap =
+            mapOf(
+              "probationOffenderSearch" to probationOffenderSearch,
+              "prisonerOffenderSearch" to prisonResponse.data.toPerson(),
+            )
+          whenever(getPersonService.getCombinedDataForPerson(hmppsId)).thenReturn(Response(data = personMap))
         }
 
         it("returns a 200 OK status code") {
@@ -248,9 +258,13 @@ internal class PersonControllerTest(
           val idThatDoesNotExist = "9999/11111Z"
 
           it("returns a 404 status code when a person cannot be found in both upstream APIs") {
-            whenever(getPersonService.execute(idThatDoesNotExist)).thenReturn(
+            whenever(getPersonService.getCombinedDataForPerson(idThatDoesNotExist)).thenReturn(
               Response(
-                data = null,
+                data =
+                  mapOf(
+                    "prisonerOffenderSearch" to null,
+                    "probationOffenderSearch" to null,
+                  ),
                 errors =
                   listOf(
                     UpstreamApiError(
@@ -268,9 +282,13 @@ internal class PersonControllerTest(
           }
 
           it("does not return a 404 status code when a person was found in one upstream API") {
-            whenever(getPersonService.execute(idThatDoesNotExist)).thenReturn(
+            whenever(getPersonService.getCombinedDataForPerson(idThatDoesNotExist)).thenReturn(
               Response(
-                data = Person("someFirstName", "someLastName"),
+                data =
+                  mapOf(
+                    "prisonerOffenderSearch" to null,
+                    "probationOffenderSearch" to Person("someFirstName", "someLastName"),
+                  ),
                 errors =
                   listOf(
                     UpstreamApiError(
@@ -291,33 +309,56 @@ internal class PersonControllerTest(
         it("gets a person with the matching ID") {
           mockMvc.performAuthorised("$basePath/$encodedHmppsId")
 
-          verify(getPersonService, times(1)).execute(hmppsId)
+          verify(getPersonService, times(1)).getCombinedDataForPerson(hmppsId)
         }
 
         it("returns a person with the matching ID") {
           val result = mockMvc.performAuthorised("$basePath/$encodedHmppsId")
 
           result.response.contentAsString.shouldBe(
             """
-        {
-        "data": {
-          "firstName": "Silly",
-          "lastName": "Sobbers",
-          "middleName": null,
-          "dateOfBirth": null,
-          "gender": null,
-          "ethnicity": null,
-          "aliases": [],
-          "identifiers": {
-              "nomisNumber": null,
-              "croNumber": null,
-              "deliusCrn": null
-          },
-          "pncId": null,
-          "hmppsId": null,
-          "contactDetails": null
-        }
-        }
+            {
+             "data":{
+                "probationOffenderSearch":{
+                   "firstName":"Sam",
+                   "lastName":"Smith",
+                   "middleName":null,
+                   "dateOfBirth":null,
+                   "gender":null,
+                   "ethnicity":null,
+                   "aliases":[
+
+                   ],
+                   "identifiers":{
+                      "nomisNumber":"1234ABC",
+                      "croNumber":null,
+                      "deliusCrn":null
+                   },
+                   "pncId":null,
+                   "hmppsId":null,
+                   "contactDetails":null
+                },
+                "prisonerOffenderSearch":{
+                   "firstName":"Kim",
+                   "lastName":"Kardashian",
+                   "middleName":null,
+                   "dateOfBirth":null,
+                   "gender":null,
+                   "ethnicity":null,
+                   "aliases":[
+
+                   ],
+                   "identifiers":{
+                      "nomisNumber":null,
+                      "croNumber":null,
+                      "deliusCrn":null
+                   },
+                   "pncId":null,
+                   "hmppsId":null,
+                   "contactDetails":null
+                }
+             }
+          }
         """.removeWhitespaceAndNewlines(),
           )
         }

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

@@ -14,6 +14,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.ProbationOffend
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Identifiers
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisoneroffendersearch.POSPrisoner
 
 @ContextConfiguration(
   initializers = [ConfigDataApplicationContextInitializer::class],
@@ -36,6 +37,9 @@ internal class GetPersonServiceTest(
       whenever(probationOffenderSearchGateway.getPerson(id = hmppsId)).thenReturn(
         Response(data = Person(firstName = "Qui-gon", lastName = "Jin", identifiers = Identifiers(nomisNumber = "A1234AA"))),
       )
+      whenever(prisonerOffenderSearchGateway.getPrisonOffender(nomsNumber = "A1234AA")).thenReturn(
+        Response(data = POSPrisoner(firstName = "Sam", lastName = "Mills")),
+      )
     }
 
     it("gets a person from Probation Offender Search") {
@@ -66,4 +70,22 @@ internal class GetPersonServiceTest(
 
       result.data.shouldBe(expectedResult)
     }
+
+    it("returns a person with both probation and prison data when prison data exists") {
+      val personFromProbationOffenderSearch = Person("Paula", "First", identifiers = Identifiers(nomisNumber = "A1234AA"))
+      val personFromPrisonOffenderSearch = POSPrisoner("Sam", "Mills")
+
+      whenever(probationOffenderSearchGateway.getPerson(hmppsId)).thenReturn(
+        Response(data = personFromProbationOffenderSearch),
+      )
+      whenever(prisonerOffenderSearchGateway.getPrisonOffender("A1234AA")).thenReturn(
+        Response(data = personFromPrisonOffenderSearch),
+      )
+
+      val result = getPersonService.getCombinedDataForPerson(hmppsId)
+      val expectedResult = result.data
+
+      result.data.shouldBe(expectedResult)
+      result.errors shouldBe emptyList()
+    }
   })