Skip to content

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor(runner): split src/runner.sh into a src/runner/ module · Issue #924 · TypedDevs/bashunit · GitHub
Skip to content

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(runner): split src/runner.sh into a src/runner/ module #924

Description

@Chemaclass

Summary

src/runner.sh is 2145 lines and 57 functions covering five distinct
responsibilities (.claude/rules/architecture-map.md:51 already names them: "file
loop, per-test execution, retry/timeout, result parsing, failure context"). Split it
into a src/runner/ module behind a thin aggregator, following the existing
src/assertions.shsrc/assert_*.sh pattern.

Blocked by #923 — path-keyed embed markers must land first, or
src/runner/parallel.sh collides with src/parallel.sh and breaks
test_built_binary_embeds_each_src_file_exactly_once.

This is a pure move

The namespace stays bashunit::runner::*. No function is renamed, no call site
changes.
Every hunk should be a verbatim relocation. If a behavior fix looks
necessary along the way, open a separate issue for it — do not fold it in, or the
diff stops being reviewable.

bashunit:90 keeps its single source "$BASHUNIT_ROOT_DIR/src/runner.sh".
src/runner.sh becomes an aggregator holding only source lines and comments
(required — see the aggregator rule in #923).

Target layout

file~linesfunctions
src/runner.sh14aggregator only
src/runner/context.sh145restore_workdir, sync_coverage_flag, export_test_identity, resolve_test_location, apply_interpolated_title, source_login_shell_profiles, needs_test_duration, _supports_reliable_pipefail
src/runner/payload.sh215the 13 _BASHUNIT_RUNNER_*_OUT slot globals + extract_encoded_field, compute_total_assertions, extract_subshell_type, format_subshell_output, decode_subshell_output, extract_result_counts, is_simple_progress_output, line_exists_in_output, extract_assertion_runtime_output
src/runner/diagnostics.sh135detect_runtime_error, classify_kill_signal, halt_if_stop_on_failure, record_profile, print_verbose_test_summary, render_running_file_header
src/runner/result.sh215parse_result{,_sync,_parallel}, get_failure_source_context, write_{failure,skipped,incomplete,risky}_result_output
src/runner/parallel.sh90_supports_wait_n, _count_running_jobs, wait_for_job_slot, spinner
src/runner/hooks.sh380run_set_up{,_before_script}, run_tear_down{,_after_script}, execute_{file,test}_hook, record_{file,test}_hook_failure, clear_mocks, clean_script_test_functions, clean_set_up_and_tear_down_after_script, cleanup_on_exit
src/runner/provider.sh120parse_data_provider_args
src/runner/exec.sh450run_test, execute_test_body, run_with_timeout, build_timeout_result, call_test_functions
src/runner/discovery.sh280load_test_files, functions_for_script
src/runner/bench.sh100load_bench_files, call_bench_functions

The dependency layering is acyclic — 53 of 57 functions are leaves; only
load_test_files, load_bench_files, run_test and parse_result have callees:

context · payload · diagnostics → parallel · hooks · result → provider · exec → discovery · bench

src/runner/parallel.sh deliberately shares a basename with src/parallel.sh; that
is the case #923 makes safe.

Tests: keep them flat

Do not create tests/unit/runner/.make test globs
$(wildcard $(TEST_SCRIPTS_DIR)/*/*[tT]est.sh) — one level only (152 files vs 156
recursive). Anything at tests/unit/runner/payload_test.sh is silently skipped
by make test, which CI runs (.github/workflows/tests.yml:29, :90). Deepening
the glob is not an option either: the 4 extra recursive matches are deliberately
excluded fixtures (tests/unit/fixtures/tests/example1_test.sh and friends).

So split tests/unit/runner_test.sh (430 lines) into flat
tests/unit/runner_<area>_test.sh files mirroring the src modules — the same
convention coverage_*_test.sh already uses (9 files).

Watch out for

  • File-scoped ShellCheck directive.src/runner.sh:2 is
    # shellcheck disable=SC2155, which currently covers the whole file. Carry it
    only to the new files that actually need it, or narrow it to specific lines.
    Do not blanket-apply it to all ten.
  • Return-slot globals now cross files.src/runner/payload.sh declares the 13
    _BASHUNIT_RUNNER_*_OUT slots; src/runner/exec.sh reads them. Expect SC2034 /
    SC2154 noise and resolve it the way src/state.sh:16-17 already does (a scoped
    disable with a comment naming the reader), not with a blanket file-level disable.
  • First line must be the shebang.build.sh's tail -n +2 strips line 1 of
    every embedded file.
  • jobs -pr must stay in the dispatcher shell.wait_for_job_slot and
    _count_running_jobs depend on running in the shell that spawned the workers.
    Moving them to another file is fine; wrapping them in a subshell is not.
  • _BASHUNIT_RUNNER_RESULT_ORDINAL is read outside the runner
    src/coverage.sh:224. It stays a plain global; do not scope it.
  • No new forks..claude/rules/perf-fork-budget.md budgets are enforced by
    tests/acceptance/bashunit_{coldstart,run}_forks_test.sh on three platforms.
    A file split adds no forks (parse time dominates cold start, file opens don't) —
    keep it that way.

Docs to update

  • .claude/rules/architecture-map.md:51 — the single runner.sh row becomes the
    module table
  • .claude/rules/architecture-map.md:17 — the call-flow annotation (runner.sh: the per-file loop)src/runner/discovery.sh
  • .claude/rules/bash-style.md:121 — the return-slot example points at
    src/runner.sh; retarget to src/runner/payload.sh
  • New adrs/adr-010-*.md using adrs/TEMPLATE.md: why the module split, why the
    aggregator pattern, why tests stay flat

Acceptance criteria

  • git diff shows only relocations — no renamed functions, no changed logic
  • bashunit:90 still sources exactly one runner file
  • src/runner.sh contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Fork-budget acceptance tests green
  • tests/unit/runner_test.sh split into flat per-area files, all picked up by
    make test/list
  • Bash 3.0+ compatible
  • No CHANGELOG entry — internal, no user-visible behavior change
  • ADR added

Do not

  • Do not rename any function or change any behavior
  • Do not create tests/unit/runner/ (see above)
  • Do not touch src/coverage.sh — separate issue
  • Do not run shfmt -w; make lint is the format gate

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions