Safe Haskell	None
Language	Haskell2010

Test.Framework.TestTypes

Contents

Organizing tests
Executing tests
Reporting results
Specifying results.

Description

This module defines types (and small auxiliary functions) for organizing tests, for configuring the execution of tests, and for representing and reporting their results.

Synopsis

type TestID = String
data Test
- = BaseTest TestSort TestID (Maybe Location) TestOptions Assertion
- | CompoundTest TestSuite
data TestOptions = TestOptions {
- to_parallel :: Bool
}
class AssertionWithTestOptions a where
- testOptions :: a -> TestOptions
- assertion :: a -> Assertion
data WithTestOptions a = WithTestOptions {
- wto_options :: TestOptions
- wto_payload :: a
}
data TestSuite
- = TestSuite TestID [Test]
- | AnonTestSuite [Test]
data TestSort
- = UnitTest
- | QuickCheckTest
- | BlackBoxTest
data TestPath
- = TestPathBase TestID
- | TestPathCompound (Maybe TestID) TestPath
data GenFlatTest a = FlatTest {
- ft_sort :: TestSort
- ft_path :: TestPath
- ft_location :: Maybe Location
- ft_payload :: a
}
type FlatTest = GenFlatTest (WithTestOptions Assertion)
type TestFilter = FlatTest -> Bool
testPathToList :: TestPath -> [Maybe TestID]
flatName :: TestPath -> String
finalName :: TestPath -> String
prefixName :: TestPath -> String
defaultTestOptions :: TestOptions
withOptions :: (TestOptions -> TestOptions) -> a -> WithTestOptions a
historyKey :: GenFlatTest a -> Text
type TR = RWST TestConfig () TestState IO
data TestState = TestState {
- ts_results :: [FlatTestResult]
- ts_index :: Int
}
initTestState :: TestState
data TestConfig = TestConfig {
- tc_quiet :: Bool
- tc_threads :: Maybe Int
- tc_shuffle :: Bool
- tc_output :: TestOutput
- tc_outputXml :: Maybe FilePath
- tc_filter :: TestFilter
- tc_reporters :: [TestReporter]
- tc_useColors :: Bool
- tc_historyFile :: FilePath
- tc_history :: TestHistory
- tc_sortByPrevTime :: Bool
- tc_failFast :: Bool
- tc_timeoutIsSuccess :: Bool
- tc_maxSingleTestTime :: Maybe Milliseconds
- tc_prevFactor :: Maybe Double
- tc_repeat :: Int
}
data TestOutput
- = TestOutputHandle Handle Bool
- | TestOutputSplitted FilePath
type ReportAllTests = [FlatTest] -> TR ()
type ReportGlobalStart = [FlatTest] -> TR ()
type ReportTestStart = FlatTest -> TR ()
type ReportTestResult = FlatTestResult -> TR ()
type ReportGlobalResults = ReportGlobalResultsArg -> TR ()
data ReportGlobalResultsArg = ReportGlobalResultsArg {
- rgra_timeMs :: Milliseconds
- rgra_passed :: [FlatTestResult]
- rgra_pending :: [FlatTestResult]
- rgra_failed :: [FlatTestResult]
- rgra_errors :: [FlatTestResult]
- rgra_timedOut :: [FlatTestResult]
- rgra_filtered :: [FlatTest]
}
data TestReporter = TestReporter {
- tr_id :: String
- tr_reportAllTests :: ReportAllTests
- tr_reportGlobalStart :: ReportGlobalStart
- tr_reportTestStart :: ReportTestStart
- tr_reportTestResult :: ReportTestResult
- tr_reportGlobalResults :: ReportGlobalResults
}
emptyTestReporter :: String -> TestReporter
attachCallStack :: ColorString -> CallStack -> ColorString
type CallStack = [(Maybe String, Location)]
data TestResult
- = Pass
- | Pending
- | Fail
- | Error
type FlatTestResult = GenFlatTest RunResult
type Milliseconds = Int
data RunResult = RunResult {
- rr_result :: TestResult
- rr_location :: Maybe Location
- rr_callers :: CallStack
- rr_message :: ColorString
- rr_wallTimeMs :: Milliseconds
- rr_timeout :: Bool
}

Organizing tests

type TestID = String Source #

