pillars
0.4.4
API
Generated with
pillars/pillars/pillars.tests/PillarsFromContainersForAll

PillarsFromContainersForAll

pillars.tests.PillarsFromContainersForAll
trait PillarsFromContainersForAll extends PillarsSuite, TestContainersForAll

Attributes

Source
suite.scala
Graph
Supertypes
trait TestContainersForAll
trait PillarsSuite
trait TestContainersSuite
trait DockerImageNameConverters
class FunSuite
trait BaseFunSuite
trait ValueTransforms
trait SuiteTransforms
trait TestTransforms
trait TestOptionsConversions
trait FunFixtures
trait Assertions
trait CompileErrorMacro
class Suite
trait PlatformSuite
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

class FunFixture[T]

Attributes

Inherited from:
FunFixtures
Source
FunFixtures.scala
Supertypes
class Object
trait Matchable
class Any
object FunFixture

Attributes

Inherited from:
FunFixtures
Source
FunFixtures.scala
Supertypes
class Object
trait Matchable
class Any
implicit class MUnitCatsAssertionsForIOBooleanOps(io: IO[Boolean])

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
Supertypes
class Object
trait Matchable
class Any
implicit class MUnitCatsAssertionsForIOOps[A](io: IO[A])

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
Supertypes
class Object
trait Matchable
class Any
implicit class MUnitCatsAssertionsForIOUnitOps(io: IO[Unit])

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
Supertypes
class Object
trait Matchable
class Any
implicit class MUnitCatsAssertionsForSyncIOOps[A](io: SyncIO[A])

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
Supertypes
class Object
trait Matchable
class Any
implicit class MUnitCatsAssertionsForSyncIOUnitOps(io: SyncIO[Unit])

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
Supertypes
class Object
trait Matchable
class Any
object ResourceFunFixture

Attributes

Inherited from:
CatsEffectFunFixtures
Source
CatsEffectFunFixtures.scala
Supertypes
class Object
trait Matchable
class Any
object ResourceSuiteLocalFixture

Attributes

Inherited from:
CatsEffectFixtures
Source
CatsEffectFixtures.scala
Supertypes
class Object
trait Matchable
class Any
object ResourceTestLocalFixture

Attributes

Inherited from:
CatsEffectFixtures
Source
CatsEffectFixtures.scala
Supertypes
class Object
trait Matchable
class Any
final class SuiteTransform(val name: String, fn: List[Test] => List[Test]) extends List[Test] => List[Test]

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
Supertypes
trait List[Test] => List[Test]
class Object
trait Matchable
class Any
implicit class SyncIOFunFixtureOps[T](fixture: SyncIO[FunFixture[T]])

Attributes

Inherited from:
CatsEffectFunFixtures
Source
CatsEffectFunFixtures.scala
Supertypes
class Object
trait Matchable
class Any
final class TestTransform(val name: String, fn: Test => Test) extends Test => Test

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
Supertypes
trait Test => Test
class Object
trait Matchable
class Any
final class ValueTransform(val name: String, fn: PartialFunction[Any, Future[Any]]) extends Any => Option[Future[Any]]

Attributes

Inherited from:
ValueTransforms
Source
ValueTransforms.scala
Supertypes
trait Any => Option[Future[Any]]
class Object
trait Matchable
class Any

Deprecated and Inherited classlikes

object ResourceFixture

Attributes

Deprecated
true
Inherited from:
CatsEffectFunFixtures
Source
CatsEffectFunFixtures.scala
Supertypes
class Object
trait Matchable
class Any
object UnsafeResourceSuiteLocalDeferredFixture

Attributes

Deprecated
true
Inherited from:
CatsEffectFixtures
Source
CatsEffectFixtures.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

final type AfterEach = AfterEach

Attributes

Inherited from:
Suite
Source
Suite.scala
final type BeforeEach = BeforeEach

Attributes

Inherited from:
Suite
Source
Suite.scala
final type Fixture[T] = Fixture[T]

Attributes

Inherited from:
Suite
Source
Suite.scala
final type Test = Test

Attributes

Inherited from:
Suite
Source
Suite.scala
final type TestValue = Future[Any]

The value produced by test bodies.

The value produced by test bodies.

