Display gas report table

Author: ddoktorski

Cargo.lock

@@ -130,3 +130,4 @@ tracing-subscriber = { version = "0.3.20", features = ["env-filter"] }
 tracing = "0.1.41"
 tracing-chrome = "0.7.2"
 tracing-log = "0.2.0"
+comfy-table = "7"

Cargo.toml

@@ -49,3 +49,4 @@ strum = "0.27"
 strum_macros = "0.27"
 scarb-oracle-hint-service.workspace = true
 tracing.workspace = true
+comfy-table.workspace = true

crates/forge-runner/Cargo.toml

@@ -1,10 +1,14 @@
 use crate::gas::stats::GasStats;
 use cheatnet::trace_data::{CallTrace, CallTraceNode};
+use comfy_table::modifiers::UTF8_ROUND_CORNERS;
+use comfy_table::{Cell, Color, Table};
 use debugging::ContractName as DebuggingContractName;
 use debugging::ContractsDataStore;
 use starknet_api::core::{ClassHash, EntryPointSelector};
 use starknet_api::execution_resources::GasVector;
 use std::collections::BTreeMap;
+use std::fmt;
+use std::fmt::Display;
 
 type ContractName = String;
 type Selector = String;
@@ -117,3 +121,48 @@ fn get_selector(contracts_data: &ContractsDataStore, selector: EntryPointSelecto
         .0
         .clone()
 }
+
+impl Display for ReportData {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        for (name, contract_info) in &self.0 {
+            if !contract_info.functions.is_empty() {
+                let table = format_table_output(contract_info, name);
+                writeln!(f, "\n{table}")?;
+            }
+        }
+        Ok(())
+    }
+}
+
+pub fn format_table_output(contract_info: &ContractInfo, name: &ContractName) -> Table {
+    let mut table = Table::new();
+    table.apply_modifier(UTF8_ROUND_CORNERS);
+
+    table.set_header(vec![
+        Cell::new(format!("{name} Contract")).fg(Color::Magenta),
+    ]);
+    table.add_row(vec![
+        Cell::new("Function Name"),
+        Cell::new("Min").fg(Color::Green),
+        Cell::new("Avg").fg(Color::Yellow),
+        Cell::new("Standard Deviation").fg(Color::Yellow),
+        Cell::new("Max").fg(Color::Red),
+        Cell::new("# Calls").fg(Color::Cyan),
+    ]);
+
+    contract_info
+        .functions
+        .iter()
+        .for_each(|(selector, report_data)| {
+            table.add_row(vec![
+                Cell::new(selector),
+                Cell::new(report_data.gas_stats.min.to_string()).fg(Color::Green),
+                Cell::new(report_data.gas_stats.mean.to_string()).fg(Color::Yellow),
+                Cell::new(report_data.gas_stats.std_deviation.to_string()).fg(Color::Yellow),
+                Cell::new(report_data.gas_stats.max.to_string()).fg(Color::Red),
+                Cell::new(report_data.n_calls.to_string()),
+            ]);
+        });
+
+    table
+}

crates/forge-runner/src/gas/report.rs

@@ -1,4 +1,4 @@
-use crate::forge_config::ForgeTrackedResource;
+use crate::forge_config::{ForgeTrackedResource, OutputConfig};
 use crate::test_case_summary::{AnyTestCaseSummary, FuzzingStatistics, TestCaseSummary};
 use cairo_vm::vm::runners::cairo_runner::ExecutionResources;
 use cheatnet::runtime_extensions::call_to_blockifier_runtime_extension::rpc::UsedResources;
@@ -39,12 +39,13 @@ pub struct TestResultMessage {
     fuzzer_report: String,
     gas_usage: String,
     used_resources: String,
+    gas_report: String,
 }
 
 impl TestResultMessage {
     pub fn new(
         test_result: &AnyTestCaseSummary,
-        show_detailed_resources: bool,
+        output_config: &OutputConfig,
         tracked_resource: ForgeTrackedResource,
     ) -> Self {
         let name = test_result
@@ -75,19 +76,28 @@ impl TestResultMessage {
             String::new()
         };
 
-        let gas_usage = match test_result {
+        let (gas_usage, gas_report) = match test_result {
             AnyTestCaseSummary::Single(TestCaseSummary::Passed { gas_info, .. }) => {
-                format!(
-                    " (l1_gas: ~{}, l1_data_gas: ~{}, l2_gas: ~{})",
-                    gas_info.gas_used.l1_gas,
-                    gas_info.gas_used.l1_data_gas,
-                    gas_info.gas_used.l2_gas
+                let gas_report = if output_config.gas_report {
+                    format!("{}", gas_info.report_data)
+                } else {
+                    String::new()
+                };
+
+                (
+                    format!(
+                        " (l1_gas: ~{}, l1_data_gas: ~{}, l2_gas: ~{})",
+                        gas_info.gas_used.l1_gas,
+                        gas_info.gas_used.l1_data_gas,
+                        gas_info.gas_used.l2_gas
+                    ),
+                    gas_report,
                 )
             }
-            _ => String::new(),
+            _ => (String::new(), String::new()),
         };
 
-        let used_resources = match (show_detailed_resources, &test_result) {
+        let used_resources = match (output_config.detailed_resources, &test_result) {
             (true, AnyTestCaseSummary::Single(TestCaseSummary::Passed { used_resources, .. })) => {
                 format_detailed_resources(used_resources, tracked_resource)
             }
@@ -104,6 +114,7 @@ impl TestResultMessage {
             fuzzer_report,
             gas_usage,
             used_resources,
+            gas_report,
         }
     }
 
@@ -140,10 +151,11 @@ impl Message for TestResultMessage {
 
         let fuzzer_report = &self.fuzzer_report;
         let gas_usage = &self.gas_usage;
+        let gas_report = &self.gas_report;
         let used_resources = &self.used_resources;
 
         format!(
-            "{result_header} {result_name}{fuzzer_report}{gas_usage}{used_resources}{result_msg}{result_debug_trace}"
+            "{result_header} {result_name}{fuzzer_report}{gas_usage}{used_resources}{result_msg}{result_debug_trace}{gas_report}"
         )
     }
 

crates/forge-runner/src/messages.rs

@@ -71,7 +71,7 @@ pub async fn run_for_test_target(
         if !result.is_interrupted() {
             let test_result_message = TestResultMessage::new(
                 &result,
-                forge_config.output_config.detailed_resources,
+                &forge_config.output_config,
                 forge_config.test_runner_config.tracked_resource,
             );
             ui.println(&test_result_message);