Modulehspec-expectations-lifted-0.10.0Haskell98

Test.Hspec.Expectations.Lifted

Introductory documentation: https://github.com/hspec/hspec-expectations#readme

1 type
12 values

Packagehspec-expectations-lifted-0.10.0
Exports13
LanguageHaskell98
LicenceMIT
SourceLifted.hs

Setting expectations

12 declarations

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

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

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

valueshouldSatisfy

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

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

valueshouldStartWith

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

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

valueshouldEndWith

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

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

valueshouldContain

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

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

valueshouldMatchList

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

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

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

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

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

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

valueshouldNotSatisfy

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

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

valueshouldNotContain

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

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

valueshouldNotReturn

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

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

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.