fix: ensure script-level temp files are always cleaned up

This commit resolves an issue where temporary files created in
`set_up_before_script` were not properly cleaned up due to test ID
contamination between test files.

Unset BASHUNIT_CURRENT_TEST_ID and set BASHUNIT_CURRENT_SCRIPT_ID at the
start of a script in order to make sure `temp_file()` and `temp_dir()`
use the correct prefix for their path names.

Remove `cleanup_temp_files()` in favor of more explicit
`cleanup_testcase_temp_files()` and `cleanup_script_temp_files()`
functions.
Call `cleanup_testcase_temp_files()` in the testcase exit trap handler
to make sure that testcase temp files are always cleaned.
Call `cleanup_script_temp_files()` explicitly at the end of test file
runs, as well as in cleanup handlers.

This makes the general cleaning at the end of `main::exec_tests()` and
`main::exec_benchmarks` obsolete. The fallback branch in the previous
implementation (`rm -rf "${TMPDIR:-/tmp}/bashunit/tmp"/*`) was not a
good idea anyway, as it potentially broke parallel running instances of
bashunit using the same TMPDIR.

Author: carlfriedrich

src/globals.sh

@@ -43,7 +43,11 @@ function temp_file() {
   mkdir -p "$base_dir" && chmod -R 777 "$base_dir"
   local test_prefix=""
   if [[ -n "${BASHUNIT_CURRENT_TEST_ID:-}" ]]; then
+    # We're inside a test function - use test ID
     test_prefix="${BASHUNIT_CURRENT_TEST_ID}_"
+  elif [[ -n "${BASHUNIT_CURRENT_SCRIPT_ID:-}" ]]; then
+    # We're at script level (e.g., in set_up_before_script) - use script ID
+    test_prefix="${BASHUNIT_CURRENT_SCRIPT_ID}_"
   fi
   mktemp "$base_dir/${test_prefix}${prefix}.XXXXXXX"
 }
@@ -54,17 +58,26 @@ function temp_dir() {
   mkdir -p "$base_dir" && chmod -R 777 "$base_dir"
   local test_prefix=""
   if [[ -n "${BASHUNIT_CURRENT_TEST_ID:-}" ]]; then
+    # We're inside a test function - use test ID
     test_prefix="${BASHUNIT_CURRENT_TEST_ID}_"
+  elif [[ -n "${BASHUNIT_CURRENT_SCRIPT_ID:-}" ]]; then
+    # We're at script level (e.g., in set_up_before_script) - use script ID
+    test_prefix="${BASHUNIT_CURRENT_SCRIPT_ID}_"
   fi
   mktemp -d "$base_dir/${test_prefix}${prefix}.XXXXXXX"
 }
 
