Skip to content

html report functionality extend #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zbelinsk wants to merge 3 commits into
base: master
Choose a base branch
from
Open

html report functionality extend #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d068d9
html report: add packet summary to sidebar header and per-file omit b…
zbelinsk Jun 28, 2026
9625c48
html report: add --min-packets flag to filter trivial functions by pa…
zbelinsk Jun 28, 2026
e4c359b
Merge branch 'master' into extend-interacitve-coverage
zbelinsk Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion scripts/Makefile.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ COV_FILES = $(patsubst %, $(TEST_BUILD_ROOT)/%/cov.txt, $(SUBDIRS))
# drops these; the cov.html "Omit" button produces an updated copy to commit.
COV_OMIT = $(H2DIR)/scripts/cov_omit_functions

# Minimum packet count threshold: functions with <= N packets are excluded from
# the HTML report (they are too small to produce meaningful coverage signal).
# Override on the command line: make cov TARGET=ref_cov COV_MIN_PACKETS=3
# Default is 1 (only single-packet stubs are filtered).

all:
$(MAKE) -f scripts/Makefile.coverage $(SUBDIRS) TARG=all

Expand Down Expand Up @@ -120,7 +125,8 @@ $(INSTALLPATH)/cov.html: $(INSTALLPATH)/cov/cov.rpt $(INSTALLPATH)/cov/cov_files
$(PYTHON) ${H2DIR}/scripts/cov_html_report.py \
--rpt $< --cov $(INSTALLPATH)/cov/cov.txt \
--fn-files $(INSTALLPATH)/cov/cov_files --omit-file $(COV_OMIT) --output $@ \
$(patsubst %,--test-cov %,$(COV_FILES))
$(patsubst %,--test-cov %,$(COV_FILES)) \
$(if $(COV_MIN_PACKETS),--min-packets $(COV_MIN_PACKETS))

