Safe Haskell	Safe
Language	Haskell2010

Test.Framework.TestInterface

Description

This module defines the API for HTF plugins.

Synopsis

type Assertion = IO ()
data TestResult
- = Pass
- | Pending
- | Fail
- | Error
data FullTestResult = FullTestResult {
- ftr_location :: Maybe Location
- ftr_callingLocations :: [(Maybe String, Location)]
- ftr_message :: Maybe ColorString
- ftr_result :: Maybe TestResult
}
data HTFFailureException = HTFFailure FullTestResult
failHTF :: MonadBaseControl IO m => FullTestResult -> m a
subAssertHTF :: MonadBaseControl IO m => Location -> Maybe String -> m a -> m a
mkFullTestResult :: TestResult -> Maybe String -> FullTestResult

Documentation

type Assertion = IO () Source #

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 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] #

data FullTestResult Source #

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 Source #
Instance details Defined in Test.Framework.TestInterface Methods (==) :: FullTestResult -> FullTestResult -> Bool # (/=) :: FullTestResult -> FullTestResult -> Bool #
Read FullTestResult Source #
Instance details Defined in Test.Framework.TestInterface Methods readsPrec :: Int -> ReadS FullTestResult # readList :: ReadS [FullTestResult] # readPrec :: ReadPrec FullTestResult # readListPrec :: ReadPrec [FullTestResult] #
Show FullTestResult Source #
Instance details Defined in Test.Framework.TestInterface Methods showsPrec :: Int -> FullTestResult -> ShowS # show :: FullTestResult -> String # showList :: [FullTestResult] -> ShowS #

data HTFFailureException Source #

Constructors

HTFFailure FullTestResult

Instances

Show HTFFailureException Source #
Instance details Defined in Test.Framework.TestInterface Methods showsPrec :: Int -> HTFFailureException -> ShowS # show :: HTFFailureException -> String # showList :: [HTFFailureException] -> ShowS #
Exception HTFFailureException Source #
Instance details Defined in Test.Framework.TestInterface Methods toException :: HTFFailureException -> SomeException # fromException :: SomeException -> Maybe HTFFailureException # displayException :: HTFFailureException -> String #

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

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 Source #

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

mkFullTestResult :: TestResult -> Maybe String -> FullTestResult Source #

Auxiliary function for contructing a FullTestResult.