fix(forge): add logs/decoded logs in json test results (#9074)

Author: grandizzy

crates/forge/bin/cmd/test/mod.rs

@@ -501,7 +501,18 @@ impl TestArgs {
 
         // Run tests in a non-streaming fashion and collect results for serialization.
         if self.json {
-            let results = runner.test_collect(filter);
+            let mut results = runner.test_collect(filter);
+            results.values_mut().for_each(|suite_result| {
+                for test_result in suite_result.test_results.values_mut() {
+                    if verbosity >= 2 {
+                        // Decode logs at level 2 and above.
+                        test_result.decoded_logs = decode_console_logs(&test_result.logs);
+                    } else {
+                        // Empty logs for non verbose runs.
+                        test_result.logs = vec![];
+                    }
+                }
+            });
             println!("{}", serde_json::to_string(&results)?);
             return Ok(TestOutcome::new(results, self.allow_failure));
         }

crates/forge/src/result.rs

@@ -389,6 +389,10 @@ pub struct TestResult {
     /// be printed to the user.
     pub logs: Vec<Log>,
 
+    /// The decoded DSTest logging events and Hardhat's `console.log` from [logs](Self::logs).
+    /// Used for json output.
+    pub decoded_logs: Vec<String>,
+
     /// What kind of test this was
     pub kind: TestKind,
 

crates/forge/tests/cli/test_cmd.rs

@@ -275,7 +275,10 @@ Ran 1 test suite [ELAPSED]: 1 tests passed, 0 failed, 0 skipped (1 total tests)
 });
 
 const SIMPLE_CONTRACT: &str = r#"
+pragma solidity 0.8.18;
+
 import "./test.sol";
+import "./console.sol";
 
 contract SimpleContract {
     uint256 public num;
@@ -289,12 +292,14 @@ contract SimpleContractTest is DSTest {
     function test() public {
         SimpleContract c = new SimpleContract();
         c.setValues(100);
+        console.log("Value set: ", 100);
     }
 }
    "#;
 
 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).unwrap();
 
@@ -306,6 +311,7 @@ forgetest!(can_run_test_with_json_output_verbose, |prj, cmd| {
 
 forgetest!(can_run_test_with_json_output_non_verbose, |prj, cmd| {
     prj.insert_ds_test();
+    prj.insert_console();
 
     prj.add_source("Simple.t.sol", SIMPLE_CONTRACT).unwrap();
 

crates/forge/tests/fixtures/SimpleContractTestNonVerbose.json

@@ -7,6 +7,7 @@
                 "reason": null,
                 "counterexample": null,
                 "logs": [],
+                "decoded_logs": [],
                 "kind": {
                     "Unit": {
                         "gas": "{...}"

crates/forge/tests/fixtures/SimpleContractTestVerbose.json

@@ -6,7 +6,18 @@
                 "status": "Success",
                 "reason": null,
                 "counterexample": null,
-                "logs": [],
+                "logs": [
+                    {
+                        "address": "0x000000000000000000636F6e736F6c652e6c6f67",
+                        "topics": [
+                            "0x41304facd9323d75b11bcdd609cb38effffdb05710f7caf0e9b16c6d9d709f50"
+                        ],
+                        "data": "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000f56616c7565207365743a20203130300000000000000000000000000000000000"
+                    }
+                ],
+                "decoded_logs": [
+                    "Value set:  100"
+                ],
                 "kind": {
                     "Unit": {
                         "gas": "{...}"
@@ -58,7 +69,8 @@
                                     "parent": null,
                                     "children": [
                                         1,
-                                        2
+                                        2,
+                                        3
                                     ],
                                     "idx": 0,
                                     "trace": {
@@ -91,6 +103,9 @@
                                         },
                                         {
                                             "Call": 1
+                                        },
+                                        {
+                                            "Call": 2
                                         }
                                     ]
                                 },
@@ -153,6 +168,36 @@
                                     },
                                     "logs": [],
                                     "ordering": []
+                                },
+                                {
+                                    "parent": 0,
+                                    "children": [],
+                                    "idx": 3,
+                                    "trace": {
+                                        "depth": 1,
+                                        "success": true,
+                                        "caller": "0x7FA9385bE102ac3EAc297483Dd6233D62b3e1496",
+                                        "address": "0x000000000000000000636F6e736F6c652e6c6f67",
+                                        "maybe_precompile": null,
+                                        "selfdestruct_address": null,
+                                        "selfdestruct_refund_target": null,
+                                        "selfdestruct_transferred_value": null,
+                                        "kind": "STATICCALL",
+                                        "value": "0x0",
+                                        "data": "{...}",
+                                        "output": "0x",
+                                        "gas_used": "{...}",
+                                        "gas_limit": "{...}",
+                                        "status": "Stop",
+                                        "steps": [],
+                                        "decoded": {
+                                            "label": null,
+                                            "return_data": null,
+                                            "call_data": null
+                                        }
+                                    },
+                                    "logs": [],
+                                    "ordering": []
                                 }
                             ]
                         }