Updated transaction controller integration tests with transaction post tests, updated prism mock schema, tidying

Author: wcdkj

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

@@ -218,10 +218,18 @@ class TransactionsController(
     val response = postTransactionsForPersonService.execute(prisonId, hmppsId, transactionRequest, filters)
 
     if (response.hasError(UpstreamApiError.Type.BAD_REQUEST)) {
-      throw ValidationException("Either invalid HMPPS ID: $hmppsId or incorrect prison: $prisonId or invalid request body: ${transactionRequest.toMap()}")
+      throw ValidationException("Either invalid HMPPS ID: $hmppsId or incorrect prison: $prisonId or invalid request body: ${transactionRequest.toApiConformingMap()}")
     }
 
-    auditService.createEvent("CREATE_TRANSACTION", mapOf("hmppsId" to hmppsId, "prisonId" to prisonId)) // add req obj
+    if (response.hasError(UpstreamApiError.Type.FORBIDDEN)) {
+      throw ValidationException("The prisonId: $prisonId is not valid for your consumer profile. ${response.errors[0].description}")
+    }
+
+    if (response.hasError(UpstreamApiError.Type.ENTITY_NOT_FOUND)) {
+      throw EntityNotFoundException(" ${response.errors[0].description}")
+    }
+
+    auditService.createEvent("CREATE_TRANSACTION", mapOf("hmppsId" to hmppsId, "prisonId" to prisonId, "transactionRequest" to transactionRequest.toApiConformingMap().toString())) // add req properly
     return DataResponse(response.data)
   }
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/NomisGateway.kt

@@ -404,7 +404,7 @@ class NomisGateway(
         "/api/v1/prison/$prisonId/offenders/$nomisNumber/transactions",
         authenticationHeader(),
         UpstreamApi.NOMIS,
-        requestBody = transactionRequest.toMap(),
+        requestBody = transactionRequest.toApiConformingMap(),
       )
     return when (result) {
       is WebClientWrapperResponse.Success -> {

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

@@ -7,12 +7,12 @@ data class TransactionRequest(
   val clientTransactionId: String,
   val clientUniqueRef: String,
 ) {
-  fun toMap(): Map<String, Any?> =
+  fun toApiConformingMap(): Map<String, Any?> =
     mapOf(
       "type" to type,
       "description" to description,
       "amount" to amount,
-      "clientTransactionId" to clientTransactionId,
-      "clientUniqueRef" to clientUniqueRef,
+      "client_transaction_id" to clientTransactionId,
+      "client_unique_ref" to clientUniqueRef,
     ).filterValues { it != null }
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/nomis/NomisTransactionResponse.kt

@@ -3,10 +3,4 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis
 data class NomisTransactionResponse(
   val id: String?,
   val description: String?,
-) {
-  fun toMap(): Map<String, String?> =
-    mapOf(
-      "id" to id,
-      "description" to description,
-    )
-}
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/prismMocks/prison-api.json

@@ -24173,7 +24173,7 @@
             "type": "string",
             "description": "Valid transaction type for the prison_id",
             "example": "CANT",
-            "enum": ["CANT,REFND,PHONE,MRPR,MTDS,DTDS,CASHD,RELA,RELS"]
+            "enum": ["CANT","REFND","PHONE","MRPR","MTDS","DTDS","CASHD","RELA","RELS"]
           },
           "description": {
             "maxLength": 240,

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

@@ -15,6 +15,9 @@ class PostTransactionForPersonService(
   @Autowired val nomisGateway: NomisGateway,
   @Autowired val getPersonService: GetPersonService,
 ) {
+  @Suppress("ktlint:standard:property-naming")
+  final val VALID_TRANSACTION_TYPE_CODES = listOf("CANT", "REFND", "PHONE", "MRPR", "MTDS", "DTDS", "CASHD", "RELA", "RELS")
+
   fun execute(
     prisonId: String,
     hmppsId: String,
@@ -26,7 +29,14 @@ class PostTransactionForPersonService(
     ) {
       return Response(
         data = null,
-        errors = listOf(UpstreamApiError(UpstreamApi.NOMIS, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Not found")),
+        errors = listOf(UpstreamApiError(UpstreamApi.NOMIS, UpstreamApiError.Type.FORBIDDEN, "Not found")),
+      )
+    }
+
+    if (transactionRequest.type !in VALID_TRANSACTION_TYPE_CODES) {
+      return Response(
+        data = null,
+        errors = listOf(UpstreamApiError(UpstreamApi.NOMIS, UpstreamApiError.Type.BAD_REQUEST, "Invalid transaction type")),
       )
     }
 
@@ -48,7 +58,7 @@ class PostTransactionForPersonService(
       )
     }
 
-    var response =
+    val response =
       nomisGateway.postTransactionForPerson(
         prisonId,
         nomisNumber,
@@ -62,7 +72,7 @@ class PostTransactionForPersonService(
       )
     }
 
-    var transactionCreateResponse = TransactionCreateResponse()
+    val transactionCreateResponse = TransactionCreateResponse()
     if (!response.data.id.isNullOrBlank()) {
       transactionCreateResponse.transactionId = response.data.id
     }

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

@@ -2,6 +2,7 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.integration
 
 import org.junit.jupiter.api.Test
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
 
@@ -64,9 +65,44 @@ class TransactionsIntegrationTest : IntegrationTestBase() {
 
   // POST transaction
   @Test
-  fun `return a response with a transaction ID`() {
-    callApi("/v1/prison/$prisonId/prisoners/$hmppsId/transactions")
-      .andExpect(status().isOk)
-      .andExpect(content().json(getExpectedResponse("transactions-response")))
+  fun `return an expected response for a successful transaction post`() {
+    val requestBody =
+      """
+      {
+        "type": "CANT",
+        "description": "Canteen Purchase of £16.34",
+        "amount": 1634,
+        "clientTransactionId": "CL123212",
+        "clientUniqueRef": "CLIENT121131-0_11"
+      }
+      """.trimIndent()
+
+    val headers = org.springframework.http.HttpHeaders()
+    headers.set("subject-distinguished-name", "C=GB,ST=London,L=London,O=Home Office,CN=automated-test-client")
+    mockMvc
+      .perform(
+        post("/v1/prison/$prisonId/prisoners/$hmppsId/transactions").headers(headers).content(requestBody).contentType(org.springframework.http.MediaType.APPLICATION_JSON),
+      ).andExpect(status().isOk)
+      .andExpect(content().json(getExpectedResponse("transaction-create-response")))
+  }
+
+  @Test
+  fun `return a 400 when request object contains invalid type`() {
+    val requestBody =
+      """
+      {
+        "type": "IS_WRONG",
+        "amount": 1634,
+        "clientTransactionId": "CL123212",
+        "clientUniqueRef": "CLIENT121131-0_11"
+      }
+      """.trimIndent()
+
+    val headers = org.springframework.http.HttpHeaders()
+    headers.set("subject-distinguished-name", "C=GB,ST=London,L=London,O=Home Office,CN=automated-test-client")
+    mockMvc
+      .perform(
+        post("/v1/prison/$prisonId/prisoners/$hmppsId/transactions").headers(headers).content(requestBody).contentType(org.springframework.http.MediaType.APPLICATION_JSON),
+      ).andExpect(status().isBadRequest)
   }
 }

src/test/resources/expected-responses/transaction-create-response

@@ -0,0 +1,6 @@
+{
+"data":
+  {
+    "transactionId": "6179604-1"
+    }
+}