Copyright	(c) 2016 Michael Walker
License	MIT
Maintainer	Michael Walker <mike@barrucadu.co.uk>
Stability	stable
Portability	CPP, FlexibleInstances, GADTs, ImpredicativeTypes, RankNTypes, TypeSynonymInstances
Safe Haskell	None
Language	Haskell2010

Test.Tasty.DejaFu

Contents

Unit testing
Property testing
- IO
Re-exports
Orphan instances

Description

This module allows using Deja Fu predicates with Tasty to test the behaviour of concurrent systems.

Synopsis

Unit testing

This is supported by the IsTest instances for ConcST and ConcIO. These instances try all executions, reporting as failures the cases which return a Just string.

instance Typeable t => IsTest (ConcST t (Maybe String)) instance IsTest (ConcIO (Maybe String)) instance IsOption Bounds instance IsOption MemType

Property testing

testAuto Source #

Arguments

:: (Eq a, Show a)
=> (forall t. ConcST t a)	The computation to test
-> TestTree

Automatically test a computation. In particular, look for deadlocks, uncaught exceptions, and multiple return values.

This uses the Conc monad for testing, which is an instance of MonadConc. If you need to test something which also uses MonadIO, use testAutoIO.

Since: 0.2.0.0

testDejafu Source #

Arguments

:: Show a
=> (forall t. ConcST t a)	The computation to test
-> TestName	The name of the test.
-> Predicate a	The predicate to check
-> TestTree

Check that a predicate holds.

Since: 0.2.0.0

testDejafus Source #

Arguments

:: Show a
=> (forall t. ConcST t a)	The computation to test
-> [(TestName, Predicate a)]	The list of predicates (with names) to check
-> TestTree

Variant of testDejafu which takes a collection of predicates to test. This will share work between the predicates, rather than running the concurrent computation many times for each predicate.

Since: 0.2.0.0

testAutoWay Source #

Arguments

:: (Eq a, Show a)
=> Way	How to execute the concurrent program.
-> MemType	The memory model to use for non-synchronised `CRef` operations.
-> (forall t. ConcST t a)	The computation to test
-> TestTree

Variant of testAuto which tests a computation under a given execution way and memory model.

Since: 0.5.0.0

testDejafuWay Source #

Arguments

:: Show a
=> Way	How to execute the concurrent program.
-> MemType	The memory model to use for non-synchronised `CRef` operations.
-> (forall t. ConcST t a)	The computation to test
-> TestName	The name of the test.
-> Predicate a	The predicate to check
-> TestTree

Variant of testDejafu which takes a way to execute the program and a memory model.

Since: 0.5.0.0

testDejafusWay Source #

Arguments

:: Show a
=> Way	How to execute the concurrent program.
-> MemType	The memory model to use for non-synchronised `CRef` operations.
-> (forall t. ConcST t a)	The computation to test
-> [(TestName, Predicate a)]	The list of predicates (with names) to check
-> TestTree

Variant of testDejafus which takes a way to execute the program and a memory model.

Since: 0.5.0.0

`IO`

testAutoIO :: (Eq a, Show a) => ConcIO a -> TestTree Source #

Variant of testAuto for computations which do IO.

Since: 0.2.0.0

testDejafuIO :: Show a => ConcIO a -> TestName -> Predicate a -> TestTree Source #

Variant of testDejafu for computations which do IO.

Since: 0.2.0.0

testDejafusIO :: Show a => ConcIO a -> [(TestName, Predicate a)] -> TestTree Source #

Variant of testDejafus for computations which do IO.

Since: 0.2.0.0

testAutoWayIO :: (Eq a, Show a) => Way -> MemType -> ConcIO a -> TestTree Source #

Variant of testAutoWay for computations which do IO.

Since: 0.5.0.0

testDejafuWayIO :: Show a => Way -> MemType -> ConcIO a -> TestName -> Predicate a -> TestTree Source #

Variant of testDejafuWay for computations which do IO.

Since: 0.5.0.0

testDejafusWayIO :: Show a => Way -> MemType -> ConcIO a -> [(TestName, Predicate a)] -> TestTree Source #

Variant of dejafusWay for computations which do IO.

Since: 0.5.0.0

Re-exports

data Way :: * where #

How to explore the possible executions of a concurrent program:

Systematically explore all executions within the bounds; or
Explore a fixed number of random executions, with the given PRNG.

Since: 0.6.0.0

Constructors

Systematically :: Way
Randomly :: Way

Instances

