Struct quick_junit::TestSuite

#[non_exhaustive]
pub struct TestSuite {
    pub name: String,
    pub tests: usize,
    pub disabled: usize,
    pub errors: usize,
    pub failures: usize,
    pub timestamp: Option<DateTime<FixedOffset>>,
    pub time: Option<Duration>,
    pub test_cases: Vec<TestCase>,
    pub properties: Vec<Property>,
    pub system_out: Option<Output>,
    pub system_err: Option<Output>,
    pub extra: IndexMap<String, String>,
}

Represents a single TestSuite.

A TestSuite groups together several TestCase instances.

Fields (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.

name: String

The name of this TestSuite.

tests: usize

The total number of tests in this TestSuite.

disabled: usize

The total number of disabled tests in this TestSuite.

errors: usize

The total number of tests in this suite that errored.

An “error” is usually some sort of unexpected issue in a test.

failures: usize

The total number of tests in this suite that failed.

A “failure” is usually some sort of expected issue in a test.

timestamp: Option<DateTime<FixedOffset>>

The time at which the TestSuite began execution.

time: Option<Duration>

The overall time taken by the TestSuite.

test_cases: Vec<TestCase>

The test cases that form this TestSuite.

properties: Vec<Property>

Custom properties set during test execution, e.g. environment variables.

system_out: Option<Output>

Data written to standard output while the TestSuite was executed.

system_err: Option<Output>

Data written to standard error while the TestSuite was executed.

extra: IndexMap<String, String>

Other fields that may be set as attributes, such as “hostname” or “package”.

Implementations

impl TestSuite

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

Creates a new TestSuite.

pub fn set_timestamp(
    &mut self,
    timestamp: impl Into<DateTime<FixedOffset>>
) -> &mut Self

Sets the start timestamp for the TestSuite.

pub fn set_time(&mut self, time: Duration) -> &mut Self

Sets the time taken for the TestSuite.

pub fn add_property(&mut self, property: impl Into<Property>) -> &mut Self

Adds a property to this TestSuite.

pub fn add_properties(
    &mut self,
    properties: impl IntoIterator<Item = impl Into<Property>>
) -> &mut Self

Adds several properties to this TestSuite.

pub fn add_test_case(&mut self, test_case: TestCase) -> &mut Self

Adds a TestCase to this TestSuite and updates counts.

When generating a new report, use of this method is recommended over adding to self.test_cases directly.

pub fn add_test_cases(
    &mut self,
    test_cases: impl IntoIterator<Item = TestCase>
) -> &mut Self

Adds several TestCases to this TestSuite and updates counts.

When generating a new report, use of this method is recommended over adding to self.test_cases directly.

pub fn set_system_out(&mut self, system_out: impl AsRef<str>) -> &mut Self

Sets standard output.

pub fn set_system_out_lossy(
    &mut self,
    system_out: impl AsRef<[u8]>
) -> &mut Self

Sets standard output from a Vec<u8>.

The output is converted to a string, lossily.

pub fn set_system_err(&mut self, system_err: impl AsRef<str>) -> &mut Self

Sets standard error.

pub fn set_system_err_lossy(
    &mut self,
    system_err: impl AsRef<[u8]>
) -> &mut Self

Sets standard error from a Vec<u8>.

The output is converted to a string, lossily.

Trait Implementations

impl Clone for TestSuite

fn clone(&self) -> TestSuite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestSuite

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

Formats the value using the given formatter.