Merge pull request #1007 from modelix/build/replace-docker-compose-with-test-containers

Use Testcontainers instead of Docker Compose for tests with PostgreSQL

Author: Oleksandr Dzhychko

gradle/libs.versions.toml

@@ -40,6 +40,7 @@ dokka = "1.9.20"
 detekt = "1.23.6"
 xmlunit = "2.10.0"
 kotest = "5.9.1"
+testcontainers = "1.20.1"
 
 [libraries]
 
@@ -130,3 +131,6 @@ detekt-api = { group = "io.gitlab.arturbosch.detekt", name= "detekt-api", versio
 detekt-test = { group = "io.gitlab.arturbosch.detekt", name= "detekt-test", version.ref = "detekt" }
 
 jimfs = { group = "com.google.jimfs", name = "jimfs", version = "1.3.0" }
+
+testcontainers = { group = "org.testcontainers", name = "testcontainers", version.ref = "testcontainers" }
+testcontainers-postgresql = { group = "org.testcontainers", name = "postgresql", version.ref = "testcontainers" }

model-server-test/README.md

@@ -82,6 +82,8 @@ dependencies {
     testImplementation(libs.mockk)
     testImplementation(kotlin("test"))
     testImplementation(project(":modelql-untyped"))
+    testImplementation(libs.testcontainers)
+    testImplementation(libs.testcontainers.postgresql)
 }
 
 tasks.named<ShadowJar>("shadowJar") {

model-server-test/build.gradle.kts

@@ -75,9 +75,11 @@ import org.modelix.model.server.store.writeDump
 import org.slf4j.LoggerFactory
 import org.springframework.util.ResourceUtils
 import java.io.File
+import java.io.FileReader
 import java.io.IOException
 import java.nio.charset.StandardCharsets
 import java.time.Duration
+import java.util.Properties
 import javax.sql.DataSource
 
 object Main {
@@ -143,9 +145,11 @@ object Main {
                         )
                 }
             } else if (cmdLineArgs.localPersistence) {
-                storeClient = IgniteStoreClient(cmdLineArgs.jdbcConfFile, inmemory = true)
+                val jdbcProperties = cmdLineArgs.jdbcConfFile?.let(::readJdbcProperties)
+                storeClient = IgniteStoreClient(jdbcProperties, inmemory = true)
             } else {
-                storeClient = IgniteStoreClient(cmdLineArgs.jdbcConfFile)
+                val jdbcProperties = cmdLineArgs.jdbcConfFile?.let(::readJdbcProperties)
+                storeClient = IgniteStoreClient(jdbcProperties)
                 if (cmdLineArgs.schemaInit) {
                     val dataSource: DataSource = Ignition.loadSpringBean<DataSource>(
                         Main::class.java.getResource("ignite.xml"),
@@ -251,6 +255,16 @@ object Main {
         }
     }
 
+    private fun readJdbcProperties(jdbcConfFile: File): Properties {
+        val properties = Properties()
+        try {
+            properties.load(FileReader(jdbcConfFile))
+        } catch (e: IOException) {
+            throw IllegalStateException("Could not load the JDBC configuration from ${jdbcConfFile.absolutePath}.", e)
+        }
+        return properties
+    }
+
     /**
      * Installs the status pages extension with a configuration suitable for generating application/problem+json
      * responses as defined in the API specification.

model-server-test/docker-compose.yaml

@@ -26,9 +26,6 @@ import org.modelix.model.IGenericKeyListener
 import org.modelix.model.lazy.RepositoryId
 import org.modelix.model.persistent.HashUtil
 import org.modelix.model.server.SqlUtils
-import java.io.File
-import java.io.FileReader
-import java.io.IOException
 import java.sql.SQLException
 import java.util.*
 import javax.cache.Cache
@@ -40,7 +37,9 @@ private val LOG = KotlinLogging.logger { }
  * Store client implementation with an ignite cache.
  * If [inmemory] is true, the data is not persisted in a database.
  */
-class IgniteStoreClient(jdbcConfFile: File? = null, private val inmemory: Boolean = false) : IsolatingStore, AutoCloseable {
+class IgniteStoreClient(jdbcProperties: Properties? = null, private val inmemory: Boolean = false) :
+    IsolatingStore,
+    AutoCloseable {
 
     companion object {
         private const val ENTRY_CHANGED_TOPIC = "entryChanged"
@@ -68,28 +67,14 @@ class IgniteStoreClient(jdbcConfFile: File? = null, private val inmemory: Boolea
      * from ignite.xml is used
      */
     init {
-        if (jdbcConfFile != null) {
+        if (jdbcProperties != null) {
             // Given that systemPropertiesMode is set to 2 (SYSTEM_PROPERTIES_MODE_OVERRIDE) in
             // ignite.xml, we can override the properties through system properties
-            try {
-                val properties = Properties()
-                properties.load(FileReader(jdbcConfFile))
-                for (pn in properties.stringPropertyNames()) {
-                    if (pn.startsWith("jdbc.")) {
-                        System.setProperty(pn, properties.getProperty(pn))
-                    } else {
-                        throw RuntimeException(
-                            "Properties not related to jdbc are not permitted. Check file " +
-                                jdbcConfFile.absolutePath,
-                        )
-                    }
+            for (propertyName in jdbcProperties.stringPropertyNames()) {
+                require(propertyName.startsWith("jdbc.")) {
+                    "Property `$propertyName` is invalid. Only properties starting with `jdbc.` are permitted."
                 }
-            } catch (e: IOException) {
-                throw RuntimeException(
-                    "We are unable to load the JDBC configuration from " +
-                        jdbcConfFile.absolutePath,
-                    e,
-                )
+                System.setProperty(propertyName, jdbcProperties.getProperty(propertyName))
             }
         }
         if (!inmemory) updateDatabaseSchema()

model-server/build.gradle.kts

@@ -13,33 +13,52 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import org.junit.jupiter.api.AfterAll
+
+package org.modelix.model.server.store
+
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertDoesNotThrow
 import org.modelix.model.lazy.RepositoryId
-import org.modelix.model.server.store.IgniteStoreClient
-import org.modelix.model.server.store.ObjectInRepository
+import org.testcontainers.containers.PostgreSQLContainer
+import org.testcontainers.utility.DockerImageName
 import java.sql.Connection
 import java.sql.DriverManager
+import java.util.Properties
 import kotlin.test.AfterTest
+import kotlin.test.BeforeTest
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertTrue
 
 class IgnitePostgresRepositoryRemovalTest {
-    private val store = IgniteStoreClient()
+    private lateinit var postgres: PostgreSQLContainer<*>
+    private lateinit var store: IgniteStoreClient
+    private lateinit var dbConnection: Connection
 
     private val toDelete = RepositoryId("repository-removal-toDelete")
     private val existing = RepositoryId("repository-removal-existing")
 
+    @BeforeTest
+    fun beforeTest() {
+        postgres = PostgreSQLContainer(DockerImageName.parse("postgres:16.2-alpine"))
+            .withDatabaseName("modelix")
+            .withUsername("modelix")
+            .withPassword("modelix")
+            .withExposedPorts(5432)
+        postgres.start()
+
+        val jdbcProperties = Properties()
+        jdbcProperties.setProperty("jdbc.url", "jdbc:postgresql://${postgres.host}:${postgres.firstMappedPort}/")
+
+        store = IgniteStoreClient(jdbcProperties)
+
+        dbConnection = DriverManager.getConnection(System.getProperty("jdbc.url"), "modelix", "modelix")
+    }
+
     @AfterTest
-    fun cleanup() {
-        dbConnection.prepareStatement("DELETE FROM modelix.model WHERE repository IN ( ? , ? )").use {
-            it.setString(1, toDelete.id)
-            it.setString(2, existing.id)
-        }
-        store.putAll(store.getAll().keys.associateWith { null })
-        store.close()
+    fun afterTest() {
+        store.dispose()
+        postgres.stop()
     }
 
     @Test
@@ -118,14 +137,4 @@ class IgnitePostgresRepositoryRemovalTest {
             store.removeRepositoryObjects(RepositoryId("invalid"))
         }
     }
-
-    companion object {
-        val dbConnection: Connection = DriverManager.getConnection(System.getProperty("jdbc.url"), "modelix", "modelix")
-
-        @JvmStatic
-        @AfterAll
-        fun closeDbConnection() {
-            dbConnection.close()
-        }
-    }
 }

model-server/src/main/kotlin/org/modelix/model/server/Main.kt

@@ -13,27 +13,48 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+package org.modelix.model.server.store
+
 import org.modelix.model.lazy.RepositoryId
 import org.modelix.model.persistent.HashUtil
-import org.modelix.model.server.store.IgniteStoreClient
-import org.modelix.model.server.store.ObjectInRepository
+import org.testcontainers.containers.PostgreSQLContainer
+import org.testcontainers.utility.DockerImageName
+import org.testcontainers.utility.MountableFile
+import java.util.Properties
 import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
 class IgnitePostgresTest {
-    lateinit var store: IgniteStoreClient
+    private lateinit var postgres: PostgreSQLContainer<*>
+    private lateinit var store: IgniteStoreClient
 
     @BeforeTest
     fun beforeTest() {
-        store = IgniteStoreClient()
+        postgres = PostgreSQLContainer(DockerImageName.parse("postgres:16.2-alpine"))
+            .withDatabaseName("modelix")
+            .withUsername("modelix")
+            .withPassword("modelix")
+            .withCopyFileToContainer(
+                MountableFile.forClasspathResource("/legacy-database.sql"),
+                "/docker-entrypoint-initdb.d/initdb.sql",
+            )
+            .withExposedPorts(5432)
+        postgres.start()
+
+        val jdbcProperties = Properties()
+        jdbcProperties.setProperty("jdbc.url", "jdbc:postgresql://${postgres.host}:${postgres.firstMappedPort}/")
+
+        store = IgniteStoreClient(jdbcProperties)
     }
 
     @AfterTest
     fun afterTest() {
         store.dispose()
+        postgres.stop()
     }
 
     @Test