expose containerFn accross the project #363 (#372)

osoykan · web-flow · commit f9eee366d2ee · 2024-04-02T09:07:21.000+02:00
diff --git a/.java-version b/.java-version
@@ -1 +1 @@
-16.0.2
+17.0.10
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,7 +4,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 plugins {
     kotlin("jvm").version(libs.versions.kotlin)
     alias(libs.plugins.dokka)
-    alias(libs.plugins.kotlinter)
+    alias(libs.plugins.spotless)
     alias(libs.plugins.gitVersioning)
     `test-report-aggregation`
     id("stove-publishing") apply false
@@ -46,7 +46,7 @@ dependencies {
 subprojects.of("lib", "spring", "examples", "ktor") {
     apply {
         plugin("kotlin")
-        plugin(rootProject.libs.plugins.kotlinter.get().pluginId)
+        plugin(rootProject.libs.plugins.spotless.get().pluginId)
         plugin(rootProject.libs.plugins.dokka.get().pluginId)
         plugin("test-report-aggregation")
         plugin(rootProject.testLibs.plugins.testLogger.get().pluginId)
@@ -68,9 +68,15 @@ subprojects.of("lib", "spring", "examples", "ktor") {
         testImplementation(testLibs.kotest.property.jvm)
     }
 
+    spotless {
+        kotlin {
+            ktlint().setEditorConfigPath(rootProject.layout.projectDirectory.file(".editorconfig"))
+        }
+    }
+
     tasks {
         test {
-            dependsOn(formatKotlin)
+            dependsOn(spotlessApply)
             useJUnitPlatform()
             testlogger {
                 setTheme("mocha")
@@ -87,7 +93,7 @@ subprojects.of("lib", "spring", "examples", "ktor") {
         }
 
         withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
-            dependsOn(formatKotlin, lintKotlin)
+            dependsOn(spotlessApply)
             compilerOptions {
                 jvmTarget.set(JvmTarget.JVM_17)
                 allWarningsAsErrors = true
diff --git a/examples/spring-example/src/test/kotlin/com/stove/spring/example/e2e/TestSystemConfig.kt b/examples/spring-example/src/test/kotlin/com/stove/spring/example/e2e/TestSystemConfig.kt
@@ -19,7 +19,8 @@ class TestSystemConfig : AbstractProjectConfig() {
                 couchbase { CouchbaseSystemOptions("Stove") }
                 kafka {
                     KafkaSystemOptions(
-                        containerOptions = KafkaContainerOptions(tag = "latest")
+                        containerOptions = KafkaContainerOptions(tag = "latest") {
+                        }
                     )
                 }
                 bridge()
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -30,6 +30,7 @@ mongodb = "5.0.0"
 wiremock = "3.4.2"
 testcontainers = "1.19.7"
 r2dbc-mssql = "1.0.2.RELEASE"
+spotless = "6.25.0"
 
 [libraries]
 kotlin-stdlib-jdk8 = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
@@ -108,4 +109,5 @@ dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 knit = { id = "org.jetbrains.kotlinx:kotlinx-knit", version.ref = "knit" }
 kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }
 gitVersioning = { id = "com.palantir.git-version", version = "3.0.0" }
+spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 
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,7 +10,6 @@ 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,
@@ -53,8 +52,7 @@ data class CouchbaseContainerOptions(
     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 }
+    override val containerFn: ContainerFn<CouchbaseContainer> = { }
 ) : ContainerOptions
 
 internal fun TestSystem.withCouchbase(options: CouchbaseSystemOptions): TestSystem {
@@ -64,10 +62,10 @@ internal fun TestSystem.withCouchbase(options: CouchbaseSystemOptions): TestSyst
         registry = options.containerOptions.registry,
         compatibleSubstitute = options.containerOptions.compatibleSubstitute
     ) {
-        CouchbaseContainer(it.let(options.containerOptions.containerImageFn))
+        CouchbaseContainer(it)
             .withBucket(bucketDefinition)
             .withReuse(this.options.keepDependenciesRunning)
-            .let(options.containerOptions.containerFn)
+            .apply(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
@@ -27,10 +27,9 @@ class Setup : AbstractProjectConfig() {
                     containerOptions = CouchbaseContainerOptions(
                         tag = "latest"
                     )
-                )
-                    .migrations {
-                        register<DefaultMigration>()
-                    }
+                ).migrations {
+                    register<DefaultMigration>()
+                }
             }
             applicationUnderTest(NoOpApplication())
         }.run()
diff --git a/lib/stove-testing-e2e-elasticsearch/build.gradle.kts b/lib/stove-testing-e2e-elasticsearch/build.gradle.kts
@@ -2,7 +2,7 @@ plugins {}
 dependencies {
     api(projects.lib.stoveTestingE2e)
     api(libs.elastic)
-    implementation(libs.testcontainers.elasticsearch)
+    api(libs.testcontainers.elasticsearch)
     implementation(libs.jackson.databind)
     implementation(libs.jackson.arrow)
 }
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
@@ -32,7 +32,7 @@ internal fun TestSystem.withElasticsearch(options: ElasticsearchSystemOptions):
                 withEnv("xpack.security.enabled", "false")
             }
             withReuse(this@withElasticsearch.options.keepDependenciesRunning)
-            options.container.configureContainer(this)
+            options.container.containerFn(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
@@ -3,7 +3,7 @@ package com.trendyol.stove.testing.e2e.elasticsearch
 import arrow.core.*
 import co.elastic.clients.elasticsearch.ElasticsearchClient
 import com.fasterxml.jackson.databind.ObjectMapper
-import com.trendyol.stove.testing.e2e.containers.ContainerOptions
+import com.trendyol.stove.testing.e2e.containers.*
 import com.trendyol.stove.testing.e2e.database.migrations.*
 import com.trendyol.stove.testing.e2e.serialization.StoveObjectMapper
 import com.trendyol.stove.testing.e2e.system.abstractions.*
@@ -58,7 +58,7 @@ data class ElasticContainerOptions(
     val exposedPorts: List<Int> = listOf(9200),
     val password: String = "password",
     val disableSecurity: Boolean = true,
-    val configureContainer: ElasticsearchContainer.() -> Unit = {}
+    override val containerFn: ContainerFn<ElasticsearchContainer> = {}
 ) : ContainerOptions
 
 data class ElasticClientConfigurer(
diff --git a/lib/stove-testing-e2e-kafka/build.gradle.kts b/lib/stove-testing-e2e-kafka/build.gradle.kts
@@ -1,11 +1,11 @@
 dependencies {
     api(projects.lib.stoveTestingE2e)
+    api(libs.testcontainers.kafka)
     implementation(libs.kafka)
     implementation(libs.kotlinx.io.reactor.extensions)
     implementation(libs.kotlinx.jdk8)
     implementation(libs.kotlinx.core)
     implementation(libs.kafkaKotlin)
-    implementation(libs.testcontainers.kafka)
 }
 
 dependencies {
diff --git a/lib/stove-testing-e2e-mongodb/build.gradle.kts b/lib/stove-testing-e2e-mongodb/build.gradle.kts
@@ -1,11 +1,11 @@
 dependencies {
     api(projects.lib.stoveTestingE2e)
+    api(libs.testcontainers.mongodb)
     implementation(libs.mongodb.reactivestreams)
     implementation(libs.kotlinx.io.reactor.extensions)
     implementation(libs.kotlinx.reactive)
     implementation(libs.kotlinx.jdk8)
     implementation(libs.kotlinx.core)
-    implementation(libs.testcontainers.mongodb)
 }
 
 dependencies {
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,8 @@ data class MongoContainerOptions(
     override val registry: String = DEFAULT_REGISTRY,
     override val image: String = "mongo",
     override val tag: String = "latest",
-    override val compatibleSubstitute: String? = null
+    override val compatibleSubstitute: String? = null,
+    override val containerFn: ContainerFn<MongoDBContainer> = {}
 ) : ContainerOptions
 
 @StoveDsl
@@ -47,6 +48,7 @@ internal fun TestSystem.withMongodb(options: MongodbSystemOptions): TestSystem {
     ) {
         MongoDBContainer(it)
             .withReuse(this.options.keepDependenciesRunning)
+            .apply(options.container.containerFn)
     }
     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
@@ -13,7 +13,8 @@ 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
+    override val compatibleSubstitute: String? = null,
+    override val containerFn: ContainerFn<MSSQLServerContainer<*>> = {}
 ) : ContainerOptions
 
 data class MsSqlOptions(
@@ -22,7 +23,6 @@ data class MsSqlOptions(
     val userName: String,
     val password: String,
     val container: MssqlContainerOptions = MssqlContainerOptions(),
-    val configureContainer: MSSQLServerContainer<*>.() -> MSSQLServerContainer<*> = { this },
     override val configureExposedConfiguration: (RelationalDatabaseExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<RelationalDatabaseExposedConfiguration> {
     val migrationCollection: MigrationCollection<SqlMigrationContext> = MigrationCollection()
@@ -62,13 +62,13 @@ internal fun TestSystem.withMsSql(options: MsSqlOptions): TestSystem =
         options.container.registry,
         options.container.compatibleSubstitute
     ) {
-        val container = MSSQLServerContainer(it)
+        MSSQLServerContainer(it)
             .acceptLicense()
             .withEnv("MSSQL_USER", options.userName)
             .withEnv("MSSQL_SA_PASSWORD", options.password)
             .withEnv("MSSQL_DB", options.databaseName)
             .withPassword(options.password)
             .withReuse(this.options.keepDependenciesRunning)
-        options.configureContainer(container)
+            .apply(options.container.containerFn)
     }.let { getOrRegister(MsSqlSystem(this, MsSqlContext(it, options))) }
         .let { this }
diff --git a/lib/stove-testing-e2e-rdbms-mssql/src/test/kotlin/com/trendyol/stove/testing/e2e/rdbms/mssql/MssqlSystemTest.kt b/lib/stove-testing-e2e-rdbms-mssql/src/test/kotlin/com/trendyol/stove/testing/e2e/rdbms/mssql/MssqlSystemTest.kt
@@ -21,9 +21,8 @@ class Setup : AbstractProjectConfig() {
                         databaseName = "test",
                         userName = "sa",
                         password = "Password12!",
-                        configureContainer = {
+                        container = MssqlContainerOptions {
                             dockerImageName = "mcr.microsoft.com/mssql/server:latest"
-                            this
                         }
                     ).migrations {
                         register<InitialMigration>()
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
@@ -15,7 +15,8 @@ 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
+    override val compatibleSubstitute: String? = null,
+    override val containerFn: ContainerFn<PostgreSQLContainer<*>> = {}
 ) : ContainerOptions
 
 @StoveDsl
@@ -54,6 +55,7 @@ internal fun TestSystem.withPostgresql(options: PostgresqlOptions = PostgresqlOp
             .withUsername("sa")
             .withPassword("sa")
             .withReuse(this.options.keepDependenciesRunning)
+            .apply(options.container.containerFn)
     }.let { getOrRegister(PostgresqlSystem(this, PostgresqlContext(it, options))) }
         .let { this }
 
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
@@ -11,7 +11,8 @@ 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
+    override val compatibleSubstitute: String? = null,
+    override val containerFn: ContainerFn<RedisContainer> = {}
 ) : ContainerOptions
 
 @StoveDsl
@@ -53,5 +54,6 @@ internal fun TestSystem.withRedis(options: RedisOptions = RedisOptions()): TestS
         RedisContainer(it)
             .withCommand("redis-server", "--requirepass", options.password)
             .withReuse(this.options.keepDependenciesRunning)
+            .apply(options.container.containerFn)
     }.let { getOrRegister(RedisSystem(this, RedisContext(it, options))) }
         .let { this }
diff --git a/lib/stove-testing-e2e/build.gradle.kts b/lib/stove-testing-e2e/build.gradle.kts
@@ -1,5 +1,9 @@
 dependencies {
     api(libs.kotlinx.core)
     api(libs.jackson.kotlin)
-    api(libs.testcontainers)
+    api(libs.testcontainers) {
+        version {
+            require(libs.testcontainers.asProvider().get().version!!)
+        }
+    }
 }
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
@@ -1,5 +1,7 @@
 package com.trendyol.stove.testing.e2e.containers
 
+typealias ContainerFn<T> = T.() -> Unit
+
 /**
  * Container options to run
  */
@@ -13,4 +15,6 @@ interface ContainerOptions {
     val imageWithTag: String get() = "$image:$tag"
 
     val compatibleSubstitute: String?
+
+    val containerFn: ContainerFn<*>
 }
diff --git a/starters/spring/stove-spring-testing-e2e-kafka/build.gradle.kts b/starters/spring/stove-spring-testing-e2e-kafka/build.gradle.kts
@@ -1,7 +1,7 @@
 dependencies {
     api(projects.lib.stoveTestingE2e)
+    api(libs.testcontainers.kafka)
     implementation(libs.spring.boot.kafka)
-    implementation(libs.testcontainers.kafka)
 }
 
 dependencies {
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,8 @@ data class KafkaContainerOptions(
     override val registry: String = DEFAULT_REGISTRY,
     override val image: String = "confluentinc/cp-kafka",
     override val tag: String = "latest",
-    override val compatibleSubstitute: String? = null
+    override val compatibleSubstitute: String? = null,
+    override val containerFn: ContainerFn<KafkaContainer> = {}
 ) : ContainerOptions
 
 data class KafkaOps(
@@ -36,7 +37,7 @@ data class KafkaSystemOptions(
     val registry: String = DEFAULT_REGISTRY,
     val ports: List<Int> = listOf(9092, 9093),
     val objectMapper: ObjectMapper = StoveObjectMapper.Default,
-    val containerOptions: ContainerOptions = KafkaContainerOptions(),
+    val containerOptions: KafkaContainerOptions = KafkaContainerOptions(),
     val ops: KafkaOps = KafkaOps(),
     override val configureExposedConfiguration: (KafkaExposedConfiguration) -> List<String> = { _ -> listOf() }
 ) : SystemOptions, ConfiguresExposedConfiguration<KafkaExposedConfiguration>
@@ -54,8 +55,9 @@ internal fun TestSystem.withKafka(options: KafkaSystemOptions = KafkaSystemOptio
         registry = options.registry,
         compatibleSubstitute = options.containerOptions.compatibleSubstitute
     ) {
-        KafkaContainer(it).withExposedPorts(*options.ports.toTypedArray())
-            .withEmbeddedZookeeper()
+        KafkaContainer(it)
+            .withExposedPorts(*options.ports.toTypedArray())
+            .apply { options.containerOptions.containerFn(this) }
             .withReuse(this.options.keepDependenciesRunning)
     }.let { getOrRegister(KafkaSystem(this, KafkaContext(it, options.objectMapper, options))) }
         .let { this }
diff --git a/starters/spring/stove-spring-testing-e2e-kafka/src/test/kotlin/com/trendyol/stove/testing/e2e/kafka/KafkaSystemTests.kt b/starters/spring/stove-spring-testing-e2e-kafka/src/test/kotlin/com/trendyol/stove/testing/e2e/kafka/KafkaSystemTests.kt
@@ -117,6 +117,8 @@ class Setup : AbstractProjectConfig() {
                                 "kafka.groupId=test-group",
                                 "kafka.offset=earliest"
                             )
+                        },
+                        containerOptions = KafkaContainerOptions {
                         }
                     )
                 }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,8 @@ class TestSystemConfig : AbstractProjectConfig() {`
`19`	`19`	`couchbase { CouchbaseSystemOptions("Stove") }`
`20`	`20`	`kafka {`
`21`	`21`	`KafkaSystemOptions(`
`22`		`- containerOptions = KafkaContainerOptions(tag = "latest")`
	`22`	`+ containerOptions = KafkaContainerOptions(tag = "latest") {`
	`23`	`+ }`
`23`	`24`	`)`
`24`	`25`	`}`
`25`	`26`	`bridge()`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,9 @@ class Setup : AbstractProjectConfig() {`
`27`	`27`	`containerOptions = CouchbaseContainerOptions(`
`28`	`28`	`tag = "latest"`
`29`	`29`	`)`
`30`		`- )`
`31`		`- .migrations {`
`32`		`- register<DefaultMigration>()`
`33`		`- }`
	`30`	`+ ).migrations {`
	`31`	`+ register<DefaultMigration>()`
	`32`	`+ }`
`34`	`33`	`}`
`35`	`34`	`applicationUnderTest(NoOpApplication())`
`36`	`35`	`}.run()`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ plugins {}`
`2`	`2`	`dependencies {`
`3`	`3`	`api(projects.lib.stoveTestingE2e)`
`4`	`4`	`api(libs.elastic)`
`5`		`- implementation(libs.testcontainers.elasticsearch)`
	`5`	`+ api(libs.testcontainers.elasticsearch)`
`6`	`6`	`implementation(libs.jackson.databind)`
`7`	`7`	`implementation(libs.jackson.arrow)`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ internal fun TestSystem.withElasticsearch(options: ElasticsearchSystemOptions):`
`32`	`32`	`withEnv("xpack.security.enabled", "false")`
`33`	`33`	`}`
`34`	`34`	`withReuse(this@withElasticsearch.options.keepDependenciesRunning)`
`35`		`- options.container.configureContainer(this)`
	`35`	`+ options.container.containerFn(this)`
`36`	`36`	`}`
`37`	`37`	`.let { getOrRegister(ElasticsearchSystem(this, ElasticsearchContext(options.defaultIndex.index, it, options))) }`
`38`	`38`	`.let { this }`