Attributes

Inherited from:
Suite
Source
Suite.scala

Inherited and Abstract types

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

Attributes

Inherited from:
TestContainersForAll
Source
TestContainersForAll.scala

Value members

Inherited methods

override def afterAll(): Unit

Attributes

Definition Classes
TestContainersForAll
Inherited from:
TestContainersForAll
Source
TestContainersForAll.scala
def afterContainersStart(containers: Containers): Unit

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

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

Attributes

Inherited from:
TestContainersSuite
Source
TestContainersSuite.scala
override def afterEach(context: AfterEach): Unit

Attributes

Definition Classes
TestContainersForAll
Inherited from:
TestContainersForAll
Source
TestContainersForAll.scala
def assert(cond: => Boolean, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, compare: Compare[A, B]): Unit

Asserts that two elements are equal according to the Compare[A, B] type-class.

Asserts that two elements are equal according to the Compare[A, B] type-class.

By default, uses == to compare values.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: => Any)(implicit loc: Location): Unit

Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.

Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: => Any)(implicit loc: Location): Unit

Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.

Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertIO[A, B](obtained: IO[A], returns: B, clue: => Any)(implicit loc: Location, ev: B <:< A): IO[Unit]

Asserts that an IO returns an expected value.

Asserts that an IO returns an expected value.

The "returns" value (second argument) must have the same type or be a subtype of the one "contained" inside the IO (first argument). For example:

 assertIO(IO(Option(1)), returns = Some(1)) // OK
 assertIO(IO(Some(1)), returns = Option(1)) // Error: Option[Int] is not a subtype of Some[Int]

The "clue" value can be used to give extra information about the failure in case the assertion fails.

Value parameters

clue

a value that will be printed in case the assertions fails

obtained

the IO under testing

returns

the expected value

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def assertNoDiff(obtained: String, expected: String, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertNotEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, compare: Compare[A, B]): Unit

Asserts that two elements are not equal according to the Compare[A, B] type-class.

Asserts that two elements are not equal according to the Compare[A, B] type-class.

By default, uses == to compare values.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def assertSyncIO[A, B](obtained: SyncIO[A], returns: B, clue: => Any)(implicit loc: Location, ev: B <:< A): SyncIO[Unit]

Asserts that a SyncIO returns an expected value.

Asserts that a SyncIO returns an expected value.

The "returns" value (second argument) must have the same type or be a subtype of the one "contained" inside the SyncIO (first argument). For example:

 assertSyncIO(SyncIO(Option(1)), returns = Some(1)) // OK
 assertSyncIO(SyncIO(Some(1)), returns = Option(1)) // Error: Option[Int] is not a subtype of Some[Int]

The "clue" value can be used to give extra information about the failure in case the assertion fails.

Value parameters

clue

a value that will be printed in case the assertions fails

obtained

the SyncIO under testing

returns

the expected value

