Struct TestResult

pub struct TestResult {

    pub status: TestStatus,
    pub reason: Option<String>,
    pub counterexample: Option<CounterExample>,
    pub logs: Vec<Log>,
    pub decoded_logs: Vec<String>,
    pub kind: TestKind,
    pub traces: Traces,
    pub gas_report_traces: Vec<Vec<CallTraceArena>>,
    pub coverage: Option<HitMaps>,
    pub labeled_addresses: AddressHashMap<String>,
    pub duration: Duration,
    pub breakpoints: Breakpoints,
    pub gas_snapshots: BTreeMap<String, BTreeMap<String, String>>,
    pub deprecated_cheatcodes: HashMap<&'static str, Option<&'static str>>,
}

The result of an executed test.

Fields

status: TestStatus

The test status, indicating whether the test case succeeded, failed, or was marked as skipped. This means that the transaction executed properly, the test was marked as skipped with vm.skip(), or that there was a revert and that the test was expected to fail (prefixed with testFail)

reason: Option<String>

If there was a revert, this field will be populated. Note that the test can still be successful (i.e self.success == true) when it’s expected to fail.

counterexample: Option<CounterExample>

Minimal reproduction test case for failing test

logs: Vec<Log>

Any captured & parsed as strings logs along the test’s execution which should be printed to the user.

decoded_logs: Vec<String>

The decoded DSTest logging events and Hardhat’s console.log from logs. Used for json output.

kind: TestKind

What kind of test this was

traces: Traces

Traces

gas_report_traces: Vec<Vec<CallTraceArena>>

Additional traces to use for gas report.

coverage: Option<HitMaps>

Raw coverage info

labeled_addresses: AddressHashMap<String>

Labeled addresses

duration: Duration

breakpoints: Breakpoints

pc breakpoint char map

gas_snapshots: BTreeMap<String, BTreeMap<String, String>>

Any captured gas snapshots along the test’s execution which should be accumulated.

deprecated_cheatcodes: HashMap<&'static str, Option<&'static str>>

Deprecated cheatcodes (mapped to their replacements, if any) used in current test.

Implementations

impl TestResult

pub fn new(setup: TestSetup) -> Self

Creates a new test result starting from test setup results.

pub fn fail(reason: String) -> Self

Creates a failed test result with given reason.

pub fn setup_fail(setup: TestSetup) -> Self

Creates a failed test setup result.

pub fn single_skip(self, reason: SkipReason) -> Self

Returns the skipped result for single test (used in skipped fuzz test too).

pub fn single_fail(self, reason: Option<String>) -> Self

Returns the failed result with reason for single test.

pub fn single_result( self, success: bool, reason: Option<String>, raw_call_result: RawCallResult, ) -> Self

Returns the result for single test. Merges execution results (logs, labeled addresses, traces and coverages) in initial setup results.

pub fn fuzz_result(self, result: FuzzTestResult) -> Self

Returns the result for a fuzzed test. Merges fuzz execution results (logs, labeled addresses, traces and coverages) in initial setup results.

pub fn invariant_skip(self, reason: SkipReason) -> Self

Returns the skipped result for invariant test.

pub fn invariant_replay_fail( self, replayed_entirely: bool, invariant_name: &String, call_sequence: Vec<BaseCounterExample>, ) -> Self

Returns the fail result for replayed invariant test.

pub fn invariant_setup_fail(self, e: Report) -> Self

Returns the fail result for invariant test setup.

pub fn invariant_result( self, gas_report_traces: Vec<Vec<CallTraceArena>>, success: bool, reason: Option<String>, counterexample: Option<CounterExample>, cases: Vec<FuzzedCases>, reverts: usize, metrics: Map<String, InvariantMetrics>, ) -> Self

Returns the invariant test result.

pub fn is_fuzz(&self) -> bool

Returns true if this is the result of a fuzz test

pub fn short_result(&self, name: &str) -> String

Formats the test result into a string (for printing).

pub fn merge_call_result(&mut self, call_result: &RawCallResult)

Function to merge logs, addresses, traces and coverage from a call result into test result.

pub fn merge_coverages(&mut self, other_coverage: Option<HitMaps>)

Function to merge given coverage in current test result coverage.

Trait Implementations

impl Clone for TestResult

fn clone(&self) -> TestResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TestResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TestResult

fn default() -> TestResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TestResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TestResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for TestResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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: 624 bytes