Add option to specify verbosity via cli (#3601)

commit-id:00fe6d0d

---

**Stack**:
- #3612
- #3609
- #3605
- #3601 ⬅


⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*

Author: ksew1

crates/forge-runner/src/debugging/args.rs

@@ -0,0 +1,35 @@
+use crate::debugging::TraceVerbosity;
+use crate::debugging::component::Component;
+use clap::Args;
+use debugging::Components;
+
+#[derive(Args, Debug, Clone, Default, Eq, PartialEq)]
+#[group(required = false, multiple = false)]
+pub struct TraceArgs {
+    /// Trace verbosity level
+    #[arg(long)]
+    trace_verbosity: Option<TraceVerbosity>,
+
+    /// Components to include in the trace.
+    #[arg(long, num_args = 1.., value_delimiter = ' ')]
+    trace_components: Option<Vec<Component>>,
+}
+
+impl TraceArgs {
+    /// Returns the [`Option<Components>`] based on the provided arguments.
+    #[must_use]
+    pub fn to_components(&self) -> Option<Components> {
+        match (&self.trace_components, &self.trace_verbosity) {
+            (None, Some(verbosity)) => Some(build_components(verbosity.to_components_vec())),
+            (Some(components), None) => Some(build_components(components)),
+            (None, None) => None,
+            (Some(_), Some(_)) => {
+                unreachable!("this case is impossible, as it is handled by clap")
+            }
+        }
+    }
+}
+
+fn build_components<'a>(iter: impl IntoIterator<Item = &'a Component>) -> Components {
+    Components::new(iter.into_iter().map(debugging::Component::from).collect())
+}

crates/forge-runner/src/debugging/component.rs

@@ -1,8 +1,9 @@
 use crate::debugging::trace_verbosity::TraceVerbosity;
+use clap::ValueEnum;
 use strum_macros::VariantArray;
 
 /// Components that will be included in the trace.
-#[derive(Clone, VariantArray)]
+#[derive(ValueEnum, Clone, VariantArray, Debug, Eq, PartialEq)]
 pub enum Component {
     /// The name of the contract being called.
     ContractName,
@@ -34,8 +35,8 @@ impl Component {
     }
 }
 
