Merge branch 'main' into perf/p0-performance-optimizations

Author: Chemaclass

CHANGELOG.md

@@ -3,6 +3,11 @@
 ## Unreleased
 
 ### Added
+- Add `watch [path]` subcommand to re-run tests automatically on file changes
+    - Uses `inotifywait` on Linux (via `inotify-tools`) or `fswatch` on macOS
+    - Falls back with a clear install hint if neither tool is available
+    - Accepts optional path argument (defaults to current directory)
+
 - Add date comparison assertions: `assert_date_equals`, `assert_date_before`, `assert_date_after`, `assert_date_within_range`, `assert_date_within_delta`
     - Auto-detects epoch seconds, ISO 8601, space-separated datetime, and timezone offsets
     - Mixed formats supported in the same assertion call
@@ -20,6 +25,15 @@
 - Reduce subshells in test execution hot path
 - Batch coverage recording with in-memory buffering
 
+### Fixed
+- JUnit XML report now conforms to the standard schema
+    - Remove non-standard `passed`, `incomplete`, `snapshot` attributes from `<testsuite>` and `status`, `assertions` from `<testcase>`
+    - Add `errors="0"` attribute and `<failure>`/`<skipped>` child elements per the JUnit spec
+    - `skipped` count now includes both skipped and incomplete tests to match emitted `<skipped/>` elements
+    - Convert `time` values from milliseconds to seconds (float) as expected by CI tools
+    - Strip ANSI escape sequences and invalid XML control characters from failure messages
+    - Include actual failure messages in `<failure>` body instead of hard-coded placeholders
+
 ## [0.33.0](https://github.com/TypedDevs/bashunit/compare/0.32.0...0.33.0) - 2026-02-15
 
 ### Changed

bashunit

@@ -72,6 +72,7 @@ source "$BASHUNIT_ROOT_DIR/src/console_results.sh"
 source "$BASHUNIT_ROOT_DIR/src/helpers.sh"
 source "$BASHUNIT_ROOT_DIR/src/test_title.sh"
 source "$BASHUNIT_ROOT_DIR/src/upgrade.sh"
+source "$BASHUNIT_ROOT_DIR/src/watch.sh"
 source "$BASHUNIT_ROOT_DIR/src/assertions.sh"
 source "$BASHUNIT_ROOT_DIR/src/doc.sh"
 source "$BASHUNIT_ROOT_DIR/src/reports.sh"
@@ -88,7 +89,7 @@ bashunit::clock::init
 _SUBCOMMAND=""
 
 case "${1:-}" in
-  test | bench | doc | init | learn | upgrade | assert)
+  test | bench | doc | init | learn | upgrade | assert | watch)
     _SUBCOMMAND="$1"
     shift
     ;;
@@ -123,4 +124,5 @@ case "$_SUBCOMMAND" in
   learn) bashunit::main::cmd_learn "$@" ;;
   upgrade) bashunit::main::cmd_upgrade "$@" ;;
   assert) bashunit::main::cmd_assert "$@" ;;
+  watch) bashunit::main::cmd_watch "$@" ;;
 esac

src/console_header.sh

@@ -69,6 +69,7 @@ Commands:
   doc [filter]        Display assertion documentation
   init [dir]          Initialize a new test directory
   learn               Start interactive tutorial
+  watch [path]        Watch files and re-run tests on change
   upgrade             Upgrade bashunit to latest version
 
 Global Options:
@@ -271,3 +272,28 @@ Note: You can also use 'bashunit test --assert <fn> <args>' (deprecated).
 More info: https://bashunit.typeddevs.com/standalone
 EOF
 }
+
+function bashunit::console_header::print_watch_help() {
+  cat << 'ENDOFHELP'
+Usage: bashunit watch [path] [test-options]
+
+Watch .sh files for changes and automatically re-run tests.
+
+Arguments:
+  [path]          Directory or file to watch and test (default: .)
+
+Options:
+  -h, --help      Show this help message
+  Any option accepted by 'bashunit test' is also accepted here.
+
+Requirements:
+  Linux:  inotifywait  (sudo apt install inotify-tools)
+  macOS:  fswatch      (brew install fswatch)
+
+Examples:
+  bashunit watch                      Watch current directory
+  bashunit watch tests/               Watch the tests/ directory
+  bashunit watch tests/ --filter user Watch and filter by name
+  bashunit watch tests/ --simple      Watch with simple output
+ENDOFHELP
+}

