Test.StateMachine

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

Sequential property combinators

forAllCommands

Arguments

:: Testable prop

=> (Show (cmd Symbolic), Show (resp Symbolic), Show (model Symbolic))

=> CommandNames cmd

=> (Traversable cmd, Foldable resp)

=> StateMachine model cmd m resp

-> Maybe Int

Minimum number of commands.

-> (Commands cmd resp -> prop)

Predicate.

-> Property

transitionMatrix :: forall cmd. CommandNames cmd => Proxy (cmd Symbolic) -> (String -> String -> Int) -> Matrix Int

runCommands :: (Traversable cmd, Foldable resp) => (MonadCatch m, MonadIO m) => StateMachine model cmd m resp -> Commands cmd resp -> PropertyM m (History cmd resp, model Concrete, Reason)

prettyCommands :: (MonadIO m, ToExpr (model Concrete)) => (Show (cmd Concrete), Show (resp Concrete)) => StateMachine model cmd m resp -> History cmd resp -> Property -> PropertyM m ()

checkCommandNames :: forall cmd resp. CommandNames cmd => Commands cmd resp -> Property -> Property

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

commandNames :: forall cmd resp. CommandNames cmd => Commands cmd resp -> [(String, Int)]

commandNamesInOrder :: forall cmd resp. CommandNames cmd => Commands cmd resp -> [String]

Parallel property combinators

forAllParallelCommands

Arguments

:: Testable prop

=> (Show (cmd Symbolic), Show (resp Symbolic), Show (model Symbolic))

=> CommandNames cmd

=> (Traversable cmd, Foldable resp)

=> StateMachine model cmd m resp

-> (ParallelCommands cmd resp -> prop)

Predicate.

-> Property

runParallelCommands :: (Show (cmd Concrete), Show (resp Concrete)) => (Traversable cmd, Foldable resp) => (MonadCatch m, MonadUnliftIO m) => StateMachine model cmd m resp -> ParallelCommands cmd resp -> PropertyM m [(History cmd resp, Logic)]

runParallelCommandsNTimes

Arguments

:: (Show (cmd Concrete), Show (resp Concrete))

=> (Traversable cmd, Foldable resp)

=> (MonadCatch m, MonadUnliftIO m)

=> Int

How many times to execute the parallel program.

-> StateMachine model cmd m resp

-> ParallelCommands cmd resp

-> PropertyM m [(History cmd resp, Logic)]

prettyParallelCommands

Arguments

:: (MonadIO m, Foldable cmd)

=> (Show (cmd Concrete), Show (resp Concrete))

=> ParallelCommands cmd resp

-> [(History cmd resp, Logic)]

Output of runParallelCommands.

-> PropertyM m ()

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

Types

data StateMachine model cmd m resp

Constructors

StateMachine (forall r. model r) (forall r. (Show1 r, Ord1 r) => model r -> cmd r -> resp r -> model r) (model Symbolic -> cmd Symbolic -> Logic) (model Concrete -> cmd Concrete -> resp Concrete -> Logic) (Maybe (model Concrete -> Logic)) (model Symbolic -> Maybe (Gen (cmd Symbolic))) (Maybe (Matrix Int)) (model Symbolic -> cmd Symbolic -> [cmd Symbolic]) (cmd Concrete -> m (resp Concrete)) (model Symbolic -> cmd Symbolic -> GenSym (resp Symbolic))

data Concrete a

Instances

Eq1 Concrete

Defined in Test.StateMachine.Types.References

Methods

liftEq :: (a -> b -> Bool) -> Concrete a -> Concrete b -> Bool

Ord1 Concrete

Defined in Test.StateMachine.Types.References

Methods

liftCompare :: (a -> b -> Ordering) -> Concrete a -> Concrete b -> Ordering

Show1 Concrete

Defined in Test.StateMachine.Types.References

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> Concrete a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [Concrete a] -> ShowS

Show a => Show (Concrete a)

Defined in Test.StateMachine.Types.References

Methods

showsPrec :: Int -> Concrete a -> ShowS

show :: Concrete a -> String

showList :: [Concrete a] -> ShowS

ToExpr a => ToExpr (Concrete a)

Defined in Test.StateMachine.Types.References

Methods

toExpr :: Concrete a -> Expr

listToExpr :: [Concrete a] -> Expr

data Symbolic a

Instances

Eq1 Symbolic

Defined in Test.StateMachine.Types.References

Methods

