Metadata refactor

Author: ksew1

crates/cheatnet/tests/common/mod.rs

@@ -27,10 +27,9 @@ use conversions::string::TryFromHexStr;
 use foundry_ui::UI;
 use runtime::starknet::constants::TEST_ADDRESS;
 use runtime::starknet::context::build_context;
-use scarb_api::metadata::MetadataCommandExt;
+use scarb_api::metadata::get_metadata_for_dir;
 use scarb_api::{
-    CompilationOpts, ScarbCommand, get_contracts_artifacts_and_source_sierra_paths,
-    target_dir_for_workspace,
+    CompilationOpts, get_contracts_artifacts_and_source_sierra_paths, target_dir_for_workspace,
 };
 use starknet::core::utils::get_selector_from_name;
 use starknet_api::contract_class::EntryPointType;
@@ -76,11 +75,7 @@ pub fn recover_data(output: CallResult) -> Vec<Felt> {
 }
 
 pub fn get_contracts() -> ContractsData {
-    let scarb_metadata = ScarbCommand::metadata()
-        .inherit_stderr()
-        .manifest_path("tests/contracts/Scarb.toml")
-        .run()
-        .unwrap();
+    let scarb_metadata = get_metadata_for_dir("tests/contracts").unwrap();
     let target_dir = target_dir_for_workspace(&scarb_metadata).join("dev");
 
     let package = scarb_metadata.packages.first().unwrap();

crates/forge/src/clean.rs

@@ -2,7 +2,7 @@ use crate::{CleanArgs, CleanComponent};
 use anyhow::{Context, Result, ensure};
 use camino::Utf8PathBuf;
 use foundry_ui::UI;
-use scarb_api::{ScarbCommand, metadata::MetadataCommandExt};
+use scarb_api::metadata::get_metadata;
 use std::fs;
 
 const COVERAGE_DIR: &str = "coverage";
@@ -26,7 +26,7 @@ pub fn clean(args: CleanArgs, ui: &UI) -> Result<()> {
         args.clean_components
     };
 
-    let scarb_metadata = ScarbCommand::metadata().inherit_stderr().no_deps().run()?;
+    let scarb_metadata = get_metadata()?;
     let workspace_root = scarb_metadata.workspace.root;
 
     let packages_root: Vec<Utf8PathBuf> = scarb_metadata

crates/forge/src/lib.rs

@@ -9,7 +9,8 @@ use forge_runner::forge_config::ForgeTrackedResource;
 use foundry_ui::components::warning::WarningMessage;
 use foundry_ui::{Message, UI};
 use run_tests::workspace::run_for_workspace;
-use scarb_api::{ScarbCommand, metadata::MetadataCommandExt};
+use scarb_api::ScarbCommand;
+use scarb_api::metadata::get_metadata;
 use scarb_ui::args::{FeaturesSpec, PackagesFilter, ProfileSpec};
 use semver::Version;
 use shared::auto_completions::{Completions, generate_completions};
@@ -298,7 +299,7 @@ pub fn main_execution(ui: Arc<UI>) -> Result<ExitStatus> {
         }
         ForgeSubcommand::CleanCache {} => {
             ui.println(&WarningMessage::new("`snforge clean-cache` is deprecated and will be removed in the future. Use `snforge clean cache` instead"));
-            let scarb_metadata = ScarbCommand::metadata().inherit_stderr().run()?;
+            let scarb_metadata = get_metadata()?;
             let cache_dir = scarb_metadata.workspace.root.join(CACHE_DIR);
 
             if cache_dir.exists() {

crates/forge/src/run_tests/workspace.rs

@@ -22,6 +22,7 @@ use scarb_api::{
     metadata::{Metadata, MetadataCommandExt, PackageMetadata},
     target_dir_for_workspace,
 };
+use scarb_metadata::MetadataCommand;
 use scarb_ui::args::PackagesFilter;
 use shared::consts::SNFORGE_TEST_FILTER;
 use std::env;
@@ -37,7 +38,7 @@ pub async fn run_for_workspace(args: TestArgs, ui: Arc<UI>) -> Result<ExitStatus
         ColorOption::Auto => (),
     }
 
-    let mut metadata_command = ScarbCommand::metadata();
+    let mut metadata_command = MetadataCommand::new();
     if let Some(profile) = &args.scarb_args.profile.specified() {
         metadata_command.profile(profile.clone());
     }

crates/scarb-api/src/lib.rs

@@ -221,7 +221,7 @@ pub fn test_targets_by_name(package: &PackageMetadata) -> HashMap<String, &Targe
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::metadata::MetadataCommandExt;
+    use crate::metadata::get_metadata_for_dir;
     use assert_fs::TempDir;
     use assert_fs::fixture::{FileWriteStr, PathChild, PathCopy};
     use camino::Utf8PathBuf;
@@ -324,10 +324,7 @@ mod tests {
             .run()
             .unwrap();
 
-        let metadata = ScarbCommand::metadata()
-            .current_dir(temp.path())
-            .run()
-            .unwrap();
+        let metadata = get_metadata_for_dir(temp.path()).unwrap();
 
         let package = metadata
             .packages
@@ -378,10 +375,7 @@ mod tests {
             .run()
             .unwrap();
 
-        let metadata = ScarbCommand::metadata()
-            .current_dir(temp.path())
-            .run()
-            .unwrap();
+        let metadata = get_metadata_for_dir(temp.path()).unwrap();
 
         let package = metadata
             .packages
@@ -436,11 +430,7 @@ mod tests {
             ))
             .unwrap();
 
-        let scarb_metadata = ScarbCommand::metadata()
-            .inherit_stderr()
-            .current_dir(temp.path())
-            .run()
-            .unwrap();
+        let scarb_metadata = get_metadata_for_dir(temp.path()).unwrap();
 
         assert!(
             package_matches_version_requirement(
@@ -580,11 +570,7 @@ mod tests {
             .run()
             .unwrap();
 
-        let metadata = ScarbCommand::metadata()
-            .inherit_stderr()
-            .manifest_path(temp.join("Scarb.toml"))
-            .run()
-            .unwrap();
+        let metadata = get_metadata_for_dir(temp.path()).unwrap();
 
         let target_dir = target_dir_for_workspace(&metadata).join("dev");
         let package = metadata.packages.first().unwrap();
@@ -623,11 +609,7 @@ mod tests {
     #[test]
     fn get_name_for_package() {
         let temp = setup_package("basic_package");
-        let scarb_metadata = ScarbCommand::metadata()
-            .inherit_stderr()
-            .current_dir(temp.path())
-            .run()
-            .unwrap();
+        let scarb_metadata = get_metadata_for_dir(temp.path()).unwrap();
 
         let package_name =
             name_for_package(&scarb_metadata, &scarb_metadata.workspace.members[0]).unwrap();

crates/scarb-api/src/metadata.rs

@@ -1,5 +1,6 @@
 use anyhow::{Context, Result};
 pub use scarb_metadata::{Metadata, MetadataCommand, MetadataCommandError, PackageMetadata};
+use std::path::PathBuf;
 
 pub trait MetadataCommandExt {
     fn run(&mut self) -> Result<Metadata>;
@@ -12,3 +13,24 @@ impl MetadataCommandExt for MetadataCommand {
             .context("error: could not gather project metadata from Scarb due to previous error")
     }
 }
+
+pub fn get_metadata_for_dir(dir: impl Into<PathBuf>) -> Result<Metadata> {
+    get_metadata_inner(Some(dir))
+}
+
+pub fn get_metadata() -> Result<Metadata> {
+    get_metadata_inner(None::<PathBuf>)
+}
+
+fn get_metadata_inner(current_dir: Option<impl Into<PathBuf>>) -> Result<Metadata> {
+    let mut command = MetadataCommand::new();
+    if let Some(dir) = current_dir {
+        command.current_dir(dir);
+    }
+
+    command
+        .inherit_stderr()
+        .inherit_stdout()
+        .exec()
+        .context("error: could not gather project metadata from Scarb due to previous error")
+}

crates/sncast/src/helpers/scarb_utils.rs

@@ -41,7 +41,10 @@ fn get_scarb_metadata_command(manifest_path: &Utf8PathBuf) -> Result<MetadataCom
     ScarbCommand::new().ensure_available()?;
 
     let mut command = ScarbCommand::metadata();
-    command.inherit_stderr().manifest_path(manifest_path);
+    command
+        .inherit_stderr()
+        .manifest_path(manifest_path)
+        .no_deps();
     Ok(command)
 }