Merge pull request #239 from djpohly/strictmode

Support Bash "strict mode" (and fix one unit test)

Author: Chemaclass

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Add `--upgrade` option to `./bashunit`
 - Remove support to deprecated `setUp`, `tearDown`, `setUpBeforeScript` and `tearDownAfterScript` functions
 - Optimize test execution time
+- Support tests written using Bash's errexit (-e), nounset (-u), and pipefail options ("unofficial strict mode").
 
 ## [0.10.1](https://github.com/TypedDevs/bashunit/compare/0.10.0...0.10.1) - 2023-11-13
 

bashunit

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -euo pipefail
 
 # shellcheck disable=SC2034
 declare -r BASHUNIT_VERSION="0.10.1"

src/console_results.sh

@@ -15,18 +15,18 @@ function console_results::render_result() {
   echo ""
 
   local total_tests=0
-  ((total_tests+=$(state::get_tests_passed)))
-  ((total_tests+=$(state::get_tests_skipped)))
-  ((total_tests+=$(state::get_tests_incomplete)))
-  ((total_tests+=$(state::get_tests_snapshot)))
-  ((total_tests+=$(state::get_tests_failed)))
+  ((total_tests += $(state::get_tests_passed))) || true
+  ((total_tests += $(state::get_tests_skipped))) || true
+  ((total_tests += $(state::get_tests_incomplete))) || true
+  ((total_tests += $(state::get_tests_snapshot))) || true
+  ((total_tests += $(state::get_tests_failed))) || true
 
   local total_assertions=0
-  ((total_assertions+=$(state::get_assertions_passed)))
-  ((total_assertions+=$(state::get_assertions_skipped)))
-  ((total_assertions+=$(state::get_assertions_incomplete)))
-  ((total_assertions+=$(state::get_assertions_snapshot)))
-  ((total_assertions+=$(state::get_assertions_failed)))
+  ((total_assertions += $(state::get_assertions_passed))) || true
+  ((total_assertions += $(state::get_assertions_skipped))) || true
+  ((total_assertions += $(state::get_assertions_incomplete))) || true
+  ((total_assertions += $(state::get_assertions_snapshot))) || true
+  ((total_assertions += $(state::get_assertions_failed))) || true
 
   printf "%sTests:     %s" "$_COLOR_FAINT" "$_COLOR_DEFAULT"
   if [[ "$(state::get_tests_passed)" -gt 0 ]] || [[ "$(state::get_assertions_passed)" -gt 0 ]]; then
@@ -111,7 +111,7 @@ function console_results::print_execution_time() {
 }
 
 function console_results::print_successful_test() {
-  ((_SUCCESSFUL_TEST_COUNT++))
+  ((_SUCCESSFUL_TEST_COUNT++)) || true
 
   if [[ "$SIMPLE_OUTPUT" == true ]]; then
     if (( _SUCCESSFUL_TEST_COUNT % 50 != 0 )); then
@@ -121,7 +121,7 @@ function console_results::print_successful_test() {
     fi
   else
     local test_name=$1
-    local data=$2
+    local data=${2-}
 
     if [[ -z "$data" ]]; then
       printf "%s✓ Passed%s: %s\n" "$_COLOR_PASSED" "$_COLOR_DEFAULT" "${test_name}"
@@ -163,7 +163,7 @@ function console_results::print_failed_snapshot_test() {
 
 function console_results::print_skipped_test() {
   local test_name=$1
-  local reason=$2
+  local reason=${2-}
 
   printf "${_COLOR_SKIPPED}↷ Skipped${_COLOR_DEFAULT}: %s\n" "${test_name}"
 
@@ -174,7 +174,7 @@ function console_results::print_skipped_test() {
 
 function console_results::print_incomplete_test() {
   local test_name=$1
-  local pending=$2
+  local pending=${2-}
 
   printf "${_COLOR_INCOMPLETE}✒ Incomplete${_COLOR_DEFAULT}: %s\n" "${test_name}"
 

src/env_configuration.sh

@@ -5,30 +5,10 @@ set -o allexport
 [[ -f ".env" ]] && source .env set
 set +o allexport
 
-if [[ -z "$PARALLEL_RUN" ]]; then
-  PARALLEL_RUN=$_DEFAULT_PARALLEL_RUN
-fi
-
-if [[ -z "$SHOW_HEADER" ]]; then
-  SHOW_HEADER=$_DEFAULT_SHOW_HEADER
-fi
-
-if [[ -z "$HEADER_ASCII_ART" ]]; then
-  HEADER_ASCII_ART=$_DEFAULT_HEADER_ASCII_ART
-fi
-
-if [[ -z "$SIMPLE_OUTPUT" ]]; then
-  SIMPLE_OUTPUT=$_DEFAULT_SIMPLE_OUTPUT
-fi
-
-if [[ -z "$STOP_ON_FAILURE" ]]; then
-  STOP_ON_FAILURE=$_DEFAULT_STOP_ON_FAILURE
-fi
-
-if [[ -z "$SHOW_EXECUTION_TIME" ]]; then
-  SHOW_EXECUTION_TIME=$_DEFAULT_SHOW_EXECUTION_TIME
-fi
-
-if [[ -z "$DEFAULT_PATH" ]]; then
-  DEFAULT_PATH=$_DEFAULT_DEFAULT_PATH
-fi
+: "${PARALLEL_RUN:=$_DEFAULT_PARALLEL_RUN}"
+: "${SHOW_HEADER:=$_DEFAULT_SHOW_HEADER}"
+: "${HEADER_ASCII_ART:=$_DEFAULT_HEADER_ASCII_ART}"
+: "${SIMPLE_OUTPUT:=$_DEFAULT_SIMPLE_OUTPUT}"
+: "${STOP_ON_FAILURE:=$_DEFAULT_STOP_ON_FAILURE}"
+: "${SHOW_EXECUTION_TIME:=$_DEFAULT_SHOW_EXECUTION_TIME}"
+: "${DEFAULT_PATH:=$_DEFAULT_DEFAULT_PATH}"

src/helpers.sh

@@ -8,7 +8,7 @@ declare -r BASHUNIT_GIT_REPO="https://github.com/TypedDevs/bashunit"
 # @return string Eg: "Some logic camelCase"
 #
 function helper::normalize_test_function_name() {
-  local original_function_name="$1"
+  local original_function_name="${1-}"
   local result
 
   # Remove "test_" prefix
@@ -85,7 +85,9 @@ function helper::get_functions_to_run() {
 # @param $1 string Eg: "do_something"
 #
 function helper::execute_function_if_exists() {
-  "$1" 2>/dev/null
+  if [[ "$(type -t "$1")" == "function" ]]; then
+    "$1" 2>/dev/null
+  fi
 }
 
 #
@@ -133,6 +135,7 @@ function helper::get_provider_data() {
     grep -B 1 "function $function_name()" "$script" |\
     grep "# data_provider " |\
     sed -E -e 's/\ *# data_provider (.*)$/\1/g'\
+    || true
   )
 
   if [[ -n "$data_provider_function" ]]; then

src/runner.sh

@@ -50,7 +50,7 @@ function runner::call_test_functions() {
       echo "Running $script"
     fi
 
-    helper::check_duplicate_functions "$script"
+    helper::check_duplicate_functions "$script" || true
 
     for function_name in "${functions_to_run[@]}"; do
       local provider_data=()
@@ -107,16 +107,16 @@ function runner::parse_execution_result() {
     sed -E -e 's/.*##ASSERTIONS_SNAPSHOT=([0-9]*)##.*/\1/g'\
   )
 
-  _ASSERTIONS_PASSED=$((_ASSERTIONS_PASSED + assertions_passed))
-  _ASSERTIONS_FAILED=$((_ASSERTIONS_FAILED + assertions_failed))
-  _ASSERTIONS_SKIPPED=$((_ASSERTIONS_SKIPPED + assertions_skipped))
-  _ASSERTIONS_INCOMPLETE=$((_ASSERTIONS_INCOMPLETE + assertions_incomplete))
-  _ASSERTIONS_SNAPSHOT=$((_ASSERTIONS_SNAPSHOT + assertions_snapshot))
+  ((_ASSERTIONS_PASSED += assertions_passed)) || true
+  ((_ASSERTIONS_FAILED += assertions_failed)) || true
+  ((_ASSERTIONS_SKIPPED += assertions_skipped)) || true
+  ((_ASSERTIONS_INCOMPLETE += assertions_incomplete)) || true
+  ((_ASSERTIONS_SNAPSHOT += assertions_snapshot)) || true
 }
 
 function runner::run_test() {
   local function_name="$1"
-  local data="$2"
+  local data="${2-}"
   local current_assertions_failed
   current_assertions_failed="$(state::get_assertions_failed)"
   local current_assertions_snapshot

src/skip_todo.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 function skip() {
-  local reason=$1
+  local reason=${1-}
   local label
   label="$(helper::normalize_test_function_name "${FUNCNAME[1]}")"
 
@@ -11,7 +11,7 @@ function skip() {
 }
 
 function todo() {
-  local pending=$1
+  local pending=${1-}
   local label
   label="$(helper::normalize_test_function_name "${FUNCNAME[1]}")"
 

tests/acceptance/bashunit.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -euo pipefail
 
 function set_up_before_script() {
   TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"

tests/acceptance/bashunit_execution_error_test.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -euo pipefail
 
 function set_up_before_script() {
   TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"

tests/acceptance/bashunit_fail_test.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -euo pipefail
 
 function set_up_before_script() {
   TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"