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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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" + '
refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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('^' + ".*" + ' refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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('^' + ".*" + ' refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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" + ' refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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('^' + ".*" + ' refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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('^' + ".*" + ' refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
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); } })(); })(); refactor(state): move progress rendering into console_results by Chemaclass · Pull Request #893 · 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,9 @@
- The docs sidebar outline now lists `h3` headings as well as `h2` — per-flag and per-pattern detail (27 headings on Command line, 24 on Common patterns, 23 on Coverage) was hidden from the "On this page" navigation
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Changed
- Progress rendering moved out of `state.sh` into `console_results.sh`: `bashunit::state::print_line` and `bashunit::state::print_tap_line` are now `bashunit::console_results::print_line` / `::print_tap_line`. Rendering from the module that owns counters and the per-test payload was a layering inversion, and it was the sole remaining reason for the `state.sh → parallel.sh` call cycle that #862 broke. `state.sh` now makes no call into the renderer, parallel, or the runner, pinned by a grep-based guard so the edge cannot return through an uncovered path. These two functions were never documented API — `docs/custom-asserts.md` points custom assertions at `bashunit::assertion_passed` / `state::add_assertions_passed`, and the documented `bashunit::print_line` is an unrelated separator helper in `globals.sh` — so no alias is kept: one in `state.sh` would have recreated the very cycle this removes (#868)

### Removed
- `bin/create-pr`, a 476-line vendored copy of [Chemaclass/create-pr](https://github.com/Chemaclass/create-pr) v0.10. Nothing referenced it — not the `Makefile` targets, the workflows, or the docs, which link the upstream project rather than this copy — and having no `.sh` extension it escaped `make sa` until #863, so it sat in the tree written in a Bash 4 style the project's own rules prohibit. Use the upstream tool (#867)

Expand Down
2 changes: 1 addition & 1 deletion src/benchmark.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,7 @@ function bashunit::benchmark::run_function() {
if bashunit::env::is_bench_mode_enabled; then
local label="$(bashunit::helper::normalize_test_function_name "$fn_name")"
local line="$label [$i/$its] ${dur_ms} ms"
bashunit::state::print_line "successful" "$line"
bashunit::console_results::print_line "successful" "$line"
fi
done

Expand Down
137 changes: 128 additions & 9 deletions src/console_results.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,7 +254,7 @@ function bashunit::console_results::print_successful_test() {
full_line="$(bashunit::str::rpad "$line" "$_BASHUNIT_CONSOLE_DURATION_OUT")"
fi

bashunit::state::print_line "successful" "$full_line"
bashunit::console_results::print_line "successful" "$full_line"
}

##
Expand DownExpand Up@@ -284,7 +284,7 @@ ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failure" "$line"
bashunit::console_results::print_line "failure" "$line"
}

##
Expand DownExpand Up@@ -381,7 +381,7 @@ $(bashunit::console_results::render_diff "$_expected_file" "$_actual_file")"

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "failed" "$line"
bashunit::console_results::print_line "failed" "$line"
}

function bashunit::console_results::print_failed_snapshot_test() {
Expand All@@ -404,7 +404,7 @@ function bashunit::console_results::print_failed_snapshot_test() {
"$(cat "$snapshot_file")" "$actual_content")"
fi

bashunit::state::print_line "failed_snapshot" "$line"
bashunit::console_results::print_line "failed_snapshot" "$line"
}

##
Expand DownExpand Up@@ -489,7 +489,7 @@ function bashunit::console_results::print_skipped_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${reason}")"
fi

bashunit::state::print_line "skipped" "$line"
bashunit::console_results::print_line "skipped" "$line"
}

