Test.Hspec.Core.Formatters.V1

This module contains formatters that can be used with hspecWith.

Formatters

silent :: Formatter

checks :: Formatter

specdoc :: Formatter

progress :: Formatter

failed_examples :: Formatter

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

Constructors

Formatter

Fields

• headerFormatter :: FormatM ()
• exampleGroupStarted :: [String] -> String -> FormatM ()

  evaluated before each test group

• exampleGroupDone :: FormatM ()

  evaluated after each test group

• exampleStarted :: Path -> FormatM ()

  evaluated before each example

• exampleProgress :: Path -> Progress -> FormatM ()

  used to notify the progress of the currently evaluated example

• exampleSucceeded :: Path -> String -> FormatM ()

  evaluated after each successful example

• exampleFailed :: Path -> String -> FailureReason -> FormatM ()

  evaluated after each failed example

• examplePending :: Path -> String -> Maybe String -> FormatM ()

  evaluated after each pending example

• failedFormatter :: FormatM ()

  evaluated after a test run

• footerFormatter :: FormatM ()

  evaluated after failedFormatter

data FailureReason

Constructors

NoReason

Reason String

ExpectedButGot (Maybe String) String String

Error (Maybe String) SomeException

Instances

Show FailureReason

Defined in Test.Hspec.Core.Example

Methods

showsPrec :: Int -> FailureReason -> ShowS

show :: FailureReason -> String

showList :: [FailureReason] -> ShowS

NFData FailureReason

Defined in Test.Hspec.Core.Example

Methods

rnf :: FailureReason -> ()

type FormatM = Free FormatF

formatterToFormat :: Formatter -> FormatConfig -> IO Format

Accessing the runner state

getSuccessCount :: FormatM Int

Get the number of successful examples encountered so far.

getPendingCount :: FormatM Int

Get the number of pending examples encountered so far.

getFailCount :: FormatM Int

Get the number of failed examples encountered so far.

getTotalCount :: FormatM Int

Get the total number of examples encountered so far.

data FailureRecord

Constructors

FailureRecord

Fields

• failureRecordLocation :: Maybe Location
• failureRecordPath :: Path
• failureRecordMessage :: FailureReason

getFailMessages :: FormatM [FailureRecord]

Get the list of accumulated failure messages.

usedSeed :: FormatM Integer

The random seed that is used for QuickCheck.

newtype Seconds

Constructors

Seconds Double

Instances

Eq Seconds

Defined in Test.Hspec.Core.Clock

Methods

(==) :: Seconds -> Seconds -> Bool

(/=) :: Seconds -> Seconds -> Bool

Fractional Seconds

Defined in Test.Hspec.Core.Clock

Methods

(/) :: Seconds -> Seconds -> Seconds

recip :: Seconds -> Seconds

fromRational :: Rational -> Seconds

Num Seconds

Defined in Test.Hspec.Core.Clock

Methods

(+) :: Seconds -> Seconds -> Seconds

(-) :: Seconds -> Seconds -> Seconds

(*) :: Seconds -> Seconds -> Seconds

negate :: Seconds -> Seconds

abs :: Seconds -> Seconds

signum :: Seconds -> Seconds

fromInteger :: Integer -> Seconds

Ord Seconds

Defined in Test.Hspec.Core.Clock

Methods

compare :: Seconds -> Seconds -> Ordering

(<) :: Seconds -> Seconds -> Bool

(<=) :: Seconds -> Seconds -> Bool

(>) :: Seconds -> Seconds -> Bool

(>=) :: Seconds -> Seconds -> Bool

max :: Seconds -> Seconds -> Seconds

min :: Seconds -> Seconds -> Seconds

Show Seconds

Defined in Test.Hspec.Core.Clock

Methods

showsPrec :: Int -> Seconds -> ShowS

show :: Seconds -> String

showList :: [Seconds] -> ShowS

PrintfArg Seconds

Defined in Test.Hspec.Core.Clock

Methods

formatArg :: Seconds -> FieldFormatter

parseFormat :: Seconds -> ModifierParser

getCPUTime :: FormatM (Maybe Seconds)

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

getRealTime :: FormatM Seconds

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

Appending to the generated report

write :: String -> FormatM ()

Append some output to the report.

writeLine :: String -> FormatM ()

The same as write, but adds a newline character.

writeTransient :: String -> FormatM ()

Dealing with colors

withInfoColor :: FormatM a -> FormatM a

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

withSuccessColor :: FormatM a -> FormatM a

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

withPendingColor :: FormatM a -> FormatM a

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

withFailColor :: FormatM a -> FormatM a

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

useDiff :: FormatM Bool

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

extraChunk :: String -> FormatM ()

Output given chunk in red.

missingChunk :: String -> FormatM ()

Output given chunk in green.

Helpers

formatException :: SomeException -> String

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.