test-framework-0.2.4: Framework for running and organising tests, with HUnit and QuickCheck supportSource codeContentsIndex
Test.Framework
Description

A generic test framework for all types of Haskell test.

For an example of how to use test-framework, please see http://github.com/batterseapower/test-framework/raw/master/example/Test/Framework/Example.lhs

Synopsis
class (Show i, Show r) => TestResultlike i r | r -> i where
testSucceeded :: r -> Bool
class TestResultlike i r => Testlike i r t | t -> i r, r -> i where
runTest :: CompleteTestOptions -> t -> IO (i :~> r, IO ())
testTypeName :: t -> TestTypeName
type TestName = String
type TestTypeName = String
data Test
= forall i r t . Testlike i r t => Test TestName t
| TestGroup TestName [Test]
| PlusTestOptions TestOptions Test
testGroup :: TestName -> [Test] -> Test
plusTestOptions :: TestOptions -> Test -> Test
module Test.Framework.Options
module Test.Framework.Runners.Console
module Test.Framework.Runners.Options
module Test.Framework.Seed
Documentation
class (Show i, Show r) => TestResultlike i r | r -> i whereSource
Something like the result of a test: works in concert with Testlike. The type parameters are the type that is used for progress reports and the type of the final output of the test respectively.
Methods
testSucceeded :: r -> BoolSource
class TestResultlike i r => Testlike i r t | t -> i r, r -> i whereSource
Something test-like in its behaviour. The type parameters are the type that is used for progress reports, the type of the final output of the test and the data type encapsulating the whole potential to do a test respectively.
Methods
runTest :: CompleteTestOptions -> t -> IO (i :~> r, IO ())Source
testTypeName :: t -> TestTypeNameSource
type TestName = StringSource
Test names or descriptions. These are shown to the user
type TestTypeName = StringSource
The name of a type of test, such as Properties or Test Cases. Tests of types of the same names will be grouped together in the test run summary.
data Test Source

Main test data type: builds up a list of tests to be run. Users should use the utility functions in e.g. the test-framework-hunit and test-framework-quickcheck packages to create instances of Test, and then build them up into testsuites by using testGroup and lists.

For an example of how to use test-framework, please see http://github.com/batterseapower/test-framework/raw/master/example/Test/Framework/Example.lhs

Constructors
forall i r t . Testlike i r t => Test TestName tA single test of some particular type.
TestGroup TestName [Test]
PlusTestOptions TestOptions Test
testGroup :: TestName -> [Test] -> TestSource
Assemble a number of tests into a cohesive group
plusTestOptions :: TestOptions -> Test -> TestSource
module Test.Framework.Options
module Test.Framework.Runners.Console
module Test.Framework.Runners.Options
module Test.Framework.Seed
Produced by Haddock version 2.6.0