File size: 17,017 Bytes
1851bae | 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 | use std::io::{self, Write};
use std::path::{Path, PathBuf};
use std::sync::Arc;
use bstr::ByteSlice;
use forge_app::CommandInfra;
use forge_domain::{CommandOutput, ConsoleWriter as OutputPrinterTrait, Environment};
use tokio::io::AsyncReadExt;
use tokio::process::Command;
use tokio::sync::Mutex;
use crate::console::StdConsoleWriter;
/// Service for executing shell commands
#[derive(Clone, Debug)]
pub struct ForgeCommandExecutorService {
env: Environment,
output_printer: Arc<StdConsoleWriter>,
// Mutex to ensure that only one command is executed at a time
ready: Arc<Mutex<()>>,
}
impl ForgeCommandExecutorService {
pub fn new(env: Environment, output_printer: Arc<StdConsoleWriter>) -> Self {
Self { env, output_printer, ready: Arc::new(Mutex::new(())) }
}
fn prepare_command(
&self,
command_str: &str,
working_dir: &Path,
env_vars: Option<Vec<String>>,
) -> Command {
// Create a basic command
let is_windows = cfg!(target_os = "windows");
let shell = self.env.shell.as_str();
let mut command = Command::new(shell);
// Core color settings for general commands
command
.env("CLICOLOR_FORCE", "1")
.env("FORCE_COLOR", "true")
.env_remove("NO_COLOR");
// Language/program specific color settings
command
.env("SBT_OPTS", "-Dsbt.color=always")
.env("JAVA_OPTS", "-Dsbt.color=always");
// enabled Git colors
command.env("GIT_CONFIG_PARAMETERS", "'color.ui=always'");
// Other common tools
command.env("GREP_OPTIONS", "--color=always"); // GNU grep
let parameter = if is_windows { "/C" } else { "-c" };
command.arg(parameter);
#[cfg(windows)]
command.raw_arg(command_str);
#[cfg(unix)]
command.arg(command_str);
tracing::info!(command = command_str, "Executing command");
command.kill_on_drop(true);
// Set the working directory
command.current_dir(working_dir);
// Configure the command for output
command
.stdin(std::process::Stdio::inherit())
.stdout(std::process::Stdio::piped())
.stderr(std::process::Stdio::piped());
// Set requested environment variables
if let Some(env_vars) = env_vars {
for env_var in env_vars {
if let Ok(value) = std::env::var(&env_var) {
command.env(&env_var, value);
tracing::debug!(env_var = %env_var, "Set environment variable from system");
} else {
tracing::warn!(env_var = %env_var, "Environment variable not found in system");
}
}
}
command
}
/// Internal method to execute commands with streaming to console
async fn execute_command_internal(
&self,
command: String,
working_dir: &Path,
silent: bool,
env_vars: Option<Vec<String>>,
) -> anyhow::Result<CommandOutput> {
let ready = self.ready.lock().await;
let mut prepared_command = self.prepare_command(&command, working_dir, env_vars);
// Spawn the command
let mut child = prepared_command.spawn()?;
let mut stdout_pipe = child.stdout.take();
let mut stderr_pipe = child.stderr.take();
// Stream the output of the command to stdout and stderr concurrently
let (status, stdout_buffer, stderr_buffer) = if silent {
tokio::try_join!(
child.wait(),
stream(&mut stdout_pipe, io::sink()),
stream(&mut stderr_pipe, io::sink())
)?
} else {
let stdout_writer = OutputPrinterWriter::stdout(self.output_printer.clone());
let stderr_writer = OutputPrinterWriter::stderr(self.output_printer.clone());
let result = tokio::try_join!(
child.wait(),
stream(&mut stdout_pipe, stdout_writer),
stream(&mut stderr_pipe, stderr_writer)
)?;
// If the command's stdout did not end with a newline, the terminal
// cursor is left mid-line. Write a newline so that subsequent output
// (e.g. the LLM response) starts on a fresh line.
if result.1.last() != Some(&b'\n') && !result.1.is_empty() {
let _ = self.output_printer.write(b"\n");
let _ = self.output_printer.flush();
}
result
};
// Drop happens after `try_join` due to <https://github.com/tokio-rs/tokio/issues/4309>
drop(stdout_pipe);
drop(stderr_pipe);
drop(ready);
Ok(CommandOutput {
stdout: stdout_buffer.to_str_lossy().into_owned(),
stderr: stderr_buffer.to_str_lossy().into_owned(),
exit_code: status.code(),
command,
})
}
}
/// Writer that delegates to OutputPrinter for synchronized writes.
struct OutputPrinterWriter {
printer: Arc<StdConsoleWriter>,
is_stdout: bool,
}
impl OutputPrinterWriter {
fn stdout(printer: Arc<StdConsoleWriter>) -> Self {
Self { printer, is_stdout: true }
}
fn stderr(printer: Arc<StdConsoleWriter>) -> Self {
Self { printer, is_stdout: false }
}
}
impl Write for OutputPrinterWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
if self.is_stdout {
self.printer.write(buf)
} else {
self.printer.write_err(buf)
}
}
fn flush(&mut self) -> io::Result<()> {
if self.is_stdout {
self.printer.flush()
} else {
self.printer.flush_err()
}
}
}
/// reads the output from A and writes it to W
async fn stream<A: AsyncReadExt + Unpin, W: Write>(
io: &mut Option<A>,
mut writer: W,
) -> io::Result<Vec<u8>> {
let mut output = Vec::new();
if let Some(io) = io.as_mut() {
let mut buff = [0; 1024];
// Carry incomplete trailing UTF-8 codepoint bytes across reads — Windows
// console stdio rejects even one byte of a split codepoint.
let mut pending = Vec::<u8>::new();
loop {
let n = io.read(&mut buff).await?;
if n == 0 {
break;
}
let chunk = buff.get(..n).unwrap_or(&[]);
output.extend_from_slice(chunk);
let mut working = std::mem::take(&mut pending);
working.extend_from_slice(chunk);
pending = write_lossy_utf8(&mut writer, &working)?;
// note: flush is necessary else we get the cursor could not be found error.
writer.flush()?;
}
// Flush dangling bytes from a stream that ended mid-codepoint.
if !pending.is_empty() {
writer.write_all(pending.to_str_lossy().as_bytes())?;
writer.flush()?;
}
}
Ok(output)
}
/// Writes `buf` as valid UTF-8 (invalid bytes → `U+FFFD`) and returns any
/// incomplete trailing codepoint bytes for the caller to carry into the next
/// chunk.
fn write_lossy_utf8<W: Write>(writer: &mut W, buf: &[u8]) -> io::Result<Vec<u8>> {
let mut chunks = ByteSlice::utf8_chunks(buf).peekable();
while let Some(chunk) = chunks.next() {
writer.write_all(chunk.valid().as_bytes())?;
if !chunk.invalid().is_empty() {
if chunk.incomplete() && chunks.peek().is_none() {
return Ok(chunk.invalid().to_vec());
}
writer.write_all("\u{FFFD}".as_bytes())?;
}
}
Ok(Vec::new())
}
/// The implementation for CommandExecutorService
#[async_trait::async_trait]
impl CommandInfra for ForgeCommandExecutorService {
async fn execute_command(
&self,
command: String,
working_dir: PathBuf,
silent: bool,
env_vars: Option<Vec<String>>,
) -> anyhow::Result<CommandOutput> {
self.execute_command_internal(command, &working_dir, silent, env_vars)
.await
}
async fn execute_command_raw(
&self,
command: &str,
working_dir: PathBuf,
env_vars: Option<Vec<String>>,
) -> anyhow::Result<std::process::ExitStatus> {
let mut prepared_command = self.prepare_command(command, &working_dir, env_vars);
// overwrite the stdin, stdout and stderr to inherit
prepared_command
.stdin(std::process::Stdio::inherit())
.stdout(std::process::Stdio::inherit())
.stderr(std::process::Stdio::inherit());
Ok(prepared_command.spawn()?.wait().await?)
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
fn test_env() -> Environment {
use fake::{Fake, Faker};
let fixture: Environment = Faker.fake();
fixture.shell(
if cfg!(target_os = "windows") {
"cmd"
} else {
"bash"
}
.to_string(),
)
}
fn test_printer() -> Arc<StdConsoleWriter> {
Arc::new(StdConsoleWriter::default())
}
#[tokio::test]
async fn test_command_executor() {
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = "echo 'hello world'";
let dir = ".";
let actual = fixture
.execute_command(cmd.to_string(), PathBuf::new().join(dir), false, None)
.await
.unwrap();
let mut expected = CommandOutput {
stdout: "hello world\n".to_string(),
stderr: "".to_string(),
command: "echo \"hello world\"".into(),
exit_code: Some(0),
};
if cfg!(target_os = "windows") {
expected.stdout = format!("'{}'", expected.stdout);
}
assert_eq!(actual.stdout.trim(), expected.stdout.trim());
assert_eq!(actual.stderr, expected.stderr);
assert_eq!(actual.success(), expected.success());
}
#[tokio::test]
async fn test_command_executor_with_env_vars_success() {
// Set up test environment variables
unsafe {
std::env::set_var("TEST_ENV_VAR", "test_value");
std::env::set_var("ANOTHER_TEST_VAR", "another_value");
}
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = if cfg!(target_os = "windows") {
"echo %TEST_ENV_VAR%"
} else {
"echo $TEST_ENV_VAR"
};
let actual = fixture
.execute_command(
cmd.to_string(),
PathBuf::new().join("."),
false,
Some(vec!["TEST_ENV_VAR".to_string()]),
)
.await
.unwrap();
assert!(actual.success());
assert!(actual.stdout.contains("test_value"));
// Clean up
unsafe {
std::env::remove_var("TEST_ENV_VAR");
std::env::remove_var("ANOTHER_TEST_VAR");
}
}
#[tokio::test]
async fn test_command_executor_with_missing_env_vars() {
unsafe {
std::env::remove_var("MISSING_ENV_VAR");
}
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = if cfg!(target_os = "windows") {
"echo %MISSING_ENV_VAR%"
} else {
"echo ${MISSING_ENV_VAR:-default_value}"
};
let actual = fixture
.execute_command(
cmd.to_string(),
PathBuf::new().join("."),
false,
Some(vec!["MISSING_ENV_VAR".to_string()]),
)
.await
.unwrap();
// Should still succeed even with missing env vars
assert!(actual.success());
}
#[tokio::test]
async fn test_command_executor_with_empty_env_list() {
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = "echo 'no env vars'";
let actual = fixture
.execute_command(
cmd.to_string(),
PathBuf::new().join("."),
false,
Some(vec![]),
)
.await
.unwrap();
assert!(actual.success());
assert!(actual.stdout.contains("no env vars"));
}
#[tokio::test]
async fn test_command_executor_with_multiple_env_vars() {
unsafe {
std::env::set_var("FIRST_VAR", "first");
std::env::set_var("SECOND_VAR", "second");
}
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = if cfg!(target_os = "windows") {
"echo %FIRST_VAR% %SECOND_VAR%"
} else {
"echo $FIRST_VAR $SECOND_VAR"
};
let actual = fixture
.execute_command(
cmd.to_string(),
PathBuf::new().join("."),
false,
Some(vec!["FIRST_VAR".to_string(), "SECOND_VAR".to_string()]),
)
.await
.unwrap();
assert!(actual.success());
assert!(actual.stdout.contains("first"));
assert!(actual.stdout.contains("second"));
// Clean up
unsafe {
std::env::remove_var("FIRST_VAR");
std::env::remove_var("SECOND_VAR");
}
}
#[tokio::test]
async fn test_command_executor_silent() {
let fixture = ForgeCommandExecutorService::new(test_env(), test_printer());
let cmd = "echo 'silent test'";
let dir = ".";
let actual = fixture
.execute_command(cmd.to_string(), PathBuf::new().join(dir), true, None)
.await
.unwrap();
let mut expected = CommandOutput {
stdout: "silent test\n".to_string(),
stderr: "".to_string(),
command: "echo \"silent test\"".into(),
exit_code: Some(0),
};
if cfg!(target_os = "windows") {
expected.stdout = format!("'{}'", expected.stdout);
}
// The output should still be captured in the CommandOutput
assert_eq!(actual.stdout.trim(), expected.stdout.trim());
assert_eq!(actual.stderr, expected.stderr);
assert_eq!(actual.success(), expected.success());
}
mod write_lossy_utf8 {
use pretty_assertions::assert_eq;
use super::super::write_lossy_utf8;
fn run(buf: &[u8]) -> (Vec<u8>, Vec<u8>) {
let mut out = Vec::<u8>::new();
let pending = write_lossy_utf8(&mut out, buf).unwrap();
(out, pending)
}
#[test]
fn valid_ascii_passes_through() {
let (out, pending) = run(b"hello");
assert_eq!(out, b"hello");
assert!(pending.is_empty());
}
#[test]
fn valid_multibyte_passes_through() {
// "héllo ✓" — mixed 2-byte and 3-byte codepoints.
let input = "héllo ✓".as_bytes();
let (out, pending) = run(input);
assert_eq!(out, input);
assert!(pending.is_empty());
}
#[test]
fn incomplete_trailing_codepoint_is_buffered() {
// "é" is 0xC3 0xA9 — leading byte alone must be held back.
let (out, pending) = run(&[b'a', 0xC3]);
assert_eq!(out, b"a");
assert_eq!(pending, vec![0xC3]);
}
#[test]
fn multibyte_split_across_two_chunks_emits_once_whole() {
let mut out = Vec::<u8>::new();
let pending = write_lossy_utf8(&mut out, &[b'a', 0xC3]).unwrap();
assert_eq!(pending, vec![0xC3]);
assert_eq!(out, b"a");
let mut working = pending;
working.push(0xA9);
let pending = write_lossy_utf8(&mut out, &working).unwrap();
assert!(pending.is_empty());
assert_eq!(out, "aé".as_bytes());
}
#[test]
fn invalid_byte_in_middle_becomes_replacement() {
let (out, pending) = run(&[b'a', 0xFF, b'b']);
assert_eq!(out, "a\u{FFFD}b".as_bytes());
assert!(pending.is_empty());
}
#[test]
fn lone_continuation_byte_becomes_replacement() {
let (out, pending) = run(&[b'a', 0x80, b'b']);
assert_eq!(out, "a\u{FFFD}b".as_bytes());
assert!(pending.is_empty());
}
#[test]
fn windows_1252_smart_quote_becomes_replacement() {
// Regression: 0x91/0x92 land as bare continuation bytes and broke
// console stdio on Windows before this fix.
let (out, pending) = run(b"quote: \x91hi\x92");
assert_eq!(out, "quote: \u{FFFD}hi\u{FFFD}".as_bytes());
assert!(pending.is_empty());
}
}
}
|