weaver-test-extra
API
Generated with
weaver-test-extra/weaver.pure/Suite

Suite

weaver.pure.Suite
trait Suite extends EffectSuite[IO], BaseCatsSuite, Helpers

Attributes

Graph
Supertypes
trait Helpers
trait BaseCatsSuite
trait Provider[IO]
trait EffectSuite[IO]
trait Here
trait Suite[IO]
trait BaseSuiteClass
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

implicit class StringOps(str: String)

Attributes

Inherited from:
Helpers
Supertypes
class Object
trait Matchable
class Any

Inherited types

final type EffectType[A] = IO[A]

Attributes

Inherited from:
EffectSuite

Value members

Abstract methods

def suitesStream: Stream[IO, Test]

Concrete methods

override def getSuite: EffectSuite[IO]

Attributes

Definition Classes
Provider
override def spec(args: List[String]): Stream[IO, TestOutcome]

Attributes

Definition Classes
Suite

Inherited methods

def cancel(reason: String)(implicit pos: SourceLocation): IO[Nothing]

Raise an error that leads to the running test being tagged as "cancelled".

Raise an error that leads to the running test being tagged as "cancelled".

Attributes

Inherited from:
EffectSuite
inline def clue[A](value: A)(using catsShow: Show[A], clues: Clues): A

Used to investigate failures in expect or assert statements.

Used to investigate failures in expect or assert statements.

Surround a value with a call to clue to display it on failure.

Attributes

Inherited from:
ClueHelpers (hidden)
def exists[L[_], A](la: L[A])(f: A => Expectations)(implicit foldable: Foldable[L], pos: SourceLocation): Expectations

Checks that an assertion is true for at least one element in a foldable. Fails if the foldable is empty.

Checks that an assertion is true for at least one element in a foldable. Fails if the foldable is empty.

Attributes

Example 
   val xs =
     List("foo", "bar")
   // success
   exists(xs)(s => expect.eql("foo", s)
Inherited from:
Helpers
def expect: Expect

Expect macros

Expect macros

Attributes

Inherited from:
Helpers
def fail[A](hint: String)(implicit pos: SourceLocation): A => Expectations

Attributes

Inherited from:
Helpers
def failure(hint: String)(implicit pos: SourceLocation): Expectations

Attributes

Inherited from:
Helpers
def forEach[L[_], A](la: L[A])(f: A => Expectations)(implicit L: Foldable[L]): Expectations

Checks that an assertion is true for all elements in a foldable. Succeeds if the foldable is empty.

Checks that an assertion is true for all elements in a foldable. Succeeds if the foldable is empty.

Attributes

Example 
   val xs =
     List("foo", "bar")
   // success
   forEach(xs)(s => expect.eql(3, s.length)
Inherited from:
Helpers
inline def here: SourceLocation

Pulls source location without being affected by implicit scope.

Pulls source location without being affected by implicit scope.

Attributes

Inherited from:
Here
def ignore(reason: String)(implicit pos: SourceLocation): IO[Nothing]

Raises an error that leads to the running test being tagged as "ignored"

Raises an error that leads to the running test being tagged as "ignored"

Attributes

Inherited from:
EffectSuite
def inEach[L[_], A](la: L[A])(f: A => Expectations)(implicit L: Foldable[L]): Expectations

Alias for forEach

Alias for forEach

Attributes

Inherited from:
Helpers
def matches[A](x: A)(f: PartialFunction[A, Expectations])(implicit pos: SourceLocation, A: Show[A]): Expectations

Checks that a given expression matches a certain pattern; fails otherwise.

Checks that a given expression matches a certain pattern; fails otherwise.

Attributes

Example 
   matches(Option(4)) { case Some(x) =>
     expect.eql(4, x)
   }
Inherited from:
Helpers
override def name: String

Attributes

Definition Classes
EffectSuite -> Suite
Inherited from:
EffectSuite
def not(assertion: Expectations)(implicit pos: SourceLocation): Expectations

Attributes

Inherited from:
Helpers
final def run(args: List[String])(report: TestOutcome => IO[Unit]): IO[Unit]

Attributes

Inherited from:
EffectSuite
def succeed[A]: A => Expectations

Attributes

Inherited from:
Helpers
def verify(condition: Boolean)(implicit pos: SourceLocation): Expectations

Attributes

Inherited from:
Helpers
def verify(condition: Boolean, hint: String)(implicit pos: SourceLocation): Expectations

Attributes

Inherited from:
Helpers
def whenSuccess[F[_], A, E](fa: F[A])(f: A => Expectations)(implicit pos: SourceLocation, F: ApplicativeError[F, E], G: Foldable[F], E: Show[E]): Expectations

Checks that an ApplicativeError (like Either) is successful

Checks that an ApplicativeError (like Either) is successful

Attributes

Example 
   val res: Either[String, Int] =
     Right(4)
   whenSuccess(res) { n =>
     expect.eql(4, n)
   }
Inherited from:
Helpers

Inherited fields

val success: Expectations

Attributes

Inherited from:
Helpers

Implicits

Implicits

implicit override protected def effectCompat: EffectCompat[IO]

Attributes

Definition Classes
EffectSuite

Inherited implicits

final implicit def StringOps(str: String): StringOps

Attributes

Inherited from:
Helpers
Generated with