Skip to content

Commit

Permalink
fix: missing coverage in clarity iterator functions (#1220)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugocaillard authored Oct 24, 2023
1 parent 4d77185 commit 336b580
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 5 deletions.
19 changes: 14 additions & 5 deletions components/clarity-repl/src/analysis/coverage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ use std::{

use clarity::vm::{
ast::ContractAST,
functions::{define::DefineFunctionsParsed, NativeFunctions},
functions::{
define::DefineFunctionsParsed,
NativeFunctions::{self, Filter, Fold, Map},
},
types::QualifiedContractIdentifier,
EvalHook, SymbolicExpression,
ClarityName, EvalHook, SymbolicExpression,
};
use serde_json::Value as JsonValue;

Expand Down Expand Up @@ -382,12 +385,18 @@ fn try_parse_native_func(

fn report_eval(expr_coverage: &mut ExprCoverage, expr: &SymbolicExpression) {
if let Some(children) = expr.match_list() {
if let Some((function_variable, rest)) = children.split_first() {
report_eval(expr_coverage, function_variable);
if let Some((func, args)) = try_parse_native_func(children) {
if [Fold, Map, Filter].contains(&func) {
if let Some(iterator_func) = args.first() {
report_eval(expr_coverage, iterator_func);
}
}
}
if let Some(func_expr) = children.first() {
report_eval(expr_coverage, func_expr);
}
return;
}

let count = expr_coverage.entry(expr.id).or_insert(0);
*count += 1;
}
Expand Down
114 changes: 114 additions & 0 deletions components/clarity-repl/src/analysis/coverage_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -548,3 +548,117 @@ fn match_res_oneline() {

assert_eq!(cov, expect);
}

#[test]
fn fold_iterator() {
let contract = vec![
"(define-private (inner-sum (a int) (b int)) (+ a b))",
"(define-public (sum)",
" (ok",
" (fold",
" inner-sum",
" (list 0 1 2)",
" 0",
" )",
" )",
")",
]
.join("\n");

let snippets: Vec<String> = vec!["(contract-call? .contract-0 sum)".into()];
let (report, cov) = get_coverage_report(&contract, snippets);

let expect = get_expected_report(
vec![
"FN:1,inner-sum",
"FN:2,sum",
"FNDA:1,inner-sum",
"FNDA:1,sum",
"FNF:2",
"FNH:2",
"DA:1,3", // the list has 3 items
"DA:3,1",
"DA:4,1",
"DA:5,1", // inner-sum func call
"DA:6,1",
"DA:7,1",
"BRF:0",
"BRH:0",
]
.join("\n"),
);
assert_eq!(cov, expect);
}

#[test]
fn map_iterator() {
let contract = vec![
"(define-private (inner-square (n int)) (* n n))",
"(define-public (square (ns (list 10 int)))",
" (ok (map",
" inner-square",
" ns",
" ))",
")",
]
.join("\n");

let snippets: Vec<String> = vec!["(contract-call? .contract-0 square (list 1 2 3))".into()];
let (report, cov) = get_coverage_report(&contract, snippets);

let expect = get_expected_report(
vec![
"FN:1,inner-square",
"FN:2,square",
"FNDA:1,inner-square",
"FNDA:1,square",
"FNF:2",
"FNH:2",
"DA:1,3",
"DA:3,1",
"DA:4,1",
"DA:5,1",
"BRF:0",
"BRH:0",
]
.join("\n"),
);
assert_eq!(cov, expect);
}

#[test]
fn filter_iterator() {
let contract = vec![
"(define-private (is-positive (n int)) (>= n 0))",
"(define-public (get-positive (ns (list 10 int)))",
" (ok (filter",
" is-positive",
" ns",
" ))",
")",
]
.join("\n");

let snippets: Vec<String> =
vec!["(contract-call? .contract-0 get-positive (list -1 2 3))".into()];
let (report, cov) = get_coverage_report(&contract, snippets);

let expect = get_expected_report(
vec![
"FN:1,is-positive",
"FN:2,get-positive",
"FNDA:1,get-positive",
"FNDA:1,is-positive",
"FNF:2",
"FNH:2",
"DA:1,3",
"DA:3,1",
"DA:4,1",
"DA:5,1",
"BRF:0",
"BRH:0",
]
.join("\n"),
);
assert_eq!(cov, expect);
}

0 comments on commit 336b580

Please sign in to comment.