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
use std::cell::{Ref, RefCell};
use std::ffi::{OsStr, OsString};
use std::marker::PhantomData;
use std::path::Path;
use std::process;
use std::rc::Rc;
use crate::errors::*;
pub trait CommandRunner {
type Command: Command;
fn build<S: AsRef<OsStr>>(&self, program: S) -> Self::Command;
}
pub trait Command {
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self;
fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut Self {
for arg in args {
self.arg(arg);
}
self
}
fn env<K, V>(&mut self, key: K, val: V) -> &mut Self
where
K: AsRef<OsStr>,
V: AsRef<OsStr>;
fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Self;
fn status(&mut self) -> Result<process::ExitStatus>;
fn exec(&mut self) -> Result<()> {
let status = self.status()?;
if status.success() {
Ok(())
} else {
Err(self.command_failed_error().into())
}
}
fn command_failed_error(&self) -> ErrorKind;
}
#[derive(Debug, Default)]
#[allow(missing_copy_implementations)]
pub struct OsCommandRunner {
#[doc(hidden)]
pub _nonexhaustive: PhantomData<()>,
}
impl OsCommandRunner {
pub fn new() -> OsCommandRunner {
OsCommandRunner {
_nonexhaustive: PhantomData,
}
}
}
impl CommandRunner for OsCommandRunner {
type Command = OsCommand;
fn build<S: AsRef<OsStr>>(&self, program: S) -> Self::Command {
let program = program.as_ref();
OsCommand {
command: process::Command::new(program),
arg_log: vec![program.to_owned()],
}
}
}
#[derive(Debug)]
pub struct OsCommand {
command: process::Command,
arg_log: Vec<OsString>,
}
impl Command for OsCommand {
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self {
let arg = arg.as_ref();
self.arg_log.push(arg.to_owned());
self.command.arg(arg);
self
}
fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut Self {
let args: Vec<_> = args.iter().map(|a| a.as_ref().to_owned()).collect();
self.arg_log.extend_from_slice(&args);
self.command.args(&args);
self
}
fn env<K, V>(&mut self, key: K, val: V) -> &mut Self
where
K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
self.command.env(key, val);
self
}
fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Self {
self.command.current_dir(dir);
self
}
fn status(&mut self) -> Result<process::ExitStatus> {
debug!("Running {:?}", &self.arg_log);
self.command
.status()
.chain_err(|| self.command_failed_error())
}
fn command_failed_error(&self) -> ErrorKind {
ErrorKind::CommandFailed(self.arg_log.clone())
}
}
#[test]
fn os_command_runner_runs_commands() {
let runner = OsCommandRunner::new();
assert!(runner.build("true").status().unwrap().success());
assert!(!runner.build("false").status().unwrap().success());
}
#[derive(Debug)]
pub struct TestCommandRunner {
cmds: Rc<RefCell<Vec<Vec<OsString>>>>,
}
impl TestCommandRunner {
pub fn new() -> TestCommandRunner {
TestCommandRunner {
cmds: Rc::new(RefCell::new(vec![])),
}
}
pub fn cmds(&self) -> Ref<'_, Vec<Vec<OsString>>> {
self.cmds.borrow()
}
}
impl Default for TestCommandRunner {
fn default() -> TestCommandRunner {
TestCommandRunner::new()
}
}
impl CommandRunner for TestCommandRunner {
type Command = TestCommand;
fn build<S: AsRef<OsStr>>(&self, program: S) -> Self::Command {
TestCommand {
cmd: vec![program.as_ref().to_owned()],
cmds: self.cmds.clone(),
}
}
}
#[derive(Debug)]
pub struct TestCommand {
cmd: Vec<OsString>,
cmds: Rc<RefCell<Vec<Vec<OsString>>>>,
}
impl TestCommand {
fn record_execution(&self) {
self.cmds.borrow_mut().push(self.cmd.clone());
}
}
impl Command for TestCommand {
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self {
self.cmd.push(arg.as_ref().to_owned());
self
}
fn env<K, V>(&mut self, _key: K, _val: V) -> &mut Self
where
K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
self
}
fn current_dir<P: AsRef<Path>>(&mut self, _dir: P) -> &mut Self {
self
}
fn status(&mut self) -> Result<process::ExitStatus> {
self.record_execution();
process::Command::new("true")
.status()
.chain_err(|| self.command_failed_error())
}
fn command_failed_error(&self) -> ErrorKind {
ErrorKind::CommandFailed(self.cmd.clone())
}
}
#[allow(unused_macros)]
macro_rules! assert_ran {
($runner:expr, { $( [ $($arg:expr),+ $(,)? ] ),* }) => {
use std::ops::Deref;
fn coerce<S: AsRef<::std::ffi::OsStr>>(s: S) ->
::std::ffi::OsString
{
s.as_ref().to_owned()
}
let expected = vec!( $( vec!( $( coerce($arg) ),+ ) ),* );
assert_eq!($runner.cmds().deref(), &expected);
};
}
#[test]
pub fn test_command_runner_logs_commands() {
let runner = TestCommandRunner::new();
let exit_code = runner
.build("git")
.args(&["clone", "https://github.com/torvalds/linux"])
.status()
.unwrap();
assert!(exit_code.success());
runner.build("echo").arg("a").arg("b").status().unwrap();
assert_ran!(runner, {
["git", "clone", "https://github.com/torvalds/linux"],
["echo", "a", "b"]
});
}