EVM.UnitTest

Documentation

data UnitTestOptions

Constructors

UnitTestOptions

Fields

• rpcInfo :: RpcInfo
• solvers :: SolverGroup
• verbose :: Maybe Int
• maxIter :: Maybe Integer
• askSmtIters :: Integer
• smtDebug :: Bool
• maxDepth :: Maybe Int
• smtTimeout :: Maybe Natural
• solver :: Maybe Text
• covMatch :: Maybe Text
• match :: Text
• fuzzRuns :: Int
• replay :: Maybe (Text, ByteString)
• vmModifier :: VM -> VM
• dapp :: DappInfo
• testParams :: TestVMParams
• ffiAllowed :: Bool

data TestVMParams

Constructors

TestVMParams

Fields

• address :: Addr
• caller :: Addr
• origin :: Addr
• gasCreate :: Word64
• gasCall :: Word64
• baseFee :: W256
• priorityFee :: W256
• balanceCreate :: W256
• coinbase :: Addr
• number :: W256
• timestamp :: W256
• gaslimit :: Word64
• gasprice :: W256
• maxCodeSize :: W256
• prevrandao :: W256
• chainId :: W256

defaultGasForCreating :: Word64

defaultGasForInvoking :: Word64

defaultBalanceForTestContract :: W256

defaultMaxCodeSize :: W256

type ABIMethod = Text

makeVeriOpts :: UnitTestOptions -> VeriOpts

Generate VeriOpts from UnitTestOptions

unitTest :: UnitTestOptions -> Contracts -> Maybe String -> IO Bool

Top level CLI endpoint for hevm test

initializeUnitTest :: UnitTestOptions -> SolcContract -> Stepper ()

Assuming a constructor is loaded, this stepper will run the constructor to create the test contract, give it an initial balance, and run `setUp()'.

runUnitTest :: UnitTestOptions -> ABIMethod -> AbiValue -> Stepper Bool

Assuming a test contract is loaded and initialized, this stepper will run the specified test method and return whether it succeeded.

execTestStepper :: UnitTestOptions -> ABIMethod -> AbiValue -> Stepper Bool

exploreStep :: UnitTestOptions -> ByteString -> Stepper Bool

checkFailures :: UnitTestOptions -> ABIMethod -> Bool -> Stepper Bool

fuzzTest :: UnitTestOptions -> Text -> [AbiType] -> VM -> Property

Randomly generates the calldata arguments and runs the test

tick :: Text -> IO ()

data OpLocation

This is like an unresolved source mapping.

Constructors

OpLocation

Fields

• srcContract :: Contract
• srcOpIx :: Int

Instances

Show OpLocation

Defined in EVM.UnitTest

Methods

showsPrec :: Int -> OpLocation -> ShowS

show :: OpLocation -> String

showList :: [OpLocation] -> ShowS

Eq OpLocation

Defined in EVM.UnitTest

Methods

(==) :: OpLocation -> OpLocation -> Bool

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

Ord OpLocation

Defined in EVM.UnitTest

Methods

compare :: OpLocation -> OpLocation -> Ordering

(<) :: OpLocation -> OpLocation -> Bool

(<=) :: OpLocation -> OpLocation -> Bool

(>) :: OpLocation -> OpLocation -> Bool

(>=) :: OpLocation -> OpLocation -> Bool

max :: OpLocation -> OpLocation -> OpLocation

min :: OpLocation -> OpLocation -> OpLocation

srcMapForOpLocation :: DappInfo -> OpLocation -> Maybe SrcMap

type CoverageState = (VM, MultiSet OpLocation)

currentOpLocation :: VM -> OpLocation

execWithCoverage :: StateT CoverageState IO VMResult

runWithCoverage :: StateT CoverageState IO VM

interpretWithCoverage :: UnitTestOptions -> Stepper a -> StateT CoverageState IO a

coverageReport :: DappInfo -> MultiSet SrcMap -> Map FilePath (Vector (Int, ByteString))

coverageForUnitTestContract :: UnitTestOptions -> Map Text SolcContract -> SourceCache -> (Text, [(Test, [AbiType])]) -> IO (MultiSet SrcMap)

runUnitTestContract :: UnitTestOptions -> Map Text SolcContract -> (Text, [(Test, [AbiType])]) -> IO [(Bool, VM)]

runTest :: UnitTestOptions -> VM -> (Test, [AbiType]) -> IO (Text, Either Text Text, VM)

type ExploreTx = (Addr, Addr, ByteString, W256)

decodeCalls :: ByteString -> [ExploreTx]

initialExplorationStepper :: UnitTestOptions -> ABIMethod -> [ExploreTx] -> [Addr] -> Int -> Stepper (Bool, RLP)

Runs an invariant test, calls the invariant before execution begins

explorationStepper :: UnitTestOptions -> ABIMethod -> [ExploreTx] -> [Addr] -> RLP -> Int -> Stepper (Bool, RLP)

getTargetContracts :: UnitTestOptions -> Stepper [Addr]

exploreRun :: UnitTestOptions -> VM -> ABIMethod -> [ExploreTx] -> IO (Text, Either Text Text, VM)

execTest :: UnitTestOptions -> VM -> ABIMethod -> AbiValue -> IO (Bool, VM)

runOne :: UnitTestOptions -> VM -> ABIMethod -> AbiValue -> IO (Text, Either Text Text, VM)

Define the thread spawner for normal test cases

fuzzRun :: UnitTestOptions -> VM -> Text -> [AbiType] -> IO (Text, Either Text Text, VM)

Define the thread spawner for property based tests

symRun :: UnitTestOptions -> VM -> Text -> [AbiType] -> IO (Text, Either Text Text, VM)

Define the thread spawner for symbolic tests

symFailure :: UnitTestOptions -> Text -> Expr Buf -> [AbiType] -> [(Expr End, SMTCex)] -> Text

prettyCalldata :: (?context :: DappContext) => SMTCex -> Expr Buf -> Text -> [AbiType] -> Text

showCalldata :: (?context :: DappContext) => SMTCex -> [AbiType] -> Expr Buf -> Text

showVal :: AbiValue -> Text

execSymTest :: UnitTestOptions -> ABIMethod -> (Expr Buf, [Prop]) -> Stepper (Expr End)

checkSymFailures :: UnitTestOptions -> Stepper VM

indentLines :: Int -> Text -> Text

passOutput :: VM -> UnitTestOptions -> Text -> Text

failOutput :: VM -> UnitTestOptions -> Text -> Text

formatTestLogs :: (?context :: DappContext) => Map W256 Event -> [Expr Log] -> Text

formatTestLog :: (?context :: DappContext) => Map W256 Event -> Expr Log -> Maybe Text

abiCall :: TestVMParams -> Either (Text, AbiValue) ByteString -> EVM ()

makeTxCall :: TestVMParams -> (Expr Buf, [Prop]) -> EVM ()

initialUnitTestVm :: UnitTestOptions -> SolcContract -> VM

getParametersFromEnvironmentVariables :: Maybe Text -> IO TestVMParams