Packages

trait TestContainerForEach extends TestContainersForEach

Starts a single container before each test and stop it after each test

Example:

class MysqlSpec extends AnyFlatSpec with TestContainerForEach {

  // 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)
  }
}
Self Type
TestContainerForEach with Suite
Linear Supertypes
TestContainersForEach, DockerImageNameConverters, TestContainersSuite, SuiteMixin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestContainerForEach
  2. TestContainersForEach
  3. DockerImageNameConverters
  4. TestContainersSuite
  5. SuiteMixin
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final type Containers = ContainerDef.Container

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

    To use testcontainers scalatest 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
    TestContainerForEach → TestContainersSuite

Abstract Value Members

  1. abstract val containerDef: ContainerDef
  2. abstract def expectedTestCount(filter: Filter): Int
    Definition Classes
    SuiteMixin
  3. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  4. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  5. abstract def run(testName: Option[String], args: Args): Status
    Definition Classes
    SuiteMixin
  6. abstract def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  10. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  11. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  13. abstract val styleName: String
    Definition Classes
    SuiteMixin
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def afterContainersStart(containers: (TestContainerForEach.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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def beforeContainersStop(containers: (TestContainerForEach.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
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    TestContainersForEach → SuiteMixin
  17. def startContainers(): ContainerDef.Container

    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
    TestContainerForEach → TestContainersSuite
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. def withContainers[A](runTest: ((TestContainerForEach.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:

    it should "test" in 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:

    it should "test" in withContainers { case mysqlContainer and pgContainer =>
  // test body
}
    runTest

    Test body

    Definition Classes
    TestContainersSuite

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. implicit def stringToDockerImageName(s: String): DockerImageName
    Definition Classes
    DockerImageNameConverters
    Annotations
    @deprecated
    Deprecated

    Use DockerImageName in Container constructor instead

Inherited from TestContainersForEach

Inherited from DockerImageNameConverters

Inherited from TestContainersSuite

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped