Comment changes

crates/forge-runner/src/backtrace.rs

@@ -21,7 +21,7 @@ use std::{env, fmt};
 
 const BACKTRACE_ENV: &str = "SNFORGE_BACKTRACE";
 
-pub fn add_back_trace_footer(
+pub fn add_backtrace_footer(
     message: String,
     contracts_data: &ContractsData,
     encountered_errors: &[EncounteredError],
@@ -137,17 +137,19 @@ impl ContractBacktraceData {
             .statements_functions
             .get(&sierra_statement_idx)?;
 
+        let stack = code_locations
+            .iter()
+            .zip(function_names)
+            .map(|(code_location, function_name)| Backtrace {
+                code_location,
+                function_name,
+            })
+            .collect();
+
         Some(BacktraceStack {
             pc,
             contract_name: &self.contract_name,
-            origins: code_locations
-                .iter()
-                .zip(function_names)
-                .map(|(code_location, function_name)| Backtrace {
-                    code_location,
-                    function_name,
-                })
-                .collect(),
+            stack,
         })
     }
 }
@@ -187,7 +189,7 @@ struct Backtrace<'a> {
 struct BacktraceStack<'a> {
     pc: usize,
     contract_name: &'a str,
-    origins: Vec<Backtrace<'a>>,
+    stack: Vec<Backtrace<'a>>,
 }
 
 impl Display for Backtrace<'_> {
@@ -209,8 +211,8 @@ impl Display for BacktraceStack<'_> {
             self.contract_name, self.pc
         )?;
         writeln!(f, "possible stack backtrace:")?;
-        for (i, pc_origin) in self.origins.iter().enumerate() {
-            writeln!(f, "   {i}: {pc_origin}")?;
+        for (i, backtrace) in self.stack.iter().enumerate() {
+            writeln!(f, "   {i}: {backtrace}")?;
         }
         Ok(())
     }

crates/forge-runner/src/running.rs

@@ -1,4 +1,4 @@
-use crate::backtrace::add_back_trace_footer;
+use crate::backtrace::add_backtrace_footer;
 use crate::build_trace_data::test_sierra_program_path::VersionedProgramPath;
 use crate::forge_config::{RuntimeConfig, TestRunnerConfig};
 use crate::gas::calculate_used_gas;
@@ -314,7 +314,7 @@ fn extract_test_case_summary(
                         error.to_string().replace(" Custom Hint Error: ", "\n    ")
                     ))
                     .map(|msg| {
-                        add_back_trace_footer(
+                        add_backtrace_footer(
                             msg,
                             contracts_data,
                             &result_with_info.encountered_errors,

crates/forge-runner/src/test_case_summary.rs

@@ -1,4 +1,4 @@
-use crate::backtrace::add_back_trace_footer;
+use crate::backtrace::add_backtrace_footer;
 use crate::build_trace_data::build_profiler_call_trace;
 use crate::build_trace_data::test_sierra_program_path::VersionedProgramPath;
 use crate::expected_result::{ExpectedPanicValue, ExpectedTestResult};
@@ -223,7 +223,7 @@ impl TestCaseSummary<Single> {
     ) -> Self {
         let name = test_case.name.clone();
         let msg = extract_result_data(&run_result, &test_case.config.expected_result)
-            .map(|msg| add_back_trace_footer(msg, contracts_data, encountered_errors));
+            .map(|msg| add_backtrace_footer(msg, contracts_data, encountered_errors));
         match run_result.value {
             RunResultValue::Success(_) => match &test_case.config.expected_result {
                 ExpectedTestResult::Success => {

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

@@ -19,4 +19,4 @@ test = "snforge test"
 
 [profile.dev.cairo]
 unstable-add-statements-functions-debug-info = true
-unstable-add-statements-code-locations-debug-info = true
+unstable-add-statements-code-locations-debug-info = true

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

@@ -19,4 +19,4 @@ test = "snforge test"
 
 [profile.dev.cairo]
 unstable-add-statements-functions-debug-info = true
-unstable-add-statements-code-locations-debug-info = true
+unstable-add-statements-code-locations-debug-info = true

crates/forge/tests/e2e/backtrace.rs

@@ -1,7 +1,7 @@
 use super::common::runner::{setup_package, test_runner};
 use assert_fs::fixture::{FileWriteStr, PathChild};
 use indoc::indoc;
-use shared::test_utils::output_assert::{assert_stdout_contains, AsOutput};
+use shared::test_utils::output_assert::assert_stdout_contains;
 use std::fs;
 use toml_edit::{value, DocumentMut};
 
@@ -60,7 +60,7 @@ fn test_backtrace() {
 
 #[test]
 #[cfg_attr(not(feature = "scarb_2_8_3"), ignore)]
-fn test_wrong_configuration() {
+fn test_wrong_scarb_toml_configuration() {
     let temp = setup_package("backtrace_vm_error");
 
     let manifest_path = temp.child("Scarb.toml");
@@ -103,9 +103,6 @@ fn test_backtrace_panic() {
         .assert()
         .failure();
 
-    println!("{}", output.as_stdout());
-    println!("{}", output.as_stderr());
-
     assert_stdout_contains(
         output,
         indoc! {