Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH · Issue #936 · TypedDevs/bashunit · GitHub
Skip to content

bug(coverage): variable assignments are counted as functions, corrupting LCOV FNF/FNH #936

Description

@Chemaclass

Summary

bashunit::coverage::extract_functions misclassifies ordinary variable assignments as
single-line function definitions. The result is wrong function metrics in every LCOV report,
and — when the assigned value also contains a | — a raw bash arithmetic error printed to
stderr on every --coverage run.

Reproduces on main (be37b72). Long-standing: it also reproduces before the coverage
module split (#925/#928), which only changed the file the error names.

Reproduce

./bashunit --coverage --parallel tests/
./src/coverage/report_lcov.sh: line 38: ((: $: syntax error: operand expected (error token is "$")

Minimal case, in any user project:

# victim.sh
PS4_LIKE="x|${LINENO}"functionreal_fn() { echo hi; }

extract_functions emits:

PS4_LIKE="x|$|4|4 <- not a function, and 4 fields instead of 3
real_fn|5|5

Root cause

Two independent defects that compound.

1. extract_functions accepts a variable assignment as a function definition.
It derives the candidate name by cutting at the first space, ( or {:

fn_name="${stripped%%[[:space:]\(\{]*}"

For PS4_LIKE="x|${LINENO}" the first such character is the { of the ${LINENO}
expansion, so fn_name becomes PS4_LIKE="x|$ and the remainder {LINENO}" starts with
{ — which the validator accepts as a function body opener:

case"$after_name"in'()'* | '{'*) ;; # <- matches "{LINENO}\""

Brace counting then balances on the same line ({} inside the expansion), so it is
emitted as a single-line function.

The trigger is any assignment with no whitespace before a ${...}, which is extremely
common: URL="https://${host}/api", PATH_="$HOME/${sub}", MSG="a${b}".
GREETING="hello ${USER}" is not affected — the space cuts the name first — which is why
this has gone unnoticed.

2. The record format is pipe-delimited with no escaping. A bogus name containing |
shifts every field. report_lcov then reads it with IFS='|' read -r fn_name fn_start fn_end
and does arithmetic on the result without validating it:

for((fln = fn_start; fln <= fn_end; fln++));do

fn_start is the literal $, hence ((: $: syntax error: operand expected.

In bashunit's own source the offending line is
src/coverage/engine.sh:18 (_BASHUNIT_COVERAGE_XTRACE_PS4='@|${BASH_SOURCE}'…).

Impact

  • Silent and wide: any file containing VAR="...${x}..." gets a phantom FN record, so
    FNF (functions found) and FNH (functions hit) are wrong in the LCOV output consumed by
    genhtml, Codecov and Coveralls. This affects user projects, not just bashunit.
  • Loud but narrow: when the value also contains |, stderr gets a bash arithmetic error
    per affected file. Cosmetic, but it makes --coverage output look broken.

Not caught by CI because --coverage is a nightly, non-gating workflow
(.github/workflows/coverage.yml) and the error goes to stderr without failing the run.

Proposal

Fix the detection, and make the consumer defensive:

  1. Reject assignments in extract_functions. A candidate name containing =, ", '
    or $ is not a function name. The cheapest correct guard is to require the candidate to
    match an identifier ([a-zA-Z_][a-zA-Z0-9_:]*) in full, rather than only checking its
    first character — a pure-bash case with no fork, consistent with the current fast path.
  2. Make the record robust. Either reject any name that would contain the delimiter, or
    have report_lcov validate fn_start/fn_end are numeric before the for ((...))
    preferably both. A malformed record should never reach arithmetic.

Acceptance criteria

  • RED first: a unit test on extract_functions pinning that VAR="x|${Y}",
    URL="https://${host}/api" and similar assignments yield no record, and that real
    single-line and multi-line functions still do
  • A test that report_lcov emits no bash error for a file containing such an assignment
  • ./bashunit --coverage --parallel tests/ produces no ((: error on stderr
  • FNF/FNH counts in the generated coverage/lcov.info no longer include phantom
    entries (compare before/after on src/coverage/engine.sh)
  • ./bashunit tests/ · --parallel · --parallel --simple --strict green
  • make sa && make lint green
  • Bash 3.0+ compatible; no new forks on the reporting path
    (.claude/rules/perf-fork-budget.md)
  • CHANGELOG entry under Unreleased → Fixed

Do not

  • Do not "fix" it by suppressing stderr — the silent wrong FNF/FNH is the more serious half
  • Do not add a grep/sed fork per line to extract_functions; the guard is a case
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions