Michelson.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 :: Value
• tdEntrypoint :: EpName
• tdAmount :: Mutez

Instances

Eq TxData

Defined in Michelson.Runtime.TxData

Methods

(==) :: TxData -> TxData -> Bool

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

Show TxData

Defined in Michelson.Runtime.TxData

Methods

showsPrec :: Int -> TxData -> ShowS

show :: TxData -> String

showList :: [TxData] -> ShowS

ToJSON TxData

Defined in Michelson.Runtime.TxData

Methods

toJSON :: TxData -> Value

toEncoding :: TxData -> Encoding

toJSONList :: [TxData] -> Value

toEncodingList :: [TxData] -> Encoding

FromJSON TxData

Defined in Michelson.Runtime.TxData

Methods

parseJSON :: Value -> Parser TxData

parseJSONList :: Value -> Parser [TxData]

More genesis addresses which can be used in tests

genesisAddress :: Address

One of genesis addresses.

genesisAddress1 :: Address

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress2 :: Address

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress3 :: Address

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress4 :: Address

genesisAddress5 :: Address

genesisAddress6 :: Address

Testing engine

type IntegrationalScenarioM = StateT InternalState (Except ScenarioError)

A monad inside which integrational tests can be described using do-notation.

type IntegrationalScenario = IntegrationalScenarioM ()

data TestError

Constructors

InterpreterError IntegrationalExecutorError

UnexpectedInterpreterError Text IntegrationalExecutorError

UnexpectedTypeCheckError TCError

ExpectingInterpreterToFail

IncorrectUpdates TestError [GStateUpdate]

IncorrectStorageUpdate AddressName Text

InvalidStorage AddressName ExpectedStorage Text

StoragePredicateMismatch AddressName Text

InvalidBalance AddressName ExpectedBalance Text

UnexpectedUpdates (NonEmpty GStateUpdate)

ValidatingEmptyScenario

CustomTestError Text

Instances

Show TestError

Defined in Michelson.Test.Integrational

Methods

showsPrec :: Int -> TestError -> ShowS

show :: TestError -> String

showList :: [TestError] -> ShowS

Exception TestError

Defined in Michelson.Test.Integrational

Methods

toException :: TestError -> SomeException

fromException :: SomeException -> Maybe TestError

displayException :: TestError -> String

Buildable TestError

Defined in Michelson.Test.Integrational

Methods

build :: TestError -> Builder

integrationalTestExpectation :: HasCallStack => IntegrationalScenario -> Expectation

Integrational test that executes given operations and validates them. 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.

integrationalTestProp :: MonadTest m => IntegrationalScenario -> m ()

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

originate :: Contract -> Text -> Value -> Mutez -> IntegrationalScenarioM Address

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

tOriginate :: (ParameterScope cp, StorageScope st) => Contract cp st -> Text -> Value st -> Mutez -> IntegrationalScenarioM Address

Like originate, but for typed contract and value.

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

Transfer tokens to a given address.

tTransfer :: forall arg. ParameterScope arg => ("from" :! Address) -> ("to" :! Address) -> Mutez -> EpName -> Value arg -> IntegrationalScenarioM ()

Similar to transfer, for typed values. Note that it works with untyped Address and does not check that entrypoint with given name is present and has the expected type. Passed value must correspond to the entrypoint argument type, not the parameter type of the contract (and must be unit for implicit accounts).

integrationalFail :: TestError -> IntegrationalScenarioM anything

Just fail with given error.

unexpectedInterpreterError :: ExecutorError -> Text -> IntegrationalScenarioM a

Fail a test because an interpreter error happened unexpectedly, with the given reason.

setMaxSteps :: RemainingSteps -> IntegrationalScenarioM ()

Make all further interpreter calls use the given gas limit.

modifyNow :: (Timestamp -> Timestamp) -> IntegrationalScenarioM ()

Make all further interpreter calls use the modified timestamp as the current one.

setNow :: Timestamp -> IntegrationalScenarioM ()

Make all further interpreter calls use the given timestamp as the current one.

rewindTime :: Integer -> IntegrationalScenarioM ()

Increase current time by the given number of seconds.

withSender :: Address -> IntegrationalScenarioM a -> IntegrationalScenarioM a

Pretend that given address initiates all the transfers within the code block (i.e. SENDER instruction will return this address).

setChainId :: ChainId -> IntegrationalScenarioM ()

Make all further interpreter calls use the given chain id.

branchout :: HasCallStack => [(Text, IntegrationalScenario)] -> IntegrationalScenario

Execute multiple testing scenarios independently, basing them on scenario built till this point.

The following property holds for this function:

pre >> branchout [a, b, c] = branchout [pre >> a, pre >> b, pre >> c] .

In case of property failure in one of the branches no following branch is executed.

Providing empty list of scenarios to this function causes error; we do not require NonEmpty here though for convenience.

(?-) :: Text -> a -> (Text, a) infixr 0

Make a tuple with name without extra syntactic noise.

offshoot :: Text -> IntegrationalScenario -> IntegrationalScenario

Test given scenario with the state gathered till this moment; if this scenario passes, go on as if it never happened.

Validators

expectNoUpdates :: IntegrationalScenario

Check that there were no updates.

expectNoStorageUpdates :: IntegrationalScenario

Check that there were no storage updates.

expectStorageUpdate :: Address -> (Value -> Either TestError ()) -> IntegrationalScenario

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 -> Value -> IntegrationalScenario

Like expectStorageUpdate, but expects a constant.

expectBalance :: Address -> Mutez -> IntegrationalScenario

Check that eventually address has some particular balance.

expectStorage :: Address -> (Value -> Either TestError ()) -> IntegrationalScenario

Check that storage value satisfies the given predicate.

expectStorageConst :: Address -> Value -> IntegrationalScenario

Check that eventually address has some particular storage value.

tExpectStorageConst :: forall st. StorageScope st => Address -> Value st -> IntegrationalScenario

Similar to expectStorageConst, for typed stuff.

Errors

attempt :: IntegrationalScenarioM a -> IntegrationalScenarioM (Either ExecutorError a)

Attempt to run an action and return its result or, if interpretation fails, an error.

expectError :: IntegrationalScenarioM a -> IntegrationalScenarioM ExecutorError

Run an action that is expected to fail. If the action fails, the test succeeds and the error is returned. If the action succeeds, the test fails.

catchExpectedError :: IntegrationalScenarioM a -> (ExecutorError -> IntegrationalScenarioM b) -> IntegrationalScenarioM b

Run an action that is expected to fail.

In action catchExpectedError f: If the action fails, f is applied to the error. If the action succeeds, the test fails.

expectGasExhaustion :: ExecutorError -> IntegrationalScenario

Check that interpreter failed due to gas exhaustion.

expectMichelsonFailed :: (MichelsonFailed -> Bool) -> Address -> ExecutorError -> IntegrationalScenario

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

Lenses

isGState :: Lens' InternalState GState

Deprecated

integrationalTestProperty :: IntegrationalScenario -> Property

Deprecated: Use integrationalTestProp instead.

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.