@bats-hardened/bats 1.14.1-alpha02

package/lib/bats-core/formatter.bash

@@ -0,0 +1,151 @@
+#!/usr/bin/env bash
+
+# reads (extended) bats tap streams from stdin and calls callback functions for each line
+#
+# Segmenting functions
+# ====================
+# bats_tap_stream_plan <number of tests>                                      -> when the test plan is encountered
+# bats_tap_stream_suite <file name>                                           -> when a new file is begun WARNING: extended only
+# bats_tap_stream_begin <test index> <test name>                              -> when a new test is begun WARNING: extended only
+#
+# Test result functions
+# =====================
+# If timing was enabled, BATS_FORMATTER_TEST_DURATION will be set to their duration in milliseconds
+# bats_tap_stream_ok <test index> <test name>                                 -> when a test was successful
+# bats_tap_stream_not_ok <test index> <test name>                             -> when a test has failed. If the failure was due to a timeout,
+#                                                                                BATS_FORMATTER_TEST_TIMEOUT is set to the timeout duration in seconds
+# bats_tap_stream_skipped <test index> <test name> <skip reason>              -> when a test was skipped
+#
+# Context functions
+# =================
+# bats_tap_stream_comment <comment text without leading '# '> <scope>         -> when a comment line was encountered,
+#                                                                                scope tells the last encountered of plan, begin, ok, not_ok, skipped, suite
+# bats_tap_stream_unknown <full line> <scope>                                 -> when a line is encountered that does not match the previous entries,
+#                                                                                scope @see bats_tap_stream_comment
+# forwards all input as is, when there is no TAP test plan header
+function bats_parse_internal_extended_tap() {
+  local header_pattern='[0-9]+\.\.[0-9]+'
+  IFS= read -r header
+
+  if [[ "$header" =~ $header_pattern ]]; then
+    bats_tap_stream_plan "${header:3}"
+  else
+    # If the first line isn't a TAP plan, print it and pass the rest through
+    printf '%s\n' "$header"
+    exec cat
+  fi
+
+  ok_line_regexpr="ok ([0-9]+) (.*)"
+  skip_line_regexpr="ok ([0-9]+) (.*) # skip( (.*))?$"
+  timeout_line_regexpr="not ok ([0-9]+) (.*) # timeout after ([0-9]+)s$"
+  not_ok_line_regexpr="not ok ([0-9]+) (.*)"
+
+  timing_expr="in ([0-9]+)ms$"
+  local test_name begin_index last_begin_index try_index ok_index not_ok_index index scope
+  begin_index=0
+  last_begin_index=-1
+  try_index=0
+  index=0
+  scope=plan
+  while IFS= read -r line; do
+    unset BATS_FORMATTER_TEST_DURATION BATS_FORMATTER_TEST_TIMEOUT
+    case "$line" in
+    'begin '*) # this might only be called in extended tap output
+      scope=begin
+      begin_index=${line#begin }
+      begin_index=${begin_index%% *}
+      if [[ $begin_index == "$last_begin_index" ]]; then
+        (( ++try_index ))
+      else
+        try_index=0
+      fi
+      test_name="${line#begin "$begin_index" }"
+      bats_tap_stream_begin "$begin_index" "$test_name"
+      ;;
+    'ok '*)
+      ((++index))
+      if [[ "$line" =~ $ok_line_regexpr ]]; then
+        ok_index="${BASH_REMATCH[1]}"
+        test_name="${BASH_REMATCH[2]}"
+        if [[ "$line" =~ $skip_line_regexpr ]]; then
+          scope=skipped
+          test_name="${BASH_REMATCH[2]}" # cut off name before "# skip"
+          local skip_reason="${BASH_REMATCH[4]}"
+          if [[ "$test_name" =~ $timing_expr ]]; then
+            local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}"
+            test_name="${test_name% in "${BATS_FORMATTER_TEST_DURATION}"ms}"
+            bats_tap_stream_skipped "$ok_index" "$test_name" "$skip_reason"
+          else
+            bats_tap_stream_skipped "$ok_index" "$test_name" "$skip_reason"
+          fi
+        else
+          scope=ok
+          if [[ "$line" =~ $timing_expr ]]; then
+            local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}"
+            bats_tap_stream_ok "$ok_index" "${test_name% in "${BASH_REMATCH[1]}"ms}"
+          else
+            bats_tap_stream_ok "$ok_index" "$test_name"
+          fi
+        fi
+      else
+        printf "ERROR: could not match ok line: %s" "$line" >&2
+        exit 1
+      fi
+      ;;
+    'not ok '*)
+      ((++index))
+      scope=not_ok
+      if [[ "$line" =~ $not_ok_line_regexpr ]]; then
+        not_ok_index="${BASH_REMATCH[1]}"
+        test_name="${BASH_REMATCH[2]}"
+        if [[ "$line" =~ $timeout_line_regexpr ]]; then
+          not_ok_index="${BASH_REMATCH[1]}"
+          test_name="${BASH_REMATCH[2]}"
+          # shellcheck disable=SC2034 # used in bats_tap_stream_ok
+          local BATS_FORMATTER_TEST_TIMEOUT="${BASH_REMATCH[3]}"
+        fi
+        if [[ "$test_name" =~ $timing_expr ]]; then
+          # shellcheck disable=SC2034 # used in bats_tap_stream_ok
+          local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}"
+          test_name="${test_name% in "${BASH_REMATCH[1]}"ms}"
+        fi
+        bats_tap_stream_not_ok "$not_ok_index" "$test_name"
+      else
+        printf "ERROR: could not match not ok line: %s" "$line" >&2
+        exit 1
+      fi
+      ;;
+    '# '*)
+      bats_tap_stream_comment "${line:2}" "$scope"
+      ;;
+    '#')
+      bats_tap_stream_comment "" "$scope"
+      ;;
+    'suite '*)
+      scope=suite
+      # pass on the
+      bats_tap_stream_suite "${line:6}"
+      ;;
+    *)
+      bats_tap_stream_unknown "$line" "$scope"
+      ;;
+    esac
+  done
+}
+
+normalize_base_path() { # <target variable> <base path>
+  # the relative path root to use for reporting filenames
+  # this is mainly intended for suite mode, where this will be the suite root folder
+  local base_path="$2"
+  # use the containing directory when --base-path is a file
+  if [[ ! -d "$base_path" ]]; then
+    base_path="$(dirname "$base_path")"
+  fi
+  # get the absolute path
+  base_path="$(cd "$base_path" && pwd)"
+  # ensure the path ends with / to strip that later on
+  if [[ "${base_path}" != *"/" ]]; then
+    base_path="$base_path/"
+  fi
+  printf -v "$1" "%s" "$base_path"
+}

