Idris2Doc : Evince.Expectations

Evince.Expectations

(source)

Definitions

mustBe : (Applicative m, (DecEq a, Show a)) => a -> a -> TestResultT m ()
  Passes if `actual` is decidably equal to `expected`. Uses `DecEq` for
constructive equality - the primary assertion in evince.

Totality: total
Visibility: export
mustNotBe : (Applicative m, (DecEq a, Show a)) => a -> a -> TestResultT m ()
  Passes if `actual` is decidably not equal to `expected`.

Totality: total
Visibility: export
mustEqual : (Applicative m, (Eq a, Show a)) => a -> a -> TestResultT m ()
  Passes if `actual == expected` via `Eq`. Fallback for types without `DecEq`
(e.g. `Double`).

Totality: total
Visibility: export
mustEqualBy : (Applicative m, Show a) => (a -> a -> Bool) -> a -> a -> TestResultT m ()
  Passes if `rel actual expected` holds. Fallback for comparisons `Eq`
can't express, such as approximate or NaN-reflexive equality on `Double`.

Totality: total
Visibility: export
mustNotEqual : (Applicative m, (Eq a, Show a)) => a -> a -> TestResultT m ()
  Passes if `actual /= expected` via `Eq`.

Totality: total
Visibility: export
mustSatisfy : (Applicative m, Show a) => a -> (a -> Bool) -> TestResultT m ()
  Passes if `pred actual` is `True`.

Totality: total
Visibility: export
mustNotSatisfy : (Applicative m, Show a) => a -> (a -> Bool) -> TestResultT m ()
  Passes if `pred actual` is `False`.

Totality: total
Visibility: export
mustBeTrue : Applicative m => Bool -> TestResultT m ()
  Passes if the value is `True`.

Totality: total
Visibility: export
mustBeFalse : Applicative m => Bool -> TestResultT m ()
  Passes if the value is `False`.

Totality: total
Visibility: export
mustBeJust : Applicative m => Maybe a -> TestResultT m ()
  Passes if the value is `Just _`.

Totality: total
Visibility: export
mustBeNothing : (Applicative m, Show a) => Maybe a -> TestResultT m ()
  Passes if the value is `Nothing`.

Totality: total
Visibility: export
mustBeRight : (Applicative m, Show a) => Either a b -> TestResultT m ()
  Passes if the value is `Right _`.

Totality: total
Visibility: export
mustBeLeft : (Applicative m, Show b) => Either a b -> TestResultT m ()
  Passes if the value is `Left _`.

Totality: total
Visibility: export
mustContain : (Applicative m, (Eq a, Show a)) => List a -> List a -> TestResultT m ()
  Passes if `needle` is a contiguous subsequence of `haystack`.

Totality: total
Visibility: export
mustNotContain : (Applicative m, (Eq a, Show a)) => List a -> List a -> TestResultT m ()
  Passes if `needle` is not a contiguous subsequence of `haystack`.

Totality: total
Visibility: export
mustStartWith : (Applicative m, (Eq a, Show a)) => List a -> List a -> TestResultT m ()
  Passes if the list starts with `prefx`.

Totality: total
Visibility: export
mustEndWith : (Applicative m, (Eq a, Show a)) => List a -> List a -> TestResultT m ()
  Passes if the list ends with `sufx`.

Totality: total
Visibility: export
mustBeEmpty : (Applicative m, Show a) => List a -> TestResultT m ()
  Passes if the list is empty.

Totality: total
Visibility: export
mustNotBeEmpty : Applicative m => List a -> TestResultT m ()
  Passes if the list is non-empty.

Totality: total
Visibility: export
mustFail : Applicative m => String -> TestResultT m ()
  Unconditionally fails with the given message.

Totality: total
Visibility: export
pending : Applicative m => TestResultT m ()
  Marks a test as pending (skipped, not counted as failure).

Totality: total
Visibility: export
pendingWith : Applicative m => String -> TestResultT m ()
  Marks a test as pending with a reason.

Totality: total
Visibility: export
mustReturn : (Monad m, (DecEq a, Show a)) => m a -> a -> TestResultT m ()
  Passes if the action returns a value decidably equal to `expected`.
The action runs in the chain's monad.

Visibility: export
mustReturnEqual : (Monad m, (Eq a, Show a)) => m a -> a -> TestResultT m ()
  Passes if the action returns a value equal to `expected` via Eq.
Fallback for types without `DecEq`.

Visibility: export