Trait/Object

com.dimafeng.testcontainers.munit

TestContainersSuite

Related Docs: object TestContainersSuite | package munit

Permalink

trait TestContainersSuite extends AnyRef

Self Type
TestContainersSuite with Suite
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestContainersSuite
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Containers <: Andable

    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

Abstract Value Members

  1. abstract def startContainers(): (TestContainersSuite.this)#Containers

    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

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: (TestContainersSuite.this)#Containers): Unit

    Permalink

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def beforeContainersStop(containers: (TestContainersSuite.this)#Containers): Unit

    Permalink

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

  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. val suiteDescription: TestDescription

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def withContainers[A](runTest: ((TestContainersSuite.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

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 AnyRef

Inherited from Any

Ungrouped