Stability	experimental
Safe Haskell	None
Language	Haskell2010

Test.Hspec.Core.Formatters

Contents

Formatters
Implementing a custom Formatter

Description

This module contains formatters that can be used with hspecWith.

Synopsis

Formatters

silent :: Formatter Source #

specdoc :: Formatter Source #

progress :: Formatter Source #

failed_examples :: Formatter Source #

Implementing a custom Formatter

A formatter is a set of actions. Each action is evaluated when a certain situation is encountered during a test run.

Actions live in the FormatM monad. It provides access to the runner state and primitives for appending to the generated report.

data Formatter Source #

Constructors

Formatter

Fields

headerFormatter :: FormatM ()
exampleGroupStarted :: [String] -> String -> FormatM ()
evaluated before each test group
The given number indicates the position within the parent group.
exampleGroupDone :: FormatM ()
exampleProgress :: Handle -> Path -> Progress -> IO ()
used to notify the progress of the currently evaluated example
Note: This is only called when interactive/color mode.
exampleSucceeded :: Path -> FormatM ()
evaluated after each successful example
exampleFailed :: Path -> Either SomeException FailureReason -> FormatM ()
evaluated after each failed example
examplePending :: Path -> Maybe String -> FormatM ()
evaluated after each pending example
failedFormatter :: FormatM ()
evaluated after a test run
footerFormatter :: FormatM ()
evaluated after failuresFormatter

data FailureReason Source #

Constructors

NoReason
Reason String
ExpectedButGot (Maybe String) String String

Instances

Eq FailureReason Source #
Methods (==) :: FailureReason -> FailureReason -> Bool # (/=) :: FailureReason -> FailureReason -> Bool #
Read FailureReason Source #
Methods readsPrec :: Int -> ReadS FailureReason # readList :: ReadS [FailureReason] # readPrec :: ReadPrec FailureReason # readListPrec :: ReadPrec [FailureReason] #
Show FailureReason Source #
Methods showsPrec :: Int -> FailureReason -> ShowS # show :: FailureReason -> String # showList :: [FailureReason] -> ShowS #
NFData FailureReason Source #
Methods rnf :: FailureReason -> () #

type FormatM = Free FormatF 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.

data FailureRecord Source #

Constructors

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

getFailMessages :: FormatM [FailureRecord] Source #

Get the list of accumulated failure messages.

usedSeed :: FormatM Integer Source #

The random seed that is used for QuickCheck.

getCPUTime :: FormatM (Maybe Double) Source #

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

getRealTime :: FormatM Double Source #

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

Appending to the gerenated report

write :: String -> FormatM () Source #

Append some output to the report.

writeLine :: String -> FormatM () Source #

The same as write, but adds a newline character.

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.

extraChunk :: String -> FormatM () Source #

Output given chunk in red.

missingChunk :: String -> FormatM () Source #

Output given chunk in green.

Helpers

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 (divide by zero)"

For IOExceptions the IOErrorType is included, as well.