Morley.Test.Integrational

Utilities for integrational testing. Example tests can be found in the 'morley-test' test suite.

Re-exports

data TxData

Data associated with a particular transaction.

Constructors

TxData

Fields

• tdSenderAddress :: !Address
• tdParameter :: !UntypedValue
• tdAmount :: !Mutez

Instances

Show ExpandedUExtInstr => Show TxData

Defined in Morley.Runtime.TxData

Methods

showsPrec :: Int -> TxData -> ShowS

show :: TxData -> String

showList :: [TxData] -> ShowS

Testing engine

type IntegrationalValidator = Either (InterpreterError -> Bool) SuccessValidator

Validator for integrational testing. If an error is expected, it should be Left with validator for errors. Otherwise it should check final global state and its updates.

type SuccessValidator = GState -> [GStateUpdate] -> Either Text ()

Validator for integrational testing that expects successful execution.

type IntegrationalScenario = IntegrationalScenarioM Validated

integrationalTestExpectation :: IntegrationalScenario -> Expectation

Integrational test that executes given operations and validates them using given validator. It can fail using Expectation capability. It starts with initGState and some reasonable dummy values for gas limit and current timestamp. You can update blockchain state by performing some operations.

integrationalTestProperty :: IntegrationalScenario -> Property

Integrational test similar to integrationalTestExpectation. It can fail using Property capability. It can be used with QuickCheck's forAll to make a property-based test with arbitrary data.

originate :: UntypedContract -> UntypedValue -> Mutez -> IntegrationalScenarioM Address

Originate a contract with given initial storage and balance. Its address is returned.

transfer :: TxData -> Address -> IntegrationalScenarioM ()

Transfer tokens to given address.

validate :: IntegrationalValidator -> IntegrationalScenario

Execute all operations that were added to the scenarion since last validate call. If validator fails, the execution will be aborted.

setMaxSteps :: RemainingSteps -> IntegrationalScenarioM ()

Make all further interpreter calls (which are triggered by the validate function) use given gas limit.

setNow :: Timestamp -> IntegrationalScenarioM ()

Make all further interpreter calls (which are triggered by the validate function) use given timestamp as the current one.

Validators

composeValidators :: SuccessValidator -> SuccessValidator -> SuccessValidator

Compose two success validators.

For example:

expectBalance bal addr composeValidators expectStorageUpdateConst addr2 ValueUnit

composeValidatorsList :: [SuccessValidator] -> SuccessValidator

Compose a list of success validators.

expectAnySuccess :: SuccessValidator

SuccessValidator that always passes.

expectStorageUpdate :: Address -> (UntypedValue -> Either Text ()) -> SuccessValidator

Check that storage value is updated for given address. Takes a predicate that is used to check the value.

It works even if updates are not filtered (i. e. a value can be updated more than once).

expectStorageUpdateConst :: Address -> UntypedValue -> SuccessValidator

Like expectStorageUpdate, but expects a constant.

expectBalance :: Address -> Mutez -> SuccessValidator

Check that eventually address has some particular balance.

expectStorageConst :: Address -> UntypedValue -> SuccessValidator

Check that eventually address has some particular storage value.

expectGasExhaustion :: InterpreterError -> Bool

Check that interpreter failed due to gas exhaustion.

expectMichelsonFailed :: Address -> InterpreterError -> Bool

Expect that interpretation of contract with given address ended with [FAILED].