align container options for whole project (#341)

osoykan · web-flow · commit c602ee82082e · 2024-02-28T11:21:33.000+01:00
* align container options for whole project

* fix test
diff --git a/lib/stove-testing-e2e-couchbase/build.gradle.kts b/lib/stove-testing-e2e-couchbase/build.gradle.kts
@@ -1,7 +1,7 @@
 dependencies {
     api(projects.lib.stoveTestingE2e)
     api(libs.couchbase.kotlin)
-    implementation(libs.testcontainers.couchbase)
+    api(libs.testcontainers.couchbase)
 }
 
 dependencies {
diff --git a/lib/stove-testing-e2e-couchbase/src/main/kotlin/com/trendyol/stove/testing/e2e/couchbase/Options.kt b/lib/stove-testing-e2e-couchbase/src/main/kotlin/com/trendyol/stove/testing/e2e/couchbase/Options.kt
@@ -10,6 +10,7 @@ import com.trendyol.stove.testing.e2e.system.*
 import com.trendyol.stove.testing.e2e.system.abstractions.*
 import com.trendyol.stove.testing.e2e.system.annotations.StoveDsl
 import org.testcontainers.couchbase.*
+import org.testcontainers.utility.DockerImageName
 
 data class CouchbaseExposedConfiguration(
     val connectionString: String,
@@ -21,7 +22,7 @@ data class CouchbaseExposedConfiguration(
 @StoveDsl
 data class CouchbaseSystemOptions(
     val defaultBucket: String,
-    val containerOptions: ContainerOptions = ContainerOptions(),
+    val containerOptions: CouchbaseContainerOptions = CouchbaseContainerOptions(),
     override val configureExposedConfiguration: (CouchbaseExposedConfiguration) -> List<String> = { _ -> listOf() },
     val objectMapper: ObjectMapper = StoveObjectMapper.Default
 ) : SystemOptions, ConfiguresExposedConfiguration<CouchbaseExposedConfiguration> {
@@ -47,20 +48,26 @@ data class CouchbaseContext(
 )
 
 @StoveDsl
-data class ContainerOptions(
-    val registry: String = DEFAULT_REGISTRY,
-    val imageVersion: String = "latest"
-)
+data class CouchbaseContainerOptions(
+    override val registry: String = DEFAULT_REGISTRY,
+    override val image: String = "couchbase/server",
+    override val tag: String = "latest",
+    override val compatibleSubstitute: String? = null,
+    val containerImageFn: DockerImageName.() -> DockerImageName = { this },
+    val containerFn: CouchbaseContainer.() -> CouchbaseContainer = { this }
+) : ContainerOptions
 
 internal fun TestSystem.withCouchbase(options: CouchbaseSystemOptions): TestSystem {
     val bucketDefinition = BucketDefinition(options.defaultBucket)
     val couchbaseContainer = withProvidedRegistry(
-        imageName = "couchbase/server:${options.containerOptions.imageVersion}",
-        registry = options.containerOptions.registry
+        imageName = options.containerOptions.imageWithTag,
+        registry = options.containerOptions.registry,
+        compatibleSubstitute = options.containerOptions.compatibleSubstitute
     ) {
-        CouchbaseContainer(it)
+        CouchbaseContainer(it.let(options.containerOptions.containerImageFn))
             .withBucket(bucketDefinition)
             .withReuse(this.options.keepDependenciesRunning)
+            .let(options.containerOptions.containerFn)
     }
     this.getOrRegister(
         CouchbaseSystem(this, CouchbaseContext(bucketDefinition, couchbaseContainer, options))
diff --git a/lib/stove-testing-e2e-couchbase/src/test/kotlin/com/trendyol/stove/testing/e2e/couchbase/CouchbaseTestSystemTests.kt b/lib/stove-testing-e2e-couchbase/src/test/kotlin/com/trendyol/stove/testing/e2e/couchbase/CouchbaseTestSystemTests.kt
@@ -24,8 +24,8 @@ class Setup : AbstractProjectConfig() {
             couchbase {
                 CouchbaseSystemOptions(
                     defaultBucket = TEST_BUCKET,
-                    containerOptions = ContainerOptions(
-                        imageVersion = "latest"
+                    containerOptions = CouchbaseContainerOptions(
+                        tag = "latest"
                     )
                 )
                     .migrations {
diff --git a/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/ElasticsearchSystem.kt b/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/ElasticsearchSystem.kt
@@ -41,14 +41,14 @@ class ElasticsearchSystem internal constructor(
                 ElasticSearchExposedConfiguration(
                     context.container.host,
                     context.container.firstMappedPort,
-                    context.options.containerOptions.password,
+                    context.options.container.password,
                     determineCertificate()
                 )
             }
     }
 
     private fun determineCertificate(): Option<ElasticsearchExposedCertificate> =
-        when (context.options.containerOptions.disableSecurity) {
+        when (context.options.container.disableSecurity) {
             true -> None
             false ->
                 ElasticsearchExposedCertificate(
@@ -164,7 +164,7 @@ class ElasticsearchSystem internal constructor(
             .let { ElasticsearchClient(it) }
 
     private fun restClient(cfg: ElasticSearchExposedConfiguration): RestClient =
-        when (context.options.containerOptions.disableSecurity) {
+        when (context.options.container.disableSecurity) {
             true ->
                 RestClient.builder(HttpHost(exposedConfiguration.host, exposedConfiguration.port)).apply {
                     setHttpClientConfigCallback { http -> http.also(context.options.clientConfigurer.httpClientBuilder) }
diff --git a/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/Extensions.kt b/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/Extensions.kt
@@ -21,18 +21,18 @@ internal fun TestSystem.withElasticsearch(options: ElasticsearchSystemOptions):
     options.objectMapper.registerArrowModule()
 
     return withProvidedRegistry(
-        imageName = "elasticsearch/elasticsearch:${options.containerOptions.imageVersion}",
-        registry = options.containerOptions.registry,
-        compatibleSubstitute = options.containerOptions.compatibleSubstitute.getOrNull()
+        imageName = options.container.imageWithTag,
+        registry = options.container.registry,
+        compatibleSubstitute = options.container.compatibleSubstitute
     ) { ElasticsearchContainer(it) }
         .apply {
-            addExposedPorts(*options.containerOptions.exposedPorts.toIntArray())
-            withPassword(options.containerOptions.password)
-            if (options.containerOptions.disableSecurity) {
+            addExposedPorts(*options.container.exposedPorts.toIntArray())
+            withPassword(options.container.password)
+            if (options.container.disableSecurity) {
                 withEnv("xpack.security.enabled", "false")
             }
             withReuse(this@withElasticsearch.options.keepDependenciesRunning)
-            options.containerOptions.configureContainer(this)
+            options.container.configureContainer(this)
         }
         .let { getOrRegister(ElasticsearchSystem(this, ElasticsearchContext(options.defaultIndex.index, it, options))) }
         .let { this }
diff --git a/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/Options.kt b/lib/stove-testing-e2e-elasticsearch/src/main/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/Options.kt
@@ -1,16 +1,12 @@
 package com.trendyol.stove.testing.e2e.elasticsearch
 
-import arrow.core.None
-import arrow.core.Option
-import arrow.core.none
+import arrow.core.*
 import co.elastic.clients.elasticsearch.ElasticsearchClient
 import com.fasterxml.jackson.databind.ObjectMapper
-import com.trendyol.stove.testing.e2e.database.migrations.DatabaseMigration
-import com.trendyol.stove.testing.e2e.database.migrations.MigrationCollection
+import com.trendyol.stove.testing.e2e.containers.ContainerOptions
+import com.trendyol.stove.testing.e2e.database.migrations.*
 import com.trendyol.stove.testing.e2e.serialization.StoveObjectMapper
-import com.trendyol.stove.testing.e2e.system.abstractions.ConfiguresExposedConfiguration
-import com.trendyol.stove.testing.e2e.system.abstractions.ExposedConfiguration
-import com.trendyol.stove.testing.e2e.system.abstractions.SystemOptions
+import com.trendyol.stove.testing.e2e.system.abstractions.*
 import com.trendyol.stove.testing.e2e.system.annotations.StoveDsl
 import org.apache.http.client.config.RequestConfig
 import org.apache.http.impl.nio.client.HttpAsyncClientBuilder
@@ -22,7 +18,7 @@ import kotlin.time.Duration.Companion.minutes
 data class ElasticsearchSystemOptions(
     val defaultIndex: DefaultIndex,
     val clientConfigurer: ElasticClientConfigurer = ElasticClientConfigurer(),
-    val containerOptions: ContainerOptions = ContainerOptions(),
+    val container: ElasticContainerOptions = ElasticContainerOptions(),
     val objectMapper: ObjectMapper = StoveObjectMapper.Default,
     override val configureExposedConfiguration: (ElasticSearchExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<ElasticSearchExposedConfiguration> {
@@ -54,15 +50,16 @@ data class ElasticsearchContext(
     val options: ElasticsearchSystemOptions
 )
 
-data class ContainerOptions(
-    val registry: String = "docker.elastic.co/",
-    val imageVersion: String = "8.6.1",
-    val compatibleSubstitute: Option<String> = None,
+data class ElasticContainerOptions(
+    override val registry: String = "docker.elastic.co/",
+    override val tag: String = "8.6.1",
+    override val image: String = "elasticsearch/elasticsearch",
+    override val compatibleSubstitute: String? = null,
     val exposedPorts: List<Int> = listOf(9200),
     val password: String = "password",
     val disableSecurity: Boolean = true,
     val configureContainer: ElasticsearchContainer.() -> Unit = {}
-)
+) : ContainerOptions
 
 data class ElasticClientConfigurer(
     val httpClientBuilder: HttpAsyncClientBuilder.() -> Unit = {
diff --git a/lib/stove-testing-e2e-elasticsearch/src/test/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/ElasticsearchTestSystemTests.kt b/lib/stove-testing-e2e-elasticsearch/src/test/kotlin/com/trendyol/stove/testing/e2e/elasticsearch/ElasticsearchTestSystemTests.kt
@@ -64,7 +64,7 @@ class Setup : AbstractProjectConfig() {
                                         RestClient.builder(HttpHost(cfg.host, cfg.port)).build()
                                     }
                             ),
-                        ContainerOptions(imageVersion = "8.9.0")
+                        ElasticContainerOptions(tag = "8.9.0")
                     ).migrations { register<AnotherIndexMigrator>() }
                 }
                 applicationUnderTest(NoOpApplication())
diff --git a/lib/stove-testing-e2e-mongodb/src/main/kotlin/com/trendyol/stove/testing/e2e/mongodb/Options.kt b/lib/stove-testing-e2e-mongodb/src/main/kotlin/com/trendyol/stove/testing/e2e/mongodb/Options.kt
@@ -26,7 +26,7 @@ data class MongoContainerOptions(
     override val registry: String = DEFAULT_REGISTRY,
     override val image: String = "mongo",
     override val tag: String = "latest",
-    override val imageWithTag: String = "$image:$tag"
+    override val compatibleSubstitute: String? = null
 ) : ContainerOptions
 
 @StoveDsl
@@ -40,11 +40,14 @@ data class DatabaseOptions(
 }
 
 internal fun TestSystem.withMongodb(options: MongodbSystemOptions): TestSystem {
-    val mongodbContainer =
-        withProvidedRegistry(options.container.imageWithTag, options.container.registry) {
-            MongoDBContainer(it)
-                .withReuse(this.options.keepDependenciesRunning)
-        }
+    val mongodbContainer = withProvidedRegistry(
+        options.container.imageWithTag,
+        options.container.registry,
+        options.container.compatibleSubstitute
+    ) {
+        MongoDBContainer(it)
+            .withReuse(this.options.keepDependenciesRunning)
+    }
     this.getOrRegister(
         MongodbSystem(this, MongodbContext(mongodbContainer, options))
     )
diff --git a/lib/stove-testing-e2e-rdbms-mssql/src/main/kotlin/com/trendyol/stove/testing/e2e/rdbms/mssql/MsSqlOptions.kt b/lib/stove-testing-e2e-rdbms-mssql/src/main/kotlin/com/trendyol/stove/testing/e2e/rdbms/mssql/MsSqlOptions.kt
@@ -9,12 +9,19 @@ import com.trendyol.stove.testing.e2e.system.abstractions.*
 import com.trendyol.stove.testing.e2e.system.annotations.StoveDsl
 import org.testcontainers.containers.MSSQLServerContainer
 
+data class MssqlContainerOptions(
+    override val registry: String = DEFAULT_REGISTRY,
+    override val image: String = MSSQLServerContainer.IMAGE,
+    override val tag: String = "2017-CU12",
+    override val compatibleSubstitute: String? = null
+) : ContainerOptions
+
 data class MsSqlOptions(
     val applicationName: String,
     val databaseName: String,
     val userName: String,
     val password: String,
-    val registry: String = DEFAULT_REGISTRY,
+    val container: MssqlContainerOptions = MssqlContainerOptions(),
     val configureContainer: MSSQLServerContainer<*>.() -> MSSQLServerContainer<*> = { this },
     override val configureExposedConfiguration: (RelationalDatabaseExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<RelationalDatabaseExposedConfiguration> {
@@ -50,7 +57,11 @@ internal fun TestSystem.mssql(): MsSqlSystem =
     }
 
 internal fun TestSystem.withMsSql(options: MsSqlOptions): TestSystem =
-    withProvidedRegistry(MSSQLServerContainer.IMAGE) {
+    withProvidedRegistry(
+        options.container.imageWithTag,
+        options.container.registry,
+        options.container.compatibleSubstitute
+    ) {
         val container = MSSQLServerContainer(it)
             .acceptLicense()
             .withEnv("MSSQL_USER", options.userName)
diff --git a/lib/stove-testing-e2e-rdbms-postgres/src/main/kotlin/com/trendol/stove/testing/e2e/rdbms/postgres/Options.kt b/lib/stove-testing-e2e-rdbms-postgres/src/main/kotlin/com/trendol/stove/testing/e2e/rdbms/postgres/Options.kt
@@ -11,11 +11,17 @@ import org.testcontainers.containers.PostgreSQLContainer
 
 const val DEFAULT_POSTGRES_IMAGE_NAME = "postgres"
 
+data class PostgresqlContainerOptions(
+    override val registry: String = DEFAULT_REGISTRY,
+    override val image: String = DEFAULT_POSTGRES_IMAGE_NAME,
+    override val tag: String = "latest",
+    override val compatibleSubstitute: String? = null
+) : ContainerOptions
+
 @StoveDsl
 data class PostgresqlOptions(
     val databaseName: String = "stove-e2e-testing",
-    val registry: String = DEFAULT_REGISTRY,
-    val imageName: String = DEFAULT_POSTGRES_IMAGE_NAME,
+    val container: PostgresqlContainerOptions = PostgresqlContainerOptions(),
     override val configureExposedConfiguration: (RelationalDatabaseExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<RelationalDatabaseExposedConfiguration> {
     val migrationCollection: MigrationCollection<PostgresSqlMigrationContext> = MigrationCollection()
@@ -42,7 +48,7 @@ data class PostgresSqlMigrationContext(
 )
 
 internal fun TestSystem.withPostgresql(options: PostgresqlOptions = PostgresqlOptions()): TestSystem =
-    withProvidedRegistry(options.imageName, options.registry, "postgres") {
+    withProvidedRegistry(options.container.imageWithTag, options.container.registry, options.container.compatibleSubstitute) {
         PostgreSQLContainer(it)
             .withDatabaseName(options.databaseName)
             .withUsername("sa")
diff --git a/lib/stove-testing-e2e-redis/src/main/kotlin/com/trendyol/stove/testing/e2e/redis/RedisOptions.kt b/lib/stove-testing-e2e-redis/src/main/kotlin/com/trendyol/stove/testing/e2e/redis/RedisOptions.kt
@@ -7,11 +7,18 @@ import com.trendyol.stove.testing.e2e.system.*
 import com.trendyol.stove.testing.e2e.system.abstractions.*
 import com.trendyol.stove.testing.e2e.system.annotations.StoveDsl
 
+data class RedisContainerOptions(
+    override val registry: String = DEFAULT_REGISTRY,
+    override val image: String = RedisContainer.DEFAULT_IMAGE_NAME.unversionedPart,
+    override val tag: String = RedisContainer.DEFAULT_TAG,
+    override val compatibleSubstitute: String? = null
+) : ContainerOptions
+
 @StoveDsl
 data class RedisOptions(
     val database: Int = 8,
     val password: String = "password",
-    val registry: String = DEFAULT_REGISTRY,
+    val container: RedisContainerOptions = RedisContainerOptions(),
     override val configureExposedConfiguration: (RedisExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<RedisExposedConfiguration>
 
@@ -42,7 +49,7 @@ internal fun TestSystem.redis(): RedisSystem =
     }
 
 internal fun TestSystem.withRedis(options: RedisOptions = RedisOptions()): TestSystem =
-    withProvidedRegistry(RedisContainer.DEFAULT_IMAGE_NAME.unversionedPart) {
+    withProvidedRegistry(options.container.image, options.container.registry, options.container.compatibleSubstitute) {
         RedisContainer(it)
             .withCommand("redis-server", "--requirepass", options.password)
             .withReuse(this.options.keepDependenciesRunning)
diff --git a/lib/stove-testing-e2e-redis/src/test/kotlin/com/trendyol/stove/testing/e2e/redis/RedisSystemTests.kt b/lib/stove-testing-e2e-redis/src/test/kotlin/com/trendyol/stove/testing/e2e/redis/RedisSystemTests.kt
@@ -13,7 +13,9 @@ class Setup : AbstractProjectConfig() {
         TestSystem()
             .with {
                 redis {
-                    RedisOptions()
+                    RedisOptions(
+                        container = RedisContainerOptions()
+                    )
                 }
                 applicationUnderTest(NoOpApplication())
             }.run()
diff --git a/lib/stove-testing-e2e/build.gradle.kts b/lib/stove-testing-e2e/build.gradle.kts
@@ -1,5 +1,5 @@
 dependencies {
     api(libs.kotlinx.core)
     api(libs.jackson.kotlin)
-    implementation(libs.testcontainers)
+    api(libs.testcontainers)
 }
diff --git a/lib/stove-testing-e2e/src/main/kotlin/com/trendyol/stove/testing/e2e/containers/ContainerOptions.kt b/lib/stove-testing-e2e/src/main/kotlin/com/trendyol/stove/testing/e2e/containers/ContainerOptions.kt
@@ -10,7 +10,7 @@ interface ContainerOptions {
 
     val tag: String
 
-    val imageWithTag: String
+    val imageWithTag: String get() = "$image:$tag"
 
-    val compatibleSubstitute: String get() = image
+    val compatibleSubstitute: String?
 }
diff --git a/lib/stove-testing-e2e/src/main/kotlin/com/trendyol/stove/testing/e2e/containers/ProvidedRegistry.kt b/lib/stove-testing-e2e/src/main/kotlin/com/trendyol/stove/testing/e2e/containers/ProvidedRegistry.kt
@@ -22,9 +22,8 @@ fun <T> withProvidedRegistry(
     registry: String = DEFAULT_REGISTRY,
     compatibleSubstitute: String? = null,
     containerBuilder: (DockerImageName) -> T
-): T =
-    containerBuilder(
-        DockerImageName
-            .parse(registry.trim('/') + '/' + imageName.trim('/'))
-            .asCompatibleSubstituteFor(compatibleSubstitute ?: imageName)
-    )
+): T = containerBuilder(
+    DockerImageName
+        .parse(registry.trim('/') + '/' + imageName.trim('/'))
+        .asCompatibleSubstituteFor(compatibleSubstitute ?: imageName)
+)
diff --git a/starters/spring/stove-spring-testing-e2e-kafka/src/main/kotlin/com/trendyol/stove/testing/e2e/kafka/Options.kt b/starters/spring/stove-spring-testing-e2e-kafka/src/main/kotlin/com/trendyol/stove/testing/e2e/kafka/Options.kt
@@ -21,7 +21,7 @@ data class KafkaContainerOptions(
     override val registry: String = DEFAULT_REGISTRY,
     override val image: String = "confluentinc/cp-kafka",
     override val tag: String = "latest",
-    override val imageWithTag: String = "$image:$tag"
+    override val compatibleSubstitute: String? = null
 ) : ContainerOptions
 
 data class KafkaOps(
@@ -49,7 +49,11 @@ data class KafkaContext(
 )
 
 internal fun TestSystem.withKafka(options: KafkaSystemOptions = KafkaSystemOptions()): TestSystem =
-    withProvidedRegistry(options.containerOptions.imageWithTag, registry = options.registry) {
+    withProvidedRegistry(
+        options.containerOptions.imageWithTag,
+        registry = options.registry,
+        compatibleSubstitute = options.containerOptions.compatibleSubstitute
+    ) {
         KafkaContainer(it).withExposedPorts(*options.ports.toTypedArray())
             .withEmbeddedZookeeper()
             .withReuse(this.options.keepDependenciesRunning)

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`dependencies {`
`2`	`2`	`api(projects.lib.stoveTestingE2e)`
`3`	`3`	`api(libs.couchbase.kotlin)`
`4`		`- implementation(libs.testcontainers.couchbase)`
	`4`	`+ api(libs.testcontainers.couchbase)`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@ class Setup : AbstractProjectConfig() {`
`24`	`24`	`couchbase {`
`25`	`25`	`CouchbaseSystemOptions(`
`26`	`26`	`defaultBucket = TEST_BUCKET,`
`27`		`- containerOptions = ContainerOptions(`
`28`		`- imageVersion = "latest"`
	`27`	`+ containerOptions = CouchbaseContainerOptions(`
	`28`	`+ tag = "latest"`
`29`	`29`	`)`
`30`	`30`	`)`
`31`	`31`	`.migrations {`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ class Setup : AbstractProjectConfig() {`
`64`	`64`	`RestClient.builder(HttpHost(cfg.host, cfg.port)).build()`
`65`	`65`	`}`
`66`	`66`	`),`
`67`		`- ContainerOptions(imageVersion = "8.9.0")`
	`67`	`+ ElasticContainerOptions(tag = "8.9.0")`
`68`	`68`	`).migrations { register<AnotherIndexMigrator>() }`
`69`	`69`	`}`
`70`	`70`	`applicationUnderTest(NoOpApplication())`