Test.Tasty.Ingredients.ConsoleReporter

Console reporter ingredient

Documentation

consoleTestReporter :: Ingredient

A simple console UI

newtype Quiet

Do not print test results (see README for details)

Constructors

Quiet Bool

Instances

Eq Quiet

Methods

(==) :: Quiet -> Quiet -> Bool

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

Ord Quiet

Methods

compare :: Quiet -> Quiet -> Ordering

(<) :: Quiet -> Quiet -> Bool

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

(>) :: Quiet -> Quiet -> Bool

(>=) :: Quiet -> Quiet -> Bool

max :: Quiet -> Quiet -> Quiet

min :: Quiet -> Quiet -> Quiet

IsOption Quiet

Methods

defaultValue :: Quiet

parseValue :: String -> Maybe Quiet

optionName :: Tagged * Quiet String

optionHelp :: Tagged * Quiet String

optionCLParser :: Parser Quiet

newtype HideSuccesses

Report only failed tests

Constructors

HideSuccesses Bool

Instances

Eq HideSuccesses

Methods

(==) :: HideSuccesses -> HideSuccesses -> Bool

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

Ord HideSuccesses

Methods

compare :: HideSuccesses -> HideSuccesses -> Ordering

(<) :: HideSuccesses -> HideSuccesses -> Bool

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

(>) :: HideSuccesses -> HideSuccesses -> Bool

(>=) :: HideSuccesses -> HideSuccesses -> Bool

max :: HideSuccesses -> HideSuccesses -> HideSuccesses

min :: HideSuccesses -> HideSuccesses -> HideSuccesses

IsOption HideSuccesses

Methods

defaultValue :: HideSuccesses

parseValue :: String -> Maybe HideSuccesses

optionName :: Tagged * HideSuccesses String

optionHelp :: Tagged * HideSuccesses String

optionCLParser :: Parser HideSuccesses

Internals

The following functions and datatypes are internals that are exposed to simplify the task of rolling your own custom console reporter UI.

Output colouring

data UseColor

When to use color on the output

Since: 0.11.3

Constructors

Never

Always

Auto

Only if stdout is an ANSI color supporting terminal

Instances

Eq UseColor

Methods

(==) :: UseColor -> UseColor -> Bool

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

Ord UseColor

Methods

compare :: UseColor -> UseColor -> Ordering

(<) :: UseColor -> UseColor -> Bool

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

(>) :: UseColor -> UseColor -> Bool

(>=) :: UseColor -> UseColor -> Bool

max :: UseColor -> UseColor -> UseColor

min :: UseColor -> UseColor -> UseColor

IsOption UseColor

Control color output

Methods

defaultValue :: UseColor

parseValue :: String -> Maybe UseColor

optionName :: Tagged * UseColor String

optionHelp :: Tagged * UseColor String

optionCLParser :: Parser UseColor

useColor :: UseColor -> Bool -> Bool

useColor when isTerm decides if colors should be used, where isTerm indicates whether stdout is a terminal device.

Since: 0.11.3

Test failure statistics

data Statistics

Track the number of tests that were run and failures of a TestTree or sub-tree.

Since: 0.11.3

Constructors

Statistics

Fields

• statTotal :: !Int

  Number of active tests (e.g., that match the pattern specified on the commandline), inactive tests are not counted.

• statFailures :: !Int

  Number of active tests that failed.

Instances

Semigroup Statistics

Methods

(<>) :: Statistics -> Statistics -> Statistics

sconcat :: NonEmpty Statistics -> Statistics

stimes :: Integral b => b -> Statistics -> Statistics

Monoid Statistics

Methods

mempty :: Statistics

mappend :: Statistics -> Statistics -> Statistics

mconcat :: [Statistics] -> Statistics

printStatistics :: (?colors :: Bool) => Statistics -> Time -> IO ()

printStatistics reports test success/failure statistics and time it took to run. The Time results is intended to be filled in by the TestReporter callback. The colors ImplicitParam controls whether coloured output is used.

Since: 0.11.3

printStatisticsNoTime :: (?colors :: Bool) => Statistics -> IO ()

printStatisticsNoTime reports test success/failure statistics The colors ImplicitParam controls whether coloured output is used.

Since: 0.12

Outputting results

data TestOutput

TestOutput is an intermediary between output formatting and output printing. It lets us have several different printing modes (normal; print failures only; quiet).

Since: 0.12

Constructors

PrintTest String (IO ()) (Result -> IO ())

Name of a test, an action that prints the test name, and an action that renders the result of the action.

PrintHeading String (IO ()) TestOutput

Name of a test group, an action that prints the heading of a test group and the TestOutput for that test group.

Skip

Inactive test (e.g. not matching the current pattern)

Seq TestOutput TestOutput

Two sets of TestOuput on the same level

Instances

Semigroup TestOutput

Methods

(<>) :: TestOutput -> TestOutput -> TestOutput

sconcat :: NonEmpty TestOutput -> TestOutput

stimes :: Integral b => b -> TestOutput -> TestOutput

Monoid TestOutput

Methods

mempty :: TestOutput

mappend :: TestOutput -> TestOutput -> TestOutput

mconcat :: [TestOutput] -> TestOutput

buildTestOutput :: (?colors :: Bool) => OptionSet -> TestTree -> TestOutput

Build the TestOutput for a TestTree and OptionSet. The colors ImplicitParam controls whether the output is colored.

Since: 0.11.3

foldTestOutput

Arguments

:: Monoid b

=> (String -> IO () -> IO Result -> (Result -> IO ()) -> b)

Eliminator for test cases. The IO () prints the testname. The IO Result blocks until the test is finished, returning it's Result. The Result -> IO () function prints the formatted output.

-> (String -> IO () -> b -> b)

Eliminator for test groups. The IO () prints the test group's name. The b is the result of folding the test group.

-> TestOutput

The TestOutput being rendered.

-> StatusMap

The StatusMap received by the TestReporter

-> b

Fold function for the TestOutput tree into a Monoid.

Since: 0.12