Test.Framework.TestTypes

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

This functionality is mainly used internally in the code generated by the hftpp pre-processor.

Organizing tests

type TestID = String

Type for naming tests.

data Test

Abstract type for tests and their results.

Constructors

BaseTest TestSort TestID (Maybe Location) TestOptions Assertion

CompoundTest TestSuite

Instances

TestableHTF Test

Defined in Test.Framework.TestManager

Methods

flatten :: Test -> [FlatTest]

WrappableHTF Test

Defined in Test.Framework.TestManager

Methods

wrap :: (Assertion -> Assertion) -> Test -> Test

data TestOptions

General options for tests

Constructors

TestOptions

Fields

• to_parallel :: Bool

Instances

Read TestOptions

Defined in Test.Framework.TestTypes

Methods

readsPrec :: Int -> ReadS TestOptions

readList :: ReadS [TestOptions]

readPrec :: ReadPrec TestOptions

readListPrec :: ReadPrec [TestOptions]

Show TestOptions

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestOptions -> ShowS

show :: TestOptions -> String

showList :: [TestOptions] -> ShowS

Eq TestOptions

Defined in Test.Framework.TestTypes

Methods

(==) :: TestOptions -> TestOptions -> Bool

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

class AssertionWithTestOptions a where

A type class for an assertion with TestOptions.

Methods

testOptions :: a -> TestOptions

assertion :: a -> Assertion

Instances

AssertionWithTestOptions (WithTestOptions (IO a))

Defined in Test.Framework.TestTypes

Methods

testOptions :: WithTestOptions (IO a) -> TestOptions

assertion :: WithTestOptions (IO a) -> Assertion

AssertionWithTestOptions (IO a)

Defined in Test.Framework.TestTypes

Methods

testOptions :: IO a -> TestOptions

assertion :: IO a -> Assertion

data WithTestOptions a

Something with TestOptions

Constructors

WithTestOptions

Fields

• wto_options :: TestOptions
• wto_payload :: a

Instances

AssertionWithTestOptions (WithTestOptions (IO a))

Defined in Test.Framework.TestTypes

Methods

testOptions :: WithTestOptions (IO a) -> TestOptions

assertion :: WithTestOptions (IO a) -> Assertion

Read a => Read (WithTestOptions a)

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)

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> WithTestOptions a -> ShowS

show :: WithTestOptions a -> String

showList :: [WithTestOptions a] -> ShowS

Eq a => Eq (WithTestOptions a)

Defined in Test.Framework.TestTypes

Methods

(==) :: WithTestOptions a -> WithTestOptions a -> Bool

(/=) :: WithTestOptions a -> WithTestOptions a -> Bool

data TestSuite

Abstract type for test suites and their results.

Constructors

TestSuite TestID [Test]

AnonTestSuite [Test]

Instances

TestableHTF TestSuite

Defined in Test.Framework.TestManager

Methods

flatten :: TestSuite -> [FlatTest]

WrappableHTF TestSuite

Defined in Test.Framework.TestManager

Methods

wrap :: (Assertion -> Assertion) -> TestSuite -> TestSuite

data TestSort

Type for distinguishing different sorts of tests.

Constructors

UnitTest

QuickCheckTest

BlackBoxTest

Instances

ToJSON TestSort

Defined in Test.Framework.JsonOutput

Methods

toJSON :: TestSort -> Value

toEncoding :: TestSort -> Encoding

toJSONList :: [TestSort] -> Value

toEncodingList :: [TestSort] -> Encoding

omitField :: TestSort -> Bool

Read TestSort

Defined in Test.Framework.TestTypes

Methods

readsPrec :: Int -> ReadS TestSort

readList :: ReadS [TestSort]

readPrec :: ReadPrec TestSort

readListPrec :: ReadPrec [TestSort]

Show TestSort

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestSort -> ShowS

show :: TestSort -> String

showList :: [TestSort] -> ShowS

Eq TestSort

Defined in Test.Framework.TestTypes

Methods

(==) :: TestSort -> TestSort -> Bool

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

data TestPath

A type denoting the hierarchical name of a test.

Constructors

TestPathBase TestID

TestPathCompound (Maybe TestID) TestPath

