Test.HClTest.Monad

This module defines the basic test type, HClTest, which is a monad. It also provides functions for creating and running tests.

Documentation

newtype HClTest w a

The HClTest monad. A HClTest action describes a single test case. The first argument is the type of the trace entries. For tests, this should be Trace. For a single test step, this should be String.

Constructors

HClTest

Fields

unHClTest :: ReaderT Config (MaybeT (WriterT (DList w) IO)) a

Instances

MonadReader Config (HClTest w)

MonadBase IO (HClTest w)

MonadBaseControl IO (HClTest w)

Monad (HClTest w)

Functor (HClTest w)

MonadPlus (HClTest w)

Applicative (HClTest w)

Alternative (HClTest w)

MonadIO (HClTest w)

data Config

The config is passed in a Reader to the test cases.

Constructors

Config

Fields

_wdLock :: RLock

_timeoutFactor :: Double

Instances

MonadReader Config (HClTest w)

runHClTest :: Double -> HClTest Trace () -> IO (Bool, String)

Like runHClTestTrace, but already shows the trace so that you get a string.

runHClTestTrace :: Double -> HClTest Trace () -> IO (Bool, DList Trace)

Run a HClTest. The first argument is the timeout for waiting for output of the process, in milliseconds. The second argument is the test case.

This will run the test in a temporary working directory. Use the functions in Test.HClTest.Setup to setup the environment.

failTest :: a -> HClTest a b

This is a HClTest action that always fails. The first argument is the trace to leave. If you want to fail without leaving a trace, you can just use mzero.

testStep :: String -> HClTest String a -> HClTest Trace a

A single test step. The first argument is a description of the step. The test step can produce trace messages of type String. Those will be collected an exactly one Trace will be emitted.

traceMsg :: a -> HClTest a ()

Add a message to the log.

testIO :: String -> IO Bool -> HClTest Trace ()

Run an IO action, and fail if that action returns false. The first argument is a description of the IO action which will be used for the trace messages.

randomParallel :: Int -> [HClTest Trace ()] -> HClTest Trace ()

Run a number of tests in parallel, in random order. The first argument is the number of threads to use. Note that if the test cases require different working directories, some of the threads may block.

withWorkingDirectory :: FilePath -> HClTest Trace a -> HClTest Trace a

Run a test in the given directory.

timeoutFactor :: Lens' Config Double

wdLock :: Lens' Config RLock