New container DSL

README.md

@@ -254,8 +254,135 @@ class MysqlSpec extends FlatSpec with ForAllTestContainer {
 }
 ```
 
+## New API
+
+Starting from 0.34.0 version testcontainers-scala provides the new API. 
+The main motivation points are in the [pull request](https://github.com/testcontainers/testcontainers-scala/pull/78).
+
+### `Container` and `ContainerDef` 
+
+Docker containers are represented through the two different entities:
+1. `ContainerDef` — it's container definition. `ContainerDef` describes, how to build a container.
+   You can think about it like about a container constructor, or dockerfile description.
+   Usually, `ContainerDef` receives some parameters.
+   `ContainerDef` has a `start()` method. It returns a started `Container`.
+2. `Container` — it's a started container. You can interact with it through its methods.
+   For example, in the case of `MySQLContainer` you can get it's JDBC URL with `jdbcUrl` method.
+   `Container` is the main entity for using inside tests.
+
+### Scalatest usage
+
+You can use one of the four traits:
+1. `TestContainerForAll` — will start a single container before all tests and stop after all tests.
+2. `TestContainerForEach` — will start a single container before each test and stop after each test.
+3. `TestContainersForAll` — will start multiple containers before all tests and stop after all tests.
+4. `TestContainersForEach` — will start multiple containers before each test and stop after each test.
+
+
+#### Single container in tests
+
+If you want to use a single container in your test:
+```scala
+class MysqlSpec extends FlatSpec with TestContainerForAll {
+
+  // You need to override `containerDef` with needed container definition
+  override val containerDef = MySQLContainer.Def()
+
+  // To use containers in tests you need to use `withContainers` function
+  it should "test" in withContainers { mysqlContainer =>
+    // Inside your test body you can do with your container whatever you want to
+    assert(mysqlContainer.jdbcUrl.nonEmpty)
+  }
+}
+```
+
+Usage of `TestContainerForEach` is not different from the example above.
+
+#### Multiple containers in tests
+
+If you want to use multiple containers in your test:
+```scala
+class ExampleSpec extends FlatSpec with TestContainersForAll {
+
+  // First of all, you need to declare, which containers you want to use
+  override type Containers = MySQLContainer and PostgreSQLContainer
+
+  // After that, you need to describe, how you want to start them,
+  // In this method you can use any intermediate logic.
+  // You can pass parameters between containers, for example.
+  override def startContainers(): Containers = {
+    val container1 = MySQLContainer.Def().start()
+    val container2 = PostgreSQLContainer.Def().start()
+    container1 and container2
+  }
+
+  // `withContainers` function supports multiple containers:
+  it should "test" in withContainers { case mysqlContainer and pgContainer =>
+    // Inside your test body you can do with your containers whatever you want to
+    assert(mysqlContainer.jdbcUrl.nonEmpty && pgContainer.jdbcUrl.nonEmpty)
+  }
+
+}
+```
+
+Usage of `TestContainersForEach` is not different from the example above.
+
+### `GenericContainer` usage
+
+To create a custom container, which is not built-in in the library, you need to use `GenericContainer`.
+
+For example, you want to create a custom nginx container:
+```scala
+class NginxContainer(port: Int, underlying: GenericContainer) extends GenericContainer(underlying) {
+  // you can add any methods or fields inside your container's body
+  def rootUrl: String = s"http://$containerIpAddress:${mappedPort(port)}/"
+}
+object NginxContainer {
+
+  // In the container definition you need to describe, how your container will be constructed:
+  case class Def(port: Int) extends GenericContainer.Def[NginxContainer](
+    new NginxContainer(port, GenericContainer(
+      dockerImage = "nginx:latest",
+      exposedPorts = Seq(port),
+      waitStrategy = Wait.forHttp("/")
+    ))
+  )
+}
+```
+
+### Migration from the classic API
+
+1. If you have custom containers created with the `GenericContainer`, add `ContainerDef` in the companion like this:
+   ```scala
+   object MyCustomContainer {
+     case class Def(/*constructor params here*/) extends GenericContainer.Def[MyCustomContainer](
+       new MyCustomContainer(/*constructor params here*/)
+     )
+   }
+   ```
+2. If you are using `ForEachTestContainer`:
+    1. If your test contains only one container, replace `ForEachTestContainer` with `TestContainerForEach`
+    2. If your test contains multiple containers, replace `ForEachTestContainer` with `TestContainersForEach`
+3. If you are using `ForAllTestContainer`:
+    1. If your test contains only one container, replace `ForAllTestContainer` with `TestContainerForAll`
+    2. If your test contains multiple containers, replace `ForAllTestContainer` with `TestContainersForAll`
+4. Fix all compilation errors using compiler messages and examples above.
+
+If you have any questions or difficulties feel free to ask it in our [slack channel](https://testcontainers.slack.com/messages/CAFK4GL85).
+
 ## Release notes
 
+* **0.34.0**
+    * Added new, experimental API and DSL.
+      The main motivation points are in the [pull request](https://github.com/testcontainers/testcontainers-scala/pull/78). 
+      Old API remains the same, so all your old code will continue to work.      
+      We will wait for the user's feedback about the new API. 
+      If it will be positive, eventually this API may replace the current API.
+      You can find more information about the new API above.
+
+* **0.33.0**
+    * TODO
+
 * **0.32.0**
     * TestContainers -> `1.12.1`
     * SBT -> `1.3.0`

core/src/main/scala/com/dimafeng/testcontainers/Container.scala

@@ -2,19 +2,21 @@ package com.dimafeng.testcontainers
 
 import java.util.function.Consumer
 
+import com.dimafeng.testcontainers.lifecycle.Stoppable
 import com.github.dockerjava.api.DockerClient
 import com.github.dockerjava.api.command.{CreateContainerCmd, InspectContainerResponse}
 import com.github.dockerjava.api.model.{Bind, Info, VolumesFrom}
 import org.junit.runner.Description
 import org.testcontainers.containers.output.OutputFrame
 import org.testcontainers.containers.startupcheck.StartupCheckStrategy
 import org.testcontainers.containers.traits.LinkableContainer
-import org.testcontainers.containers.{FailureDetectingExternalResource, Network, TestContainerAccessor, GenericContainer => OTCGenericContainer}
+import org.testcontainers.containers.{FailureDetectingExternalResource, Network, TestContainerAccessor, GenericContainer => JavaGenericContainer}
 import org.testcontainers.lifecycle.Startable
 
 import scala.collection.JavaConverters._
 import scala.concurrent.{Future, blocking}
 
+@deprecated("For internal usage only. Will be deleted.")
 trait TestContainerProxy[T <: FailureDetectingExternalResource] extends Container {
 
   @deprecated("Please use reflective methods from the wrapper and `configure` method for creation")
@@ -33,7 +35,9 @@ trait TestContainerProxy[T <: FailureDetectingExternalResource] extends Containe
   override def failed(e: Throwable)(implicit description: Description): Unit = TestContainerAccessor.failed(e, description)
 }
 
-abstract class SingleContainer[T <: OTCGenericContainer[_]] extends TestContainerProxy[T] {
+abstract class SingleContainer[T <: JavaGenericContainer[_]] extends TestContainerProxy[T] {
+
+  def underlyingUnsafeContainer: T = container
 
   override def start(): Unit = container.start()
 
@@ -102,7 +106,7 @@ abstract class SingleContainer[T <: OTCGenericContainer[_]] extends TestContaine
   }
 }
 
-trait Container extends Startable {
+trait Container extends Startable with Stoppable {
 
   @deprecated("Use `stop` instead")
   def finished()(implicit description: Description): Unit = stop()

core/src/main/scala/com/dimafeng/testcontainers/ContainerDef.scala

@@ -0,0 +1,17 @@
+package com.dimafeng.testcontainers
+
+import com.dimafeng.testcontainers.lifecycle.Stoppable
+import org.testcontainers.lifecycle.Startable
+
+trait ContainerDef {
+
+  type Container <: Startable with Stoppable
+
+  protected def createContainer(): Container
+
+  def start(): Container = {
+    val container = createContainer()
+    container.start()
+    container
+  }
+}

core/src/main/scala/com/dimafeng/testcontainers/DockerComposeContainer.scala

@@ -7,7 +7,7 @@ import java.util.function.Consumer
 import com.dimafeng.testcontainers.DockerComposeContainer.ComposeFile
 import org.testcontainers.containers.output.OutputFrame
 import org.testcontainers.containers.wait.strategy.{Wait, WaitStrategy}
-import org.testcontainers.containers.{DockerComposeContainer => OTCDockerComposeContainer}
+import org.testcontainers.containers.{DockerComposeContainer => JavaDockerComposeContainer}
 import org.testcontainers.utility.Base58
 
 import scala.collection.JavaConverters._
@@ -73,10 +73,10 @@ class DockerComposeContainer(composeFiles: ComposeFile,
                              env: Map[String, String] = Map.empty,
                              tailChildContainers: Boolean = false,
                              logConsumers: Seq[ServiceLogConsumer] = Seq.empty)
-  extends TestContainerProxy[OTCDockerComposeContainer[_]] {
+  extends TestContainerProxy[JavaDockerComposeContainer[_]] {
 
-  override val container: OTCDockerComposeContainer[_] = {
-    val container: OTCDockerComposeContainer[_] = new OTCDockerComposeContainer(identifier, composeFiles match {
+  override val container: JavaDockerComposeContainer[_] = {
+    val container: JavaDockerComposeContainer[_] = new JavaDockerComposeContainer(identifier, composeFiles match {
       case ComposeFile(Left(f)) => util.Arrays.asList(f)
       case ComposeFile(Right(files)) => files.asJava
     })

core/src/main/scala/com/dimafeng/testcontainers/FixedHostPortGenericContainer.scala

@@ -1,7 +1,7 @@
 package com.dimafeng.testcontainers
 
 import org.testcontainers.containers.wait.strategy.WaitStrategy
-import org.testcontainers.containers.{BindMode, FixedHostPortGenericContainer => OTCFixedHostPortGenericContainer}
+import org.testcontainers.containers.{BindMode, FixedHostPortGenericContainer => JavaFixedHostPortGenericContainer}
 
 class FixedHostPortGenericContainer(imageName: String,
                                     exposedPorts: Seq[Int] = Seq(),
@@ -11,9 +11,9 @@ class FixedHostPortGenericContainer(imageName: String,
                                     waitStrategy: Option[WaitStrategy] = None,
                                     exposedHostPort: Int,
                                     exposedContainerPort: Int
-                                   ) extends SingleContainer[OTCFixedHostPortGenericContainer[_]] {
+                                   ) extends SingleContainer[JavaFixedHostPortGenericContainer[_]] {
 
-  override implicit val container: OTCFixedHostPortGenericContainer[_] = new OTCFixedHostPortGenericContainer(imageName)
+  override implicit val container: JavaFixedHostPortGenericContainer[_] = new JavaFixedHostPortGenericContainer(imageName)
 
   if (exposedPorts.nonEmpty) {
     container.withExposedPorts(exposedPorts.map(int2Integer): _*)

core/src/main/scala/com/dimafeng/testcontainers/GenericContainer.scala

@@ -4,30 +4,41 @@ import java.util.concurrent.Future
 
 import com.dimafeng.testcontainers.GenericContainer.DockerImage
 import org.testcontainers.containers.wait.strategy.WaitStrategy
-import org.testcontainers.containers.{BindMode, GenericContainer => OTCGenericContainer}
-
-class GenericContainer(dockerImage: DockerImage,
-                       exposedPorts: Seq[Int] = Seq(),
-                       env: Map[String, String] = Map(),
-                       command: Seq[String] = Seq(),
-                       classpathResourceMapping: Seq[(String, String, BindMode)] = Seq(),
-                       waitStrategy: Option[WaitStrategy] = None
-                      ) extends SingleContainer[OTCGenericContainer[_]] {
-
-  override implicit val container: OTCGenericContainer[_] = dockerImage match {
-    case DockerImage(Left(imageFromDockerfile)) => new OTCGenericContainer(imageFromDockerfile)
-    case DockerImage(Right(imageName))          => new OTCGenericContainer(imageName)
-  }
+import org.testcontainers.containers.{BindMode, GenericContainer => JavaGenericContainer}
 
-  if (exposedPorts.nonEmpty) {
-    container.withExposedPorts(exposedPorts.map(int2Integer): _*)
-  }
-  env.foreach(Function.tupled(container.withEnv))
-  if (command.nonEmpty) {
-    container.withCommand(command: _*)
-  }
-  classpathResourceMapping.foreach(Function.tupled(container.withClasspathResourceMapping))
-  waitStrategy.foreach(container.waitingFor)
+class GenericContainer(
+  override val underlyingUnsafeContainer: JavaGenericContainer[_]
+) extends SingleContainer[JavaGenericContainer[_]] {
+
+  override implicit val container: JavaGenericContainer[_] = underlyingUnsafeContainer
+
+  def this(
+    dockerImage: DockerImage,
+    exposedPorts: Seq[Int] = Seq(),
+    env: Map[String, String] = Map(),
+    command: Seq[String] = Seq(),
+    classpathResourceMapping: Seq[(String, String, BindMode)] = Seq(),
+    waitStrategy: Option[WaitStrategy] = None
+  ) = this({
+    val underlying: JavaGenericContainer[_] = dockerImage match {
+      case DockerImage(Left(imageFromDockerfile)) => new JavaGenericContainer(imageFromDockerfile)
+      case DockerImage(Right(imageName))          => new JavaGenericContainer(imageName)
+    }
+
+    if (exposedPorts.nonEmpty) {
+      underlying.withExposedPorts(exposedPorts.map(int2Integer): _*)
+    }
+    env.foreach(Function.tupled(underlying.withEnv))
+    if (command.nonEmpty) {
+      underlying.withCommand(command: _*)
+    }
+    classpathResourceMapping.foreach(Function.tupled(underlying.withClasspathResourceMapping))
+    waitStrategy.foreach(underlying.waitingFor)
+
+    underlying
+  })
+
+  def this(genericContainer: GenericContainer) = this(genericContainer.underlyingUnsafeContainer)
 }
 
 object GenericContainer {
@@ -48,4 +59,9 @@ object GenericContainer {
             classpathResourceMapping: Seq[(String, String, BindMode)] = Seq(),
             waitStrategy: WaitStrategy = null): GenericContainer =
     new GenericContainer(dockerImage, exposedPorts, env, command, classpathResourceMapping, Option(waitStrategy))
+
+  abstract class Def[C <: GenericContainer](init: => C) extends ContainerDef {
+    override type Container = C
+    protected def createContainer(): C = init
+  }
 }

core/src/main/scala/com/dimafeng/testcontainers/lifecycle/Stoppable.scala

@@ -0,0 +1,46 @@
+package com.dimafeng.testcontainers.lifecycle
+
+trait Stoppable extends AutoCloseable with Andable {
+
+  def stop(): Unit
+
+  override def close(): Unit = stop()
+}
+
+/**
+  * Gives you a possibility to write `container1 and container2`.
+  *
+  * Used for tests DSL.
+  */
+sealed trait Andable {
+
+  def stop(): Unit
+
+  def foreach(f: Stoppable => Unit): Unit = {
+    this match {
+      case and(head, tail) =>
+        head.foreach(f)
+        tail.foreach(f)
+
+      case stoppable: Stoppable =>
+        f(stoppable)
+    }
+  }
+
+}
+final case class and[A1 <: Andable, A2 <: Andable](head: A1, tail: A2) extends Andable {
+
+  /**
+    * Stopping all Andable elements in the reverse order
+    */
+  override def stop(): Unit = {
+    tail.stop()
+    head.stop()
+  }
+}
+
+object Andable {
+  implicit class AndableOps[A <: Andable](val self: A) extends AnyVal {
+    def and[A2 <: Andable](that: A2): A and A2 = com.dimafeng.testcontainers.lifecycle.and(self, that)
+  }
+}

core/src/test/scala/com/dimafeng/testcontainers/BaseSpec.scala

@@ -2,7 +2,7 @@ package com.dimafeng.testcontainers
 
 import org.mockito.MockitoAnnotations
 import org.scalatest.{BeforeAndAfterAll, BeforeAndAfterEach, FlatSpec, Matchers}
-import org.scalatest.mockito.MockitoSugar
+import org.scalatestplus.mockito.MockitoSugar
 
 abstract class BaseSpec[T: Manifest]
   extends FlatSpec with Matchers with MockitoSugar with BeforeAndAfterEach with BeforeAndAfterAll {