Test.Hspec.Core.Formatters.V2 · hspec-core-2.11.14

Monad FormatMDefined in hspec-core-2.11.14 · Test.Hspec.Core.Formatters.Internal
Functor FormatMDefined in hspec-core-2.11.14 · Test.Hspec.Core.Formatters.Internal
Applicative FormatMDefined in hspec-core-2.11.14 · Test.Hspec.Core.Formatters.Internal
MonadIO FormatMDefined in hspec-core-2.11.14 · Test.Hspec.Core.Formatters.Internal

valueformatterToFormat :: Formatter -> FormatConfig -> IO Format

#

Accessing config values

valuegetConfig :: FormatM FormatConfig

#

valuegetConfigValue :: (FormatConfig -> a) -> FormatM a

#

datadata FormatConfig

#

Constructors

FormatConfig
- formatConfigUseColor :: Bool
- formatConfigReportProgress :: Bool
- formatConfigOutputUnicode :: Bool
- formatConfigUseDiff :: Bool
- formatConfigDiffContext :: Maybe Int
- formatConfigExternalDiff :: Maybe (String -> String -> IO ())
- formatConfigPrettyPrint :: Bool
- formatConfigPrettyPrintFunction :: Maybe (String -> String -> (String, String))
- formatConfigFormatException :: SomeException -> String
- formatConfigPrintTimes :: Bool
- formatConfigHtmlOutput :: Bool
- formatConfigPrintCpuTime :: Bool
- formatConfigUsedSeed :: Integer
- formatConfigExpectedTotalCount :: Int
- formatConfigExpertMode :: Bool

Accessing the runner state

valuegetSuccessCount :: FormatM Int

#

Get the number of successful examples encountered so far.

valuegetPendingCount :: FormatM Int

#

Get the number of pending examples encountered so far.

valuegetFailCount :: FormatM Int

#

Get the number of failed examples encountered so far.

valuegetTotalCount :: FormatM Int

#

Get the total number of examples encountered so far.

valuegetExpectedTotalCount :: FormatM Int

#

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

datadata FailureRecord

#

Constructors

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

valuegetFailMessages :: FormatM [FailureRecord]

#

Get the list of accumulated failure messages.

valueusedSeed :: FormatM Integer

#

The random seed that is used for QuickCheck.

valueprintTimes :: FormatM Bool

#

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

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

valuegetCPUTime :: FormatM (Maybe Seconds)

#

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

valuegetRealTime :: FormatM Seconds

#

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

Appending to the generated report

valuewrite :: String -> FormatM ()

#

Append some output to the report.

valuewriteLine :: String -> FormatM ()

#

The same as write, but adds a newline character.

valuewriteTransient :: String -> FormatM ()

#

Dealing with colors

valuewithInfoColor :: FormatM a -> FormatM a

#

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

valuewithPendingColor :: FormatM a -> FormatM a

#

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

valuewithFailColor :: FormatM a -> FormatM a

#

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

valueoutputUnicode :: FormatM Bool

#

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

valueuseDiff :: FormatM Bool

#

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

valuediffContext :: FormatM (Maybe Int)

#

Return the value of Test.Hspec.Core.Runner.configDiffContext.

valueexternalDiffAction :: FormatM (Maybe (String -> String -> IO ()))

#

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.

valueprettyPrint :: FormatM Bool

#

Deprecated. use prettyPrintFunction instead

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

valueprettyPrintFunction :: FormatM (Maybe (String -> String -> (String, String)))

#

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

valueextraChunk :: String -> FormatM ()

#

Output given chunk in red.

valuemissingChunk :: String -> FormatM ()

#

Output given chunk in green.

expert mode

valueunlessExpert :: FormatM () -> FormatM ()

#

Do nothing on `--expert`, otherwise run the given action.

Helpers

valueformatLocation :: Location -> String

#

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.