Test.Hspec.Formatters

This module contains formatters that can be used with hspecWith.

Formatters

silent :: 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 :: Int -> [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 String -> 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

Instances

IsFormatter Formatter

IsFormatter (IO Formatter)

data FormatM a

Instances

Monad FormatM

Functor FormatM

Applicative FormatM

MonadIO FormatM

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

failureRecordPath :: Path

failureRecordMessage :: Either SomeException String

getFailMessages :: FormatM [FailureRecord]

Get the list of accumulated failure messages.

usedSeed :: FormatM Integer

The random seed that is used for QuickCheck.

getCPUTime :: FormatM (Maybe Double)

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

getRealTime :: FormatM Double

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

Appending to the gerenated report

write :: String -> FormatM ()

Append some output to the report.

writeLine :: String -> FormatM ()

The same as write, but adds a newline character.

newParagraph :: FormatM ()

Append an empty line to the report.

Calling this multiple times has the same effect as calling it once.

Dealing with colors

withSuccessColor :: FormatM a -> FormatM a

Set output to color 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.

Helpers

formatException :: SomeException -> String

Convert an exception to a string.

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

 ArithException (divide by zero)

Using custom formatters with hspec-discover

Anything that is an instance of IsFormatter can be used by hspec-discover as the default formatter for a spec. If you have a formatter myFormatter in the module Custom.Formatters you can use it by passing an additional argument to hspec-discover.

{-# OPTIONS_GHC -F -pgmF hspec-discover -optF --formatter=Custom.Formatters.myFormatter #-}

class IsFormatter a where

Methods

toFormatter :: a -> IO Formatter

Instances

IsFormatter Formatter

IsFormatter (IO Formatter)