TestContainersForEach

Starts containers before each test and stop them after each test

Example:

class ExampleSpec extends FunSuite with TestContainersForEach {

  // 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:
  test("test") {
    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)
    }
  }
}

Notes:
- If you override beforeEach() without calling super.beforeEach() your containers won't start
- If you override afterEach() without calling super.afterEach() your containers won't stop

Self Type: TestContainersForEach with Suite

Linear Supertypes

TestContainersSuite, DockerImageNameConverters, AnyRef, Any

Known Subclasses

TestContainerForEach

Type Members

abstract 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
```
Definition Classes
TestContainersForEach → TestContainersSuite

Abstract Value Members

abstract def startContainers(): (TestContainersForEach.this)#Containers

Contains containers startup logic.
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

Definition Classes
TestContainersSuite

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def afterContainersStart(containers: (TestContainersForEach.this)#Containers): Unit

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

Definition Classes
TestContainersSuite
def afterEach(context: (TestContainersForEach.this)#AfterEach): Unit
final def asInstanceOf[T0]: T0

Definition Classes
Any
def beforeContainersStop(containers: (TestContainersForEach.this)#Containers): Unit

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

Definition Classes
TestContainersSuite
def beforeEach(context: (TestContainersForEach.this)#BeforeEach): Unit
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val suiteDescription: TestDescription

Definition Classes
TestContainersSuite
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withContainers[A](runTest: ((TestContainersForEach.this)#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
  }
}
```
runTest
Test body

Definition Classes
TestContainersSuite

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.
implicit def stringToDockerImageName(s: String): DockerImageName

Definition Classes
DockerImageNameConverters
Annotations
@deprecated
Deprecated
Use DockerImageName in Container constructor instead

Related Doc: package munit

trait TestContainersForEach extends TestContainersSuite

Type Members

abstract type Containers <: Andable

Abstract Value Members

abstract def startContainers(): (TestContainersForEach.this)#Containers

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def afterContainersStart(containers: (TestContainersForEach.this)#Containers): Unit

def afterEach(context: (TestContainersForEach.this)#AfterEach): Unit

final def asInstanceOf[T0]: T0

def beforeContainersStop(containers: (TestContainersForEach.this)#Containers): Unit

def beforeEach(context: (TestContainersForEach.this)#BeforeEach): Unit

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val suiteDescription: TestDescription

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

def withContainers[A](runTest: ((TestContainersForEach.this)#Containers) ⇒ A): A

Deprecated Value Members

def finalize(): Unit

implicit def stringToDockerImageName(s: String): DockerImageName

Inherited from TestContainersSuite

Inherited from DockerImageNameConverters

Inherited from AnyRef

Inherited from Any

Ungrouped