fix(junit-formatter): shield internals from env (fixes #1174)

Author: martin-schulze-vireso

docs/CHANGELOG.md

@@ -11,6 +11,10 @@ The format is based on [Keep a Changelog][kac] and this project adheres to
 
 ## [Unreleased]
 
+### Fixed
+
+* avoid interference from env to junit formatter internals (#1175)
+
 ## [1.13.0] - 2025-11-07
 
 ### Added 

libexec/bats-core/bats-format-junit

@@ -4,18 +4,6 @@ set -euo pipefail
 # shellcheck source=lib/bats-core/formatter.bash
 source "$BATS_ROOT/$BATS_LIBDIR/bats-core/formatter.bash"
 
-BASE_PATH=.
-
-while [[ "$#" -ne 0 ]]; do
-  case "$1" in
-  --base-path)
-    shift
-    normalize_base_path BASE_PATH "$1"
-    ;;
-  esac
-  shift
-done
-
 init_suite() {
   suite_test_exec_time=0
   # since we have to print the suite header before its contents but we don't know the contents before the header,
@@ -24,7 +12,6 @@ init_suite() {
   test_result_state="" # declare for the first flush, when no test has been encountered
 }
 
-_buffer_log=
 init_file() {
   file_count=0
   file_failures=0
@@ -97,8 +84,8 @@ print_test_case() {
   fi
 }
 
-xml_escape() {
-  output=${1//&/\&}
+xml_escape() { # <string to escape>
+  local output=${1//&/\&amp;}
   output=${output//</\&lt;}
   output=${output//>/\&gt;}
   output=${output//'"'/\&quot;}
@@ -168,7 +155,7 @@ $1"
 }
 
 finish_file() {
-  if [[ "${class-JUNIT_FORMATTER_NO_FILE_ENCOUNTERED}" != JUNIT_FORMATTER_NO_FILE_ENCOUNTERED ]]; then
+  if [[ "${class}" != JUNIT_FORMATTER_NO_FILE_ENCOUNTERED ]]; then
     file_header
     printf "%s\n" "${_buffer}"
     file_footer
@@ -189,10 +176,6 @@ bats_tap_stream_plan() { #  <number of tests>
   :
 }
 
-init_suite
-trap finish_suite EXIT
-trap '' INT
-
 bats_tap_stream_begin() { # <test index> <test name>
   flush_log
   # set after flushing to avoid overriding name of test
@@ -259,4 +242,44 @@ bats_tap_stream_unknown() { # <full line>
   :
 }
 
-bats_parse_internal_extended_tap
+main() {
+  local _buffer_log="" \
+        name="" \
+        class="JUNIT_FORMATTER_NO_FILE_ENCOUNTERED" \
+        _buffer="" \
+        _buffer_log="" \
+        _suite_buffer="" \
+        _system_out_log="" \
+        test_result_state="" \
+        test_skip_message=""
+
+  local -i file_count=0 \
+            file_failures=0 \
+            file_skipped=0 \
+            file_exec_time=0 \
+            test_exec_time=0 \
+            suite_test_exec_time=0 
+
+  local BASE_PATH=.
+
+  while [[ "$#" -ne 0 ]]; do
+    case "$1" in
+    --base-path)
+      shift
+      normalize_base_path BASE_PATH "$1"
+      ;;
+    esac
+    shift
+  done
+
+  init_suite
+  trap finish_suite EXIT
+  trap '' INT
+
+  bats_parse_internal_extended_tap
+
+  trap - EXIT
+  finish_suite # ensure we run this with the local variables still in scope
+}
+
+main "$@"

test/junit-formatter.bats

@@ -175,7 +175,7 @@ TESTSUITES_REGEX="<testsuites time=\"$FLOAT_REGEX\">"
 @test "don't choke on setup_suite errors (issue #1106)" {
   bats_require_minimum_version 1.5.0
   local stderr='' # silence shellcheck
-  reentrant_run -1 --separate-stderr bats --formatter junit "$FIXTURE_ROOT/../suite_setup_teardown/error_in_setup_suite/test.bats"
+  name=non-empty reentrant_run -1 --separate-stderr bats --formatter junit "$FIXTURE_ROOT/../suite_setup_teardown/error_in_setup_suite/test.bats"
   [ "${stderr}" == "" ]
   [[ "${lines[2]}" == '<testsuite name="setup_suite" '*'>' ]]
   [[ "${lines[3]}" == '    <testcase classname="setup_suite" '*'>' ]]