[RELEASE] - Bump version

README.md

@@ -2,22 +2,31 @@
 
 In the forge of software development, where annotations ignite, A crucible of testing, common classes to excite. Each annotation examined, with attention to detail and might, Their effects on code behavior, tested through day and night. From mockk objects to test doubles, a toolkit to refine, Developers and testers, their skills to redefine. The Annotation Validator, a sentinel of code integrity true, A library of verification, where testing wisdom shines anew.
 
+## Kafka and Postgres Test Container
+
+`@KafkaPostgresTestContainer` Annotation for integration tests.
+
+This combined `@KafkaTestContainer` and `@PostgresTestContainer`
+
+## Kafka Test Container
+
+`@KafkaTestContainer` Annotation for integration tests.
+
+Initialize Kafka test container using test container default properties
 
 ## Postgres Test Container
 
-`@PostgresContainer` Annotation for integration tests.
+`@PostgresTestContainer` Annotation for integration tests.
 
-Initialize Postgres test container using spring properties for R2DBC,
+Initialize Postgres test container using test container default properties, script located in `src/<test path>/resources/postgres/` folder.
-script located in `src/<test path>/resources` folder. And specify properties in `src/<test path>/resources/application.properties`.
 
 ### Properties For Test Container
 
-| name                       | required | example     | info                                                           |
+| file                | required | info                                                           |
-|----------------------------|:--------:|-------------|----------------------------------------------------------------|
+|---------------------|:--------:|----------------------------------------------------------------|
-| container.postgres.version |          | postgres:17 | postgres container default postgres:latest                     |
+| postgres/schema.sql | &check;  | Postgres init script containing all structure and functions    |
-| container.postgres.init    | &check;  | schema.sql  | Postgres init script containing all structure and functions    |
+| postgres/data.sql   |          | Postgres data script containing all data to populate database  |
-| container.postgres.before  |          | data.sql    | Postgres data script containing all data to populate database  |
+| postgres/reset.sql  |          | Postgres reset script containing all command to reset database |
-| container.postgres.after   |          | reset.sql   | Postgres reset script containing all command to reset database |
 
 ## Releasing library
 

build.gradle.kts

