PI-2517 - add new integration test

Author: achimber-moj

Dockerfile.prism

@@ -13,7 +13,6 @@ ADD https://probation-offender-search-dev.hmpps.service.justice.gov.uk/v3/api-do
 ADD https://prisoner-search-dev.prison.service.justice.gov.uk/v3/api-docs /tmp/prisoner-offender-search-tmp.json
 RUN jq 'del(.components.schemas.Query.properties.subQueries)' /tmp/prisoner-offender-search-tmp.json > prisoner-offender-search-tmp1.json
 RUN swagger-cli bundle -r -o /prismMocks/prisoner-offender-search.json prisoner-offender-search-tmp1.json
-
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/prisoner-offender-search.json
 
 ENTRYPOINT sh -c 'port=4010; for file in $(ls /prismMocks/*.json | sort); do node dist/index.js mock -p $port -h 0.0.0.0 $file & port=$((port + 1)); done; wait'

Makefile

@@ -2,7 +2,7 @@ authenticate-docker:
 	./scripts/authenticate_docker.sh
 
 build-dev:
-	docker compose pull hmpps-auth
+	#docker compose pull hmpps-auth
 	docker compose build
 
 build:
@@ -26,16 +26,16 @@ unit-test:
 smoke-test: serve
 	./gradlew smokeTest --warning-mode all
 
-integration-test:
-	./gradlew integrationTest
+integration-test: serve
+	./gradlew integrationTest --warning-mode all
 
 heartbeat:
 	./scripts/heartbeat.sh
 
 test: unit-test smoke-test
 
 e2e:
-	./gradlew smokeTest --warning-mode all
+	./gradlew integrationTest --warning-mode all
 
 lint:
 	./gradlew ktlintCheck

docker-compose.yml

@@ -1,31 +1,31 @@
 services:
-  hmpps-integration-api:
-    build:
-      context: .
-    container_name: hmpps-integration-api
-    healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:8080/health" ]
-    depends_on:
-      hmpps-auth:
-        condition: service_healthy
-    ports:
-      - "8080:8080"
-    environment:
-      - SERVER_PORT=8080
-      - SPRING_PROFILES_ACTIVE=local-docker
-      - LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=TRACE
+#  hmpps-integration-api:
+#    build:
+#      context: .
+#    container_name: hmpps-integration-api
+#    healthcheck:
+#      test: [ "CMD", "curl", "-f", "http://localhost:8080/health" ]
+#    depends_on:
+#      hmpps-auth:
+#        condition: service_healthy
+#    ports:
+#      - "8080:8080"
+#    environment:
+#      - SERVER_PORT=8080
+#      - SPRING_PROFILES_ACTIVE=local-docker
+#      - LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=TRACE
 
-  hmpps-auth:
-    image: quay.io/hmpps/hmpps-auth:latest
-    container_name: hmpps-auth
-    ports:
-      - "9090:8080"
-    healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:8080/auth/health" ]
-    environment:
-      - SERVER_PORT=8080
-      - SPRING_PROFILES_ACTIVE=dev
-      - LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=TRACE
+#  hmpps-auth:
+#    image: quay.io/hmpps/hmpps-auth:latest
+#    container_name: hmpps-auth
+#    ports:
+#      - "9090:8080"
+#    healthcheck:
+#      test: [ "CMD", "curl", "-f", "http://localhost:8080/auth/health" ]
+#    environment:
+#      - SERVER_PORT=8080
+#      - SPRING_PROFILES_ACTIVE=dev
+#      - LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=TRACE
 
   prism:
     build:

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

@@ -7,9 +7,11 @@ management.endpoint:
 
 services:
   prison-api:
-    base-url: http://localhost:4000
+    base-url: http://localhost:4016
   hmpps-auth:
-    base-url: http://localhost:9090
+    base-url: http://localhost:3000
+    username: client
+    password: client-secret
   prisoner-offender-search:
     base-url: http://localhost:4017
   probation-offender-search:

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

@@ -1,12 +1,17 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.integration
 