-function cleanup_temp_files() {
-  internal_log "cleanup_temp_files"
+function cleanup_testcase_temp_files() {
+  internal_log "cleanup_testcase_temp_files"
   if [[ -n "${BASHUNIT_CURRENT_TEST_ID:-}" ]]; then
     rm -rf "${TMPDIR:-/tmp}/bashunit/tmp/${BASHUNIT_CURRENT_TEST_ID}"_*
-  else
-    rm -rf "${TMPDIR:-/tmp}/bashunit/tmp"/*
+  fi
+}
+
+function cleanup_script_temp_files() {
+  internal_log "cleanup_script_temp_files"
+  if [[ -n "${BASHUNIT_CURRENT_SCRIPT_ID:-}" ]]; then
+    rm -rf "${TMPDIR:-/tmp}/bashunit/tmp/${BASHUNIT_CURRENT_SCRIPT_ID}"_*
   fi
 }
 

src/main.sh

@@ -70,7 +70,6 @@ function main::exec_tests() {
     reports::generate_report_html "$BASHUNIT_REPORT_HTML"
   fi
 
-  cleanup_temp_files
   internal_log "Finished tests" "exit_code:$exit_code"
   exit $exit_code
 }
@@ -98,23 +97,22 @@ function main::exec_benchmarks() {
 
   benchmark::print_results
 
-  cleanup_temp_files
   internal_log "Finished benchmarks"
 }
 
 function main::cleanup() {
   printf "%sCaught Ctrl-C, killing all child processes...%s\n"  "${_COLOR_SKIPPED}" "${_COLOR_DEFAULT}"
   # Kill all child processes of this script
   pkill -P $$
-  cleanup_temp_files
+  cleanup_script_temp_files
   exit 1
 }
 
 function main::handle_stop_on_failure_sync() {
   printf "\n%sStop on failure enabled...%s\n"  "${_COLOR_SKIPPED}" "${_COLOR_DEFAULT}"
   console_results::print_failing_tests_and_reset
   console_results::render_result
-  cleanup_temp_files
+  cleanup_script_temp_files
   exit 1
 }
 

src/runner.sh

@@ -5,11 +5,15 @@ function runner::load_test_files() {
   local filter=$1
   shift
   local files=("${@}")
+  local scripts_ids=()
 
   for test_file in "${files[@]}"; do
     if [[ ! -f $test_file ]]; then
       continue
     fi
+    unset BASHUNIT_CURRENT_TEST_ID
+    export BASHUNIT_CURRENT_SCRIPT_ID="$(helper::generate_id "${test_file}")"
+    scripts_ids+=("${BASHUNIT_CURRENT_SCRIPT_ID}")
     internal_log "Loading file" "$test_file"
     # shellcheck source=/dev/null
     source "$test_file"
@@ -21,6 +25,9 @@ function runner::load_test_files() {
     fi
     runner::run_tear_down_after_script
     runner::clean_set_up_and_tear_down_after_script
+    if ! parallel::is_enabled; then
+      cleanup_script_temp_files
+    fi
     internal_log "Finished file" "$test_file"
   done
 
@@ -32,6 +39,10 @@ function runner::load_test_files() {
     # Kill the spinner once the aggregation finishes
     disown "$spinner_pid" && kill "$spinner_pid" &>/dev/null
     printf "\r " # Clear the spinner output
+    for script_id in "${scripts_ids[@]}"; do
+      export BASHUNIT_CURRENT_SCRIPT_ID="${script_id}"
+      cleanup_script_temp_files
+    done
   fi
 }
 
@@ -42,12 +53,15 @@ function runner::load_bench_files() {
 
   for bench_file in "${files[@]}"; do
     [[ -f $bench_file ]] || continue
+    unset BASHUNIT_CURRENT_TEST_ID
+    export BASHUNIT_CURRENT_SCRIPT_ID="$(helper::generate_id "${test_file}")"
     # shellcheck source=/dev/null
     source "$bench_file"
     runner::run_set_up_before_script
     runner::call_bench_functions "$bench_file" "$filter"
     runner::run_tear_down_after_script
     runner::clean_set_up_and_tear_down_after_script
+    cleanup_script_temp_files
   done
 }
 
@@ -259,6 +273,7 @@ function runner::run_test() {
       state::set_test_exit_code "$exit_code"
       runner::run_tear_down
       runner::clear_mocks
+      cleanup_testcase_temp_files
       state::export_subshell_context
     ' EXIT
     state::initialize_assertions_count

tests/unit/globals_test.sh

@@ -67,22 +67,22 @@ function test_globals_temp_file_in_test_function() {
   # shellcheck disable=SC2155
   local temp_file=$(temp_file "custom-prefix")
   assert_file_exists "$temp_file"
-  cleanup_temp_files
+  cleanup_testcase_temp_files
   assert_file_not_exists "$temp_file"
 }
 
 function test_globals_temp_dir_in_test_function() {
   # shellcheck disable=SC2155
   local temp_dir=$(temp_dir "custom-prefix")
   assert_directory_exists "$temp_dir"
-  cleanup_temp_files
+  cleanup_testcase_temp_files
   assert_directory_not_exists "$temp_dir"
 }
 
 function test_globals_temp_dir_and_file_in_script() {
   assert_directory_exists "$SCRIPT_TEMP_DIR"
   assert_file_exists "$SCRIPT_TEMP_FILE"
-  cleanup_temp_files
+  cleanup_script_temp_files
   assert_directory_not_exists "$SCRIPT_TEMP_DIR"
   assert_file_not_exists "$SCRIPT_TEMP_FILE"
 }