K3S Module

Author: greshny

.github/workflows/test.yml

@@ -45,7 +45,7 @@ jobs:
           check-latest: true
           cache: "sbt"
       - name: Restore cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.sbt

build.sbt

@@ -111,6 +111,7 @@ lazy val root = (project in file("."))
     moduleWireMock,
     moduleYugabytedb,
     moduleOpensearch,
+    moduleK3s,
     allOld
   )
   .settings(noPublishSettings)
@@ -563,3 +564,13 @@ lazy val moduleOpensearch = (project in file("modules/opensearch"))
     name := "testcontainers-scala-opensearch",
     libraryDependencies ++= Dependencies.moduleOpensearch.value
   )
+
+lazy val moduleK3s = project.in(file("modules/k3s"))
+  .dependsOn(
+    core % "compile->compile;test->test;provided->provided",
+    scalatest % "test->test"
+  )
+  .settings(
+    commonSettings,
+    libraryDependencies ++= Dependencies.moduleK3s.value
+  )

docs/src/main/tut/setup.md

@@ -95,6 +95,7 @@ Here is the full list of the [currently available modules](https://github.com/te
 * `testcontainers-scala-redis` — module with Redis container.
 * `testcontainers-scala-wiremock` - module with WireMock container.
 * `testcontainers-scala-opensearch` - module with Opensearch container.
+* `testcontainers-scala-k3s` - module with K3S container.
 
 Most of the modules are just proxies to the testcontainers-java modules and behave exactly like java containers.
 You can find documentation about them in the [testcontainers-java docs pages](https://www.testcontainers.org/).

modules/k3s/src/main/scala/com/dimafeng/testcontainers/K3sContainer.scala

@@ -0,0 +1,38 @@
+package com.dimafeng.testcontainers
+
+import org.testcontainers.k3s.{K3sContainer => JavaK3sContainer}
+import org.testcontainers.utility.DockerImageName
+import org.testcontainers.containers.Network
+
+class K3sContainer private (
+  dockerImageName: DockerImageName,
+  network: Option[Network],
+  networkAlias: Option[String]
+) extends SingleContainer[JavaK3sContainer] {
+  override val container: JavaK3sContainer = {
+    val c = new JavaK3sContainer(dockerImageName)
+    network.fold(c)(c.withNetwork(_))
+    networkAlias.fold(c)(c.withNetworkAliases(_))
+  }
+
+  def generateInternalKubeConfigYaml(networkAlias: String): String = container.generateInternalKubeConfigYaml(networkAlias)
+  def kubeConfigYaml: String = container.getKubeConfigYaml()
+}
+
+object K3sContainer {
+  private[testcontainers] final val defaultImage: String = "rancher/k3s"
+  private[testcontainers] final val defaultTag: String = "v1.32.2-k3s1"
+  private[testcontainers] final val defaultDockerImageName: String = s"${defaultImage}:${defaultTag}"
+
+  case class Def(
+    dockerImageName: DockerImageName = DockerImageName.parse(defaultDockerImageName),
+    network: Option[Network] = None,
+    networkAlias: Option[String] = None
+  ) extends ContainerDef {
+    override type Container = K3sContainer
+    override def createContainer(): K3sContainer = new K3sContainer(dockerImageName, network, networkAlias)
+
+    def withNetwork(network: Network): Def = copy(network = Some(network))
+    def withNetworkAlias(alias: String): Def = copy(networkAlias = Some(alias))
+  }
+}

modules/k3s/src/test/scala/com/dimafeng/testcontainers/K3sSpec.scala

@@ -0,0 +1,32 @@
+package com.dimafeng.testcontainers
+
+import com.dimafeng.testcontainers.scalatest.TestContainersForAll
+import org.scalatest.flatspec.AnyFlatSpec
+import org.testcontainers.containers.Network
+import org.testcontainers.utility.DockerImageName
+
+class K3sSpec extends AnyFlatSpec with TestContainersForAll {
+  override type Containers = K3sContainer
+
+  val network: Network = Network.SHARED
+
+  override def startContainers(): K3sContainer = {
+    K3sContainer.Def()
+      .withNetwork(network)
+      .withNetworkAlias("k3s")
+      .start()
+  }
+
+  "K3sContainer" should "be started" in withContainers { k3s =>
+    val kubeConfig = k3s.generateInternalKubeConfigYaml("k3s")
+    k3s.container.getKubeConfigYaml()
+
+    assert(kubeConfig.contains("apiVersion"))
+    assert(kubeConfig.contains("kind: \"Config\""))
+    assert(kubeConfig.contains("clusters"))
+    assert(kubeConfig.contains("users"))
+    assert(kubeConfig.contains("contexts"))
+    assert(k3s.logs.contains("kube-system"))
+    assert(k3s.kubeConfigYaml.contains("apiVersion"))
+  }
+}

project/Dependencies.scala

@@ -372,4 +372,10 @@ object Dependencies {
       "com.softwaremill.sttp.client3" %% "core" % sttpVersion
     )
   )
+
+  val moduleK3s = Def.setting(
+    COMPILE(
+      "org.testcontainers" % "k3s" % testcontainersVersion
+    )
+  )
 }