@bats-hardened/bats 1.14.1-alpha02

package/libexec/bats-core/bats-gather-tests

@@ -0,0 +1,402 @@
+#!/usr/bin/env bash
+set -eET
+
+args=("$@")
+filter_tags_list=()
+
+# shellcheck source=lib/bats-core/common.bash disable=SC2153
+source "$BATS_ROOT/$BATS_LIBDIR/bats-core/common.bash"
+# shellcheck source=lib/bats-core/preprocessing.bash
+source "$BATS_ROOT/$BATS_LIBDIR/bats-core/preprocessing.bash"
+
+abort() {
+  printf 'ERROR: '
+  # shellcheck disable=SC2059
+  printf "$@"
+  exit 1
+} >&2
+
+read_tags() {
+  local IFS=,
+  read -ra tags <<<"$1" || true
+  if ((${#tags[@]} > 0)); then
+    for ((i = 0; i < ${#tags[@]}; ++i)); do
+      bats_trim "tags[$i]" "${tags[$i]}"
+    done
+    bats_sort sorted_tags "${tags[@]}"
+    # shellcheck disable=SC2154
+    filter_tags_list+=("${sorted_tags[*]}")
+  else
+    filter_tags_list+=("")
+  fi
+}
+
+while [[ "$#" -ne 0 ]]; do
+  case "$1" in
+    --dummy-flag)
+      ;;
+    --filter-tags)
+      shift
+      read_tags "$1"
+      ;;
+    --)
+      shift 1
+      break
+      ;;
+    *)
+      abort "Unknown flag %s in command:\nbats-gather-tests %s" "$1" "${args[*]}"
+      ;;
+  esac
+  shift 1
+done
+
+
+# shellcheck source=lib/bats-core/test_functions.bash disable=SC2153
+# required to provide e.g. `load` for free code (some users rely on this)
+source "$BATS_ROOT/$BATS_LIBDIR/bats-core/test_functions.bash"
+# _bats_test_functions_setup will be called per file further down
+
+# override test_functions.bash's version to use it for test registration
+bats_test_function() {
+  local -a tags=() current_tags=()
+  local description=
+
+  while (( $# > 0 )); do
+    case "$1" in
+      --description)
+        description=$2
+        shift 2
+      ;;
+      --tags)
+        if [[ "$2" != "" ]]; then # avoid unbound variable with set -u Bash 3
+          IFS=, read -ra current_tags <<<"$2" || true
+          tags+=("${current_tags[@]}")
+        fi
+        shift 2
+      ;;
+      --)
+        shift
+        break
+      ;;
+      *)
+        printf "ERROR: unknown option %s for bats_test_function" "$1" >&2
+        exit 1
+      ;;
+    esac
+  done
+
+  if (( ${#tags[@]} > 1 )); then # avoid unbound variable with set -u Bash 3
+    bats_sort tags "${tags[@]}"
+  fi
+
+  line="$BATS_TEST_FILENAME"
+  line+=$'\t'
+  line+="$*"
+  # always execute should_skip_because_of_status for its sideeffects
+  if should_skip_because_of_status || should_skip_because_of_focus || should_skip_because_of_filter_tags || should_skip_because_of_filter || should_skip_because_of_negative_filter; then
+    return 0
+  fi
+
+  # dereferencing ${test_names[*]} fails on older bash versions when empty -> check before
+  if [[ ${#test_names[@]} -gt 0 && " ${test_names[*]} " == *" $line "* ]]; then
+      test_dupes+=("$line")
+  fi
+  test_names+=("$line")
+
+  local args
+  printf -v args '%q ' "$@"
+  #echo "Adding test $line as '$BATS_TEST_FILENAME$args'" >&2
+  printf "%s\t%s\n" "$BATS_TEST_FILENAME" "$args" >> "$TESTS_LIST_FILE"
+}
+
+function should_skip_because_of_focus() {
+  if bats_all_in tags 'bats:focus'; then
+    if [[ $focus_mode == 1 ]]; then
+      # focused tests in focus mode should just be registered
+      :
+    else
+      # the current test enables focus mode ...
+      focus_mode=1
+      # ... -> remove previously found, unfocused tests
+      included_tests=()
+      : >| "$TESTS_LIST_FILE"
+    fi
+  elif [[ $focus_mode == 1 ]]; then
+    # the current test is not focused but focus mode is enabled -> filter out
+    return 0
+    # no else -> unfocused tests outside focus mode should just be registered
+  fi
+  return 1
+}
+
+function should_skip_because_of_filter_tags() {
+  if (( ${#filter_tags_list[@]} > 0 )); then
+    for filter_tags in "${filter_tags_list[@]}"; do
+      # empty search tags only match empty test tags!
+      if [[ -z "$filter_tags" ]]; then
+        if [[ ${#tags[@]} -eq 0 ]]; then
+          return 1
+        fi
+        continue
+      fi
+      # non empty filter tags must  be processed
+      local -a positive_filter_tags=() negative_filter_tags=()
+      IFS=, read -ra filter_tags <<<"$filter_tags" || true
+      for filter_tag in "${filter_tags[@]}"; do
+        if [[ $filter_tag == !* ]]; then
+          bats_trim filter_tag "${filter_tag#!}"
+          negative_filter_tags+=("${filter_tag}")
+        else
+          positive_filter_tags+=("${filter_tag}")
+        fi
+      done
+      if bats_append_arrays_as_args positive_filter_tags -- bats_all_in tags &&
+        ! bats_append_arrays_as_args negative_filter_tags -- bats_any_in tags; then
+        return 1
+      fi
+    done
+    return 0 # skip, because no match was found
+  fi
+  return 1 # no filter tags -> nothing to skip
+}
+
+if [[ -n "${filter-}" ]]; then
+function should_skip_because_of_filter() {
+  # shellcheck disable=SC2154 # filter should be inherited as env var
+  ! [[ "$description" =~ $filter ]]
+}
+else
+function should_skip_because_of_filter() {
+  # skip this when there is no $filter
+  return 1
+}
+fi
+
+if [[ -n "${nfilter-}" ]]; then
+function should_skip_because_of_negative_filter() {
+  # shellcheck disable=SC2154 # nfilter should be inherited as env var
+  [[ "$description" =~ $nfilter ]]
+}
+else
+function should_skip_because_of_negative_filter() {
+  # skip this when there is no $nfilter
+  return 1
+}
+fi
+
+function should_skip_because_of_status() {
+  # disable this filter if not activated by $filter_status
+  return 1
+}
+
+# shellcheck disable=SC2154 # filter_status is set in the environment
+if [[ -n "${filter_status-}" ]]; then
+  case "$filter_status" in
+  failed)
+    bats_filter_test_by_status() { # <line>
+      ! bats_binary_search "$1" "passed_tests"
+    }
+    ;;
+  passed)
+    bats_filter_test_by_status() {
+      ! bats_binary_search "$1" "failed_tests"
+    }
+    ;;
+  missed)
+    bats_filter_test_by_status() {
+      ! bats_binary_search "$1" "failed_tests" && ! bats_binary_search "$1" "passed_tests"
+    }
+    ;;
+  *)
+    printf "Error: Unknown value '%s' for --filter-status. Valid values are 'failed' and 'missed'.\n" "$filter_status" >&2
+    exit 1
+    ;;
+  esac
+
+  if IFS='' read -d $'\n' -r BATS_PREVIOUS_RUNLOG_FILE < <(ls -1r "$BATS_RUN_LOGS_DIRECTORY"); then
+    BATS_PREVIOUS_RUNLOG_FILE="$BATS_RUN_LOGS_DIRECTORY/$BATS_PREVIOUS_RUNLOG_FILE"
+    if [[ $BATS_PREVIOUS_RUNLOG_FILE == "$BATS_RUNLOG_FILE" ]]; then
+      count=$(find "$BATS_RUN_LOGS_DIRECTORY" -name "$BATS_RUNLOG_DATE*" | wc -l)
+      BATS_RUNLOG_FILE="$BATS_RUN_LOGS_DIRECTORY/${BATS_RUNLOG_DATE}-$count.log"
+    fi
+    failed_tests=()
+    passed_tests=()
+    # store tests that were already filtered out in the last run for the same filter reason
+    last_filtered_tests=()
+    i=0
+    while read -rd $'\n' line; do
+      ((++i))
+      case "$line" in
+      "passed "*)
+        passed_tests+=("${line#passed }")
+        ;;
+      "failed "*)
+        failed_tests+=("${line#failed }")
+        ;;
+      "status-filtered $filter_status"*) # pick up tests that were filtered in the last round for the same status
+        last_filtered_tests+=("${line#status-filtered "$filter_status" }")
+        ;;
+      "status-filtered "*) # ignore other status-filtered lines
+        ;;
+      "#"*) # allow for comments
+        ;;
+      *)
+        printf "Error: %s:%d: Invalid format: %s\n" "$BATS_PREVIOUS_RUNLOG_FILE" "$i" "$line" >&2
+        exit 1
+        ;;
+      esac
+    done < <(sort "$BATS_PREVIOUS_RUNLOG_FILE")
+
+    # enable filter only, when there is something to filter
+    function should_skip_because_of_status() {
+      #echo "Match:"
+      #echo "$line"
+      #printf "%s\n" "${failed_tests[@]}"
+      #echo "or"
+      #printf "%s\n" "${last_filtered_tests[@]}"
+      if bats_filter_test_by_status "$line"; then
+        if ! bats_binary_search "$line" last_filtered_tests; then
+          included_tests+=("$line")
+          #echo "included"
+          return 1
+        fi
+      fi
+      #echo "excluded"
+      excluded_tests+=("$line")
+      return 0
+    }  >&2
+  else
+    printf "No recording of previous runs found. Running all tests!\n" >&2
+  fi
+else
+  : #printf "Not filtering by status!\n" >&2
+fi
+
+# shellcheck source=lib/bats-core/tracing.bash
+source "$BATS_ROOT/$BATS_LIBDIR/bats-core/tracing.bash"
+
+BATS_OUT="$BATS_RUN_TMPDIR/gather-tests.out"
+touch "$BATS_OUT"
+
+bats_gather_tests_exit_trap() {
+  local bats_gather_tests_exit_status=$?
+  trap - ERR EXIT DEBUG
+  if (( bats_gather_tests_exit_status != 0)); then
+    printf "1..1\nnot ok 1 bats-gather-tests\n"
+    # play back traces from test file evaluation
+    bats_replace_filename < "$BATS_TRACE"
+    bats_replace_filename <"$BATS_OUT" | bats_prefix_lines_for_tap_output
+  fi >&2
+  exit "$bats_gather_tests_exit_status"
+}
+
+trap bats_gather_tests_exit_trap EXIT
+
+# prepare tracing for errors during test file evaluation
+BATS_TRACE="$BATS_RUN_TMPDIR/bats-gather-tests.trace"
+touch "$BATS_TRACE"
+
+bats_gather_tests_source_exit_trap() {
+  local bats_gather_tests_source_exit_status=$?
+  trap - ERR EXIT DEBUG
+  if (( bats_gather_tests_source_exit_status != 0)); then
+    bats_get_failure_stack_trace stack_trace
+    # shellcheck disable=SC2154
+    bats_print_stack_trace "${stack_trace[@]}"
+    # TODO: why doesn't this work via ERR trap?
+    # shellcheck disable=SC2154,SC2034
+    BATS_ERROR_STATUS=$bats_gather_tests_source_exit_status
+    bats_print_failed_command "${stack_trace[@]}"
+  fi  >>"$BATS_TRACE"
+  exit "$bats_gather_tests_source_exit_status"
+}
+
+bats_gather_tests_for_file() {
+  local test_names=() test_dupes=() included_tests=() excluded_tests=()
+
+  trap bats_gather_tests_source_exit_trap EXIT
+  bats_setup_tracing
+  bats_set_stacktrace_limit
+
+  # do the actual evaluation for gathering the tests
+  # shellcheck disable=SC1090
+  BATS_TEST_DIRNAME="${filename%/*}" source "$BATS_TEST_SOURCE" 1>>"$BATS_OUT" 2>&1
+
+  if [[ "${#test_dupes[@]}" -ne 0 ]]; then
+    printf 'file_duplicate_test_names="%q"\n' "${test_dupes[*]#$filename$'\t'}"
+  fi
+
+  if [[ -n "$filter_status" ]]; then
+    # save filtered tests to exclude them again in next round
+    for test_line in "${excluded_tests[@]}"; do
+      printf "status-filtered %s %s\n" "$filter_status" "$test_line"
+    done >>"$BATS_RUNLOG_FILE"
+  fi
+
+
+  printf "file_test_count=%d\n" "${#test_names[@]}"
+  printf "file_included_test_count=%d\n" "${#included_tests[@]}"
+  printf "focus_mode=%d\n" "$focus_mode"
+}
+
+focus_mode=0
+total_test_count=0
+total_included_test_count=0
+export BATS_TEST_FILE_NUMBER=0
+
+for filename in "$@"; do
+  (( ++BATS_TEST_FILE_NUMBER ))
+  if [[ ! -f "$filename" ]]; then
+    abort 'Test file "%s" does not exist.\n' "${filename}"
+  fi
+
+  BATS_TEST_FILENAME="$filename"
+  _bats_test_functions_setup -1 # invalid TEST_NUMBER, as this is not a test
+
+  # shellcheck disable=SC2034
+  BATS_TEST_NAME=source
+  bats_preprocess_source # uses BATS_TEST_FILENAME, BATS_TEST_FILE_NUMBER
+
+  file_duplicate_test_names=""
+  file_test_count=0
+  file_included_test_count=0
+  saved_focus_mode=$focus_mode
+
+  # get new values for the variables above
+  if [[ $BASH_VERSION == 4.3.*  ]]; then
+    # Bash 4.3 has function scoping issues when this is run in $() -> work around via file
+    bats_gather_tests_var_transfer_file=$BATS_RUN_TMPDIR/gather-tests-var-transfer
+    (set -eET; bats_gather_tests_for_file >"$bats_gather_tests_var_transfer_file")
+    result=$(<"$bats_gather_tests_var_transfer_file")
+  else
+    # separate retrieval from eval to avoid hiding the exit code
+    result="$(set -eET; bats_gather_tests_for_file)"
+  fi
+
+  eval "$result"
+
+  if [[ -n "$file_duplicate_test_names" ]]; then
+    trap - EXIT # prevent 1..1 from being printed
+    abort 'Duplicate test name(s) in file "%s": %s' "$filename" "$file_duplicate_test_names"
+  fi
+
+  total_test_count=$((total_test_count + file_test_count))
+
+  # did focus mode turn on in this file? (cannot turn off afterwards)
+  if (( saved_focus_mode != focus_mode)); then # -> only count new tests
+    total_included_test_count=$file_included_test_count
+  else # -> count previous tests as well
+    total_included_test_count=$((total_included_test_count + file_included_test_count))
+  fi
+done
+
+if [[ -n "$filter_status" ]]; then
+  if (( total_test_count == 0 && total_included_test_count == 0 )); then
+    printf "There were no tests of status '%s' in the last recorded run.\n" "$filter_status" >&2
+  fi
+fi
+
+# communicate to the caller that we are running in focus mode
+if (( focus_mode )); then
+  printf "focus_mode\n"
+fi

package/libexec/bats-core/bats-preprocess

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+set -e
+
+bats_encode_test_name() {
+  local name="$1"
+  local result='test_'
+  local hex_code
+
+  if [[ ! "$name" =~ [^[:alnum:]\ _-] ]]; then
+    name="${name//_/-5f}"
+    name="${name//-/-2d}"
+    name="${name// /_}"
+    result+="$name"
+  else
+    local length="${#name}"
+    local char i
+
+    for ((i = 0; i < length; i++)); do
+      char="${name:$i:1}"
+      if [[ "$char" == ' ' ]]; then
+        result+='_'
+      elif [[ "$char" =~ [[:alnum:]] ]]; then
+        result+="$char"
+      else
+        printf -v 'hex_code' -- '-%02x' \'"$char"
+        result+="$hex_code"
+      fi
+    done
+  fi
+
+  printf -v "$2" '%s' "$result"
+}
+
+BATS_TEST_PATTERN="^[[:blank:]]*@test[[:blank:]]+(.*[^[:blank:]])[[:blank:]]+\{(.*)\$"
+BATS_TEST_PATTERN_COMMENT="[[:blank:]]*([^[:blank:]()]+)[[:blank:]]*\(?\)?[[:blank:]]+\{[[:blank:]]+#[[:blank:]]*@test[[:blank:]]*\$"
+BATS_COMMENT_COMMAND_PATTERN="^[[:blank:]]*#[[:blank:]]*bats[[:blank:]]+(.*)$"
+BATS_VALID_TAG_PATTERN="[-_:[:alnum:]]+"
+BATS_VALID_TAGS_PATTERN="^ *($BATS_VALID_TAG_PATTERN)?( *, *$BATS_VALID_TAG_PATTERN)* *$"
+
+# shellcheck source=lib/bats-core/common.bash
+source "$BATS_ROOT/$BATS_LIBDIR/bats-core/common.bash"
+
+extract_tags() { # <tag_type/return_var> <tags-string>
+  local -r tag_type=$1 tags_string=$2
+  local -a tags=()
+
+  if [[ $tags_string =~ $BATS_VALID_TAGS_PATTERN ]]; then
+    IFS=, read -ra tags <<<"$tags_string"
+    local -ri length=${#tags[@]}
+    for ((i = 0; i < length; ++i)); do
+      local element="tags[$i]"
+      bats_trim "$element" "${!element}" 2>/dev/null # printf on bash 3 will complain but work anyways
+      if [[ -z "${!element}" && -n "${CHECK_BATS_COMMENT_COMMANDS:-}" ]]; then
+        printf "%s:%d: Error: Invalid %s: '%s'. " "$test_file" "$line_number" "$tag_type" "$tags_string"
+        printf "Tags must not be empty. Please remove redundant commas!\n"
+        exit_code=1
+      fi
+    done
+  elif [[ -n "${CHECK_BATS_COMMENT_COMMANDS:-}" ]]; then
+    printf "%s:%d: Error: Invalid %s: '%s'. " "$test_file" "$line_number" "$tag_type" "$tags_string"
+    printf "Valid tags must match %s and be separated with comma (and optional spaces)\n" "$BATS_VALID_TAG_PATTERN"
+    exit_code=1
+  fi >&2
+  if ((${#tags[@]} > 0)); then
+    eval "$tag_type=(\"\${tags[@]}\")"
+  else
+    eval "$tag_type=()"
+  fi
+}
+
+test_file="$1"
+test_tags=()
+file_tags=()
+line_number=0
+exit_code=0
+EMPTY_BODY_REGEX='[[:space:]]*\}'
+IFS=,
+{
+  while IFS= read -r line; do
+    ((++line_number))
+    line="${line//$'\r'/}"
+    if [[ "$line" =~ $BATS_TEST_PATTERN ]] || [[ "$line" =~ $BATS_TEST_PATTERN_COMMENT ]]; then
+      name="${BASH_REMATCH[1]#[\'\"]}"
+      name="${name%[\'\"]}"
+      body="${BASH_REMATCH[2]:-}"
+      bats_encode_test_name "$name" 'encoded_name'
+
+      if [[ "$body" =~ $EMPTY_BODY_REGEX ]]; then
+        # ":;" is needed for empty {} after test
+        lead=':; '
+      else
+        # avoid injecting non user code into tests
+        lead=''
+      fi
+
+      # shellcheck disable=SC2154 # encoded_name is declare via bats_encode_test_name
+      printf 'bats_test_function --description %q  --tags "%s" --tags "%s" -- %s;' "$name" "${test_tags[*]-}" "${file_tags[*]-}" "$encoded_name"
+      printf '%s() { %s%s\n' "${encoded_name:?}" "$lead" "$body" || :
+
+      test_tags=() # reset test tags for next test
+    else
+      if [[ "$line" =~ $BATS_COMMENT_COMMAND_PATTERN ]]; then
+        command=${BASH_REMATCH[1]}
+        case $command in
+        'test_tags='*)
+          extract_tags test_tags "${command#test_tags=}"
+          ;;
+        'file_tags='*)
+          extract_tags file_tags "${command#file_tags=}"
+          ;;
+        esac
+      fi
+      printf '%s\n' "$line"
+    fi
+  done
+} <<<"$(<"$test_file")"$'\n'
+
+exit $exit_code

package/man/Makefile

@@ -0,0 +1,23 @@
+# Makefile
+#
+# bats-core manpages
+#
+RONN := ronn -W
+PAGES := bats.1 bats.7
+ORG := bats-core
+MANUAL := 'Bash Automated Testing System'
+ISOFMT := $(shell date -I)
+RM := rm -f
+
+.PHONY: all clean
+
+all: $(PAGES)
+
+bats.1: bats.1.ronn
+	$(RONN) --date=$(ISOFMT) --manual=$(MANUAL) --organization=$(ORG) --roff $<
+
+bats.7: bats.7.ronn
+	$(RONN) --date=$(ISOFMT) --manual=$(MANUAL) --organization=$(ORG) --roff $<
+
+clean:
+	$(RM) $(PAGES)

package/man/README.md

@@ -0,0 +1,5 @@
+Bats man pages are generated with [Ronn](http://rtomayko.github.io/ronn/).
+
+After making changes to `bats.1.ronn` or `bats.7.ronn`, run `make` in
+this directory to generate `bats.1` and `bats.7`. **Do not edit the
+`bats.1` or `bats.7` files directly.**

package/man/bats.1

@@ -0,0 +1,143 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "BATS" "1" "July 2026" "bats-core" "Bash Automated Testing System"
+.SH "NAME"
+\fBbats\fR \- Bash Automated Testing System
+.SH "SYNOPSIS"
+Usage: bats [OPTIONS] \fItests\fR bats [\-h | \-v]
+.P
+\fItests\fR is the path to a Bats test file, or the path to a directory containing Bats test files (ending with "\.bats")
+.SH "DESCRIPTION"
+Bats is a TAP\-compliant testing framework for Bash\. It provides a simple way to verify that the UNIX programs you write behave as expected\.
+.P
+A Bats test file is a Bash script with special syntax for defining test cases\. Under the hood, each test case is just a function with a description\.
+.P
+Test cases consist of standard shell commands\. Bats makes use of Bash's \fBerrexit\fR (\fBset \-e\fR) option when running test cases\. If every command in the test case exits with a \fB0\fR status code (success), the test passes\. In this way, each line is an assertion of truth\.
+.P
+See \fBbats\fR(7) for more information on writing Bats tests\.
+.SH "RUNNING TESTS"
+To run your tests, invoke the \fBbats\fR interpreter with a path to a test file\. The file's test cases are run sequentially and in isolation\. If all the test cases pass, \fBbats\fR exits with a \fB0\fR status code\. If there are any failures, \fBbats\fR exits with a \fB1\fR status code\.
+.P
+You can invoke the \fBbats\fR interpreter with multiple test file arguments, or with a path to a directory containing multiple \fB\.bats\fR files\. Bats will run each test file individually and aggregate the results\. If any test case fails, \fBbats\fR exits with a \fB1\fR status code\.
+.SH "FILTERING TESTS"
+There are multiple mechanisms to filter which tests to execute:
+.IP "\(bu" 4
+\fB\-\-filter <regex>\fR to filter by test name
+.IP "\(bu" 4
+\fB\-\-filter\-status <status>\fR to filter by the test's status in the last run
+.IP "\(bu" 4
+\fB\-\-filter\-tags <tag\-list>\fR to filter by the tags of a test
+.IP "" 0
+.SH "\-\-FILTER\-TAGS <var>TAG\-LIST</var>"
+Tags can be used for finegrained filtering of which tests to run via \fB\-\-filter\-tags\fR\. This accepts a comma separated list of tags\. Only tests that match all of these tags will be executed\. For example, \fBbats \-\-filter\-tags a,b,c\fR will pick up tests with tags \fBa,b,c\fR, but not tests that miss one or more of those tags\.
+.P
+Additionally, you can specify negative tags via \fBbats \-\-filter\-tags a,!b,c\fR, which now won't match tests with tags \fBa,b,c\fR, due to the \fBb\fR, but will select \fBa,c\fR\. To put it more formally, \fB\-\-filter\-tags\fR is a boolean conjunction\.
+.P
+To allow for more complex queries, you can specify multiple \fB\-\-filter\-tags\fR\. A test will be executed, if it matches at least one of them\. This means multiple \fB\-\-filter\-tags\fR form a boolean disjunction\.
+.P
+A query of \fB\-\-filter\-tags a,!b \-\-filter\-tags b,c\fR can be translated to: Execute only tests that (have tag a, but not tag b) or (have tag b and c)\.
+.P
+An empty tag list matches tests without tags\.
+.SH "OPTIONS"
+.IP "\(bu" 4
+\fB\-\-abort\fR: Stop execution of suite on first failed test
+.IP "\(bu" 4
+\fB\-\-allow\-empty\-suite\fR: Exit with code 0 (instead of the default code 1) when no tests are found\. Can also be set via \fB$BATS_ALLOW_EMPTY_SUITE\fR (to any non\-empty value), which keeps compatibility with Bats versions that don't know this flag\.
+.IP "\(bu" 4
+\fB\-c\fR, \fB\-\-count\fR: Count the number of test cases without running any tests
+.IP "\(bu" 4
+\fB\-\-code\-quote\-style <style>\fR: A two character string of code quote delimiters or \fBcustom\fR which requires setting \fB$BATS_BEGIN_CODE_QUOTE\fR and \fB$BATS_END_CODE_QUOTE\fR\. Can also be set via \fB$BATS_CODE_QUOTE_STYLE\fR\.
+.IP "\(bu" 4
+\fB\-\-line\-reference\-format\fR Controls how file/line references e\.g\. in stack traces are printed:
+.IP "\(bu" 4
+comma_line (default): a\.bats, line 1
+.IP "\(bu" 4
+colon: a\.bats:1
+.IP "\(bu" 4
+uri: file:///tests/a\.bats:1
+.IP "\(bu" 4
+custom: provide your own via defining bats_format_file_line_reference_custom with parameters \fIfilename\fR \fIline\fR, store via \fBprintf \-v "$output"\fR
+.IP "" 0
+
+.IP "\(bu" 4
+\fB\-\-errexit\fR: Enable errexit (\fBset \-e\fR) for commands run in \fBrun\fR
+.IP "\(bu" 4
+\fB\-f\fR, \fB\-\-filter <regex>\fR: Filter test cases by names matching the regular expression
+.IP "\(bu" 4
+\fB\-F\fR, \fB\-\-formatter <type>\fR: Switch between formatters: pretty (default), tap (default w/o term), tap13, junit, \fB/<absolute path to formatter>\fR
+.IP "\(bu" 4
+\fB\-\-filter\-status <status>\fR: Only run tests with the given status in the last completed (no CTRL+C/SIGINT) run\. Valid \fIstatus\fR values are: failed \- runs tests that failed or were not present in the last run missed \- runs tests that were not present in the last run
+.IP "\(bu" 4
+\fB\-\-filter\-tags <comma\-separated\-tag\-list>\fR: Only run tests that match all the tags in the list (\fB&&\fR)\. You can negate a tag via prepending \fB!\fR\. Specifying this flag multiple times allows for logical or (\fB||\fR): \fB\-\-filter\-tags A,B \-\-filter\-tags A,!C\fR matches tags \fB(A && B) || (A && !C)\fR
+.IP "\(bu" 4
+\fB\-\-gather\-test\-outputs\-in <directory>\fR: Gather the output of failing \fIand\fR passing tests as files in directory
+.IP "\(bu" 4
+\fB\-h\fR, \fB\-\-help\fR: Display this help message
+.IP "\(bu" 4
+\fB\-j\fR, \fB\-\-jobs <jobs>\fR: Number of parallel jobs (requires GNU parallel)
+.IP "\(bu" 4
+\fB\-\-negative\-filter <regex>\fR: Only run tests that do not match the regular expression
+.IP "\(bu" 4
+\fB\-\-no\-tempdir\-cleanup\fR: Preserve test output temporary directory
+.IP "\(bu" 4
+\fB\-\-no\-parallelize\-across\-files\fR: Serialize test file execution instead of running them in parallel (requires \-\-jobs >1)
+.IP "\(bu" 4
+\fB\-\-no\-parallelize\-within\-files\fR: Serialize test execution within files instead of running them in parallel (requires \-\-jobs >1)
+.IP "\(bu" 4
+\fB\-\-parallel\-binary\-name <name>\fR: Name of parallel binary
+.IP "\(bu" 4
+\fB\-\-report\-formatter <type>\fR: Switch between reporters (same options as \-\-formatter)
+.IP "\(bu" 4
+\fB\-o\fR, \fB\-\-output <dir>\fR: Directory to write report files
+.IP "\(bu" 4
+\fB\-p\fR, \fB\-\-pretty\fR: Shorthand for "\-\-formatter pretty"
+.IP "\(bu" 4
+\fB\-\-print\-output\-on\-failure\fR: Automatically print the value of \fB$output\fR on failed tests
+.IP "\(bu" 4
+\fB\-r\fR, \fB\-\-recursive\fR: Include tests in subdirectories
+.IP "\(bu" 4
+\fB\-\-show\-output\-of\-passing\-tests\fR: Print output of passing tests
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-tap\fR: Shorthand for "\-\-formatter tap"
+.IP "\(bu" 4
+\fB\-T\fR, \fB\-\-timing\fR: Add timing information to tests
+.IP "\(bu" 4
+\fB\-x\fR, \fB\-\-trace\fR: Print test commands as they are executed (like \fBset \-x\fR)
+.IP "\(bu" 4
+\fB\-\-verbose\-run\fR: Make \fBrun\fR print \fB$output\fR by default
+.IP "\(bu" 4
+\fB\-v\fR, \fB\-\-version\fR: Display the version number
+.IP "" 0
+.SH "OUTPUT"
+When you run Bats from a terminal, you'll see output as each test is performed, with a check\-mark next to the test's name if it passes or an "X" if it fails\.
+.IP "" 4
+.nf
+$ bats addition\.bats
+ ✓ addition using bc
+ ✓ addition using dc
+
+2 tests, 0 failures
+.fi
+.IP "" 0
+.P
+If Bats is not connected to a terminal\-\-in other words, if you run it from a continuous integration system or redirect its output to a file\-\-the results are displayed in human\-readable, machine\-parsable TAP format\. You can force TAP output from a terminal by invoking Bats with the \fB\-\-tap\fR option\.
+.IP "" 4
+.nf
+$ bats \-\-tap addition\.bats
+1\.\.2
+ok 1 addition using bc
+ok 2 addition using dc
+.fi
+.IP "" 0
+.SH "EXIT STATUS"
+The \fBbats\fR interpreter exits with a value of \fB0\fR if all test cases pass, or \fB1\fR if one or more test cases fail\.
+.SH "SEE ALSO"
+Bats wiki: \fIhttps://github\.com/bats\-core/bats\-core/wiki/\fR
+.P
+\fBbash\fR(1), \fBbats\fR(7)
+.SH "COPYRIGHT"
+(c) 2017\-2022 bats\-core organization
+.br
+(c) 2011\-2016 Sam Stephenson
+.P
+Bats is released under the terms of an MIT\-style license\.