chore(coverage): improve debug report (#11190)

Author: DaniPopes

crates/evm/coverage/src/lib.rs

@@ -44,6 +44,8 @@ pub struct CoverageReport {
     /// All coverage items for the codebase, keyed by the compiler version.
     pub analyses: HashMap<Version, SourceAnalysis>,
     /// All item anchors for the codebase, keyed by their contract ID.
+    ///
+    /// `(id, (creation, runtime))`
     pub anchors: HashMap<ContractId, (Vec<ItemAnchor>, Vec<ItemAnchor>)>,
     /// All the bytecode hits for the codebase.
     pub bytecode_hits: HashMap<ContractId, HitMap>,
@@ -77,6 +79,8 @@ impl CoverageReport {
     }
 
     /// Add anchors to this report.
+    ///
+    /// `(id, (creation, runtime))`
     pub fn add_anchors(
         &mut self,
         anchors: impl IntoIterator<Item = (ContractId, (Vec<ItemAnchor>, Vec<ItemAnchor>))>,
@@ -356,7 +360,7 @@ impl Display for CoverageItem {
                 write!(f, r#"Function "{name}""#)?;
             }
         }
-        write!(f, " (location: {}, hits: {})", self.loc, self.hits)
+        write!(f, " (location: ({}), hits: {})", self.loc, self.hits)
     }
 }
 
@@ -375,7 +379,7 @@ pub struct SourceLocation {
 
 impl Display for SourceLocation {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(f, "source ID {}, lines {:?}, bytes {:?}", self.source_id, self.lines, self.bytes)
+        write!(f, "source ID: {}, lines: {:?}, bytes: {:?}", self.source_id, self.lines, self.bytes)
     }
 }
 

crates/forge/src/coverage.rs

@@ -201,31 +201,32 @@ impl CoverageReporter for DebugReporter {
 
     fn report(&mut self, report: &CoverageReport) -> eyre::Result<()> {
         for (path, items) in report.items_by_file() {
+            let uncovered = items.iter().copied().filter(|item| item.hits == 0);
+            if uncovered.clone().count() == 0 {
+                continue;
+            }
+
             sh_println!("Uncovered for {}:", path.display())?;
-            for item in items {
-                if item.hits == 0 {
-                    sh_println!("- {item}")?;
-                }
+            for item in uncovered {
+                sh_println!("- {item}")?;
             }
             sh_println!()?;
         }
 
-        for (contract_id, anchors) in &report.anchors {
+        for (contract_id, (cta, rta)) in &report.anchors {
+            if cta.is_empty() && rta.is_empty() {
+                continue;
+            }
+
             sh_println!("Anchors for {contract_id}:")?;
-            let anchors = anchors
-                .0
+            let anchors = cta
                 .iter()
                 .map(|anchor| (false, anchor))
-                .chain(anchors.1.iter().map(|anchor| (true, anchor)));
-            for (is_deployed, anchor) in anchors {
-                sh_println!("- {anchor}")?;
-                if is_deployed {
-                    sh_println!("- Creation code")?;
-                } else {
-                    sh_println!("- Runtime code")?;
-                }
+                .chain(rta.iter().map(|anchor| (true, anchor)));
+            for (is_runtime, anchor) in anchors {
+                let kind = if is_runtime { " runtime" } else { "creation" };
                 sh_println!(
-                    "  - Refers to item: {}",
+                    "- {kind} {anchor}: {}",
                     report
                         .analyses
                         .get(&contract_id.version)