Struct Test 

pub struct Test<'a> {
    pub result: bool,
    pub number: Option<i32>,
    pub description: Option<&'a str>,
    pub directive: Option<Directive<'a>>,
    pub yaml: Vec<&'a str>,
}

A Test declaring the result of some test-case.

Fields

result: bool

Result of the test.

number: Option<i32>

Number of the test.

description: Option<&'a str>

Description of the test.

directive: Option<Directive<'a>>

Directive detailing this tests meta-execution.

yaml: Vec<&'a str>

List of YAML lines detailing the test execution.

Implementations

impl<'a> Test<'a>

pub fn parse_from_str(content: &'a str) -> Result<Self>

Parse Test from a &str.

Examples

Parsing a TAP test may look like this:

use tapconsooomer::Test;

let content = "not ok 1 - foo()";
let test = Test::parse_from_str(content).expect("Parser error");
assert_eq!(test.result, false);
assert_eq!(test.number, Some(1));
assert_eq!(test.description, Some("foo()"));
assert_eq!(test.directive.is_none(), true);
assert_eq!(test.yaml.len(), 0);

Note, many attributes of a TAP test are optional. A minimal TAP test may look like this:

use tapconsooomer::Test;

let content = "ok";
let test = Test::parse_from_str(content).expect("Parser error");
assert_eq!(test.result, true);
assert_eq!(test.number, None);
assert_eq!(test.description, None);
assert_eq!(test.directive.is_none(), true);
assert_eq!(test.yaml.len(), 0);

TAP tests may also optionally contain a YAML block. While no parsing of actual YAML syntax is performed, the parser captures each line inside the YAML block in a Vec:

use tapconsooomer::Test;

let content = concat!(
    "not ok 2 - bar()\n",
    "  ---\n",
    "  message: invalid input\n",
    "  status: failed\n",
    "  ...\n",
);
let test = Test::parse_from_str(content).expect("Parser error");
assert_eq!(test.result, false);
assert_eq!(test.number, Some(2));
assert_eq!(test.description, Some("bar()"));
assert_eq!(test.directive.is_none(), true);
assert_eq!(test.yaml.len(), 2);
assert_eq!(test.yaml, ["message: invalid input", "status: failed"])

Trait Implementations

impl<'a> Debug for Test<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for Test<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.