ModuleImpSpec-0.2.0.0Haskell2010

Test.ImpSpec.Expectations.Lifted

1 type
30 values

PackageImpSpec-0.2.0.0
Exports31
LanguageHaskell2010
LicenceApache-2.0
SourceLifted.hs

Lifted Expectations

1 declaration

valueio :: IO a -> IO a

Enforce the type of expectation

Useful with polymorphic expectations that are defined below.

Example

Because shouldBeExpr is polymorphic in m, compiler will choke with a unification error. This is due to the fact that hspec's it expects a polymorphic Example.

it "MyTest" $ do
  "foo" `shouldBeExpr` "bar"

However, this is easily solved by io:

it "MyTest" $ io $ do
  "foo" `shouldBeExpr` "bar"

Common

valueassertBool :: (HasCallStack, MonadIO m) => String -> Bool -> m ()

Lifted version of H.assertBool

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

Just like expectationFailure, but does not force the return type to unit. Lifted version of H.assertFailure

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.

valueshouldThrow

:: (HasCallStack, Exception e, MonadUnliftIO m)
=> m a
-> Selector e
-> m ()

Lifted version of shouldThrow.

typetype Selector a = a -> Bool

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

Custom

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

Either

valueshouldBeRight

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

Same as shouldBe, except it checks that the value is Right

valueshouldBeLeft

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

Same as shouldBe, except it checks that the value is Left

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

Return value on the Right and fail otherwise. Lifted version of H.expectRight.

valueexpectRightDeep

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

Same as expectRight, but also evaluate the returned value to NF

valueexpectRightDeep_

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

Same as expectRightDeep, but discards the result

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

Return value on the Left and fail otherwise

valueexpectLeftDeep

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

Same as expectLeft, but also evaluate the returned value to NF

valueexpectLeftDeep_

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

Same as expectLeftDeep, but discards the result

Maybe

valueshouldBeJust

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

Same as shouldBe, except it checks that the value is Just

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

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

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

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