|
| 1 | +use std::{ |
| 2 | + collections::BTreeMap, |
| 3 | + ffi::{OsStr, OsString}, |
| 4 | + process::Command, |
| 5 | +}; |
| 6 | + |
| 7 | +#[derive(Debug)] |
| 8 | +pub struct CommandBuilder { |
| 9 | + program: OsString, |
| 10 | + argv: Vec<OsString>, |
| 11 | + envs: BTreeMap<OsString, OsString>, |
| 12 | + cwd: Option<OsString>, |
| 13 | +} |
| 14 | + |
| 15 | +impl CommandBuilder { |
| 16 | + pub fn new<S: AsRef<OsStr>>(program: S) -> Self { |
| 17 | + Self { |
| 18 | + program: program.as_ref().to_owned(), |
| 19 | + argv: Vec::new(), |
| 20 | + envs: BTreeMap::new(), |
| 21 | + cwd: None, |
| 22 | + } |
| 23 | + } |
| 24 | + |
| 25 | + pub fn build(self) -> Command { |
| 26 | + let mut command = Command::new(&self.program); |
| 27 | + command.args(&self.argv); |
| 28 | + command.envs(&self.envs); |
| 29 | + if let Some(cwd) = self.cwd { |
| 30 | + command.current_dir(cwd); |
| 31 | + } |
| 32 | + command |
| 33 | + } |
| 34 | + |
| 35 | + pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self { |
| 36 | + self.argv.push(arg.as_ref().to_owned()); |
| 37 | + self |
| 38 | + } |
| 39 | + |
| 40 | + pub fn args<I, S>(&mut self, args: I) -> &mut Self |
| 41 | + where |
| 42 | + I: IntoIterator<Item = S>, |
| 43 | + S: AsRef<OsStr>, |
| 44 | + { |
| 45 | + for arg in args { |
| 46 | + self.arg(arg.as_ref()); |
| 47 | + } |
| 48 | + self |
| 49 | + } |
| 50 | + |
| 51 | + pub fn current_dir<D>(&mut self, dir: D) |
| 52 | + where |
| 53 | + D: AsRef<OsStr>, |
| 54 | + { |
| 55 | + self.cwd = Some(dir.as_ref().to_owned()); |
| 56 | + } |
| 57 | + |
| 58 | + pub fn wrap<S, I, T>(&mut self, wrapper: S, wrapper_args: I) -> &mut Self |
| 59 | + where |
| 60 | + S: AsRef<OsStr>, |
| 61 | + I: IntoIterator<Item = T>, |
| 62 | + T: AsRef<OsStr>, |
| 63 | + { |
| 64 | + let mut new_argv = Vec::new(); |
| 65 | + |
| 66 | + // Add wrapper arguments first |
| 67 | + for arg in wrapper_args { |
| 68 | + new_argv.push(arg.as_ref().to_owned()); |
| 69 | + } |
| 70 | + |
| 71 | + // Add the current program |
| 72 | + new_argv.push(self.program.clone()); |
| 73 | + |
| 74 | + // Add the current arguments |
| 75 | + new_argv.extend(self.argv.iter().cloned()); |
| 76 | + |
| 77 | + // Update program to wrapper and argv to the new argument list |
| 78 | + self.program = wrapper.as_ref().to_owned(); |
| 79 | + self.argv = new_argv; |
| 80 | + self |
| 81 | + } |
| 82 | + |
| 83 | + pub fn wrap_with(&mut self, wrapper_cmd: CommandBuilder) -> &mut Self { |
| 84 | + let mut new_argv = Vec::new(); |
| 85 | + |
| 86 | + // Add wrapper command arguments first |
| 87 | + new_argv.extend(wrapper_cmd.argv.iter().cloned()); |
| 88 | + |
| 89 | + // Add the current program |
| 90 | + new_argv.push(self.program.clone()); |
| 91 | + |
| 92 | + // Add the current arguments |
| 93 | + new_argv.extend(self.argv.iter().cloned()); |
| 94 | + |
| 95 | + // Update program to wrapper and argv to the new argument list |
| 96 | + self.program = wrapper_cmd.program; |
| 97 | + self.argv = new_argv; |
| 98 | + // Update cwd if wrapper has it set |
| 99 | + self.cwd = wrapper_cmd.cwd.or(self.cwd.take()); |
| 100 | + // Merge environment variables, with wrapper's envs taking precedence |
| 101 | + self.envs.extend(wrapper_cmd.envs); |
| 102 | + self |
| 103 | + } |
| 104 | + |
| 105 | + /// Returns the command line as a string for debugging/testing purposes |
| 106 | + pub fn as_command_line(&self) -> String { |
| 107 | + let mut parts: Vec<String> = vec![self.program.to_string_lossy().into_owned()]; |
| 108 | + parts.extend( |
| 109 | + self.argv |
| 110 | + .iter() |
| 111 | + .map(|arg| arg.to_string_lossy().into_owned()), |
| 112 | + ); |
| 113 | + shell_words::join(parts) |
| 114 | + } |
| 115 | +} |
| 116 | + |
| 117 | +#[cfg(test)] |
| 118 | +mod tests { |
| 119 | + use super::*; |
| 120 | + |
| 121 | + #[test] |
| 122 | + fn test_wrap_with_args() { |
| 123 | + let mut builder = CommandBuilder::new("ls"); |
| 124 | + builder.arg("-la").wrap("sudo", ["-n"]); |
| 125 | + assert_eq!(builder.as_command_line(), "sudo -n ls -la"); |
| 126 | + } |
| 127 | + |
| 128 | + #[test] |
| 129 | + fn test_wrap_without_args() { |
| 130 | + let mut builder = CommandBuilder::new("ls"); |
| 131 | + builder.arg("-la").wrap("time", [] as [&str; 0]); |
| 132 | + assert_eq!(builder.as_command_line(), "time ls -la"); |
| 133 | + } |
| 134 | + |
| 135 | + #[test] |
| 136 | + fn test_multiple_wraps() { |
| 137 | + let mut builder = CommandBuilder::new("valgrind"); |
| 138 | + builder |
| 139 | + .arg("my-program") |
| 140 | + .wrap("setarch", ["x86_64", "-R"]) |
| 141 | + .wrap("sudo", ["-n"]); |
| 142 | + assert_eq!( |
| 143 | + builder.as_command_line(), |
| 144 | + "sudo -n setarch x86_64 -R valgrind my-program" |
| 145 | + ); |
| 146 | + } |
| 147 | + |
| 148 | + #[test] |
| 149 | + fn test_wrap_with_spaces() { |
| 150 | + let mut builder = CommandBuilder::new("echo"); |
| 151 | + builder.arg("hello world").wrap("bash", ["-c"]); |
| 152 | + assert_eq!(builder.as_command_line(), "bash -c echo 'hello world'"); |
| 153 | + } |
| 154 | + |
| 155 | + #[test] |
| 156 | + fn test_wrap_and_build() { |
| 157 | + let mut builder = CommandBuilder::new("ls"); |
| 158 | + builder.arg("-la").wrap("sudo", ["-n"]); |
| 159 | + |
| 160 | + let cmd = builder.build(); |
| 161 | + assert_eq!(cmd.get_program(), "sudo"); |
| 162 | + |
| 163 | + let args: Vec<_> = cmd.get_args().collect(); |
| 164 | + assert_eq!(args, vec!["-n", "ls", "-la"]); |
| 165 | + } |
| 166 | + |
| 167 | + #[test] |
| 168 | + fn test_wrap_with_builder() { |
| 169 | + let mut wrapper = CommandBuilder::new("sudo"); |
| 170 | + wrapper.arg("-n"); |
| 171 | + |
| 172 | + let mut builder = CommandBuilder::new("ls"); |
| 173 | + builder.arg("-la").wrap_with(wrapper); |
| 174 | + |
| 175 | + assert_eq!(builder.as_command_line(), "sudo -n ls -la"); |
| 176 | + } |
| 177 | + |
| 178 | + #[test] |
| 179 | + fn test_wrap_with_preserves_env() { |
| 180 | + let mut wrapper = CommandBuilder::new("env"); |
| 181 | + wrapper.arg("FOO=bar"); |
| 182 | + |
| 183 | + let mut builder = CommandBuilder::new("ls"); |
| 184 | + builder.arg("-la").wrap_with(wrapper); |
| 185 | + |
| 186 | + assert_eq!(builder.as_command_line(), "env 'FOO=bar' ls -la"); |
| 187 | + } |
| 188 | +} |
0 commit comments