refactor: add support for RandomPortUtil trait

j5ik2o · j5ik2o · commit fea10228ccb2 · 2021-06-30T11:18:59.000+09:00
diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@ The `DockerController` for the corresponding preset is as follows. Please see th
 ```scala
 class MySQLControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
 
-  val hostPort: Int               = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int               = temporaryServerPort()
   val rootPassword: String        = "test"
   val dbName                      = "test"
   
@@ -137,7 +137,7 @@ class MySQLControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport w
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort: Int        = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int        = temporaryServerPort()
   val dbName: String.      = "test"
   val rootUserName: String = "root"
   val rootPassword: String = "test"
@@ -233,7 +233,7 @@ class NginxSpec extends AnyFreeSpec with DockerControllerSpecSupport {
   ).configureCreateContainerCmd { cmd =>
     // if customize the container generation, please do the following.
     // In this example, a random host port is specified.
-    val hostPort: Int              = RandomPortUtil.temporaryServerPort()
+    val hostPort: Int              = temporaryServerPort()
     val containerPort: ExposedPort = ExposedPort.tcp(80)
     val portBinding: Ports         = new Ports()
     portBinding.bind(containerPort, Ports.Binding.bindPort(hostPort))
diff --git a/docker-controller-scala-dynamodb-local/src/test/scala/com/github/j5ik2o/dockerController/dynamodbLocal/DynamoDBLocalControllerSpec.scala b/docker-controller-scala-dynamodb-local/src/test/scala/com/github/j5ik2o/dockerController/dynamodbLocal/DynamoDBLocalControllerSpec.scala
@@ -21,7 +21,7 @@ class DynamoDBLocalControllerSpec extends AnyFreeSpec with DockerControllerSpecS
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort: Int                       = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int                       = temporaryServerPort()
   val controller: DynamoDBLocalController = new DynamoDBLocalController(dockerClient)(hostPort)
 
   // val waitPredicate: WaitPredicate = WaitPredicates.forListeningHostTcpPort(dockerHost, hostPort)
diff --git a/docker-controller-scala-elasticmq/src/test/scala/com/github/j5ik2o/dockerController/elasticmq/ElasticMQControllerSpec.scala b/docker-controller-scala-elasticmq/src/test/scala/com/github/j5ik2o/dockerController/elasticmq/ElasticMQControllerSpec.scala
@@ -21,7 +21,7 @@ class ElasticMQControllerSpec extends AnyFreeSpec with DockerControllerSpecSuppo
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPorts: Seq[Int]             = Seq(RandomPortUtil.temporaryServerPort(), RandomPortUtil.temporaryServerPort())
+  val hostPorts: Seq[Int]             = Seq(temporaryServerPort(), RandomPortUtil.temporaryServerPort())
   val controller: ElasticMQController = ElasticMQController(dockerClient)(dockerHost, hostPorts)
 
   override protected val dockerControllers: Vector[DockerController] = Vector(controller)
diff --git a/docker-controller-scala-elasticsearch/src/test/scala/com/github/j5ik2o/dockerController/elasticsearch/ElasticsearchControllerSpec.scala b/docker-controller-scala-elasticsearch/src/test/scala/com/github/j5ik2o/dockerController/elasticsearch/ElasticsearchControllerSpec.scala
@@ -17,8 +17,8 @@ class ElasticsearchControllerSpec extends AnyFreeSpec with DockerControllerSpecS
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort1: Int                      = RandomPortUtil.temporaryServerPort()
-  val hostPort2: Int                      = RandomPortUtil.temporaryServerPort()
+  val hostPort1: Int                      = temporaryServerPort()
+  val hostPort2: Int                      = temporaryServerPort()
   val controller: ElasticsearchController = ElasticsearchController(dockerClient)(hostPort1, hostPort2)
 
   override protected val dockerControllers: Vector[DockerController] = Vector(controller)
diff --git a/docker-controller-scala-kafka/src/test/scala/com/github/j5ik2o/dockerController/kafka/KafkaControllerSpec.scala b/docker-controller-scala-kafka/src/test/scala/com/github/j5ik2o/dockerController/kafka/KafkaControllerSpec.scala
@@ -19,7 +19,7 @@ class KafkaControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
 
   val topicName = "mytopic"
 
-  val kafkaExternalHostPort: Int = RandomPortUtil.temporaryServerPort()
+  val kafkaExternalHostPort: Int = temporaryServerPort()
 
   val kafkaController = new KafkaController(dockerClient)(
     kafkaExternalHostName = dockerHost,
diff --git a/docker-controller-scala-localstack/src/test/scala/com/github/j5ik2o/dockerController/localstack/LocalStackControllerSpec.scala b/docker-controller-scala-localstack/src/test/scala/com/github/j5ik2o/dockerController/localstack/LocalStackControllerSpec.scala
@@ -32,8 +32,8 @@ import scala.jdk.CollectionConverters._
 class LocalStackControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
   val accessKeyId: String         = "AKIAIOSFODNN7EXAMPLE"
   val secretAccessKey: String     = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
-  val hostPortForS3: Int          = RandomPortUtil.temporaryServerPort()
-  val hostPortForDynamoDB: Int    = RandomPortUtil.temporaryServerPort()
+  val hostPortForS3: Int          = temporaryServerPort()
+  val hostPortForDynamoDB: Int    = temporaryServerPort()
   val endpointForS3: String       = s"http://$dockerHost:$hostPortForS3"
   val endpointForDynamoDB: String = s"http://$dockerHost:$hostPortForDynamoDB"
   val region: Regions             = Regions.AP_NORTHEAST_1
diff --git a/docker-controller-scala-memcached/src/test/scala/com/github/j5ik2o/dockerController/memcached/MemcachedControllerSpec.scala b/docker-controller-scala-memcached/src/test/scala/com/github/j5ik2o/dockerController/memcached/MemcachedControllerSpec.scala
@@ -17,7 +17,7 @@ class MemcachedControllerSpec extends AnyFreeSpec with DockerControllerSpecSuppo
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort: Int                   = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int                   = temporaryServerPort()
   val controller: MemcachedController = MemcachedController(dockerClient)(hostPort)
 
   override protected val dockerControllers: Vector[DockerController] = Vector(controller)
diff --git a/docker-controller-scala-minio/src/test/scala/com/github/j5ik2o/dockerController/minio/MinioControllerSpec.scala b/docker-controller-scala-minio/src/test/scala/com/github/j5ik2o/dockerController/minio/MinioControllerSpec.scala
@@ -18,7 +18,7 @@ class MinioControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
   val minioAccessKeyId: String     = "AKIAIOSFODNN7EXAMPLE"
   val minioSecretAccessKey: String = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
   val minioHost: String            = DockerClientConfigUtil.dockerHost(dockerClientConfig)
-  val minioPort: Int               = RandomPortUtil.temporaryServerPort()
+  val minioPort: Int               = temporaryServerPort()
   val minioEndpoint: String        = s"http://$minioHost:$minioPort"
   val minioRegion: Regions         = Regions.AP_NORTHEAST_1
 
diff --git a/docker-controller-scala-mysql/src/test/scala/com/github/j5ik2o/dockerController/MySQLControllerSpec.scala b/docker-controller-scala-mysql/src/test/scala/com/github/j5ik2o/dockerController/MySQLControllerSpec.scala
@@ -12,7 +12,7 @@ class MySQLControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport w
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort: Int        = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int        = temporaryServerPort()
   val rootPassword: String = "test"
 
   override protected def flywayDriverClassName: String = classOf[com.mysql.cj.jdbc.Driver].getName
diff --git a/docker-controller-scala-postgresql/src/test/scala/com/github/j5ik2o/dockerController/postgresql/PostgreSQLControllerSpec.scala b/docker-controller-scala-postgresql/src/test/scala/com/github/j5ik2o/dockerController/postgresql/PostgreSQLControllerSpec.scala
@@ -17,7 +17,7 @@ class PostgreSQLControllerSpec extends AnyFreeSpec with DockerControllerSpecSupp
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  val hostPort: Int                = RandomPortUtil.temporaryServerPort()
+  val hostPort: Int                = temporaryServerPort()
   val dbName                       = "test"
   val rootUserName: String         = "postgres"
   val rootPassword: Option[String] = Some("test")
diff --git a/docker-controller-scala-redis/src/test/scala/com/github/j5ik2o/dockerController/redis/RedisControllerSpec.scala b/docker-controller-scala-redis/src/test/scala/com/github/j5ik2o/dockerController/redis/RedisControllerSpec.scala
@@ -10,13 +10,15 @@ import com.redis.RedisClient
 import org.scalatest.freespec.AnyFreeSpec
 
 import scala.concurrent.duration._
+import scala.util.control.NonFatal
 
 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)
+  val hostPort: Int               = temporaryServerPort()
+  val controller: RedisController = RedisController(dockerClient)(hostPort)
+
   override protected val dockerControllers: Vector[DockerController] = Vector(controller)
 
   override protected val waitPredicatesSettings: Map[DockerController, WaitPredicateSetting] =
@@ -34,10 +36,18 @@ class RedisControllerSpec extends AnyFreeSpec with DockerControllerSpecSupport {
 
   "RedisController" - {
     "run" in {
-      val r = new RedisClient(dockerHost, hostPort)
-      r.set("1", "2")
-      assert(r.get("1").get == "2")
-      r.close()
+      var redisClient: RedisClient = null
+      try {
+        redisClient = new RedisClient(dockerHost, hostPort)
+        redisClient.set("1", "2")
+        assert(redisClient.get("1").get == "2")
+      } catch {
+        case NonFatal(ex) =>
+          fail(ex)
+      } finally {
+        if (redisClient != null)
+          redisClient.close()
+      }
     }
   }
 }
diff --git a/docker-controller-scala-scalatest/src/main/scala/com/github/j5ik2o/dockerController/DockerControllerSpecSupport.scala b/docker-controller-scala-scalatest/src/main/scala/com/github/j5ik2o/dockerController/DockerControllerSpecSupport.scala
@@ -2,7 +2,8 @@ package com.github.j5ik2o.dockerController
 
 import org.scalatest._
 
-trait DockerControllerSpecSupport extends SuiteMixin with DockerControllerHelper { this: TestSuite =>
+trait DockerControllerSpecSupport extends SuiteMixin with DockerControllerHelper with RandomPortUtil {
+  this: TestSuite =>
 
   protected def createRemoveLifecycle: DockerContainerCreateRemoveLifecycle.Value =
     DockerContainerCreateRemoveLifecycle.ForEachTest
diff --git a/docker-controller-scala-scalatest/src/test/scala/com/github/j5ik2o/dockerController/DockerControllerSpecBase.scala b/docker-controller-scala-scalatest/src/test/scala/com/github/j5ik2o/dockerController/DockerControllerSpecBase.scala
@@ -16,7 +16,7 @@ abstract class DockerControllerSpecBase extends AnyFreeSpec with DockerControlle
     imageName = "nginx",
     tag = Some("latest")
   ).configureCreateContainerCmd { cmd =>
-    val hostPort: Int              = RandomPortUtil.temporaryServerPort()
+    val hostPort: Int              = temporaryServerPort()
     val containerPort: ExposedPort = ExposedPort.tcp(80)
     val portBinding: Ports         = new Ports()
     portBinding.bind(containerPort, Ports.Binding.bindPort(hostPort))
diff --git a/docker-controller-scala-zookeeper/src/test/scala/com/github/j5ik2o/dockerController/ZooKeeperControllerSpec.scala b/docker-controller-scala-zookeeper/src/test/scala/com/github/j5ik2o/dockerController/ZooKeeperControllerSpec.scala
@@ -13,7 +13,7 @@ class ZooKeeperControllerSpec extends AnyFreeSpec with DockerControllerSpecSuppo
   val testTimeFactor: Int = sys.env.getOrElse("TEST_TIME_FACTOR", "1").toInt
   logger.debug(s"testTimeFactor = $testTimeFactor")
 
-  lazy val hostPort: Int                            = RandomPortUtil.temporaryServerPort()
+  lazy val hostPort: Int                            = temporaryServerPort()
   lazy val zooKeeperController: ZooKeeperController = ZooKeeperController(dockerClient)(1, hostPort)
 
   override protected val dockerControllers: Vector[DockerController] = Vector(zooKeeperController)
