Expect.Task

A library to create Expecations for Tasks.

Documentation

check :: Expectation -> Task TestFailure ()

Check an expectation in the middle of a do block.

task "Laundry gets done" <| do
    weightInKgs <- clothesInWasher
    check (weightInKgs |> Expect.atMost 8)
    soapInWasher
    startMachine

andCheck :: (a -> Expectation) -> Task TestFailure a -> Task TestFailure a

Check a task returns an expected value, than pass that value on.

task "Greetings are friendly" <| do
    getGreeting
        |> andCheck (Expect.equal "Hi!")

succeeds :: Show err => Task err a -> Task TestFailure a

Check a task succeeds.

task "solve rubicskube" <| do
    solveRubicsKube
        |> succeeds

fails :: Text -> Task TestFailure a

Check a task fails.

task "chemistry experiment" <| do
    mixRedAndGreenLiquids
        |> fails

data TestFailure

Error generated when a test expectation is not met.

Instances

Show TestFailure

Defined in Internal.TestResult

Methods

showsPrec :: Int -> TestFailure -> ShowS

show :: TestFailure -> String

showList :: [TestFailure] -> ShowS

Semigroup TestFailure

Defined in Internal.TestResult

Methods

(<>) :: TestFailure -> TestFailure -> TestFailure

sconcat :: NonEmpty TestFailure -> TestFailure

stimes :: Integral b => b -> TestFailure -> TestFailure

Monoid TestFailure

Defined in Internal.TestResult

Methods

mempty :: TestFailure

mappend :: TestFailure -> TestFailure -> TestFailure

mconcat :: [TestFailure] -> TestFailure

Exception TestFailure

Defined in Internal.TestResult

Methods

toException :: TestFailure -> SomeException

fromException :: SomeException -> Maybe TestFailure

displayException :: TestFailure -> String