NON-318: Refactor testcontainers setup (#417)

…and test on postgres 16 now that production database has been updated

Author: ushkarev

.circleci/config.yml

@@ -16,7 +16,7 @@ parameters:
     default: "21.0"
   postgres-version:
     type: string
-    default: "15"
+    default: "16"
   localstack-version:
     type: string
     default: "4"

README.md

@@ -1,30 +1,42 @@
 # HMPPS Non-associations API
+
 [![CircleCI](https://circleci.com/gh/ministryofjustice/hmpps-non-associations-api/tree/main.svg?style=svg)](https://circleci.com/gh/ministryofjustice/hmpps-non-associations-api)
 [![Docker Repository on Quay](https://quay.io/repository/hmpps/hmpps-non-associations-api/status "Docker Repository on Quay")](https://quay.io/repository/hmpps/hmpps-non-associations-api)
 [![Runbook](https://img.shields.io/badge/runbook-view-172B4D.svg?logo=confluence)](https://dsdmoj.atlassian.net/wiki/spaces/NOM/pages/1739325587/DPS+Runbook)
 [![API docs](https://img.shields.io/badge/API_docs_-view-85EA2D.svg?logo=swagger)](https://non-associations-api-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html)
 [![Event docs](https://img.shields.io/badge/Event_docs-view-85EA2D.svg)](https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/ministryofjustice/hmpps-non-associations-api/main/async-api.yml&readOnly)
 
-**Non-associations API to own the non-associations data for prisoners**
+This application is the REST api and database that owns prisoner non-association data.
 
 ## Running locally against dev/T3 services
 
 This is straight-forward as authentication is delegated down to the calling services in `dev` environment.
-Environment variables to be set are as follows:
 
-```
-API_BASE_URL_OAUTH=https://sign-in-dev.hmpps.service.justice.gov.uk/auth
-NON_ASSOCIATIONS_API_CLIENT_ID=[choose a suitable hmpps-auth client]
-NON_ASSOCIATIONS_API_CLIENT_SECRET=
-```
+Use all environment variables starting with `API_BASE_URL_` from [helm chart values](./helm_deploy/values-dev.yaml).
+Choose a suitable hmpps-auth oauth client, for instance from kubernetes `hmpps-incentives-api` secret and add
+`NON_ASSOCIATIONS_API_CLIENT_ID` and `NON_ASSOCIATIONS_API_CLIENT_SECRET`.
 
 Start the database and other required services via docker-compose with:
 
 ```shell
 docker compose -f docker-compose-local.yml up
 ```
 
-Then run the API.
+Then run the API; for example using IntelliJ.
+
+## Testing and linting
+
+Run unit and integration tests with:
+
+```shell
+./gradlew test
+```
+
+Run automatic lint fixes:
+
+```shell
+./gradlew ktlintformat
+```
 
 ## Connecting to AWS resources from a local port
 

docker-compose-local.yml

@@ -16,7 +16,7 @@ services:
       - "/var/run/docker.sock:/var/run/docker.sock"
 
   non-associations-db:
-    image: postgres:15
+    image: postgres:16
     networks:
       - hmpps
     container_name: non-postgres

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
 
   database:
-    image: postgres:15
+    image: postgres:16
     networks:
       - hmpps
     container_name: non-db

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsnonassociationsapi/config/LocalStackContainer.kt

@@ -0,0 +1,27 @@
+package uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config
+
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.testcontainers.containers.localstack.LocalStackContainer
+import org.testcontainers.containers.output.Slf4jLogConsumer
+import org.testcontainers.utility.DockerImageName
+
+object LocalStackTestcontainer : Testcontainer<LocalStackContainer>("localstack", 4566) {
+  override fun start(): LocalStackContainer {
+    val logConsumer = Slf4jLogConsumer(log).withPrefix("localstack")
+    log.info("Starting localstack")
+    return LocalStackContainer(
+      DockerImageName.parse("localstack/localstack").withTag("4"),
+    ).apply {
+      withServices(LocalStackContainer.Service.SQS, LocalStackContainer.Service.SNS)
+      withEnv("DEFAULT_REGION", "eu-west-2")
+      start()
+      followOutput(logConsumer)
+    }
+  }
+
+  override fun setupProperties(instance: LocalStackContainer, registry: DynamicPropertyRegistry) {
+    val localstackUrl = instance.getEndpointOverride(LocalStackContainer.Service.SNS).toString()
+    registry.add("hmpps.sqs.localstackUrl") { localstackUrl }
+    registry.add("hmpps.sqs.region", instance::getRegion)
+  }
+}

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsnonassociationsapi/config/LocalStackTestcontainer.kt

@@ -0,0 +1,33 @@
+package uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config
+
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.testcontainers.containers.PostgreSQLContainer
+import org.testcontainers.containers.wait.strategy.Wait
+import org.testcontainers.utility.DockerImageName
+
+object PostgresTestcontainer : Testcontainer<PostgreSQLContainer<Nothing>>("postgres", 5432) {
+  override fun start(): PostgreSQLContainer<Nothing> {
+    log.info("Creating a Postgres database")
+    return PostgreSQLContainer<Nothing>(
+      DockerImageName.parse("postgres").withTag("16"),
+    ).apply {
+      withEnv("HOSTNAME_EXTERNAL", "localhost")
+      withDatabaseName("non_associations")
+      withUsername("non_associations")
+      withPassword("non_associations")
+      setWaitStrategy(Wait.forListeningPort())
+      withReuse(true)
+
+      start()
+    }
+  }
+
+  override fun setupProperties(instance: PostgreSQLContainer<Nothing>, registry: DynamicPropertyRegistry) {
+    registry.add("spring.datasource.url", instance::getJdbcUrl)
+    registry.add("spring.datasource.username", instance::getUsername)
+    registry.add("spring.datasource.password", instance::getPassword)
+    registry.add("spring.flyway.url", instance::getJdbcUrl)
+    registry.add("spring.flyway.user", instance::getUsername)
+    registry.add("spring.flyway.password", instance::getPassword)
+  }
+}

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsnonassociationsapi/config/PostgresContainer.kt

@@ -0,0 +1,35 @@
+package uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config
+
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import org.springframework.test.context.DynamicPropertyRegistry
+import java.io.IOException
+import java.net.ServerSocket
+
+abstract class Testcontainer<InstanceType>(
+  val containerName: String,
+  val exposedPort: Int,
+) {
+  protected val log: Logger = LoggerFactory.getLogger(this::class.java)
+
+  val instance: InstanceType? by lazy { startIfNotRunning() }
+
+  open fun isRunning(): Boolean = try {
+    val serverSocket = ServerSocket(exposedPort)
+    serverSocket.localPort == 0
+  } catch (e: IOException) {
+    true
+  }
+
+  open fun startIfNotRunning(): InstanceType? {
+    if (isRunning()) {
+      log.warn("Not starting $containerName container because port $exposedPort is already open")
+      return null
+    }
+    return start()
+  }
+
+  abstract fun start(): InstanceType
+
+  open fun setupProperties(instance: InstanceType, registry: DynamicPropertyRegistry) {}
+}

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsnonassociationsapi/config/PostgresTestcontainer.kt

@@ -3,7 +3,7 @@ package uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.helper
 import org.springframework.test.context.ActiveProfiles
 import org.springframework.test.context.DynamicPropertyRegistry
 import org.springframework.test.context.DynamicPropertySource
-import uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config.PostgresContainer
+import uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config.PostgresTestcontainer
 import java.time.Clock
 import java.time.Instant
 import java.time.LocalDateTime
@@ -20,19 +20,13 @@ abstract class TestBase {
     )
     val now: LocalDateTime = LocalDateTime.now(clock)
 
-    private val pgContainer = PostgresContainer.instance
+    private val postgresInstance = PostgresTestcontainer.instance
 
+    @Suppress("unused")
     @JvmStatic
     @DynamicPropertySource
-    fun properties(registry: DynamicPropertyRegistry) {
-      pgContainer?.run {
-        registry.add("spring.datasource.url", pgContainer::getJdbcUrl)
-        registry.add("spring.datasource.username", pgContainer::getUsername)
-        registry.add("spring.datasource.password", pgContainer::getPassword)
-        registry.add("spring.flyway.url", pgContainer::getJdbcUrl)
-        registry.add("spring.flyway.user", pgContainer::getUsername)
-        registry.add("spring.flyway.password", pgContainer::getPassword)
-      }
+    fun postgresProperties(registry: DynamicPropertyRegistry) {
+      postgresInstance?.let { PostgresTestcontainer.setupProperties(postgresInstance, registry) }
     }
   }
 

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsnonassociationsapi/config/Testcontainer.kt

@@ -8,8 +8,7 @@ import org.springframework.test.context.DynamicPropertyRegistry
 import org.springframework.test.context.DynamicPropertySource
 import org.springframework.test.context.bean.override.mockito.MockitoSpyBean
 import software.amazon.awssdk.services.sqs.model.PurgeQueueRequest
-import uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config.LocalStackContainer
-import uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config.LocalStackContainer.setLocalStackProperties
+import uk.gov.justice.digital.hmpps.hmppsnonassociationsapi.config.LocalStackTestcontainer
 import uk.gov.justice.hmpps.sqs.HmppsQueue
 import uk.gov.justice.hmpps.sqs.HmppsQueueService
 import uk.gov.justice.hmpps.sqs.HmppsSqsProperties
@@ -21,6 +20,17 @@ import uk.gov.justice.hmpps.sqs.countMessagesOnQueue
 @ActiveProfiles("test")
 class SqsIntegrationTestBase : IntegrationTestBase() {
 
+  companion object {
+    private val localstackInstance = LocalStackTestcontainer.instance
+
+    @Suppress("unused")
+    @JvmStatic
+    @DynamicPropertySource
+    fun localstackProperties(registry: DynamicPropertyRegistry) {
+      localstackInstance?.also { LocalStackTestcontainer.setupProperties(localstackInstance, registry) }
+    }
+  }
+
   @Autowired
   private lateinit var hmppsQueueService: HmppsQueueService
 
@@ -49,17 +59,6 @@ class SqsIntegrationTestBase : IntegrationTestBase() {
     nonAssociationsQueue.sqsClient.countMessagesOnQueue(nonAssociationsQueue.queueUrl).get()
   }
 
-  companion object {
-    private val localStackContainer = LocalStackContainer.instance
-
-    @Suppress("unused")
-    @JvmStatic
-    @DynamicPropertySource
-    fun testcontainers(registry: DynamicPropertyRegistry) {
-      localStackContainer?.also { setLocalStackProperties(it, registry) }
-    }
-  }
-
   fun getNumberOfMessagesCurrentlyOnQueue(): Int? =
     nonAssociationsQueue.sqsClient.countMessagesOnQueue(nonAssociationsQueue.queueUrl).get()
 }