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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
/*
* Description: An async process creation framework. More of a utility
* library.
*
* Copyright (C) 2022 Danny McClanahan <dmcC2@hypnicjerk.ai>
* SPDX-License-Identifier: Apache-2.0
*/
//! An async process creation framework. More of a utility library.
//!
//! - *TODO: [`fs`] doesn't do much yet.*
//! - [`exe::Command`] covers all the configuration for a single process
//! invocation.
//! - [`base::CommandBase`] abstracts a process invocation which requires setup
//! work.
//! - [`sync`] and [`stream`] invoke processes "synchronously" or
//! "asynchronously".
//! - [`sh`] wraps a shell script invocation.
#![deny(rustdoc::missing_crate_level_docs)]
#![warn(missing_docs)]
/* Make all doctests fail if they produce any warnings. */
#![doc(test(attr(deny(warnings))))]
#![deny(clippy::all)]
#![allow(clippy::collapsible_else_if)]
#![allow(clippy::result_large_err)]
/// Representations of filesystem locations on the local host.
///
/// *TODO: currently these don't do any validation!*
pub mod fs {
use displaydoc::Display;
use std::path::PathBuf;
/// Trait for objects representing a handle to a filesystem path.
pub(crate) trait PathWrapper {
/// Consume this object and return a path.
fn into_path_buf(self) -> PathBuf;
}
/// @={0}
///
/// A path to a file that is assumed to already exist.
#[derive(Debug, Display, Clone)]
#[ignore_extra_doc_attributes]
pub struct File(pub PathBuf);
impl PathWrapper for File {
fn into_path_buf(self) -> PathBuf {
let Self(path) = self;
path
}
}
/// @<{0}
///
/// A path to a directory that is assumed to already exist.
#[derive(Debug, Display, Clone)]
#[ignore_extra_doc_attributes]
pub struct Directory(pub PathBuf);
impl PathWrapper for Directory {
fn into_path_buf(self) -> PathBuf {
let Self(path) = self;
path
}
}
}
/// Representations of executable files and methods to invoke them as async
/// processes.
pub mod exe {
use super::fs::{self, PathWrapper};
use displaydoc::Display;
use indexmap::IndexMap;
use once_cell::sync::Lazy;
use signal_hook::consts::{signal::*, TERM_SIGNALS};
use thiserror::Error;
use std::{
collections::VecDeque,
ffi::{OsStr, OsString},
io, iter,
os::unix::process::ExitStatusExt,
path::{Path, PathBuf},
process, str,
};
/// *{0}
///
/// A path to an executable file which is assumed to exist.
#[derive(Debug, Display, Clone)]
#[ignore_extra_doc_attributes]
pub struct Exe(pub fs::File);
impl<R: AsRef<OsStr>> From<&R> for Exe {
fn from(value: &R) -> Self {
let p = Path::new(value);
let f = fs::File(p.to_path_buf());
Self(f)
}
}
impl Default for Exe {
fn default() -> Self { Self(fs::File(PathBuf::default())) }
}
impl Exe {
/// This is the default state of the executable.
///
/// If an executable in this state is invoked, a panic will occur.
pub fn is_empty(&self) -> bool {
let Self(fs::File(exe)) = self;
exe.as_os_str().is_empty()
}
}
impl PathWrapper for Exe {
fn into_path_buf(self) -> PathBuf {
let Self(exe) = self;
exe.into_path_buf()
}
}
/// [{0:?}]
///
/// The command line to provide to the executable. Note that the complete
/// "argv" used by [`Command`] contains the executable path prefixed to
/// these arguments.
#[derive(Debug, Display, Clone, Default)]
#[ignore_extra_doc_attributes]
pub struct Argv(pub VecDeque<OsString>);
impl<R: AsRef<OsStr>, I: iter::IntoIterator<Item=R>> From<I> for Argv {
fn from(value: I) -> Self {
let argv: VecDeque<OsString> = value
.into_iter()
.map(|s| {
let s: &OsStr = s.as_ref();
s.to_os_string()
})
.collect();
Self(argv)
}
}
impl Argv {
/// If we're non-empty, prefix ourself with `--`.
pub fn trailing_args(mut self) -> Self {
if self.0.is_empty() {
Self(VecDeque::new())
} else {
self.unshift("--".into());
self
}
}
/// Prefix ourself with the given `leftmost_arg`.
pub fn unshift(&mut self, leftmost_arg: OsString) {
let Self(ref mut argv) = self;
argv.push_front(leftmost_arg);
}
}
/// [{0:?}]
///
/// Environment variables to set in the subprocess environment.
#[derive(Debug, Display, Clone, Default)]
#[ignore_extra_doc_attributes]
pub struct EnvModifications(pub IndexMap<OsString, OsString>);
impl<R: AsRef<OsStr>, I: iter::IntoIterator<Item=(R, R)>> From<I> for EnvModifications {
fn from(value: I) -> Self {
let env: IndexMap<OsString, OsString> = value
.into_iter()
.map(|(k, v)| {
let k: &OsStr = k.as_ref();
let v: &OsStr = v.as_ref();
(k.to_os_string(), v.to_os_string())
})
.collect();
Self(env)
}
}
/// <exe={exe}, wd={wd:?}, argv={argv}, env={env}>
///
/// Request to execute a subprocess. See [`crate::sync`] and [`crate::stream`]
/// for examples of invocation.
#[derive(Debug, Display, Clone, Default)]
#[ignore_extra_doc_attributes]
pub struct Command {
/// Executable name, which may be absolute or relative to `$PATH` entries.
pub exe: Exe,
/// The working directory for the child process; otherwise, the working
/// directory is inherited from the parent process.
pub wd: Option<fs::Directory>,
/// Arguments to pass to the executable. These should *not* be quoted at
/// all.
pub argv: Argv,
/// Any new environment variables to set within the child process. The
/// environment is otherwise inherited from the parent.
pub env: EnvModifications,
}
impl Command {
pub(crate) fn command(self) -> async_process::Command {
dbg!(&self);
let Self {
exe,
wd,
argv,
env: EnvModifications(env),
} = self;
if exe.is_empty() {
unreachable!(
"command was executed before .exe was set; this can only occur using ::default()"
);
}
let mut command = async_process::Command::new(exe.into_path_buf());
if let Some(wd) = wd {
command.current_dir(wd.into_path_buf());
}
command.args(argv.0);
for (var, val) in env.into_iter() {
command.env(&var, &val);
}
command
}
/// Make this command execute the `new_exe` binary instead, shifting all
/// args one to the right.
pub fn unshift_new_exe(&mut self, new_exe: Exe) {
if new_exe.is_empty() {
unreachable!("new_exe is an empty string!! self was: {:?}", self);
}
let mut argv = self.argv.clone();
if !self.exe.is_empty() {
argv.unshift(self.exe.clone().into_path_buf().as_os_str().to_os_string());
}
self.argv = argv;
self.exe = new_exe;
}
pub(crate) fn unshift_shell_script(&mut self, script_path: Exe) {
self.unshift_new_exe(script_path);
self.unshift_new_exe(Exe(fs::File(PathBuf::from("sh"))));
}
}
/// Errors that can occur when executing command lines.
#[derive(Debug, Display, Error)]
pub enum CommandError {
/// a command line exited with non-zero status {0}
NonZeroExit(i32),
/// a command line exited with termination signal {0} ({1})
ProcessTerminated(i32, &'static str),
/// a command line exited with non-termination signal {0} ({1})
ProcessKilled(i32, &'static str),
/// i/o error invoking command line: {0}
Io(#[from] io::Error),
/// utf-8 decoding error for command line: {0}
Utf8(#[from] str::Utf8Error),
}
macro_rules! signal_pairs {
($($name:ident),+) => {
[$(($name, stringify!($name))),+]
}
}
static SIGNAL_NAMES: Lazy<IndexMap<i32, &'static str>> = Lazy::new(|| {
signal_pairs![
SIGABRT, SIGALRM, SIGBUS, SIGCHLD, SIGCONT, SIGFPE, SIGHUP, SIGILL, SIGINT, SIGIO, SIGKILL,
SIGPIPE, SIGPROF, SIGQUIT, SIGSEGV, SIGSTOP, SIGSYS, SIGTERM, SIGTRAP, SIGTSTP, SIGTTIN,
SIGTTOU, SIGURG, SIGUSR1, SIGUSR2, SIGVTALRM, SIGWINCH, SIGXCPU, SIGXFSZ
]
.into()
});
impl CommandError {
/// Raise an error if the process exited with any type of failure.
pub fn analyze_exit_status(status: process::ExitStatus) -> Result<(), Self> {
if let Some(code) = status.code() {
if code == 0 {
Ok(())
} else {
Err(Self::NonZeroExit(code))
}
} else if let Some(signal) = status.signal() {
let name = SIGNAL_NAMES.get(&signal).unwrap();
Err(if TERM_SIGNALS.contains(&signal) {
Self::ProcessTerminated(signal, name)
} else {
Self::ProcessKilled(signal, name)
})
} else {
unreachable!("status {:?} had no exit code or signal", status)
}
}
pub(crate) fn command_with_context(
self,
command: Command,
context: String,
) -> CommandErrorWrapper {
CommandErrorWrapper {
command,
context,
error: self,
}
}
}
/// command {command:?} failed ({context}): {error}
#[derive(Debug, Display, Error)]
pub struct CommandErrorWrapper {
/// The command that attempted to be executed.
pub command: Command,
/// Additional information about where the error occurred.
pub context: String,
/// The underlying error.
#[source]
pub error: CommandError,
}
}
/// Extend the concept of a "process" to include setup, to enable abstraction.
pub mod base {
use super::*;
use displaydoc::Display;
use thiserror::Error;
use std::io;
/// Errors which may occur during the execution of
/// [`CommandBase::setup_command`].
#[derive(Debug, Display, Error)]
pub enum SetupError {
/// inner error: {0}
Inner(#[source] Box<SetupErrorWrapper>),
/// i/o error: {0}
Io(#[from] io::Error),
}
impl SetupError {
/// Wrap a raw error with `context` to produced a wrapped error.
pub fn with_context(self, context: String) -> SetupErrorWrapper {
SetupErrorWrapper {
context,
error: self,
}
}
}
/// setup error ({context}): {error}
#[derive(Debug, Display, Error)]
pub struct SetupErrorWrapper {
/// Additional information about where the error occurred.
pub context: String,
/// The underlying error.
#[source]
pub error: SetupError,
}
/// Declare higher-level operations which desugar to command lines by
/// implementing this trait.
pub trait CommandBase {
/// Generate a command line from the given object.
#[allow(async_fn_in_trait)]
async fn setup_command(self) -> Result<exe::Command, SetupError>;
}
}
/// Methods to execute a process "synchronously", i.e. waiting until it has
/// exited.
///
///```
/// # tokio_test::block_on(async {
/// use std::path::PathBuf;
/// use super_process::{fs, exe, sync::SyncInvocable};
///
/// let command = exe::Command {
/// exe: exe::Exe(fs::File(PathBuf::from("echo"))),
/// argv: ["hey"].as_ref().into(),
/// ..Default::default()
/// };
///
/// // Spawn the child process and wait for it to end.
/// let output = command.clone().invoke().await.expect("sync subprocess failed");
/// // Parse stdout into utf8...
/// let hey = output.decode(command).expect("utf8 decoding failed").stdout
/// // ...and strip the trailing newline.
/// .strip_suffix("\n")
/// .expect("trailing newline not found");
/// assert_eq!(hey, "hey");
/// # }) // async
/// ```
pub mod sync {
use super::exe;
use std::{process, str};
/// The slurped streams for a synchronously-invoked process, as raw bytes.
#[derive(Debug, Clone)]
#[allow(missing_docs)]
pub struct RawOutput {
pub stdout: Vec<u8>,
pub stderr: Vec<u8>,
}
impl RawOutput {
/// Parse the process's exit status with
/// [`exe::CommandError::analyze_exit_status`].
pub fn extract(
command: exe::Command,
output: process::Output,
) -> Result<Self, exe::CommandErrorWrapper> {
let process::Output {
status,
stdout,
stderr,
} = output;
let output = Self { stdout, stderr };
if let Err(e) = exe::CommandError::analyze_exit_status(status) {
let output_msg: String = match output.decode(command.clone()) {
Ok(decoded) => format!("(utf-8 decoded) {:?}", decoded),
Err(_) => format!("(could not decode) {:?}", &output),
};
return Err(e.command_with_context(
command,
format!("when analyzing exit status for output {}", output_msg),
));
}
Ok(output)
}
/// Decode the output streams of this process, with the invoking `command`
/// provided for error context.
pub fn decode(
&self,
command: exe::Command,
) -> Result<DecodedOutput<'_>, exe::CommandErrorWrapper> {
let Self { stdout, stderr } = self;
let stdout =
str::from_utf8(stdout)
.map_err(|e| e.into())
.map_err(|e: exe::CommandError| {
e.command_with_context(
command.clone(),
format!("when decoding stdout from {:?}", &self),
)
})?;
let stderr =
str::from_utf8(stderr)
.map_err(|e| e.into())
.map_err(|e: exe::CommandError| {
e.command_with_context(command, format!("when decoding stderr from {:?}", &self))
})?;
Ok(DecodedOutput { stdout, stderr })
}
}
/// The slurped streams for a synchronously-invoked process, after UTF-8
/// decoding.
#[derive(Debug, Clone)]
#[allow(missing_docs)]
pub struct DecodedOutput<'a> {
pub stdout: &'a str,
pub stderr: &'a str,
}
/// Trait that defines "synchronously" invokable processes.
pub trait SyncInvocable {
/// Invoke a child process and wait on it to complete while slurping its
/// output.
#[allow(async_fn_in_trait)]
async fn invoke(self) -> Result<RawOutput, exe::CommandErrorWrapper>;
}
impl SyncInvocable for exe::Command {
async fn invoke(self) -> Result<RawOutput, exe::CommandErrorWrapper> {
let mut command = self.clone().command();
let output =
command
.output()
.await
.map_err(|e| e.into())
.map_err(|e: exe::CommandError| {
e.command_with_context(self.clone(), "waiting for output".to_string())
})?;
let output = RawOutput::extract(self, output)?;
Ok(output)
}
}
}
/// Methods to execute a process in an "asynchronous" or "streaming" fashion.
///
/// **TODO: define a generic stream type like the `Emission` trait in
/// `learning-progress-bar`, then express the stdio lines stream in terms of the
/// stdio byte chunks stream!** We avoid doing that here because we expect using
/// a [`BufReader`](futures_lite::io::BufReader) to produce
/// [`StdioLine`](stream::StdioLine)s will be more efficient and cleaner than
/// manually implementing a `BufReader` with `async-channel` or something.
pub mod stream {
use super::exe;
use async_process::{self, Child, Stdio};
/// A handle to the result an asynchronous invocation.
pub struct Streaming {
/// The handle to the live child process (live until [`Child::output`] is
/// called).
pub child: Child,
/// The command being executed.
pub command: exe::Command,
}
impl Streaming {
/// Wait for the process to exit, printing lines of stdout and stderr to the
/// terminal.
pub async fn wait(self) -> Result<(), exe::CommandErrorWrapper> {
let Self { mut child, command } = self;
let status = child.status().await.map_err(|e| {
let e: exe::CommandError = e.into();
e.command_with_context(command.clone(), "merging async streams".to_string())
})?;
exe::CommandError::analyze_exit_status(status)
.map_err(|e| e.command_with_context(command, "checking async exit status".to_string()))?;
Ok(())
}
}
/// Trait that defines "asynchronously" invokable processes.
pub trait Streamable {
/// Invoke a child process and return a handle to its output streams.
fn invoke_streaming(self) -> Result<Streaming, exe::CommandErrorWrapper>;
}
impl Streamable for exe::Command {
fn invoke_streaming(self) -> Result<Streaming, exe::CommandErrorWrapper> {
let mut command = self.clone().command();
let child = command
.stdout(Stdio::inherit())
.stderr(Stdio::inherit())
.spawn()
.map_err(|e| e.into())
.map_err(|e: exe::CommandError| {
e.command_with_context(self.clone(), "spawning async process".to_string())
})?;
Ok(Streaming {
child,
command: self,
})
}
}
}
/// Methods to execute a shell script as a process.
pub mod sh {
use super::{
base::{self, CommandBase},
exe, fs,
sync::SyncInvocable,
};
use displaydoc::Display;
use indexmap::IndexMap;
use tempfile::{NamedTempFile, TempPath};
use thiserror::Error;
use std::{
ffi::OsString,
io::{self, BufRead, Write},
str,
};
/// Errors that may occur when executing a shell script.
#[derive(Debug, Display, Error)]
pub enum ShellError {
/// setup error {0}
Setup(#[from] base::SetupErrorWrapper),
/// command error {0}
Command(#[from] exe::CommandErrorWrapper),
/// i/o error {0}
Io(#[from] io::Error),
/// utf-8 decoding error {0}
Utf8(#[from] str::Utf8Error),
}
impl ShellError {
/// Wrap a raw error with `context` to produced a wrapped error.
pub fn with_context(self, context: String) -> ShellErrorWrapper {
ShellErrorWrapper {
context,
error: self,
}
}
}
/// shell error ({context}): {error}
#[derive(Debug, Display, Error)]
pub struct ShellErrorWrapper {
/// Additional information about where the error occurred.
pub context: String,
/// The underlying error.
#[source]
pub error: ShellError,
}
/// Generate a shell script to execute via [`ShellScript`].
///
/// This script is generated by writing [`Self::contents`] to a temporary
/// file. ```
/// # tokio_test::block_on(async {
/// use super_process::{sh, exe, base::CommandBase, sync::SyncInvocable};
///
/// let contents = "echo hey".as_bytes().to_vec();
/// let source = sh::ShellSource { contents };
/// let script = source.into_script().await.expect("generating shell script
/// failed"); let command = script.with_command(exe::Command::default())
/// .setup_command().await.unwrap();
///
/// let output = command.invoke().await.expect("shell script should succeed");
/// assert!(b"hey\n".as_ref() == &output.stdout);
/// # }) // async
/// ```
#[derive(Debug, Clone)]
pub struct ShellSource {
/// The bytes of a shell script to be written to file.
pub contents: Vec<u8>,
}
impl ShellSource {
fn write_to_temp_path(self) -> io::Result<TempPath> {
/* Create the script. */
let (mut script_file, script_path) = NamedTempFile::new()?.into_parts();
let Self { contents } = self;
script_file.write_all(&contents)?;
script_file.sync_all()?;
/* Close the file, but keep the path alive. */
Ok(script_path)
}
/// Create a handle to a shell script backed by a temp file.
///
/// *FIXME: we don't ever delete the temp file! Use lifetimes to avoid
/// this!*
pub async fn into_script(self) -> Result<ShellScript, ShellError> {
let script_path = self.write_to_temp_path()?;
/* FIXME: We don't ever delete the script! */
let script_path = exe::Exe(fs::File(
script_path
.keep()
.expect("should never be any error keeping the shell script path"),
));
Ok(ShellScript { script_path })
}
}
/// Request for dumping the components of the environment after evaluating a
/// shell script. ```
/// # tokio_test::block_on(async {
/// use std::ffi::OsStr;
/// use super_process::{sh, exe};
///
/// let env = sh::EnvAfterScript {
/// source: sh::ShellSource {
/// contents: b"export A=3".to_vec(),
/// },
/// };
/// let exe::EnvModifications(env) =
/// env.extract_env_bindings().await.unwrap(); let env_val =
/// env.get(OsStr::new("A")).unwrap().to_str().unwrap(); assert_eq!(3,
/// env_val.parse::<usize>().unwrap()); # }) // async
/// ```
#[derive(Debug, Clone)]
pub struct EnvAfterScript {
/// Script to run before extracting the environment.
pub source: ShellSource,
}
impl EnvAfterScript {
fn into_source(self) -> ShellSource {
let Self {
source: ShellSource { mut contents },
} = self;
contents.extend_from_slice(b"\n\nexec env");
ShellSource { contents }
}
async fn into_command(self) -> Result<exe::Command, ShellErrorWrapper> {
/* Write script file. */
let source = self.into_source();
let script = source
.into_script()
.await
.map_err(|e| e.with_context("when writing env script to file".to_string()))?;
/* Generate command. */
let sh = script.with_command(exe::Command::default());
let command = sh
.setup_command()
.await
.map_err(|e| {
e.with_context("when setting up the shell command".to_string())
.into()
})
.map_err(|e: ShellError| {
e.with_context("when setting up the shell command, again".to_string())
})?;
Ok(command)
}
async fn extract_stdout(self) -> Result<Vec<u8>, ShellErrorWrapper> {
/* Setup command. */
let command = self.into_command().await?;
/* Execute command. */
let output = command
.invoke()
.await
.map_err(|e| e.into())
.map_err(|e: ShellError| e.with_context("when extracting env bindings".to_string()))?;
Ok(output.stdout)
}
/// Execute the wrapped script and parse the output of the `env` command
/// executed afterwards!
pub async fn extract_env_bindings(self) -> Result<exe::EnvModifications, ShellErrorWrapper> {
let stdout = self.extract_stdout().await?;
/* Parse output into key-value pairs. */
let mut env_map: IndexMap<OsString, OsString> = IndexMap::new();
for line in stdout.lines() {
let line = line
.map_err(|e| e.into())
.map_err(|e: ShellError| e.with_context("when extracting stdout line".to_string()))?;
/* FIXME: we currently just ignore lines that don't have an '=' -- fix this! */
if let Some(equals_index) = line.find('=') {
let key = &line[..equals_index];
let value = &line[equals_index + 1..];
env_map.insert(key.into(), value.into());
}
}
Ok(exe::EnvModifications(env_map))
}
}
/// Execute a command line beginning with this shell script.
///
/// The later arguments provided via [`Self::with_command`] (FIXME!)
///```
/// # tokio_test::block_on(async {
/// use std::io::Write;
/// use tempfile::NamedTempFile;
/// use super_process::{sh, exe, sync::SyncInvocable, base::CommandBase, fs};
///
/// let script_path = {
/// let (mut script_file, script_path) = NamedTempFile::new().unwrap().into_parts();
/// script_file.write_all(b"echo hey\n").unwrap();
/// script_file.sync_all().unwrap();
/// script_path.keep().unwrap()
/// };
/// let script_path = exe::Exe(fs::File(script_path));
/// let script = sh::ShellScript { script_path };
/// let command = script.with_command(exe::Command::default())
/// .setup_command().await.unwrap();
///
/// let output = command.invoke().await.expect("script should succeed");
/// assert!(b"hey\n".as_ref() == &output.stdout);
/// # }) // async
/// ```
#[derive(Debug, Clone)]
pub struct ShellScript {
/// The script to execute.
pub script_path: exe::Exe,
}
impl ShellScript {
/// Provide a command line for this shell script to execute.
pub fn with_command(self, base: exe::Command) -> ShellScriptInvocation {
ShellScriptInvocation { script: self, base }
}
}
/// The command wrapper for a shell script.
#[derive(Debug, Clone)]
pub struct ShellScriptInvocation {
/// The script to preface the command line with.
pub script: ShellScript,
/// The command line to provide to the script.
pub base: exe::Command,
}
impl CommandBase for ShellScriptInvocation {
async fn setup_command(self) -> Result<exe::Command, base::SetupError> {
let Self {
script: ShellScript { script_path },
mut base,
} = self;
base.unshift_shell_script(script_path);
Ok(base)
}
}
}