Modulehspec-core-2.11.18Haskell2010

Test.Hspec.Core.Formatters.V2

This is an unstable API. Use Test.Hspec.Api.Formatters.V3 instead.

Contents

Formatters
Implementing a custom Formatter
Accessing config values
Accessing the runner state
Appending to the generated report
Dealing with colors
expert mode
Helpers

Synopsis

value silent
value checks
value specdoc
value progress
value failed_examples
data Formatter
type Path
type Progress
data Location
data Item
data Result
data FailureReason
newtype FormatM
value formatterToFormat
value getConfig
value getConfigValue
data FormatConfig
value getSuccessCount
value getPendingCount
value getFailCount
value getTotalCount
value getExpectedTotalCount
data FailureRecord
value getFailMessages
value usedSeed
value printTimes
newtype Seconds
value getCPUTime
value getRealTime
value write
value writeLine
value writeTransient
value withInfoColor
value withSuccessColor
value withPendingColor
value withFailColor
value outputUnicode
value useDiff
value diffContext
value externalDiffAction
value prettyPrint
value prettyPrintFunction
value extraChunk
value missingChunk
value unlessExpert
value formatLocation
value formatException

Packagehspec-core-2.11.18
Exports47
LanguageHaskell2010
LicenceMIT
SourceV2.hs

Formatters

valuesilent :: Formatter

valuechecks :: Formatter

valuespecdoc :: Formatter

valueprogress :: Formatter

valuefailed_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.

datadata Formatter

Constructors

Formatter
- formatterStarted :: FormatM ()
- formatterGroupStarted :: Path -> FormatM ()
- formatterGroupDone :: Path -> FormatM ()
- formatterProgress :: Path -> Progress -> FormatM ()
- formatterItemStarted :: Path -> FormatM ()
- formatterItemDone :: Path -> Item -> FormatM ()
- formatterDone :: FormatM ()

typetype Path = ([String], String)

Source#

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

typetype Progress = (Int, Int)

Source#

(CurrentItem, TotalItems) tuple.

datadata Location

Source#

Location is used to represent source locations.

Constructors

Location
- locationFile :: FilePath
- locationLine :: Int
- locationColumn :: Int

Instances3Eq, Read, Show

Eq LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location
Read LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location
Show LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location

datadata Item

Constructors

Item
- itemLocation :: Maybe Location
- itemDuration :: Seconds
- itemInfo :: String
- itemResult :: Result

Instances1Show

Show ItemDefined in hspec-core-2.11.18 · Test.Hspec.Core.Format

datadata Result

Constructors

Success
Pending (Maybe Location) (Maybe String)
Failure (Maybe Location) FailureReason

Instances1Show

Show ResultDefined in hspec-core-2.11.18 · Test.Hspec.Core.Format

datadata FailureReason

Constructors

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

Instances2Show, NFData

Show FailureReasonDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example
NFData FailureReasonDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example

newtypenewtype FormatM a

Instances4Monad, Functor, Applicative, MonadIO

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

valueformatterToFormat :: Formatter -> FormatConfig -> IO Format

Accessing config values

valuegetConfig :: FormatM FormatConfig

Source#

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

Source#

datadata FormatConfig

Source#

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

Source#

Get the number of successful examples encountered so far.

valuegetPendingCount :: FormatM Int

Source#

Get the number of pending examples encountered so far.

valuegetFailCount :: FormatM Int

Source#

Get the number of failed examples encountered so far.

valuegetTotalCount :: FormatM Int

Source#

Get the total number of examples encountered so far.

valuegetExpectedTotalCount :: FormatM Int

Source#

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]

Source#

Get the list of accumulated failure messages.

valueusedSeed :: FormatM Integer

Source#

The random seed that is used for QuickCheck.

valueprintTimes :: FormatM Bool

Source#

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.18 · Test.Hspec.Core.Clock
Fractional SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Num SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Ord SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Show SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
PrintfArg SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock

valuegetCPUTime :: FormatM (Maybe Seconds)

Source#

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

valuegetRealTime :: FormatM Seconds

Source#

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

Appending to the generated report

valuewrite :: String -> FormatM ()

Source#

Append some output to the report.

valuewriteLine :: String -> FormatM ()

Source#

The same as write, but adds a newline character.

valuewriteTransient :: String -> FormatM ()

Dealing with colors

valuewithInfoColor :: FormatM a -> FormatM a

Source#

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

valuewithSuccessColor :: FormatM a -> FormatM a

Source#

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

valuewithPendingColor :: FormatM a -> FormatM a

Source#

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

valuewithFailColor :: FormatM a -> FormatM a

Source#

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

valueoutputUnicode :: FormatM Bool

Source#

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

valueuseDiff :: FormatM Bool

Source#

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

valuediffContext :: FormatM (Maybe Int)

Source#

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

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

Source#

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

Source#

Deprecated. use prettyPrintFunction instead

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

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

Source#

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

valueextraChunk :: String -> FormatM ()

Source#

Output given chunk in red.

valuemissingChunk :: String -> FormatM ()

Source#

Output given chunk in green.

expert mode

valueunlessExpert :: FormatM () -> FormatM ()

Source#

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

Helpers

valueformatLocation :: Location -> String

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

Example1 expression

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

For IOExceptions the IOErrorType is included, as well.