Trait

com.dimafeng.testcontainers.munit

TestContainerForAll

Related Doc: package munit

Permalink

trait TestContainerForAll extends TestContainersForAll

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

Example:

class MysqlSpec extends FunSuite 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
  test("test case name") {
    withContainers { mysqlContainer =>
      // Inside your test body you can do with your container whatever you want to
      assert(mysqlContainer.jdbcUrl.nonEmpty)
    }
  }
}

Notes:
- If you override beforeAll() without calling super.beforeAll() your container won't start
- If you override afterAll() without calling super.afterAll() your container won't stop
Self Type
TestContainerForAll with Suite
Linear Supertypes
TestContainersForAll, TestContainersSuite, DockerImageNameConverters, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestContainerForAll
  2. TestContainersForAll
  3. TestContainersSuite
  4. DockerImageNameConverters
  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 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
    TestContainerForAllTestContainersForAllTestContainersSuite

Abstract Value Members

  1. abstract val containerDef: ContainerDef

    Permalink

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 afterAll(): Unit

    Permalink
    Definition Classes
    TestContainersForAll
  5. 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
  6. def afterEach(context: (TestContainerForAll.this)#AfterEach): Unit

    Permalink
    Definition Classes
    TestContainersForAll
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def beforeAll(): Unit

    Permalink
    Definition Classes
    TestContainersForAll
  9. 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
  10. def beforeEach(context: (TestContainerForAll.this)#BeforeEach): Unit

    Permalink
    Definition Classes
    TestContainersForAll
  11. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  20. 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
    TestContainerForAllTestContainersSuite
  21. val suiteDescription: TestDescription

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

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. 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:

    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

  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.

  2. implicit def stringToDockerImageName(s: String): DockerImageName

    Permalink
    Definition Classes
    DockerImageNameConverters
    Annotations
    @deprecated
    Deprecated

    Use DockerImageName in Container constructor instead

Inherited from TestContainersForAll

Inherited from TestContainersSuite

Inherited from DockerImageNameConverters

Inherited from AnyRef

Inherited from Any

Ungrouped