formatterStarted :: FormatM ()

evaluated before a test run
formatterGroupStarted :: Path -> FormatM ()

evaluated before each spec group
formatterGroupDone :: Path -> FormatM ()

evaluated after each spec group
formatterProgress :: Path -> Progress -> FormatM ()

used to notify the progress of the currently evaluated example
formatterItemStarted :: Path -> FormatM ()

evaluated before each spec item
formatterItemDone :: Path -> Item -> FormatM ()

evaluated after each spec item
formatterDone :: FormatM ()

evaluated after a test run

type Path = ([ String ], String ) Source #

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

Since: 2.0.0

type Progress = ( Int , Int ) Source #

data Location Source #

Location is used to represent source locations.

Constructors

Location
Fields locationFile :: FilePath locationLine :: Int locationColumn :: Int

Instances

Instances details

Eq Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods (==) :: Location -> Location -> Bool Source # (/=) :: Location -> Location -> Bool Source #
Read Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods readsPrec :: Int -> ReadS Location Source # readList :: ReadS [ Location ] Source # readPrec :: ReadPrec Location Source # readListPrec :: ReadPrec [ Location ] Source #
Show Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods showsPrec :: Int -> Location -> ShowS Source # show :: Location -> String Source # showList :: [ Location ] -> ShowS Source #

data Item Source #

Constructors

Item
Fields itemLocation :: Maybe Location itemDuration :: Seconds itemInfo :: String itemResult :: Result

Instances

Instances details

Show Item Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> Item -> ShowS Source # show :: Item -> String Source # showList :: [ Item ] -> ShowS Source #

data Result Source #

Constructors

Success
Pending ( Maybe Location ) ( Maybe String )
Failure ( Maybe Location ) FailureReason

Instances

Instances details

Show Result Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> Result -> ShowS Source # show :: Result -> String Source # showList :: [ Result ] -> ShowS Source #

data FailureReason Source #

Constructors

NoReason
Reason String
ExpectedButGot ( Maybe String ) String String
Error ( Maybe String ) SomeException

Instances

Instances details

Show FailureReason Source #
Instance details Defined in Test.Hspec.Core.Example Methods showsPrec :: Int -> FailureReason -> ShowS Source # show :: FailureReason -> String Source # showList :: [ FailureReason ] -> ShowS Source #
NFData FailureReason Source #
Instance details Defined in Test.Hspec.Core.Example Methods rnf :: FailureReason -> () Source #

data FormatM a Source #

Instances

Instances details

Monad FormatM Source #
Instance details Defined in Test.Hspec.Core.Formatters.Internal Methods (>>=) :: FormatM a -> (a -> FormatM b) -> FormatM b Source # (>>) :: FormatM a -> FormatM b -> FormatM b Source # return :: a -> FormatM a Source #
Functor FormatM Source #
Instance details Defined in Test.Hspec.Core.Formatters.Internal Methods fmap :: (a -> b) -> FormatM a -> FormatM b Source # (<$) :: a -> FormatM b -> FormatM a Source #
Applicative FormatM Source #
Instance details Defined in Test.Hspec.Core.Formatters.Internal Methods pure :: a -> FormatM a Source # (<>) :: FormatM (a -> b) -> FormatM a -> FormatM b Source # liftA2 :: (a -> b -> c) -> FormatM a -> FormatM b -> FormatM c Source # (>) :: FormatM a -> FormatM b -> FormatM b Source # (<*) :: FormatM a -> FormatM b -> FormatM a Source #
MonadIO FormatM Source #
Instance details Defined in Test.Hspec.Core.Formatters.Internal Methods liftIO :: IO a -> FormatM a Source #

formatterToFormat :: Formatter -> FormatConfig -> IO Format Source #

Accessing the runner state

getSuccessCount :: FormatM Int Source #

Get the number of successful examples encountered so far.

getPendingCount :: FormatM Int Source #

Get the number of pending examples encountered so far.

getFailCount :: FormatM Int Source #

Get the number of failed examples encountered so far.

getTotalCount :: FormatM Int Source #

Get the total number of examples encountered so far.

getExpectedTotalCount :: FormatM Int Source #

Get the number of spec items that will have been encountered when this run completes (if it is not terminated early).

data FailureRecord Source #

