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
use tracing::{debug, error, info};
mod macros;
#[derive(Debug)]
pub enum Error {
Io(std::io::Error),
ExitCode(i32),
Signal(i32),
NoExitCodeAndSignal,
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Error::Io(e) => write!(f, "I/O error: {e}"),
Error::ExitCode(exit_code) => write!(f, "Exit code: {exit_code}"),
Error::Signal(signal) => write!(f, "Signal: {signal}"),
Error::NoExitCodeAndSignal => write!(f, "No exit code and signal"),
}
}
}
impl std::error::Error for Error {}
impl From<std::io::Error> for Error {
fn from(e: std::io::Error) -> Self {
Error::Io(e)
}
}
pub type Result<T> = std::result::Result<T, Error>;
#[derive(Debug)]
struct Metadata<'a> {
env_key: &'a str,
program: &'a str,
args: &'a [&'a str],
}
#[cfg(windows)]
static DEFAULT_METADATA: Metadata = Metadata {
env_key: "COMSPEC",
program: "cmd.exe",
args: &["/D", "/S", "/C"],
};
#[cfg(unix)]
static DEFAULT_METADATA: Metadata = Metadata {
env_key: "SHELL",
program: "/bin/sh",
args: &["-c"],
};
fn parse_program() -> String {
std::env::var(DEFAULT_METADATA.env_key).unwrap_or_else(|e| {
debug!(
default_program = DEFAULT_METADATA.program,
env_key = DEFAULT_METADATA.env_key,
error = ?e,
"Failed to get shell environment variable, falling back to default program."
);
DEFAULT_METADATA.program.to_string()
})
}
/// Sheller is a builder for `std::process::Command` that sets the shell program and arguments.
///
/// Please see the `Sheller::new` method for more information.
#[derive(Debug)]
pub struct Sheller {
program: String,
args: Vec<&'static str>,
script: String,
}
impl Default for Sheller {
fn default() -> Self {
Self {
program: parse_program(),
args: DEFAULT_METADATA.args.into(),
script: String::new(),
}
}
}
impl Sheller {
/// Create a new `Sheller` with the given `script` and platform-specific defaults.
///
/// # Platform-specific defaults
///
/// ## Windows
///
/// When `target_family` is `windows`.
///
/// Set the `COMSPEC` environment variable to `program`, and if the environment variable is not set, use `cmd.exe` as the fallback program.
///
/// Also set the `args` to `["/D", "/S", "/C"]`.
///
/// ## Unix
///
/// When `target_family` is `unix`.
///
/// Set the `SHELL` environment variable to `program`, and if the environment variable is not set, use `/bin/sh` as the fallback program.
///
/// Also set the `args` to `["-c"]`.
///
/// # Arguments
///
/// * `script` - The shell script to run. This is dependent on the shell program.
///
/// # Examples
///
/// ```
/// use sheller::Sheller;
///
/// let mut command = Sheller::new("echo hello").build();
/// assert!(command.status().unwrap().success());
/// ```
#[must_use]
pub fn new<T>(script: T) -> Self
where
T: Into<String>,
{
Self {
script: script.into(),
..Default::default()
}
}
/// Returns `std::process::Command` with the shell program and arguments set.
///
/// # Examples
///
/// ```
/// use sheller::Sheller;
///
/// let mut command = Sheller::new("echo hello").build();
/// assert!(command.status().unwrap().success());
/// ```
#[must_use]
pub fn build(self) -> std::process::Command {
let mut command = std::process::Command::new(&self.program);
command.args(&self.args);
command.arg(self.script);
command
}
/// Run the shell command and panic if the command failed to run.
///
/// # Examples
/// ```
/// use sheller::{CommandExt, Sheller};
///
/// Sheller::new("echo hello").run();
/// ```
///
/// # Panics
/// Panics if the command failed to run.
pub fn run(self) {
self.build().run();
}
/// Run the shell command and return a `Result`.
///
/// # Examples
/// ```
/// use sheller::{CommandExt, Sheller};
///
/// Sheller::new("echo hello").try_run().unwrap();
/// ```
///
/// # Errors
/// Returns an `Err` if the command failed to run.
pub fn try_run(self) -> Result<()> {
self.build().try_run()
}
}
pub trait CommandExt {
/// Run the command and panic if the command failed to run.
///
/// # Examples
/// ```
/// use sheller::CommandExt;
/// use std::process::Command;
///
/// #[cfg(windows)]
/// fn example() {
/// let mut command = Command::new("cmd.exe");
/// command.args(["/D", "/S", "/C", "echo hello"]).run();
/// }
///
/// #[cfg(unix)]
/// fn example() {
/// let mut command = Command::new("echo");
/// command.arg("hello").run();
/// }
///
/// example();
/// ```
///
/// # Panics
/// Panics if the command failed to run.
fn run(&mut self);
/// Run the command and return a `Result`.
///
/// # Examples
/// ```
/// use sheller::CommandExt;
/// use std::process::Command;
///
/// #[cfg(windows)]
/// fn example() {
/// let mut command = Command::new("cmd.exe");
/// command
/// .args(["/D", "/S", "/C", "echo hello"])
/// .try_run()
/// .unwrap();
/// }
///
/// #[cfg(unix)]
/// fn example() {
/// let mut command = Command::new("echo");
/// command.arg("hello").try_run().unwrap();
/// }
///
/// example();
/// ```
///
/// # Errors
/// Returns an `Err` if the command failed to run.
fn try_run(&mut self) -> Result<()>;
}
#[cfg(unix)]
fn get_signal(a: std::process::ExitStatus) -> Option<i32> {
use std::os::unix::process::ExitStatusExt;
a.signal()
}
#[cfg(windows)]
fn get_signal(_: std::process::ExitStatus) -> Option<i32> {
None
}
impl CommandExt for std::process::Command {
/// Run the command and panic if the command failed to run.
///
/// # Examples
/// ```
/// use sheller::CommandExt;
/// use std::process::Command;
///
/// #[cfg(windows)]
/// fn example() {
/// let mut command = Command::new("cmd.exe");
/// command.args(["/D", "/S", "/C", "echo hello"]).run();
/// }
///
/// #[cfg(unix)]
/// fn example() {
/// let mut command = Command::new("echo");
/// command.arg("hello").run();
/// }
///
/// example();
/// ```
///
/// # Panics
/// Panics if the command failed to run.
fn run(&mut self) {
self.try_run().unwrap();
}
/// Run the command and return a `Result` with `Ok` if the command was successful, and `Err` if the command failed.
///
/// # Examples
/// ```
/// use sheller::CommandExt;
/// use std::process::Command;
///
/// #[cfg(windows)]
/// fn example() {
/// let mut command = Command::new("cmd.exe");
/// command
/// .args(["/D", "/S", "/C", "echo hello"])
/// .try_run()
/// .unwrap();
/// }
///
/// #[cfg(unix)]
/// fn example() {
/// let mut command = Command::new("echo");
/// command.arg("hello").try_run().unwrap();
/// }
///
/// example();
/// ```
///
/// # Errors
/// Returns an `Err` if the command failed to run.
fn try_run(&mut self) -> Result<()> {
info!(command = ?self, "Running command.");
let mut command = self.spawn().map_err(|e| {
error!(command = ?self, error = ?e, "Failed to spawn command.");
e
})?;
let status = command.wait().map_err(|e| {
error!(command = ?self, error = ?e, "Failed to wait for command.");
e
})?;
if let Some(exit_code) = status.code() {
if exit_code == 0 {
info!(command = ?self, "Succeeded to run command with zero exit code.");
Ok(())
} else {
error!(command = ?self, exit_code = ?exit_code, "Failed to run command with non-zero exit code.");
Err(Error::ExitCode(exit_code))
}
} else if let Some(signal) = get_signal(status) {
error!(command = ?self, signal = ?signal, "Failed to run command with signal.");
Err(Error::Signal(signal))
} else {
error!(command = ?self, "Failed to run command with no exit code and signal.");
Err(Error::NoExitCodeAndSignal)
}
}
}