@@ -12,6 +12,7 @@ dependencies {
     implementation(hlaeja.springboot.starter.r2dbc)
     implementation(hlaeja.springboot.starter.test)
     implementation(hlaeja.testcontainers.junit)
+    implementation(hlaeja.testcontainers.kafka)
     implementation(hlaeja.testcontainers.postgresql)
 
     testRuntimeOnly(hlaeja.junit.platform.launcher)

gradle.properties

@@ -1,3 +1,3 @@
 kotlin.code.style=official
-version=0.3.0
+version=0.5.0-SNAPSHOT
-catalog=0.11.0
+catalog=0.12.0

src/main/kotlin/ltd/hlaeja/test/container/KafkaPostgresTestContainer.kt

@@ -0,0 +1,18 @@
+package ltd.hlaeja.test.container
+
+import ltd.hlaeja.test.container.extension.KafkaPostgresTestExtension
+import ltd.hlaeja.test.container.postgres.PostgresTestListener
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.TestExecutionListeners
+import org.springframework.test.context.TestExecutionListeners.MergeMode
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@ExtendWith(KafkaPostgresTestExtension::class)
+@ContextConfiguration(initializers = [KafkaPostgresTestExtension::class])
+@TestExecutionListeners(
+    listeners = [PostgresTestListener::class],
+    mergeMode = MergeMode.MERGE_WITH_DEFAULTS,
+)
+annotation class KafkaPostgresTestContainer

src/main/kotlin/ltd/hlaeja/test/container/KafkaTestContainer.kt

@@ -0,0 +1,11 @@
+package ltd.hlaeja.test.container
+
+import ltd.hlaeja.test.container.extension.KafkaTestExtension
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.test.context.ContextConfiguration
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@ExtendWith(KafkaTestExtension::class)
+@ContextConfiguration(initializers = [KafkaTestExtension::class])
+annotation class KafkaTestContainer

src/main/kotlin/ltd/hlaeja/test/container/PostgresContainer.kt

@@ -1,12 +0,0 @@
-package ltd.hlaeja.test.container
-
-import org.springframework.test.context.ContextConfiguration
-import org.springframework.test.context.TestExecutionListeners
-import org.springframework.test.context.TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS
-
-@Suppress("unused")
-@Retention(AnnotationRetention.RUNTIME)
-@Target(AnnotationTarget.CLASS)
-@ContextConfiguration(initializers = [PostgresInitializer::class])
-@TestExecutionListeners(listeners = [PostgresInitializer::class], mergeMode = MERGE_WITH_DEFAULTS)
-annotation class PostgresContainer

src/main/kotlin/ltd/hlaeja/test/container/PostgresExecutor.kt

@@ -1,55 +0,0 @@
-package ltd.hlaeja.test.container
-
-import io.github.oshai.kotlinlogging.KotlinLogging
-import java.io.BufferedReader
-import java.io.InputStream
-import java.io.InputStreamReader
-import kotlinx.coroutines.runBlocking
-import ltd.hlaeja.test.util.isResourceFile
-import org.springframework.r2dbc.core.DatabaseClient
-import org.springframework.r2dbc.core.await
-import org.springframework.stereotype.Component
-
-private val log = KotlinLogging.logger {}
-
-@Component
-class PostgresExecutor(
-    private val databaseClient: DatabaseClient,
-) {
-
-    fun executeSqlFile(
-        sqlFile: String,
-    ) = runBlocking {
-        sqlFile.isResourceFile()
-            ?.inputStream
-            ?.use {
-                log.debug { "Executing SQL file: $sqlFile" }
-                executeSqlStatements(makeSqlStatements(it))
-            }
-            ?: log.debug { "SQL file not found or not readable: $sqlFile" }
-    }
-
-    @Suppress("TooGenericExceptionThrown")
-    private suspend fun executeSqlStatements(
-        statements: List<String>,
-    ) = try {
-        statements.forEach { statement ->
-            log.debug { "Running statement: $statement" }
-            databaseClient.sql(statement).await()
-        }
-    } catch (e: Exception) {
-        throw RuntimeException("Failed to execute SQL statements", e)
-    }
-
-    private suspend fun makeSqlStatements(
-        inputStream: InputStream,
-    ): List<String> = BufferedReader(InputStreamReader(inputStream))
-        .lines()
-        .filter { it.isNotEmpty() && !it.startsWith("--") }
-        .map { it.trim() }
-        .toList()
-        .joinToString(" ")
-        .split(';')
-        .filter { it.isNotBlank() }
-        .map { "${it.trim()};" }
-}

src/main/kotlin/ltd/hlaeja/test/container/PostgresInitializer.kt

@@ -1,67 +0,0 @@
-package ltd.hlaeja.test.container
-
-import io.github.oshai.kotlinlogging.KotlinLogging
-import ltd.hlaeja.test.util.getProperty
-import ltd.hlaeja.test.util.isResourceFile
-import org.springframework.boot.test.util.TestPropertyValues
-import org.springframework.context.ApplicationContextInitializer
-import org.springframework.context.ConfigurableApplicationContext
-import org.springframework.test.context.TestContext
-import org.springframework.test.context.TestExecutionListener
-import org.testcontainers.containers.PostgreSQLContainer
-
-private val log = KotlinLogging.logger {}
-
-@Suppress("unused")
-class PostgresInitializer : ApplicationContextInitializer<ConfigurableApplicationContext>, TestExecutionListener {
-
-    companion object {
-        const val SCRIPT_INIT = "container.postgres.init"
-        const val SCRIPT_BEFORE = "container.postgres.before"
-        const val SCRIPT_AFTER = "container.postgres.after"
-        const val POSTGRES_VERSION = "container.postgres.version"
-        const val POSTGRES_LATEST = "postgres:latest"
-    }
-
-    override fun initialize(
-        context: ConfigurableApplicationContext,
-    ) {
-        postgres(context).apply {
-            TestPropertyValues.of(
-                "spring.r2dbc.url=r2dbc:pool:postgresql://$host:$firstMappedPort/$databaseName",
-                "spring.r2dbc.username=$username",
-                "spring.r2dbc.password=$password",
-            ).applyTo(context)
-        }
-    }
-
-    override fun beforeTestClass(
-        context: TestContext,
-    ) {
-        context.testClass
-            .also { log.debug { "Starting execution before class: ${it.simpleName}" } }
-            .getAnnotation(PostgresContainer::class.java) ?: return
-        context.getProperty(SCRIPT_BEFORE)
-            ?.let { context.applicationContext.getBean(PostgresExecutor::class.java).executeSqlFile(it) }
-    }
-
-    override fun afterTestClass(
-        context: TestContext,
-    ) {
-        context.testClass
-            .also { log.debug { "Starting execution after class: ${it.simpleName}" } }
-            .getAnnotation(PostgresContainer::class.java) ?: return
-        context.getProperty(SCRIPT_AFTER)
-            ?.let { context.applicationContext.getBean(PostgresExecutor::class.java).executeSqlFile(it) }
-    }
-
-    private fun postgres(
-        context: ConfigurableApplicationContext,
-    ): PostgreSQLContainer<*> = PostgreSQLContainer(context.getProperty(POSTGRES_VERSION, POSTGRES_LATEST)).apply {
-        context.getProperty(SCRIPT_INIT)
-            ?.isResourceFile()
-            ?.let { lala -> withInitScript(lala.path) }
-            ?: log.error { "Postgres init script not found" }
-        start()
-    }
-}

src/main/kotlin/ltd/hlaeja/test/container/PostgresTestContainer.kt

@@ -0,0 +1,15 @@
+package ltd.hlaeja.test.container
+
+import ltd.hlaeja.test.container.extension.PostgresTestExtension
+import ltd.hlaeja.test.container.postgres.PostgresTestListener
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.TestExecutionListeners
+import org.springframework.test.context.TestExecutionListeners.MergeMode
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@ExtendWith(PostgresTestExtension::class)
+@ContextConfiguration(initializers = [PostgresTestExtension::class])
+@TestExecutionListeners(listeners = [PostgresTestListener::class], mergeMode = MergeMode.MERGE_WITH_DEFAULTS)
+annotation class PostgresTestContainer

src/main/kotlin/ltd/hlaeja/test/container/extension/KafkaPostgresTestExtension.kt

@@ -0,0 +1,27 @@
+package ltd.hlaeja.test.container.extension
+
+import ltd.hlaeja.test.container.kafka.TestContainerKafka
+import ltd.hlaeja.test.container.postgres.TestContainerPostgres
+import org.junit.jupiter.api.extension.BeforeAllCallback
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.springframework.boot.test.util.TestPropertyValues
+import org.springframework.context.ApplicationContextInitializer
+import org.springframework.context.ConfigurableApplicationContext
+
+class KafkaPostgresTestExtension : BeforeAllCallback, ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    override fun initialize(applicationContext: ConfigurableApplicationContext) {
+        TestPropertyValues
+            .of(TestContainerPostgres.props() + TestContainerKafka.props())
+            .applyTo(applicationContext.environment)
+    }
+
+    override fun beforeAll(context: ExtensionContext) {
+        if (!TestContainerPostgres.postgres.isRunning) {
+            TestContainerPostgres.postgres.start()
+        }
+        if (!TestContainerKafka.kafka.isRunning) {
+            TestContainerKafka.kafka.start()
+        }
+    }
+}

