cradle 0.2.2

Execute child processes with ease
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

//! An internal module used for the outputs of child processes.

use crate::{
    collected_output::Waiter, config::Config, context::Context, error::Error, output::Output,
};
use std::{
    ffi::OsString,
    io::Write,
    process::{Command, ExitStatus, Stdio},
};

/// Internal type to capture all the outputs of a child process.
/// Usually you don't have to use this type directly.
///
/// See also the documentation for
/// [Custom `Output` impls](crate::Output#custom-output-impls).
#[derive(Clone, Debug)]
pub struct ChildOutput {
    pub(crate) stdout: Option<Vec<u8>>,
    pub(crate) stderr: Option<Vec<u8>>,
    pub(crate) exit_status: ExitStatus,
}

impl ChildOutput {
    pub(crate) fn run_child_process_output<Stdout, Stderr, T>(
        context: Context<Stdout, Stderr>,
        mut config: Config,
    ) -> Result<T, Error>
    where
        Stdout: Write + Clone + Send + 'static,
        Stderr: Write + Clone + Send + 'static,
        T: Output,
    {
        <T as Output>::configure(&mut config);
        let child_output = ChildOutput::run_child_process(context, &config)?;
        T::from_child_output(&config, &child_output)
    }

    fn run_child_process<Stdout, Stderr>(
        mut context: Context<Stdout, Stderr>,
        config: &Config,
    ) -> Result<Self, Error>
    where
        Stdout: Write + Clone + Send + 'static,
        Stderr: Write + Clone + Send + 'static,
    {
        let (executable, arguments) = Self::parse_input(config.arguments.clone())?;
        if config.log_command {
            writeln!(context.stderr, "+ {}", config.full_command())
                .map_err(|error| Error::command_io_error(config, error))?;
        }
        let mut command = Command::new(&executable);
        command.args(arguments);
        for (key, value) in &config.added_environment_variables {
            command.env(key, value);
        }
        command
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped());
        if let Some(working_directory) = &config.working_directory {
            command.current_dir(working_directory);
        }
        let mut child = command.spawn().map_err(|source| {
            if source.kind() == std::io::ErrorKind::NotFound {
                Error::FileNotFound { executable, source }
            } else {
                Error::command_io_error(config, source)
            }
        })?;
        let waiter = Waiter::spawn_standard_stream_relaying(
            &context,
            config,
            child.stdin.take().expect("child process should have stdin"),
            child
                .stdout
                .take()
                .expect("child process should have stdout"),
            child
                .stderr
                .take()
                .expect("child process should have stderr"),
        );
        let exit_status = child
            .wait()
            .map_err(|error| Error::command_io_error(config, error))?;
        let collected_output = waiter
            .join()
            .map_err(|error| Error::command_io_error(config, error))?;
        Self::check_exit_status(config, exit_status)?;
        Ok(Self {
            stdout: collected_output.stdout,
            stderr: collected_output.stderr,
            exit_status,
        })
    }

    fn parse_input(
        input: Vec<OsString>,
    ) -> Result<(OsString, impl Iterator<Item = OsString>), Error> {
        let mut words = input.into_iter();
        {
            match words.next() {
                None => Err(Error::NoExecutableGiven),
                Some(command) => Ok((command, words)),
            }
        }
    }

    fn check_exit_status(config: &Config, exit_status: ExitStatus) -> Result<(), Error> {
        if config.error_on_non_zero_exit_code && !exit_status.success() {
            Err(Error::NonZeroExitCode {
                full_command: config.full_command(),
                exit_status,
            })
        } else {
            Ok(())
        }
    }
}