Test.Util

A module containing utilities for testing with test-framework, HUnit, and testable.

Throwing and catching exceptions

isExceptionThrown :: (Functor m, MonadCatchIO m, Exception e) => m a -> m (Either e a)

Determine whether an exception was caught, and return it if so.

assertThrown :: (Functor m, MonadCatchIO m, Exception e, Show e) => Maybe String -> Proxy e -> m () -> m ()

Assert that an exception is thrown.

When an exception is not thrown, the input String, or otherwise a default string, is output.

For more control, see the more fundamental isExceptionThrown.

assertNotThrown :: (Functor m, MonadCatchIO m, Exception e, Show e) => Maybe (e -> String) -> m () -> m ()

Assert that an exception is not thrown.

When an exception is thrown, the input function, or a default one, is given the exception and the resulting string is output.

For more control, see the more fundamental isExceptionThrown.

Concurrent TDD

Process timing

timeMicroseconds :: (Monad m, MonadIO m) => m a -> m (a, Integer)

Time a computation.

timeoutMicroseconds :: Integer -> IO a -> IO (Maybe a)

Run a computation within an approximate time limit.

This is currently a wrapper for timeout that checks for overflows.

assertMicroseconds :: Integer -> IO a -> IO a

Assert that a computation runs within an approximate time limit.

If the computation does not finish within the given time limit, a TimeLimitExceeded exception is thrown.

For more control, see the more fundamental timeoutMicroseconds function.

timeoutProcessMicroseconds :: Integer -> ProcessHandle -> IO (Maybe ExitCode)

Apply an approximate time limit, from the current time, to a process by its handle.

If the process finishes approximately within the given time limit, Just its exit code is returned. Otherwise, it is killed and Nothing is returned.

This function requires a threaded runtime system to work properly.

assertProcessMicroseconds :: Integer -> ProcessHandle -> IO ()

Assert that a process finishes within an approximate time limit.

If the computation does not finish within the given time limit, a TimeLimitExceeded exception is thrown.

For more control, see the more fundamental timeoutProcessMicroseconds function.

Exceptions

data TestUtilException where

A class of exceptions for Tests.Util.

Constructors

TestUtilException :: Exception e => e -> TestUtilException

Instances

Show TestUtilException

Typeable TestUtilException

Exception TestUtilException

testUtilExceptionToException :: Exception e => e -> SomeException

testUtilExceptionFromException :: Exception e => SomeException -> Maybe e

data TimeoutOverflow

timeoutMicrosoconds was invoked with an integer that would cause the input given to timeout to overflow.

Constructors

TimeoutOverflow

Fields

_timeoutOverflow_message :: Maybe String

Optional error message.

_timeoutOverflow_microseconds :: Integer

Input given to timeoutMicroseconds.

_timeoutOverflow_inputBound :: Integer

Maximum bound of Int as an Integer.

Instances

Eq TimeoutOverflow

Show TimeoutOverflow

Typeable TimeoutOverflow

Exception TimeoutOverflow

timeoutOverflow_message :: Lens' TimeoutOverflow (Maybe String)

timeoutOverflow_microseconds :: Lens' TimeoutOverflow Integer

timeoutOverflow_inputBound :: Lens' TimeoutOverflow Integer

data TimeLimitExceeded

Constructors

TimeLimitExceeded

Fields

_timelimitExceeded_message :: Maybe String

Optional error message.

_timelimitExceeded_callerName :: String

Name of the function that directly threw the exception (assertMicroseconds, etc.)

_timelimitExceeded_microseconds :: Integer

The timelimit.

Instances

Eq TimeLimitExceeded

Show TimeLimitExceeded

Typeable TimeLimitExceeded

Exception TimeLimitExceeded

timelimitExceeded_message :: Lens' TimeLimitExceeded (Maybe String)

timelimitExceeded_callerName :: Lens' TimeLimitExceeded String

timelimitExceeded_microseconds :: Lens' TimeLimitExceeded Integer