Test.TLT.Class

Main state and monad definitions for the TLT testing system. See TLT for more information.

Documentation

type TLTstate = (TLTopts, TRBuf)

Synonym for the elements of the TLT state.

newtype TLT (m :: * -> *) r

Monad transformer for TLT tests. This layer stores the results from tests as they are executed.

Constructors

TLT

Fields

• unwrap :: StateT TLTstate m r

Instances

MonadTrans TLT

Defined in Test.TLT.Class

Methods

lift :: Monad m => m a -> TLT m a

Monad m => Applicative (TLT m)

Defined in Test.TLT.Class

Methods

pure :: a -> TLT m a

(<*>) :: TLT m (a -> b) -> TLT m a -> TLT m b

liftA2 :: (a -> b -> c) -> TLT m a -> TLT m b -> TLT m c

(*>) :: TLT m a -> TLT m b -> TLT m b

(<*) :: TLT m a -> TLT m b -> TLT m a

Functor m => Functor (TLT m)

Defined in Test.TLT.Class

Methods

fmap :: (a -> b) -> TLT m a -> TLT m b

(<$) :: a -> TLT m b -> TLT m a

Monad m => Monad (TLT m)

Defined in Test.TLT.Class

Methods

(>>=) :: TLT m a -> (a -> TLT m b) -> TLT m b

(>>) :: TLT m a -> TLT m b -> TLT m b

return :: a -> TLT m a

Monad m => MonadTLT (TLT m) m

Defined in Test.TLT.Class

Methods

liftTLT :: TLT m a -> TLT m a

class (Monad m, Monad n) => MonadTLT m n | m -> n where

Extending TLT operations across other monad transformers. For easiest and most flexible testing, declare the monad transformers of your application as instances of this class.

Methods

liftTLT :: TLT n a -> m a

Lift TLT operations within a monad transformer stack. Note that with enough transformer types included in this class, the liftTLT function should usually be unnecessary: the commands in this module which actually configure testing, or specify a test, already liftTLT their own result. So they will all act as top-level transformers in MonadTLT.

Instances

Monad m => MonadTLT (TLT m) m

Defined in Test.TLT.Class

Methods

liftTLT :: TLT m a -> TLT m a

MonadTLT m n => MonadTLT (ResourceT m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> ResourceT m a

MonadTLT m n => MonadTLT (MaybeT m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> MaybeT m a

MonadTLT m n => MonadTLT (STT s m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> STT s m a

(MonadTLT m n, Functor f) => MonadTLT (FreeT f m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> FreeT f m a

MonadTLT m n => MonadTLT (ExceptT e m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> ExceptT e m a

MonadTLT m n => MonadTLT (IdentityT m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> IdentityT m a

MonadTLT m n => MonadTLT (ReaderT r m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> ReaderT r m a

MonadTLT m n => MonadTLT (StateT s m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> StateT s m a

MonadTLT m n => MonadTLT (StateT s m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> StateT s m a

(MonadTLT m n, Monoid w) => MonadTLT (WriterT w m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> WriterT w m a

(MonadTLT m n, Monoid w) => MonadTLT (WriterT w m) n

Defined in Test.TLT.Class

Methods

liftTLT :: TLT n a -> WriterT w m a

runTLT :: Monad m => TLT m r -> m (TLTopts, [TestResult])

Execute the tests specified in a TLT monad without output side-effects, returning the final options and result reports.

This function is primarily useful when calling TLT from some other package. If you are using TLT itself as your test framework, and wishing to see its human-oriented output directly, consider using tlt instead.

reportAllTestResults :: MonadTLT m n => Bool -> m ()

This function controls whether tlt will report only tests which fail, suppressing any display of tests which pass, or else report the results of all tests. The default is the former: the idea is that no news should be good news, with the programmer bothered only with problems which need fixing.

setExitAfterFailDisplay :: MonadTLT m n => Bool -> m ()

This function controls whether the main tlt executable should exit after displaying test results which include at least one failing test. By default, it will exit in this situation. The idea is that a test suite can be broken into parts when it makes sense to run the latter parts only when the former parts all pass.

tltFail :: MonadTLT m n => String -> String -> m ()

Report a failure. Useful in pattern-matching cases which are entirely not expected.

tltPass :: MonadTLT m n => String -> m ()

Report a success. Useful in default cases.

inGroup :: MonadTLT m n => String -> m a -> m a

Organize the tests in the given subcomputation as a separate group within the test results we will report.

class (MonadTLT m nt, Monad m, MonadTLT ne nt) => MonadTLTExcept m e nt ne | m -> e, m -> ne where

Enabling TLT checking of the completion of computations with- or without uncaught exceptions in a (possibly embedded) ExceptT or Except monad.

In general, it is more difficult to automatically deduce MonadTLTExcept instances than MonadTLT because runToExcept instances bodies will frequently require additional parameters to functions such as runReaderT, or values corresponding to Nothing, which are specific to a particular scenario.

Note that using MonadTLTExcept imposes the restriction that the TLT transformer layer must be wrapped within the ExceptT transformer layer.

Methods

liftTLTExcept :: ExceptT e ne a -> m a

Encodes how an embedded ExceptT monad can be lifted to the top-level monad stack type m.

runToExcept :: m a -> ExceptT e ne a

Runs the layers of the monad stack above the ExceptT layer, exposing that latter layer. Serves as an inverse of liftTLTExcept.

Instances

MonadTLT m nt => MonadTLTExcept (ExceptT e m) e nt m

The ExceptT instance is a base case; here the lift/run functions are simply id.

Defined in Test.TLT.Class

Methods

liftTLTExcept :: ExceptT e m a -> ExceptT e m a

runToExcept :: ExceptT e m a -> ExceptT e m a

MonadTLTExcept m e nt ne => MonadTLTExcept (IdentityT m) e nt ne

We can infer general instances for other monad transformer types when their run function does not take some initializing argument.

Defined in Test.TLT.Class

Methods

liftTLTExcept :: ExceptT e ne a -> IdentityT m a

runToExcept :: IdentityT m a -> ExceptT e ne a

(MonadTLTExcept m e nt ne, Monoid w) => MonadTLTExcept (WriterT w m) e nt ne

The runToExcept function in this case simply discards any output.

Defined in Test.TLT.Class

Methods

liftTLTExcept :: ExceptT e ne a -> WriterT w m a

runToExcept :: WriterT w m a -> ExceptT e ne a

(MonadTLTExcept m e nt ne, Monoid w) => MonadTLTExcept (WriterT w m) e nt ne

The runToExcept function in this case simply discards any output.

Defined in Test.TLT.Class

Methods

liftTLTExcept :: ExceptT e ne a -> WriterT w m a

runToExcept :: WriterT w m a -> ExceptT e ne a

noUncaught_ :: MonadTLTExcept m e nt ne => String -> m a -> m ()

Ensure that a computation in ExceptT completes without an uncaught exception.

noUncaught :: (MonadTLTExcept m e nt ne, Show e) => String -> m a -> m ()

Ensure that a computation in ExceptT completes without an uncaught exception.

uncaughtWith :: MonadTLTExcept m e nt ne => String -> m a -> (e -> ExceptT e ne ()) -> m ()

Ensure that a computation in ExceptT does throw an uncaught exception, allowing further testing of the exception.

uncaught :: forall {m} {e} {nt :: Type -> Type} {ne :: Type -> Type} {a}. MonadTLTExcept m e nt ne => String -> m a -> m ()

Ensure that a computation in ExceptT does throw an uncaught exception.