Struct Report 

pub struct Report { /* private fields */ }

A report for a suite of tests.

The report is comprised of a few elements:

• The title of the test suite.
• The date that the test suite was run.
• The sections within the report.

Implementations

impl Report

pub fn title(&self) -> &str

Gets the title from the Report.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result)
    .try_build()?;

assert_eq!(report.title(), "Hello, world!");

pub fn date(&self) -> DateTime<Local>

Gets the date from the Report.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;
use chrono::Local;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result.clone())
    .try_build()?;

assert_eq!(
    Local::now().naive_local().date(),
    report.date().naive_local().date()
);

pub fn sections(&self) -> &NonEmpty<Section>

Gets the sections from a Report.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result.clone())
    .try_build()?;

assert_eq!(report.sections().len(), 1);
assert_eq!(report.sections().first().as_test_result().unwrap(), &result);

pub fn write_to<W: Write>(&self, writer: &mut W, config: &Config) -> Result<()>

Writes the report to a writer.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;
use bitbelay_report::Config;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result.clone())
    .try_build()?;

let mut buffer = Vec::new();
report.write_to(&mut buffer, &Config::default())?;

Trait Implementations

impl Debug for Report

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

Formats the value using the given formatter.