Test.StateMachine.Sequential

This module contains helpers for generating, shrinking, and checking sequential programs.

Documentation

forAllCommands

Arguments

:: Testable prop

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

=> (Traversable cmd, Foldable resp)

=> StateMachine model cmd m resp

-> Maybe Int

Minimum number of commands.

-> (Commands cmd resp -> prop)

Predicate.

-> Property

existsCommands

Arguments

:: (Testable prop, Foldable resp)

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

=> StateMachine model cmd m resp

-> [model Symbolic -> Gen (cmd Symbolic)]

Generators.

-> (Commands cmd resp -> prop)

Predicate.

-> Property

Generate commands from a list of generators.

generateCommands

Arguments

:: (Foldable resp, Show (model Symbolic))

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

=> StateMachine model cmd m resp

-> Maybe Int

Minimum number of commands.

-> Gen (Commands cmd resp)

generateCommandsState

Arguments

:: Foldable resp

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

=> StateMachine model cmd m resp

-> Counter

-> Maybe Int

Minimum number of commands.

-> StateT (model Symbolic) Gen (Commands cmd resp)

deadlockError :: (Show (model Symbolic), Show (cmd Symbolic), Show (resp Symbolic)) => model Symbolic -> [Command cmd resp] -> String -> b

getUsedVars :: Foldable f => f Symbolic -> [Var]

shrinkCommands :: forall model cmd m resp. (Traversable cmd, Foldable resp) => StateMachine model cmd m resp -> Commands cmd resp -> [Commands cmd resp]

Shrink commands in a pre-condition and scope respecting way.

shrinkAndValidate :: forall model cmd m resp. (Traversable cmd, Foldable resp) => StateMachine model cmd m resp -> ShouldShrink -> ValidateEnv model -> Commands cmd resp -> [(ValidateEnv model, Commands cmd resp)]

Validate list of commands, optionally shrinking one of the commands

The input to this function is a list of commands (Commands), for example

[A, B, C, D, E, F, G, H]

The result is a list of Commands, i.e. a list of lists. The outermost list is used for all the shrinking possibilities. For example, let's assume we haven't shrunk something yet, and therefore need to shrink one of the commands. Let's further assume that only commands B and E can be shrunk, to B1, B2 and E1, E2, E3 respectively. Then the result will look something like

[    -- outermost list recording all the shrink possibilities
    [A', B1', C', D', E' , F', G', H']   -- B shrunk to B1
  , [A', B2', C', D', E' , F', G', H']   -- B shrunk to B2
  , [A', B' , C', D', E1', F', G', H']   -- E shrunk to E1
  , [A', B' , C', D', E2', F', G', H']   -- E shrunk to E2
  , [A', B' , C', D', E3', F', G', H']   -- E shrunk to E3
]

where one of the commands has been shrunk and all commands have been validated and renumbered (references updated). So, in this example, the result will contain at most 5 lists; it may contain fewer, since some of these lists may not be valid.

If we _did_ already shrink something, then no commands will be shrunk, and the resulting list will either be empty (if the list of commands was invalid) or contain a single element with the validated and renumbered commands.

data ValidateEnv model

Environment required during shrinkAndValidate

Constructors

ValidateEnv

Fields

• veModel :: model Symbolic

  The model we're starting validation from

• veScope :: Map Var Var

  Reference renumbering

  When a command

  Command .. [Var i, ..]

  is changed during validation to

  Command .. [Var j, ..]

  then any subsequent uses of Var i should be replaced by Var j. This is recorded in veScope. When we remove the first command altogether (during shrinking), then Var i won't appear in the veScope and shrank candidates that contain commands referring to Var i should be considered as invalid.

• veCounter :: Counter

  Counter (for generating new references)

data ShouldShrink

Constructors

MustShrink

DontShrink

initValidateEnv :: model Symbolic -> ValidateEnv model

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

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

getChanContents :: MonadIO m => TChan a -> m [a]

data Check

Constructors

CheckPrecondition

CheckEverything

CheckNothing

executeCommands :: (Show (cmd Concrete), Show (resp Concrete)) => (Traversable cmd, Foldable resp) => (MonadCatch m, MonadIO m) => StateMachine model cmd m resp -> TChan (Pid, HistoryEvent cmd resp) -> Pid -> Check -> Commands cmd resp -> StateT (Environment, model Symbolic, Counter, model Concrete) m Reason

prettyPrintHistory :: forall model cmd m resp. ToExpr (model Concrete) => (Show (cmd Concrete), Show (resp Concrete)) => StateMachine model cmd m resp -> History cmd resp -> IO ()

prettyPrintHistory' :: forall model cmd m resp tag. ToExpr (model Concrete) => (Show (cmd Concrete), Show (resp Concrete), ToExpr tag) => StateMachine model cmd m resp -> ([Event model cmd resp Symbolic] -> [tag]) -> Commands cmd resp -> History cmd resp -> IO ()

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

prettyCommands' :: (MonadIO m, ToExpr (model Concrete), ToExpr tag) => (Show (cmd Concrete), Show (resp Concrete)) => StateMachine model cmd m resp -> ([Event model cmd resp Symbolic] -> [tag]) -> Commands cmd resp -> History cmd resp -> Property -> PropertyM m ()

Variant of prettyCommands that also prints the tags covered by each command.

saveCommands :: (Show (cmd Symbolic), Show (resp Symbolic)) => FilePath -> Commands cmd resp -> Property -> Property

runSavedCommands :: (Show (cmd Concrete), Show (resp Concrete)) => (Traversable cmd, Foldable resp) => (MonadMask m, MonadIO m) => (Read (cmd Symbolic), Read (resp Symbolic)) => StateMachine model cmd m resp -> FilePath -> PropertyM m (Commands cmd resp, History cmd resp, model Concrete, Reason)

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

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

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

Fail if some commands have not been executed.

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

Print the percentage of each command used. The prefix check is an unfortunate remaining for backwards compatibility.

showLabelledExamples :: (Show tag, Show (model Symbolic)) => (Show (cmd Symbolic), Show (resp Symbolic)) => (Traversable cmd, Foldable resp) => StateMachine model cmd m resp -> ([Event model cmd resp Symbolic] -> [tag]) -> IO ()

showLabelledExamples'

Arguments

:: (Show tag, Show (model Symbolic))

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

=> (Traversable cmd, Foldable resp)

=> StateMachine model cmd m resp

-> Maybe Int

Seed

-> Int

Number of tests to run to find examples

-> ([Event model cmd resp Symbolic] -> [tag])

-> (tag -> Bool)

Tag filter (can be const True)

-> IO ()

Show minimal examples for each of the generated tags.