Moduletest-framework-0.8.2.3Haskell2010

Test.Framework.Providers.API

This module exports everything that you need to be able to create your own framework test provider. To create a provider you need to:

Create an instance of the Testlike class
Create an instance of the TestResultlike class
Expose a function that lets people construct Test values using your new instances

7 types
2 classes
25 values

Packagetest-framework-0.8.2.3
Exports34
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAPI.hs

valuebuildTest :: IO Test -> Test

Convenience for creating tests from an IO action

valuebuildTestBracketed :: IO (Test, IO ()) -> Test

Convenience for creating tests from an IO action, with a cleanup handler for when tests are finished

valuemutuallyExclusive :: Test -> Test

Mark all tests in this portion of the tree as mutually exclusive, so only one runs at a time

valueplusTestOptions :: TestOptions -> Test -> Test

Add some options to child tests

valuetestGroup :: TestName -> [Test] -> Test

Assemble a number of tests into a cohesive group

datadata MutuallyExcluded t

Constructors

ME (MVar ()) t

Instances1Testlike

Testlike i r t => Testlike i r (MutuallyExcluded t)Defined in test-framework-0.8.2.3 · Test.Framework.Core

datadata Test

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-quickcheck2 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, Typeable t) => Test TestName t
A single test of some particular type
TestGroup TestName [Test]
Assemble a number of tests into a cohesive group
PlusTestOptions TestOptions Test
Add some options to child tests
BuildTestBracketed (IO (Test, IO ()))
Convenience for creating tests from an IO action, with cleanup

typetype TestName = String

Test names or descriptions. These are shown to the user

classclass (Show i, Show r) => TestResultlike i r | r -> i where

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 -> Bool

typetype TestTypeName = String

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.

classclass TestResultlike i r => Testlike i r t | t -> i r, r -> i where

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 ())
testTypeName :: t -> TestTypeName

Instances1Testlike

Testlike i r t => Testlike i r (MutuallyExcluded t)Defined in test-framework-0.8.2.3 · Test.Framework.Core

valuebimapImproving :: (a -> c) -> (b -> d) -> a :~> b -> c :~> d

valueconsumeImproving :: a :~> b -> [a :~> b]

valueimprovingLast :: a :~> b -> b

valueliftIO :: IO a -> ImprovingIO i f a

valuemaybeTimeoutImprovingIO

:: Maybe Int
-> ImprovingIO i f a
-> ImprovingIO i f (Maybe a)

As timeoutImprovingIO, but don't bother applying a timeout to the action if Nothing is given as the number of microseconds to apply the time out for.

valuerunImprovingIO :: ImprovingIO i f f -> IO (i :~> f, IO ())

valuetimeoutImprovingIO :: Int -> ImprovingIO i f a -> ImprovingIO i f (Maybe a)

Given a number of microseconds and an improving IO action, run that improving IO action only for at most the given period before giving up. See also timeout.

valuetunnelImprovingIO :: ImprovingIO i f (ImprovingIO i f a -> IO a)

valueyieldImprovement :: i -> ImprovingIO i f ()

datadata (:~>) i f

Constructors

Finished f
Improving i (i :~> f)

Instances1Functor

Functor ((:~>) i)Defined in test-framework-0.8.2.3 · Test.Framework.Improving

newtypenewtype ImprovingIO i f a

Instances3Monad, Functor, Applicative

Monad (ImprovingIO i f)Defined in test-framework-0.8.2.3 · Test.Framework.Improving
Functor (ImprovingIO i f)Defined in test-framework-0.8.2.3 · Test.Framework.Improving
Applicative (ImprovingIO i f)Defined in test-framework-0.8.2.3 · Test.Framework.Improving

module Test.Framework.Options

module Test.Framework.Seed

valuedropLast :: Int -> [a] -> [a]

valuelistToMaybeLast :: [a] -> Maybe a

valuemapAccumLM

:: Monad m
=> acc -> x -> m (acc, y)
-> acc
-> [x]
-> m (acc, [y])

valuemappendBy :: Monoid b => (a -> b) -> a -> a -> b

valuemicrosecondsToPicoseconds :: Num a => a -> a

valueonLeft :: (a -> c) -> (a, b) -> (c, b)

valueonRight :: (b -> c) -> (a, b) -> (a, c)

valueorElse :: Maybe a -> a -> a

valuepadRight :: Int -> String -> String

valuesecondsToMicroseconds :: Num a => a -> a

valueunlinesConcise :: [String] -> String

Like unlines, but does not append a trailing newline if there is at least one line. For example:

unlinesConcise ["A", "B"] == "A\nB"
unlinesConcise [] == ""

Whereas:

unlines ["A", "B"] == "A\nB\n"
unlines [] == ""

This is closer to the behaviour of unwords, which does not append a trailing space.

newtypenewtype K a

Constructors

K
- unK :: a