hspec-expectations-0.3.0: Catchy combinators for HUnit

Safe HaskellSafe-Infered




Introductory documentation: https://github.com/sol/test-shouldbe#readme


Setting expectations

shouldBe :: (Show a, Eq a) => a -> a -> ExpectationSource

actual `shouldBe` expected sets the expectation that actual is equal to expected (this is just an alias for @?=).

shouldSatisfy :: Show a => a -> (a -> Bool) -> ExpectationSource

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

shouldReturn :: (Show a, Eq a) => IO a -> a -> ExpectationSource

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

Expecting exceptions

shouldThrow :: Exception e => IO a -> Selector e -> ExpectationSource

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

type Selector a = a -> BoolSource

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.

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).