Show Way
Methods showsPrec :: Int -> Way -> ShowS # show :: Way -> String # showList :: [Way] -> ShowS #

data Bounds :: * #

Since: 0.2.0.0

Constructors

Bounds
Fields boundPreemp :: Maybe PreemptionBound boundFair :: Maybe FairBound boundLength :: Maybe LengthBound

Instances

Eq Bounds
Methods (==) :: Bounds -> Bounds -> Bool # (/=) :: Bounds -> Bounds -> Bool #
Ord Bounds
Methods compare :: Bounds -> Bounds -> Ordering # (<) :: Bounds -> Bounds -> Bool # (<=) :: Bounds -> Bounds -> Bool # (>) :: Bounds -> Bounds -> Bool # (>=) :: Bounds -> Bounds -> Bool # max :: Bounds -> Bounds -> Bounds # min :: Bounds -> Bounds -> Bounds #
Read Bounds
Methods readsPrec :: Int -> ReadS Bounds # readList :: ReadS [Bounds] # readPrec :: ReadPrec Bounds # readListPrec :: ReadPrec [Bounds] #
Show Bounds
Methods showsPrec :: Int -> Bounds -> ShowS # show :: Bounds -> String # showList :: [Bounds] -> ShowS #
NFData Bounds	Since: 0.5.1.0
Methods rnf :: Bounds -> () #

data MemType :: * #

The memory model to use for non-synchronised CRef operations.

Since: 0.4.0.0

Constructors

SequentialConsistency	The most intuitive model: a program behaves as a simple interleaving of the actions in different threads. When a `CRef` is written to, that write is immediately visible to all threads.
TotalStoreOrder	Each thread has a write buffer. A thread sees its writes immediately, but other threads will only see writes when they are committed, which may happen later. Writes are committed in the same order that they are created.
PartialStoreOrder	Each `CRef` has a write buffer. A thread sees its writes immediately, but other threads will only see writes when they are committed, which may happen later. Writes to different `CRef`s are not necessarily committed in the same order that they are created.

Instances

Bounded MemType
Methods minBound :: MemType # maxBound :: MemType #
Enum MemType
Methods succ :: MemType -> MemType # pred :: MemType -> MemType # toEnum :: Int -> MemType # fromEnum :: MemType -> Int # enumFrom :: MemType -> [MemType] # enumFromThen :: MemType -> MemType -> [MemType] # enumFromTo :: MemType -> MemType -> [MemType] # enumFromThenTo :: MemType -> MemType -> MemType -> [MemType] #
Eq MemType
Methods (==) :: MemType -> MemType -> Bool # (/=) :: MemType -> MemType -> Bool #
Ord MemType
Methods compare :: MemType -> MemType -> Ordering # (<) :: MemType -> MemType -> Bool # (<=) :: MemType -> MemType -> Bool # (>) :: MemType -> MemType -> Bool # (>=) :: MemType -> MemType -> Bool # max :: MemType -> MemType -> MemType # min :: MemType -> MemType -> MemType #
Read MemType
Methods readsPrec :: Int -> ReadS MemType # readList :: ReadS [MemType] # readPrec :: ReadPrec MemType # readListPrec :: ReadPrec [MemType] #
Show MemType
Methods showsPrec :: Int -> MemType -> ShowS # show :: MemType -> String # showList :: [MemType] -> ShowS #
NFData MemType	Since: 0.5.1.0
Methods rnf :: MemType -> () #

Orphan instances

IsOption Way Source #	Since: 0.5.0.0
Methods defaultValue :: Way # parseValue :: String -> Maybe Way # optionName :: Tagged * Way String # optionHelp :: Tagged * Way String # optionCLParser :: Parser Way #
IsOption MemType Source #	Since: 0.3.0.0
Methods defaultValue :: MemType # parseValue :: String -> Maybe MemType # optionName :: Tagged * MemType String # optionHelp :: Tagged * MemType String # optionCLParser :: Parser MemType #
IsTest (ConcIO (Maybe String)) Source #	Since: 0.3.0.0
Methods run :: OptionSet -> ConcIO (Maybe String) -> (Progress -> IO ()) -> IO Result # testOptions :: Tagged * (ConcIO (Maybe String)) [OptionDescription] #
Typeable * t => IsTest (ConcST t (Maybe String)) Source #	Since: 0.3.0.0
Methods run :: OptionSet -> ConcST t (Maybe String) -> (Progress -> IO ()) -> IO Result # testOptions :: Tagged * (ConcST t (Maybe String)) [OptionDescription] #