Struct zebra_test::prelude::prop::test_runner::TestRunner

pub struct TestRunner {
    config: Config,
    successes: u32,
    local_rejects: u32,
    global_rejects: u32,
    rng: TestRng,
    flat_map_regens: Arc<AtomicUsize>,
    local_reject_detail: BTreeMap<Reason, u32>,
    global_reject_detail: BTreeMap<Reason, u32>,
}

State used when running a proptest test.

Fields

config: Config

successes: u32

local_rejects: u32

global_rejects: u32

rng: TestRng

flat_map_regens: Arc<AtomicUsize>

local_reject_detail: BTreeMap<Reason, u32>

global_reject_detail: BTreeMap<Reason, u32>

Implementations

impl TestRunner

pub fn new(config: Config) -> TestRunner

Create a fresh TestRunner with the given configuration.

The runner will use an RNG with a generated seed and the default algorithm.

In no_std environments, every TestRunner will use the same hard-coded seed. This seed is not contractually guaranteed and may be changed between releases without notice.

pub fn deterministic() -> TestRunner

Create a fresh TestRunner with the standard deterministic RNG.

This is sugar for the following:

let config = Config::default();
let algorithm = config.rng_algorithm;
TestRunner::new_with_rng(
    config,
    TestRng::deterministic_rng(algorithm));

Refer to TestRng::deterministic_rng() for more information on the properties of the RNG used here.

pub fn new_with_rng(config: Config, rng: TestRng) -> TestRunner

Create a fresh TestRunner with the given configuration and RNG.

pub fn rng(&mut self) -> &mut TestRng

Returns the RNG for this test run.

pub fn new_rng(&mut self) -> TestRng

Create a new, independent but deterministic RNG from the RNG in this runner.

pub fn config(&self) -> &Config

Returns the configuration of this runner.

pub fn bytes_used(&self) -> Vec<u8>

Dumps the bytes obtained from the RNG so far (only works if the RNG is set to Recorder).

Panics

Panics if the RNG does not capture generated data.

pub fn run<S>( &mut self, strategy: &S, test: impl Fn(<S as Strategy>::Value) -> Result<(), TestCaseError>, ) -> Result<(), TestError<<S as Strategy>::Value>>

where S: Strategy,

Run test cases against f, choosing inputs via strategy.

If any failure cases occur, try to find a minimal failure case and report that. If invoking f panics, the panic is turned into a TestCaseError::Fail.

If failure persistence is enabled, all persisted failing cases are tested first. If a later non-persisted case fails, its seed is persisted before returning failure.

Returns success or failure indicating why the test as a whole failed.

pub fn run_one<V>( &mut self, case: V, test: impl Fn(<V as ValueTree>::Value) -> Result<(), TestCaseError>, ) -> Result<bool, TestError<<V as ValueTree>::Value>>

where V: ValueTree,

Run one specific test case against this runner.

If the test fails, finds the minimal failing test case. If the test does not fail, returns whether it succeeded or was filtered out.

This does not honour the fork config, and will not be able to terminate the run if it runs for longer than timeout. However, if the test function returns but took longer than timeout, the test case will fail.

pub fn reject_local(&mut self, whence: impl Into<Reason>) -> Result<(), Reason>

Update the state to account for a local rejection from whence, and return Ok if the caller should keep going or Err to abort.

pub fn flat_map_regen(&self) -> bool

Increment the counter of flat map regenerations and return whether it is still under the configured limit.

Trait Implementations

impl Clone for TestRunner

fn clone(&self) -> TestRunner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestRunner

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

Formats the value using the given formatter.

impl Default for TestRunner

Equivalent to: TestRunner::new(Config::default()).

fn default() -> TestRunner

Returns the “default value” for a type.

impl Display for TestRunner

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

Formats the value using the given formatter.