Trait

com.dimafeng.testcontainers.scalatest

TestContainerForAll

Related Doc: package scalatest

Permalink

trait TestContainerForAll extends TestContainersForAll

Starts a single container before all tests and stop it after all tests

Example:

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

Type Members

  1. final type Containers = ContainerDef.Container

    Permalink

    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
    TestContainerForAll → TestContainersSuite

Abstract Value Members

  1. abstract val containerDef: ContainerDef

    Permalink

  2. abstract def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    SuiteMixin

  3. abstract def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    SuiteMixin

  4. abstract def rerunner: Option[String]

    Permalink
    Definition Classes
    SuiteMixin

  5. abstract def runNestedSuites(args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin

  6. abstract def runTests(testName: Option[String], args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin

  7. abstract val styleName: String

    Permalink
    Definition Classes
    SuiteMixin

  8. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin

  9. abstract def suiteName: String

    Permalink
    Definition Classes
    SuiteMixin

  10. abstract def tags: Map[String, Set[String]]

    Permalink
    Definition Classes
    SuiteMixin

  11. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

    Permalink
    Definition Classes
    SuiteMixin

  12. abstract def testNames: Set[String]

    Permalink
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def afterContainersStart(containers: (TestContainerForAll.this)#Containers): Unit

    Permalink

    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

    Permalink
    Definition Classes
    Any

  6. def beforeContainersStop(containers: (TestContainerForAll.this)#Containers): Unit

    Permalink

    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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. def run(testName: Option[String], args: Args): Status

    Permalink
    Definition Classes
    TestContainersForAll → SuiteMixin

  17. def runTest(testName: String, args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    TestContainersForAll → SuiteMixin

  18. def startContainers(): ContainerDef.Container

    Permalink

    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
    TestContainerForAll → TestContainersSuite

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

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from TestContainersForAll

Inherited from TestContainersSuite

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped