TestContainersSuite

trait TestContainersSuite extends DockerImageNameConverters
Companion:
object
trait DockerImageNameConverters
class Object
trait Matchable
class Any
Suite

Type members

Types

type Containers <: Andable

To use testcontainers suites you need to declare, which containers you want to use inside your tests.

To use testcontainers suites you need to declare, which containers you want to use inside your tests.

For example:

 override type Containers = MySQLContainer

If you want to use multiple containers inside your tests, use and syntax:

 override type Containers = MySQLContainer and PostgreSQLContainer

Value members

Abstract methods

Contains containers startup logic. In this method you can use any intermediate logic. You can pass parameters between containers, for example:

Contains containers startup logic. In this method you can use any intermediate logic. You can pass parameters between containers, for example:

override def startContainers(): Containers = {
 val container1 = Container1.Def().start()
 val container2 = Container2.Def(container1.someParam).start()
 container1 and container2
}
Returns:

Started containers

Concrete methods

def afterContainersStart(containers: Containers): Unit

Override, if you want to do something after containers start.

Override, if you want to do something after containers start.

def beforeContainersStop(containers: Containers): Unit

Override, if you want to do something before containers stop.

Override, if you want to do something before containers stop.

def withContainers[A](runTest: Containers => A): A

To use containers inside your test bodies you need to use withContainers function:

To use containers inside your test bodies you need to use withContainers function:

test("test") {
 withContainers { mysqlContainer =>
   // Inside your test body you can do with your container whatever you want to
   assert(mysqlContainer.jdbcUrl.nonEmpty)
 }
}

withContainers also supports multiple containers:

test("test") {
 withContainers { case mysqlContainer and pgContainer =>
   // test body
 }
}
Value parameters:
runTest

Test body

Concrete fields

val suiteDescription: TestDescription

Implicits

Deprecated and Inherited implicits

@deprecated("Use `DockerImageName` in Container constructor instead")
implicit def stringToDockerImageName(s: String): DockerImageName
Deprecated
Inherited from:
DockerImageNameConverters