fix(compat): use glob pattern instead of regex for code fence

Chemaclass · Chemaclass · commit f77aa5f9026f · 2026-02-11T14:44:14.000+01:00
Replace regex matching with glob pattern matching for code fence
detection to avoid backtick escaping issues in Bash 3.0.

Changed from: [[ "$line" =~ ^\`\`\` ]]
To: [[ "$line" == '```'* ]]

This is more reliable across all Bash versions.
diff --git a/src/console_header.sh b/src/console_header.sh
@@ -11,7 +11,8 @@ function bashunit::console_header::print_version_with_env() {
         bashunit::console_header::print_version "$filter" "$@"
 
         if bashunit::env::is_dev_mode_enabled; then
-                printf "%sDev log:%s %s\n" "${_BASHUNIT_COLOR_INCOMPLETE}" "${_BASHUNIT_COLOR_DEFAULT}" "$BASHUNIT_DEV_LOG"
+                printf "%sDev log:%s %s\n" \
+                        "${_BASHUNIT_COLOR_INCOMPLETE}" "${_BASHUNIT_COLOR_DEFAULT}" "$BASHUNIT_DEV_LOG"
         fi
 }
 
@@ -51,9 +52,9 @@ EOF
                 printf "%s%sbashunit%s - %s\n" \
                         "$_BASHUNIT_COLOR_BOLD" "$_BASHUNIT_COLOR_PASSED" "$_BASHUNIT_COLOR_DEFAULT" "$BASHUNIT_VERSION"
         else
-                printf "${_BASHUNIT_COLOR_BOLD}${_BASHUNIT_COLOR_PASSED}bashunit${_BASHUNIT_COLOR_DEFAULT} - %s | Tests: %s\n" \
-                        "$BASHUNIT_VERSION" \
-                        "$total_tests"
+                printf "%s%sbashunit%s - %s | Tests: %s\n" \
+                        "${_BASHUNIT_COLOR_BOLD}" "${_BASHUNIT_COLOR_PASSED}" "${_BASHUNIT_COLOR_DEFAULT}" \
+                        "$BASHUNIT_VERSION" "$total_tests"
         fi
 }
 
diff --git a/src/console_results.sh b/src/console_results.sh
@@ -241,7 +241,8 @@ function bashunit::console_results::print_failure_message() {
   local line
   line="$(printf "\
 ${_BASHUNIT_COLOR_FAILED}✗ Failed${_BASHUNIT_COLOR_DEFAULT}: %s
-    ${_BASHUNIT_COLOR_FAINT}Message:${_BASHUNIT_COLOR_DEFAULT} ${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \
+    ${_BASHUNIT_COLOR_FAINT}Message:${_BASHUNIT_COLOR_DEFAULT} \
+${_BASHUNIT_COLOR_BOLD}'%s'${_BASHUNIT_COLOR_DEFAULT}\n" \
     "${test_name}" "${failure_message}")"
 
   bashunit::state::print_line "failure" "$line"
diff --git a/src/doc.sh b/src/doc.sh
@@ -17,7 +17,6 @@ function bashunit::doc::print_asserts() {
 
   # Patterns stored in variable for Bash 3.0 compatibility
   local _doc_pattern='^## ([A-Za-z0-9_]+)'
-  local _code_fence_pattern='^\`\`\`'
   local line
   while IFS='' read -r line || [[ -n "$line" ]]; do
     if [[ $line =~ $_doc_pattern ]]; then
@@ -33,7 +32,9 @@ function bashunit::doc::print_asserts() {
     fi
 
     if ((should_print)); then
-      if [[ "$line" =~ $_code_fence_pattern ]]; then
+      # Check for code fence using pattern matching instead of regex
+      # Avoids backtick escaping issues in Bash 3.0
+      if [[ "$line" == '```'* ]]; then
         echo "--------------"
         echo "$docstring"
         should_print=0
diff --git a/src/runner.sh b/src/runner.sh
@@ -3,7 +3,9 @@
 
 # Pre-compiled regex pattern for parsing test result assertions
 if [[ -z ${_BASHUNIT_RUNNER_PARSE_RESULT_REGEX+x} ]]; then
-  declare -r _BASHUNIT_RUNNER_PARSE_RESULT_REGEX='ASSERTIONS_FAILED=([0-9]*)##ASSERTIONS_PASSED=([0-9]*)##''ASSERTIONS_SKIPPED=([0-9]*)##ASSERTIONS_INCOMPLETE=([0-9]*)##ASSERTIONS_SNAPSHOT=([0-9]*)##''TEST_EXIT_CODE=([0-9]*)'
+  declare -r _BASHUNIT_RUNNER_PARSE_RESULT_REGEX='ASSERTIONS_FAILED=([0-9]*)##'\
+'ASSERTIONS_PASSED=([0-9]*)##ASSERTIONS_SKIPPED=([0-9]*)##'\
+'ASSERTIONS_INCOMPLETE=([0-9]*)##ASSERTIONS_SNAPSHOT=([0-9]*)##TEST_EXIT_CODE=([0-9]*)'
 fi
 
 function bashunit::runner::restore_workdir() {
diff --git a/src/state.sh b/src/state.sh
@@ -231,7 +231,16 @@ function bashunit::state::export_subshell_context() {
   fi
 
   cat <<EOF
-##ASSERTIONS_FAILED=$_BASHUNIT_ASSERTIONS_FAILED##ASSERTIONS_PASSED=$_BASHUNIT_ASSERTIONS_PASSED##ASSERTIONS_SKIPPED=$_BASHUNIT_ASSERTIONS_SKIPPED##ASSERTIONS_INCOMPLETE=$_BASHUNIT_ASSERTIONS_INCOMPLETE##ASSERTIONS_SNAPSHOT=$_BASHUNIT_ASSERTIONS_SNAPSHOT##TEST_EXIT_CODE=$_BASHUNIT_TEST_EXIT_CODE##TEST_HOOK_FAILURE=$_BASHUNIT_TEST_HOOK_FAILURE##TEST_HOOK_MESSAGE=$encoded_test_hook_message##TEST_TITLE=$encoded_test_title##TEST_OUTPUT=$encoded_test_output##
+##ASSERTIONS_FAILED=$_BASHUNIT_ASSERTIONS_FAILED\
+##ASSERTIONS_PASSED=$_BASHUNIT_ASSERTIONS_PASSED\
+##ASSERTIONS_SKIPPED=$_BASHUNIT_ASSERTIONS_SKIPPED\
+##ASSERTIONS_INCOMPLETE=$_BASHUNIT_ASSERTIONS_INCOMPLETE\
+##ASSERTIONS_SNAPSHOT=$_BASHUNIT_ASSERTIONS_SNAPSHOT\
+##TEST_EXIT_CODE=$_BASHUNIT_TEST_EXIT_CODE\
+##TEST_HOOK_FAILURE=$_BASHUNIT_TEST_HOOK_FAILURE\
+##TEST_HOOK_MESSAGE=$encoded_test_hook_message\
+##TEST_TITLE=$encoded_test_title\
+##TEST_OUTPUT=$encoded_test_output##
 EOF
 }
 
diff --git a/tests/acceptance/bashunit_direct_fn_call_test.sh b/tests/acceptance/bashunit_direct_fn_call_test.sh
@@ -78,8 +78,10 @@ function test_bashunit_direct_fn_call_failure() {
         local expected="foo"
         local actual="bar"
 
-        assert_match_snapshot "$(./bashunit --no-parallel -a assert_same --env "$TEST_ENV_FILE" "$expected" $actual 2>&1)"
-        assert_general_error "$(./bashunit --no-parallel -a assert_same --env "$TEST_ENV_FILE" "$expected" $actual)"
+        assert_match_snapshot \
+                "$(./bashunit --no-parallel -a assert_same --env "$TEST_ENV_FILE" "$expected" $actual 2>&1)"
+        assert_general_error \
+                "$(./bashunit --no-parallel -a assert_same --env "$TEST_ENV_FILE" "$expected" $actual)"
 }
 
 function test_bashunit_direct_fn_call_non_existing_fn() {
diff --git a/tests/acceptance/bashunit_fail_test.sh b/tests/acceptance/bashunit_fail_test.sh
@@ -21,7 +21,8 @@ function test_bashunit_when_a_test_fail_verbose_output_option() {
 }
 
 function test_different_verbose_snapshots_matches() {
-        bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"
+        bashunit::todo \
+                "The different snapshots for these tests should also be identical, option to choose snapshot name?"
 }
 
 function test_bashunit_when_a_test_fail_simple_output_env() {
@@ -53,5 +54,6 @@ function test_bashunit_with_a_test_fail_and_exit_immediately() {
 }
 
 function test_different_simple_snapshots_matches() {
-        bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"
+        bashunit::todo \
+                "The different snapshots for these tests should also be identical, option to choose snapshot name?"
 }
diff --git a/tests/acceptance/bashunit_pass_test.sh b/tests/acceptance/bashunit_pass_test.sh
@@ -21,7 +21,8 @@ function test_bashunit_when_a_test_passes_verbose_output_option() {
 }
 
 function test_different_verbose_snapshots_matches() {
-        bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"
+        bashunit::todo \
+                "The different snapshots for these tests should also be identical, option to choose snapshot name?"
 }
 
 function test_bashunit_when_a_test_passes_simple_output_env() {
@@ -39,5 +40,6 @@ function test_bashunit_when_a_test_passes_simple_output_option() {
 }
 
 function test_different_simple_snapshots_matches() {
-        bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"
+        bashunit::todo \
+                "The different snapshots for these tests should also be identical, option to choose snapshot name?"
 }
diff --git a/tests/acceptance/bashunit_report_html_test.sh b/tests/acceptance/bashunit_report_html_test.sh
@@ -9,7 +9,8 @@ function set_up_before_script() {
 function test_bashunit_when_report_html_option() {
         local test_file=./tests/acceptance/fixtures/test_bashunit_when_report_html.sh
 
-        assert_match_snapshot "$(./bashunit --no-parallel --env "$TEST_ENV_FILE" --report-html custom.html "$test_file")"
+        assert_match_snapshot \
+                "$(./bashunit --no-parallel --env "$TEST_ENV_FILE" --report-html custom.html "$test_file")"
         assert_file_exists custom.html
 
         if [[ -f custom.html ]]; then
diff --git a/tests/acceptance/bashunit_script_temp_file_cleanup_test.sh b/tests/acceptance/bashunit_script_temp_file_cleanup_test.sh
@@ -33,7 +33,8 @@ function test_script_temp_files_are_cleaned_up_after_test_run() {
         # Check that no parallel temp files remain in the temp directory
 
         if [[ -d "$parallel_temp_base_dir" ]]; then
-                remaining_files=$(find "$parallel_temp_base_dir" -name "script_with_setup_temp_file" 2>/dev/null || true)
+                remaining_files=$(find "$parallel_temp_base_dir" \
+                        -name "script_with_setup_temp_file" 2>/dev/null || true)
 
                 assert_empty "$remaining_files"
 
diff --git a/tests/acceptance/bashunit_setup_before_script_error_test.sh b/tests/acceptance/bashunit_setup_before_script_error_test.sh
@@ -90,7 +90,8 @@ function test_bashunit_when_set_up_before_script_fails_with_multiple_tests() {
 
 function test_bashunit_when_set_up_before_script_with_intermediate_failing_command() {
         local test_file
-        test_file=./tests/acceptance/fixtures/test_bashunit_when_setup_before_script_with_intermediate_failing_command.sh
+        test_file=./tests/acceptance/fixtures/\
+test_bashunit_when_setup_before_script_with_intermediate_failing_command.sh
         local fixture=$test_file
 
         local header_line="Running $fixture"
diff --git a/tests/acceptance/bashunit_stop_on_failure_test.sh b/tests/acceptance/bashunit_stop_on_failure_test.sh
@@ -21,7 +21,8 @@ function test_bashunit_when_stop_on_failure_env() {
 }
 
 function test_different_snapshots_matches() {
-        bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"
+        bashunit::todo \
+                "The different snapshots for these tests should also be identical, option to choose snapshot name?"
 }
 
 function test_bashunit_when_stop_on_failure_env_simple_output() {
diff --git a/tests/acceptance/bashunit_teardown_after_script_error_test.sh b/tests/acceptance/bashunit_teardown_after_script_error_test.sh
@@ -63,7 +63,8 @@ function test_bashunit_when_tear_down_after_script_with_failing_command() {
 
 function test_bashunit_when_tear_down_after_script_with_intermediate_failing_command() {
         local test_file
-        test_file=./tests/acceptance/fixtures/test_bashunit_when_teardown_after_script_with_intermediate_failing_command.sh
+        test_file=./tests/acceptance/fixtures/\
+test_bashunit_when_teardown_after_script_with_intermediate_failing_command.sh
         local fixture=$test_file
 
         local header_line="Running $fixture"
diff --git a/tests/acceptance/bashunit_upgrade_test.sh b/tests/acceptance/bashunit_upgrade_test.sh
@@ -60,9 +60,8 @@ function test_upgrade_when_a_new_version_found() {
                 bashunit::skip "curl or wget not installed" && return
         fi
 
-        sed -i -e \
-                's/declare -r BASHUNIT_VERSION="[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}"/declare -r BASHUNIT_VERSION="0.1.0"/' \
-                "$TMP_BIN"
+        sed -i -e 's/declare -r BASHUNIT_VERSION="[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}"/'\
+'declare -r BASHUNIT_VERSION="0.1.0"/' "$TMP_BIN"
 
         if [[ $_BASHUNIT_OS == "OSX" ]]; then
                 rm -f "${TMP_BIN}-e"
@@ -89,9 +88,8 @@ function test_do_not_update_on_consecutive_calls() {
                 bashunit::skip "curl or wget not installed" && return
         fi
 
-        sed -i -e \
-                's/declare -r BASHUNIT_VERSION="[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}"/declare -r BASHUNIT_VERSION="0.1.0"/' \
-                "$TMP_BIN"
+        sed -i -e 's/declare -r BASHUNIT_VERSION="[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}"/'\
+'declare -r BASHUNIT_VERSION="0.1.0"/' "$TMP_BIN"
 
         if [[ $_BASHUNIT_OS == "OSX" ]]; then
                 rm -f "${TMP_BIN}-e"
diff --git a/tests/acceptance/install_test.sh b/tests/acceptance/install_test.sh
@@ -90,7 +90,9 @@ function test_install_downloads_the_given_version() {
 
         output="$(./install.sh lib 0.9.0)"
 
-        assert_same "$(printf "> Downloading a concrete version: '0.9.0'\n> bashunit has been installed in the 'lib' folder")" \
+        assert_same \
+                "$(printf "> Downloading a concrete version: '0.9.0'\n"\
+"> bashunit has been installed in the 'lib' folder")" \
                 "$output"
 
         assert_file_exists "$installed_bashunit"
@@ -149,12 +151,15 @@ function test_install_downloads_the_non_stable_beta_version() {
 
         output="$(./install.sh deps beta)"
 
-        assert_contains "$(printf "> Downloading non-stable version: 'beta'\n> bashunit has been installed in the 'deps' folder")" \
+        assert_contains \
+                "$(printf "> Downloading non-stable version: 'beta'\n"\
+"> bashunit has been installed in the 'deps' folder")" \
                 "$output"
 
         assert_file_exists "$installed_bashunit"
 
-        assert_matches "$(printf "\(non-stable\) beta after ([0-9]+\.[0-9]+\.[0-9]+) \[2023-11-13\] 🐍 \#[a-fA-F0-9]{7}")" \
+        assert_matches \
+                "$(printf "\(non-stable\) beta after ([0-9]+\.[0-9]+\.[0-9]+) \[2023-11-13\] 🐍 \#[a-fA-F0-9]{7}")" \
                 "$("$installed_bashunit" --version)"
 
         assert_directory_not_exists "./deps/temp_bashunit"
diff --git a/tests/functional/custom_asserts_test.sh b/tests/functional/custom_asserts_test.sh
@@ -20,6 +20,7 @@ function test_assert_positive_number_passed() {
 }
 
 function test_assert_positive_number_failed() {
-  assert_same "$(bashunit::console_results::print_failed_test "Assert positive number failed" "positive number" "got" "0")" \
+  assert_same \
+    "$(bashunit::console_results::print_failed_test "Assert positive number failed" "positive number" "got" "0")" \
     "$(assert_positive_number "0")"
 }
diff --git a/tests/unit/assert_test.sh b/tests/unit/assert_test.sh
diff --git a/tests/unit/directory_test.sh b/tests/unit/directory_test.sh
diff --git a/tests/unit/file_test.sh b/tests/unit/file_test.sh
diff --git a/tests/unit/skip_todo_test.sh b/tests/unit/skip_todo_test.sh
diff --git a/tests/unit/test_doubles_test.sh b/tests/unit/test_doubles_test.sh

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ function test_bashunit_when_a_test_fail_verbose_output_option() {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`function test_different_verbose_snapshots_matches() {`
`24`		`- bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"`
	`24`	`+ bashunit::todo \`
	`25`	`+ "The different snapshots for these tests should also be identical, option to choose snapshot name?"`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`function test_bashunit_when_a_test_fail_simple_output_env() {`
`@@ -53,5 +54,6 @@ function test_bashunit_with_a_test_fail_and_exit_immediately() {`
`53`	`54`	`}`
`54`	`55`
`55`	`56`	`function test_different_simple_snapshots_matches() {`
`56`		`- bashunit::todo "The different snapshots for these tests should also be identical, option to choose snapshot name?"`
	`57`	`+ bashunit::todo \`
	`58`	`+ "The different snapshots for these tests should also be identical, option to choose snapshot name?"`
`57`	`59`	`}`