liftEq :: (a -> b -> Bool) -> Symbolic a -> Symbolic b -> Bool

Ord1 Symbolic

Defined in Test.StateMachine.Types.References

Methods

liftCompare :: (a -> b -> Ordering) -> Symbolic a -> Symbolic b -> Ordering

Show1 Symbolic

Defined in Test.StateMachine.Types.References

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> Symbolic a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [Symbolic a] -> ShowS

Eq (Symbolic a)

Defined in Test.StateMachine.Types.References

Methods

(==) :: Symbolic a -> Symbolic a -> Bool

(/=) :: Symbolic a -> Symbolic a -> Bool

Ord (Symbolic a)

Defined in Test.StateMachine.Types.References

Methods

compare :: Symbolic a -> Symbolic a -> Ordering

(<) :: Symbolic a -> Symbolic a -> Bool

(<=) :: Symbolic a -> Symbolic a -> Bool

(>) :: Symbolic a -> Symbolic a -> Bool

(>=) :: Symbolic a -> Symbolic a -> Bool

max :: Symbolic a -> Symbolic a -> Symbolic a

min :: Symbolic a -> Symbolic a -> Symbolic a

Show (Symbolic a)

Defined in Test.StateMachine.Types.References

Methods

showsPrec :: Int -> Symbolic a -> ShowS

show :: Symbolic a -> String

showList :: [Symbolic a] -> ShowS

ToExpr a => ToExpr (Symbolic a)

Defined in Test.StateMachine.Types.References

Methods

toExpr :: Symbolic a -> Expr

listToExpr :: [Symbolic a] -> Expr

data Reference a r

Instances

Traversable (Reference a :: (Type -> Type) -> Type)

Defined in Test.StateMachine.Types.References

Methods

traverse :: Applicative f => (forall (a0 :: k). p a0 -> f (q a0)) -> Reference a p -> f (Reference a q)

Foldable (Reference a :: (Type -> Type) -> Type)

Defined in Test.StateMachine.Types.References

Methods

foldMap :: Monoid m => (forall (x :: k). p x -> m) -> Reference a p -> m

Functor (Reference a :: (Type -> Type) -> Type)

Defined in Test.StateMachine.Types.References

Methods

fmap :: (forall (x :: k). p x -> q x) -> Reference a p -> Reference a q

(Eq a, Eq1 r) => Eq (Reference a r)

Defined in Test.StateMachine.Types.References

Methods

(==) :: Reference a r -> Reference a r -> Bool

(/=) :: Reference a r -> Reference a r -> Bool

(Ord a, Ord1 r) => Ord (Reference a r)

Defined in Test.StateMachine.Types.References

Methods

compare :: Reference a r -> Reference a r -> Ordering

(<) :: Reference a r -> Reference a r -> Bool

(<=) :: Reference a r -> Reference a r -> Bool

(>) :: Reference a r -> Reference a r -> Bool

(>=) :: Reference a r -> Reference a r -> Bool

max :: Reference a r -> Reference a r -> Reference a r

min :: Reference a r -> Reference a r -> Reference a r

(Show1 r, Show a) => Show (Reference a r)

Defined in Test.StateMachine.Types.References

Methods

showsPrec :: Int -> Reference a r -> ShowS

show :: Reference a r -> String

showList :: [Reference a r] -> ShowS

Generic (Reference a r)

Defined in Test.StateMachine.Types.References

Associated Types

type Rep (Reference a r) :: Type -> Type

Methods

from :: Reference a r -> Rep (Reference a r) x

to :: Rep (Reference a r) x -> Reference a r

ToExpr (r a) => ToExpr (Reference a r)

Defined in Test.StateMachine.Types.References

Methods

toExpr :: Reference a r -> Expr

listToExpr :: [Reference a r] -> Expr

type Rep (Reference a r)

Defined in Test.StateMachine.Types.References

