Struct MultiContractRunner

pub struct MultiContractRunner {

    pub contracts: DeployableContracts,
    pub evm_opts: EvmOpts,
    pub env: Env,
    pub evm_spec: SpecId,
    pub revert_decoder: RevertDecoder,
    pub sender: Option<Address>,
    pub fork: Option<CreateFork>,
    pub config: Arc<Config>,
    pub coverage: bool,
    pub debug: bool,
    pub decode_internal: InternalTraceMode,
    pub test_options: TestOptions,
    pub isolation: bool,
    pub alphanet: bool,
    pub known_contracts: ContractsByArtifact,
    pub libs_to_deploy: Vec<Bytes>,
    pub libraries: Libraries,
}

A multi contract runner receives a set of contracts deployed in an EVM instance and proceeds to run all test functions in these contracts.

Fields

contracts: DeployableContracts

Mapping of contract name to JsonAbi, creation bytecode and library bytecode which needs to be deployed & linked against

evm_opts: EvmOpts

The EVM instance used in the test runner

env: Env

The configured evm

evm_spec: SpecId

The EVM spec

revert_decoder: RevertDecoder

Revert decoder. Contains all known errors and their selectors.

sender: Option<Address>

The address which will be used as the from field in all EVM calls

fork: Option<CreateFork>

The fork to use at launch

config: Arc<Config>

Project config.

coverage: bool

Whether to collect coverage info

debug: bool

Whether to collect debug info

decode_internal: InternalTraceMode

Whether to enable steps tracking in the tracer.

test_options: TestOptions

Settings related to fuzz and/or invariant tests

isolation: bool

Whether to enable call isolation

alphanet: bool

Whether to enable Alphanet features.

known_contracts: ContractsByArtifact

Known contracts linked with computed library addresses.

libs_to_deploy: Vec<Bytes>

Libraries to deploy.

libraries: Libraries

Library addresses used to link contracts.

Implementations

impl MultiContractRunner

pub fn matching_contracts<'a: 'b, 'b>( &'a self, filter: &'b dyn TestFilter, ) -> impl Iterator<Item = (&'a ArtifactId, &'a TestContract)> + 'b

Returns an iterator over all contracts that match the filter.

pub fn matching_test_functions<'a: 'b, 'b>( &'a self, filter: &'b dyn TestFilter, ) -> impl Iterator<Item = &'a Function> + 'b

Returns an iterator over all test functions that match the filter.

pub fn all_test_functions<'a: 'b, 'b>( &'a self, filter: &'b dyn TestFilter, ) -> impl Iterator<Item = &'a Function> + 'b

Returns an iterator over all test functions in contracts that match the filter.

pub fn list( &self, filter: &dyn TestFilter, ) -> BTreeMap<String, BTreeMap<String, Vec<String>>>

Returns all matching tests grouped by contract grouped by file (file -> (contract -> tests))

pub fn test_collect( &mut self, filter: &dyn TestFilter, ) -> BTreeMap<String, SuiteResult>

Executes all tests that match the given filter.

The same as test, but returns the results instead of streaming them.

Note that this method returns only when all tests have been executed.

pub fn test_iter( &mut self, filter: &dyn TestFilter, ) -> impl Iterator<Item = (String, SuiteResult)>

Executes all tests that match the given filter.

The same as test, but returns the results instead of streaming them.

Note that this method returns only when all tests have been executed.

pub fn test( &mut self, filter: &dyn TestFilter, tx: Sender<(String, SuiteResult)>, show_progress: bool, )

Executes all tests that match the given filter.

This will create the runtime based on the configured evm ops and create the Backend before executing all contracts and their tests in parallel.

Each Executor gets its own instance of the Backend.

fn run_test_suite( &self, artifact_id: &ArtifactId, contract: &TestContract, db: Backend, filter: &dyn TestFilter, tokio_handle: &Handle, progress: Option<&TestsProgress>, ) -> SuiteResult

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 2784 bytes