Skip to main content

Module runner

Module runner 

Source
Expand description

The Forge test runner.

Re-exportsΒ§

use crate::MultiContractRunner; πŸ”’
use crate::TestFilter; πŸ”’
use crate::coverage::HitMaps; πŸ”’
use crate::fuzz::BaseCounterExample; πŸ”’
use crate::fuzz::FuzzTestResult; πŸ”’
use crate::multi_runner::FuzzMinimizeConfig; πŸ”’
use crate::multi_runner::FuzzMinimizeMode; πŸ”’
use crate::multi_runner::FuzzMinimizeObservation; πŸ”’
use crate::multi_runner::LibraryDeployment; πŸ”’
use crate::multi_runner::TestContract; πŸ”’
use crate::multi_runner::TestFunctionMatcher; πŸ”’
use crate::multi_runner::TestRunnerConfig; πŸ”’
use crate::multi_runner::is_generated_symbolic_regression_contract; πŸ”’
use crate::progress::TestsProgress; πŸ”’
use crate::result::InvariantFailure; πŸ”’
use crate::result::InvariantOutcome; πŸ”’
use crate::result::InvariantPredicateResult; πŸ”’
use crate::result::SetupOutcome; πŸ”’
use crate::result::SetupStorage; πŸ”’
use crate::result::SuiteResult; πŸ”’
use crate::result::SymbolicArtifactRef; πŸ”’
use crate::result::SymbolicCallTrace; πŸ”’
use crate::result::SymbolicCorpusSeedMetadata; πŸ”’
use crate::result::SymbolicCorpusSeedRef; πŸ”’
use crate::result::SymbolicCounterexample; πŸ”’
use crate::result::SymbolicCounterexampleArtifact; πŸ”’
use crate::result::SymbolicCounterexampleArtifactKind; πŸ”’
use crate::result::SymbolicCounterexampleCall; πŸ”’
use crate::result::SymbolicCounterexampleMinimization; πŸ”’
use crate::result::SymbolicCounterexampleReplaySemantics; πŸ”’
use crate::result::SymbolicCounterexampleTestIdentity; πŸ”’
use crate::result::SymbolicInvariantArtifactFailure; πŸ”’
use crate::result::SymbolicInvariantFailureSite; πŸ”’
use crate::result::SymbolicReplayMetadata; πŸ”’
use crate::result::SymbolicReplayStatus; πŸ”’
use crate::result::SymbolicResult; πŸ”’
use crate::result::TestKind; πŸ”’
use crate::result::TestResult; πŸ”’
use crate::result::TestSetup; πŸ”’
use crate::result::TestStatus; πŸ”’
use crate::result::invariant_campaign_display_name; πŸ”’
use crate::result::invariant_kind; πŸ”’
use crate::symbolic_minimizer::MinimizedSequence; πŸ”’
use crate::symbolic_minimizer::minimize_sequence_counterexample; πŸ”’
use crate::symbolic_minimizer::minimize_single_call_counterexample; πŸ”’
use alloy_dyn_abi::DynSolValue; πŸ”’
use alloy_dyn_abi::JsonAbiExt; πŸ”’
use alloy_json_abi::Function; πŸ”’
use alloy_json_abi::JsonAbi; πŸ”’
use alloy_json_abi::StateMutability; πŸ”’
use alloy_primitives::Address; πŸ”’
use alloy_primitives::B256; πŸ”’
use alloy_primitives::Bytes; πŸ”’
use alloy_primitives::I256; πŸ”’
use alloy_primitives::Selector; πŸ”’
use alloy_primitives::U256; πŸ”’
use alloy_primitives::address; πŸ”’
use alloy_primitives::hex; πŸ”’
use alloy_primitives::hex; πŸ”’
use alloy_primitives::keccak256; πŸ”’
use alloy_primitives::map::Entry; πŸ”’
use alloy_primitives::map::HashMap; πŸ”’
use alloy_primitives::map::HashSet; πŸ”’
use evm2::bytecode::Bytecode; πŸ”’
use evm2::evm::Cache; πŸ”’
use evm2::evm::InMemoryDB; πŸ”’
use evm2::interpreter::InstrStop; πŸ”’
use evm2::interpreter::op as opcode; πŸ”’
use eyre::Result; πŸ”’
use foundry_common::LIBRARY_DEPLOYER; πŸ”’
use foundry_common::TestFunctionExt; πŸ”’
use foundry_common::TestFunctionKind; πŸ”’
use foundry_common::contracts::ContractsByAddress; πŸ”’
use foundry_compilers::utils::canonicalized; πŸ”’
use foundry_config::Config; πŸ”’
use foundry_config::FuzzConfig; πŸ”’
use foundry_config::FuzzCorpusConfig; πŸ”’
use foundry_config::FuzzDictionaryConfig; πŸ”’
use foundry_config::InlineConfig; πŸ”’
use foundry_config::InvariantConfig; πŸ”’
use foundry_config::InvariantDepthMode; πŸ”’
use foundry_config::SymbolicConfig; πŸ”’
use foundry_evm::constants::CALLER; πŸ”’
use foundry_evm::constants::MAGIC_ASSUME; πŸ”’
use foundry_evm::core::evm::FoundryEvmNetwork; πŸ”’
use foundry_evm::decode::RevertDecoder; πŸ”’
use foundry_evm::decode::SkipReason; πŸ”’
use foundry_evm::executors::CallResult; πŸ”’
use foundry_evm::executors::DynamicTargetCtx; πŸ”’
use foundry_evm::executors::EvmError; πŸ”’
use foundry_evm::executors::Executor; πŸ”’
use foundry_evm::executors::ITest; πŸ”’
use foundry_evm::executors::InvariantReplayOptions; πŸ”’
use foundry_evm::executors::MinimizationReplayInput; πŸ”’
use foundry_evm::executors::RawCallResult; πŸ”’
use foundry_evm::executors::RawFailure; πŸ”’
use foundry_evm::executors::ShowmapOpts; πŸ”’
use foundry_evm::executors::ShowmapReplayTarget; πŸ”’
use foundry_evm::executors::StatelessReplayTarget; πŸ”’
use foundry_evm::executors::canonical_replay_dirs; πŸ”’
use foundry_evm::executors::fuzz::FuzzedExecutor; πŸ”’
use foundry_evm::executors::invariant::CandidateReplay; πŸ”’
use foundry_evm::executors::invariant::CheckSequenceFailureSite; πŸ”’
use foundry_evm::executors::invariant::CheckSequenceOptions; πŸ”’
use foundry_evm::executors::invariant::CheckSequenceOutcome; πŸ”’
use foundry_evm::executors::invariant::HandlerAssertionFailure; πŸ”’
use foundry_evm::executors::invariant::InvariantExecutor; πŸ”’
use foundry_evm::executors::invariant::InvariantFuzzError; πŸ”’
use foundry_evm::executors::invariant::LiveInvariantSolution; πŸ”’
use foundry_evm::executors::invariant::LiveInvariantSolver; πŸ”’
use foundry_evm::executors::invariant::ReplayErrorResult; πŸ”’
use foundry_evm::executors::invariant::apply_invariant_call_delay; πŸ”’
use foundry_evm::executors::invariant::check_sequence; πŸ”’
use foundry_evm::executors::invariant::deadline_passed; πŸ”’
use foundry_evm::executors::invariant::did_fail_on_assert; πŸ”’
use foundry_evm::executors::invariant::execute_and_commit_tx; πŸ”’
use foundry_evm::executors::invariant::execute_tx; πŸ”’
use foundry_evm::executors::invariant::execute_tx_and_register_created; πŸ”’
use foundry_evm::executors::invariant::handler_edge_fingerprint; πŸ”’
use foundry_evm::executors::invariant::replay_error; πŸ”’
use foundry_evm::executors::invariant::replay_handler_failure_sequence; πŸ”’
use foundry_evm::executors::invariant::replay_run; πŸ”’
use foundry_evm::executors::invariant::reset_shrink_progress; πŸ”’
use foundry_evm::executors::persist_corpus_seed; πŸ”’
use foundry_evm::executors::read_corpus_dir; πŸ”’
use foundry_evm::executors::replay_corpus_to_showmap; πŸ”’
use foundry_evm::executors::replay_sequence_for_minimization; πŸ”’
use foundry_evm::executors::should_ignore_revert; πŸ”’
use foundry_evm::fuzz::BasicTxDetails; πŸ”’
use foundry_evm::fuzz::CallDetails; πŸ”’
use foundry_evm::fuzz::CounterExample; πŸ”’
use foundry_evm::fuzz::FuzzFixtures; πŸ”’
use foundry_evm::fuzz::fixture_name; πŸ”’
use foundry_evm::fuzz::invariant::FuzzRunIdentifiedContracts; πŸ”’
use foundry_evm::fuzz::invariant::InvariantContract; πŸ”’
use foundry_evm::fuzz::invariant::InvariantSettings; πŸ”’
use foundry_evm::fuzz::invariant::SenderFilters; πŸ”’
use foundry_evm::fuzz::invariant::TargetedContracts; πŸ”’
use foundry_evm::fuzz::invariant::is_optimization_invariant; πŸ”’
use foundry_evm::fuzz::strategies::EvmFuzzState; πŸ”’
use foundry_evm::inspectors::CmpOperands; πŸ”’
use foundry_evm::inspectors::EdgeCovConfig; πŸ”’
use foundry_evm::inspectors::EdgeCovKind; πŸ”’
use foundry_evm::inspectors::cheatcodes::Vm::AccountAccess; πŸ”’
use foundry_evm::traces::TraceKind; πŸ”’
use foundry_evm::traces::TraceRequirements; πŸ”’
use foundry_evm::traces::load_contracts; πŸ”’
use foundry_evm_networks::NetworkVariant; πŸ”’
use foundry_evm_symbolic::ExecutorView; πŸ”’
use foundry_evm_symbolic::SYMBOLIC_VM_COMPAT_ADDRESS; πŸ”’
use foundry_evm_symbolic::SymbolicBranchTarget; πŸ”’
use foundry_evm_symbolic::SymbolicConcreteInput; πŸ”’
use foundry_evm_symbolic::SymbolicExecutor; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantCandidateInput; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantCounterexampleKind; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantRunInput; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantRunResult; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantStep; πŸ”’
use foundry_evm_symbolic::SymbolicInvariantTarget; πŸ”’
use foundry_evm_symbolic::SymbolicRunInput; πŸ”’
use foundry_evm_symbolic::SymbolicRunResult; πŸ”’
use foundry_evm_symbolic::SymbolicStats; πŸ”’
use foundry_evm_symbolic::SymbolicStopReason; πŸ”’
use foundry_evm_symbolic::SymbolicStorageAssignment; πŸ”’
use foundry_evm_symbolic::symbolic_vm_selectors; πŸ”’
use itertools::Itertools; πŸ”’
use proptest::test_runner::RngAlgorithm; πŸ”’
use proptest::test_runner::TestError; πŸ”’
use proptest::test_runner::TestRng; πŸ”’
use proptest::test_runner::TestRunner; πŸ”’
use serde::Deserialize; πŸ”’
use serde::Deserialize; πŸ”’
use serde::Serialize; πŸ”’
use serde::Serialize; πŸ”’
use std::borrow::Cow; πŸ”’
use std::collections::BTreeMap; πŸ”’
use std::ops::Deref; πŸ”’
use std::path::Path; πŸ”’
use std::path::PathBuf; πŸ”’
use std::sync::Arc; πŸ”’
use std::sync::Mutex; πŸ”’
use std::time::Instant; πŸ”’
use tokio::signal; πŸ”’
use tracing::Span; πŸ”’
use rayon::prelude::*; πŸ”’