src/main/kotlin/ltd/hlaeja/test/container/extension/KafkaTestExtension.kt

@@ -0,0 +1,21 @@
+package ltd.hlaeja.test.container.extension
+
+import ltd.hlaeja.test.container.kafka.TestContainerKafka
+import org.junit.jupiter.api.extension.BeforeAllCallback
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.springframework.boot.test.util.TestPropertyValues
+import org.springframework.context.ApplicationContextInitializer
+import org.springframework.context.ConfigurableApplicationContext
+
+class KafkaTestExtension : BeforeAllCallback, ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    override fun initialize(applicationContext: ConfigurableApplicationContext) {
+        TestPropertyValues.of(TestContainerKafka.props()).applyTo(applicationContext.environment)
+    }
+
+    override fun beforeAll(context: ExtensionContext) {
+        if (!TestContainerKafka.kafka.isRunning) {
+            TestContainerKafka.kafka.start()
+        }
+    }
+}

src/main/kotlin/ltd/hlaeja/test/container/extension/PostgresTestExtension.kt

@@ -0,0 +1,21 @@
+package ltd.hlaeja.test.container.extension
+
+import ltd.hlaeja.test.container.postgres.TestContainerPostgres
+import org.junit.jupiter.api.extension.BeforeAllCallback
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.springframework.boot.test.util.TestPropertyValues
+import org.springframework.context.ApplicationContextInitializer
+import org.springframework.context.ConfigurableApplicationContext
+
+class PostgresTestExtension : BeforeAllCallback, ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    override fun initialize(applicationContext: ConfigurableApplicationContext) {
+        TestPropertyValues.of(TestContainerPostgres.props()).applyTo(applicationContext.environment)
+    }
+
+    override fun beforeAll(context: ExtensionContext) {
+        if (!TestContainerPostgres.postgres.isRunning) {
+            TestContainerPostgres.postgres.start()
+        }
+    }
+}

src/main/kotlin/ltd/hlaeja/test/container/kafka/TestContainerKafka.kt

@@ -0,0 +1,13 @@
+package ltd.hlaeja.test.container.kafka
+
+import org.testcontainers.kafka.ConfluentKafkaContainer
+
+object TestContainerKafka {
+
+    val kafka: ConfluentKafkaContainer = ConfluentKafkaContainer("confluentinc/cp-kafka:8.0.0")
+        .withReuse(true)
+
+    fun props(): Map<String, String> = mapOf(
+        "spring.kafka.bootstrap-servers" to kafka.bootstrapServers,
+    )
+}

src/main/kotlin/ltd/hlaeja/test/container/postgres/PostgresTestListener.kt

