Test.StateMachine

The main module for state machine based testing, it contains combinators that help you build sequential and parallel properties.

Sequential property combinators

data Program act

A (sequential) program is an abstract datatype representing a list of actions.

The idea is that the user shows how to generate, shrink, execute and modelcheck individual actions, and then the below combinators lift those things to whole programs.

Instances

Eq (Internal act) => Eq (Program act)

Methods

(==) :: Program act -> Program act -> Bool

(/=) :: Program act -> Program act -> Bool

Read (Untyped act) => Read (Program act)

Methods

readsPrec :: Int -> ReadS (Program act)

readList :: ReadS [Program act]

readPrec :: ReadPrec (Program act)

readListPrec :: ReadPrec [Program act]

Show (Untyped act) => Show (Program act)

Methods

showsPrec :: Int -> Program act -> ShowS

show :: Program act -> String

showList :: [Program act] -> ShowS

Monoid (Program act)

Methods

mempty :: Program act

mappend :: Program act -> Program act -> Program act

mconcat :: [Program act] -> Program act

programLength :: Program act -> Int

Returns the number of actions in a program.

forAllProgram

Arguments

:: HFoldable act

=> Generator model act

-> Shrinker act

-> Precondition model act

-> Transition' model act err

-> InitialModel model

-> (Program act -> Property)

Predicate that should hold for all programs.

-> Property

This function is like a forAllShrink for sequential programs.

monadicSequential

Arguments

:: Monad m

=> HFoldable act

=> Testable a

=> StateMachine' model act m err

-> (Program act -> PropertyM m a)

Predicate that should hold for all programs.

-> Property

Wrapper around forAllProgram using the StateMachine specification to generate and shrink sequential programs.

runProgram

Arguments

:: Monad m

=> Show1 (act Symbolic)

=> Show err

=> Typeable err

=> HTraversable act

=> StateMachine' model act m err

-> Program act

-> PropertyM m (History act err, model Concrete, Reason)

Testable property of sequential programs derived from a StateMachine specification.

prettyProgram :: MonadIO m => Show (model Concrete) => Show err => StateMachine' model act m err -> History act err -> Property -> PropertyM m ()

Takes the output of running a program and pretty prints a counterexample if the run failed.

actionNames :: forall act. Constructors act => Program act -> [(Constructor, Int)]

Returns the frequency of actions in a program.

checkActionNames :: Constructors act => Program act -> Property -> Property

Print distribution of actions and fail if some actions have not been executed.

Parallel property combinators

data ParallelProgram act

Instances

Eq (Untyped act) => Eq (ParallelProgram act)

Methods

(==) :: ParallelProgram act -> ParallelProgram act -> Bool

(/=) :: ParallelProgram act -> ParallelProgram act -> Bool

Read (Untyped act) => Read (ParallelProgram act)

Methods

readsPrec :: Int -> ReadS (ParallelProgram act)

readList :: ReadS [ParallelProgram act]

readPrec :: ReadPrec (ParallelProgram act)

readListPrec :: ReadPrec [ParallelProgram act]

Show (Untyped act) => Show (ParallelProgram act)

Methods

showsPrec :: Int -> ParallelProgram act -> ShowS

show :: ParallelProgram act -> String

showList :: [ParallelProgram act] -> ShowS

data History act err

A history is a trace of a program execution.

Instances

Monoid (History act err)

Methods

mempty :: History act err

mappend :: History act err -> History act err -> History act err

mconcat :: [History act err] -> History act err

monadicParallel

Arguments

:: MonadBaseControl IO m

=> Eq (Untyped act)

=> Show1 (act Symbolic)

=> HFoldable act

=> StateMachine' model act m err

-> (ParallelProgram act -> PropertyM m ())

Predicate that should hold for all parallel programs.

-> Property

Wrapper around 'forAllParallelProgram using the StateMachine specification to generate and shrink parallel programs.

runParallelProgram

Arguments

:: MonadBaseControl IO m

=> Show1 (act Symbolic)

=> HTraversable act

=> StateMachine' model act m err

-> ParallelProgram act

-> PropertyM m [(History act err, Property)]

Testable property of parallel programs derived from a StateMachine specification.

runParallelProgram'

Arguments

:: MonadBaseControl IO m

=> Show1 (act Symbolic)

=> HTraversable act

=> Int

How many times to execute the parallel program.

-> StateMachine' model act m err

-> ParallelProgram act

-> PropertyM m [(History act err, Property)]

prettyParallelProgram

Arguments

:: MonadIO m

=> HFoldable act

=> Show (Untyped act)

=> ParallelProgram act

-> [(History act err, Property)]

Output of 'runParallelProgram.

-> PropertyM m ()

Takes the output of a parallel program runs and pretty prints a counter example if any of the runs fail.

With counterexamples

forAllProgramC

Arguments

:: HFoldable act

=> Generator model act

-> Shrinker act

-> Precondition model act

-> Transition' model act err

-> InitialModel model

-> (Program act -> PropertyOf a)

Predicate that should hold for all programs.

-> PropertyOf (Program act :&: a)

Variant of forAllProgram which returns the generated and shrunk program if the property fails.

monadicSequentialC

Arguments

:: Monad m

=> HFoldable act

=> Testable a

=> StateMachine' model act m err

-> (Program act -> PropertyM m a)

Predicate that should hold for all programs.

-> PropertyOf (Program act)

Variant of monadicSequential with counterexamples.

monadicParallelC

Arguments

:: MonadBaseControl IO m

=> Eq (Untyped act)

=> Show1 (act Symbolic)

=> HFoldable act

=> StateMachine' model act m err

-> (ParallelProgram act -> PropertyM m ())

Predicate that should hold for all parallel programs.

-> PropertyOf (ParallelProgram act)

Variant of monadicParallel with counterexamples.

Types

module Test.StateMachine.Types

Reexport

quickCheck :: Testable prop => prop -> IO ()

Tests a property and prints the results to stdout.

By default up to 100 tests are performed, which may not be enough to find all bugs. To run more tests, use withMaxSuccess.