Instances

ToJSON TestPath

Defined in Test.Framework.JsonOutput

Methods

toJSON :: TestPath -> Value

toEncoding :: TestPath -> Encoding

toJSONList :: [TestPath] -> Value

toEncodingList :: [TestPath] -> Encoding

omitField :: TestPath -> Bool

Show TestPath

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestPath -> ShowS

show :: TestPath -> String

showList :: [TestPath] -> ShowS

data GenFlatTest a

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)

Flattened representation of tests.

type TestFilter = FlatTest -> Bool

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

testPathToList :: TestPath -> [Maybe TestID]

Splits a TestPath into a list of test identifiers.

flatName :: TestPath -> String

Creates a string representation from a TestPath.

finalName :: TestPath -> String

Returns the final name of a TestPath

prefixName :: TestPath -> String

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

defaultTestOptions :: TestOptions

The default TestOptions

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

Shortcut for constructing a WithTestOptions value.

historyKey :: GenFlatTest a -> Text

Key of a flat test for the history database.

Executing tests

type TR = RWST TestConfig () TestState IO

The TR (test runner) monad.

data TestState

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

The initial test state.

data TestConfig

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

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestConfig -> ShowS

show :: TestConfig -> String

showList :: [TestConfig] -> ShowS

data TestOutput

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

Show TestOutput

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestOutput -> ShowS

show :: TestOutput -> String

showList :: [TestOutput] -> ShowS

Eq TestOutput

Defined in Test.Framework.TestTypes

Methods

(==) :: TestOutput -> TestOutput -> Bool

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

Reporting results

type ReportAllTests = [FlatTest] -> TR ()

Reports the IDs of all tests available.

type ReportGlobalStart = [FlatTest] -> TR ()

Signals that test execution is about to start.

type ReportTestStart = FlatTest -> TR ()

Reports the start of a single test.

type ReportTestResult = FlatTestResult -> TR ()

Reports the result of a single test.

type ReportGlobalResults = ReportGlobalResultsArg -> TR ()

Reports the overall results of all tests.

data ReportGlobalResultsArg

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

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

Show TestReporter

Defined in Test.Framework.TestTypes

Methods

showsPrec :: Int -> TestReporter -> ShowS

show :: TestReporter -> String

showList :: [TestReporter] -> ShowS

Eq TestReporter

Defined in Test.Framework.TestTypes

Methods

(==) :: TestReporter -> TestReporter -> Bool

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

emptyTestReporter :: String -> TestReporter

attachCallStack :: ColorString -> HtfStack -> ColorString

type CallStack = [(Maybe String, Location)]

A type for call-stacks

Specifying results.

data TestResult

The summary result of a test.

Constructors

Pass

Pending

Fail

Error

Instances

FromJSON TestResult

Defined in Test.Framework.History

Methods

parseJSON :: Value -> Parser TestResult

parseJSONList :: Value -> Parser [TestResult]

omittedField :: Maybe TestResult

ToJSON TestResult

Defined in Test.Framework.History

Methods

toJSON :: TestResult -> Value

toEncoding :: TestResult -> Encoding

toJSONList :: [TestResult] -> Value

toEncodingList :: [TestResult] -> Encoding

omitField :: TestResult -> Bool

Read TestResult

Defined in Test.Framework.TestInterface

Methods

readsPrec :: Int -> ReadS TestResult

readList :: ReadS [TestResult]

readPrec :: ReadPrec TestResult

readListPrec :: ReadPrec [TestResult]

Show TestResult

Defined in Test.Framework.TestInterface

Methods

showsPrec :: Int -> TestResult -> ShowS

show :: TestResult -> String

showList :: [TestResult] -> ShowS

Eq TestResult

Defined in Test.Framework.TestInterface

Methods

(==) :: TestResult -> TestResult -> Bool

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

type FlatTestResult = GenFlatTest RunResult

The result of running a GenFlatTest

type Milliseconds = Int

A type synonym for time in milliseconds.

data RunResult

The result of a test run.

Constructors

RunResult

Fields

• rr_result :: TestResult

  The summary result of the test.

• rr_stack :: HtfStack

  The stack leading to the test failure

• 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