FlakyTestAttributes

Struct FlakyTestAttributes 

Source
#[non_exhaustive]
pub struct FlakyTestAttributes {
Show 19 fields pub attempt_to_fix_id: Option<String>, pub codeowners: Option<Vec<String>>, pub envs: Option<Vec<String>>, pub first_flaked_branch: Option<String>, pub first_flaked_sha: Option<String>, pub first_flaked_ts: Option<i64>, pub flaky_category: Option<Option<String>>, pub flaky_state: Option<FlakyTestAttributesFlakyState>, pub last_flaked_branch: Option<String>, pub last_flaked_sha: Option<String>, pub last_flaked_ts: Option<i64>, pub module: Option<Option<String>>, pub name: Option<String>, pub pipeline_stats: Option<FlakyTestPipelineStats>, pub services: Option<Vec<String>>, pub suite: Option<String>, pub test_run_metadata: Option<FlakyTestRunMetadata>, pub test_stats: Option<FlakyTestStats>, pub additional_properties: BTreeMap<String, Value>, /* private fields */
}
Expand description

Attributes of a flaky test.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§attempt_to_fix_id: Option<String>

Unique identifier for the attempt to fix this flaky test. Use this ID in the Git commit message in order to trigger the attempt to fix workflow.

When the workflow is triggered the test is automatically retried by the tracer a certain number of configurable times. When all retries pass, the test is automatically marked as fixed in Flaky Test Management. Test runs are tagged with @test.test_management.attempt_to_fix_passed and @test.test_management.is_attempt_to_fix when the attempt to fix workflow is triggered.

§codeowners: Option<Vec<String>>

The name of the test’s code owners as inferred from the repository configuration.

§envs: Option<Vec<String>>

List of environments where this test has been flaky.

§first_flaked_branch: Option<String>

The branch name where the test exhibited flakiness for the first time.

§first_flaked_sha: Option<String>

The commit SHA where the test exhibited flakiness for the first time.

§first_flaked_ts: Option<i64>

Unix timestamp when the test exhibited flakiness for the first time.

§flaky_category: Option<Option<String>>

The category of a flaky test.

§flaky_state: Option<FlakyTestAttributesFlakyState>

The current state of the flaky test.

§last_flaked_branch: Option<String>

The branch name where the test exhibited flakiness for the last time.

§last_flaked_sha: Option<String>

The commit SHA where the test exhibited flakiness for the last time.

§last_flaked_ts: Option<i64>

Unix timestamp when the test exhibited flakiness for the last time.

§module: Option<Option<String>>

The name of the test module. The definition of module changes slightly per language:

  • In .NET, a test module groups every test that is run under the same unit test project.
  • In Swift, a test module groups every test that is run for a given bundle.
  • In JavaScript, the test modules map one-to-one to test sessions.
  • In Java, a test module groups every test that is run by the same Maven Surefire/Failsafe or Gradle Test task execution.
  • In Python, a test module groups every test that is run under the same .py file as part of a test suite, which is typically managed by a framework like unittest or pytest.
  • In Ruby, a test module groups every test that is run within the same test file, which is typically managed by a framework like RSpec or Minitest.
§name: Option<String>

The test name. A concise name for a test case. Defined in the test itself.

§pipeline_stats: Option<FlakyTestPipelineStats>

CI pipeline related statistics for the flaky test. This information is only available if test runs are associated with CI pipeline events from CI Visibility.

§services: Option<Vec<String>>

List of test service names where this test has been flaky.

A test service is a group of tests associated with a project or repository. It contains all the individual tests for your code, optionally organized into test suites, which are like folders for your tests.

§suite: Option<String>

The name of the test suite. A group of tests exercising the same unit of code depending on your language and testing framework.

§test_run_metadata: Option<FlakyTestRunMetadata>

Metadata about the latest failed test run of the flaky test.

§test_stats: Option<FlakyTestStats>

Test statistics for the flaky test.

§additional_properties: BTreeMap<String, Value>

Implementations§

Source§

impl FlakyTestAttributes

Source

pub fn new() -> FlakyTestAttributes

Source

pub fn attempt_to_fix_id(self, value: String) -> Self

Source

pub fn codeowners(self, value: Vec<String>) -> Self

Source

pub fn envs(self, value: Vec<String>) -> Self

Source

pub fn first_flaked_branch(self, value: String) -> Self

Source

pub fn first_flaked_sha(self, value: String) -> Self

Source

pub fn first_flaked_ts(self, value: i64) -> Self

Source

pub fn flaky_category(self, value: Option<String>) -> Self

Source

pub fn flaky_state(self, value: FlakyTestAttributesFlakyState) -> Self

Source

pub fn last_flaked_branch(self, value: String) -> Self

Source

pub fn last_flaked_sha(self, value: String) -> Self

Source

pub fn last_flaked_ts(self, value: i64) -> Self

Source

pub fn module(self, value: Option<String>) -> Self

Source

pub fn name(self, value: String) -> Self

Source

pub fn pipeline_stats(self, value: FlakyTestPipelineStats) -> Self

Source

pub fn services(self, value: Vec<String>) -> Self

Source

pub fn suite(self, value: String) -> Self

Source

pub fn test_run_metadata(self, value: FlakyTestRunMetadata) -> Self

Source

pub fn test_stats(self, value: FlakyTestStats) -> Self

Source

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations§

Source§

impl Clone for FlakyTestAttributes

Source§

fn clone(&self) -> FlakyTestAttributes

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlakyTestAttributes

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FlakyTestAttributes

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for FlakyTestAttributes

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for FlakyTestAttributes

Source§

fn eq(&self, other: &FlakyTestAttributes) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for FlakyTestAttributes

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FlakyTestAttributes

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,