# Collect per-test results.txt into a clean PASS/FAIL summary and append to TESTOUT.
# Called after tst completes; each test's full output is in <test-dir>/make.log.
Expand Down
44 changes: 39 additions & 5 deletions scripts/cov_html_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@
.tree-fn.active .tree-label { color: #fff; }
.tree-root { background: #252526; font-weight: bold; border-bottom: 1px solid #444; }
.tree-root .tree-label { color: #ccc; }
.tree-omit-btn {
margin-left: auto; background: transparent; border: none;
color: #a44; font-size: 0.85em; cursor: pointer; padding: 0 4px;
border-radius: 3px; line-height: 1; flex-shrink: 0;
}
.tree-omit-btn:hover { color: #f99; background: #3c2222; }

#detail { flex: 1; overflow: hidden; display: flex; flex-direction: column; padding: 16px 20px; background: #1e1e1e; color: #ccc; }
#detail h2 { font-size: 1em; margin-bottom: 10px; color: #9cdcfe; border-bottom: 1px solid #333; padding-bottom: 6px; flex-shrink: 0; }
Expand Down Expand Up @@ -618,14 +624,15 @@
}

// Collapse single-child directory chains (a/b/c → a/b/c) for compactness.
function treeRowHtml(label, pct, depth, kind, key, isOpen, dataAttr) {
function treeRowHtml(label, pct, depth, kind, key, isOpen, dataAttr, extra) {
var pad = 10 + depth * 14;
var arrow = kind === 'leaf' ? '' :
'<span class="tree-arrow">' + (isOpen ? '▾' : '▸') + '</span>';
var badge = '<span class="pct ' + pctClass(pct) + '">' + pct + '%</span>';
return '<div class="tree-row tree-' + kind + '" style="padding-left:' + pad + 'px;" '
+ dataAttr + '>' + arrow + badge
+ '<span class="tree-label">' + escSvg(label) + '</span></div>';
+ '<span class="tree-label">' + escSvg(label) + '</span>'
+ (extra || '') + '</div>';
}

function renderTreeNode(node, depth, out) {
Expand All @@ -649,8 +656,11 @@
fileKeys.forEach(function(k) {
var f = node.files[k];
var isOpen = !treeCollapsed[f.path];
var safePath = f.path.replace(/'/g, "\\'");
var omitBtn = '<button class="tree-omit-btn" title="Omit all functions in this file" '
+ 'onclick="event.stopPropagation();omitFile(\'' + safePath + '\')">⊘</button>';
out.push(treeRowHtml(f.name, nodePct(f), depth, 'file', f.path, isOpen,
'onclick="toggleTreeNode(\'' + f.path.replace(/'/g, "\\'") + '\')"'));
'onclick="toggleTreeNode(\'' + safePath + '\')"', omitBtn));
if (isOpen) {
// functions in this file, sorted by pct asc
f.fns.slice().sort(function(a, b) {
Expand Down Expand Up @@ -753,6 +763,23 @@
if (nextFn) show(nextFn);
}

// Omit all functions belonging to a given source file path.
function omitFile(filePath) {
var fns = Object.keys(fnSrc).filter(function(fn) { return fnSrc[fn] === filePath; });
var visible = fns.filter(function(fn) { return !isOmitted(fn); });
if (!visible.length) return;
if (!confirm('Omit all ' + visible.length + ' function(s) in ' + filePath + '?')) return;
visible.forEach(function(fn) { localOmit[fn] = 1; });
saveLocalOmit();
refreshOmitUi();
onTestChange();
refreshDetail();
if (currentFunc && isOmitted(currentFunc)) {
var first = document.querySelector('.fn-entry:not([style*="display: none"]):not([style*="display:none"])');
if (first) show(first.dataset.fn);
}
}

// Restore a single session-omitted function (live — no reload needed).
function restoreOmit(fn) {
delete localOmit[fn];
Expand Down Expand Up @@ -1027,6 +1054,10 @@ def build_html(funcs, cov_data, test_covs, fn_src, omit_names=None, omit_header=
execd, total = packet_counts(lines)
fn_packets[name] = [execd, total]

total_exec_pkts = sum(v[0] for v in fn_packets.values())
total_pkts = sum(v[1] for v in fn_packets.values())
pkt_pct = round(100 * total_exec_pkts / total_pkts) if total_pkts else 0

callees, callers = build_call_graphs(cov_data, tracked_fns)

fn_data_js = 'var fnData = {\n' + ',\n'.join(fn_data_entries) + '\n};'
Expand Down Expand Up @@ -1149,7 +1180,8 @@ def build_html(funcs, cov_data, test_covs, fn_src, omit_names=None, omit_header=
'<div id="sidebar">',
'<div id="sidebar-header">',
' <strong>Coverage Report</strong><br>',
f' {total} functions &nbsp;·&nbsp; {covered_any} hit &nbsp;·&nbsp; {covered_100} at 100%',
f' {total} functions &nbsp;·&nbsp; {covered_any} hit &nbsp;·&nbsp; {covered_100} at 100%<br>',
f' {total_exec_pkts} / {total_pkts} packets &nbsp;·&nbsp; {pkt_pct}% coverage',
'</div>',
test_selector,
threshold,
Expand Down Expand Up @@ -1224,6 +1256,8 @@ def main():
ap.add_argument('--test-cov', action='append', metavar='FILE', default=[],
dest='test_covs',
help='Per-test cov.txt path; may be repeated. Test name derived from path.')
ap.add_argument('--min-packets', type=int, default=1, metavar='N', dest='min_packets',
help='Filter functions with <= N packets (default 1).')
args = ap.parse_args()

funcs = parse_rpt(args.rpt)
Expand All @@ -1248,7 +1282,7 @@ def main():
print(f'[cov_html_report] dropped {len(present)} committed-omit functions',
file=sys.stderr)

func_minimal_packet_length = 1
func_minimal_packet_length = args.min_packets
trivial = {name for _, name in funcs
if packet_counts(cov_data.get(name, []))[1] <= func_minimal_packet_length}
if trivial:
Expand Down
Loading