peace_item_spec_sh_cmd 0.0.9

Manages running a shell command for the peace framework
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

use std::{marker::PhantomData, process::Stdio};

use chrono::Utc;
use peace::cfg::State;
use tokio::process::Command;

use crate::{ShCmd, ShCmdError, ShCmdExecutionRecord, ShCmdState};

/// Common code to run `ShCmd`s.
#[derive(Debug)]
pub(crate) struct ShCmdExecutor<Id>(PhantomData<Id>);

impl<Id> ShCmdExecutor<Id> {
    /// Executes the provided `ShCmd` and returns execution information.
    pub async fn exec(
        sh_cmd: &ShCmd,
    ) -> Result<State<ShCmdState<Id>, ShCmdExecutionRecord>, ShCmdError> {
        let start_datetime = Utc::now();
        let mut command: Command = sh_cmd.into();
        let output = command
            .stdin(Stdio::null())
            .kill_on_drop(true)
            .output()
            .await
            .map_err(|error| {
                #[cfg(feature = "error_reporting")]
                let sh_cmd_string = format!("{sh_cmd}");

                ShCmdError::CmdExecFail {
                    sh_cmd: sh_cmd.clone(),
                    #[cfg(feature = "error_reporting")]
                    sh_cmd_string,
                    error,
                }
            })?;
        let end_datetime = Utc::now();

        let stdout = String::from_utf8(output.stdout).map_err(|from_utf8_error| {
            let stdout_lossy = String::from_utf8_lossy(from_utf8_error.as_bytes()).to_string();
            let error = from_utf8_error.utf8_error();
            #[cfg(feature = "error_reporting")]
            let invalid_span = {
                let start = error.valid_up_to();
                let len = error.error_len().unwrap_or(1);
                miette::SourceSpan::from((start, len))
            };

            ShCmdError::StdoutNonUtf8 {
                sh_cmd: sh_cmd.clone(),
                stdout_lossy,
                #[cfg(feature = "error_reporting")]
                invalid_span,
                error,
            }
        })?;

        let stderr = String::from_utf8(output.stderr)
            .map_err(|from_utf8_error| {
                let stderr_lossy = String::from_utf8_lossy(from_utf8_error.as_bytes()).to_string();
                let error = from_utf8_error.utf8_error();
                #[cfg(feature = "error_reporting")]
                let invalid_span = {
                    let start = error.valid_up_to();
                    let len = error.error_len().unwrap_or(1);
                    miette::SourceSpan::from((start, len))
                };

                ShCmdError::StderrNonUtf8 {
                    sh_cmd: sh_cmd.clone(),
                    stderr_lossy,
                    #[cfg(feature = "error_reporting")]
                    invalid_span,
                    error,
                }
            })?
            .trim()
            .to_string();

        Ok(State::new(
            ShCmdState::Some {
                stdout,
                stderr,
                marker: PhantomData,
            },
            ShCmdExecutionRecord::Some {
                start_datetime,
                end_datetime,
                exit_code: output.status.code(),
            },
        ))
    }
}