-impl From<Component> for debugging::Component {
-    fn from(component: Component) -> Self {
+impl From<&Component> for debugging::Component {
+    fn from(component: &Component) -> Self {
         match component {
             Component::ContractName => debugging::Component::ContractName,
             Component::EntryPointType => debugging::Component::EntryPointType,

crates/forge-runner/src/debugging/mod.rs

@@ -1,25 +1,28 @@
+mod args;
 mod component;
 mod trace_verbosity;
 
 use cheatnet::forking::data::ForkData;
 use cheatnet::runtime_extensions::forge_runtime_extension::contracts_data::ContractsData;
 use cheatnet::state::CallTrace;
 
+pub use args::TraceArgs;
 pub use trace_verbosity::TraceVerbosity;
 
 #[must_use]
 pub fn build_debugging_trace(
     call_trace: &CallTrace,
     contracts_data: &ContractsData,
-    trace_verbosity: Option<TraceVerbosity>,
+    trace_args: &TraceArgs,
     test_name: String,
     fork_data: &ForkData,
 ) -> Option<debugging::Trace> {
+    let components = trace_args.to_components()?;
     let contracts_data_store = debugging::ContractsDataStore::new(contracts_data, fork_data);
     Some(debugging::Trace::new(
         call_trace,
         &contracts_data_store,
-        &trace_verbosity?.to_components(),
+        &components,
         test_name,
     ))
 }

crates/forge-runner/src/debugging/trace_verbosity.rs

@@ -1,6 +1,5 @@
 use crate::debugging::component::Component;
 use clap::ValueEnum;
-use debugging::Components;
 use strum::VariantArray;
 
 /// Trace verbosity level.
@@ -15,16 +14,12 @@ pub enum TraceVerbosity {
 }
 
 impl TraceVerbosity {
-    /// Converts the [`TraceVerbosity`] to a [`Components`] that will be included in the trace.
+    /// Converts the [`TraceVerbosity`] to a vector of [`Component`].
     #[must_use]
-    pub fn to_components(&self) -> Components {
-        Components::new(
-            Component::VARIANTS
-                .iter()
-                .filter(|component| component.verbosity() <= *self)
-                .cloned()
-                .map(debugging::Component::from)
-                .collect(),
-        )
+    pub fn to_components_vec(&self) -> Vec<&Component> {
+        Component::VARIANTS
+            .iter()
+            .filter(|component| component.verbosity() <= *self)
+            .collect()
     }
 }

crates/forge-runner/src/forge_config.rs

@@ -1,3 +1,4 @@
+use crate::debugging::TraceArgs;
 use blockifier::execution::contract_class::TrackedResource;
 use camino::Utf8PathBuf;
 use cheatnet::runtime_extensions::forge_runtime_extension::contracts_data::ContractsData;
@@ -29,6 +30,7 @@ pub struct TestRunnerConfig {
 
 #[derive(Debug, PartialEq)]
 pub struct OutputConfig {
+    pub trace_args: TraceArgs,
     pub detailed_resources: bool,
     pub execution_data_to_save: ExecutionDataToSave,
 }

crates/forge-runner/src/lib.rs

@@ -1,6 +1,5 @@
 use crate::coverage_api::run_coverage;
-use crate::debugging::TraceVerbosity;
-use crate::forge_config::{ExecutionDataToSave, ForgeConfig, TestRunnerConfig};
+use crate::forge_config::{ExecutionDataToSave, ForgeConfig};
 use crate::running::{run_fuzz_test, run_test};
 use crate::test_case_summary::TestCaseSummary;
 use anyhow::Result;
@@ -110,7 +109,6 @@ pub fn run_for_test_case(
     forge_config: Arc<ForgeConfig>,
     versioned_program_path: Arc<Utf8PathBuf>,
     send: Sender<()>,
-    trace_verbosity: Option<TraceVerbosity>,
     ui: &Arc<UI>,
 ) -> JoinHandle<Result<AnyTestCaseSummary>> {
     if case.config.fuzzer_config.is_none() {
@@ -119,10 +117,9 @@ pub fn run_for_test_case(
             let res = run_test(
                 case,
                 casm_program,
-                forge_config.test_runner_config.clone(),
+                forge_config,
                 versioned_program_path,
                 send,
-                trace_verbosity,
                 ui,
             )
             .await?;
@@ -134,10 +131,9 @@ pub fn run_for_test_case(
             let res = run_with_fuzzing(
                 case,
                 casm_program,
-                forge_config.test_runner_config.clone(),
+                forge_config.clone(),
                 versioned_program_path,
                 send,
-                trace_verbosity,
                 ui,
             )
             .await??;
@@ -149,13 +145,13 @@ pub fn run_for_test_case(
 fn run_with_fuzzing(
     case: Arc<TestCaseWithResolvedConfig>,
     casm_program: Arc<AssembledProgramWithDebugInfo>,
-    test_runner_config: Arc<TestRunnerConfig>,
+    forge_config: Arc<ForgeConfig>,
     versioned_program_path: Arc<Utf8PathBuf>,
     send: Sender<()>,
-    trace_verbosity: Option<TraceVerbosity>,
     ui: Arc<UI>,
 ) -> JoinHandle<Result<TestCaseSummary<Fuzzing>>> {
     tokio::task::spawn(async move {
+        let test_runner_config = &forge_config.test_runner_config;
         if send.is_closed() {
             return Ok(TestCaseSummary::Interrupted {});
         }
@@ -182,12 +178,11 @@ fn run_with_fuzzing(
             tasks.push(run_fuzz_test(
                 case.clone(),
                 casm_program.clone(),
-                test_runner_config.clone(),
+                forge_config.clone(),
                 versioned_program_path.clone(),
                 send.clone(),
                 fuzzing_send.clone(),
                 rng.clone(),
-                trace_verbosity,
                 ui,
             ));
         }

crates/forge-runner/src/running.rs

@@ -1,5 +1,5 @@
 use crate::backtrace::add_backtrace_footer;
-use crate::forge_config::{RuntimeConfig, TestRunnerConfig};
+use crate::forge_config::{ForgeConfig, RuntimeConfig};
 use crate::gas::calculate_used_gas;
 use crate::package_tests::with_config_resolved::{ResolvedForkConfig, TestCaseWithResolvedConfig};
 use crate::test_case_summary::{Single, TestCaseSummary};
@@ -20,7 +20,6 @@ use cheatnet::forking::state::ForkStateReader;
 use cheatnet::runtime_extensions::call_to_blockifier_runtime_extension::CallToBlockifierExtension;
 use cheatnet::runtime_extensions::call_to_blockifier_runtime_extension::rpc::UsedResources;
 use cheatnet::runtime_extensions::cheatable_starknet_runtime_extension::CheatableStarknetRuntimeExtension;
-use cheatnet::runtime_extensions::forge_runtime_extension::contracts_data::ContractsData;
 use cheatnet::runtime_extensions::forge_runtime_extension::{
     ForgeExtension, ForgeRuntime, add_resources_to_top_call, get_all_used_resources,
     update_top_call_l1_resources, update_top_call_resources, update_top_call_vm_trace,
@@ -52,7 +51,7 @@ mod setup;
 mod syscall_handler;
 pub mod with_config;
 
-use crate::debugging::{TraceVerbosity, build_debugging_trace};
+use crate::debugging::build_debugging_trace;
 pub use hints::hints_to_params;
 use setup::VmExecutionContext;
 pub use syscall_handler::has_segment_arena;
@@ -62,10 +61,9 @@ pub use syscall_handler::syscall_handler_offset;
 pub fn run_test(
     case: Arc<TestCaseWithResolvedConfig>,
     casm_program: Arc<AssembledProgramWithDebugInfo>,
-    test_runner_config: Arc<TestRunnerConfig>,
+    forge_config: Arc<ForgeConfig>,
     versioned_program_path: Arc<Utf8PathBuf>,
     send: Sender<()>,
-    trace_verbosity: Option<TraceVerbosity>,
     ui: Arc<UI>,
 ) -> JoinHandle<TestCaseSummary<Single>> {
     tokio::task::spawn_blocking(move || {
@@ -78,7 +76,7 @@ pub fn run_test(
         let run_result = run_test_case(
             &case,
             &casm_program,
-            &RuntimeConfig::from(&test_runner_config),
+            &RuntimeConfig::from(&forge_config.test_runner_config),
             None,
         );
 
@@ -89,9 +87,8 @@ pub fn run_test(
         extract_test_case_summary(
             run_result,
             &case,
-            &test_runner_config.contracts_data,
+            &forge_config,
             &versioned_program_path,
-            trace_verbosity,
             &ui,
         )
     })
@@ -101,12 +98,11 @@ pub fn run_test(
 pub(crate) fn run_fuzz_test(
     case: Arc<TestCaseWithResolvedConfig>,
     casm_program: Arc<AssembledProgramWithDebugInfo>,
-    test_runner_config: Arc<TestRunnerConfig>,
+    forge_config: Arc<ForgeConfig>,
     versioned_program_path: Arc<Utf8PathBuf>,
     send: Sender<()>,
     fuzzing_send: Sender<()>,
     rng: Arc<Mutex<StdRng>>,
-    trace_verbosity: Option<TraceVerbosity>,
     ui: Arc<UI>,
 ) -> JoinHandle<TestCaseSummary<Single>> {
     tokio::task::spawn_blocking(move || {
@@ -120,7 +116,7 @@ pub(crate) fn run_fuzz_test(
         let run_result = run_test_case(
             &case,
             &casm_program,
-            &Arc::new(RuntimeConfig::from(&test_runner_config)),
+            &RuntimeConfig::from(&forge_config.test_runner_config),
             Some(rng),
         );
 
@@ -134,9 +130,8 @@ pub(crate) fn run_fuzz_test(
         extract_test_case_summary(
             run_result,
             &case,
-            &test_runner_config.contracts_data,
+            &forge_config,
             &versioned_program_path,
-            trace_verbosity,
             &ui,
         )
     })
@@ -391,19 +386,20 @@ pub fn run_test_case(
 fn extract_test_case_summary(
     run_result: Result<RunResult>,
     case: &TestCaseWithResolvedConfig,
-    contracts_data: &ContractsData,
+    forge_config: &ForgeConfig,
     versioned_program_path: &Utf8Path,
-    trace_verbosity: Option<TraceVerbosity>,
     ui: &UI,
 ) -> TestCaseSummary<Single> {
+    let contracts_data = &forge_config.test_runner_config.contracts_data;
+    let trace_args = &forge_config.output_config.trace_args;
     match run_result {
         Ok(run_result) => match run_result {
             RunResult::Completed(run_completed) => TestCaseSummary::from_run_completed(
                 *run_completed,
                 case,
                 contracts_data,
                 versioned_program_path,
-                trace_verbosity,
+                trace_args,
                 ui,
             ),
             RunResult::Error(run_error) => {
@@ -431,7 +427,7 @@ fn extract_test_case_summary(
                     debugging_trace: build_debugging_trace(
                         &run_error.call_trace.borrow(),
                         contracts_data,
-                        trace_verbosity,
+                        trace_args,
                         case.name.clone(),
                         &run_error.fork_data,
                     ),

crates/forge-runner/src/test_case_summary.rs

@@ -1,6 +1,6 @@
 use crate::backtrace::{add_backtrace_footer, get_backtrace, is_backtrace_enabled};
 use crate::build_trace_data::build_profiler_call_trace;
-use crate::debugging::{TraceVerbosity, build_debugging_trace};
+use crate::debugging::{TraceArgs, build_debugging_trace};
 use crate::expected_result::{ExpectedPanicValue, ExpectedTestResult};
 use crate::gas::check_available_gas;
 use crate::package_tests::with_config_resolved::TestCaseWithResolvedConfig;
@@ -324,15 +324,15 @@ impl TestCaseSummary<Single> {
         test_case: &TestCaseWithResolvedConfig,
         contracts_data: &ContractsData,
         versioned_program_path: &Utf8Path,
-        trace_verbosity: Option<TraceVerbosity>,
+        trace_args: &TraceArgs,
         ui: &UI,
     ) -> Self {
         let name = test_case.name.clone();
 
         let debugging_trace = build_debugging_trace(
             &call_trace.borrow(),
             contracts_data,
-            trace_verbosity,
+            trace_args,
             name.clone(),
             &fork_data,
         );