StructsΒ§

ConfirmedFrontierInvariantFailure πŸ”’
An invariant failure confirmed while solving a captured fuzz frontier.
ContractRunner
A type that executes all tests of a contract
ContractRunnerContext πŸ”’
FunctionRunner πŸ”’
Executes a single test function, returning a TestResult.
FuzzBranchFrontierArtifact πŸ”’
FuzzBranchFrontierOperands πŸ”’
FuzzBranchFrontierRecord πŸ”’
FuzzBranchFrontierSite πŸ”’
InvariantCampaignScope πŸ”’
InvariantCampaignSelection πŸ”’
InvariantPersistedFailure πŸ”’
Holds data about a persisted invariant failure.
ReplayedInvariantSequence πŸ”’
A replayed and shrunk invariant counterexample.
SequenceArtifactSpec πŸ”’
Metadata for the symbolic artifact persisted with a replayed invariant sequence.
SequenceReplay πŸ”’
A stateful call sequence replay target shared by symbolic minimization and failure checks.
SymbolicHandlerReplayStorage πŸ”’
Symbolic storage assignments that only apply when replaying the exact recorded sequence.

EnumsΒ§

PersistedFingerprintProvenance πŸ”’
Reproducible edge-fingerprint algorithms and their capture configuration.
SequenceMinimization πŸ”’
How to report a failing invariant sequence, see FunctionRunner::minimize_invariant_sequence.