package/lib/bats-core/preprocessing.bash

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+bats_export_preprocess_source_BATS_TEST_SOURCE() {
+  # export to make it visible to bats_evaluate_preprocessed_source
+  # since the latter runs in bats-exec-test's bash while this runs in bats-exec-file's
+  export BATS_TEST_SOURCE="$BATS_RUN_TMPDIR/${BATS_TEST_FILE_NUMBER?}-${BATS_TEST_FILENAME##*/}.src"
+}
+
+bats_preprocess_source() { # index
+  bats_export_preprocess_source_BATS_TEST_SOURCE
+  # shellcheck disable=SC2153
+  CHECK_BATS_COMMENT_COMMANDS=1 "$BATS_ROOT/libexec/bats-core/bats-preprocess" "$BATS_TEST_FILENAME" >"$BATS_TEST_SOURCE"
+}
+
+bats_evaluate_preprocessed_source() {
+  # Dynamically loaded user files provided outside of Bats.
+  # shellcheck disable=SC1090
+  source "${BATS_TEST_SOURCE?}"
+}

package/lib/bats-core/semaphore.bash

@@ -0,0 +1,113 @@
+#!/usr/bin/env bash
+
+bats_run_under_flock() {
+  flock "$BATS_SEMAPHORE_DIR" "$@"
+}
+
+bats_run_under_shlock() {
+      local lockfile="$BATS_SEMAPHORE_DIR/shlock.lock"
+      while ! shlock -p $$ -f "$lockfile"; do
+        sleep 1
+      done
+      # we got the lock now, execute the command
+      "$@"
+      local status=$?
+      # free the lock
+      rm -f "$lockfile"
+      return $status
+    }
+
+# setup the semaphore environment for the loading file
+bats_semaphore_setup() {
+  export -f bats_semaphore_get_free_slot_count
+  export -f bats_semaphore_acquire_while_locked
+  export BATS_SEMAPHORE_DIR="$BATS_RUN_TMPDIR/semaphores"
+
+  if command -v flock >/dev/null; then
+    BATS_LOCKING_IMPLEMENTATION=flock
+  elif command -v shlock >/dev/null; then
+    BATS_LOCKING_IMPLEMENTATION=shlock
+  else
+    printf "ERROR: flock/shlock is required for parallelization within files!\n" >&2
+    exit 1
+  fi
+}
+
+# $1 - output directory for stdout/stderr
+# $@ - command to run
+# run the given command in a semaphore
+# block when there is no free slot for the semaphore
+# when there is a free slot, run the command in background
+# gather the output of the command in files in the given directory
+bats_semaphore_run() {
+  local output_dir=$1
+  shift
+  local semaphore_slot
+  semaphore_slot=$(bats_semaphore_acquire_slot)
+  bats_semaphore_release_wrapper "$output_dir" "$semaphore_slot" "$@" &
+  printf "%d\n" "$!"
+}
+
+# $1 - output directory for stdout/stderr
+# $@ - command to run
+# this wraps the actual function call to install some traps on exiting
+bats_semaphore_release_wrapper() {
+  local output_dir="$1"
+  local semaphore_name="$2"
+  shift 2 # all other parameters will be use for the command to execute
+
+  # shellcheck disable=SC2064 # we want to expand the semaphore_name right now!
+  trap "status=$?; bats_semaphore_release_slot '$semaphore_name'; exit $status" EXIT
+
+  mkdir -p "$output_dir"
+  "$@" 2>"$output_dir/stderr" >"$output_dir/stdout"
+  local status=$?
+
+  # bash bug: the exit trap is not called for the background process
+  bats_semaphore_release_slot "$semaphore_name"
+  trap - EXIT # avoid calling release twice
+  return $status
+}
+
+bats_semaphore_acquire_while_locked() {
+  if [[ $(bats_semaphore_get_free_slot_count) -gt 0 ]]; then
+    local slot=0
+    while [[ -e "$BATS_SEMAPHORE_DIR/slot-$slot" ]]; do
+      ((++slot))
+    done
+    if [[ $slot -lt $BATS_SEMAPHORE_NUMBER_OF_SLOTS ]]; then
+      touch "$BATS_SEMAPHORE_DIR/slot-$slot" && printf "%d\n" "$slot" && return 0
+    fi
+  fi
+  return 1
+}
+
+# block until a semaphore slot becomes free
+# prints the number of the slot that it received
+bats_semaphore_acquire_slot() {
+  mkdir -p "$BATS_SEMAPHORE_DIR"
+  # wait for a slot to become free
+  # TODO: avoid busy waiting by using signals -> this opens op prioritizing possibilities as well
+  while true; do
+    # don't lock for reading, we are fine with spuriously getting no free slot
+    if [[ $(bats_semaphore_get_free_slot_count) -gt 0 ]]; then
+      bats_run_under_"$BATS_LOCKING_IMPLEMENTATION" \
+        bash -c bats_semaphore_acquire_while_locked \
+      && break
+    fi
+    sleep 1
+  done
+}
+
+bats_semaphore_release_slot() {
+  # we don't need to lock this, since only our process owns this file
+  # and freeing a semaphore cannot lead to conflicts with others
+  rm "$BATS_SEMAPHORE_DIR/slot-$1" # this will fail if we had not acquired a semaphore!
+}
+
+bats_semaphore_get_free_slot_count() {
+  # find might error out without returning something useful when a file is deleted,
+  # while the directory is traversed ->  only continue when there was no error
+  until used_slots=$(find "$BATS_SEMAPHORE_DIR" -name 'slot-*' 2>/dev/null | wc -l); do :; done
+  echo $((BATS_SEMAPHORE_NUMBER_OF_SLOTS - used_slots))
+}