Test.Tasty.Ingredients.ConsoleReporter · tasty-1.5.3

valueconsoleTestReporter :: Ingredient

A simple console UI.

valueconsoleTestReporterWithHook

:: [TestName] -> Result -> IO Result
-> Ingredient

A simple console UI with a hook to postprocess results, depending on their names and external conditions (e. g., its previous outcome, stored in a file). Names are listed in reverse order: from test's own name to a name of the outermost test group.

newtypenewtype Quiet

#

Do not print test results (see README for details).

Constructors

Quiet Bool

Instances3Eq, Ord, IsOption

Eq QuietDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Ord QuietDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
IsOption QuietDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

newtypenewtype HideSuccesses

#

Report only failed tests.

At the moment, this option only works globally. As an argument to localOption, it does nothing.

Constructors

HideSuccesses Bool

Instances3Eq, Ord, IsOption

Eq HideSuccessesDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Ord HideSuccessesDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
IsOption HideSuccessesDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

newtypenewtype MinDurationToReport

#

The minimum amount of time a test can take before tasty prints timing information.

Constructors

MinDurationToReport
- minDurationMicros :: Integer

Instances3Eq, Ord, IsOption

Eq MinDurationToReportDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Ord MinDurationToReportDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
IsOption MinDurationToReportDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

newtypenewtype AnsiTricks

#

By default, when the option --hide-successes is given and the output goes to an ANSI-capable terminal, we employ some ANSI terminal tricks to display the name of the currently running test and then erase it if it succeeds.

These tricks sometimes fail, however—in particular, when the test names happen to be longer than the width of the terminal window. See

When that happens, this option can be used to disable the tricks. In that case, the test name will be printed only once the test fails.

Constructors

AnsiTricks
- getAnsiTricks :: Bool

Instances1IsOption

IsOption AnsiTricksDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

Internals

0 declarations

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

Output colouring

datadata UseColor

#

When to use color on the output

Constructors

Never
Always
Auto
Only if stdout is an ANSI color supporting terminal

Instances3Eq, Ord, IsOption

Eq UseColorDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Ord UseColorDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
IsOption UseColorDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Control color output

valueuseColor :: UseColor -> Bool -> Bool

#

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

Test failure statistics

datadata Statistics

#

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

Constructors

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

Instances2Semigroup, Monoid

Semigroup StatisticsDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Monoid StatisticsDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

valuecomputeStatistics :: StatusMap -> IO Statistics

#

computeStatistics computes a summary Statistics for a given state of the StatusMap. Useful in combination with printStatistics.

valueprintStatistics :: IP "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.

valueprintStatisticsNoTime :: IP "colors" Bool => Statistics -> IO ()

#

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

Outputting results

datadata TestOutput

#

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

Constructors

PrintTest String (IO ()) (Progress -> IO ()) (Result -> IO ())
Printing a test.
PrintHeading String (IO ()) TestOutput
Printing a test group.
Skip
Inactive test (e.g. not matching the current pattern).
Seq TestOutput TestOutput
Two sets of TestOutput on the same level.

Instances2Semigroup, Monoid

Semigroup TestOutputDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter
Monoid TestOutputDefined in tasty-1.5.3 · Test.Tasty.Ingredients.ConsoleReporter

valuebuildTestOutput :: IP "colors" Bool => OptionSet -> TestTree -> TestOutput

#

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

valuefoldTestOutput

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

valuewithConsoleFormat :: IP "colors" Bool => ConsoleFormatPrinter

#

Run action with console configured for a specific output format

This function does not apply any output formats if colors are disabled at command line or console detection.

Can be used by providers that wish to provider specific result details printing, while re-using the tasty formats and coloring logic.