scrut 0.4.3

A simple and powerful test framework for CLI applications
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
139
140
141
142

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

use super::renderer::Renderer;
use crate::outcome::Outcome;

pub struct JsonRenderer(bool);

impl JsonRenderer {
    pub fn new(pretty: bool) -> Self {
        Self(pretty)
    }
}

impl Default for JsonRenderer {
    fn default() -> Self {
        Self::new(false)
    }
}

impl Renderer for JsonRenderer {
    fn render(&self, outcomes: &[&Outcome]) -> anyhow::Result<String> {
        if self.0 {
            serde_json::to_string_pretty(outcomes)
        } else {
            serde_json::to_string(outcomes)
        }
        .map_err(anyhow::Error::new)
    }
}

pub struct YamlRenderer;

impl YamlRenderer {
    pub fn new() -> Self {
        Self
    }
}

impl Default for YamlRenderer {
    fn default() -> Self {
        Self::new()
    }
}

impl Renderer for YamlRenderer {
    fn render(&self, outcomes: &[&Outcome]) -> anyhow::Result<String> {
        serde_yaml::to_string(outcomes).map_err(anyhow::Error::new)
    }
}

#[cfg(test)]
mod tests {
    use anyhow::Result;

    use super::JsonRenderer;
    use super::YamlRenderer;
    use crate::escaping::Escaper;
    use crate::outcome::Outcome;
    use crate::parsers::parser::ParserType;
    use crate::renderers::renderer::Renderer;
    use crate::testcase::TestCase;
    use crate::testcase::TestCaseError;

    #[test]
    fn test_json_render() {
        let renderer = JsonRenderer::default();
        let rendered = render(renderer).expect("rendering succeeds");
        insta::assert_snapshot!(rendered);
    }

    #[test]
    fn test_json_render_pretty() {
        let renderer = JsonRenderer::new(true);
        let rendered = render(renderer).expect("rendering succeeds");
        insta::assert_snapshot!(rendered);
    }

    #[test]
    fn test_yaml_render() {
        let renderer = YamlRenderer::new();
        let rendered = render(renderer).expect("rendering succeeds");
        insta::assert_snapshot!(rendered);
    }

    fn render<T: Renderer>(renderer: T) -> Result<String> {
        renderer.render(&[
            &Outcome {
                output: ("the stdout", "the stderr").into(),
                testcase: TestCase {
                    title: "the title".to_string(),
                    shell_expression: "the command".to_string(),
                    expectations: vec![],
                    exit_code: None,
                    line_number: 234,
                    ..Default::default()
                },
                location: None,
                result: Ok(()),
                escaping: Escaper::default(),
                format: ParserType::Markdown,
            },
            &Outcome {
                output: ("stdout 1", "stderr 1").into(),
                testcase: TestCase {
                    title: "the title 1".to_string(),
                    shell_expression: "the command 1".to_string(),
                    expectations: vec![],
                    exit_code: None,
                    line_number: 234,
                    ..Default::default()
                },
                location: Some("the location 1".to_string()),
                result: Ok(()),
                escaping: Escaper::default(),
                format: ParserType::Markdown,
            },
            &Outcome {
                output: ("stdout 2", "stderr 2").into(),
                testcase: TestCase {
                    title: "the title 2".to_string(),
                    shell_expression: "the command 2".to_string(),
                    expectations: vec![],
                    exit_code: None,
                    line_number: 234,
                    ..Default::default()
                },
                location: Some("the location 2".to_string()),
                result: Err(TestCaseError::InvalidExitCode {
                    actual: 123,
                    expected: 234,
                }),
                escaping: Escaper::default(),
                format: ParserType::Markdown,
            },
        ])
    }
}