Attributes

Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def assume(cond: Boolean, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source
Assertions.scala
override def beforeAll(): Unit

Attributes

Definition Classes
TestContainersForAll
Inherited from:
TestContainersForAll
Source
TestContainersForAll.scala
def beforeContainersStop(containers: Containers): Unit

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

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

Attributes

Inherited from:
TestContainersSuite
Source
TestContainersSuite.scala
override def beforeEach(context: BeforeEach): Unit

Attributes

Definition Classes
TestContainersForAll
Inherited from:
TestContainersForAll
Source
TestContainersForAll.scala
def clue[T](c: Clue[T]): T

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def clues(clue: Clue[_]*): Clues

Attributes

Inherited from:
Assertions
Source
Assertions.scala
transparent inline def compileErrors(inline code: String): String

Attributes

Inherited from:
CompileErrorMacro
Source
MacroCompat.scala
def fail(message: String, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fails this test with the given message and optional clues.

Unconditionally fails this test with the given message and optional clues.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing

Unconditionally fails this test with the given message and exception marked as the cause.

Unconditionally fails this test with the given message and exception marked as the cause.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fails this test due to result of comparing two values.

Unconditionally fails this test due to result of comparing two values.

The only reason to use this method instead of fail() is if you want to allow comparing the two different values in the the IntelliJ GUI diff viewer.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fail this test case and cancel all the subsequent tests in this suite.

Unconditionally fail this test case and cancel all the subsequent tests in this suite.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def fromContainer(supports: Set[ModuleTestSupport])(containers: List[_ <: SingleContainer[_]]): Resource[IO, Pillars[IO]]

Attributes

Inherited from:
PillarsSuite
Source
suite.scala
def intercept[T <: Throwable](body: => Any)(implicit T: ClassTag[T], loc: Location): T

Evalutes the given expression and asserts that an exception of type T is thrown.

Evalutes the given expression and asserts that an exception of type T is thrown.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def interceptIO[T <: Throwable](io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]

Intercepts a Throwable being thrown inside the provided IO.

Intercepts a Throwable being thrown inside the provided IO.

Attributes

Example 
 val io = IO.raiseError[Unit](MyException("BOOM!"))
 interceptIO[MyException](io)

or

 interceptIO[MyException] {
     IO.raiseError[Unit](MyException("BOOM!"))
 }
Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: => Any)(implicit T: ClassTag[T], loc: Location): T

Evalutes the given expression and asserts that an exception of type T with the expected message is thrown.

Evalutes the given expression and asserts that an exception of type T with the expected message is thrown.

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def interceptMessageIO[T <: Throwable](expectedExceptionMessage: String)(io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]

Intercepts a Throwable with a certain message being thrown inside the provided IO.

Intercepts a Throwable with a certain message being thrown inside the provided IO.

Attributes

Example 
 val io = IO.raiseError[Unit](MyException("BOOM!"))
 interceptIO[MyException]("BOOM!")(io)

or

 interceptIO[MyException] {
     IO.raiseError[Unit](MyException("BOOM!"))
 }
Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def interceptMessageSyncIO[T <: Throwable](expectedExceptionMessage: String)(io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]

Intercepts a Throwable with a certain message being thrown inside the provided SyncIO.

Intercepts a Throwable with a certain message being thrown inside the provided SyncIO.

Attributes

Example 
 val io = SyncIO.raiseError[Unit](MyException("BOOM!"))
 interceptSyncIO[MyException]("BOOM!")(io)

or

 interceptSyncIO[MyException] {
     SyncIO.raiseError[Unit](MyException("BOOM!"))
 }
Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def interceptSyncIO[T <: Throwable](io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]

Intercepts a Throwable being thrown inside the provided SyncIO.

Intercepts a Throwable being thrown inside the provided SyncIO.

Attributes

Example 
 val io = SyncIO.raiseError[Unit](MyException("BOOM!"))
 interceptSyncIO[MyException](io)

or

 interceptSyncIO[MyException] {
     SyncIO.raiseError[Unit](MyException("BOOM!"))
 }
Inherited from:
CatsEffectAssertions
Source
CatsEffectAssertions.scala
def isCI: Boolean

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
def munitAnsiColors: Boolean

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def munitAppendToFailureMessage(buildSuffix: Test => Option[String]): TestTransform

Optionally augment a failure with additional information.

Optionally augment a failure with additional information.

Failures that are not FailExceptionLike subclasses will be wrapped, if needed.

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
def munitCaptureClues[T](thunk: => T): (T, Clues)

Attributes

Inherited from:
Assertions
Source
Assertions.scala
final def munitFailTransform: TestTransform

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
def munitFixtures: Seq[AnyFixture[_]]

Fixtures that can be reused for individual test cases or entire suites.

Fixtures that can be reused for individual test cases or entire suites.

Attributes

Inherited from:
Suite
Source
Suite.scala
def munitFlakyOK: Boolean

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
final def munitFlakyTransform: TestTransform

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
final def munitFutureTransform: ValueTransform

Attributes

Inherited from:
ValueTransforms
Source
ValueTransforms.scala
def munitIOTimeout: Duration

The timeout for IO-based tests. When it expires it will gracefully cancel the fiber running the test and invoke any finalizers before ultimately failing the test.

The timeout for IO-based tests. When it expires it will gracefully cancel the fiber running the test and invoke any finalizers before ultimately failing the test.

Note that the fiber may still hang while running finalizers or even be uncancelable. In this case the munitTimeout will take effect, with the caveat that the hanging fiber will be leaked.

Attributes

Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala
def munitIgnore: Boolean

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
final def munitIgnoreSuiteTransform: SuiteTransform

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
final def munitOnlySuiteTransform: SuiteTransform

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
def munitPrint(clue: => Any): String

Attributes

Inherited from:
Assertions
Source
Assertions.scala
final def munitSuiteTransform(tests: List[Test]): List[Test]

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
def munitSuiteTransforms: List[SuiteTransform]

Attributes

Inherited from:
SuiteTransforms
Source
SuiteTransforms.scala
final def munitTestTransform(test: Test): Test

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
def munitTestTransforms: List[TestTransform]

Attributes

Inherited from:
TestTransforms
Source
TestTransforms.scala
def munitTests(): Seq[Test]

The base class for all test suites

The base class for all test suites

Attributes

Inherited from:
BaseFunSuite
Source
FunSuite.scala
override def munitTimeout: Duration

The overall timeout applicable to all tests in the suite, including those written in terms of Future or synchronous code. This is implemented by the MUnit framework itself.

The overall timeout applicable to all tests in the suite, including those written in terms of Future or synchronous code. This is implemented by the MUnit framework itself.

When this timeout expires, the suite will immediately fail the test and proceed without waiting for its cancelation or even attempting to cancel it. For that reason it is recommended to set this to a greater value than munitIOTimeout, which performs graceful cancelation of IO-based tests. The default grace period for cancelation is 1 second.

Attributes

Definition Classes
CatsEffectSuite -> BaseFunSuite
Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala
final def munitValueTransform(testValue: => Any): Future[Any]

Attributes

Inherited from:
ValueTransforms
Source
ValueTransforms.scala
override def munitValueTransforms: List[ValueTransform]

Attributes

Definition Classes
CatsEffectSuite -> ValueTransforms
Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala
def printer: Printer

Attributes

Inherited from:
Assertions
Source
Assertions.scala
def test(options: TestOptions)(body: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
BaseFunSuite
Source
FunSuite.scala
def test(name: String)(body: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
BaseFunSuite
Source
FunSuite.scala
def withContainers[A](runTest: 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
 }
}

Value parameters

runTest

Test body

Attributes

Inherited from:
TestContainersSuite
Source
TestContainersSuite.scala
def withPillars[T](test: Pillars[IO] => IO[T]): IO[T]

Attributes

Inherited from:
PillarsSuite
Source
suite.scala

Inherited and Abstract methods

def moduleSupports: Set[ModuleTestSupport]

Attributes

Inherited from:
PillarsSuite
Source
suite.scala
def startContainers(): Containers

Contains containers startup logic. In this method you can use any intermediate logic. You can pass parameters between containers, for example:

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
}

Attributes

Returns

Started containers

Inherited from:
TestContainersSuite
Source
TestContainersSuite.scala

Deprecated and Inherited methods

def munitIoRuntime: IORuntime

Attributes

Deprecated
true
Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala

Inherited fields

val munitLines: Lines

Attributes

Inherited from:
Assertions
Source
Assertions.scala
final val munitTestsBuffer: ListBuffer[Test]

Attributes

Inherited from:
BaseFunSuite
Source
FunSuite.scala
val suiteDescription: TestDescription

Attributes

Inherited from:
TestContainersSuite
Source
TestContainersSuite.scala

Implicits

Inherited implicits

implicit override def munitExecutionContext: ExecutionContext

Attributes

Definition Classes
CatsEffectSuite -> Suite
Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala
implicit def munitIORuntime: IORuntime

Attributes

Inherited from:
CatsEffectSuite
Source
CatsEffectSuite.scala
implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions

Implicitly create a TestOptions given a test name. This allows writing test("name") { ... } even if test accepts a TestOptions

Implicitly create a TestOptions given a test name. This allows writing test("name") { ... } even if test accepts a TestOptions

Attributes

Inherited from:
TestOptionsConversions
Source
TestOptions.scala

Deprecated and Inherited implicits

implicit def stringToDockerImageName(s: String): DockerImageName

Attributes

Deprecated
true
Inherited from:
DockerImageNameConverters
Source
DockerImageNameConverters.scala
Generated with