diff --git a/Cargo.lock b/Cargo.lock index c312f12818..82a44f1e50 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -5164,7 +5164,8 @@ checksum = "b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5" name = "infra_utils" version = "0.0.0" dependencies = [ - "thiserror", + "rstest", + "tokio", ] [[package]] diff --git a/crates/infra_utils/Cargo.toml b/crates/infra_utils/Cargo.toml index ed18931577..6b42af283d 100644 --- a/crates/infra_utils/Cargo.toml +++ b/crates/infra_utils/Cargo.toml @@ -10,4 +10,7 @@ description = "Infrastructure utility." workspace = true [dependencies] -thiserror.workspace = true +tokio = { workspace = true, features = ["process"] } + +[dev-dependencies] +rstest.workspace = true diff --git a/crates/infra_utils/src/command.rs b/crates/infra_utils/src/command.rs new file mode 100644 index 0000000000..3d4e955030 --- /dev/null +++ b/crates/infra_utils/src/command.rs @@ -0,0 +1,29 @@ +use std::env; + +use tokio::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..2d18e1cf0d --- /dev/null +++ b/crates/infra_utils/src/command_test.rs @@ -0,0 +1,15 @@ +use rstest::rstest; + +use crate::command::create_shell_command; + +#[rstest] +#[tokio::test] +async fn create_shell_command_example() { + let mut ls_command = create_shell_command("ls"); + let output = ls_command.output().await.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; diff --git a/crates/infra_utils/src/path.rs b/crates/infra_utils/src/path.rs index cfa2444a24..d8080216fe 100644 --- a/crates/infra_utils/src/path.rs +++ b/crates/infra_utils/src/path.rs @@ -1,28 +1,16 @@ -use std::env; use std::path::{Path, PathBuf}; use std::sync::LazyLock; - -use thiserror::Error; +use std::{env, fs}; #[cfg(test)] #[path = "path_test.rs"] mod path_test; -#[derive(Debug, Error)] -pub enum PathResolutionError { - // TODO(Arni): Handle manifest dir not exist here? - #[error("No file exists at '{path}'")] - PathDoesNotExist { path: PathBuf }, - /// This error is raised when file existence can be neither confirmed nor denied. See - /// [`std::path::Path::try_exists`] for more information. - #[error(transparent)] - IoError(#[from] std::io::Error), -} - // TODO(tsabary): wrap path-related env::* invocations in the repo as utility functions static PATH_TO_CARGO_MANIFEST_DIR: LazyLock> = LazyLock::new(|| env::var("CARGO_MANIFEST_DIR").ok().map(|dir| Path::new(&dir).into())); +// TODO(Tsabary): should not be public. Use a getter instead. pub fn cargo_manifest_dir() -> Option { PATH_TO_CARGO_MANIFEST_DIR.clone() } @@ -34,16 +22,21 @@ pub fn cargo_manifest_dir() -> Option { /// * `relative_path` - A string slice representing the relative path from the project root. /// /// # Returns -/// * An absolute `PathBuf` representing the resolved path starting from the project root. -pub fn resolve_project_relative_path(relative_path: &str) -> Result { +/// * A `PathBuf` representing the resolved path starting from the project root. +pub fn resolve_project_relative_path(relative_path: &str) -> Result { let base_dir = path_of_project_root(); - let path = base_dir.join(relative_path); - if !path.try_exists()? { - return Err(PathResolutionError::PathDoesNotExist { path }); - } + let absolute_path = fs::canonicalize(path)?; - Ok(path) + Ok(absolute_path) +} + +/// Returns the absolute path of the project root directory. +/// +/// # Returns +/// * A `PathBuf` representing the path of the project root. +pub fn project_path() -> Result { + resolve_project_relative_path(".") } fn path_of_project_root() -> PathBuf { diff --git a/crates/infra_utils/src/path_test.rs b/crates/infra_utils/src/path_test.rs index 88d7f5ff23..8133007262 100644 --- a/crates/infra_utils/src/path_test.rs +++ b/crates/infra_utils/src/path_test.rs @@ -1,6 +1,5 @@ -use crate::path::{path_of_project_root, resolve_project_relative_path, PathResolutionError}; +use crate::path::{path_of_project_root, resolve_project_relative_path}; -// TODO: Add a test for PathResolutionError::IoError. #[test] fn resolve_project_relative_path_on_non_existent_path() { let relative_path = "does_not_exist.txt"; @@ -8,11 +7,7 @@ fn resolve_project_relative_path_on_non_existent_path() { assert!(!expected_path.exists()); let result = resolve_project_relative_path(relative_path); - if let Err(PathResolutionError::PathDoesNotExist { path }) = result { - assert_eq!(path, expected_path); - } else { - panic!("Expected PathDoesNotExist error, got {:?}", result); - } + assert!(result.is_err(), "Expected an non-existent path error, got {:?}", result); } #[test] diff --git a/crates/papyrus_config/src/lib.rs b/crates/papyrus_config/src/lib.rs index 77e4106f16..7a383cef54 100644 --- a/crates/papyrus_config/src/lib.rs +++ b/crates/papyrus_config/src/lib.rs @@ -49,7 +49,6 @@ use clap::parser::MatchesError; use dumping::REQUIRED_PARAM_DESCRIPTION_PREFIX; -use infra_utils::path::PathResolutionError; use serde::{Deserialize, Serialize}; use serde_json::Value; use validator::ValidationError; @@ -180,8 +179,6 @@ pub enum ConfigError { #[error(transparent)] CommandMatches(#[from] MatchesError), #[error(transparent)] - GetPathError(#[from] PathResolutionError), - #[error(transparent)] IOError(#[from] std::io::Error), // TODO(Eitan): Improve error message #[error("Insert a new param is not allowed: {param_path}.")]