Changes for the BashSupport Pro test runner.

- Add formatter "bashpro" to output BashSupport Pro's format
- bats-core#183: Execute bats-core tests with the shell defined in the run configuration. Without this Bash is picked from $PATH, which is Bash v3 on macOS even if /usr/local/bin/bash was used to execute the first bats runner script.
- Group tests by file in a hierarchy of suites (root > file > test)

Author: jansorg

bin/bats

@@ -72,4 +72,4 @@ BATS_BASE_LIBDIR=lib # this will be patched with the true value in install.sh
 
 export BATS_ROOT=${BATS_PATH%/*/*}
 export -f bats_readlinkf
-exec env BATS_ROOT="$BATS_ROOT" BATS_LIBDIR="${BATS_BASE_LIBDIR:-lib}" "$BATS_ROOT/libexec/bats-core/bats" "$@"
+exec env BATS_ROOT="$BATS_ROOT" BATS_LIBDIR="${BATS_BASE_LIBDIR:-lib}" "$BASH" "$BATS_ROOT/libexec/bats-core/bats" "$@"

libexec/bats-core/bats

@@ -2,7 +2,7 @@
 set -e
 
 export BATS_VERSION='1.12.0'
-VALID_FORMATTERS="pretty, junit, tap, tap13"
+VALID_FORMATTERS="pretty, junit, tap, tap13, bashpro"
 
 version() {
   printf 'Bats %s\n' "$BATS_VERSION"
@@ -57,7 +57,7 @@ HELP_TEXT_HEADER
                             Specifying this flag multiple times allows for logical or (||):
                             `--filter-tags A,B --filter-tags A,!C` matches tags (A && B) || (A && !C)
   -F, --formatter <type>    Switch between formatters: pretty (default),
-                              tap (default w/o term), tap13, junit, /<absolute path to formatter>
+                              tap (default w/o term), tap13, junit, bashpro, /<absolute path to formatter>
   --gather-test-outputs-in <directory>
                             Gather the output of failing *and* passing tests
                             as files in directory (if existing, must be empty)
@@ -193,7 +193,7 @@ while [[ "$#" -ne 0 ]]; do
   -F | --formatter)
     shift
     # allow cat formatter to see extended output but don't advertise to users
-    if [[ $1 =~ ^(pretty|junit|tap|tap13|cat|/.*)$ ]]; then
+    if [[ $1 =~ ^(pretty|junit|tap|tap13|cat|/.*|bashpro)$ ]]; then
       formatter="$1"
     else
       printf "Unknown formatter '%s', valid options are %s\n" "$1" "${VALID_FORMATTERS}"
@@ -505,12 +505,12 @@ bats_tee() { # <output-file> <command...>
 }
 
 if [[ -n "$report_formatter" ]]; then
-  exec bats-exec-suite "${flags[@]}" "${filenames[@]}" |
+  exec "$BASH" bats-exec-suite "${flags[@]}" "${filenames[@]}" |
     bats_tee "${BATS_REPORT_OUTPUT_DIR}/${BATS_REPORT_FILENAME}" "$interpolated_report_formatter" "${report_formatter_flags[@]}" |
     bats_test_count_validator |
-    "$interpolated_formatter" "${formatter_flags[@]}"
+    "$BASH" "$interpolated_formatter" "${formatter_flags[@]}"
 else
-  exec bats-exec-suite "${flags[@]}" "${filenames[@]}" |
+  exec "$BASH" bats-exec-suite "${flags[@]}" "${filenames[@]}" |
     bats_test_count_validator |
-    "$interpolated_formatter" "${formatter_flags[@]}"
+    "$BASH" "$interpolated_formatter" "${formatter_flags[@]}"
 fi

libexec/bats-core/bats-exec-suite

@@ -237,7 +237,7 @@ bats_run_teardown_suite() {
   # avoid being called twice, in case this is not called through bats_teardown_suite_trap
   # but from the end of file
   trap bats_suite_exit_trap EXIT
-  
+
   bats_set_stacktrace_limit
 
   BATS_TEARDOWN_SUITE_COMPLETED=
@@ -306,11 +306,15 @@ else
       bats_exec_suite_status=130 # bash's code for SIGINT exits
       break
     fi
-    bats-exec-file "${flags[@]}" "$file_index" "$filename" "${TESTS_LIST_FILE}" || bats_exec_suite_status=1
+    if [ -n "${BATS_SHELL:-}" ]; then
+      "$BATS_SHELL" bats-exec-file "${flags[@]}" "$file_index" "$filename" "${TESTS_LIST_FILE}" || bats_exec_suite_status=1
+    else
+      bats-exec-file "${flags[@]}" "$file_index" "$filename" "${TESTS_LIST_FILE}" || bats_exec_suite_status=1
+    fi
   done
 fi
 
 set -eET
 bats_run_teardown_suite
 
-bats_exit_suite
+bats_exit_suite

libexec/bats-core/bats-format-bashpro

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+set -e
+
+_bashpro_file=""
+declare -i begin_index=0 test_active=0 number_of_printed_log_lines_for_this_test_so_far=0
+
+yaml_block_open=''
+add_yaml_entry() {
+  if [[ -z "$yaml_block_open" ]]; then
+    printf "  ---\n"
+  fi
+  [[ -n "$1" ]] && printf "  %s: %s\n" "$1" "$2"
+  yaml_block_open=1
+}
+
+close_previous_yaml_block() {
+  if [[ -n "$yaml_block_open" ]]; then
+    printf "  ...\n"
+    yaml_block_open=''
+  fi
+}
+
+trap '' INT
+
+number_of_printed_log_lines_for_this_test_so_far=0
+
+# shellcheck source=lib/bats-core/formatter.bash
+source "$BATS_ROOT/lib/bats-core/formatter.bash"
+
+bats_tap_stream_plan() {
+  # printf "TAP version 13\n"
+  printf "1..%d\n" "$1"
+}
+
+bats_tap_stream_begin() { #<test index> <test name>
+    test_active=1
+    number_of_printed_log_lines_for_this_test_so_far=0
+    printf "# _id=%d, _file=%s, _test=%s\n" "$begin_index" "$_bashpro_file" "$2"
+}
+
+bats_tap_stream_ok() { # <test index> <test name>
+    close_previous_yaml_block
+    test_active=0
+    number_of_printed_log_lines_for_this_test_so_far=0
+    printf "ok %d %s\n" "$1" "$2"
+    if [[ "${BATS_FORMATTER_TEST_DURATION-x}" != x ]]; then
+        add_yaml_entry "duration_ms" "${BATS_FORMATTER_TEST_DURATION}"
+    fi
+}
+
+pass_on_optional_data() {
+    if [[ "${BATS_FORMATTER_TEST_DURATION-x}" != x ]]; then
+        add_yaml_entry "duration_ms" "${BATS_FORMATTER_TEST_DURATION}"
+    fi
+    if [[ "${BATS_FORMATTER_TEST_TIMEOUT-x}" != x ]]; then
+        add_yaml_entry "timeout_sec" "${BATS_FORMATTER_TEST_TIMEOUT}"
+    fi
+}
+
+bats_tap_stream_not_ok() { # <test index> <test name>
+    close_previous_yaml_block
+    test_active=1 # to print the error message for this test
+    number_of_printed_log_lines_for_this_test_so_far=0
+
+    printf "not ok %d %s\n" "$1" "$2"
+    pass_on_optional_data
+}
+
+bats_tap_stream_skipped() { # <test index> <test name> <reason>
+    close_previous_yaml_block
+    number_of_printed_log_lines_for_this_test_so_far=0
+
+    printf "not ok %d %s # SKIP %s\n" "$1" "$2" "$3"
+    pass_on_optional_data
+}
+
+bats_tap_stream_comment() { # <comment text without leading '# '>
+    if ((test_active == 1 && number_of_printed_log_lines_for_this_test_so_far == 0)); then
+      add_yaml_entry "" ""
+    fi
+    ((++number_of_printed_log_lines_for_this_test_so_far))
+    printf "# %s\n" "$1"
+}
+
+bats_tap_stream_suite() { # <file name>
+    _bashpro_file="$1"
+    test_active=0
+    number_of_printed_log_lines_for_this_test_so_far=0
+}
+
+bats_tap_stream_unknown() { # <full line>
+    printf  "%s\n" "$1"
+}
+
+bats_parse_internal_extended_tap
+
+# close the final block if there was one
+close_previous_yaml_block