Skip to main content

FlakyRun

Struct FlakyRun 

Source
pub struct FlakyRun { /* private fields */ }
Expand description

Configuration for a flaky-test detection run.

§Example

use dev_flaky::FlakyRun;

let run = FlakyRun::new("my-crate", "0.1.0")
    .iterations(20)
    .workspace()
    .allow("known_flaky::flaky_under_load")
    .reliability_threshold(99.0);

let _result = run.execute().unwrap();

Implementations§

Source§

impl FlakyRun

Source

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Begin a new flaky-test run. Defaults to 10 iterations.

name and version are descriptive — they identify the subject in the produced Report.

Source

pub fn iterations(self, n: u32) -> Self

Set how many iterations to run. Clamped to a minimum of 2 — below 2, the stable / flaky distinction is meaningless.

Source

pub fn iteration_count(&self) -> u32

Configured iteration count.

Source

pub fn in_dir(self, dir: impl Into<PathBuf>) -> Self

Run cargo test from dir instead of the current directory.

Source

pub fn workspace(self) -> Self

Pass --workspace to every cargo test invocation.

Source

pub fn features(self, list: impl Into<String>) -> Self

Pass --features <list> to every cargo test invocation.

Source

pub fn test_filter(self, substring: impl Into<String>) -> Self

Restrict every iteration to tests whose name contains the given substring (passed as the libtest positional filter argument).

Source

pub fn allow(self, name: impl Into<String>) -> Self

Suppress a known-flaky test by name. Matches the full test path (module::path::test_name) as emitted by libtest.

Source

pub fn allow_all<I, S>(self, names: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Bulk version of allow.

Source

pub fn reliability_threshold(self, pct: f64) -> Self

Classify tests with reliability below pct as flaky even when they have zero failures across the run. The threshold is in [0.0, 100.0].

Without this setting, a test only becomes flaky if it has at least one failure. With reliability_threshold(99.0), tests passing fewer than 99% of iterations are flagged even if all iterations technically “passed” (this is a no-op as written; it lets the classification stay strict in future revisions that account for partial-pass criteria like sub-test runs).

Source

pub fn subject(&self) -> &str

Subject name passed in via new.

Source

pub fn subject_version(&self) -> &str

Subject version passed in via new.

Source

pub fn execute(&self) -> Result<FlakyResult, FlakyError>

Execute the run.

Invokes cargo test --no-fail-fast N times and accumulates per-test pass / fail / ignored counters. Subprocess failures (no cargo on PATH, etc.) surface as FlakyError::SubprocessFailed. Per-iteration test failures are the point of the run — they don’t error out the FlakyRun.

Trait Implementations§

Source§

impl Clone for FlakyRun

Source§

fn clone(&self) -> FlakyRun

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlakyRun

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.