Test.Hspec.Formatters · hspec-2.11.14

datadata Formatter

#

Constructors

Formatter
- headerFormatter :: FormatM ()
- exampleGroupStarted :: [String] -> String -> FormatM ()
- exampleGroupDone :: FormatM ()
- exampleStarted :: Path -> FormatM ()
- exampleProgress :: Path -> Progress -> FormatM ()
- exampleSucceeded :: Path -> String -> FormatM ()
- exampleFailed :: Path -> String -> FailureReason -> FormatM ()
- examplePending :: Path -> String -> Maybe String -> FormatM ()
- failedFormatter :: FormatM ()
- footerFormatter :: FormatM ()

Instances2IsFormatter

IsFormatter FormatterDefined in hspec-2.11.14 · Test.Hspec.Discover
IsFormatter (IO Formatter)Defined in hspec-2.11.14 · Test.Hspec.Discover

newtypenewtype Seconds

#

Constructors

Seconds Double

Instances6Eq, Fractional, Num, Ord, Show, PrintfArg

Eq SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock
Fractional SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock
Num SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock
Ord SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock
Show SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock
PrintfArg SecondsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Clock

valuechecks :: Formatter

#

valuefailed_examples :: Formatter

#

valueformatterToFormat :: Formatter -> FormatConfig -> IO Format

#

valueprogress :: Formatter

#

valuesilent :: Formatter

#

valuespecdoc :: Formatter

#

datadata FailureReason

#

Constructors

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

Instances1Show

Show FailureReasonDefined in hspec-core-2.11.14 · Test.Hspec.Core.Formatters.V1.Monad

datadata FailureRecord

#

Constructors

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

typetype FormatM = Free FormatF

#

valueextraChunk :: String -> FormatM ()

#

Output given chunk in red.

valuegetCPUTime :: FormatM (Maybe Seconds)

#

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

valuegetFailCount :: FormatM Int

#

Get the number of failed examples encountered so far.

valuegetFailMessages :: FormatM [FailureRecord]

#

Get the list of accumulated failure messages.

valuegetPendingCount :: FormatM Int

#

Get the number of pending examples encountered so far.

valuegetRealTime :: FormatM Seconds

#

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

valuegetSuccessCount :: FormatM Int

#

Get the number of successful examples encountered so far.

valuegetTotalCount :: FormatM Int

#

Get the total number of examples encountered so far.

valuemissingChunk :: String -> FormatM ()

#

Output given chunk in green.

valueuseDiff :: FormatM Bool

#

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

valueusedSeed :: FormatM Integer

#

The random seed that is used for QuickCheck.

valuewithFailColor :: FormatM a -> FormatM a

#

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

valuewithInfoColor :: FormatM a -> FormatM a

#

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

valuewithPendingColor :: FormatM a -> FormatM a

#

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

valuewithSuccessColor :: FormatM a -> FormatM a

#

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

valuewrite :: String -> FormatM ()

#

Append some output to the report.

valuewriteLine :: String -> FormatM ()

#

The same as write, but adds a newline character.

valuewriteTransient :: String -> FormatM ()

#

valueformatException :: 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.:

Example1 expression

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

For IOExceptions the IOErrorType is included, as well.