Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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" + '
perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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('^' + ".*" + ' perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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('^' + ".*" + ' perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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" + ' perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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('^' + ".*" + ' perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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('^' + ".*" + ' perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading
, '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); } })(); })(); perf(coverage): single-pass file scan + native regex in extract_functions by Chemaclass · Pull Request #644 · TypedDevs/bashunit · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@

### Changed
- Speed up coverage report generation by collapsing the per-line non-executable pattern checks in `bashunit::coverage::is_executable_line` into a single combined `grep` invocation (#636)
- Speed up coverage report generation further by combining executable + hit counting into a single source-file pass (`bashunit::coverage::compute_file_coverage`) shared across text/lcov/html reporters, removing per-line `get_line_hits` scans of the coverage data file (#636)
- Replace `echo | sed` / `echo | grep` subshells in `bashunit::coverage::extract_functions` with bash native regex matching and parameter expansion (#636)

## [0.35.0](https://github.com/TypedDevs/bashunit/compare/0.34.1...0.35.0) - 2026-04-26

Expand Down
95 changes: 68 additions & 27 deletions src/coverage.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,9 +173,10 @@ function bashunit::coverage::calculate_percentage() {
# Get file coverage stats as "executable:hit:pct:class"
function bashunit::coverage::get_file_stats() {
local file="$1"
local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
local stats executable hit pct class
stats=$(bashunit::coverage::compute_file_coverage "$file")
executable="${stats%%:*}"
hit="${stats##*:}"
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
echo "${executable}:${hit}:${pct}:${class}"
Expand DownExpand Up@@ -517,6 +518,30 @@ function bashunit::coverage::get_line_hits() {
echo "$count"
}

# Compute executable + hit counts for a file in a single source-file pass.
# Reuses get_all_line_hits to avoid scanning the coverage data per line.
# Output format: "executable:hit"
function bashunit::coverage::compute_file_coverage() {
local file="$1"

local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local executable=0 hit=0 lineno=0 line line_hits
while IFS= read -r line || [ -n "$line" ]; do
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
done <"$file"

echo "${executable}:${hit}"
}

# Get all line hits for a file in one pass (performance optimization)
# Output format: one "lineno:count" per line
function bashunit::coverage::get_all_line_hits() {
Expand DownExpand Up@@ -571,12 +596,16 @@ function bashunit::coverage::extract_functions() {
if [ "$in_function" -eq 0 ]; then
local fn_name=""

# Match: function name() or function name {
# Match: name() with optional `function` keyword (parens form)
local _re='^[[:space:]]*(function[[:space:]]+)?([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\(\)[[:space:]]*\{?[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [ -z "$fn_name" ]; then
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
else
# Match: function name { (keyword form, no parens)
_re='^[[:space:]]*(function[[:space:]]+)([a-zA-Z_][a-zA-Z0-9_:]*)[[:space:]]*\{[[:space:]]*(#.*)?$'
fn_name=$(echo "$line" | sed -nE "s/$_re/\2/p")
if [[ "$line" =~ $_re ]]; then
fn_name="${BASH_REMATCH[2]}"
fi
fi

if [ -n "$fn_name" ]; then
Expand All@@ -588,10 +617,12 @@ function bashunit::coverage::extract_functions() {
# Count opening braces on this line
local open_braces="${line//[^\{]/}"
local close_braces="${line//[^\}]/}"
brace_count=$((brace_count + ${#open_braces} - ${#close_braces}))
local open_count=${#open_braces}
local close_count=${#close_braces}
brace_count=$((brace_count + open_count - close_count))

# Single-line function
if [ "$brace_count" -eq 0 ] && [ "$(echo "$line" | "$GREP" -c '\{' || true)" -gt 0 ] && [ "$(echo "$line" | "$GREP" -c '\}' || true)" -gt 0 ]; then
# Single-line function: braces balance on same line and both present
if [ "$brace_count" -eq 0 ] && [ "$open_count" -gt 0 ] && [ "$close_count" -gt 0 ]; then
echo "${current_fn}:${fn_start}:${lineno}"
in_function=0
current_fn=""
Expand DownExpand Up@@ -694,11 +725,14 @@ function bashunit::coverage::report_text() {
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue
has_files=true

local executable hit pct class
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
class=$(bashunit::coverage::get_coverage_class "$pct")
local stats executable hit pct class
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"
class="${stats##*:}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand DownExpand Up@@ -772,19 +806,23 @@ function bashunit::coverage::report_lcov() {

echo "SF:$file"

local lineno=0
local line
local -a hits_by_line=()
local hit_lineno hit_count
while IFS=: read -r hit_lineno hit_count; do
[ -n "$hit_lineno" ] && hits_by_line[hit_lineno]=$hit_count
done < <(bashunit::coverage::get_all_line_hits "$file")

local lineno=0 executable=0 hit=0 line line_hits
# shellcheck disable=SC2094
while IFS= read -r line || [ -n "$line" ]; do
((++lineno))
lineno=$((lineno + 1))
bashunit::coverage::is_executable_line "$line" "$lineno" || continue
echo "DA:${lineno},$(bashunit::coverage::get_line_hits "$file" "$lineno")"
executable=$((executable + 1))
line_hits=${hits_by_line[lineno]:-0}
[ "$line_hits" -gt 0 ] && hit=$((hit + 1))
echo "DA:${lineno},${line_hits}"
done <"$file"

local executable hit
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")

echo "LF:$executable"
echo "LH:$hit"
echo "end_of_record"
Expand DownExpand Up@@ -852,10 +890,13 @@ function bashunit::coverage::report_html() {
while IFS= read -r file; do
{ [ -z "$file" ] || [ ! -f "$file" ]; } && continue

local executable hit pct
executable=$(bashunit::coverage::get_executable_lines "$file")
hit=$(bashunit::coverage::get_hit_lines "$file")
pct=$(bashunit::coverage::calculate_percentage "$hit" "$executable")
local stats executable hit pct
stats=$(bashunit::coverage::get_file_stats "$file")
executable="${stats%%:*}"
stats="${stats#*:}"
hit="${stats%%:*}"
stats="${stats#*:}"
pct="${stats%%:*}"

total_executable=$((total_executable + executable))
total_hit=$((total_hit + hit))
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/coverage_reporting_test.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,3 +250,75 @@ function test_coverage_get_hit_lines_returns_zero_when_no_data() {

assert_equals "0" "$result"
}

function test_coverage_compute_file_coverage_returns_executable_and_hit_counts() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
echo "line 3"
EOF

{
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "3:2" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_zero_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
echo "line 1"
echo "line 2"
EOF

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "2:0" "$result"

rm -f "$temp_file"
}

function test_coverage_compute_file_coverage_ignores_non_executable_hits() {
BASHUNIT_COVERAGE="true"
bashunit::coverage::init

local temp_file
temp_file=$(mktemp)
cat >"$temp_file" <<'EOF'
#!/usr/bin/env bash
# comment
echo "line 3"
EOF

{
echo "${temp_file}:1"
echo "${temp_file}:2"
echo "${temp_file}:3"
} >>"$_BASHUNIT_COVERAGE_DATA_FILE"

local result
result=$(bashunit::coverage::compute_file_coverage "$temp_file")

assert_equals "1:1" "$result"

rm -f "$temp_file"
}
Loading