Type for naming tests.

data Test Source #

Abstract type for tests and their results.

Constructors

BaseTest TestSort TestID (Maybe Location) TestOptions Assertion
CompoundTest TestSuite

Instances

TestableHTF Test Source #
Instance details Defined in Test.Framework.TestManager Methods flatten :: Test -> [FlatTest]
WrappableHTF Test Source #
Instance details Defined in Test.Framework.TestManager Methods wrap :: (Assertion -> Assertion) -> Test -> Test Source #

data TestOptions Source #

General options for tests

Constructors

TestOptions
Fields to_parallel :: Bool

Instances

Eq TestOptions Source #
Instance details Defined in Test.Framework.TestTypes Methods (==) :: TestOptions -> TestOptions -> Bool # (/=) :: TestOptions -> TestOptions -> Bool #
Read TestOptions Source #
Instance details Defined in Test.Framework.TestTypes Methods readsPrec :: Int -> ReadS TestOptions # readList :: ReadS [TestOptions] # readPrec :: ReadPrec TestOptions # readListPrec :: ReadPrec [TestOptions] #
Show TestOptions Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestOptions -> ShowS # show :: TestOptions -> String # showList :: [TestOptions] -> ShowS #

class AssertionWithTestOptions a where Source #

A type class for an assertion with TestOptions.

Methods

testOptions :: a -> TestOptions Source #

assertion :: a -> Assertion Source #

Instances

AssertionWithTestOptions (IO a) Source #
Instance details Defined in Test.Framework.TestTypes Methods testOptions :: IO a -> TestOptions Source # assertion :: IO a -> Assertion Source #
AssertionWithTestOptions (WithTestOptions (IO a)) Source #
Instance details Defined in Test.Framework.TestTypes Methods testOptions :: WithTestOptions (IO a) -> TestOptions Source # assertion :: WithTestOptions (IO a) -> Assertion Source #

data WithTestOptions a Source #

Something with TestOptions

Constructors

WithTestOptions
Fields wto_options :: TestOptions wto_payload :: a

Instances

Eq a => Eq (WithTestOptions a) Source #
Instance details Defined in Test.Framework.TestTypes Methods (==) :: WithTestOptions a -> WithTestOptions a -> Bool # (/=) :: WithTestOptions a -> WithTestOptions a -> Bool #
Read a => Read (WithTestOptions a) Source #
Instance details Defined in Test.Framework.TestTypes Methods readsPrec :: Int -> ReadS (WithTestOptions a) # readList :: ReadS [WithTestOptions a] # readPrec :: ReadPrec (WithTestOptions a) # readListPrec :: ReadPrec [WithTestOptions a] #
Show a => Show (WithTestOptions a) Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> WithTestOptions a -> ShowS # show :: WithTestOptions a -> String # showList :: [WithTestOptions a] -> ShowS #
AssertionWithTestOptions (WithTestOptions (IO a)) Source #
Instance details Defined in Test.Framework.TestTypes Methods testOptions :: WithTestOptions (IO a) -> TestOptions Source # assertion :: WithTestOptions (IO a) -> Assertion Source #

data TestSuite Source #

Abstract type for test suites and their results.

Constructors

TestSuite TestID [Test]
AnonTestSuite [Test]

Instances

TestableHTF TestSuite Source #
Instance details Defined in Test.Framework.TestManager Methods flatten :: TestSuite -> [FlatTest]
WrappableHTF TestSuite Source #
Instance details Defined in Test.Framework.TestManager Methods wrap :: (Assertion -> Assertion) -> TestSuite -> TestSuite Source #

data TestSort Source #

Type for distinguishing different sorts of tests.

Constructors

UnitTest
QuickCheckTest
BlackBoxTest

Instances

Eq TestSort Source #
Instance details Defined in Test.Framework.TestTypes Methods (==) :: TestSort -> TestSort -> Bool # (/=) :: TestSort -> TestSort -> Bool #
Read TestSort Source #
Instance details Defined in Test.Framework.TestTypes Methods readsPrec :: Int -> ReadS TestSort # readList :: ReadS [TestSort] # readPrec :: ReadPrec TestSort # readListPrec :: ReadPrec [TestSort] #
Show TestSort Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestSort -> ShowS # show :: TestSort -> String # showList :: [TestSort] -> ShowS #
ToJSON TestSort Source #
Instance details Defined in Test.Framework.JsonOutput Methods toJSON :: TestSort -> Value # toEncoding :: TestSort -> Encoding # toJSONList :: [TestSort] -> Value # toEncodingList :: [TestSort] -> Encoding #

