foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-24 15:19:26 -05:00
Code Issues Packages 1 Wiki Activity

feat(coverage): add breadcrumbs to deno coverage --html report (#24860)

Browse source
This commit is contained in:
Łukasz Czerniawski 2024-08-14 09:37:19 +02:00 committed by GitHub
parent fd1f8234f4
commit e2faf50375
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 67 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
cli/tools/coverage/reporter.rs
View file

@ -475,8 +475,14 @@ impl HtmlCoverageReporter {
format!("Coverage report for {node}") format!("Coverage report for {node}")
}; };
let title = title.replace(std::path::MAIN_SEPARATOR, "/"); let title = title.replace(std::path::MAIN_SEPARATOR, "/");
let breadcrumbs_parts = node
.split(std::path::MAIN_SEPARATOR)
.filter(|s| !s.is_empty())
.collect::<Vec<_>>();
let head = self.create_html_head(&title); let head = self.create_html_head(&title);
let header = self.create_html_header(&title, stats); let breadcrumb_navigation =
self.create_breadcrumbs_navigation(&breadcrumbs_parts, is_dir);
let header = self.create_html_header(&breadcrumb_navigation, stats);
let footer = self.create_html_footer(timestamp); let footer = self.create_html_footer(timestamp);
format!( format!(
"<!doctype html> "<!doctype html>
@ -513,7 +519,7 @@ impl HtmlCoverageReporter {
/// Creates header part of the contents for html report. /// Creates header part of the contents for html report.
pub fn create_html_header( pub fn create_html_header(
&self, &self,
title: &str, breadcrumb_navigation: &str,
stats: &CoverageStats, stats: &CoverageStats,
) -> String { ) -> String {
let CoverageStats { let CoverageStats {
@ -531,7 +537,7 @@ impl HtmlCoverageReporter {
format!( format!(
" "
<div class='pad1'> <div class='pad1'>
<h1>{title}</h1> <h1>{breadcrumb_navigation}</h1>
<div class='clearfix'> <div class='clearfix'>
<div class='fl pad1y space-right2'> <div class='fl pad1y space-right2'>
<span class='strong'>{branch_percent:.2}%</span> <span class='strong'>{branch_percent:.2}%</span>
@ -681,4 +687,47 @@ impl HtmlCoverageReporter {
</table>" </table>"
) )
} }
pub fn create_breadcrumbs_navigation(
&self,
breadcrumbs_parts: &[&str],
is_dir: bool,
) -> String {
let mut breadcrumbs_html = Vec::new();
let root_repeats = if is_dir {
breadcrumbs_parts.len()
} else {
breadcrumbs_parts.len() - 1
};
let mut root_url = "../".repeat(root_repeats);
root_url += "index.html";
breadcrumbs_html.push(format!("<a href='{root_url}'>All files</a>"));
for (index, breadcrumb) in breadcrumbs_parts.iter().enumerate() {
let mut full_url = "../".repeat(breadcrumbs_parts.len() - (index + 1));
if index == breadcrumbs_parts.len() - 1 {
breadcrumbs_html.push(breadcrumb.to_string());
continue;
}
if is_dir {
full_url += "index.html";
} else {
full_url += breadcrumb;
if index != breadcrumbs_parts.len() - 1 {
full_url += "/index.html";
}
}
breadcrumbs_html.push(format!("<a href='{full_url}'>{breadcrumb}</a>"))
}
if breadcrumbs_parts.is_empty() {
return String::from("All files");
}
breadcrumbs_html.into_iter().collect::<Vec<_>>().join(" / ")
}
} }

21
tests/integration/coverage_tests.rs
View file

@ -516,7 +516,7 @@ fn test_html_reporter() {
output.assert_matches_text("HTML coverage report has been generated at [WILDCARD]/cov/html/index.html\n"); output.assert_matches_text("HTML coverage report has been generated at [WILDCARD]/cov/html/index.html\n");
let index_html = tempdir.join("html").join("index.html").read_to_string(); let index_html = tempdir.join("html").join("index.html").read_to_string();
assert_contains!(index_html, "<h1>Coverage report for all files</h1>"); assert_contains!(index_html, "<h1>All files</h1>");
assert_contains!(index_html, "baz/"); assert_contains!(index_html, "baz/");
assert_contains!(index_html, "href='baz/index.html'"); assert_contains!(index_html, "href='baz/index.html'");
assert_contains!(index_html, "foo.ts"); assert_contains!(index_html, "foo.ts");
@ -525,13 +525,19 @@ fn test_html_reporter() {
assert_contains!(index_html, "href='bar.ts.html'"); assert_contains!(index_html, "href='bar.ts.html'");
let foo_ts_html = tempdir.join("html").join("foo.ts.html").read_to_string(); let foo_ts_html = tempdir.join("html").join("foo.ts.html").read_to_string();
assert_contains!(foo_ts_html, "<h1>Coverage report for foo.ts</h1>"); assert_contains!(
foo_ts_html,
"<h1><a href='index.html'>All files</a> / foo.ts</h1>"
);
// Check that line count has correct title attribute // Check that line count has correct title attribute
assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 1 time'>x1</span>"); assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 1 time'>x1</span>");
assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 3 times'>x3</span>"); assert_contains!(foo_ts_html, "<span class='cline-any cline-yes' title='This line is covered 3 times'>x3</span>");
let bar_ts_html = tempdir.join("html").join("bar.ts.html").read_to_string(); let bar_ts_html = tempdir.join("html").join("bar.ts.html").read_to_string();
assert_contains!(bar_ts_html, "<h1>Coverage report for bar.ts</h1>"); assert_contains!(
bar_ts_html,
"<h1><a href='index.html'>All files</a> / bar.ts</h1>"
);
// Check <T> in source code is escaped to &lt;T&gt; // Check <T> in source code is escaped to &lt;T&gt;
assert_contains!(bar_ts_html, "&lt;T&gt;"); assert_contains!(bar_ts_html, "&lt;T&gt;");
// Check that line anchors are correctly referenced by line number links // Check that line anchors are correctly referenced by line number links
@ -543,7 +549,10 @@ fn test_html_reporter() {
.join("baz") .join("baz")
.join("index.html") .join("index.html")
.read_to_string(); .read_to_string();
assert_contains!(baz_index_html, "<h1>Coverage report for baz/</h1>"); assert_contains!(
baz_index_html,
"<h1><a href='../index.html'>All files</a> / baz</h1>"
);
assert_contains!(baz_index_html, "qux.ts"); assert_contains!(baz_index_html, "qux.ts");
assert_contains!(baz_index_html, "href='qux.ts.html'"); assert_contains!(baz_index_html, "href='qux.ts.html'");
assert_contains!(baz_index_html, "quux.ts"); assert_contains!(baz_index_html, "quux.ts");
@ -554,7 +563,7 @@ fn test_html_reporter() {
.join("baz") .join("baz")
.join("qux.ts.html") .join("qux.ts.html")
.read_to_string(); .read_to_string();
assert_contains!(baz_qux_ts_html, "<h1>Coverage report for baz/qux.ts</h1>"); assert_contains!(baz_qux_ts_html, "<h1><a href='../index.html'>All files</a> / <a href='../baz/index.html'>baz</a> / qux.ts</h1>");
let baz_quux_ts_html = tempdir let baz_quux_ts_html = tempdir
.join("html") .join("html")
@ -563,7 +572,7 @@ fn test_html_reporter() {
.read_to_string(); .read_to_string();
assert_contains!( assert_contains!(
baz_quux_ts_html, baz_quux_ts_html,
"<h1>Coverage report for baz/quux.ts</h1>" "<h1><a href='../index.html'>All files</a> / <a href='../baz/index.html'>baz</a> / quux.ts</h1>"
); );
} }