fix: test doubles when running tests in parallel by isolating spy files per test

Author: Chemaclass

CHANGELOG.md

@@ -3,7 +3,6 @@
 ## Unreleased
 
 - Fix asserts on test doubles in subshell
-- Fix test doubles when running tests in parallel
 - Allow interpolating arguments in data providers output
 
 ## [0.19.1](https://github.com/TypedDevs/bashunit/compare/0.19.0...0.19.1) - 2025-05-23

docs/test-doubles.md

@@ -4,6 +4,9 @@ When creating tests, you might need to override existing function to be able to
 
 Temporary files created by spies are isolated per test run, so they work reliably when executing tests in parallel.
 
+Spies record their calls in temporary files scoped to each test run.
+This avoids clashes between processes and allows spies to work reliably when tests execute in parallel using `BASHUNIT_PARALLEL_RUN`.
+
 ## mock
 > `mock "function" "body"`
 

src/runner.sh

@@ -141,7 +141,11 @@ function runner::run_test() {
   # race conditions when running tests in parallel.
   local sanitized_fn_name
   sanitized_fn_name="$(helper::normalize_variable_name "$fn_name")"
-  export BASHUNIT_CURRENT_TEST_ID="${sanitized_fn_name}_$$_$(random_str 6)"
+  if env::is_parallel_run_enabled; then
+    export BASHUNIT_CURRENT_TEST_ID="${sanitized_fn_name}_$$_$(random_str 6)"
+  else
+    export BASHUNIT_CURRENT_TEST_ID="${sanitized_fn_name}_$$"
+  fi
 
   local interpolated_fn_name="$(helper::interpolate_function_name "$fn_name" "$@")"
   local current_assertions_failed="$(state::get_assertions_failed)"
@@ -344,40 +348,45 @@ function runner::parse_result_parallel() {
 }
 
 # shellcheck disable=SC2295
-function runner::_extract_field_value() {
-  local line=$1
-  local key=$2
-
-  local value="${line##*##${key}=}"
-  value="${value%%##*}"
-
-  echo "$value"
-}
-
 function runner::parse_result_sync() {
   local fn_name=$1
   local execution_result=$2
 
-  local trimmed="${execution_result%$'\n'}"
-  local result_line="${trimmed##*$'\n'}"
-
-  local assertions_failed
-  assertions_failed=$(runner::_extract_field_value "$result_line" "ASSERTIONS_FAILED")
+  local assertions_failed=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##ASSERTIONS_FAILED=([0-9]*)##.*/\1/g'\
+  )
 
-  local assertions_passed
-  assertions_passed=$(runner::_extract_field_value "$result_line" "ASSERTIONS_PASSED")
+  local assertions_passed=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##ASSERTIONS_PASSED=([0-9]*)##.*/\1/g'\
+  )
 
-  local assertions_skipped
-  assertions_skipped=$(runner::_extract_field_value "$result_line" "ASSERTIONS_SKIPPED")
+  local assertions_skipped=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##ASSERTIONS_SKIPPED=([0-9]*)##.*/\1/g'\
+  )
 
-  local assertions_incomplete
-  assertions_incomplete=$(runner::_extract_field_value "$result_line" "ASSERTIONS_INCOMPLETE")
+  local assertions_incomplete=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##ASSERTIONS_INCOMPLETE=([0-9]*)##.*/\1/g'\
+  )
 
-  local assertions_snapshot
-  assertions_snapshot=$(runner::_extract_field_value "$result_line" "ASSERTIONS_SNAPSHOT")
+  local assertions_snapshot=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##ASSERTIONS_SNAPSHOT=([0-9]*)##.*/\1/g'\
+  )
 
-  local test_exit_code
-  test_exit_code=$(runner::_extract_field_value "$result_line" "TEST_EXIT_CODE")
+  local test_exit_code=$(\
+    echo "$execution_result" |\
+    tail -n 1 |\
+    sed -E -e 's/.*##TEST_EXIT_CODE=([0-9]*)##.*/\1/g'\
+  )
 
   log "debug" "[SYNC]" "fn_name:$fn_name" "execution_result:$execution_result"
 

src/test_doubles.sh

@@ -15,8 +15,6 @@ function unmock() {
       local params_file_var="${variable}_params_file"
       [[ -f "${!times_file_var-}" ]] && rm -f "${!times_file_var}"
       [[ -f "${!params_file_var-}" ]] && rm -f "${!params_file_var}"
-      unset "${variable}_times"
-      unset "${variable}_params"
       unset "$times_file_var"
       unset "$params_file_var"
       break
@@ -44,9 +42,6 @@ function spy() {
   local variable
   variable="$(helper::normalize_variable_name "$command")"
 
-  export "${variable}_times"=0
-  export "${variable}_params"
-
   local times_file params_file
   local test_id="${BASHUNIT_CURRENT_TEST_ID:-global}"
   times_file=$(temp_file "${test_id}_${variable}_times")
@@ -57,9 +52,7 @@ function spy() {
   export "${variable}_params_file"="$params_file"
 
   eval "function $command() {
-    ${variable}_params=(\"\$*\")
     echo \"\$*\" > '$params_file'
-    ((${variable}_times++)) || true
     local _c=\$(cat '$times_file')
     _c=\$((_c+1))
     echo \"\$_c\" > '$times_file'
@@ -74,10 +67,8 @@ function assert_have_been_called() {
   local command=$1
   local variable
   variable="$(helper::normalize_variable_name "$command")"
-  local actual
-  actual="${variable}_times"
   local file_var="${variable}_times_file"
-  local times="${!actual-0}"
+  local times=0
   if [[ -f "${!file_var-}" ]]; then
     times=$(cat "${!file_var}")
   fi
@@ -97,10 +88,8 @@ function assert_have_been_called_with() {
   local command=$2
   local variable
   variable="$(helper::normalize_variable_name "$command")"
-  local actual
-  actual="${variable}_params"
   local file_var="${variable}_params_file"
-  local params="${!actual-}"
+  local params=""
   if [[ -f "${!file_var-}" ]]; then
     params=$(cat "${!file_var}")
   fi
@@ -120,15 +109,13 @@ function assert_have_been_called_times() {
   local command=$2
   local variable
   variable="$(helper::normalize_variable_name "$command")"
-  local actual
-  actual="${variable}_times"
   local file_var="${variable}_times_file"
-  local times="${!actual-0}"
+  local times=0
   if [[ -f "${!file_var-}" ]]; then
     times=$(cat "${!file_var}")
   fi
   local label="${3:-$(helper::normalize_test_function_name "${FUNCNAME[1]}")}"
-  if [[ -z "${!actual-}" && $expected -ne 0 || $times -ne $expected ]]; then
+  if [[ $times -ne $expected ]]; then
     state::add_assertions_failed
     console_results::print_failed_test "${label}" "${command}" \
       "to has been called" "${expected} times" \