Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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" + '
feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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('^' + ".*" + ' feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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('^' + ".*" + ' feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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" + ' feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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('^' + ".*" + ' feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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); } })(); })(); feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) · Issue #1019 · TypedDevs/bashunit · GitHub
Skip to content

feat(api): conditional skip helpers (skip_if, skip_unless_command, skip_on) #1019

Description

@Chemaclass

Problem

Conditional skipping is manual and easy to get wrong. bashunit::skip (src/api/skip_todo.sh:3) marks the test skipped but does not stop the test body — the author has to remember && return.

bashunit's own suite shows the cost: 32 test files repeat this shape.

# tests/unit/assert/files_test.sh:197if bashunit::check_os::is_windows;then
bashunit::skip &&returnfi
# tests/unit/util/math_test.sh:42
bashunit::skip "bc not available"

Two failure modes: forget return and the test keeps running (on a platform where it cannot pass), or forget the guard entirely and the suite is red on someone else's machine. Neither is caught by any linter.

Proposal

Three helpers, each of which marks the test skipped and returns from the caller:

bashunit::skip_if <condition-command> [reason] # skips when the command succeeds
bashunit::skip_unless <condition-command> [reason]
bashunit::skip_unless_command <cmd> [<cmd>…] # reason defaults to "requires <cmd>"
bashunit::skip_on <os> [reason] # windows | macos | linux

Usage:

functiontest_permissions() {
bashunit::skip_on windows "Git Bash fakes file permissions"
assert_file_permissions 644 "$file"
}
functiontest_math() {
bashunit::skip_unless_command bc
assert_equals 4 "$(calc 2+2)"
}

The "returns from the caller" part is the whole point and is the tricky bit in Bash 3.0 — a function cannot return on behalf of its caller. Look at how bashunit::runner::execute_test_hook (src/runner/hooks.sh:200) already solves early-exit with a FUNCNAME-guarded trap; reuse that mechanism rather than inventing a second one. If a trap-based approach is rejected, the fallback is to keep && return at the call site but have the helpers return a status that makes the idiom unambiguous — document whichever is chosen.

src/system/check_os.sh already provides is_windows / is_macos / is_linux for skip_on.

Acceptance criteria

  • bashunit::skip_if true "reason" marks the test skipped and the rest of the body does not run
  • bashunit::skip_if false does not skip and the body runs to completion
  • bashunit::skip_unless_command definitely_not_a_command skips with reason requires definitely_not_a_command
  • bashunit::skip_unless_command bash does not skip
  • bashunit::skip_on windows skips only on Windows; macos, linux likewise
  • An unknown OS name is a usage error, not a silent no-skip
  • The reason appears in the console output and in the reports, like today's bashunit::skip
  • Skipped counters increment exactly once
  • Works inside a data-provider test and under --parallel
  • Existing bashunit::skip / bashunit::todo behaviour is unchanged
  • At least a few of the 32 boilerplate sites in tests/ are migrated in the same PR to prove the ergonomics
  • Documented in docs/skipping-incomplete.md and docs/globals.md

Repo checklist (agent)

  • TDD: RED → GREEN → REFACTOR. Write the failing test first.
  • Bash 3.0+ only: no printf -v, no += append, no declare -A, no [[ ]], no ${var,,}, no &>>, no ${arr[-1]}. Expanding a possibly-empty array under set -u needs ${arr[@]+"${arr[@]}"}.
  • A new CLI flag must be wired in all of these or a parity test fails:
  • Gates: make sa, make lint, ./bashunit tests/, ./bashunit --parallel tests/. Never run shfmt -w.
  • Docs: update docs/command-line.md. Editing docs/assertions.md invalidates the bashunit doc acceptance snapshot — regenerate it.
  • CHANGELOG.md: add one line under ## Unreleased.
  • Fixtures under tests/acceptance/fixtures/ must not end in *test.sh.
  • One issue = one PR.

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