Constructors

FailureRecord
Fields failureRecordLocation :: Maybe Location failureRecordPath :: Path failureRecordMessage :: FailureReason

getFailMessages :: FormatM [ FailureRecord ] Source #

Get the list of accumulated failure messages.

usedSeed :: FormatM Integer Source #

The random seed that is used for QuickCheck.

printTimes :: FormatM Bool Source #

Return True if the user requested time reporting for individual spec items, False otherwise.

newtype Seconds Source #

Constructors

Seconds Double

Instances

Instances details

Eq Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (==) :: Seconds -> Seconds -> Bool Source # (/=) :: Seconds -> Seconds -> Bool Source #
Fractional Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (/) :: Seconds -> Seconds -> Seconds Source # recip :: Seconds -> Seconds Source # fromRational :: Rational -> Seconds Source #
Num Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (+) :: Seconds -> Seconds -> Seconds Source # (-) :: Seconds -> Seconds -> Seconds Source # (*) :: Seconds -> Seconds -> Seconds Source # negate :: Seconds -> Seconds Source # abs :: Seconds -> Seconds Source # signum :: Seconds -> Seconds Source # fromInteger :: Integer -> Seconds Source #
Ord Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods compare :: Seconds -> Seconds -> Ordering Source # (<) :: Seconds -> Seconds -> Bool Source # (<=) :: Seconds -> Seconds -> Bool Source # (>) :: Seconds -> Seconds -> Bool Source # (>=) :: Seconds -> Seconds -> Bool Source # max :: Seconds -> Seconds -> Seconds Source # min :: Seconds -> Seconds -> Seconds Source #
Show Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods showsPrec :: Int -> Seconds -> ShowS Source # show :: Seconds -> String Source # showList :: [ Seconds ] -> ShowS Source #
PrintfArg Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods formatArg :: Seconds -> FieldFormatter Source # parseFormat :: Seconds -> ModifierParser Source #

getCPUTime :: FormatM ( Maybe Seconds ) Source #

Get the used CPU time since the test run has been started.

getRealTime :: FormatM Seconds Source #

Get the passed real time since the test run has been started.

Appending to the generated report

write :: String -> FormatM () Source #

Append some output to the report.

writeLine :: String -> FormatM () Source #

The same as write , but adds a newline character.

writeTransient :: String -> FormatM () Source #

Dealing with colors

withInfoColor :: FormatM a -> FormatM a Source #

Set output color to cyan, run given action, and finally restore the default color.

withSuccessColor :: FormatM a -> FormatM a Source #

Set output color to green, run given action, and finally restore the default color.

withPendingColor :: FormatM a -> FormatM a Source #

Set output color to yellow, run given action, and finally restore the default color.

withFailColor :: FormatM a -> FormatM a Source #

Set output color to red, run given action, and finally restore the default color.

outputUnicode :: FormatM Bool Source #

Return True if the user requested unicode output, False otherwise.

useDiff :: FormatM Bool Source #

Return True if the user requested colorized diffs, False otherwise.

diffContext :: FormatM ( Maybe Int ) Source #

Return the value of configDiffContext .

Since: 2.10.6

externalDiffAction :: FormatM ( Maybe ( String -> String -> IO ())) Source #

An action for printing diffs.

The action takes expected and actual as arguments.

When this is a Just -value then it should be used instead of any built-in diff implementation. A Just -value also implies that useDiff returns True .

Since: 2.10.6

prettyPrint :: FormatM Bool Source #

Deprecated: use prettyPrintFunction instead

Return True if the user requested pretty diffs, False otherwise.

prettyPrintFunction :: FormatM ( Maybe ( String -> String -> ( String , String ))) Source #

Return a function for pretty-printing if the user requested pretty diffs, Nothing otherwise.

Since: 2.10.0

extraChunk :: String -> FormatM () Source #

Output given chunk in red.

missingChunk :: String -> FormatM () Source #

Output given chunk in green.

Helpers

formatLocation :: Location -> String Source #

formatException :: SomeException -> String Source #

The function formatException converts an exception to a string.

This is different from show . The type of the exception is included, e.g.:

>>> formatException (toException DivideByZero)
"ArithException\ndivide by zero"

For IOException s the IOErrorType is included, as well.

Since: 2.0.0