feat: add support for redis

Author: j5ik2o

build.sbt

@@ -161,6 +161,17 @@ val `docker-controller-scala-mysql` = (project in file("docker-controller-scala-
     )
   ).dependsOn(`docker-controller-scala-core`, `docker-controller-scala-scalatest` % Test)
 
+val `docker-controller-scala-redis` = (project in file("docker-controller-scala-redis"))
+  .settings(baseSettings)
+  .settings(
+    name := "docker-controller-scala-redis",
+    libraryDependencies ++= Seq(
+      scalatest.scalatest    % Test,
+      logback.classic        % Test,
+      (debasishg.redisClient % Test).cross(CrossVersion.for3Use2_13)
+    )
+  ).dependsOn(`docker-controller-scala-core`, `docker-controller-scala-scalatest` % Test)
+
 val `docker-controller-scala-elasticsearch` = (project in file("docker-controller-scala-elasticsearch"))
   .settings(baseSettings)
   .settings(
@@ -191,6 +202,7 @@ val `docker-controller-scala-root` = (project in file("."))
     `docker-controller-scala-core`,
     `docker-controller-scala-scalatest`,
     `docker-controller-scala-mysql`,
+    `docker-controller-scala-redis`,
     `docker-controller-scala-dynamodb-local`,
     `docker-controller-scala-minio`,
     `docker-controller-scala-zookeeper`,

docker-controller-scala-redis/src/main/scala/com/github/j5ik2o/dockerController/redis/RedisController.scala

@@ -0,0 +1,67 @@
+package com.github.j5ik2o.dockerController.redis
+
+import com.github.dockerjava.api.DockerClient
+import com.github.dockerjava.api.command.CreateContainerCmd
+import com.github.dockerjava.api.model.HostConfig.newHostConfig
+import com.github.dockerjava.api.model.{ ExposedPort, Ports }
+import com.github.j5ik2o.dockerController.DockerControllerImpl
+import com.github.j5ik2o.dockerController.redis.RedisController._
+
+import scala.concurrent.duration.{ DurationInt, FiniteDuration }
+
+object RedisController {
+  final val DefaultImageName: String        = "redis"
+  final val DefaultImageTag: Option[String] = Some("6.2.4")
+  final val DefaultContainerPort: Int       = 6379
+
+  def apply(
+      dockerClient: DockerClient,
+      outputFrameInterval: FiniteDuration = 500.millis,
+      imageName: String = DefaultImageName,
+      imageTag: Option[String] = DefaultImageTag,
+      envVars: Map[String, String] = Map.empty
+  )(
+      hostPort: Int,
+      allowEmptyPassword: Boolean = true,
+      redisPassword: Option[String] = None,
+      redisAofEnabled: Boolean = false
+  ): RedisController =
+    new RedisController(dockerClient, outputFrameInterval, imageName, imageTag, envVars)(
+      hostPort,
+      allowEmptyPassword,
+      redisPassword,
+      redisAofEnabled
+    )
+}
+
+class RedisController(
+    dockerClient: DockerClient,
+    outputFrameInterval: FiniteDuration = 500.millis,
+    imageName: String = DefaultImageName,
+    imageTag: Option[String] = DefaultImageTag,
+    envVars: Map[String, String] = Map.empty
+)(
+    hostPort: Int,
+    allowEmptyPassword: Boolean = true,
+    redisPassword: Option[String] = None,
+    redisAofEnabled: Boolean = false
+) extends DockerControllerImpl(dockerClient, outputFrameInterval)(imageName, imageTag) {
+
+  private val environmentVariables = Map(
+    "ALLOW_EMPTY_PASSWORD" -> { if (allowEmptyPassword) "yes" else "no" },
+    "REDIS_AOF_ENABLED"    -> { if (redisAofEnabled) "yes" else "no" }
+  ) ++
+    redisPassword.map(password => Map("REDIS_PASSWORD" -> password)).getOrElse(Map.empty) ++
+    envVars
+
+  override protected def newCreateContainerCmd(): CreateContainerCmd = {
+    val containerPort = ExposedPort.tcp(DefaultContainerPort)
+    val portBinding   = new Ports()
+    portBinding.bind(containerPort, Ports.Binding.bindPort(hostPort))
+    super
+      .newCreateContainerCmd()
+      .withEnv(environmentVariables.map { case (k, v) => s"$k=$v" }.toArray: _*)
+      .withExposedPorts(containerPort)
+      .withHostConfig(newHostConfig().withPortBindings(portBinding))
+  }
+}

docker-controller-scala-redis/src/test/resources/logback-test.xml

@@ -0,0 +1,22 @@
+<configuration>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <layout class="ch.qos.logback.classic.PatternLayout">
+            <Pattern>
+                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
+            </Pattern>
+        </layout>
+    </appender>
+
+    <appender name="ASYNCSTDOUT" class="ch.qos.logback.classic.AsyncAppender">
+        <appender-ref ref="STDOUT" />
+    </appender>
+
+    <logger name="org.apache" level="INFO">
+    </logger>
+
+    <root level="DEBUG">
+        <appender-ref ref="ASYNCSTDOUT" />
+    </root>
+
+</configuration>

docker-controller-scala-redis/src/test/scala/com/github/j5ik2o/dockerController/redis/RedisControllerSpec.scala

@@ -0,0 +1,43 @@
+package com.github.j5ik2o.dockerController.redis
+
+import com.github.j5ik2o.dockerController.{
+  DockerController,
+  DockerControllerSpecSupport,
+  RandomPortUtil,
+  WaitPredicates
+}
+import com.redis.RedisClient
+import org.scalatest.freespec.AnyFreeSpec
+
+import scala.concurrent.duration._
+
+class RedisControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
+  val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
+  logger.debug(s"testTimeFactor = $testTimeFactor")
+
+  val hostPort: Int                                                  = RandomPortUtil.temporaryServerPort()
+  val controller: RedisController                                    = RedisController(dockerClient)(hostPort)
+  override protected val dockerControllers: Vector[DockerController] = Vector(controller)
+
+  override protected val waitPredicatesSettings: Map[DockerController, WaitPredicateSetting] =
+    Map(
+      controller -> WaitPredicateSetting(
+        Duration.Inf,
+        WaitPredicates.forListeningHostTcpPort(
+          dockerHost,
+          hostPort,
+          (1 * testTimeFactor).seconds,
+          Some((5 * testTimeFactor).seconds)
+        )
+      )
+    )
+
+  "RedisController" - {
+    "run" in {
+      val r = new RedisClient(dockerHost, hostPort)
+      r.set("1", "2")
+      assert(r.get("1").get == "2")
+      r.close()
+    }
+  }
+}

project/Dependencies.scala

@@ -98,4 +98,8 @@ object Dependencies {
 
   }
 
+  object debasishg {
+    val redisClient = "net.debasishg" %% "redisclient" % "3.30"
+  }
+
 }