From 798be68480e07d82f4e74c4a17987f5751a8c6c7 Mon Sep 17 00:00:00 2001
From: Itay Tsabary <itayt@starkware.co>
Date: Mon, 25 Nov 2024 11:14:34 +0200
Subject: [PATCH] chore: add shell command builder

commit-id:96859c27
---
 crates/infra_utils/src/command.rs      | 28 ++++++++++++++++++++++++++
 crates/infra_utils/src/command_test.rs | 12 +++++++++++
 crates/infra_utils/src/lib.rs          |  1 +
 3 files changed, 41 insertions(+)
 create mode 100644 crates/infra_utils/src/command.rs
 create mode 100644 crates/infra_utils/src/command_test.rs

diff --git a/crates/infra_utils/src/command.rs b/crates/infra_utils/src/command.rs
new file mode 100644
index 0000000000..4a22cac174
--- /dev/null
+++ b/crates/infra_utils/src/command.rs
@@ -0,0 +1,28 @@
+use std::env;
+use std::process::Command;
+
+use crate::path::project_path;
+
+#[cfg(test)]
+#[path = "command_test.rs"]
+mod command_test;
+
+/// Returns a shell command originating from the project root, with cargo environment variables
+/// filtered out.
+///
+/// # Arguments
+/// * `command_name` - The shell command name.
+///
+/// # Returns
+/// * A [`std::process::Command`] object with the current directory set to the project root, and
+///   cleared out cargo related environment variables.
+pub fn create_shell_command(command_name: &str) -> Command {
+    let project_path = project_path().expect("Failed to get project path");
+    let mut command = Command::new(command_name);
+    command.current_dir(&project_path);
+    // Filter out all CARGO_ environment variables.
+    env::vars().filter(|(key, _)| key.starts_with("CARGO_")).for_each(|(key, _)| {
+        command.env_remove(key);
+    });
+    command
+}
diff --git a/crates/infra_utils/src/command_test.rs b/crates/infra_utils/src/command_test.rs
new file mode 100644
index 0000000000..239b92475f
--- /dev/null
+++ b/crates/infra_utils/src/command_test.rs
@@ -0,0 +1,12 @@
+use crate::command::create_shell_command;
+
+#[test]
+fn create_shell_command_example() {
+    let mut ls_command = create_shell_command("ls");
+    let output = ls_command.output().expect("Failed to execute command");
+    let stdout = String::from_utf8_lossy(&output.stdout);
+
+    assert!(output.status.success());
+    // Project root should contain the `crates` directory.
+    assert!(stdout.contains("crates"));
+}
diff --git a/crates/infra_utils/src/lib.rs b/crates/infra_utils/src/lib.rs
index 4da9789237..f744151bf9 100644
--- a/crates/infra_utils/src/lib.rs
+++ b/crates/infra_utils/src/lib.rs
@@ -1 +1,2 @@
+pub mod command;
 pub mod path;