Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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" + '
fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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('^' + ".*" + ' fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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('^' + ".*" + ' fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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" + ' fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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('^' + ".*" + ' fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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('^' + ".*" + ' fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring 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); } })(); })(); fix(build): key embed markers on repo-relative paths so src/ can hold module dirs · Issue #923 · TypedDevs/bashunit · GitHub
Skip to content

fix(build): key embed markers on repo-relative paths so src/ can hold module dirs #923

Description

@Chemaclass

Summary

build.sh labels every embedded file with # <basename>. That label is both the
dedupe key and the only thing test_built_binary_embeds_each_src_file_exactly_once
inspects. Keying on a basename hides a real double-embed bug and blocks any
subdirectory under src/.

Fix: key the dedupe and the marker on a repo-relative path. This is a
prerequisite for splitting large src/ files into module directories
(src/runner/, src/coverage/), but it stands on its own as a bug fix.

Current behavior

Two defects, both reproduced on main (94933c0).

1. The dedupe key is relative from the top-level loop and absolute from the recursion.

build::dependencies yields src/state.sh; build::process_file's recursion
yields /abs/path/src/state.sh (build.sh:92 expands $BASHUNIT_ROOT_DIR). The
case at build.sh:73-75 compares those as strings, so they never match. Add one
cross-module source and the file is bundled twice:

mkdir -p src/runner
printf'#!/usr/bin/env bash\nsource "$BASHUNIT_ROOT_DIR/src/state.sh"\n\nfunction bashunit::runner::_x() { :; }\n'> src/runner/exec.sh
# add: source "$BASHUNIT_ROOT_DIR/src/runner/exec.sh" to src/runner.sh
bash build.sh bin
grep -c '^# state\.sh$' bin/bashunit # => 2
grep -c '^function bashunit::state::reset_test_title()' bin/bashunit # => 2
grep -oE '^function bashunit::[a-zA-Z_:]+\(\)' bin/bashunit | sort | uniq -d | wc -l # => 42

42 framework functions defined twice in the distributable. build.sh:10-12 already
warns about exactly this hazard ("one added cross-source would otherwise silently
bundle a file twice") — the guard is just ineffective for the absolute form.

2. A basename marker false-positives across directories.

src/parallel.sh and src/runner/parallel.sh both emit # parallel.sh, so
test_built_binary_embeds_each_src_file_exactly_once reports a duplicate for two
genuinely different files.

3. Relative source joins accumulate /. segments.

build.sh:97 does "$(dirname "$file")/$sourced_file" without stripping a leading
./, so each recursion level appends another /.: $dir/././common.sh. The same
file can therefore reach the dedupe under two spellings. Latent today; only masked
because the marker is a basename.

Expected behavior

  • A file sourced from more than one place is embedded exactly once, regardless of
    whether the path arrives relative or absolute.
  • Two files with the same basename in different directories are embedded as two
    distinct entries with distinct markers.
  • The built artifact defines every bashunit::* function exactly once.

Scope

build.sh

  1. In build::process_file, derive local marker="${file#"$BASHUNIT_ROOT_DIR"/}"
    and use it for both the case dedupe key and the emitted comment
    (echo "# $marker"). Leave $file itself untouched — tail -n +2 "$file" and
    dirname "$file" must keep working on whichever form the caller passed (the
    top-level loop's relative paths already require cwd = repo root).
  2. In the relative-path join, strip a leading ./:
    sourced_file="$(dirname "$file")/${sourced_file#./}".
  3. Update the stale _BUILD_EMBEDDED_FILES comment at build.sh:10-12 — the source
    graph is no longer described as "a tree today".

tests/unit/build_test.sh

  1. New test (this is the RED test — write it first). Assert the artifact defines
    no bashunit::* function twice:

    duplicated=$(grep -oE '^function bashunit::[a-zA-Z_:]+\(\)'"$build_dir/bashunit"| sort | uniq -d)
    assert_empty "$duplicated"

    Verified to fail with 42 entries on current main once a cross-module source
    exists, and to pass after the fix. Restrict the pattern to bashunit:: — an
    unnamespaced ^function pattern also matches the example code inside the
    embedded docs/assertions.md heredoc and reports 19 false positives on a clean
    main build.

  2. Line 135 regex → ^# src/[a-z_0-9/]+\.sh$. Without this the existing duplicate
    guard still passes but matches zero lines — silently vacuous once markers
    become paths.

  3. Line 103 → assert_equals "1" "$(grep -cFx "# $dir/common.sh" "$dir/out.tmp")".
    test_build_process_file_embeds_a_file_only_once feeds absolute temp paths
    outside the repo root, so its marker is the full path, not common.sh.

  4. Add a regression test for the basename collision: a fixture module file whose
    basename matches an existing top-level src/*.sh, asserting both are embedded
    with distinct markers. Without this, nothing stops the collision from
    reappearing.

No change needed

build::dependencies stays as-is — it reads only bashunit's own source lines,
so it remains the single source of truth and module children arrive via recursion.
test_build_bundles_{every,only}_src_file_sourced_by_entrypoint keep passing
untouched: they compare that list against itself, and nested files appear on
neither side.

Acceptance criteria

  • The new duplicate-bashunit::*-function test fails before the build.sh fix
    and passes after it
  • A cross-module source embeds the target file exactly once
  • Two same-basename files in different src/ dirs get distinct markers
  • ./bashunit tests/ green
  • ./bashunit --parallel tests/ green
  • make sa && make lint green
  • bash build.sh bin -v prints ✅ Build verified ✅
  • Bash 3.0+ compatible (${var#prefix} only; no printf -v, no [[, no +=)
  • No CHANGELOG entry — internal, no user-visible behavior change

Verification: artifact order must not change

The artifact must place files in the exact order bash sources them at runtime.
build::process_file emits a file's body and then recurses, which equals runtime
order provided an aggregator holds only source lines and comments. Confirmed
against a 3-module prototype (cross-module sources, two deliberately colliding
basenames): an independent DFS over the source graph matched the artifact's marker
order exactly, 46/46 files. src/assertions.sh already satisfies the aggregator
rule (zero non-comment, non-source top-level lines).

Worth stating in .claude/rules/architecture-map.md as part of this PR, since the
follow-up module splits depend on it:

A module aggregator (src/<module>.sh) contains only source lines and
comments. Anything else at top level would make the built artifact's execution
order diverge from dev-mode source order.

Also note for anyone adding files: tail -n +2 strips line 1, so every new src
file's first line must be the shebang
.

Do not

References

  • build.sh:10-12 (stale tree comment), :70-84 (marker + dedupe), :91-101 (path join)
  • tests/unit/build_test.sh:92-104, :128-138
  • Existing nested-src precedent: src/dev/debug.sh, excluded from the build at build.sh:113

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingrefactoringRefactoring or cleaning related

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions