Safe Haskell	Safe
Language	Haskell2010

Test.Framework.AssertM

Description

This module defines the AssertM monad, which allows you either to run assertions as ordinary unit tests or to evaluate them as pure functions.

Synopsis

Documentation

class Monad m => AssertM m where Source #

A typeclass for generic assertions.

Minimal complete definition

genericAssertFailure__, genericSubAssert

Methods

genericAssertFailure__ :: Location -> ColorString -> m a Source #

genericSubAssert :: Location -> Maybe String -> m a -> m a Source #

Instances

AssertM IO Source #
Methods genericAssertFailure__ :: Location -> ColorString -> IO a Source # genericSubAssert :: Location -> Maybe String -> IO a -> IO a Source #
AssertM AssertBool Source #
Methods genericAssertFailure__ :: Location -> ColorString -> AssertBool a Source # genericSubAssert :: Location -> Maybe String -> AssertBool a -> AssertBool a Source #

data AssertStackElem Source #

Stack trace element for generic assertions.

Constructors

AssertStackElem
Fields ase_message :: Maybe String ase_location :: Maybe Location

Instances

Eq AssertStackElem Source #
Methods (==) :: AssertStackElem -> AssertStackElem -> Bool # (/=) :: AssertStackElem -> AssertStackElem -> Bool #
Ord AssertStackElem Source #
Methods compare :: AssertStackElem -> AssertStackElem -> Ordering # (<) :: AssertStackElem -> AssertStackElem -> Bool # (<=) :: AssertStackElem -> AssertStackElem -> Bool # (>) :: AssertStackElem -> AssertStackElem -> Bool # (>=) :: AssertStackElem -> AssertStackElem -> Bool # max :: AssertStackElem -> AssertStackElem -> AssertStackElem # min :: AssertStackElem -> AssertStackElem -> AssertStackElem #
Read AssertStackElem Source #
Methods readsPrec :: Int -> ReadS AssertStackElem # readList :: ReadS [AssertStackElem] # readPrec :: ReadPrec AssertStackElem # readListPrec :: ReadPrec [AssertStackElem] #
Show AssertStackElem Source #
Methods showsPrec :: Int -> AssertStackElem -> ShowS # show :: AssertStackElem -> String # showList :: [AssertStackElem] -> ShowS #

data AssertBool a Source #

Type for evaluating a generic assertion as a pure function.

Constructors

AssertOk a	Assertion passes successfully and yields the given value.
AssertFailed [AssertStackElem]	Assertion fails with the given stack trace. In the stack trace, the outermost stackframe comes first.

Instances

Monad AssertBool Source #
Methods (>>=) :: AssertBool a -> (a -> AssertBool b) -> AssertBool b # (>>) :: AssertBool a -> AssertBool b -> AssertBool b # return :: a -> AssertBool a # fail :: String -> AssertBool a #
Functor AssertBool Source #
Methods fmap :: (a -> b) -> AssertBool a -> AssertBool b # (<$) :: a -> AssertBool b -> AssertBool a #
Applicative AssertBool Source #
Methods pure :: a -> AssertBool a # (<>) :: AssertBool (a -> b) -> AssertBool a -> AssertBool b # liftA2 :: (a -> b -> c) -> AssertBool a -> AssertBool b -> AssertBool c # (>) :: AssertBool a -> AssertBool b -> AssertBool b # (<*) :: AssertBool a -> AssertBool b -> AssertBool a #
AssertM AssertBool Source #
Methods genericAssertFailure__ :: Location -> ColorString -> AssertBool a Source # genericSubAssert :: Location -> Maybe String -> AssertBool a -> AssertBool a Source #
Eq a => Eq (AssertBool a) Source #
Methods (==) :: AssertBool a -> AssertBool a -> Bool # (/=) :: AssertBool a -> AssertBool a -> Bool #
Ord a => Ord (AssertBool a) Source #
Methods compare :: AssertBool a -> AssertBool a -> Ordering # (<) :: AssertBool a -> AssertBool a -> Bool # (<=) :: AssertBool a -> AssertBool a -> Bool # (>) :: AssertBool a -> AssertBool a -> Bool # (>=) :: AssertBool a -> AssertBool a -> Bool # max :: AssertBool a -> AssertBool a -> AssertBool a # min :: AssertBool a -> AssertBool a -> AssertBool a #
Read a => Read (AssertBool a) Source #
Methods readsPrec :: Int -> ReadS (AssertBool a) # readList :: ReadS [AssertBool a] # readPrec :: ReadPrec (AssertBool a) # readListPrec :: ReadPrec [AssertBool a] #
Show a => Show (AssertBool a) Source #
Methods showsPrec :: Int -> AssertBool a -> ShowS # show :: AssertBool a -> String # showList :: [AssertBool a] -> ShowS #

boolValue :: AssertBool a -> Bool Source #

Evaluates a generic assertion to a Bool value.

eitherValue :: AssertBool a -> Either String a Source #

Evaluates a generic assertion to an Either value. The result is Right x if the assertion passes and yields value x, otherwise the result is Left err, where err is an error message.

formatStack :: [AssertStackElem] -> String Source #

Formats a stack trace.