toolproof 0.17.0

Standalone test suite for CLI tools and applications
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use async_trait::async_trait;

use crate::civilization::Civilization;
use crate::errors::ToolproofStepError;

use super::{SegmentArgs, ToolproofInstruction, ToolproofRetriever};

mod env_var {
    use super::*;

    pub struct EnvVar;

    inventory::submit! {
        &EnvVar as &dyn ToolproofInstruction
    }

    #[async_trait]
    impl ToolproofInstruction for EnvVar {
        fn segments(&self) -> &'static str {
            "I have the environment variable {name} set to {value}"
        }

        async fn run(
            &self,
            args: &SegmentArgs<'_>,
            civ: &mut Civilization,
        ) -> Result<(), ToolproofStepError> {
            let env_name = args.get_string("name")?;
            let env_value = args.get_string("value")?;

            civ.set_env(env_name.to_string(), env_value.to_string());

            Ok(())
        }
    }
}

mod run {
    use crate::errors::ToolproofTestFailure;

    use super::*;

    pub struct Run;

    inventory::submit! {
        &Run as &dyn ToolproofInstruction
    }

    #[async_trait]
    impl ToolproofInstruction for Run {
        fn segments(&self) -> &'static str {
            "I run {command}"
        }

        async fn run(
            &self,
            args: &SegmentArgs<'_>,
            civ: &mut Civilization,
        ) -> Result<(), ToolproofStepError> {
            let command = args.get_string("command")?;

            let exit_status = civ.run_command(command.to_string()).await?;

            if !exit_status.success() {
                return Err(ToolproofTestFailure::Custom {
                    msg: format!("Failed to run command ({})\nCommand: {command}\nstdout:\n---\n{}\n---\nstderr:\n---\n{}\n---",
                    exit_status,
                    civ.last_command_output.as_ref().map(|o| o.stdout.as_str()).unwrap_or_else(|| "<empty>"),
                    civ.last_command_output.as_ref().map(|o| o.stderr.as_str()).unwrap_or_else(|| "<empty>"),
                ),
                }
                .into());
            }

            Ok(())
        }
    }

    pub struct FailingRun;

    inventory::submit! {
        &FailingRun as &dyn ToolproofInstruction
    }

    #[async_trait]
    impl ToolproofInstruction for FailingRun {
        fn segments(&self) -> &'static str {
            "I run {command} and expect it to fail"
        }

        async fn run(
            &self,
            args: &SegmentArgs<'_>,
            civ: &mut Civilization,
        ) -> Result<(), ToolproofStepError> {
            let command = args.get_string("command")?;

            let exit_status = civ.run_command(command.to_string()).await?;

            if exit_status.success() {
                return Err(ToolproofTestFailure::Custom {
                    msg: format!(
                        "Command ran successfully, but should not have ({})\nCommand: {command}\nstdout:\n---\n{}\n---\nstderr:\n---\n{}\n---",
                        exit_status,
                        civ.last_command_output.as_ref().map(|o| o.stdout.as_str()).unwrap_or_else(|| "<empty>"),
                        civ.last_command_output.as_ref().map(|o| o.stderr.as_str()).unwrap_or_else(|| "<empty>"),
                    ),
                }
                .into());
            }

            Ok(())
        }
    }
}

mod stdio {
    use crate::errors::ToolproofTestFailure;

    use super::*;

    pub struct StdOut;

    inventory::submit! {
        &StdOut as &dyn ToolproofRetriever
    }

    #[async_trait]
    impl ToolproofRetriever for StdOut {
        fn segments(&self) -> &'static str {
            "stdout"
        }

        async fn run(
            &self,
            _args: &SegmentArgs<'_>,
            civ: &mut Civilization,
        ) -> Result<serde_json::Value, ToolproofStepError> {
            let Some(output) = &civ.last_command_output else {
                return Err(ToolproofStepError::Assertion(
                    ToolproofTestFailure::Custom {
                        msg: "no stdout exists".into(),
                    },
                ));
            };

            Ok(output.stdout.clone().into())
        }
    }

    pub struct StdErr;

    inventory::submit! {
        &StdErr as &dyn ToolproofRetriever
    }

    #[async_trait]
    impl ToolproofRetriever for StdErr {
        fn segments(&self) -> &'static str {
            "stderr"
        }

        async fn run(
            &self,
            _args: &SegmentArgs<'_>,
            civ: &mut Civilization,
        ) -> Result<serde_json::Value, ToolproofStepError> {
            let Some(output) = &civ.last_command_output else {
                return Err(ToolproofStepError::Assertion(
                    ToolproofTestFailure::Custom {
                        msg: "no stderr exists".into(),
                    },
                ));
            };

            Ok(output.stderr.clone().into())
        }
    }
}