Test.Framework.TestInterface

This module defines the API for HTF plugins.

Documentation

type Assertion = IO ()

An assertion is just an IO action. Internally, the body of any test in HTF is of type Assertion. If a test specification of a certain plugin has a type different from Assertion, the plugin's preprocessor pass must inject wrapper code to convert the test specification into an assertion.

Assertions may use failHTF to signal a TestResult different from Pass. If the assertion finishes successfully, the tests passes implicitly.

Please note: the assertion must not swallow any exceptions! Otherwise, timeouts and other things might not work as expected.

data TestResult

The summary result of a test.

Constructors

Pass

Pending

Fail

Error

Instances

Eq TestResult

Defined in Test.Framework.TestInterface

Methods

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

(/=) :: TestResult -> 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

ToJSON TestResult

Defined in Test.Framework.History

Methods

toJSON :: TestResult -> Value

toEncoding :: TestResult -> Encoding

toJSONList :: [TestResult] -> Value

toEncodingList :: [TestResult] -> Encoding

FromJSON TestResult

Defined in Test.Framework.History

Methods

parseJSON :: Value -> Parser TestResult

parseJSONList :: Value -> Parser [TestResult]

data FullTestResult

The full result of a test, as used by HTF plugins.

Constructors

FullTestResult

Fields

• ftr_location :: Maybe Location

  The location of a possible failure

• ftr_callingLocations :: [(Maybe String, Location)]

  The "stack" to the location of a possible failure

• ftr_message :: Maybe ColorString

  An error message

• ftr_result :: Maybe TestResult

  The outcome of the test, Nothing means timeout

Instances

Eq FullTestResult

Defined in Test.Framework.TestInterface

Methods

(==) :: FullTestResult -> FullTestResult -> Bool

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

Read FullTestResult

Defined in Test.Framework.TestInterface

Methods

readsPrec :: Int -> ReadS FullTestResult

readList :: ReadS [FullTestResult]

readPrec :: ReadPrec FullTestResult

readListPrec :: ReadPrec [FullTestResult]

Show FullTestResult

Defined in Test.Framework.TestInterface

Methods

showsPrec :: Int -> FullTestResult -> ShowS

show :: FullTestResult -> String

showList :: [FullTestResult] -> ShowS

data HTFFailureException

Constructors

HTFFailure FullTestResult

Instances

Show HTFFailureException

Defined in Test.Framework.TestInterface

Methods

showsPrec :: Int -> HTFFailureException -> ShowS

show :: HTFFailureException -> String

showList :: [HTFFailureException] -> ShowS

Exception HTFFailureException

Defined in Test.Framework.TestInterface

Methods

toException :: HTFFailureException -> SomeException

fromException :: SomeException -> Maybe HTFFailureException

displayException :: HTFFailureException -> String

failHTF :: MonadBaseControl IO m => FullTestResult -> m a

Terminate a HTF test, usually to signal a failure. The result of the test is given in the FullTestResult argument.

subAssertHTF :: MonadBaseControl IO m => Location -> Maybe String -> m a -> m a

Opens a new assertion stack frame to allow for sensible location information.

mkFullTestResult :: TestResult -> Maybe String -> FullTestResult

Auxiliary function for contructing a FullTestResult.