garden/cmds/cmd.rs
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
use std::sync::atomic;
use anyhow::Result;
use better_default::Default;
use clap::{CommandFactory, FromArgMatches, Parser};
use rayon::prelude::*;
use yansi::Paint;
use crate::cli::GardenOptions;
use crate::{cli, cmd, constants, display, errors, eval, model, path, query, syntax};
/// Run one or more custom commands over a tree query
#[derive(Parser, Clone, Debug)]
#[command(author, about, long_about)]
pub struct CmdOptions {
/// Run a command in all trees before running the next command
#[arg(long, short)]
breadth_first: bool,
/// Perform a trial run without running commands
#[arg(long, short = 'N')]
dry_run: bool,
/// Continue to the next tree when errors occur
#[arg(long, short)]
keep_going: bool,
/// Filter trees by name post-query using a glob pattern
#[arg(long, short, default_value = "*")]
trees: String,
/// Set variables using 'name=value' expressions
#[arg(long, short = 'D')]
define: Vec<String>,
/// Do not pass "-e" to the shell.
/// Prevent the "errexit" shell option from being set. By default, the "-e" option
/// is passed to the configured shell so that multi-line and multi-statement
/// commands halt execution when the first statement with a non-zero exit code is
/// encountered. This option has the effect of making multi-line and
/// multi-statement commands run all statements even when an earlier statement
/// returns a non-zero exit code.
#[arg(long = "no-errexit", short = 'n', default_value_t = true, action = clap::ArgAction::SetFalse)]
exit_on_error: bool,
/// Run commands even when the tree does not exist.
#[arg(long, short)]
force: bool,
/// Run commands in parallel using the specified number of jobs.
#[arg(
long = "jobs",
short = 'j',
require_equals = false,
num_args = 0..=1,
default_missing_value = "0",
value_name = "JOBS",
)]
num_jobs: Option<usize>,
/// Be quiet
#[arg(short, long)]
quiet: bool,
/// Increase verbosity level (default: 0)
#[arg(short, long, action = clap::ArgAction::Count)]
verbose: u8,
/// Do not pass "-o shwordsplit" to zsh.
/// Prevent the "shwordsplit" shell option from being set when using zsh.
/// The "-o shwordsplit" option is passed to zsh by default so that unquoted
/// $variable expressions are subject to word splitting, just like other shells.
/// This option disables this behavior.
#[arg(long = "no-wordsplit", short = 'z', default_value_t = true, action = clap::ArgAction::SetFalse)]
word_split: bool,
/// Tree query for the gardens, groups or trees to execute commands within
query: String,
/// Custom commands to run over the resolved trees
// NOTE: value_terminator may not be needed in future versions of clap_complete.
// https://github.com/clap-rs/clap/pull/4612
#[arg(required = true, value_terminator = "--")]
commands: Vec<String>,
/// Arguments to forward to custom commands
#[arg(last = true)]
arguments: Vec<String>,
}
/// Run custom garden commands
#[derive(Parser, Clone, Debug)]
#[command(bin_name = constants::GARDEN)]
pub struct CustomOptions {
/// Set variables using 'name=value' expressions
#[arg(long, short = 'D')]
define: Vec<String>,
/// Perform a trial run without running commands
#[arg(long, short = 'N')]
dry_run: bool,
/// Continue to the next tree when errors occur
#[arg(long, short)]
keep_going: bool,
/// Filter trees by name post-query using a glob pattern
#[arg(long, short, default_value = "*")]
trees: String,
/// Do not pass "-e" to the shell.
/// Prevent the "errexit" shell option from being set. By default, the "-e" option
/// is passed to the configured shell so that multi-line and multi-statement
/// commands halt execution when the first statement with a non-zero exit code is
/// encountered. This option has the effect of making multi-line and
/// multi-statement commands run all statements even when an earlier statement
/// returns a non-zero exit code.
#[arg(long = "no-errexit", short = 'n', default_value_t = true, action = clap::ArgAction::SetFalse)]
exit_on_error: bool,
/// Run commands even when the tree does not exist.
#[arg(long, short)]
force: bool,
/// Run commands in parallel using the specified number of jobs.
#[arg(
long = "jobs",
short = 'j',
require_equals = false,
num_args = 0..=1,
default_missing_value = "0",
value_name = "JOBS",
)]
num_jobs: Option<usize>,
/// Be quiet
#[arg(short, long)]
quiet: bool,
/// Increase verbosity level (default: 0)
#[arg(short, long, action = clap::ArgAction::Count)]
verbose: u8,
/// Do not pass "-o shwordsplit" to zsh.
/// Prevent the "shwordsplit" shell option from being set when using zsh.
/// The "-o shwordsplit" option is passed to zsh by default so that unquoted
/// $variable expressions are subject to word splitting, just like other shells.
/// This option disables this behavior.
#[arg(long = "no-wordsplit", short = 'z', default_value_t = true, action = clap::ArgAction::SetFalse)]
word_split: bool,
/// Tree queries for the Gardens/Groups/Trees to execute commands within
// NOTE: value_terminator may not be needed in future versions of clap_complete.
// https://github.com/clap-rs/clap/pull/4612
#[arg(value_terminator = "--")]
queries: Vec<String>,
/// Arguments to forward to custom commands
#[arg(last = true)]
arguments: Vec<String>,
}
/// Main entry point for `garden cmd <query> <command>...`.
pub fn main_cmd(app_context: &model::ApplicationContext, options: &mut CmdOptions) -> Result<()> {
app_context
.get_root_config_mut()
.apply_defines(&options.define);
app_context
.get_root_config_mut()
.update_quiet_and_verbose_variables(options.quiet, options.verbose);
if app_context.options.debug_level(constants::DEBUG_LEVEL_CMD) > 0 {
debug!("jobs: {:?}", options.num_jobs);
debug!("query: {}", options.query);
debug!("commands: {:?}", options.commands);
debug!("arguments: {:?}", options.arguments);
debug!("trees: {:?}", options.trees);
}
if !app_context.get_root_config().shell_exit_on_error {
options.exit_on_error = false;
}
if !app_context.get_root_config().shell_word_split {
options.word_split = false;
}
let mut params: CmdParams = options.clone().into();
params.update(&app_context.options)?;
let exit_status = if options.num_jobs.is_some() {
cmd_parallel(app_context, &options.query, ¶ms)?
} else {
cmd(app_context, &options.query, ¶ms)?
};
errors::exit_status_into_result(exit_status)
}
/// CmdParams are used to control the execution of run_cmd_vec().
///
/// `garden cmd` and `garden <custom-cmd>` parse command line arguments into CmdParams.
#[derive(Clone, Debug, Default)]
pub struct CmdParams {
commands: Vec<String>,
arguments: Vec<String>,
queries: Vec<String>,
tree_pattern: glob::Pattern,
breadth_first: bool,
dry_run: bool,
force: bool,
keep_going: bool,
num_jobs: Option<usize>,
#[default(true)]
exit_on_error: bool,
quiet: bool,
verbose: u8,
#[default(true)]
word_split: bool,
}
/// Build CmdParams from a CmdOptions struct.
impl From<CmdOptions> for CmdParams {
fn from(options: CmdOptions) -> Self {
Self {
commands: options.commands.clone(),
arguments: options.arguments.clone(),
breadth_first: options.breadth_first,
dry_run: options.dry_run,
exit_on_error: options.exit_on_error,
force: options.force,
keep_going: options.keep_going,
num_jobs: options.num_jobs,
tree_pattern: glob::Pattern::new(&options.trees).unwrap_or_default(),
quiet: options.quiet,
verbose: options.verbose,
word_split: options.word_split,
..Default::default()
}
}
}
/// Build CmdParams from a CustomOptions struct
impl From<CustomOptions> for CmdParams {
fn from(options: CustomOptions) -> Self {
let mut params = Self {
// Add the custom command name to the list of commands. cmds() operates on a vec of commands.
arguments: options.arguments.clone(),
queries: options.queries.clone(),
// Custom commands run breadth-first. The distinction shouldn't make a difference in
// practice because "garden <custom-cmd> ..." is only able to run a single command, but we
// use breadth-first because it retains the original implementation/behavior from before
// --breadth-first was added to "garden cmd" and made opt-in.
//
// On the other hand, we want "garden <cmd> <query>" to paralellize over all of the
// resolved TreeContexts, so we use depth-first traversal when running in paralle.
breadth_first: options.num_jobs.is_none(),
dry_run: options.dry_run,
keep_going: options.keep_going,
exit_on_error: options.exit_on_error,
force: options.force,
num_jobs: options.num_jobs,
tree_pattern: glob::Pattern::new(&options.trees).unwrap_or_default(),
quiet: options.quiet,
verbose: options.verbose,
word_split: options.word_split,
..Default::default()
};
// Default to "." when no queries have been specified.
if params.queries.is_empty() {
params.queries.push(constants::DOT.into());
}
params
}
}
impl CmdParams {
/// Apply the opt-level MainOptions onto the CmdParams.
fn update(&mut self, options: &cli::MainOptions) -> Result<()> {
self.quiet |= options.quiet;
self.verbose += options.verbose;
cmd::initialize_threads_option(self.num_jobs)?;
Ok(())
}
}
/// Format an error
fn format_error<I: CommandFactory>(err: clap::Error) -> clap::Error {
let mut cmd = I::command();
err.format(&mut cmd)
}
/// Main entry point for `garden <command> <query>...`.
pub fn main_custom(app_context: &model::ApplicationContext, arguments: &Vec<String>) -> Result<()> {
// Set the command name to "garden <custom>".
let name = &arguments[0];
let garden_custom = format!("garden {name}");
let cli = CustomOptions::command().bin_name(garden_custom);
let matches = cli.get_matches_from(arguments);
let mut options = <CustomOptions as FromArgMatches>::from_arg_matches(&matches)
.map_err(format_error::<CustomOptions>)?;
app_context
.get_root_config_mut()
.apply_defines(&options.define);
app_context
.get_root_config_mut()
.update_quiet_and_verbose_variables(options.quiet, options.verbose);
if !app_context.get_root_config().shell_exit_on_error {
options.exit_on_error = false;
}
if !app_context.get_root_config().shell_word_split {
options.word_split = false;
}
if app_context.options.debug_level(constants::DEBUG_LEVEL_CMD) > 0 {
debug!("jobs: {:?}", options.num_jobs);
debug!("command: {}", name);
debug!("queries: {:?}", options.queries);
debug!("arguments: {:?}", options.arguments);
debug!("trees: {:?}", options.trees);
}
// Add the custom command name to the list of commands. cmds() operates on a vec of commands.
let mut params: CmdParams = options.clone().into();
params.update(&app_context.options)?;
params.commands.push(name.to_string());
cmds(app_context, ¶ms)
}
/// Run commands across trees.
///
/// Resolve the trees queries down to a set of tree indexes paired with
/// an optional garden context.
///
/// If the names resolve to gardens, each garden is processed independently.
/// Trees that exist in multiple matching gardens will be processed multiple
/// times.
///
/// If the names resolve to trees, each tree is processed independently
/// with no garden context.
fn cmd(app_context: &model::ApplicationContext, query: &str, params: &CmdParams) -> Result<i32> {
let config = app_context.get_root_config_mut();
let contexts = query::resolve_trees(app_context, config, None, query);
if params.breadth_first {
run_cmd_breadth_first(app_context, &contexts, params)
} else {
run_cmd_depth_first(app_context, &contexts, params)
}
}
/// Run commands in parallel. This is the parallel version of fn cmd().
fn cmd_parallel(
app_context: &model::ApplicationContext,
query: &str,
params: &CmdParams,
) -> Result<i32> {
let config = app_context.get_root_config_mut();
let contexts = query::resolve_trees(app_context, config, None, query);
if params.breadth_first {
run_cmd_breadth_first_parallel(app_context, &contexts, params)
} else {
run_cmd_depth_first_parallel(app_context, &contexts, params)
}
}
/// The configured shell state.
struct ShellParams {
/// The shell string is parsed into command line arguments.
shell_command: Vec<String>,
/// Is this a shell script runner that requires $0 to be passed as the first argument?
is_shell: bool,
}
impl ShellParams {
fn new(shell: &str, exit_on_error: bool, word_split: bool) -> Self {
let mut shell_command = cmd::shlex_split(shell);
let basename = path::str_basename(&shell_command[0]);
// Does the shell understand "-e" for errexit?
let is_shell = path::is_shell(basename);
let is_zsh = matches!(basename, constants::SHELL_ZSH);
// Does the shell use "-e <string>" or "-c <string>" to evaluate commands?
let is_dash_e = matches!(
basename,
constants::SHELL_BUN
| constants::SHELL_NODE
| constants::SHELL_NODEJS
| constants::SHELL_PERL
| constants::SHELL_RUBY
);
// Is the shell a full-blown command with "-c" and everything defined by the user?
// If so we won't manage the custom shell options ourselves.
let is_custom = shell_command.len() > 1;
if !is_custom {
if word_split && is_zsh {
shell_command.push(string!("-o"));
shell_command.push(string!("shwordsplit"));
}
if is_zsh {
shell_command.push(string!("+o"));
shell_command.push(string!("nomatch"));
}
if exit_on_error && is_shell {
shell_command.push(string!("-e"));
}
if is_dash_e {
shell_command.push(string!("-e"));
} else {
shell_command.push(string!("-c"));
}
}
Self {
shell_command,
is_shell,
}
}
/// Return ShellParams from a "#!" shebang line string.
fn from_str(shell: &str) -> Self {
let shell_command = cmd::shlex_split(shell);
let basename = path::str_basename(&shell_command[0]);
// Does the shell understand "-e" for errexit?
let is_shell = path::is_shell(basename);
Self {
shell_command,
is_shell,
}
}
/// Retrun ShellParams from an ApplicationContext and CmdParams.
fn from_context_and_params(
app_context: &model::ApplicationContext,
params: &CmdParams,
) -> Self {
let shell = app_context.get_root_config().shell.as_str();
Self::new(shell, params.exit_on_error, params.word_split)
}
}
/// Check whether the TreeContext is relevant to the current CmdParams.
/// Returns None when the extracted details are not applicable.
fn get_tree_from_context<'a>(
app_context: &'a model::ApplicationContext,
context: &model::TreeContext,
params: &CmdParams,
) -> Option<(&'a model::Configuration, &'a model::Tree)> {
// Skip filtered trees.
if !params.tree_pattern.matches(&context.tree) {
return None;
}
// Skip symlink trees.
let config = match context.config {
Some(config_id) => app_context.get_config(config_id),
None => app_context.get_root_config(),
};
let tree = config.trees.get(&context.tree)?;
if tree.is_symlink {
return None;
}
Some((config, tree))
}
/// Prepare state needed for running commands.
fn get_command_environment<'a>(
app_context: &'a model::ApplicationContext,
context: &model::TreeContext,
params: &CmdParams,
) -> Option<(Option<String>, &'a String, model::Environment)> {
let (config, tree) = get_tree_from_context(app_context, context, params)?;
// Trees must have a valid path available.
let Ok(tree_path) = tree.path_as_ref() else {
return None;
};
// Evaluate the tree environment
let env = eval::environment(app_context, config, context);
// Sparse gardens/missing trees are ok -> skip these entries.
let mut fallback_path = None;
if !display::print_tree(
tree,
config.tree_branches,
params.verbose,
params.quiet,
params.force,
) {
// The "--force" option runs commands in a fallback directory when the tree does not exist.
if params.force {
fallback_path = Some(config.fallback_execdir_string());
} else {
return None;
}
}
Some((fallback_path, tree_path, env))
}
// Expand a command to include its pre-commands and post-commands then execute them in order.
fn expand_and_run_command(
app_context: &model::ApplicationContext,
context: &model::TreeContext,
name: &str,
path: &str,
shell_params: &ShellParams,
params: &CmdParams,
env: &model::Environment,
) -> Result<i32, i32> {
let mut exit_status = errors::EX_OK;
// Create a sequence of the command names to run including pre and post-commands.
let command_names = cmd::expand_command_names(app_context, context, name);
for command_name in &command_names {
// One command maps to multiple command sequences. When the scope is tree, only the tree's
// commands are included. When the scope includes a garden, its matching commands are
// appended to the end.
let cmd_seq_vec = eval::command(app_context, context, command_name);
app_context.get_root_config_mut().reset();
if let Err(cmd_status) = run_cmd_vec(path, shell_params, env, &cmd_seq_vec, params) {
exit_status = cmd_status;
if !params.keep_going {
return Err(cmd_status);
}
}
}
Ok(exit_status)
}
/// Run commands breadth-first. Each command is run in all trees before running the next command.
fn run_cmd_breadth_first(
app_context: &model::ApplicationContext,
contexts: &[model::TreeContext],
params: &CmdParams,
) -> Result<i32> {
let mut exit_status: i32 = errors::EX_OK;
let shell_params = ShellParams::from_context_and_params(app_context, params);
// Loop over each command, evaluate the tree environment,
// and run the command in each context.
for name in ¶ms.commands {
// One invocation runs multiple commands
for context in contexts {
let Some((fallback_path, tree_path, env)) =
get_command_environment(app_context, context, params)
else {
continue;
};
let path = fallback_path.as_ref().unwrap_or(tree_path);
match expand_and_run_command(
app_context,
context,
name,
path,
&shell_params,
params,
&env,
) {
Ok(cmd_status) => {
if cmd_status != errors::EX_OK {
exit_status = cmd_status;
}
}
Err(cmd_status) => return Ok(cmd_status),
}
}
}
// Return the last non-zero exit status.
Ok(exit_status)
}
/// Run multiple commands in parallel over a single tree query.
/// All command are run in parallel over all of the matching trees.
/// Each command invocation operates over every resolved tree, serially, within the scope of
/// the currently running command.
fn run_cmd_breadth_first_parallel(
app_context: &model::ApplicationContext,
contexts: &[model::TreeContext],
params: &CmdParams,
) -> Result<i32> {
let exit_status = atomic::AtomicI32::new(errors::EX_OK);
let shell_params = ShellParams::from_context_and_params(app_context, params);
// Loop over each command, evaluate the tree environment, and run the command in each context.
params.commands.par_iter().for_each(|name| {
// Create a thread-specific ApplicationContext.
let app_context_clone = app_context.clone();
let app_context = &app_context_clone;
// One invocation runs multiple commands
for context in contexts {
let Some((fallback_path, tree_path, env)) =
get_command_environment(app_context, context, params)
else {
continue;
};
let path = fallback_path.as_ref().unwrap_or(tree_path);
match expand_and_run_command(
app_context,
context,
name,
path,
&shell_params,
params,
&env,
) {
Ok(cmd_status) => {
if cmd_status != errors::EX_OK {
exit_status.store(cmd_status, atomic::Ordering::Release);
}
}
Err(cmd_status) => {
exit_status.store(cmd_status, atomic::Ordering::Release);
break;
}
}
}
});
// Return the last non-zero exit status.
Ok(exit_status.load(atomic::Ordering::Acquire))
}
/// Run commands depth-first. All commands are run on the current tree before visiting the next tree.
fn run_cmd_depth_first(
app_context: &model::ApplicationContext,
contexts: &[model::TreeContext],
params: &CmdParams,
) -> Result<i32> {
let mut exit_status: i32 = errors::EX_OK;
let shell_params = ShellParams::from_context_and_params(app_context, params);
// Loop over each context, evaluate the tree environment and run the command.
for context in contexts {
let Some((fallback_path, tree_path, env)) =
get_command_environment(app_context, context, params)
else {
continue;
};
let path = fallback_path.as_ref().unwrap_or(tree_path);
// One invocation runs multiple commands
for name in ¶ms.commands {
match expand_and_run_command(
app_context,
context,
name,
path,
&shell_params,
params,
&env,
) {
Ok(cmd_status) => {
if cmd_status != errors::EX_OK {
exit_status = cmd_status;
}
}
Err(cmd_status) => return Ok(cmd_status),
}
}
}
// Return the last non-zero exit status.
Ok(exit_status)
}
/// Run commands depth-first in parallel.
/// All trees are visited concurrently in parallel. Commands are run serially within
/// the scope of a single tree.
fn run_cmd_depth_first_parallel(
app_context: &model::ApplicationContext,
contexts: &[model::TreeContext],
params: &CmdParams,
) -> Result<i32> {
let exit_status = atomic::AtomicI32::new(errors::EX_OK);
let shell_params = ShellParams::from_context_and_params(app_context, params);
// Loop over each context, evaluate the tree environment and run the command.
contexts.par_iter().for_each(|context| {
// Create a thread-specific ApplicationContext.
let app_context_clone = app_context.clone();
let app_context = &app_context_clone;
let Some((fallback_path, tree_path, env)) =
get_command_environment(app_context, context, params)
else {
return;
};
let path = fallback_path.as_ref().unwrap_or(tree_path);
// One invocation runs multiple commands
for name in ¶ms.commands {
match expand_and_run_command(
app_context,
context,
name,
path,
&shell_params,
params,
&env,
) {
Ok(cmd_status) => {
if cmd_status != errors::EX_OK {
exit_status.store(cmd_status, atomic::Ordering::Release);
}
}
Err(cmd_status) => {
exit_status.store(cmd_status, atomic::Ordering::Release);
break;
}
}
}
});
// Return any of the non-zero exit statuses. Which value is returned is
// undefined due to the parallel nature of this function. Any of the
// non-zero exit status values could have ended up recorded in exit_status.
Ok(exit_status.load(atomic::Ordering::Acquire))
}
/// Run a vector of custom commands using the configured shell.
/// Parameters:
/// - path: The current working directory for the command.
/// - shell: The shell that will be used to run the command strings.
/// - env: Environment variables to set.
/// - cmd_seq_vec: Vector of vector of command strings to run.
/// - arguments: Additional command line arguments available in $1, $2, $N.
fn run_cmd_vec(
path: &str,
shell_params: &ShellParams,
env: &model::Environment,
cmd_seq_vec: &[Vec<String>],
params: &CmdParams,
) -> Result<(), i32> {
// Get the current executable name
let current_exe = cmd::current_exe();
let mut exit_status = errors::EX_OK;
for cmd_seq in cmd_seq_vec {
for cmd_str in cmd_seq {
if params.verbose > 1 {
eprintln!("{} {}", ":".cyan(), &cmd_str.trim_end().green());
}
if params.dry_run {
continue;
}
// Create a custom ShellParams when "#!" is used.
let cmd_shell_params;
let (cmd_str, shell_params) = match syntax::split_shebang(cmd_str) {
Some((shell_cmd, cmd_str)) => {
cmd_shell_params = ShellParams::from_str(shell_cmd);
(cmd_str, &cmd_shell_params)
}
None => (cmd_str.as_str(), shell_params),
};
let mut exec = subprocess::Exec::cmd(&shell_params.shell_command[0]).cwd(path);
exec = exec.args(&shell_params.shell_command[1..]);
exec = exec.arg(cmd_str);
if shell_params.is_shell {
// Shells require $0 to be specified when using -c to run commands in order to make $1 and friends
// behave intuitively from within the script. The garden executable's location is
// provided in $0 for convenience.
exec = exec.arg(current_exe.as_str());
}
exec = exec.args(¶ms.arguments);
// Update the command environment
for (k, v) in env {
exec = exec.env(k, v);
}
// When a command list is used then the return code from the final command
// is the one that is returned when --no-errexit is in effect.
let status = cmd::status(exec);
if status != errors::EX_OK {
exit_status = status;
if params.exit_on_error {
return Err(status);
}
} else {
exit_status = errors::EX_OK;
}
}
if exit_status != errors::EX_OK {
return Err(exit_status);
}
}
Ok(())
}
/// Run cmd() over a Vec of tree queries
fn cmds(app: &model::ApplicationContext, params: &CmdParams) -> Result<()> {
let exit_status = atomic::AtomicI32::new(errors::EX_OK);
if params.num_jobs.is_some() {
params.queries.par_iter().for_each(|query| {
let status = cmd_parallel(&app.clone(), query, params).unwrap_or(errors::EX_IOERR);
if status != errors::EX_OK {
exit_status.store(status, atomic::Ordering::Release);
}
});
} else {
for query in ¶ms.queries {
let status = cmd(app, query, params).unwrap_or(errors::EX_IOERR);
if status != errors::EX_OK {
exit_status.store(status, atomic::Ordering::Release);
if !params.keep_going {
break;
}
}
}
}
// Return the last non-zero exit status.
errors::exit_status_into_result(exit_status.load(atomic::Ordering::Acquire))
}