mirror of
https://github.com/denoland/deno.git
synced 2024-12-22 23:34:47 -05:00
fix(coverage): use only string byte indexes and 0-indexed line numbers (#13190)
This commit is contained in:
parent
37dbe5249c
commit
7ebbda7fd7
12 changed files with 331 additions and 408 deletions
1
Cargo.lock
generated
1
Cargo.lock
generated
|
@ -695,6 +695,7 @@ dependencies = [
|
||||||
"tempfile",
|
"tempfile",
|
||||||
"test_util",
|
"test_util",
|
||||||
"text-size",
|
"text-size",
|
||||||
|
"text_lines",
|
||||||
"tokio",
|
"tokio",
|
||||||
"trust-dns-client",
|
"trust-dns-client",
|
||||||
"trust-dns-server",
|
"trust-dns-server",
|
||||||
|
|
|
@ -81,6 +81,7 @@ shell-escape = "=0.1.5"
|
||||||
sourcemap = "=6.0.1"
|
sourcemap = "=6.0.1"
|
||||||
tempfile = "=3.2.0"
|
tempfile = "=3.2.0"
|
||||||
text-size = "=1.1.0"
|
text-size = "=1.1.0"
|
||||||
|
text_lines = "=0.4.1"
|
||||||
tokio = { version = "=1.14", features = ["full"] }
|
tokio = { version = "=1.14", features = ["full"] }
|
||||||
uuid = { version = "=0.8.2", features = ["v4", "serde"] }
|
uuid = { version = "=0.8.2", features = ["v4", "serde"] }
|
||||||
walkdir = "=2.3.2"
|
walkdir = "=2.3.2"
|
||||||
|
|
|
@ -6,6 +6,20 @@ use test_util as util;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn branch() {
|
fn branch() {
|
||||||
|
run_coverage_text("branch", "ts");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn complex() {
|
||||||
|
run_coverage_text("complex", "ts");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn final_blankline() {
|
||||||
|
run_coverage_text("final_blankline", "js");
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_coverage_text(test_name: &str, extension: &str) {
|
||||||
let tempdir = TempDir::new().expect("tempdir fail");
|
let tempdir = TempDir::new().expect("tempdir fail");
|
||||||
let tempdir = tempdir.path().join("cov");
|
let tempdir = tempdir.path().join("cov");
|
||||||
let status = util::deno_cmd()
|
let status = util::deno_cmd()
|
||||||
|
@ -14,7 +28,7 @@ fn branch() {
|
||||||
.arg("--quiet")
|
.arg("--quiet")
|
||||||
.arg("--unstable")
|
.arg("--unstable")
|
||||||
.arg(format!("--coverage={}", tempdir.to_str().unwrap()))
|
.arg(format!("--coverage={}", tempdir.to_str().unwrap()))
|
||||||
.arg("coverage/branch_test.ts")
|
.arg(format!("coverage/{}_test.{}", test_name, extension))
|
||||||
.stdout(std::process::Stdio::piped())
|
.stdout(std::process::Stdio::piped())
|
||||||
.stderr(std::process::Stdio::inherit())
|
.stderr(std::process::Stdio::inherit())
|
||||||
.status()
|
.status()
|
||||||
|
@ -38,7 +52,7 @@ fn branch() {
|
||||||
.to_string();
|
.to_string();
|
||||||
|
|
||||||
let expected = fs::read_to_string(
|
let expected = fs::read_to_string(
|
||||||
util::testdata_path().join("coverage/expected_branch.out"),
|
util::testdata_path().join(format!("coverage/{}_expected.out", test_name)),
|
||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
|
@ -67,82 +81,7 @@ fn branch() {
|
||||||
.to_string();
|
.to_string();
|
||||||
|
|
||||||
let expected = fs::read_to_string(
|
let expected = fs::read_to_string(
|
||||||
util::testdata_path().join("coverage/expected_branch.lcov"),
|
util::testdata_path().join(format!("coverage/{}_expected.lcov", test_name)),
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
if !util::wildcard_match(&expected, &actual) {
|
|
||||||
println!("OUTPUT\n{}\nOUTPUT", actual);
|
|
||||||
println!("EXPECTED\n{}\nEXPECTED", expected);
|
|
||||||
panic!("pattern match failed");
|
|
||||||
}
|
|
||||||
|
|
||||||
assert!(output.status.success());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn complex() {
|
|
||||||
let tempdir = TempDir::new().expect("tempdir fail");
|
|
||||||
let status = util::deno_cmd()
|
|
||||||
.current_dir(util::testdata_path())
|
|
||||||
.arg("test")
|
|
||||||
.arg("--quiet")
|
|
||||||
.arg("--unstable")
|
|
||||||
.arg(format!("--coverage={}", tempdir.path().to_str().unwrap()))
|
|
||||||
.arg("coverage/complex_test.ts")
|
|
||||||
.stdout(std::process::Stdio::piped())
|
|
||||||
.stderr(std::process::Stdio::inherit())
|
|
||||||
.status()
|
|
||||||
.expect("failed to spawn test runner");
|
|
||||||
|
|
||||||
assert!(status.success());
|
|
||||||
|
|
||||||
let output = util::deno_cmd()
|
|
||||||
.current_dir(util::testdata_path())
|
|
||||||
.arg("coverage")
|
|
||||||
.arg("--quiet")
|
|
||||||
.arg("--unstable")
|
|
||||||
.arg(format!("{}/", tempdir.path().to_str().unwrap()))
|
|
||||||
.stdout(std::process::Stdio::piped())
|
|
||||||
.stderr(std::process::Stdio::inherit())
|
|
||||||
.output()
|
|
||||||
.expect("failed to spawn coverage reporter");
|
|
||||||
|
|
||||||
let actual =
|
|
||||||
util::strip_ansi_codes(std::str::from_utf8(&output.stdout).unwrap())
|
|
||||||
.to_string();
|
|
||||||
|
|
||||||
let expected = fs::read_to_string(
|
|
||||||
util::testdata_path().join("coverage/expected_complex.out"),
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
if !util::wildcard_match(&expected, &actual) {
|
|
||||||
println!("OUTPUT\n{}\nOUTPUT", actual);
|
|
||||||
println!("EXPECTED\n{}\nEXPECTED", expected);
|
|
||||||
panic!("pattern match failed");
|
|
||||||
}
|
|
||||||
|
|
||||||
assert!(output.status.success());
|
|
||||||
|
|
||||||
let output = util::deno_cmd()
|
|
||||||
.current_dir(util::testdata_path())
|
|
||||||
.arg("coverage")
|
|
||||||
.arg("--quiet")
|
|
||||||
.arg("--unstable")
|
|
||||||
.arg("--lcov")
|
|
||||||
.arg(format!("{}/", tempdir.path().to_str().unwrap()))
|
|
||||||
.stdout(std::process::Stdio::piped())
|
|
||||||
.stderr(std::process::Stdio::inherit())
|
|
||||||
.output()
|
|
||||||
.expect("failed to spawn coverage reporter");
|
|
||||||
|
|
||||||
let actual =
|
|
||||||
util::strip_ansi_codes(std::str::from_utf8(&output.stdout).unwrap())
|
|
||||||
.to_string();
|
|
||||||
|
|
||||||
let expected = fs::read_to_string(
|
|
||||||
util::testdata_path().join("coverage/expected_complex.lcov"),
|
|
||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
SF:[WILDCARD]branch.ts
|
SF:[WILDCARD]branch.ts
|
||||||
FN:2,branch
|
FN:1,branch
|
||||||
FN:10,unused
|
FN:9,unused
|
||||||
FNDA:1,branch
|
FNDA:1,branch
|
||||||
FNDA:0,unused
|
FNDA:0,unused
|
||||||
FNF:2
|
FNF:2
|
||||||
|
@ -11,10 +11,10 @@ BRH:0
|
||||||
DA:1,1
|
DA:1,1
|
||||||
DA:2,2
|
DA:2,2
|
||||||
DA:3,2
|
DA:3,2
|
||||||
DA:4,0
|
DA:4,2
|
||||||
DA:5,0
|
DA:5,0
|
||||||
DA:6,0
|
DA:6,0
|
||||||
DA:7,1
|
DA:7,2
|
||||||
DA:9,0
|
DA:9,0
|
||||||
DA:10,0
|
DA:10,0
|
||||||
DA:11,0
|
DA:11,0
|
||||||
|
@ -22,6 +22,6 @@ DA:12,0
|
||||||
DA:13,0
|
DA:13,0
|
||||||
DA:14,0
|
DA:14,0
|
||||||
DA:15,0
|
DA:15,0
|
||||||
LH:4
|
LH:5
|
||||||
LF:14
|
LF:14
|
||||||
end_of_record
|
end_of_record
|
|
@ -1,5 +1,4 @@
|
||||||
cover [WILDCARD]/coverage/branch.ts ... 28.571% (4/14)
|
cover [WILDCARD]/coverage/branch.ts ... 35.714% (5/14)
|
||||||
4 | } else {
|
|
||||||
5 | return false;
|
5 | return false;
|
||||||
6 | }
|
6 | }
|
||||||
-----|-----
|
-----|-----
|
|
@ -1,8 +1,8 @@
|
||||||
SF:[WILDCARD]complex.ts
|
SF:[WILDCARD]complex.ts
|
||||||
FN:22,dependency
|
FN:17,dependency
|
||||||
FN:37,complex
|
FN:32,complex
|
||||||
FN:51,unused
|
FN:46,unused
|
||||||
FN:65,ƒ
|
FN:64,ƒ
|
||||||
FNDA:1,dependency
|
FNDA:1,dependency
|
||||||
FNDA:1,complex
|
FNDA:1,complex
|
||||||
FNDA:0,unused
|
FNDA:0,unused
|
||||||
|
@ -20,7 +20,7 @@ DA:23,2
|
||||||
DA:24,2
|
DA:24,2
|
||||||
DA:25,2
|
DA:25,2
|
||||||
DA:26,2
|
DA:26,2
|
||||||
DA:27,1
|
DA:27,2
|
||||||
DA:32,1
|
DA:32,1
|
||||||
DA:33,1
|
DA:33,1
|
||||||
DA:34,1
|
DA:34,1
|
||||||
|
@ -30,7 +30,7 @@ DA:38,2
|
||||||
DA:39,2
|
DA:39,2
|
||||||
DA:40,2
|
DA:40,2
|
||||||
DA:41,2
|
DA:41,2
|
||||||
DA:42,1
|
DA:42,2
|
||||||
DA:46,0
|
DA:46,0
|
||||||
DA:47,0
|
DA:47,0
|
||||||
DA:48,0
|
DA:48,0
|
5
cli/tests/testdata/coverage/final_blankline.js
vendored
Normal file
5
cli/tests/testdata/coverage/final_blankline.js
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
// deno-fmt-ignore-file - has blankline at end
|
||||||
|
export default function example() {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
16
cli/tests/testdata/coverage/final_blankline_expected.lcov
vendored
Normal file
16
cli/tests/testdata/coverage/final_blankline_expected.lcov
vendored
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
SF:[WILDCARD]final_blankline.js
|
||||||
|
FN:2,example
|
||||||
|
FNDA:1,example
|
||||||
|
FNF:1
|
||||||
|
FNH:1
|
||||||
|
BRF:0
|
||||||
|
BRH:0
|
||||||
|
DA:1,1
|
||||||
|
DA:2,1
|
||||||
|
DA:3,2
|
||||||
|
DA:4,2
|
||||||
|
DA:5,1
|
||||||
|
DA:6,1
|
||||||
|
LH:6
|
||||||
|
LF:6
|
||||||
|
end_of_record
|
1
cli/tests/testdata/coverage/final_blankline_expected.out
vendored
Normal file
1
cli/tests/testdata/coverage/final_blankline_expected.out
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
cover file:///[WILDCARD]final_blankline.js ... 100.000% (6/6)
|
5
cli/tests/testdata/coverage/final_blankline_test.js
vendored
Normal file
5
cli/tests/testdata/coverage/final_blankline_test.js
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
import example from "./final_blankline.js";
|
||||||
|
|
||||||
|
Deno.test("Example.", () => {
|
||||||
|
example();
|
||||||
|
});
|
|
@ -9,8 +9,8 @@ use crate::proc_state::ProcState;
|
||||||
use crate::source_maps::SourceMapGetter;
|
use crate::source_maps::SourceMapGetter;
|
||||||
use crate::tools::fmt::format_json;
|
use crate::tools::fmt::format_json;
|
||||||
|
|
||||||
use deno_ast::swc::common::Span;
|
|
||||||
use deno_ast::MediaType;
|
use deno_ast::MediaType;
|
||||||
|
use deno_ast::ModuleSpecifier;
|
||||||
use deno_core::error::AnyError;
|
use deno_core::error::AnyError;
|
||||||
use deno_core::serde_json;
|
use deno_core::serde_json;
|
||||||
use deno_core::url::Url;
|
use deno_core::url::Url;
|
||||||
|
@ -25,15 +25,15 @@ use std::fs::File;
|
||||||
use std::io::BufWriter;
|
use std::io::BufWriter;
|
||||||
use std::io::Write;
|
use std::io::Write;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::sync::Arc;
|
use text_lines::TextLines;
|
||||||
use uuid::Uuid;
|
use uuid::Uuid;
|
||||||
|
|
||||||
// TODO(caspervonb) all of these structs can and should be made private, possibly moved to
|
|
||||||
// inspector::protocol.
|
|
||||||
#[derive(Debug, Serialize, Deserialize, Clone)]
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
||||||
#[serde(rename_all = "camelCase")]
|
#[serde(rename_all = "camelCase")]
|
||||||
struct CoverageRange {
|
struct CoverageRange {
|
||||||
|
/// Start byte index.
|
||||||
start_offset: usize,
|
start_offset: usize,
|
||||||
|
/// End byte index.
|
||||||
end_offset: usize,
|
end_offset: usize,
|
||||||
count: usize,
|
count: usize,
|
||||||
}
|
}
|
||||||
|
@ -171,6 +171,210 @@ impl CoverageCollector {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct BranchCoverageItem {
|
||||||
|
line_index: usize,
|
||||||
|
block_number: usize,
|
||||||
|
branch_number: usize,
|
||||||
|
taken: Option<usize>,
|
||||||
|
is_hit: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct FunctionCoverageItem {
|
||||||
|
name: String,
|
||||||
|
line_index: usize,
|
||||||
|
execution_count: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct CoverageReport {
|
||||||
|
url: ModuleSpecifier,
|
||||||
|
named_functions: Vec<FunctionCoverageItem>,
|
||||||
|
branches: Vec<BranchCoverageItem>,
|
||||||
|
found_lines: Vec<(usize, usize)>,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn generate_coverage_report(
|
||||||
|
script_coverage: &ScriptCoverage,
|
||||||
|
script_source: &str,
|
||||||
|
maybe_source_map: &Option<Vec<u8>>,
|
||||||
|
) -> CoverageReport {
|
||||||
|
let maybe_source_map = maybe_source_map
|
||||||
|
.as_ref()
|
||||||
|
.map(|source_map| SourceMap::from_slice(source_map).unwrap());
|
||||||
|
let text_lines = TextLines::new(script_source);
|
||||||
|
|
||||||
|
let comment_spans = deno_ast::lex(script_source, MediaType::JavaScript)
|
||||||
|
.into_iter()
|
||||||
|
.filter(|item| {
|
||||||
|
matches!(item.inner, deno_ast::TokenOrComment::Comment { .. })
|
||||||
|
})
|
||||||
|
.map(|item| item.span)
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
|
let url = Url::parse(&script_coverage.url).unwrap();
|
||||||
|
let mut coverage_report = CoverageReport {
|
||||||
|
url,
|
||||||
|
named_functions: Vec::with_capacity(
|
||||||
|
script_coverage
|
||||||
|
.functions
|
||||||
|
.iter()
|
||||||
|
.filter(|f| !f.function_name.is_empty())
|
||||||
|
.count(),
|
||||||
|
),
|
||||||
|
branches: Vec::new(),
|
||||||
|
found_lines: Vec::new(),
|
||||||
|
};
|
||||||
|
|
||||||
|
for function in &script_coverage.functions {
|
||||||
|
if function.function_name.is_empty() {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
let source_line_index =
|
||||||
|
text_lines.line_index(function.ranges[0].start_offset);
|
||||||
|
let line_index = if let Some(source_map) = maybe_source_map.as_ref() {
|
||||||
|
source_map
|
||||||
|
.tokens()
|
||||||
|
.find(|token| token.get_dst_line() as usize == source_line_index)
|
||||||
|
.map(|token| token.get_src_line() as usize)
|
||||||
|
.unwrap_or(0)
|
||||||
|
} else {
|
||||||
|
source_line_index
|
||||||
|
};
|
||||||
|
|
||||||
|
coverage_report.named_functions.push(FunctionCoverageItem {
|
||||||
|
name: function.function_name.clone(),
|
||||||
|
line_index,
|
||||||
|
execution_count: function.ranges[0].count,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
for (block_number, function) in script_coverage.functions.iter().enumerate() {
|
||||||
|
let block_hits = function.ranges[0].count;
|
||||||
|
for (branch_number, range) in function.ranges[1..].iter().enumerate() {
|
||||||
|
let source_line_index = text_lines.line_index(range.start_offset);
|
||||||
|
let line_index = if let Some(source_map) = maybe_source_map.as_ref() {
|
||||||
|
source_map
|
||||||
|
.tokens()
|
||||||
|
.find(|token| token.get_dst_line() as usize == source_line_index)
|
||||||
|
.map(|token| token.get_src_line() as usize)
|
||||||
|
.unwrap_or(0)
|
||||||
|
} else {
|
||||||
|
source_line_index
|
||||||
|
};
|
||||||
|
|
||||||
|
// From https://manpages.debian.org/unstable/lcov/geninfo.1.en.html:
|
||||||
|
//
|
||||||
|
// Block number and branch number are gcc internal IDs for the branch. Taken is either '-'
|
||||||
|
// if the basic block containing the branch was never executed or a number indicating how
|
||||||
|
// often that branch was taken.
|
||||||
|
//
|
||||||
|
// However with the data we get from v8 coverage profiles it seems we can't actually hit
|
||||||
|
// this as appears it won't consider any nested branches it hasn't seen but its here for
|
||||||
|
// the sake of accuracy.
|
||||||
|
let taken = if block_hits > 0 {
|
||||||
|
Some(range.count)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
coverage_report.branches.push(BranchCoverageItem {
|
||||||
|
line_index,
|
||||||
|
block_number,
|
||||||
|
branch_number,
|
||||||
|
taken,
|
||||||
|
is_hit: range.count > 0,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO(caspervonb): collect uncovered ranges on the lines so that we can highlight specific
|
||||||
|
// parts of a line in color (word diff style) instead of the entire line.
|
||||||
|
let mut line_counts = Vec::with_capacity(text_lines.lines_count());
|
||||||
|
for line_index in 0..text_lines.lines_count() {
|
||||||
|
let line_start_offset = text_lines.line_start(line_index);
|
||||||
|
let line_end_offset = text_lines.line_end(line_index);
|
||||||
|
let ignore = comment_spans.iter().any(|span| {
|
||||||
|
(span.lo.0 as usize) <= line_start_offset
|
||||||
|
&& (span.hi.0 as usize) >= line_end_offset
|
||||||
|
}) || script_source[line_start_offset..line_end_offset]
|
||||||
|
.trim()
|
||||||
|
.is_empty();
|
||||||
|
let mut count = 0;
|
||||||
|
|
||||||
|
if ignore {
|
||||||
|
count = 1;
|
||||||
|
} else {
|
||||||
|
// Count the hits of ranges that include the entire line which will always be at-least one
|
||||||
|
// as long as the code has been evaluated.
|
||||||
|
for function in &script_coverage.functions {
|
||||||
|
for range in &function.ranges {
|
||||||
|
if range.start_offset <= line_start_offset
|
||||||
|
&& range.end_offset >= line_end_offset
|
||||||
|
{
|
||||||
|
count += range.count;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// We reset the count if any block with a zero count overlaps with the line range.
|
||||||
|
for function in &script_coverage.functions {
|
||||||
|
for range in &function.ranges {
|
||||||
|
if range.count > 0 {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
let overlaps = range.start_offset < line_end_offset
|
||||||
|
&& range.end_offset > line_start_offset;
|
||||||
|
if overlaps {
|
||||||
|
count = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
line_counts.push(count);
|
||||||
|
}
|
||||||
|
|
||||||
|
coverage_report.found_lines =
|
||||||
|
if let Some(source_map) = maybe_source_map.as_ref() {
|
||||||
|
let mut found_lines = line_counts
|
||||||
|
.iter()
|
||||||
|
.enumerate()
|
||||||
|
.map(|(index, count)| {
|
||||||
|
// get all the mappings from this destination line to a different src line
|
||||||
|
let mut results = source_map
|
||||||
|
.tokens()
|
||||||
|
.filter(move |token| token.get_dst_line() as usize == index)
|
||||||
|
.map(move |token| (token.get_src_line() as usize, *count))
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
// only keep the results that point at different src lines
|
||||||
|
results.sort_unstable_by_key(|(index, _)| *index);
|
||||||
|
results.dedup_by_key(|(index, _)| *index);
|
||||||
|
results.into_iter()
|
||||||
|
})
|
||||||
|
.flatten()
|
||||||
|
.collect::<Vec<(usize, usize)>>();
|
||||||
|
|
||||||
|
found_lines.sort_unstable_by_key(|(index, _)| *index);
|
||||||
|
// combine duplicated lines
|
||||||
|
for i in (1..found_lines.len()).rev() {
|
||||||
|
if found_lines[i].0 == found_lines[i - 1].0 {
|
||||||
|
found_lines[i - 1].1 += found_lines[i].1;
|
||||||
|
found_lines.remove(i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
found_lines
|
||||||
|
} else {
|
||||||
|
line_counts
|
||||||
|
.into_iter()
|
||||||
|
.enumerate()
|
||||||
|
.map(|(index, count)| (index, count))
|
||||||
|
.collect::<Vec<(usize, usize)>>()
|
||||||
|
};
|
||||||
|
|
||||||
|
coverage_report
|
||||||
|
}
|
||||||
|
|
||||||
enum CoverageReporterKind {
|
enum CoverageReporterKind {
|
||||||
Pretty,
|
Pretty,
|
||||||
Lcov,
|
Lcov,
|
||||||
|
@ -186,13 +390,7 @@ fn create_reporter(
|
||||||
}
|
}
|
||||||
|
|
||||||
trait CoverageReporter {
|
trait CoverageReporter {
|
||||||
fn visit_coverage(
|
fn report(&mut self, coverage_report: &CoverageReport, file_text: &str);
|
||||||
&mut self,
|
|
||||||
script_coverage: &ScriptCoverage,
|
|
||||||
script_source: &str,
|
|
||||||
maybe_source_map: Option<Vec<u8>>,
|
|
||||||
maybe_original_source: Option<Arc<String>>,
|
|
||||||
);
|
|
||||||
|
|
||||||
fn done(&mut self);
|
fn done(&mut self);
|
||||||
}
|
}
|
||||||
|
@ -206,212 +404,67 @@ impl LcovCoverageReporter {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CoverageReporter for LcovCoverageReporter {
|
impl CoverageReporter for LcovCoverageReporter {
|
||||||
fn visit_coverage(
|
fn report(&mut self, coverage_report: &CoverageReport, _file_text: &str) {
|
||||||
&mut self,
|
let file_path = coverage_report
|
||||||
script_coverage: &ScriptCoverage,
|
.url
|
||||||
script_source: &str,
|
.to_file_path()
|
||||||
maybe_source_map: Option<Vec<u8>>,
|
.ok()
|
||||||
_maybe_original_source: Option<Arc<String>>,
|
.map(|p| p.to_str().map(|p| p.to_string()))
|
||||||
) {
|
.flatten()
|
||||||
// TODO(caspervonb) cleanup and reduce duplication between reporters, pre-compute line coverage
|
.unwrap_or_else(|| coverage_report.url.to_string());
|
||||||
// elsewhere.
|
println!("SF:{}", file_path);
|
||||||
let maybe_source_map = maybe_source_map
|
|
||||||
.map(|source_map| SourceMap::from_slice(&source_map).unwrap());
|
|
||||||
|
|
||||||
let url = Url::parse(&script_coverage.url).unwrap();
|
for function in &coverage_report.named_functions {
|
||||||
let file_path = url.to_file_path().unwrap();
|
println!("FN:{},{}", function.line_index + 1, function.name);
|
||||||
println!("SF:{}", file_path.to_str().unwrap());
|
|
||||||
|
|
||||||
let mut functions_found = 0;
|
|
||||||
for function in &script_coverage.functions {
|
|
||||||
if function.function_name.is_empty() {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let source_line = script_source
|
|
||||||
.chars()
|
|
||||||
.take(function.ranges[0].start_offset)
|
|
||||||
.filter(|c| *c == '\n')
|
|
||||||
.count()
|
|
||||||
+ 1;
|
|
||||||
|
|
||||||
let line_index = if let Some(source_map) = maybe_source_map.as_ref() {
|
|
||||||
source_map
|
|
||||||
.tokens()
|
|
||||||
.find(|token| token.get_dst_line() as usize == source_line)
|
|
||||||
.map(|token| token.get_src_line() as usize)
|
|
||||||
.unwrap_or(0)
|
|
||||||
} else {
|
|
||||||
source_line
|
|
||||||
};
|
|
||||||
|
|
||||||
let function_name = &function.function_name;
|
|
||||||
|
|
||||||
println!("FN:{},{}", line_index + 1, function_name);
|
|
||||||
|
|
||||||
functions_found += 1;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut functions_hit = 0;
|
for function in &coverage_report.named_functions {
|
||||||
for function in &script_coverage.functions {
|
println!("FNDA:{},{}", function.execution_count, function.name);
|
||||||
if function.function_name.is_empty() {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let execution_count = function.ranges[0].count;
|
|
||||||
let function_name = &function.function_name;
|
|
||||||
|
|
||||||
println!("FNDA:{},{}", execution_count, function_name);
|
|
||||||
|
|
||||||
if execution_count != 0 {
|
|
||||||
functions_hit += 1;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let functions_found = coverage_report.named_functions.len();
|
||||||
println!("FNF:{}", functions_found);
|
println!("FNF:{}", functions_found);
|
||||||
|
let functions_hit = coverage_report
|
||||||
|
.named_functions
|
||||||
|
.iter()
|
||||||
|
.filter(|f| f.execution_count > 0)
|
||||||
|
.count();
|
||||||
println!("FNH:{}", functions_hit);
|
println!("FNH:{}", functions_hit);
|
||||||
|
|
||||||
let mut branches_found = 0;
|
for branch in &coverage_report.branches {
|
||||||
let mut branches_hit = 0;
|
let taken = if let Some(taken) = &branch.taken {
|
||||||
for (block_number, function) in script_coverage.functions.iter().enumerate()
|
taken.to_string()
|
||||||
{
|
} else {
|
||||||
let block_hits = function.ranges[0].count;
|
"-".to_string()
|
||||||
for (branch_number, range) in function.ranges[1..].iter().enumerate() {
|
};
|
||||||
let source_line = script_source
|
|
||||||
.chars()
|
|
||||||
.take(range.start_offset)
|
|
||||||
.filter(|c| *c == '\n')
|
|
||||||
.count()
|
|
||||||
+ 1;
|
|
||||||
|
|
||||||
let line_index = if let Some(source_map) = maybe_source_map.as_ref() {
|
println!(
|
||||||
source_map
|
"BRDA:{},{},{},{}",
|
||||||
.tokens()
|
branch.line_index + 1,
|
||||||
.find(|token| token.get_dst_line() as usize == source_line)
|
branch.block_number,
|
||||||
.map(|token| token.get_src_line() as usize)
|
branch.branch_number,
|
||||||
.unwrap_or(0)
|
taken
|
||||||
} else {
|
);
|
||||||
source_line
|
|
||||||
};
|
|
||||||
|
|
||||||
// From https://manpages.debian.org/unstable/lcov/geninfo.1.en.html:
|
|
||||||
//
|
|
||||||
// Block number and branch number are gcc internal IDs for the branch. Taken is either '-'
|
|
||||||
// if the basic block containing the branch was never executed or a number indicating how
|
|
||||||
// often that branch was taken.
|
|
||||||
//
|
|
||||||
// However with the data we get from v8 coverage profiles it seems we can't actually hit
|
|
||||||
// this as appears it won't consider any nested branches it hasn't seen but its here for
|
|
||||||
// the sake of accuracy.
|
|
||||||
let taken = if block_hits > 0 {
|
|
||||||
range.count.to_string()
|
|
||||||
} else {
|
|
||||||
"-".to_string()
|
|
||||||
};
|
|
||||||
|
|
||||||
println!(
|
|
||||||
"BRDA:{},{},{},{}",
|
|
||||||
line_index + 1,
|
|
||||||
block_number,
|
|
||||||
branch_number,
|
|
||||||
taken
|
|
||||||
);
|
|
||||||
|
|
||||||
branches_found += 1;
|
|
||||||
if range.count > 0 {
|
|
||||||
branches_hit += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let branches_found = coverage_report.branches.len();
|
||||||
println!("BRF:{}", branches_found);
|
println!("BRF:{}", branches_found);
|
||||||
|
let branches_hit =
|
||||||
|
coverage_report.branches.iter().filter(|b| b.is_hit).count();
|
||||||
println!("BRH:{}", branches_hit);
|
println!("BRH:{}", branches_hit);
|
||||||
|
|
||||||
let lines = script_source.split('\n').collect::<Vec<_>>();
|
for (index, count) in &coverage_report.found_lines {
|
||||||
let line_offsets = {
|
|
||||||
let mut offsets: Vec<(usize, usize)> = Vec::new();
|
|
||||||
let mut index = 0;
|
|
||||||
|
|
||||||
for line in &lines {
|
|
||||||
offsets.push((index, index + line.len() + 1));
|
|
||||||
index += line.len() + 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
offsets
|
|
||||||
};
|
|
||||||
|
|
||||||
let line_counts = line_offsets
|
|
||||||
.iter()
|
|
||||||
.map(|(line_start_offset, line_end_offset)| {
|
|
||||||
let mut count = 0;
|
|
||||||
|
|
||||||
// Count the hits of ranges that include the entire line which will always be at-least one
|
|
||||||
// as long as the code has been evaluated.
|
|
||||||
for function in &script_coverage.functions {
|
|
||||||
for range in &function.ranges {
|
|
||||||
if range.start_offset <= *line_start_offset
|
|
||||||
&& range.end_offset >= *line_end_offset
|
|
||||||
{
|
|
||||||
count += range.count;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// We reset the count if any block with a zero count overlaps with the line range.
|
|
||||||
for function in &script_coverage.functions {
|
|
||||||
for range in &function.ranges {
|
|
||||||
if range.count > 0 {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let overlaps = std::cmp::max(line_end_offset, &range.end_offset)
|
|
||||||
- std::cmp::min(line_start_offset, &range.start_offset)
|
|
||||||
< (line_end_offset - line_start_offset)
|
|
||||||
+ (range.end_offset - range.start_offset);
|
|
||||||
|
|
||||||
if overlaps {
|
|
||||||
count = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
count
|
|
||||||
})
|
|
||||||
.collect::<Vec<usize>>();
|
|
||||||
|
|
||||||
let found_lines = if let Some(source_map) = maybe_source_map.as_ref() {
|
|
||||||
let mut found_lines = line_counts
|
|
||||||
.iter()
|
|
||||||
.enumerate()
|
|
||||||
.map(|(index, count)| {
|
|
||||||
source_map
|
|
||||||
.tokens()
|
|
||||||
.filter(move |token| token.get_dst_line() as usize == index)
|
|
||||||
.map(move |token| (token.get_src_line() as usize, *count))
|
|
||||||
})
|
|
||||||
.flatten()
|
|
||||||
.collect::<Vec<(usize, usize)>>();
|
|
||||||
|
|
||||||
found_lines.sort_unstable_by_key(|(index, _)| *index);
|
|
||||||
found_lines.dedup_by_key(|(index, _)| *index);
|
|
||||||
found_lines
|
|
||||||
} else {
|
|
||||||
line_counts
|
|
||||||
.iter()
|
|
||||||
.enumerate()
|
|
||||||
.map(|(index, count)| (index, *count))
|
|
||||||
.collect::<Vec<(usize, usize)>>()
|
|
||||||
};
|
|
||||||
|
|
||||||
for (index, count) in &found_lines {
|
|
||||||
println!("DA:{},{}", index + 1, count);
|
println!("DA:{},{}", index + 1, count);
|
||||||
}
|
}
|
||||||
|
|
||||||
let lines_hit = found_lines.iter().filter(|(_, count)| *count != 0).count();
|
let lines_hit = coverage_report
|
||||||
|
.found_lines
|
||||||
|
.iter()
|
||||||
|
.filter(|(_, count)| *count != 0)
|
||||||
|
.count();
|
||||||
println!("LH:{}", lines_hit);
|
println!("LH:{}", lines_hit);
|
||||||
|
|
||||||
let lines_found = found_lines.len();
|
let lines_found = coverage_report.found_lines.len();
|
||||||
println!("LF:{}", lines_found);
|
println!("LF:{}", lines_found);
|
||||||
|
|
||||||
println!("end_of_record");
|
println!("end_of_record");
|
||||||
|
@ -429,134 +482,28 @@ impl PrettyCoverageReporter {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CoverageReporter for PrettyCoverageReporter {
|
impl CoverageReporter for PrettyCoverageReporter {
|
||||||
fn visit_coverage(
|
fn report(&mut self, coverage_report: &CoverageReport, file_text: &str) {
|
||||||
&mut self,
|
let lines = file_text.split('\n').collect::<Vec<_>>();
|
||||||
script_coverage: &ScriptCoverage,
|
print!("cover {} ... ", coverage_report.url);
|
||||||
script_source: &str,
|
|
||||||
maybe_source_map: Option<Vec<u8>>,
|
|
||||||
maybe_original_source: Option<Arc<String>>,
|
|
||||||
) {
|
|
||||||
let maybe_source_map = maybe_source_map
|
|
||||||
.map(|source_map| SourceMap::from_slice(&source_map).unwrap());
|
|
||||||
|
|
||||||
let mut ignored_spans: Vec<Span> = Vec::new();
|
let hit_lines = coverage_report
|
||||||
for item in deno_ast::lex(script_source, MediaType::JavaScript) {
|
.found_lines
|
||||||
if let deno_ast::TokenOrComment::Token(_) = item.inner {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
ignored_spans.push(item.span);
|
|
||||||
}
|
|
||||||
|
|
||||||
let lines = script_source.split('\n').collect::<Vec<_>>();
|
|
||||||
|
|
||||||
let line_offsets = {
|
|
||||||
let mut offsets: Vec<(usize, usize)> = Vec::new();
|
|
||||||
let mut index = 0;
|
|
||||||
|
|
||||||
for line in &lines {
|
|
||||||
offsets.push((index, index + line.len() + 1));
|
|
||||||
index += line.len() + 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
offsets
|
|
||||||
};
|
|
||||||
|
|
||||||
// TODO(caspervonb): collect uncovered ranges on the lines so that we can highlight specific
|
|
||||||
// parts of a line in color (word diff style) instead of the entire line.
|
|
||||||
let line_counts = line_offsets
|
|
||||||
.iter()
|
.iter()
|
||||||
.enumerate()
|
.filter(|(_, count)| *count > 0)
|
||||||
.map(|(index, (line_start_offset, line_end_offset))| {
|
|
||||||
let ignore = ignored_spans.iter().any(|span| {
|
|
||||||
(span.lo.0 as usize) <= *line_start_offset
|
|
||||||
&& (span.hi.0 as usize) >= *line_end_offset
|
|
||||||
});
|
|
||||||
|
|
||||||
if ignore {
|
|
||||||
return (index, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut count = 0;
|
|
||||||
|
|
||||||
// Count the hits of ranges that include the entire line which will always be at-least one
|
|
||||||
// as long as the code has been evaluated.
|
|
||||||
for function in &script_coverage.functions {
|
|
||||||
for range in &function.ranges {
|
|
||||||
if range.start_offset <= *line_start_offset
|
|
||||||
&& range.end_offset >= *line_end_offset
|
|
||||||
{
|
|
||||||
count += range.count;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// We reset the count if any block with a zero count overlaps with the line range.
|
|
||||||
for function in &script_coverage.functions {
|
|
||||||
for range in &function.ranges {
|
|
||||||
if range.count > 0 {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let overlaps = std::cmp::max(line_end_offset, &range.end_offset)
|
|
||||||
- std::cmp::min(line_start_offset, &range.start_offset)
|
|
||||||
< (line_end_offset - line_start_offset)
|
|
||||||
+ (range.end_offset - range.start_offset);
|
|
||||||
|
|
||||||
if overlaps {
|
|
||||||
count = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
(index, count)
|
|
||||||
})
|
|
||||||
.collect::<Vec<(usize, usize)>>();
|
|
||||||
|
|
||||||
let lines = if let Some(original_source) = maybe_original_source.as_ref() {
|
|
||||||
original_source.split('\n').collect::<Vec<_>>()
|
|
||||||
} else {
|
|
||||||
lines
|
|
||||||
};
|
|
||||||
|
|
||||||
let line_counts = if let Some(source_map) = maybe_source_map.as_ref() {
|
|
||||||
let mut line_counts = line_counts
|
|
||||||
.iter()
|
|
||||||
.map(|(index, count)| {
|
|
||||||
source_map
|
|
||||||
.tokens()
|
|
||||||
.filter(move |token| token.get_dst_line() as usize == *index)
|
|
||||||
.map(move |token| (token.get_src_line() as usize, *count))
|
|
||||||
})
|
|
||||||
.flatten()
|
|
||||||
.collect::<Vec<(usize, usize)>>();
|
|
||||||
|
|
||||||
line_counts.sort_unstable_by_key(|(index, _)| *index);
|
|
||||||
line_counts.dedup_by_key(|(index, _)| *index);
|
|
||||||
|
|
||||||
line_counts
|
|
||||||
} else {
|
|
||||||
line_counts
|
|
||||||
};
|
|
||||||
|
|
||||||
print!("cover {} ... ", script_coverage.url);
|
|
||||||
|
|
||||||
let hit_lines = line_counts
|
|
||||||
.iter()
|
|
||||||
.filter(|(_, count)| *count != 0)
|
|
||||||
.map(|(index, _)| *index);
|
.map(|(index, _)| *index);
|
||||||
|
|
||||||
let missed_lines = line_counts
|
let missed_lines = coverage_report
|
||||||
|
.found_lines
|
||||||
.iter()
|
.iter()
|
||||||
.filter(|(_, count)| *count == 0)
|
.filter(|(_, count)| *count == 0)
|
||||||
.map(|(index, _)| *index);
|
.map(|(index, _)| *index);
|
||||||
|
|
||||||
let lines_found = line_counts.len();
|
let lines_found = coverage_report.found_lines.len();
|
||||||
let lines_hit = hit_lines.count();
|
let lines_hit = hit_lines.count();
|
||||||
let line_ratio = lines_hit as f32 / lines_found as f32;
|
let line_ratio = lines_hit as f32 / lines_found as f32;
|
||||||
|
|
||||||
let line_coverage =
|
let line_coverage =
|
||||||
format!("{:.3}% ({}/{})", line_ratio * 100.0, lines_hit, lines_found,);
|
format!("{:.3}% ({}/{})", line_ratio * 100.0, lines_hit, lines_found);
|
||||||
|
|
||||||
if line_ratio >= 0.9 {
|
if line_ratio >= 0.9 {
|
||||||
println!("{}", colors::green(&line_coverage));
|
println!("{}", colors::green(&line_coverage));
|
||||||
|
@ -715,12 +662,21 @@ pub async fn cover_files(
|
||||||
.get_source(&module_specifier)
|
.get_source(&module_specifier)
|
||||||
.map(|f| f.source);
|
.map(|f| f.source);
|
||||||
|
|
||||||
reporter.visit_coverage(
|
let coverage_report = generate_coverage_report(
|
||||||
&script_coverage,
|
&script_coverage,
|
||||||
script_source,
|
script_source,
|
||||||
maybe_source_map,
|
&maybe_source_map,
|
||||||
maybe_cached_source,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
|
let file_text = if let Some(original_source) =
|
||||||
|
maybe_source_map.and(maybe_cached_source.as_ref())
|
||||||
|
{
|
||||||
|
original_source.as_str()
|
||||||
|
} else {
|
||||||
|
script_source
|
||||||
|
};
|
||||||
|
|
||||||
|
reporter.report(&coverage_report, file_text);
|
||||||
}
|
}
|
||||||
|
|
||||||
reporter.done();
|
reporter.done();
|
||||||
|
|
Loading…
Reference in a new issue