@@ -0,0 +1,24 @@
+package ltd.hlaeja.test.container.postgres
+
+import ltd.hlaeja.test.container.postgres.TestContainerPostgres.sqlFile
+import ltd.hlaeja.test.container.util.hasAnnotation
+import org.junit.jupiter.api.Nested
+import org.springframework.test.context.TestContext
+import org.springframework.test.context.TestExecutionListener
+
+class PostgresTestListener : TestExecutionListener {
+
+    override fun beforeTestClass(
+        context: TestContext,
+    ) {
+        if (context.testClass.hasAnnotation<Nested>()) return
+        sqlFile("postgres/data.sql", context)
+    }
+
+    override fun afterTestClass(
+        context: TestContext,
+    ) {
+        if (context.testClass.hasAnnotation<Nested>()) return
+        sqlFile("postgres/reset.sql", context)
+    }
+}

src/main/kotlin/ltd/hlaeja/test/container/postgres/TestContainerPostgres.kt

@@ -0,0 +1,68 @@
+package ltd.hlaeja.test.container.postgres
+
+import java.io.BufferedReader
+import java.io.InputStream
+import java.io.InputStreamReader
+import kotlinx.coroutines.runBlocking
+import ltd.hlaeja.test.container.util.isResourceFile
+import org.springframework.r2dbc.core.DatabaseClient
+import org.springframework.r2dbc.core.await
+import org.springframework.test.context.TestContext
+import org.testcontainers.containers.PostgreSQLContainer
+import org.testcontainers.utility.DockerImageName
+
+object TestContainerPostgres {
+
+    val postgres = PostgreSQLContainer(DockerImageName.parse("postgres:17"))
+        .withReuse(true)
+        .apply {
+            withDatabaseName("testdb")
+            withUsername("test")
+            withPassword("test")
+            "postgres/schema.sql".isResourceFile()?.let { withInitScript(it.path) }
+        }
+
+    fun props(): Map<String, String> = postgres.let {
+        mapOf(
+            "spring.r2dbc.url" to "r2dbc:postgresql://${it.host}:${it.firstMappedPort}/${it.databaseName}",
+            "spring.r2dbc.username" to it.username,
+            "spring.r2dbc.password" to it.password,
+        )
+    }
+
+    fun sqlFile(
+        sqlFile: String,
+        context: TestContext,
+    ): Unit = runBlocking {
+        sqlFile.isResourceFile()
+            ?.inputStream
+            ?.use {
+                executeSqlStatements(
+                    makeSqlStatements(it),
+                    context.applicationContext.getBean(DatabaseClient::class.java),
+                )
+            }
+    }
+
+    @Suppress("TooGenericExceptionThrown", "SqlSourceToSinkFlow")
+    private suspend fun executeSqlStatements(
+        statements: List<String>,
+        databaseClient: DatabaseClient,
+    ) = try {
+        statements.forEach { databaseClient.sql(it).await() }
+    } catch (e: Exception) {
+        throw RuntimeException("Failed to execute SQL statements", e)
+    }
+
+    private fun makeSqlStatements(
+        inputStream: InputStream,
+    ): List<String> = BufferedReader(InputStreamReader(inputStream))
+        .lines()
+        .filter { it.isNotEmpty() && !it.startsWith("--") }
+        .map { it.trim() }
+        .toList()
+        .joinToString(" ")
+        .split(';')
+        .filter { it.isNotBlank() }
+        .map { "${it.trim()};" }
+}

src/main/kotlin/ltd/hlaeja/test/container/util/ContainerUtil.kt

@@ -0,0 +1,12 @@
+package ltd.hlaeja.test.container.util
+
+import org.springframework.core.io.ClassPathResource
+
+fun String.isResourceFile(): ClassPathResource? = ClassPathResource(this).let { resource ->
+    when {
+        resource.exists() && resource.isReadable -> resource
+        else -> null
+    }
+}
+
+inline fun <reified T : Annotation> Class<*>.hasAnnotation(): Boolean = getAnnotation(T::class.java) != null

src/main/kotlin/ltd/hlaeja/test/util/ContainerUtil.kt

@@ -1,26 +0,0 @@
-package ltd.hlaeja.test.util
-
-import org.springframework.context.ConfigurableApplicationContext
-import org.springframework.core.io.ClassPathResource
-import org.springframework.test.context.TestContext
-
-fun ConfigurableApplicationContext.getProperty(
-    property: String,
-): String? = this.environment.getProperty(property)
-
-fun ConfigurableApplicationContext.getProperty(
-    property: String,
-    default: String,
-): String = this.environment.getProperty(property, default)
-
-fun TestContext.getProperty(
-    property: String,
-): String? = this.applicationContext.environment.getProperty(property)
-
-fun String.isResourceFile(): ClassPathResource? {
-    val resource = ClassPathResource(this)
-    return when {
-        resource.exists() && resource.isReadable -> resource
-        else -> null
-    }
-}