Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Cleveland.Internal.Scenario

Synopsis

type Scenario m = MonadScenario m => Scenario' m
class MonadFail m => MonadScenario m where
- scenario :: ClevelandT m () -> Scenario' m
data Scenario' m where
- ScenarioEmulated :: EmulatedT PureM () -> Scenario' PureM
- ScenarioNetwork :: NetworkT ClientM () -> Scenario' ClientM
scenarioNetwork :: NetworkT ClientM () -> Scenario' ClientM
scenarioEmulated :: EmulatedT PureM () -> Scenario' PureM
withInitialNow :: Timestamp -> Scenario' PureM -> Scenario' PureM
withInitialLevel :: Natural -> Scenario' PureM -> Scenario' PureM
withMinBlockTime :: Natural -> Scenario' PureM -> Scenario' PureM
withChainId :: ChainId -> Scenario' PureM -> Scenario' PureM
withModifiedState :: (PureState -> PureState) -> Scenario' PureM -> Scenario' PureM

Documentation

type Scenario m = MonadScenario m => Scenario' m Source #

A convenience type synonym for Scenario' that has MonadScenario constraint baked in.

class MonadFail m => MonadScenario m where Source #

Typeclass for base monads that can implement a scenario.

Methods

scenario :: ClevelandT m () -> Scenario' m Source #

Finalize a generic cleveland scenario.

Instances

Instances details

MonadScenario ClientM Source #
Instance details Defined in Test.Cleveland.Internal.Scenario Methods scenario :: ClevelandT ClientM () -> Scenario' ClientM Source #
MonadScenario PureM Source #
Instance details Defined in Test.Cleveland.Internal.Scenario Methods scenario :: ClevelandT PureM () -> Scenario' PureM Source #

data Scenario' m where Source #

A type representing a finalized scenario. Usually, when using this type with a polymorphic argument, an additional MonadScenario constraint on the argument is required.

To avoid annotating with MonadScenario everywhere, consider using Scenario instead when possible.

Constructors

ScenarioEmulated :: EmulatedT PureM () -> Scenario' PureM
ScenarioNetwork :: NetworkT ClientM () -> Scenario' ClientM

scenarioNetwork :: NetworkT ClientM () -> Scenario' ClientM Source #

Finalize a scenario that needs network-only features.

scenarioEmulated :: EmulatedT PureM () -> Scenario' PureM Source #

Finalize a scenario that needs emulator-only features.

withInitialNow :: Timestamp -> Scenario' PureM -> Scenario' PureM Source #

Use with an emulated Scenario to configure the initial now value in tests.

Example : > testScenarioOnEmulator Testname $ withInitialNow (Timestamp 10000000) $ scenarioEmulated $ tests > testScenarioOnEmulator Testname $ withInitialNow (Timestamp 10000000) $ scenario $ tests

withInitialLevel :: Natural -> Scenario' PureM -> Scenario' PureM Source #

Similar to withInitialNow but for the initial level

withMinBlockTime :: Natural -> Scenario' PureM -> Scenario' PureM Source #

Similar to withInitialNow but for the MINIMAL_BLOCK_DELAY protocol constant.

withChainId :: ChainId -> Scenario' PureM -> Scenario' PureM Source #

Similar to withInitialNow but for the chain id

withModifiedState :: (PureState -> PureState) -> Scenario' PureM -> Scenario' PureM Source #