ConstantsΒ§

FUZZ_BRANCH_FRONTIER_FILE πŸ”’
FUZZ_BRANCH_FRONTIER_SCHEMA πŸ”’
STATEFUL_FUZZ_BRANCH_FRONTIER_SCHEMA πŸ”’

FunctionsΒ§

apply_symbolic_storage πŸ”’
Applies the setup storage of a symbolic counterexample. Arbitrary storage draws the modeled values instead of random ones, keeping its own rules for when a slot is drawn; other storage, such as under the generic layout, is written directly.
base_counterexample_to_tx πŸ”’
base_counterexamples πŸ”’
Converts campaign transactions into displayable counterexample calls.
base_counterexamples_to_txes πŸ”’
Converts a persisted counterexample to BasicTxDetails, setting show_solidity in place.
can_merge_invariant_suite πŸ”’
Returns whether predicates can share a concrete campaign. Symbolic execution checks one predicate at a time with its own symbolic configuration, result, and replay.
comparison_result πŸ”’
contract_short_name πŸ”’
Returns the contract name without the file path prefix.
corpus_has_entries πŸ”’
Returns whether any canonical replay directory under dir holds a corpus entry.
count_runnable_invariant_campaign_anchors πŸ”’
effective_test_function_kind πŸ”’
failed_invariant_calls πŸ”’
Returns the failing call sequence of a replayable invariant error.
frontier_comparison_flipped πŸ”’
frontier_filter_display πŸ”’
frontier_selector πŸ”’
function_matches_network_pass πŸ”’
fuzz_test_path_name πŸ”’
Returns a stable path component that distinguishes overloaded fuzz tests.
fuzzer_with_cases πŸ”’
handler_failure_file πŸ”’
inline_config_for πŸ”’
invariant_corpus_dir πŸ”’
Returns the corpus directory of a shared contract campaign or an isolated campaign.
invariant_failure_file πŸ”’
Returns the current invariant failure cache path.
invariant_frontier_dir πŸ”’
Returns the collision-free directory for one stateful frontier campaign.
invariant_handler_failure_name πŸ”’
invariant_suite_paths πŸ”’
Sets the invariant corpus directory and returns the contract-level failure directory.
legacy_fuzz_corpus_dir πŸ”’
Returns the legacy unqualified corpus when the qualified corpus has no entries.
minimized_reason πŸ”’
Returns the reason to show for a minimized sequence, whose values can differ from the campaign’s: the minimized replay’s reason when replaying the original sequence reproduced the campaign reason, otherwise the campaign reason.
narrow_generated_corpus_root πŸ”’
Narrows a generated corpus root to the per-test directory when it exists.
parse_frontier_selectors πŸ”’
persisted_call_sequence πŸ”’
Helper function to load failed call sequence from file. Ignores failure if generated with different invariant settings than the current ones.
persisted_invariant_failure πŸ”’
Loads a persisted invariant failure from the new cache path, falling back to the legacy path.
record_handler_failure πŸ”’
Persists a handler-side assertion bug with symbolic replay storage.
record_invariant_failure πŸ”’
Persists an invariant failure, with any symbolic replay storage and confirmed failure site.
replay_fuzz_minimize πŸ”’
Replays one corpus-minimization candidate and records its coverage observation.
replay_ran_out_of_gas πŸ”’
Returns whether a replay ran out of gas without failing an assertion first. The symbolic engine does not model gas, so such a halt is not the failure the solver model was found for. MemoryLimitOOG and InvalidOperandOOG are memory exceptions the engine does model.
replayed_memory_halt πŸ”’
Returns whether a replay ran out of gas at pc on a memory access that ends beyond memory_limit, the halt the symbolic engine modeled there.
same_sequence_failure πŸ”’
Returns true if two sequence replays failed in the same way at the same site.
sample_stateful_frontiers πŸ”’
sanitize_symbolic_artifact_component πŸ”’
select_context_diverse_frontiers πŸ”’
select_invariant_campaigns πŸ”’
select_stateful_frontiers πŸ”’
should_symbolically_import_fuzz_corpus πŸ”’
solve_live_invariant_frontier πŸ”’
Solves a live comparison from its concrete prefix. Only the campaign can turn the returned sequence into a reported failure or a coverage-winning corpus entry.
stable_hashed_component πŸ”’
svm_returns_exhausted πŸ”’
Returns whether a replay answered with svm_returns made an svm.* call past them. A test that clears mocked calls also clears the sequence, which only matters when it had returns.
symbolic_artifact_file_name πŸ”’
symbolic_invariant_counterexample_calls πŸ”’
symbolic_invariant_unsupported_domain_reason πŸ”’
test_paths πŸ”’
Helper function to set test corpus dir and to compose persisted failure paths.
warn_fork_block_mismatch πŸ”’
Warns when a persisted failure is replayed on a different fork block than it was recorded on. Returns whether the blocks differ.
warn_unimported_frontiers πŸ”’
Warns about requested frontier labels that the frontier file at path did not provide.

Type AliasesΒ§

HandlerFailureMap πŸ”’
Persisted handler-side assertion bugs keyed by (reverter, selector).
SequenceReasons πŸ”’
Failure reasons of replaying an original sequence and its minimized form.
SymbolicHandlerStorageMap πŸ”’
Symbolic replay storage for handler bugs keyed by (reverter, selector, fingerprint).