Test.Hspec.Expectations · hspec-expectations-0.8.4

Setting expectations

13 declarations

typetype Expectation = Assertion

#

valueexpectationFailure :: HasCallStack => String -> Expectation

#

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

#

actual `shouldBe` expected sets the expectation that actual is equal to expected.

valueshouldSatisfy :: (HasCallStack, Show a) => a -> (a -> Bool) -> Expectation

#

v `shouldSatisfy` p sets the expectation that p v is True.

valueshouldStartWith :: (HasCallStack, Show a, Eq a) => [a] -> [a] -> Expectation

#

list `shouldStartWith` prefix sets the expectation that list starts with prefix,

valueshouldEndWith :: (HasCallStack, Show a, Eq a) => [a] -> [a] -> Expectation

#

list `shouldEndWith` suffix sets the expectation that list ends with suffix,

valueshouldContain :: (HasCallStack, Show a, Eq a) => [a] -> [a] -> Expectation

#

list `shouldContain` sublist sets the expectation that sublist is contained, wholly and intact, anywhere in list.

valueshouldMatchList :: (HasCallStack, Show a, Eq a) => [a] -> [a] -> Expectation

#

xs `shouldMatchList` ys sets the expectation that xs has the same elements that ys has, possibly in another order

valueshouldReturn :: (HasCallStack, Show a, Eq a) => IO a -> a -> Expectation

#

action `shouldReturn` expected sets the expectation that action returns expected.

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

#

actual `shouldNotBe` notExpected sets the expectation that actual is not equal to notExpected

valueshouldNotSatisfy

:: (HasCallStack, Show a)
=> a
-> a -> Bool
-> Expectation

#

v `shouldNotSatisfy` p sets the expectation that p v is False.

valueshouldNotContain

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

#

list `shouldNotContain` sublist sets the expectation that sublist is not contained anywhere in list.

valueshouldNotReturn :: (HasCallStack, Show a, Eq a) => IO a -> a -> Expectation

#

action `shouldNotReturn` notExpected sets the expectation that action does not return notExpected.

Expecting exceptions

1 declaration

valueshouldThrow

:: (HasCallStack, Exception e)
=> IO a
-> Selector e
-> Expectation

#

action `shouldThrow` selector sets the expectation that action throws an exception. The precise nature of the expected exception is described with a Selector.

Selecting exceptions

typetype Selector a = a -> Bool

#

A Selector is a predicate; it can simultaneously constrain the type and value of an exception.

Predefined type-based selectors

There are predefined selectors for some standard exceptions. Each selector is just const True with an appropriate type.

valueanyException :: Selector SomeException

#

valueanyErrorCall :: Selector ErrorCall

#

valueanyIOException :: Selector IOException

#

valueanyArithException :: Selector ArithException

#

Combinators for defining value-based selectors

Some exceptions (most prominently ErrorCall) have no Eq instance. Selecting a specific value would require pattern matching.

For such exceptions, combinators that construct selectors are provided. Each combinator corresponds to a constructor; it takes the same arguments, and has the same name (but starting with a lower-case letter).

valueerrorCall :: String -> Selector ErrorCall

#

Re-exports

1 declaration

typetype HasCallStack = IP "callStack" CallStack

#

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.