data TestPath Source #

A type denoting the hierarchical name of a test.

Constructors

TestPathBase TestID
TestPathCompound (Maybe TestID) TestPath

Instances

Show TestPath Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestPath -> ShowS # show :: TestPath -> String # showList :: [TestPath] -> ShowS #
ToJSON TestPath Source #
Instance details Defined in Test.Framework.JsonOutput Methods toJSON :: TestPath -> Value # toEncoding :: TestPath -> Encoding # toJSONList :: [TestPath] -> Value # toEncodingList :: [TestPath] -> Encoding #

data GenFlatTest a Source #

Generic type for flattened tests and their results.

Constructors

FlatTest
Fields ft_sort :: TestSort The sort of the test. ft_path :: TestPath Hierarchival path. ft_location :: Maybe Location Place of definition. ft_payload :: a A generic payload.

type FlatTest = GenFlatTest (WithTestOptions Assertion) Source #

Flattened representation of tests.

type TestFilter = FlatTest -> Bool Source #

A filter is a predicate on GenFlatTest. If the predicate is True, the flat test is run.

testPathToList :: TestPath -> [Maybe TestID] Source #

Splits a TestPath into a list of test identifiers.

flatName :: TestPath -> String Source #

Creates a string representation from a TestPath.

finalName :: TestPath -> String Source #

Returns the final name of a TestPath

prefixName :: TestPath -> String Source #

Returns the name of the prefix of a test path. The prefix is everything except the last element.

defaultTestOptions :: TestOptions Source #

The default TestOptions

withOptions :: (TestOptions -> TestOptions) -> a -> WithTestOptions a Source #

Shortcut for constructing a WithTestOptions value.

historyKey :: GenFlatTest a -> Text Source #

Key of a flat test for the history database.

Executing tests

type TR = RWST TestConfig () TestState IO Source #

The TR (test runner) monad.

data TestState Source #

The state type for the TR monad.

Constructors

TestState
Fields ts_results :: [FlatTestResult] Results collected so far. ts_index :: Int Current index for splitted output.

initTestState :: TestState Source #

The initial test state.

data TestConfig Source #

Configuration of test execution.

Constructors

TestConfig

Fields

tc_quiet :: Bool
If set, displays messages only for failed tests.
tc_threads :: Maybe Int
Use Just i for parallel execution with i threads, Nothing for sequential execution.
tc_shuffle :: Bool
Shuffle tests before parallel execution
tc_output :: TestOutput
Output destination of progress and result messages.
tc_outputXml :: Maybe FilePath
Output destination of XML result summary
tc_filter :: TestFilter
Filter for the tests to run.
tc_reporters :: [TestReporter]
Test reporters to use.
tc_useColors :: Bool
Whether to use colored output
tc_historyFile :: FilePath
Path to history file
tc_history :: TestHistory
History of previous test runs
tc_sortByPrevTime :: Bool
Sort ascending by previous execution times
tc_failFast :: Bool
Stop test run as soon as one test fails
tc_timeoutIsSuccess :: Bool
Do not regard timeout as an error
tc_maxSingleTestTime :: Maybe Milliseconds
Maximum time in milliseconds a single test is allowed to run
tc_prevFactor :: Maybe Double
Maximum factor a single test is allowed to run slower than its previous execution
tc_repeat :: Int
Number of times to repeat tests selected on the command line before reporting them as a success.

Instances

Show TestConfig Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestConfig -> ShowS # show :: TestConfig -> String # showList :: [TestConfig] -> ShowS #

data TestOutput Source #

The destination of progress and result messages from HTF.

Constructors

TestOutputHandle Handle Bool	Output goes to `Handle`, boolean flag indicates whether the handle should be closed at the end.
TestOutputSplitted FilePath	Output goes to files whose names are derived from `FilePath` by appending a number to it. Numbering starts at zero.

Instances

