| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Test.HUnitPlus.Reporting
Description
Reporting functionality for HUnit-Plus. Test reporting is now
defined using a set of events. A Reporter contains handlers for
these events, which have access to and update a Reporter-defined
state value. The handlers in a Reporter are called at
appropriate points during text execution.
This module also contains a basic defaultReporter that simply
passes the state value through unchanged. It also defines
combinedReporter, which facilitates "gluing" two Reporters
together.
- data Node = Label Text
- data State = State {}
- data Counts = Counts {}
- data Reporter us = Reporter {
- reporterStart :: IO us
- reporterEnd :: Double -> Counts -> us -> IO us
- reporterStartSuite :: State -> us -> IO us
- reporterEndSuite :: Double -> State -> us -> IO us
- reporterStartCase :: State -> us -> IO us
- reporterCaseProgress :: Text -> State -> us -> IO us
- reporterEndCase :: Double -> State -> us -> IO us
- reporterSkipCase :: State -> us -> IO us
- reporterSystemOut :: Text -> State -> us -> IO us
- reporterSystemErr :: Text -> State -> us -> IO us
- reporterFailure :: Text -> State -> us -> IO us
- reporterError :: Text -> State -> us -> IO us
- type Path = [Node]
- zeroCounts :: Counts
- showPath :: Path -> Text
- showQualName :: State -> Text
- defaultReporter :: Reporter a
- combinedReporter :: Reporter us1 -> Reporter us2 -> Reporter (us1, us2)
Documentation
Composed into Paths.
Keeps track of the remaining tests and the results of the performed tests. As each test is performed, the path is removed and the counts are updated as appropriate.
Constructors
| State | |
Fields
| |
A record that holds the results of tests that have been performed up until this point.
Constructors
| Counts | |
Fields
| |
Report generator. This record type contains a number of functions that are called at various points throughout a test run.
Constructors
| Reporter | |
Fields
| |
Uniquely describes the location of a test within a test hierarchy. Node order is from test case to root.
zeroCounts :: Counts Source #
A Counts with all zero counts.
showPath :: Path -> Text Source #
Converts a test case path to a string, separating adjacent elements by
a dot ('.'). An element of the path is quoted (as with show) when
there is potential ambiguity.
showQualName :: State -> Text Source #
Gewerate a string showing the entire qualified name from the reporting state.
defaultReporter :: Reporter a Source #
A reporter containing default actions, which are to do nothing and return the user state unmodified.