Support passing Scarb profiles in snforge test (#3565)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #1619 

## Introduced changes

<!-- A brief description of the changes -->

- Enabled passing the same profile flags as in Scarb
- Moved all Scarb related flags to separate struct `ScarbArgs`
(refactor)

Author: ddoktorski

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Added
 
 - `interact_with_state` cheatcode to enable effective use of `contract_state_for_testing` in snforge tests
+- Support for using [Scarb profiles](https://docs.swmansion.com/scarb/docs/reference/profiles.html) with `snforge test`, allowing to pass the same profile flags as in Scarb (`--release`, `--dev`, `--profile`) to build artifacts using a specific profile
 
 #### Deprecated
 

Cargo.lock

@@ -83,7 +83,7 @@ test-case = "3.3.1"
 scarb-metadata = "1.14.0"
 flatten-serde-json = "0.1.0"
 snapbox = "0.4.17"
-scarb-ui = "0.1.5"
+scarb-ui = "0.1.7"
 semver = "1.0.26"
 bimap = "0.6.3"
 primitive-types = "0.13.1"

Cargo.toml

@@ -10,7 +10,7 @@ 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_ui::args::{FeaturesSpec, PackagesFilter};
+use scarb_ui::args::{FeaturesSpec, PackagesFilter, ProfileSpec};
 use semver::Version;
 use shared::auto_completions::{Completions, generate_completions};
 use std::cell::RefCell;
@@ -162,9 +162,6 @@ pub struct TestArgs {
     #[arg(short = 'x', long)]
     exit_first: bool,
 
-    #[command(flatten)]
-    packages_filter: PackagesFilter,
-
     /// Number of fuzzer runs
     #[arg(short = 'r', long)]
     fuzzer_runs: Option<NonZeroU32>,
@@ -207,10 +204,6 @@ pub struct TestArgs {
     #[arg(long)]
     max_n_steps: Option<u32>,
 
-    /// Specify features to enable
-    #[command(flatten)]
-    pub features: FeaturesSpec,
-
     /// Build contracts separately in the scarb starknet contract target
     #[arg(long)]
     no_optimization: bool,
@@ -222,6 +215,21 @@ pub struct TestArgs {
     /// Additional arguments for cairo-coverage or cairo-profiler
     #[arg(last = true)]
     additional_args: Vec<OsString>,
+
+    #[command(flatten)]
+    scarb_args: ScarbArgs,
+}
+
+#[derive(Parser, Debug)]
+pub struct ScarbArgs {
+    #[command(flatten)]
+    packages_filter: PackagesFilter,
+
+    #[command(flatten)]
+    features: FeaturesSpec,
+
+    #[command(flatten)]
+    profile: ProfileSpec,
 }
 
 #[derive(ValueEnum, Display, Debug, Clone)]

crates/forge/src/lib.rs

@@ -32,7 +32,11 @@ pub async fn run_for_workspace(args: TestArgs, ui: Arc<UI>) -> Result<ExitStatus
         ColorOption::Auto => (),
     }
 
-    let scarb_metadata = ScarbCommand::metadata().inherit_stderr().run()?;
+    let mut metadata_command = ScarbCommand::metadata();
+    if let Some(profile) = &args.scarb_args.profile.specified() {
+        metadata_command.profile(profile.clone());
+    }
+    let scarb_metadata = metadata_command.inherit_stderr().run()?;
 
     if args.coverage {
         can_coverage_be_generated(&scarb_metadata)?;
@@ -46,6 +50,7 @@ pub async fn run_for_workspace(args: TestArgs, ui: Arc<UI>) -> Result<ExitStatus
         target_dir_for_workspace(&scarb_metadata).join(&scarb_metadata.current_profile);
 
     let packages: Vec<PackageMetadata> = args
+        .scarb_args
         .packages_filter
         .match_many(&scarb_metadata)
         .context("Failed to find any packages matching the specified filter")?;
@@ -63,7 +68,8 @@ pub async fn run_for_workspace(args: TestArgs, ui: Arc<UI>) -> Result<ExitStatus
 
     build_artifacts_with_scarb(
         filter.clone(),
-        args.features.clone(),
+        args.scarb_args.features.clone(),
+        args.scarb_args.profile.clone(),
         &scarb_metadata.app_version_info.version,
         args.no_optimization,
     )?;

crates/forge/src/run_tests/workspace.rs

@@ -7,7 +7,7 @@ use forge_runner::package_tests::TestTargetLocation;
 use forge_runner::package_tests::raw::TestTargetRaw;
 use scarb_api::{ScarbCommand, test_targets_by_name};
 use scarb_metadata::PackageMetadata;
-use scarb_ui::args::{FeaturesSpec, PackagesFilter};
+use scarb_ui::args::{FeaturesSpec, PackagesFilter, ProfileSpec};
 use semver::Version;
 use std::fs;
 use std::io::ErrorKind;
@@ -40,32 +40,43 @@ pub fn should_compile_starknet_contract_target(
 pub fn build_artifacts_with_scarb(
     filter: PackagesFilter,
     features: FeaturesSpec,
+    profile: ProfileSpec,
     scarb_version: &Version,
     no_optimization: bool,
 ) -> Result<()> {
     if should_compile_starknet_contract_target(scarb_version, no_optimization) {
-        build_contracts_with_scarb(filter.clone(), features.clone())?;
+        build_contracts_with_scarb(filter.clone(), features.clone(), profile.clone())?;
     }
-    build_test_artifacts_with_scarb(filter, features)?;
+    build_test_artifacts_with_scarb(filter, features, profile)?;
     Ok(())
 }
 
-fn build_contracts_with_scarb(filter: PackagesFilter, features: FeaturesSpec) -> Result<()> {
+fn build_contracts_with_scarb(
+    filter: PackagesFilter,
+    features: FeaturesSpec,
+    profile: ProfileSpec,
+) -> Result<()> {
     ScarbCommand::new_with_stdio()
         .arg("build")
         .packages_filter(filter)
         .features(features)
+        .profile(profile)
         .run()
         .context("Failed to build contracts with Scarb")?;
     Ok(())
 }
 
-fn build_test_artifacts_with_scarb(filter: PackagesFilter, features: FeaturesSpec) -> Result<()> {
+fn build_test_artifacts_with_scarb(
+    filter: PackagesFilter,
+    features: FeaturesSpec,
+    profile: ProfileSpec,
+) -> Result<()> {
     ScarbCommand::new_with_stdio()
         .arg("build")
         .arg("--test")
         .packages_filter(filter)
         .features(features)
+        .profile(profile)
         .run()
         .context("Failed to build test artifacts with Scarb")?;
     Ok(())

crates/forge/src/scarb.rs

@@ -13,3 +13,9 @@ snforge_std = { path = "../../../../../snforge_std" }
 
 [[target.starknet-contract]]
 sierra = true
+
+[profile.custom-profile]
+inherits = "release"
+
+[profile.custom-profile.cairo]
+sierra-replace-ids = true

crates/forge/tests/data/empty/Scarb.toml

@@ -20,6 +20,7 @@ mod forking;
 mod fuzzing;
 mod io_operations;
 mod new;
+mod profiles;
 mod requirements;
 mod running;
 mod steps;

crates/forge/tests/e2e/mod.rs

@@ -0,0 +1,44 @@
+use super::common::runner::{setup_package, test_runner};
+use indoc::indoc;
+use shared::test_utils::output_assert::assert_stdout_contains;
+
+#[test]
+fn release() {
+    let temp = setup_package("empty");
+
+    let output = test_runner(&temp).arg("--release").assert().code(0);
+
+    assert_stdout_contains(
+        output,
+        indoc! {r"
+        [..]Compiling[..]
+        [..]Finished `release` profile target(s) in [..]
+
+
+        Collected 0 test(s) from empty package
+        Tests: 0 passed, 0 failed, 0 ignored, 0 filtered out
+        "},
+    );
+}
+
+#[test]
+fn custom() {
+    let temp = setup_package("empty");
+
+    let output = test_runner(&temp)
+        .args(["--profile", "custom-profile"])
+        .assert()
+        .code(0);
+
+    assert_stdout_contains(
+        output,
+        indoc! {r"
+        [..]Compiling[..]
+        [..]Finished `custom-profile` profile target(s) in [..]
+
+
+        Collected 0 test(s) from empty package
+        Tests: 0 passed, 0 failed, 0 ignored, 0 filtered out
+        "},
+    );
+}

crates/forge/tests/e2e/profiles.rs

@@ -1,7 +1,7 @@
 use crate::metadata::MetadataCommand;
 use crate::version::VersionCommand;
 use anyhow::Context;
-use scarb_ui::args::{FeaturesSpec, PackagesFilter, ToEnvVars};
+use scarb_ui::args::{FeaturesSpec, PackagesFilter, ProfileSpec, ToEnvVars};
 use std::collections::HashMap;
 use std::ffi::{OsStr, OsString};
 use std::path::PathBuf;
@@ -101,6 +101,12 @@ impl ScarbCommand {
         self
     }
 
+    /// Pass profile to `scarb` call.
+    pub fn profile(&mut self, profile: ProfileSpec) -> &mut Self {
+        self.envs(profile.to_env_vars());
+        self
+    }
+
     /// Current directory of the `scarb` process.
     pub fn current_dir(&mut self, path: impl Into<PathBuf>) -> &mut Self {
         self.current_dir = Some(path.into());