ctrf-rs 0.2.0

A reporter for Common Test Report Format (CTRF) in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

// crate import(s)
use crate::{
    impl_extra,
    insights::test_insights::TestInsights,
    test::{attachment::Attachment, step::Step},
};

// std import(s)
use std::{collections::HashMap, path::PathBuf, time::Duration, vec};

// other import(s)
use serde::{Deserialize, Serialize};
use serde_json::Value;

pub mod attachment;
pub mod step;

/// Status indicator for a CTRF [`Test`] element.
/// Corresponds to the spec's ["Status"](https://www.ctrf.io/docs/specification/status) enumeration.
#[derive(Deserialize, Serialize, Clone, Copy, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum Status {
    /// The test has not yet executed or is awaiting fulfillment of some condition.
    Pending,
    /// The test was intentionally not executed.
    Skipped,
    /// The test executed but did not meet all success criteria.
    Failed,
    /// The test executed and met all success criteria.
    Passed,
    /// This is a catch-all for outcomes that do not align with any other pre-defined status.
    /// Typically indicative of a unique or library-specific status.
    Other,
}

/// Test element for a CTRF report.
/// Corresponds to the spec's ["Test"](https://www.ctrf.io/docs/specification/test) object.
#[derive(Deserialize, Serialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Test {
    name: String,
    status: Status,
    duration: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stop: Option<u64>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub suite: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trace: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub snippet: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ai: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw_status: Option<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub test_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_path: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub retries: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flaky: Option<bool>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub stdout: Vec<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub stderr: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub thread_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub browser: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub screenshot: Option<String>,
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub parameters: HashMap<String, Value>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub steps: Vec<Step>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<Attachment>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub insights: Option<TestInsights>,
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    extra: HashMap<String, Value>,
}

impl Test {
    /// Creates an instance of a `Test` with the provided arguments.
    /// For other fields, applies a vacant default (`None` or empty collection).
    pub fn new(name: String, status: Status, duration: Duration) -> Self {
        Self {
            name,
            status,
            duration: duration.as_millis() as u64,
            start: None,
            stop: None,
            suite: vec![],
            message: None,
            trace: None,
            snippet: None,
            ai: None,
            raw_status: None,
            tags: vec![],
            test_type: None,
            file_path: None,
            line: None,
            retries: None,
            flaky: None,
            stdout: vec![],
            stderr: vec![],
            thread_id: None,
            browser: None,
            device: None,
            screenshot: None,
            parameters: HashMap::new(),
            steps: vec![],
            attachments: vec![],
            insights: None,
            extra: HashMap::new(),
        }
    }

    /// Returns the `Test`'s contained `status` value
    pub fn status(&self) -> Status {
        self.status
    }
}

impl_extra!(Test);