+import org.junit.jupiter.api.AfterAll
+import org.junit.jupiter.api.BeforeAll
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
 import org.springframework.boot.test.context.SpringBootTest
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT
 import org.springframework.http.HttpHeaders
 import org.springframework.test.context.ActiveProfiles
 import org.springframework.test.web.servlet.MockMvc
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.mockservers.HmppsAuthMockServer
+import java.io.File
 
 @ActiveProfiles("integration-test")
 @AutoConfigureMockMvc
@@ -15,9 +20,28 @@ abstract class IntegrationTestBase {
   @Autowired
   lateinit var mockMvc: MockMvc
 
+  companion object {
+    private val hmppsAuthMockServer = HmppsAuthMockServer()
+
+    @BeforeAll
+    @JvmStatic
+    fun startMockServers() {
+      hmppsAuthMockServer.start()
+      hmppsAuthMockServer.stubGetOAuthToken("client", "client-secret")
+    }
+
+    @AfterAll
+    @JvmStatic
+    fun stopMockServers() {
+      hmppsAuthMockServer.stop()
+    }
+  }
+
   fun getAuthHeader(): HttpHeaders {
     val headers = HttpHeaders()
     headers.set("subject-distinguished-name", "C=GB,ST=London,L=London,O=Home Office,CN=automated-test-client")
     return headers
   }
+
+  fun getExpectedResponse(filename: String): String = File("./src/test/resources/expected-responses/$filename").readText(Charsets.UTF_8).removeWhitespaceAndNewlines()
 }

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

@@ -5,8 +5,6 @@ import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers.print
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
-import java.io.File
 import java.net.URLEncoder
 import java.nio.charset.StandardCharsets
 
@@ -21,25 +19,47 @@ internal class PersonIntegrationTest : IntegrationTestBase() {
     val lastName = "Example_Last_Name"
     val queryParams = "first_name=$firstName&last_name=$lastName"
 
-    val expectedResponse = File("./src/test/resources/expected-responses/person-name-search-response").readText(Charsets.UTF_8).removeWhitespaceAndNewlines()
-
     mockMvc.perform(
       get("$basePath?$queryParams").headers(getAuthHeader()),
     )
       .andExpect(status().isOk)
       .andDo(print())
-      .andExpect(content().json(expectedResponse))
+      .andExpect(content().json(getExpectedResponse("person-name-search-response")))
   }
 
   @Test
   fun `returns a person from Prisoner Offender Search and Probation Offender Search`() {
-    val expectedResponse = File("./src/test/resources/expected-responses/person-offender-and-probation-search-response").readText(Charsets.UTF_8).removeWhitespaceAndNewlines()
-
     mockMvc.perform(
       get("$basePath/$encodedHmppsId").headers(getAuthHeader()),
     )
       .andExpect(status().isOk)
       .andDo(print())
-      .andExpect(content().json(expectedResponse))
+      .andExpect(content().json(getExpectedResponse("person-offender-and-probation-search-response")))
+  }
+
+  @Test
+  fun `returns image metadata for a person`() {
+    mockMvc.perform(
+      get("$basePath/$encodedHmppsId/images").headers(getAuthHeader()),
+    )
+      .andExpect(status().isOk)
+      .andDo(print())
+      .andExpect(content().json(getExpectedResponse("person-image-meta-data")))
+  }
+
+  @Test
+  fun `returns person name details for a person`() {
+    mockMvc.perform(
+      get("$basePath/$encodedHmppsId/name").headers(getAuthHeader()),
+    )
+      .andExpect(status().isOk)
+      .andDo(print())
+      .andExpect(
+        content().json(
+          """
+        {"data":{"firstName":"string","lastName":"string"}}
+      """,
+        ),
+      )
   }
 }

src/test/resources/expected-responses/person-image-meta-data

@@ -0,0 +1,20 @@
+{
+  "data": [
+    {
+      "id": 2461788,
+      "active": false,
+      "captureDateTime": "2021-07-05T10:35:17",
+      "view": "OIC",
+      "orientation": "NECK",
+      "type": "OFF_IDM"
+    }
+  ],
+  "pagination": {
+    "isLastPage": true,
+    "count": 1,
+    "page": 1,
+    "perPage": 10,
+    "totalCount": 1,
+    "totalPages": 1
+  }
+}