type Rep (Reference a r) = D1 (MetaData "Reference" "Test.StateMachine.Types.References" "quickcheck-state-machine-0.6.0-LSB9KqOf7Vm4DfY8PJnoGQ" False) (C1 (MetaCons "Reference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (r a))))

concrete :: Reference a Concrete -> a

reference :: Typeable a => a -> Reference a Concrete

newtype Opaque a

Constructors

Opaque

Fields

• unOpaque :: a

Instances

Eq a => Eq (Opaque a)

Defined in Test.StateMachine.Types.References

Methods

(==) :: Opaque a -> Opaque a -> Bool

(/=) :: Opaque a -> Opaque a -> Bool

Ord a => Ord (Opaque a)

Defined in Test.StateMachine.Types.References

Methods

compare :: Opaque a -> Opaque a -> Ordering

(<) :: Opaque a -> Opaque a -> Bool

(<=) :: Opaque a -> Opaque a -> Bool

(>) :: Opaque a -> Opaque a -> Bool

(>=) :: Opaque a -> Opaque a -> Bool

max :: Opaque a -> Opaque a -> Opaque a

min :: Opaque a -> Opaque a -> Opaque a

Show (Opaque a)

Defined in Test.StateMachine.Types.References

Methods

showsPrec :: Int -> Opaque a -> ShowS

show :: Opaque a -> String

showList :: [Opaque a] -> ShowS

ToExpr (Opaque a)

Defined in Test.StateMachine.Types.References

Methods

toExpr :: Opaque a -> Expr

listToExpr :: [Opaque a] -> Expr

opaque :: Reference (Opaque a) Concrete -> a

data Reason

Constructors

Ok

PreconditionFailed String

PostconditionFailed String

InvariantBroken String

ExceptionThrown

Instances

Eq Reason

Defined in Test.StateMachine.Types

Methods

(==) :: Reason -> Reason -> Bool

(/=) :: Reason -> Reason -> Bool

Show Reason

Defined in Test.StateMachine.Types

Methods

showsPrec :: Int -> Reason -> ShowS

show :: Reason -> String

showList :: [Reason] -> ShowS

data GenSym a

Instances

Monad GenSym

Defined in Test.StateMachine.Types.GenSym

Methods

(>>=) :: GenSym a -> (a -> GenSym b) -> GenSym b

(>>) :: GenSym a -> GenSym b -> GenSym b

return :: a -> GenSym a

fail :: String -> GenSym a

Functor GenSym

Defined in Test.StateMachine.Types.GenSym

Methods

fmap :: (a -> b) -> GenSym a -> GenSym b

(<$) :: a -> GenSym b -> GenSym a

Applicative GenSym

Defined in Test.StateMachine.Types.GenSym

Methods

pure :: a -> GenSym a

(<*>) :: GenSym (a -> b) -> GenSym a -> GenSym b

liftA2 :: (a -> b -> c) -> GenSym a -> GenSym b -> GenSym c

(*>) :: GenSym a -> GenSym b -> GenSym b

(<*) :: GenSym a -> GenSym b -> GenSym a

genSym :: Typeable a => GenSym (Reference a Symbolic)

class CommandNames (cmd :: k -> Type) where

The names of all possible commands

This is used for things like tagging, coverage checking, etc.

Minimal complete definition

Nothing

Methods

cmdName :: cmd r -> String

Name of this particular command

cmdNames :: Proxy (cmd r) -> [String]

Name of all possible commands

cmdName :: (Generic1 cmd, CommandNames (Rep1 cmd)) => cmd r -> String

Name of this particular command

cmdNames :: forall r. CommandNames (Rep1 cmd) => Proxy (cmd r) -> [String]

Name of all possible commands

Instances

CommandNames (U1 :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: U1 r -> String

cmdNames :: Proxy (U1 r) -> [String]

CommandNames f => CommandNames (Rec1 f :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: Rec1 f r -> String

cmdNames :: Proxy (Rec1 f r) -> [String]

(CommandNames f, CommandNames g) => CommandNames (f :*: g :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: (f :*: g) r -> String

cmdNames :: Proxy ((f :*: g) r) -> [String]

(CommandNames f, CommandNames g) => CommandNames (f :+: g :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: (f :+: g) r -> String

cmdNames :: Proxy ((f :+: g) r) -> [String]

CommandNames (K1 i c :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: K1 i c r -> String

cmdNames :: Proxy (K1 i c r) -> [String]

CommandNames f => CommandNames (M1 S c f :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: M1 S c f r -> String

cmdNames :: Proxy (M1 S c f r) -> [String]

CommandNames f => CommandNames (M1 D c f :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: M1 D c f r -> String

cmdNames :: Proxy (M1 D c f r) -> [String]

Constructor c => CommandNames (M1 C c f :: k -> Type)

Defined in Test.StateMachine.ConstructorName

Methods

cmdName :: M1 C c f r -> String

cmdNames :: Proxy (M1 C c f r) -> [String]

module Test.StateMachine.Logic