function bashunit::console_results::print_incomplete_test() {
Expand All@@ -503,7 +503,7 @@ function bashunit::console_results::print_incomplete_test() {
line="$line$(printf "${_BASHUNIT_COLOR_FAINT} %s${_BASHUNIT_COLOR_DEFAULT}\n" "${pending}")"
fi

bashunit::state::print_line "incomplete" "$line"
bashunit::console_results::print_line "incomplete" "$line"
}

function bashunit::console_results::print_snapshot_test() {
Expand All@@ -514,7 +514,7 @@ function bashunit::console_results::print_snapshot_test() {
local line
line="$(printf "${_BASHUNIT_COLOR_SNAPSHOT}✎ Snapshot${_BASHUNIT_COLOR_DEFAULT}: %s\n" "${test_name}")"

bashunit::state::print_line "snapshot" "$line"
bashunit::console_results::print_line "snapshot" "$line"
}

function bashunit::console_results::print_risky_test() {
Expand All@@ -531,7 +531,7 @@ function bashunit::console_results::print_risky_test() {
full_line="$(bashunit::str::rpad "$line" "$time_display")"
fi

bashunit::state::print_line "risky" "$full_line"
bashunit::console_results::print_line "risky" "$full_line"
}

function bashunit::console_results::print_error_test() {
Expand All@@ -556,7 +556,7 @@ function bashunit::console_results::print_error_test() {

line="$line$(bashunit::console_results::test_location_suffix)"

bashunit::state::print_line "error" "$line"
bashunit::console_results::print_line "error" "$line"
}

##
Expand DownExpand Up@@ -676,3 +676,122 @@ function bashunit::console_results::print_risky_tests_and_reset() {
"$(bashunit::state::get_tests_risky)" "risky test" "risky tests"
fi
}

##
# Emit one progress entry for a finished test, in whichever output mode is
# active (verbose line, --simple char, or TAP).
#
# Lived in state.sh until #868. Rendering from the counter module was a layering
# inversion, and it was the sole reason for the state -> parallel call cycle that
# #862 broke; keep it here so state.sh owns counters and the payload only.
# Arguments: $1 - test type, $2 - already formatted line
##
function bashunit::console_results::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::console_results::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::console_results::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
2 changes: 1 addition & 1 deletion src/runner.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -1281,7 +1281,7 @@ function bashunit::runner::run_test() {
bashunit::runner::format_subshell_output "$subshell_output"
subshell_output=$_BASHUNIT_RUNNER_OUTPUT_OUT
if ! bashunit::env::is_failures_only_enabled; then
bashunit::state::print_line "$type" "$subshell_output"
bashunit::console_results::print_line "$type" "$subshell_output"
fi
fi

Expand Down
109 changes: 0 additions & 109 deletions src/state.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -396,112 +396,3 @@ function bashunit::state::aggregate_parallel_results() {
"snapshot:$total_snapshot"
}

function bashunit::state::print_line() {
# shellcheck disable=SC2034
local type=$1
local line=$2

((_BASHUNIT_TOTAL_TESTS_COUNT++)) || true

bashunit::state::add_test_output "[$type]$line"

if bashunit::env::is_no_progress_enabled; then
return
fi

if bashunit::env::is_tap_output_enabled; then
bashunit::state::print_tap_line "$type" "$line"
return
fi

if ! bashunit::env::is_simple_output_enabled; then
printf "%s\n" "$line"
return
fi

local char
case "$type" in
successful) char="." ;;
failure) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
failed_snapshot) char="${_BASHUNIT_COLOR_FAILED}F${_BASHUNIT_COLOR_DEFAULT}" ;;
skipped) char="${_BASHUNIT_COLOR_SKIPPED}S${_BASHUNIT_COLOR_DEFAULT}" ;;
incomplete) char="${_BASHUNIT_COLOR_INCOMPLETE}I${_BASHUNIT_COLOR_DEFAULT}" ;;
snapshot) char="${_BASHUNIT_COLOR_SNAPSHOT}N${_BASHUNIT_COLOR_DEFAULT}" ;;
risky) char="${_BASHUNIT_COLOR_RISKY}R${_BASHUNIT_COLOR_DEFAULT}" ;;
error) char="${_BASHUNIT_COLOR_FAILED}E${_BASHUNIT_COLOR_DEFAULT}" ;;
*) char="?" && bashunit::log "warning" "unknown test type '$type'" ;;
esac

if bashunit::parallel::is_enabled; then
printf "%s" "$char"
else
if ((_BASHUNIT_TOTAL_TESTS_COUNT % 50 == 0)); then
printf "%s\n" "$char"
else
printf "%s" "$char"
fi
fi
}

function bashunit::state::print_tap_line() {
local type=$1
local line=$2

local clean_line
clean_line=$(printf "%s" "$line" | sed 's/\x1B\[[0-9;]*[mK]//g')
local test_name="${clean_line#*: }"
test_name="${test_name%%$'\n'*}"
# Strip trailing whitespace and duration
test_name=$(printf "%s" "$test_name" | \
sed 's/[[:space:]]*[0-9][0-9]*m\{0,1\}[[:space:]]*[0-9.]*[ms]*[[:space:]]*$//')

case "$type" in
successful)
printf "ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
failure | failed | failed_snapshot | error)
printf "not ok %d - %s\n" "$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
local detail_line
printf " ---\n"
while IFS= read -r detail_line; do
detail_line=$(printf "%s" "$detail_line" | sed 's/\x1B\[[0-9;]*[mK]//g')
if [ -n "$detail_line" ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Failed:" || true)" -eq 0 ] \
&& [ "$(echo "$detail_line" | "$GREP" -cF "Error:" || true)" -eq 0 ]; then
local trimmed="${detail_line#"${detail_line%%[![:space:]]*}"}"
printf " %s\n" "$trimmed"
fi
done <<< "$clean_line"
printf " ...\n"
;;
skipped)
local skip_name="${test_name%% *}"
local skip_reason="${test_name#"$skip_name"}"
skip_reason="${skip_reason#"${skip_reason%%[![:space:]]*}"}"
if [ -n "$skip_reason" ]; then
printf "ok %d - %s # SKIP %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$skip_name" "$skip_reason"
else
printf "ok %d - %s # SKIP\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
fi
;;
incomplete)
printf "ok %d - %s # TODO incomplete\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
snapshot)
printf "ok %d - %s # snapshot\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
risky)
printf "ok %d - %s # RISKY no assertions\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
*)
printf "not ok %d - %s\n" \
"$_BASHUNIT_TOTAL_TESTS_COUNT" "$test_name"
;;
esac
}
Loading
Loading