Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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" + '
build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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('^' + ".*" + ' build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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('^' + ".*" + ' build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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" + ' build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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('^' + ".*" + ' build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

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); } })(); })(); build: harden build.sh (verify gate, fail-fast, derived deps list) · Issue #834 · TypedDevs/bashunit · GitHub
Skip to content

build: harden build.sh (verify gate, fail-fast, derived deps list) #834

Description

@Chemaclass

Context

Audit of build.sh (2026-07-19) found one real CI gate hole, one silent-corruption path, and several latent traps. Build speed is a non-issue (full build: 0.32s; verification suite dominates). All findings below were verified by experiment, not just code reading.

Findings

1. --verify does not gate the build (CI hole) — build.sh:24-35

BASHUNIT_BUILD_DIR="$out_dir""$out" tests ... --stop-on-failure
# shellcheck disable=SC2181if [[ $?-eq 0 ]];thenecho"✅ Build verified ✅"fi

The if has no else and no exit. A failing suite (inner exit code 1, verified with a forced failing test) still lets build.sh exit 0. .github/workflows/build.yml:27 runs ./build.sh --verify and relies on that exit code — the workflow goes green on a broken artifact.

Fix: fail the script when the run fails:

if! BASHUNIT_BUILD_DIR="$out_dir""$out" tests --simple --parallel \
--log-junit "$out_dir/log-junit.xml" --report-html "$out_dir/report.html" \
--stop-on-failure;thenecho"❌ Build verification failed"exit 1
fi

2. build::embed_docs corrupts the artifact silently on a missing marker — build.sh:126-149

If # __BASHUNIT_EMBEDDED_DOCS_START__ is ever absent from the generated file, line_num is empty, $((line_num - 1)) becomes -1, BSD head -n -1 errors, and a partial temp_file is still mv'd over the artifact. There is no set -euo pipefail anywhere in build.sh.

Fix: add set -euo pipefail at the top of build.sh, and guard the marker lookup (error + exit 1 when either marker is missing).

3. grep -v '^source' over-strips — build.sh:50

Strips any column-0 line starting with source, which would also eat a future source_dir=... variable line. Fix: anchor as grep -v '^source ' (trailing space). Note: indented runtime sourcing (e.g. src/main.sh:150 bootstrap) must keep surviving — it does today because it is indented; do not "fix" that.

4. No dedup guard in build::process_file recursion — build.sh:59-89

The source graph is a tree today (verified: 28 embedded files, zero duplicates), but one added cross-source between src files would silently embed a file twice (duplicate function defs + double top-level execution). Fix: track visited files in the recursion and skip already-processed ones.

5. eval echo "$sourced_file"build.sh:76

eval on grep'd file content to expand $BASHUNIT_ROOT_DIR. Works, but it is an eval-on-text footgun (word splitting, globbing, command execution on unexpected content). Fix: plain parameter substitution:

sourced_file="${sourced_file/\$BASHUNIT_ROOT_DIR/$BASHUNIT_ROOT_DIR}"

6. No post-build syntax gate

bash -n "$out" is free (<50ms) and catches artifact corruption (e.g. finding 2) instantly, before the expensive verify suite. Fix: run it in build::generate_bin right after build::embed_docs, exit 1 on failure.

7. Hardcoded deps array duplicates the entrypoint — build.sh:91-124

build::dependencies hand-lists 27 files in an order that duplicates the source order already present in the bashunit entrypoint (lines 57-84). tests/unit/build_test.sh (test_build_bundles_every_src_file_sourced_by_entrypoint) exists solely to police that sync, and forgetting the manual step is a recurring gotcha. Fix: derive the list by parsing the entrypoint's ^source lines (skip src/dev/ — dev-only, intentionally excluded from the artifact), preserving order. The sync test can then be simplified to assert derivation instead of policing a manual list.

8. Fixed temp.sh name — build.sh:40

Concurrent builds into the same out dir clobber each other's temp file. Fix: unique suffix (temp.$$.sh) — minor, do last.

Acceptance criteria

  • ./build.sh --verify exits non-zero when the built binary fails the test suite (add a unit/acceptance test that simulates a failing verify run, or test the gate function in isolation)
  • build.sh runs under set -euo pipefail; missing embed markers abort with a clear error and non-zero exit
  • bash -n gate runs on every build; corrupt artifact aborts before verify
  • build::process_file skips already-embedded files (regression test: artifact contains each # <file>.sh marker exactly once)
  • No eval in build.sh
  • Deps list derived from the bashunit entrypoint; src/dev/* excluded; embed order unchanged (byte-identical artifact vs current build, except intentional changes)
  • Built artifact verified: ./build.sh --verify green, bin/bashunit doc equals output hash unchanged (8e93990bbb22cf48c0b4a4fdb9308243015cdcf9)

Constraints

  • build.sh itself runs only in dev/CI, so Bash 4+ is tolerated there today — but keep it Bash 3.2-clean anyway (macOS default bash runs it locally); no declare -A, prefer [ ] in new code where practical
  • Portable across macOS (BSD head/sed) and Linux; CI also builds on Windows (checksum step skips there — keep that)
  • Do not change what gets embedded: src/dev/debug.sh (bashunit::dump/bashunit::dd) stays dev-only
  • TDD: each fix lands with its failing test first where testable (gate, dedup, marker guard, derivation)

Verification

./build.sh --verify # must gate
bash -n bin/bashunit # clean
bin/bashunit doc equals | shasum # 8e93990bbb22cf48c0b4a4fdb9308243015cdcf9
./bashunit tests/ && ./bashunit --parallel --simple --strict tests/
make sa && make lint

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions