Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
- The `--parallel` unsupported-OS warning no longer claims Alpine is excluded: Alpine has been a supported parallel platform since the race conditions were fixed, the message was simply never updated

### Fixed
- The numeric options (`--jobs`, `--retry`, `--test-timeout`, `--coverage-min`) and `--output` now reject an invalid value with a clear error and a non-zero exit, instead of dropping the setting. `--jobs abc` was the worst case: `[ n -lt abc ]` errors rather than returning false, so the Bash 3.x job-slot poll never reached its `break` and the run **hung**, while Bash 4.3+ silently ignored the concurrency limit. `--coverage-min abc` leaked a raw `[: abc: integer expression expected` and still exited `0`, so a CI job never enforced its threshold. Validation runs on the resolved configuration, so it covers the `BASHUNIT_*` environment variables too (#873)
- An unknown option is now rejected with a clear error and a non-zero exit instead of being silently filed under test paths. A mistyped flag used to degrade the run while still reporting success: `bashunit --parralel tests/` ran sequentially and exited `0`, and `bashunit --filterr foo tests/` swallowed both the flag and its value and ran the whole suite. Applies to `test` and `bench`; the `assert` subcommand parses its own arguments and is unchanged (#871)
- The quickstart's sample output showed durations as `16 ms` / `90 ms`; bashunit prints `16ms` / `90ms`
- `.env.example` documented `BASHUNIT_SHOW_EXECUTION_TIME` as defaulting to `true`; the actual default has been `auto` since #765
Expand Down
50 changes: 50 additions & 0 deletions src/main.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,54 @@ function bashunit::main::abort_unknown_option() {
exit 1
}

##
# Exits non-zero unless the value is a non-negative integer.
# Arguments: $1 - value, $2 - the setting name to quote in the error
##
function bashunit::main::require_non_negative_int_or_exit() {
case "$1" in
'' | *[!0-9]*)
printf "%sError: %s must be a non-negative integer, got '%s'.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "$2" "$1" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates the resolved configuration and exits non-zero on a bad value.
# Runs after flag parsing so it covers both the flags and the BASHUNIT_* env
# vars, which bypass the parser entirely. The numeric settings are compared with
# `[ -lt ]`, which errors instead of returning false on a non-integer operand: the
# job-slot poll looped forever and the rest silently dropped the setting (#873).
##
function bashunit::main::validate_config_or_exit() {
if [ "${BASHUNIT_PARALLEL_JOBS:-0}" != "0" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_PARALLEL_JOBS}" "BASHUNIT_PARALLEL_JOBS (--jobs)"
fi
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_RETRY:-0}" "BASHUNIT_RETRY (--retry)"
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_TEST_TIMEOUT:-0}" "BASHUNIT_TEST_TIMEOUT (--test-timeout)"
# Empty is the documented "no minimum" default, so only a set value is checked.
if [ -n "${BASHUNIT_COVERAGE_MIN:-}" ]; then
bashunit::main::require_non_negative_int_or_exit \
"${BASHUNIT_COVERAGE_MIN}" "BASHUNIT_COVERAGE_MIN (--coverage-min)"
fi

# Only TAP is implemented; an unrecognised name used to fall back to the
# default renderer without a word, so `--output tpa` looked like it worked.
case "${BASHUNIT_OUTPUT_FORMAT:-}" in
'' | tap) ;;
*)
printf "%sError: unsupported output format '%s' for --output. Supported: tap.%s\n" \
"${_BASHUNIT_COLOR_FAILED}" "${BASHUNIT_OUTPUT_FORMAT}" "${_BASHUNIT_COLOR_DEFAULT}" >&2
exit 1
;;
esac
}

##
# Validates a `--shard <index>/<total>` spec and exports the parts, or prints an
# error and exits non-zero. Requires numeric index/total with 1 <= index <= total.
Expand DownExpand Up@@ -354,6 +402,8 @@ function bashunit::main::cmd_test() {
shift
done

bashunit::main::validate_config_or_exit

# Auto-enable coverage when any coverage output option is specified
if [ "$_bashunit_coverage_opt_set" = true ]; then
# shellcheck disable=SC2034
Expand Down
100 changes: 100 additions & 0 deletions tests/acceptance/bashunit_invalid_option_value_test.sh
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
#!/usr/bin/env bash
set -euo pipefail

function set_up_before_script() {
TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
TEST_FILE="tests/acceptance/fixtures/tests_path/a_test.sh"
}

# The numeric options used to accept any string. `[ n -lt abc ]` errors rather
# than returning false, so the value was either ignored or -- on the Bash 3.x
# job-slot poll -- looped forever (#873).
function test_bashunit_fails_when_jobs_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--jobs" "$output"
}

function test_bashunit_fails_when_jobs_is_negative() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs -5 "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
}

function test_bashunit_fails_when_retry_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --retry abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--retry" "$output"
}

function test_bashunit_fails_when_test_timeout_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --test-timeout abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--test-timeout" "$output"
}

function test_bashunit_fails_when_coverage_min_is_not_a_number() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --coverage-min abc "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--coverage-min" "$output"
}

function test_bashunit_fails_when_output_format_is_unsupported() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output nonsense "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "--output" "$output"
}

# The environment path bypasses flag parsing entirely, so it needs the same gate.
function test_bashunit_fails_when_parallel_jobs_env_var_is_not_a_number() {
local ec=0
local output
output=$(BASHUNIT_PARALLEL_JOBS=abc ./bashunit --env "$TEST_ENV_FILE" --parallel "$TEST_FILE" 2>&1) || ec=$?

assert_general_error "" "" "$ec"
assert_contains "BASHUNIT_PARALLEL_JOBS" "$output"
}

function test_bashunit_still_accepts_valid_option_values() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs 2 --retry 0 --test-timeout 0 "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_jobs_auto() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --jobs auto "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "All tests passed" "$output"
}

function test_bashunit_still_accepts_tap_output() {
local ec=0
local output
output=$(./bashunit --env "$TEST_ENV_FILE" --output tap "$TEST_FILE" 2>&1) || ec=$?

assert_successful_code "" "" "$ec"
assert_contains "TAP version 13" "$output"
}
Loading