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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
//! Extension trait to log properties of a command
//!
//! # Example
//!
//! ```rust
//! # use std::process::Command;
//! # use command_ext::{CommandExtLog, CommandWrap};
//! # use log::Level;
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let output = Command::new("echo")
//!     .arg("x")
//!     .log_args(Level::Debug)
//!     .log_status(Level::Info)
//!     .log_stdout(Level::Trace)
//!     .log_stderr(Level::Warn)
//!     .output()?;
//! # Ok(())
//! # }
//! ```

use log::{log, Level};
use std::{ffi::OsStr, process::Command};
use typed_builder::TypedBuilder;

use crate::{wrap::HasCommand, CommandWrap};
#[cfg(feature = "check")]
use crate::{CommandExtCheck, CommandExtError};

#[derive(TypedBuilder, Debug)]
pub struct CommandLog<'a> {
    command: &'a mut Command,
    #[builder(default, setter(into, strip_option))]
    /// The log level for args before execution
    args: Option<Level>,
    #[builder(default, setter(into, strip_option))]
    /// Whether to log the environment on execution
    envs: Option<Level>,
    #[builder(default, setter(into, strip_option))]
    /// Whether to log the current directory on execution
    current_dir: Option<Level>,
    #[builder(default, setter(into, strip_option))]
    /// Whether to log the status after execution
    status: Option<Level>,
    #[builder(default, setter(into, strip_option))]
    /// Whether to log stdout after execution
    stdout: Option<Level>,
    #[builder(default, setter(into, strip_option))]
    /// Whether to log stderr after execution
    stderr: Option<Level>,
}

impl<'a> CommandLog<'a> {
    fn log_before(&mut self) {
        if let Some(args) = self.args {
            log!(
                args,
                "args: {} {}",
                self.command().get_program().to_string_lossy(),
                self.command()
                    .get_args()
                    .collect::<Vec<_>>()
                    .join(OsStr::new(" "))
                    .to_string_lossy()
            );
        }

        if let Some(envs) = self.envs {
            self.command().get_envs().for_each(|(k, v)| {
                log!(
                    envs,
                    "envs: {}={}",
                    k.to_string_lossy(),
                    v.unwrap_or_default().to_string_lossy()
                );
            });
        }

        if let Some(current_dir) = self.current_dir {
            log!(
                current_dir,
                "current_dir: {}",
                self.command()
                    .get_current_dir()
                    .map(|d| d.to_string_lossy())
                    .unwrap_or_default()
            );
        }
    }
}

impl<'a> HasCommand for CommandLog<'a> {
    fn command(&self) -> &Command {
        self.command
    }

    fn command_mut(&mut self) -> &mut Command {
        self.command
    }
}

impl<'a> CommandWrap for CommandLog<'a> {
    fn on_spawn(&mut self) {
        self.log_before();
    }

    fn on_output(&mut self) {
        self.log_before();
    }

    fn on_status(&mut self) {
        self.log_before();
    }

    fn after_output(&mut self, output: &std::io::Result<std::process::Output>) {
        if let Ok(output) = output {
            if let Some(status) = self.status {
                log!(status, "status: {}", output.status);
            }
            if let Some(stdout) = self.stdout {
                let out = String::from_utf8_lossy(&output.stdout).trim().to_string();
                if !out.is_empty() {
                    log!(stdout, "stdout: {out}",);
                }
            }
            if let Some(stderr) = self.stderr {
                let err = String::from_utf8_lossy(&output.stderr).trim().to_string();
                if !err.is_empty() {
                    log!(stderr, "stderr: {err}",);
                }
            }
        }
    }

    fn after_status(&mut self, status: &std::io::Result<std::process::ExitStatus>) {
        if let Ok(status) = status {
            if let Some(status_filter) = self.status {
                log!(status_filter, "status: {}", status);
            }
        }
    }
}

impl<'a> From<&'a mut Command> for CommandLog<'a> {
    fn from(value: &'a mut Command) -> Self {
        Self::builder().command(value).build()
    }
}

pub trait CommandExtLog {
    fn log_args<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
    fn log_envs<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
    fn log_current_dir<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
    fn log_status<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
    fn log_stdout<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
    fn log_stderr<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>;
}

impl CommandExtLog for Command {
    fn log_args<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder().command(self).args(filter).build()
    }

    fn log_envs<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder().command(self).envs(filter).build()
    }

    fn log_current_dir<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder()
            .command(self)
            .current_dir(filter)
            .build()
    }

    fn log_status<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder().command(self).status(filter).build()
    }

    fn log_stdout<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder().command(self).stdout(filter).build()
    }

    fn log_stderr<L>(&mut self, filter: L) -> CommandLog
    where
        L: Into<Level>,
    {
        CommandLog::builder().command(self).stderr(filter).build()
    }
}

impl<'a> CommandLog<'a> {
    pub fn log_args<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.args = Some(filter.into());
        self
    }

    pub fn log_envs<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.envs = Some(filter.into());
        self
    }

    pub fn log_current_dir<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.current_dir = Some(filter.into());
        self
    }

    pub fn log_status<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.status = Some(filter.into());
        self
    }

    pub fn log_stdout<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.stdout = Some(filter.into());
        self
    }

    pub fn log_stderr<L>(&'a mut self, filter: L) -> &'a mut CommandLog
    where
        L: Into<Level>,
    {
        self.stderr = Some(filter.into());
        self
    }
}

#[cfg(feature = "check")]
impl<'a> CommandExtCheck for CommandLog<'a> {
    type Error = CommandExtError;

    fn check(&mut self) -> Result<std::process::Output, Self::Error> {
        self.output().map_err(CommandExtError::from).and_then(|r| {
            r.status
                .success()
                .then_some(r.clone())
                .ok_or_else(|| CommandExtError::Check {
                    status: r.status,
                    stdout: String::from_utf8_lossy(&r.stdout).to_string(),
                    stderr: String::from_utf8_lossy(&r.stderr).to_string(),
                })
        })
    }
}

#[cfg(test)]
mod test {
    use log::Level;
    use std::process::Command;
    use test_log::test;

    use crate::{CommandExtLog, CommandWrap};

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_args() -> anyhow::Result<()> {
        Command::new("echo")
            .arg("x")
            .log_args(Level::Error)
            .output()?;
        Ok(())
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_envs() -> anyhow::Result<()> {
        Command::new("echo")
            .env("x", "y")
            .log_envs(Level::Error)
            .output()?;
        Ok(())
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_current_dir() -> anyhow::Result<()> {
        Command::new("echo")
            .current_dir(env!("CARGO_MANIFEST_DIR"))
            .log_current_dir(Level::Error)
            .output()?;
        Ok(())
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_status() -> anyhow::Result<()> {
        Command::new("echo")
            .arg("x")
            .log_status(Level::Error)
            .output()?;

        Ok(())
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_stdout() -> anyhow::Result<()> {
        Command::new("echo")
            .arg("x")
            .log_stdout(Level::Error)
            .output()?;

        Ok(())
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_stderr() -> anyhow::Result<()> {
        Command::new("bash")
            .args(["-c", "echo y 1>&2"])
            .log_stderr(Level::Error)
            .output()?;

        Ok(())
    }
}