Test.Cleveland.Michelson.Internal.Entrypoints

Internal utilities for unit testing.

Documentation

type EPList = [(EpName, Ty)]

Convenience type synonym for a list of pairs of entrypoint names and types

newtype EPExpected a

Newtype wrapper for the expected value in entrypoint comparison

Constructors

EPExpected a

Instances

Eq a => Eq (EPExpected a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

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

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

Show a => Show (EPExpected a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

showsPrec :: Int -> EPExpected a -> ShowS

show :: EPExpected a -> String

showList :: [EPExpected a] -> ShowS

Buildable a => Buildable (EPExpected a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

build :: EPExpected a -> Builder

Buildable (EPExpected Ty, EPActual Ty)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

build :: (EPExpected Ty, EPActual Ty) -> Builder

newtype EPActual a

Newtype wrapper for the actual value in entrypoint comparison

Constructors

EPActual a

Instances

Eq a => Eq (EPActual a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

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

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

Show a => Show (EPActual a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

showsPrec :: Int -> EPActual a -> ShowS

show :: EPActual a -> String

showList :: [EPActual a] -> ShowS

Buildable a => Buildable (EPActual a)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

build :: EPActual a -> Builder

Buildable (EPExpected Ty, EPActual Ty)

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

build :: (EPExpected Ty, EPActual Ty) -> Builder

data EPMismatch

Entrypoint comparison mismatch report

Constructors

EPMismatch

Fields

• epmmExtra :: EPList

  Extraneous entrypoints, i.e. those that exist in the actual contract, but not in the specification

• epmmMissing :: EPList

  Missing entrypoints, i.e. those that exist in the specification, but not the actual contract

• epmmTypeMismatch :: [(EpName, (EPExpected Ty, EPActual Ty))]

  Entrypoints that exist in both the contract and the specification, but types do not match.

Bundled Patterns

pattern EPComparisonResultOK :: EPMismatch

A pattern syononym for no mismatches

Instances

Eq EPMismatch

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

(==) :: EPMismatch -> EPMismatch -> Bool

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

Show EPMismatch

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

showsPrec :: Int -> EPMismatch -> ShowS

show :: EPMismatch -> String

showList :: [EPMismatch] -> ShowS

Buildable EPMismatch

Defined in Test.Cleveland.Michelson.Internal.Entrypoints

Methods

build :: EPMismatch -> Builder

ignoreExtraEntrypoints :: EPMismatch -> EPMismatch

Ignore extraneous entrypoint names in EPMismatch. Essentially sets epmmExtra to [].

compareEntrypoints :: EPExpected (Map EpName Ty) -> EPActual (Map EpName Ty) -> EPMismatch

Compare two sets of entrypoints. Accepts ordered Maps to enforce sorting order.

contractMatchesEntrypoints :: Contract -> Map EpName Ty -> Either TCError EPMismatch

Check if the contract exactly matches the given entrypoints. Will report both missing and extraneous entrypoint names, and type mismatches.

contractCoversEntrypoints :: Contract -> Map EpName Ty -> Either TCError EPMismatch

Check if the contract contains the entrypoints given in spec (with matching types). Ignores any additional entrypoints present in the contract.

testContractEntrypoints :: (EPMismatch -> EPMismatch) -> TestName -> Contract -> Map EpName Ty -> TestTree

Expect the contract to match with the entrypoints given in spec (with matching types). Comparison is defined by the first argument; use ignoreExtraEntrypoints for cover test, id for match test.

Also tests if the same holds after Michelson and Micheline roundtrips of the contract.

assertEPComparisonSuccessful :: Either TCError EPMismatch -> Assertion

Turn Either TCError EPMismatch into an Assertion

michelsonRoundtripContract :: HasCallStack => Contract -> Contract

Round-trip the contract through Michelson text representation.

This is useful if you're intending to use the contract with Michelson text output and want to check if that output satisfies tests (which should be the same for internal representation and output, but bugs happen)

michelineRoundtripContract :: HasCallStack => Contract -> Contract

Round-trip the contract through Micheline JSON representation.

This is useful if you're intending to use the contract with Micheline JSON output and want to check if that output satisfies tests (which should be the same for internal representation and output, but bugs happen)