Refactor platform test container configuration

Authored-by: Leonhardt Koepsell <[email protected]>
codebandits · Nov 3, 2024 · a825b2f · a825b2f
1 parent d26dfaa
commit a825b2f
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 25 deletions.
diff --git a/...s/kotlin/dev/codebandits/ImageFixtures.kt → ...tlin/dev/codebandits/ContainerProvider.kt b/...s/kotlin/dev/codebandits/ImageFixtures.kt → ...tlin/dev/codebandits/ContainerProvider.kt
@@ -1,25 +1,37 @@
 package dev.codebandits
 
+import org.testcontainers.containers.GenericContainer
 import org.testcontainers.images.builder.ImageFromDockerfile
 import org.testcontainers.images.builder.dockerfile.DockerfileBuilder
 
-object ImageFixtures {
-  private val imageCache = mutableMapOf<Any, ImageFromDockerfile>()
-
-  enum class JavaVersion {
-    TEMURIN_22,
-    TEMURIN_21,
-    TEMURIN_20,
-    OPENJDK_17,
-    OPENJDK_11,
+object ContainerProvider {
+  fun dockerJavaGradle(
+    dockerVersion: String,
+    javaVersion: JavaVersion,
+    gradleVersion: String,
+  ): GenericContainer<*> {
+    val image = ImageFixtures.dockerJavaGradle(
+      dockerVersion = dockerVersion,
+      javaVersion = javaVersion,
+      gradleVersion = gradleVersion,
+    )
+    val container: GenericContainer<*> = GenericContainer(image)
+    if (System.getenv("CI") == "true") {
+      container.withStartupAttempts(3)
+    }
+    return container
   }
+}
+
+private object ImageFixtures {
+  private val imageCache = mutableMapOf<List<Any>, ImageFromDockerfile>()
 
-  fun dockerTemurinGradle(
+  fun dockerJavaGradle(
     dockerVersion: String,
     javaVersion: JavaVersion,
     gradleVersion: String,
   ): ImageFromDockerfile {
-    val imageIdentifier = Pair("docker-temurin-gradle", Triple(dockerVersion, javaVersion, gradleVersion))
+    val imageIdentifier = listOf("docker-java-gradle", dockerVersion, javaVersion, gradleVersion)
     return imageCache.getOrPut(imageIdentifier) {
       ImageFromDockerfile()
         .withDockerfileFromBuilder { builder ->

diff --git a/src/testPlatforms/kotlin/dev/codebandits/DockerHostPathTest.kt b/src/testPlatforms/kotlin/dev/codebandits/DockerHostPathTest.kt
@@ -5,7 +5,6 @@ import dev.codebandits.helpers.configureBuildGradleKtsPluginFromLibsDir
 import dev.codebandits.helpers.setupPluginLibsDir
 import org.junit.jupiter.api.Test
 import org.testcontainers.containers.BindMode
-import org.testcontainers.containers.GenericContainer
 import org.testcontainers.utility.MountableFile
 import strikt.api.expectThat
 import strikt.assertions.contains
@@ -32,13 +31,11 @@ class DockerHostPathTest : GradleProjectTest() {
       }
       """.trimIndent()
     )
-    val image = ImageFixtures.dockerTemurinGradle(
+    val container = ContainerProvider.dockerJavaGradle(
       dockerVersion = "27",
-      javaVersion = ImageFixtures.JavaVersion.TEMURIN_21,
+      javaVersion = JavaVersion.TEMURIN_21,
       gradleVersion = "8.10.2",
     )
-    val container = GenericContainer(image)
-      .withStartupAttempts(3)
       .withFileSystemBind("/var/run/docker.sock", "/var/run/custom.sock", BindMode.READ_ONLY)
       .withCopyFileToContainer(MountableFile.forHostPath(projectDirectory), "/project")
       .withWorkingDirectory("/project")
@@ -74,13 +71,11 @@ class DockerHostPathTest : GradleProjectTest() {
       """.trimIndent()
     )
 
-    val image = ImageFixtures.dockerTemurinGradle(
+    val container = ContainerProvider.dockerJavaGradle(
       dockerVersion = "27",
-      javaVersion = ImageFixtures.JavaVersion.TEMURIN_21,
+      javaVersion = JavaVersion.TEMURIN_21,
       gradleVersion = "8.10.2",
     )
-    val container = GenericContainer(image)
-      .withStartupAttempts(3)
       .withFileSystemBind("/var/run/docker.sock", "/var/run/docker.sock", BindMode.READ_ONLY)
       .withCopyFileToContainer(MountableFile.forHostPath(projectDirectory), "/project")
       .withWorkingDirectory("/project")

diff --git a/src/testPlatforms/kotlin/dev/codebandits/JavaVersion.kt b/src/testPlatforms/kotlin/dev/codebandits/JavaVersion.kt
@@ -0,0 +1,9 @@
+package dev.codebandits
+
+enum class JavaVersion {
+  TEMURIN_22,
+  TEMURIN_21,
+  TEMURIN_20,
+  OPENJDK_17,
+  OPENJDK_11,
+}
diff --git a/src/testPlatforms/kotlin/dev/codebandits/VersionCompatabilityTest.kt b/src/testPlatforms/kotlin/dev/codebandits/VersionCompatabilityTest.kt
@@ -6,7 +6,6 @@ import dev.codebandits.helpers.setupPluginLibsDir
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.CsvSource
 import org.testcontainers.containers.BindMode
-import org.testcontainers.containers.GenericContainer
 import org.testcontainers.utility.MountableFile
 import strikt.api.expectThat
 import strikt.assertions.contains
@@ -19,7 +18,7 @@ class VersionCompatabilityTest : GradleProjectTest() {
     "27, TEMURIN_21, 8.10.2",
     "26, OPENJDK_17, 7.6.4",
   )
-  fun `run dockerRun`(dockerVersion: String, javaVersion: ImageFixtures.JavaVersion, gradleVersion: String) {
+  fun `run dockerRun`(dockerVersion: String, javaVersion: JavaVersion, gradleVersion: String) {
     setupPluginLibsDir()
     buildGradleFile.configureBuildGradlePluginFromLibsDir()
     buildGradleFile.appendLine(
@@ -33,13 +32,11 @@ class VersionCompatabilityTest : GradleProjectTest() {
       }
       """.trimIndent()
     )
-    val image = ImageFixtures.dockerTemurinGradle(
+    val container = ContainerProvider.dockerJavaGradle(
       dockerVersion = dockerVersion,
       javaVersion = javaVersion,
       gradleVersion = gradleVersion,
     )
-    val container = GenericContainer(image)
-      .withStartupAttempts(3)
       .withFileSystemBind("/var/run/docker.sock", "/var/run/docker.sock", BindMode.READ_ONLY)
       .withCopyFileToContainer(MountableFile.forHostPath(projectDirectory), "/project")
       .withWorkingDirectory("/project")