src/main.sh

@@ -405,6 +405,22 @@ function bashunit::main::cmd_learn() {
   exit 0
 }
 
+#############################
+# Subcommand: watch
+#############################
+function bashunit::main::cmd_watch() {
+  if [[ "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then
+    bashunit::console_header::print_watch_help
+    exit 0
+  fi
+
+  local path="${1:-.}"
+  shift || true
+  local -a extra_args=("$@")
+
+  bashunit::watch::run "$path" "${extra_args[@]+\"${extra_args[@]}\"}"
+}
+
 #############################
 # Subcommand: upgrade
 #############################

src/reports.sh

@@ -6,6 +6,7 @@ _BASHUNIT_REPORTS_TEST_NAMES=()
 _BASHUNIT_REPORTS_TEST_STATUSES=()
 _BASHUNIT_REPORTS_TEST_DURATIONS=()
 _BASHUNIT_REPORTS_TEST_ASSERTIONS=()
+_BASHUNIT_REPORTS_TEST_FAILURES=()
 
 function bashunit::reports::add_test_snapshot() {
   bashunit::reports::add_test "$1" "$2" "$3" "$4" "snapshot"
@@ -24,7 +25,7 @@ function bashunit::reports::add_test_passed() {
 }
 
 function bashunit::reports::add_test_failed() {
-  bashunit::reports::add_test "$1" "$2" "$3" "$4" "failed"
+  bashunit::reports::add_test "$1" "$2" "$3" "$4" "failed" "$5"
 }
 
 function bashunit::reports::add_test() {
@@ -36,45 +37,69 @@ function bashunit::reports::add_test() {
   local duration="$3"
   local assertions="$4"
   local status="$5"
+  local failure_message="${6:-}"
 
   _BASHUNIT_REPORTS_TEST_FILES[${#_BASHUNIT_REPORTS_TEST_FILES[@]}]="$file"
   _BASHUNIT_REPORTS_TEST_NAMES[${#_BASHUNIT_REPORTS_TEST_NAMES[@]}]="$test_name"
   _BASHUNIT_REPORTS_TEST_STATUSES[${#_BASHUNIT_REPORTS_TEST_STATUSES[@]}]="$status"
   _BASHUNIT_REPORTS_TEST_ASSERTIONS[${#_BASHUNIT_REPORTS_TEST_ASSERTIONS[@]}]="$assertions"
   _BASHUNIT_REPORTS_TEST_DURATIONS[${#_BASHUNIT_REPORTS_TEST_DURATIONS[@]}]="$duration"
+  _BASHUNIT_REPORTS_TEST_FAILURES[${#_BASHUNIT_REPORTS_TEST_FAILURES[@]}]="$failure_message"
+}
+
+function bashunit::reports::__xml_escape() {
+  local text="$1"
+  # Strip ANSI escape sequences and control characters invalid in XML 1.0,
+  # then escape XML special characters (& first to avoid double-escaping)
+  echo "$text" \
+    | sed -e 's/\x1b\[[0-9;]*[a-zA-Z]//g' \
+    | tr -d '\000-\010\013\014\016-\037' \
+    | sed -e 's/&/\&amp;/g' -e 's/</\&lt;/g' -e 's/>/\&gt;/g' -e 's/"/\&quot;/g' -e "s/'/\&apos;/g"
 }
 
 function bashunit::reports::generate_junit_xml() {
   local output_file="$1"
 
-  local test_passed=$(bashunit::state::get_tests_passed)
   local tests_skipped=$(bashunit::state::get_tests_skipped)
   local tests_incomplete=$(bashunit::state::get_tests_incomplete)
-  local tests_snapshot=$(bashunit::state::get_tests_snapshot)
   local tests_failed=$(bashunit::state::get_tests_failed)
-  local time=$(bashunit::clock::total_runtime_in_milliseconds)
+  local time_ms=$(bashunit::clock::total_runtime_in_milliseconds)
+  local time
+  time=$(LC_ALL=C awk -v ms="$time_ms" 'BEGIN {printf "%.3f", ms/1000}')
 
   {
     echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
     echo "<testsuites>"
     echo "  <testsuite name=\"bashunit\" tests=\"${#_BASHUNIT_REPORTS_TEST_NAMES[@]}\""
-    echo "             passed=\"$test_passed\" failures=\"$tests_failed\" incomplete=\"$tests_incomplete\""
-    echo "             skipped=\"$tests_skipped\" snapshot=\"$tests_snapshot\""
+    echo "             failures=\"$tests_failed\" errors=\"0\""
+    echo "             skipped=\"$(( tests_skipped + tests_incomplete ))\""
     echo "             time=\"$time\">"
 
     local i
     for i in "${!_BASHUNIT_REPORTS_TEST_NAMES[@]}"; do
       local file="${_BASHUNIT_REPORTS_TEST_FILES[$i]:-}"
       local name="${_BASHUNIT_REPORTS_TEST_NAMES[$i]:-}"
-      local assertions="${_BASHUNIT_REPORTS_TEST_ASSERTIONS[$i]:-}"
       local status="${_BASHUNIT_REPORTS_TEST_STATUSES[$i]:-}"
-      local test_time="${_BASHUNIT_REPORTS_TEST_DURATIONS[$i]:-}"
+      local test_time_ms="${_BASHUNIT_REPORTS_TEST_DURATIONS[$i]:-}"
+      local failure_message="${_BASHUNIT_REPORTS_TEST_FAILURES[$i]:-}"
+      local test_time
+      test_time=$(LC_ALL=C awk -v ms="$test_time_ms" 'BEGIN {printf "%.3f", ms/1000}')
 
       echo "    <testcase file=\"$file\""
       echo "        name=\"$name\""
-      echo "        status=\"$status\""
-      echo "        assertions=\"$assertions\""
       echo "        time=\"$test_time\">"
+
+      # Add failure element for failed tests with actual failure message
+      if [[ "$status" == "failed" ]]; then
+        local escaped_message
+        escaped_message=$(bashunit::reports::__xml_escape "$failure_message")
+        echo "      <failure message=\"Test failed\">$escaped_message</failure>"
+      elif [[ "$status" == "skipped" ]]; then
+        echo "      <skipped/>"
+      elif [[ "$status" == "incomplete" ]]; then
+        echo "      <skipped message=\"Test incomplete\"/>"
+      fi
+
       echo "    </testcase>"
     done
 

src/runner.sh

@@ -735,15 +735,15 @@ function bashunit::runner::run_test() {
       error_message="$hook_message"
     fi
     bashunit::console_results::print_error_test "$failure_function" "$error_message" "$runtime_output"
-    bashunit::reports::add_test_failed "$test_file" "$failure_label" "$duration" "$total_assertions"
+    bashunit::reports::add_test_failed "$test_file" "$failure_label" "$duration" "$total_assertions" "$error_message"
     bashunit::runner::write_failure_result_output "$test_file" "$failure_function" "$error_message" "$runtime_output"
     bashunit::internal_log "Test error" "$failure_label" "$error_message"
     return
   fi
 
   if [[ "$current_assertions_failed" != "$(bashunit::state::get_assertions_failed)" ]]; then
     bashunit::state::add_tests_failed
-    bashunit::reports::add_test_failed "$test_file" "$label" "$duration" "$total_assertions"
+    bashunit::reports::add_test_failed "$test_file" "$label" "$duration" "$total_assertions" "$subshell_output"
     bashunit::runner::write_failure_result_output "$test_file" "$fn_name" "$subshell_output"
 
     bashunit::internal_log "Test failed" "$label"
@@ -998,7 +998,9 @@ function bashunit::runner::record_file_hook_failure() {
 
   bashunit::state::add_tests_failed
   bashunit::console_results::print_error_test "$hook_name" "$hook_output"
-  bashunit::reports::add_test_failed "$test_file" "$(bashunit::helper::normalize_test_function_name "$hook_name")" 0 0
+  local _normalized_hook
+  _normalized_hook="$(bashunit::helper::normalize_test_function_name "$hook_name")"
+  bashunit::reports::add_test_failed "$test_file" "$_normalized_hook" 0 0 "$hook_output"
   bashunit::runner::write_failure_result_output "$test_file" "$hook_name" "$hook_output"
 
   return "$status"

src/watch.sh

@@ -0,0 +1,82 @@
+#!/usr/bin/env bash
+
+# bashunit watch mode
+# Watches test and source files for changes and re-runs tests automatically.
+# Requires: inotifywait (inotify-tools) on Linux, or fswatch on macOS.
+
+function bashunit::watch::_command_exists() {
+  command -v "$1" &>/dev/null
+}
+
+function bashunit::watch::is_available() {
+  if bashunit::watch::_command_exists inotifywait; then
+    echo "inotifywait"
+  elif bashunit::watch::_command_exists fswatch; then
+    echo "fswatch"
+  else
+    echo ""
+  fi
+}
+
+function bashunit::watch::run() {
+  local path="${1:-.}"
+  shift
+  local extra_args=("$@")
+
+  local tool
+  tool=$(bashunit::watch::is_available)
+
+  if [[ -z "$tool" ]]; then
+    printf "%sError: watch mode requires 'inotifywait' (Linux) or 'fswatch' (macOS).%s\n" \
+      "${_BASHUNIT_COLOR_FAILED}" "${_BASHUNIT_COLOR_DEFAULT}"
+    printf "  Linux:  sudo apt install inotify-tools\n"
+    printf "  macOS:  brew install fswatch\n"
+    exit 1
+  fi
+
+  printf "%sbashunit --watch%s  watching: %s\n\n" \
+    "${_BASHUNIT_COLOR_PASSED}" "${_BASHUNIT_COLOR_DEFAULT}" "$path"
+
+  # Run once immediately before entering the watch loop
+  bashunit::watch::run_tests "$path" "${extra_args[@]+"${extra_args[@]}"}"
+
+  while true; do
+    bashunit::watch::wait_for_change "$tool" "$path"
+    printf "\n%s[change detected — re-running tests]%s\n\n" \
+      "${_BASHUNIT_COLOR_SKIPPED}" "${_BASHUNIT_COLOR_DEFAULT}"
+    bashunit::watch::run_tests "$path" "${extra_args[@]+"${extra_args[@]}"}"
+  done
+}
+
+function bashunit::watch::run_tests() {
+  local path="$1"
+  shift
+  # Re-invoke bashunit test in a subshell so state resets cleanly each run
+  "$BASHUNIT_ROOT_DIR/bashunit" test "$path" "$@"
+  return $?
+}
+
+function bashunit::watch::wait_for_change() {
+  local tool="$1"
+  local path="$2"
+
+  case "$tool" in
+  inotifywait)
+    inotifywait \
+      --quiet \
+      --recursive \
+      --event modify,create,delete,move \
+      --include '.*\.sh$' \
+      "$path" 2>/dev/null
+    ;;
+  fswatch)
+    # fswatch outputs one line per event; we only need the first one
+    fswatch \
+      --recursive \
+      --include='.*\.sh$' \
+      --exclude='.*' \
+      --one-event \
+      "$path" 2>/dev/null
+    ;;
+  esac
+}

tests/acceptance/snapshots/bashunit_path_test_sh.test_bashunit_without_path_env_nor_argument.snapshot

@@ -8,6 +8,7 @@ Commands:
   doc [filter]        Display assertion documentation
   init [dir]          Initialize a new test directory
   learn               Start interactive tutorial
+  watch [path]        Watch files and re-run tests on change
   upgrade             Upgrade bashunit to latest version
 
 Global Options:

tests/acceptance/snapshots/bashunit_test_sh.test_bashunit_should_display_help.snapshot

@@ -7,6 +7,7 @@ Commands:
   doc [filter]        Display assertion documentation
   init [dir]          Initialize a new test directory
   learn               Start interactive tutorial
+  watch [path]        Watch files and re-run tests on change
   upgrade             Upgrade bashunit to latest version
 
 Global Options: