Put metrics behind show-metrics invariant config

foundry-rs · Oct 22, 2024 · 3edde16 · 3edde16
1 parent 4dc2aeb
commit 3edde16
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 2 deletions.
diff --git a/crates/config/src/invariant.rs b/crates/config/src/invariant.rs
@@ -34,6 +34,8 @@ pub struct InvariantConfig {
     pub gas_report_samples: u32,
     /// Path where invariant failures are recorded and replayed.
     pub failure_persist_dir: Option<PathBuf>,
+    /// Whether to collect and display fuzzed selectors metrics.
+    pub show_metrics: bool,
 }
 
 impl Default for InvariantConfig {
@@ -48,6 +50,7 @@ impl Default for InvariantConfig {
             max_assume_rejects: 65536,
             gas_report_samples: 256,
             failure_persist_dir: None,
+            show_metrics: false,
         }
     }
 }
@@ -65,6 +68,7 @@ impl InvariantConfig {
             max_assume_rejects: 65536,
             gas_report_samples: 256,
             failure_persist_dir: Some(cache_dir),
+            show_metrics: false,
         }
     }
 
@@ -103,6 +107,7 @@ impl InlineConfigParser for InvariantConfig {
                     conf_clone.failure_persist_dir = Some(PathBuf::from(value))
                 }
                 "shrink-run-limit" => conf_clone.shrink_run_limit = parse_config_u32(key, value)?,
+                "show-metrics" => conf_clone.show_metrics = parse_config_bool(key, value)?,
                 _ => Err(InlineConfigParserError::InvalidConfigProperty(key.to_string()))?,
             }
         }

diff --git a/crates/evm/evm/src/executors/invariant/mod.rs b/crates/evm/evm/src/executors/invariant/mod.rs
@@ -369,7 +369,9 @@ impl<'a> InvariantExecutor<'a> {
                     })?;
 
                 let discarded = call_result.result.as_ref() == MAGIC_ASSUME;
-                invariant_test.record_metrics(tx, call_result.reverted, discarded);
+                if self.config.show_metrics {
+                    invariant_test.record_metrics(tx, call_result.reverted, discarded);
+                }
 
                 // Collect coverage from last fuzzed call.
                 invariant_test.merge_coverage(call_result.coverage.clone());

diff --git a/crates/forge/bin/cmd/test/mod.rs b/crates/forge/bin/cmd/test/mod.rs
@@ -613,7 +613,7 @@ impl TestArgs {
             for (name, result) in tests {
                 if !silent {
                     shell::println(result.short_result(name))?;
-
+                    // Display invariant metrics if invariant kind.
                     if let TestKind::Invariant { runs: _, calls: _, reverts: _, metrics } =
                         &result.kind
                     {

diff --git a/crates/forge/tests/it/invariant.rs b/crates/forge/tests/it/invariant.rs
@@ -871,9 +871,11 @@ contract CounterTest is Test {
     }
 
     /// forge-config: default.invariant.runs = 10
+    /// forge-config: default.invariant.show-metrics = true
     function invariant_counter() public {}
 
     /// forge-config: default.invariant.runs = 10
+    /// forge-config: default.invariant.show-metrics = true
     function invariant_counter2() public {}
 }
 

diff --git a/crates/forge/tests/it/test_helpers.rs b/crates/forge/tests/it/test_helpers.rs
@@ -112,6 +112,7 @@ impl ForgeTestProfile {
                 max_assume_rejects: 65536,
                 gas_report_samples: 256,
                 failure_persist_dir: Some(tempfile::tempdir().unwrap().into_path()),
+                show_metrics: false,
             })
             .build(output, Path::new(self.project().root()))
             .expect("Config loaded")