fix(forge): show backtrace line only on -vvvvv (#12211)

* fix(forge): show backtrace line only on -vvvvv

* fix tests

* Update docs

* Fix

---------

Co-authored-by: 0xrusowsky <[email protected]>

Author: grandizzy

crates/cast/tests/cli/main.rs

@@ -92,7 +92,9 @@ Display options:
           - 2 (-vv): Print logs for all tests.
           - 3 (-vvv): Print execution traces for failing tests.
           - 4 (-vvvv): Print execution traces for all tests, and setup traces for failing tests.
-          - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes.
+          - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes
+          and
+            backtraces with line numbers.
 
 Find more information in the book: https://getfoundry.sh/cast/overview
 

crates/cli/src/opts/global.rs

@@ -18,7 +18,8 @@ pub struct GlobalArgs {
     /// - 2 (-vv): Print logs for all tests.
     /// - 3 (-vvv): Print execution traces for failing tests.
     /// - 4 (-vvvv): Print execution traces for all tests, and setup traces for failing tests.
-    /// - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes.
+    /// - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes and
+    ///   backtraces with line numbers.
     #[arg(help_heading = "Display options", global = true, short, long, verbatim_doc_comment, conflicts_with = "quiet", action = ArgAction::Count)]
     verbosity: Verbosity,
 

crates/evm/traces/src/lib.rs

@@ -358,9 +358,13 @@ impl TraceMode {
     }
 
     pub fn with_verbosity(self, verbosity: u8) -> Self {
-        // Enable step recording for backtraces when verbosity >= 3
-        // We need to ensure we're recording JUMP AND JUMPDEST steps:
-        if verbosity >= 3 { std::cmp::max(self, Self::Steps) } else { self }
+        match verbosity {
+            0..3 => self,
+            3..=4 => std::cmp::max(self, Self::Call),
+            // Enable step recording for backtraces when verbosity is 5 or higher.
+            // We need to ensure we're recording JUMP AND JUMPDEST steps.
+            _ => std::cmp::min(self, Self::Steps),
+        }
     }
 
     pub fn into_config(self) -> Option<TracingInspectorConfig> {

crates/forge/tests/cli/backtrace.rs

@@ -12,7 +12,7 @@ forgetest!(test_backtraces, |prj, cmd| {
 
     prj.add_test("Backtrace.t.sol", include_str!("../fixtures/backtraces/Backtrace.t.sol"));
 
-    let output = cmd.args(["test", "-vvv"]).assert_failure();
+    let output = cmd.args(["test", "-vvvvv"]).assert_failure();
 
     output.stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
@@ -165,7 +165,7 @@ contract BacktraceTest is DSTest {
 "#,
     );
 
-    let output = cmd.args(["test", "-vvv"]).assert_failure();
+    let output = cmd.args(["test", "-vvvvv"]).assert_failure();
 
     output.stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
@@ -239,7 +239,7 @@ contract BacktraceTest is DSTest {
 
     // Second run - mixed compilation (SimpleRevert fresh, BacktraceTest fresh, HelperContract
     // cached)
-    let output = cmd.forge_fuse().args(["test", "-vvv"]).assert_failure();
+    let output = cmd.forge_fuse().args(["test", "-vvvvv"]).assert_failure();
 
     output.stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
@@ -306,65 +306,65 @@ Ran 9 tests for test/LibraryBacktrace.t.sol:LibraryBacktraceTest
 [FAIL: DivisionByZero()] testExternalDivisionByZero() ([GAS])
 ...
 Backtrace:
-  at ExternalMathLib.div (src/libraries/ExternalMathLib.sol:11:48)
-  at LibraryConsumer.externalDivide (src/LibraryConsumer.sol:43:95)
-  at LibraryBacktraceTest.testExternalDivisionByZero (test/LibraryBacktrace.t.sol:49:60)
+  at ExternalMathLib.div
+  at LibraryConsumer.externalDivide
+  at LibraryBacktraceTest.testExternalDivisionByZero
 
 [FAIL: panic: arithmetic underflow or overflow (0x11)] testExternalOverflow() ([GAS])
 ...
 Backtrace:
   at ExternalMathLib.mul
-  at LibraryConsumer.externalMultiply (src/LibraryConsumer.sol:49:97)
-  at LibraryBacktraceTest.testExternalOverflow (test/LibraryBacktrace.t.sol:59:54)
+  at LibraryConsumer.externalMultiply
+  at LibraryBacktraceTest.testExternalOverflow
 
 [FAIL: ExternalMathLib: value must be positive] testExternalRequire() ([GAS])
 ...
 Backtrace:
-  at ExternalMathLib.requirePositive (src/libraries/ExternalMathLib.sol:32:87)
-  at LibraryConsumer.externalCheckPositive (src/LibraryConsumer.sol:61:95)
-  at LibraryBacktraceTest.testExternalRequire (test/LibraryBacktrace.t.sol:64:53)
+  at ExternalMathLib.requirePositive
+  at LibraryConsumer.externalCheckPositive
+  at LibraryBacktraceTest.testExternalRequire
 
 [FAIL: Underflow()] testExternalUnderflow() ([GAS])
 ...
 Backtrace:
-  at ExternalMathLib.sub (src/libraries/ExternalMathLib.sol:25:63)
-  at LibraryConsumer.externalSubtract (src/LibraryConsumer.sol:55:97)
-  at LibraryBacktraceTest.testExternalUnderflow (test/LibraryBacktrace.t.sol:54:55)
+  at ExternalMathLib.sub
+  at LibraryConsumer.externalSubtract
+  at LibraryBacktraceTest.testExternalUnderflow
 
 [FAIL: DivisionByZero()] testInternalDivisionByZero() ([GAS])
 ...
 Backtrace:
-  at LibraryConsumer.internalDivide (src/libraries/InternalMathLib.sol:11:48)
-  at LibraryBacktraceTest.testInternalDivisionByZero (test/LibraryBacktrace.t.sol:27:60)
+  at LibraryConsumer.internalDivide
+  at LibraryBacktraceTest.testInternalDivisionByZero
 
 [FAIL: panic: arithmetic underflow or overflow (0x11)] testInternalOverflow() ([GAS])
 Traces:
 ...
 Backtrace:
   at LibraryConsumer.internalMultiply
-  at LibraryBacktraceTest.testInternalOverflow (test/LibraryBacktrace.t.sol:37:54)
+  at LibraryBacktraceTest.testInternalOverflow
 
 [FAIL: InternalMathLib: value must be positive] testInternalRequire() ([GAS])
 Traces:
 ...
 Backtrace:
-  at LibraryConsumer.internalCheckPositive (src/libraries/InternalMathLib.sol:32:87)
-  at LibraryBacktraceTest.testInternalRequire (test/LibraryBacktrace.t.sol:42:53)
+  at LibraryConsumer.internalCheckPositive
+  at LibraryBacktraceTest.testInternalRequire
 
 [FAIL: Underflow()] testInternalUnderflow() ([GAS])
 Traces:
 ...
 Backtrace:
-  at LibraryConsumer.internalSubtract (src/libraries/InternalMathLib.sol:25:63)
-  at LibraryBacktraceTest.testInternalUnderflow (test/LibraryBacktrace.t.sol:32:55)
+  at LibraryConsumer.internalSubtract
+  at LibraryBacktraceTest.testInternalUnderflow
 
 [FAIL: DivisionByZero()] testMixedLibraryFailure() ([GAS])
 Traces:
 ...
 Backtrace:
-  at ExternalMathLib.div (src/libraries/ExternalMathLib.sol:11:48)
-  at LibraryConsumer.mixedCalculation (src/LibraryConsumer.sol:72:62)
-  at LibraryBacktraceTest.testMixedLibraryFailure (test/LibraryBacktrace.t.sol:72:105)
+  at ExternalMathLib.div
+  at LibraryConsumer.mixedCalculation
+  at LibraryBacktraceTest.testMixedLibraryFailure
 
 Suite result: FAILED. 0 passed; 9 failed; 0 skipped; [ELAPSED]
 ...
@@ -389,7 +389,7 @@ forgetest!(test_multiple_libraries_same_file, |prj, cmd| {
     );
 
     let output = cmd
-        .args(["test", "-vvv", "--ast", "--mc", "MultipleLibraryBacktraceTest"])
+        .args(["test", "-vvvvv", "--ast", "--mc", "MultipleLibraryBacktraceTest"])
         .assert_failure();
 
     output.stdout_eq(str![[r#"
@@ -401,28 +401,28 @@ Ran 4 tests for test/MultipleLibraryBacktrace.t.sol:MultipleLibraryBacktraceTest
 [FAIL: FirstLibError()] testAllLibrariesFirstFails() ([GAS])
 ...
 Backtrace:
-  at MultipleLibraryConsumer.useAllLibraries (src/libraries/MultipleLibraries.sol:8:6)
+  at MultipleLibraryConsumer.useAllLibraries (src/libraries/MultipleLibraries.sol:10:42)
   at MultipleLibraryBacktraceTest.testAllLibrariesFirstFails (test/MultipleLibraryBacktrace.t.sol:31:60)
 
 [FAIL: FirstLibError()] testFirstLibraryError() ([GAS])
 Traces:
 ...
 Backtrace:
-  at MultipleLibraryConsumer.useFirstLib (src/libraries/MultipleLibraries.sol:8:6)
+  at MultipleLibraryConsumer.useFirstLib (src/libraries/MultipleLibraries.sol:10:42)
   at MultipleLibraryBacktraceTest.testFirstLibraryError (test/MultipleLibraryBacktrace.t.sol:16:55)
 
 [FAIL: SecondLibError()] testSecondLibraryError() ([GAS])
 Traces:
 ...
 Backtrace:
-  at MultipleLibraryConsumer.useSecondLib (src/libraries/MultipleLibraries.sol:24:6)
+  at MultipleLibraryConsumer.useSecondLib (src/libraries/MultipleLibraries.sol:26:41)
   at MultipleLibraryBacktraceTest.testSecondLibraryError (test/MultipleLibraryBacktrace.t.sol:21:56)
 
 [FAIL: ThirdLibError()] testThirdLibraryError() ([GAS])
 Traces:
 ...
 Backtrace:
-  at MultipleLibraryConsumer.useThirdLib (src/libraries/MultipleLibraries.sol:40:6)
+  at MultipleLibraryConsumer.useThirdLib (src/libraries/MultipleLibraries.sol:42:42)
   at MultipleLibraryBacktraceTest.testThirdLibraryError (test/MultipleLibraryBacktrace.t.sol:26:55)
 
 Suite result: FAILED. 0 passed; 4 failed; 0 skipped; [ELAPSED]
@@ -446,7 +446,7 @@ forgetest!(test_fork_backtrace, |prj, cmd| {
     prj.add_test("ForkBacktrace.t.sol", include_str!("../fixtures/backtraces/ForkBacktrace.t.sol"));
 
     let output = cmd
-        .args(["test", "-vvv", "--fork-url", &fork_url, "--match-contract", "ForkBacktraceTest"])
+        .args(["test", "-vvvvv", "--fork-url", &fork_url, "--match-contract", "ForkBacktraceTest"])
         .assert_failure();
 
     output.stdout_eq(str![[r#"
@@ -500,7 +500,7 @@ Suite result: FAILED. 0 passed; 5 failed; 0 skipped; [ELAPSED]
             "test",
             "--mt",
             "testTransferFromWithoutApproval",
-            "-vvv",
+            "-vvvvv",
             "--fork-url",
             &fork_url,
             "--etherscan-api-key",
@@ -534,7 +534,7 @@ forgetest!(test_backtrace_via_ir_disables_source_lines, |prj, cmd| {
 
     prj.update_config(|c| c.via_ir = true);
 
-    let output = cmd.args(["test", "-vvv"]).assert_failure();
+    let output = cmd.args(["test", "-vvvvv"]).assert_failure();
     output.stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
 [SOLC_VERSION] [ELAPSED]

crates/forge/tests/cli/cmd.rs

@@ -70,7 +70,9 @@ Display options:
           - 2 (-vv): Print logs for all tests.
           - 3 (-vvv): Print execution traces for failing tests.
           - 4 (-vvvv): Print execution traces for all tests, and setup traces for failing tests.
-          - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes.
+          - 5 (-vvvvv): Print execution and setup traces for all tests, including storage changes
+          and
+            backtraces with line numbers.
 
 Find more information in the book: https://getfoundry.sh/forge/overview
 

crates/forge/tests/cli/test_cmd/mod.rs

@@ -315,14 +315,15 @@ contract SimpleContractTest is DSTest {
 }
    "#;
 
+#[cfg(not(feature = "isolate-by-default"))]
 forgetest!(can_run_test_with_json_output_verbose, |prj, cmd| {
     prj.insert_ds_test();
     prj.insert_console();
 
     prj.add_source("Simple.t.sol", SIMPLE_CONTRACT);
 
     // Assert that with verbose output the json output includes the traces
-    cmd.args(["test", "-vvv", "--json"])
+    cmd.args(["test", "-vvvvv", "--json"])
         .assert_success()
         .stdout_eq(file!["../../fixtures/SimpleContractTestVerbose.json": Json]);
 });
@@ -624,7 +625,7 @@ contract CustomTypesTest is Test {
    "#,
     );
 
-    cmd.args(["test", "-vvvv"]).assert_failure().stdout_eq(str![[r#"
+    cmd.args(["test", "-vvvvv"]).assert_failure().stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
 [SOLC_VERSION] [ELAPSED]
 Compiler run successful!
@@ -3020,7 +3021,7 @@ contract SuppressTracesTest is Test {
     );
 
     // Show traces and logs for failed test only.
-    cmd.args(["test", "--mc", "SuppressTracesTest", "-vvvv", "-s"]).assert_failure().stdout_eq(
+    cmd.args(["test", "--mc", "SuppressTracesTest", "-vvvvv", "-s"]).assert_failure().stdout_eq(
         str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
 [SOLC_VERSION] [ELAPSED]
@@ -3043,6 +3044,8 @@ Traces:
     ├─ [0] console::log("test increment failure") [staticcall]
     │   └─ ← [Stop]
     ├─ [22418] Counter::increment()
+    │   ├─  storage changes:
+    │   │   @ 0: 0 → 1
     │   └─ ← [Stop]
     ├─ [424] Counter::number() [staticcall]
     │   └─ ← [Return] 1
@@ -3103,7 +3106,7 @@ Traces:
 
 Backtrace:
   at VM.assertEq
-  at SuppressTracesTest.test_increment_failure (lib/forge-std/src/StdAssertions.sol:[..]:[..])
+  at SuppressTracesTest.test_increment_failure
 
 [PASS] test_increment_success() ([GAS])
 Logs:
@@ -3861,7 +3864,7 @@ contract NonContractCallRevertTest is Test {
      "#,
     );
 
-    cmd.args(["test", "--mc", "NonContractCallRevertTest", "-vvv"])
+    cmd.args(["test", "--mc", "NonContractCallRevertTest", "-vvvvv"])
         .assert_failure()
         .stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
@@ -3874,6 +3877,13 @@ Logs:
   test non contract call failure
 
 Traces:
+  [157143] NonContractCallRevertTest::setUp()
+    ├─ [96345] → new Counter@0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f
+    │   └─ ← [Return] 481 bytes of code
+    ├─ [22492] Counter::setNumber(1)
+    │   └─ ← [Stop]
+    └─ ← [Stop]
+
   [6350] NonContractCallRevertTest::test_non_contract_call_failure()
     ├─ [0] console::log("test non contract call failure") [staticcall]
     │   └─ ← [Stop]
@@ -3889,6 +3899,13 @@ Logs:
   test non contract (void) call failure
 
 Traces:
+  [157143] NonContractCallRevertTest::setUp()
+    ├─ [96345] → new Counter@0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f
+    │   └─ ← [Return] 481 bytes of code
+    ├─ [22492] Counter::setNumber(1)
+    │   └─ ← [Stop]
+    └─ ← [Stop]
+
   [6215] NonContractCallRevertTest::test_non_contract_void_call_failure()
     ├─ [0] console::log("test non contract (void) call failure") [staticcall]
     │   └─ ← [Stop]
@@ -3902,6 +3919,13 @@ Logs:
   test non supported fn selector call failure
 
 Traces:
+  [157143] NonContractCallRevertTest::setUp()
+    ├─ [96345] → new Counter@0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f
+    │   └─ ← [Return] 481 bytes of code
+    ├─ [22492] Counter::setNumber(1)
+    │   └─ ← [Stop]
+    └─ ← [Stop]
+
   [8620] NonContractCallRevertTest::test_non_supported_selector_call_failure()
     ├─ [0] console::log("test non supported fn selector call failure") [staticcall]
     │   └─ ← [Stop]
@@ -3971,7 +3995,7 @@ contract NonContractDelegateCallRevertTest is Test {
      "#,
     );
 
-    cmd.args(["test", "--mc", "NonContractDelegateCallRevertTest", "-vvv"])
+    cmd.args(["test", "--mc", "NonContractDelegateCallRevertTest", "-vvvvv"])
         .assert_failure()
         .stdout_eq(str![[r#"
 [COMPILING_FILES] with [SOLC_VERSION]
@@ -3988,6 +4012,8 @@ Traces:
     ├─ [0] console::log("Test: Simulating call to unlinked library") [staticcall]
     │   └─ ← [Stop]
     ├─ [214746] → new LibraryCaller@0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f
+    │   ├─  storage changes:
+    │   │   @ 0: 0 → 0x000000000000000000000000deadbeef00000000000000000000000000000000
     │   └─ ← [Return] 960 bytes of code
     ├─ [3896] LibraryCaller::foobar(10)
     │   ├─ [0] 0xdEADBEeF00000000000000000000000000000000::foo(10) [delegatecall]