Truncate coverage report

commit-id:6426d392

Author: ksew1

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Changed
 - macros are now by default included in the coverage report. If you want to exclude them, use the `--include` without the
   `macros` option (can also have empty value)
+- by default, the hit count of the lines will be truncated to 1. This can be changed with the `--no-truncation` flag
 
 ## [0.4.0] - 2025-01-03
 

crates/cairo-coverage-core/src/args.rs

@@ -3,6 +3,9 @@
 pub struct RunOptions {
     /// Include additional components in the coverage report.
     pub include: Vec<IncludedComponent>,
+
+    /// If set, the hit count of the lines will not be truncated to 1.
+    pub no_truncation: bool,
 }
 
 /// Additional components that can be included in the coverage report.

crates/cairo-coverage-core/src/coverage/project.rs

@@ -47,3 +47,16 @@ fn register_line_execution(
         *function_coverage.entry(line).or_default() += executed_statement_count;
     }
 }
+
+/// Truncates the execution count of each statement to 1.
+/// Currently, execution counts are not stable between `scarb` versions,
+/// so truncating to 1 is a way of achieving stability.
+pub fn truncate_to_one(project_coverage: &mut ProjectCoverage) {
+    for file_coverage in project_coverage.values_mut() {
+        for function_coverage in file_coverage.values_mut() {
+            for execution_count in function_coverage.values_mut() {
+                *execution_count = (*execution_count).min(1);
+            }
+        }
+    }
+}

crates/cairo-coverage-core/src/lib.rs

@@ -24,11 +24,14 @@ use rayon::iter::{IntoParallelIterator, ParallelIterator};
 pub fn run(
     trace_files: Vec<Utf8PathBuf>,
     project_path: Utf8PathBuf,
-    RunOptions { include }: RunOptions,
+    RunOptions {
+        include,
+        no_truncation,
+    }: RunOptions,
 ) -> Result<String> {
     let ignore_matcher = ignore_matcher::build(&project_path)?;
 
-    let coverage_data = execution_data::load(&trace_files)?
+    let mut project_coverage = execution_data::load(&trace_files)?
         .into_par_iter()
         .map(|execution_data| {
             let filter = statement_category_filter::build(
@@ -48,5 +51,9 @@ pub fn run(
         .reduce(merge)
         .context("at least one trace file must be provided")?;
 
-    Ok(lcov::fmt_string(&coverage_data))
+    if !no_truncation {
+        coverage::project::truncate_to_one(&mut project_coverage);
+    }
+
+    Ok(lcov::fmt_string(&project_coverage))
 }

crates/cairo-coverage/src/args/run.rs

@@ -17,6 +17,10 @@ pub struct RunArgs {
     #[arg(long, short, num_args = 0.., default_value = "macros")]
     pub include: Vec<IncludedComponent>,
 
+    /// If set, the hit count of the lines will not be truncated to 1.
+    #[arg(long)]
+    pub no_truncation: bool,
+
     /// Path to the project directory. If not provided, the project directory is inferred using `scarb metadata`.
     #[arg(value_parser = parse_project_path, long)]
     pub project_path: Option<Utf8PathBuf>,

crates/cairo-coverage/src/commands/run.rs

@@ -13,6 +13,7 @@ pub fn run(
         project_path,
         output_path,
         trace_files,
+        no_truncation,
     }: RunArgs,
 ) -> Result<()> {
     let project_path = if let Some(project_path) = project_path {
@@ -23,6 +24,7 @@ pub fn run(
 
     let options = RunOptions {
         include: include.into_iter().map(Into::into).collect(),
+        no_truncation,
     };
 
     let lcov = cairo_coverage_core::run(trace_files, project_path, options)?;

crates/cairo-coverage/tests/expected_output/complex_calculator.lcov

@@ -3,17 +3,17 @@ SF:{dir}/src/lib.cairo
 FN:2,complex_calculator::add
 FNDA:1,complex_calculator::add
 FN:18,complex_calculator::divide
-FNDA:2,complex_calculator::divide
+FNDA:1,complex_calculator::divide
 FN:28,complex_calculator::factorial
-FNDA:25,complex_calculator::factorial
+FNDA:1,complex_calculator::factorial
 FN:45,complex_calculator::fibonacci
-FNDA:2,complex_calculator::fibonacci
+FNDA:1,complex_calculator::fibonacci
 FN:54,complex_calculator::is_prime
-FNDA:216,complex_calculator::is_prime
+FNDA:1,complex_calculator::is_prime
 FN:10,complex_calculator::multiply
 FNDA:1,complex_calculator::multiply
 FN:38,complex_calculator::power
-FNDA:22,complex_calculator::power
+FNDA:1,complex_calculator::power
 FN:6,complex_calculator::subtract
 FNDA:1,complex_calculator::subtract
 FN:14,complex_calculator::unsafe_divide
@@ -24,22 +24,22 @@ DA:2,1
 DA:6,1
 DA:10,1
 DA:14,0
-DA:18,2
+DA:18,1
 DA:21,0
-DA:28,25
-DA:29,10
-DA:30,10
-DA:38,22
-DA:39,6
-DA:40,6
+DA:28,1
+DA:29,1
+DA:30,1
+DA:38,1
+DA:39,1
+DA:40,1
 DA:45,1
-DA:46,2
+DA:46,1
 DA:47,0
 DA:49,0
-DA:54,4
-DA:59,216
-DA:60,158
-DA:63,80
+DA:54,1
+DA:59,1
+DA:60,1
+DA:63,1
 LF:20
 LH:16
 end_of_record

crates/cairo-coverage/tests/expected_output/readme_example.lcov

@@ -1,17 +1,17 @@
 TN:
 SF:{dir}/src/lib.cairo
 FN:8,readme_example::add
-FNDA:2,readme_example::add
+FNDA:1,readme_example::add
 FN:16,readme_example::calculator
-FNDA:4,readme_example::calculator
+FNDA:1,readme_example::calculator
 FN:12,readme_example::multiply
 FNDA:0,readme_example::multiply
 FNF:3
 FNH:2
-DA:8,2
+DA:8,1
 DA:12,0
-DA:16,4
-DA:17,2
+DA:16,1
+DA:17,1
 DA:18,0
 LF:5
 LH:3

crates/cairo-coverage/tests/expected_output/scarb_template.lcov

@@ -1,12 +1,12 @@
 TN:
 SF:{dir}/src/lib.cairo
 FN:8,scarb_template::fib
-FNDA:69,scarb_template::fib
+FNDA:1,scarb_template::fib
 FNF:1
 FNH:1
-DA:8,69
-DA:9,32
-DA:11,32
+DA:8,1
+DA:9,1
+DA:11,1
 LF:3
 LH:3
 end_of_record

crates/cairo-coverage/tests/expected_output/simple.lcov

@@ -1,15 +1,15 @@
 TN:
 SF:{dir}/src/lib.cairo
 FN:7,simple::increase_by_one
-FNDA:2,simple::increase_by_one
+FNDA:1,simple::increase_by_one
 FN:2,simple::increase_by_two
-FNDA:3,simple::increase_by_two
+FNDA:1,simple::increase_by_two
 FNF:2
 FNH:2
 DA:2,1
-DA:3,3
-DA:7,2
-DA:8,2
+DA:3,1
+DA:7,1
+DA:8,1
 LF:4
 LH:4
 end_of_record