Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Expectations

Functions for making assertions about test behavior.

20 values

Packagesandwich-0.3.1.0
Exports20
LanguageHaskell2010
LicenceBSD-3-Clause
SourceExpectations.hs

Manually fail a test or mark as pending

4 declarations

valueexpectationFailure :: (HasCallStack, MonadIO m) => String -> m a

General-purpose function to throw a test exception with a String.

valuepending :: (HasCallStack, MonadIO m) => m a

Throws a Pending exception, which will cause the test to be marked as pending.

valuependingWith :: (HasCallStack, MonadIO m) => String -> m a

Throws a Pending exception with a message to add additional details.

valuexit

:: (HasCallStack, MonadIO m)
=> String
-> ExampleT context m ()
-> SpecFree context m ()

Shorthand for a pending test example. You can quickly mark an it node as pending by putting an "x" in front of it.

Expecting failures

3 declarations

valueshouldFail :: (HasCallStack, MonadUnliftIO m) => m () -> m ()

Assert that a given action should fail with some FailureReason.

valueshouldFailPredicate

:: (HasCallStack, MonadUnliftIO m)
=> FailureReason -> Bool
-> m ()
-> m ()

Assert that a given action should fail with some FailureReason matching a predicate.

valueshouldThrow

:: (HasCallStack, MonadUnliftIO m, Exception e)
=> m a
The action to run.
-> (e -> Bool)
A predicate on the exception to determine if it's as expected.
-> m ()

Asserts that an action should throw an exception. Accepts a predicate to determine if the exception matches.

Assertions

13 declarations

valueshouldBe :: (HasCallStack, MonadIO m, Eq a, Show a) => a -> a -> m ()

Asserts that two things are equal.

valueshouldNotBe :: (HasCallStack, MonadIO m, Eq a, Show a) => a -> a -> m ()

Asserts that two things are not equal.

valueshouldContain

:: (HasCallStack, MonadIO m, Eq a, Show a)
=> [a]
-> [a]
-> m ()

Asserts that the given list contains a subsequence.

valueshouldContainPredicate

:: (HasCallStack, MonadIO m, Show a)
=> [a]
-> a -> Bool
-> m ()

Asserts that the given list contains an item matching a predicate.

valueshouldNotContain

:: (HasCallStack, MonadIO m, Eq a, Show a)
=> [a]
-> [a]
-> m ()

Asserts that the given list does not contain a subsequence.

valueshouldBeSet

:: (HasCallStack, MonadIO m, Ord a, Show a)
=> [a]
-> [a]
-> m ()

Asserts that the given lists are equal as sets.

valueshouldNotContainPredicate

:: (HasCallStack, MonadIO m, Show a)
=> [a]
-> a -> Bool
-> m ()

Asserts that the given list contains an item matching a predicate.

valueshouldBeNothing :: (HasCallStack, MonadIO m, Show a) => Maybe a -> m ()

Asserts that the given Maybe is Nothing.

valueshouldBeJust :: (HasCallStack, MonadIO m) => Maybe a -> m ()

Asserts that the given Maybe is Just.

valueshouldBeLeft

:: (HasCallStack, MonadIO m, Show a, Show b)
=> Either a b
-> m ()

Asserts that the given Either is Left.

valueshouldBeRight

:: (HasCallStack, MonadIO m, Show a, Show b)
=> Either a b
-> m ()

Asserts that the given Either is Right.

valuetextShouldContain :: (HasCallStack, MonadIO m) => Text -> Text -> m ()

Asserts that the given text contains a substring.

valuetextShouldNotContain :: (HasCallStack, MonadIO m) => Text -> Text -> m ()

Asserts that the given text does not contain a substring.