Eq TestOutput Source #
Instance details Defined in Test.Framework.TestTypes Methods (==) :: TestOutput -> TestOutput -> Bool # (/=) :: TestOutput -> TestOutput -> Bool #
Show TestOutput Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestOutput -> ShowS # show :: TestOutput -> String # showList :: [TestOutput] -> ShowS #

Reporting results

type ReportAllTests = [FlatTest] -> TR () Source #

Reports the IDs of all tests available.

type ReportGlobalStart = [FlatTest] -> TR () Source #

Signals that test execution is about to start.

type ReportTestStart = FlatTest -> TR () Source #

Reports the start of a single test.

type ReportTestResult = FlatTestResult -> TR () Source #

Reports the result of a single test.

type ReportGlobalResults = ReportGlobalResultsArg -> TR () Source #

Reports the overall results of all tests.

data ReportGlobalResultsArg Source #

Constructors

ReportGlobalResultsArg
Fields rgra_timeMs :: Milliseconds rgra_passed :: [FlatTestResult] rgra_pending :: [FlatTestResult] rgra_failed :: [FlatTestResult] rgra_errors :: [FlatTestResult] rgra_timedOut :: [FlatTestResult] rgra_filtered :: [FlatTest]

data TestReporter Source #

A TestReporter provides hooks to customize the output of HTF.

Constructors

TestReporter

Fields

tr_id :: String
tr_reportAllTests :: ReportAllTests
Called to report the IDs of all tests available.
tr_reportGlobalStart :: ReportGlobalStart
Called to report the start of test execution.
tr_reportTestStart :: ReportTestStart
Called to report the start of a single test.
tr_reportTestResult :: ReportTestResult
Called to report the result of a single test.
tr_reportGlobalResults :: ReportGlobalResults
Called to report the overall results of all tests.

Instances

Eq TestReporter Source #
Instance details Defined in Test.Framework.TestTypes Methods (==) :: TestReporter -> TestReporter -> Bool # (/=) :: TestReporter -> TestReporter -> Bool #
Show TestReporter Source #
Instance details Defined in Test.Framework.TestTypes Methods showsPrec :: Int -> TestReporter -> ShowS # show :: TestReporter -> String # showList :: [TestReporter] -> ShowS #

emptyTestReporter :: String -> TestReporter Source #

attachCallStack :: ColorString -> CallStack -> ColorString Source #

type CallStack = [(Maybe String, Location)] Source #

A type for call-stacks

Specifying results.

data TestResult Source #

The summary result of a test.

Constructors

Pass
Pending
Fail
Error

Instances

Eq TestResult Source #
Instance details Defined in Test.Framework.TestInterface Methods (==) :: TestResult -> TestResult -> Bool # (/=) :: TestResult -> TestResult -> Bool #
Read TestResult Source #
Instance details Defined in Test.Framework.TestInterface Methods readsPrec :: Int -> ReadS TestResult # readList :: ReadS [TestResult] # readPrec :: ReadPrec TestResult # readListPrec :: ReadPrec [TestResult] #
Show TestResult Source #
Instance details Defined in Test.Framework.TestInterface Methods showsPrec :: Int -> TestResult -> ShowS # show :: TestResult -> String # showList :: [TestResult] -> ShowS #
ToJSON TestResult Source #
Instance details Defined in Test.Framework.History Methods toJSON :: TestResult -> Value # toEncoding :: TestResult -> Encoding # toJSONList :: [TestResult] -> Value # toEncodingList :: [TestResult] -> Encoding #
FromJSON TestResult Source #
Instance details Defined in Test.Framework.History Methods parseJSON :: Value -> Parser TestResult # parseJSONList :: Value -> Parser [TestResult] #

type FlatTestResult = GenFlatTest RunResult Source #

The result of running a GenFlatTest

type Milliseconds = Int Source #

A type synonym for time in milliseconds.

data RunResult Source #

The result of a test run.

Constructors

RunResult

Fields

rr_result :: TestResult
The summary result of the test.
rr_location :: Maybe Location
The location where the test failed (if applicable).
rr_callers :: CallStack
Information about the callers of the location where the test failed
rr_message :: ColorString
A message describing the result.
rr_wallTimeMs :: Milliseconds
Execution time in milliseconds.
rr_timeout :: Bool
True if the execution took too long