Merge pull request bats-core#1176 from martin-schulze-vireso/fix/junit-control-characters

fix(junit-formatter): remove control characters

Author: martin-schulze-vireso

docs/CHANGELOG.md

@@ -13,7 +13,9 @@ The format is based on [Keep a Changelog][kac] and this project adheres to
 
 ### Fixed
 
-* avoid interference from env to junit formatter internals (#1175)
+* junit formatter: 
+  * avoid interference between env and internals (#1175)
+  * remove control characters (\x00-\x08\x0B\x0C\x0E-\x1F) (#1176)
 
 ## [1.13.0] - 2025-11-07
 

libexec/bats-core/bats-format-junit

@@ -282,4 +282,6 @@ main() {
   finish_suite # ensure we run this with the local variables still in scope
 }
 
-main "$@"
+# [\x00-\x08\x0B\x0C\x0E-\x1F] can't use $'\x00' as this terminates the string early
+BATS_JUNIT_FORMATTER_DELETE_CHARS_DEFAULT='\000'$'\x01\x02\x03\x04\x05\x06\x07\x08\x0B\x0C\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F'
+main "$@" | tr -d "${BATS_JUNIT_FORMATTER_DELETE_CHARS-$BATS_JUNIT_FORMATTER_DELETE_CHARS_DEFAULT}"

test/fixtures/junit-formatter/xml-escape.bats

@@ -3,7 +3,7 @@
 }
 
 @test "Failed test with escape characters: \"'<>& (0x1b)" {
-  echo "<>'&[0m[K" && false
+  echo "<>'&[0m[K"$'\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1fstop' && false
 }
 
 @test "Skipped test with escape characters: \"'<>& (0x1b)" {

test/junit-formatter.bats

@@ -56,9 +56,11 @@ TESTSUITES_REGEX="<testsuites time=\"$FLOAT_REGEX\">"
   [[ "${lines[3]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Successful test with escape characters: &quot;&#39;&lt;&gt;&amp; (0x1b)\" time=\""*"\" />" ]]
   [[ "${lines[4]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Failed test with escape characters: &quot;&#39;&lt;&gt;&amp; (0x1b)\" "* ]]
   [[ "${lines[5]}" == '        <failure type="failure">(in test file '*"$ESCAPED_TEST_FILE_NAME, line 6)" ]]
-  [[ "${lines[6]}" == '  `echo &quot;&lt;&gt;&#39;&amp;&quot; &amp;&amp; false&#39; failed'* ]]
-  [[ "${lines[9]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Skipped test with escape characters: &quot;&#39;&lt;&gt;&amp; (0x1b)\" time=\""*"\">" ]]
-  [[ "${lines[10]}" == "        <skipped>&quot;&#39;&lt;&gt;&amp;</skipped>" ]]
+  [[ "${lines[6]}" == '  `echo &quot;&lt;&gt;&#39;&amp;&quot;$&#39;\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1fstop&#39; &amp;&amp; false&#39; failed'* ]]
+  [[ "${lines[7]}" == '&lt;&gt;&#39;&amp;' ]]
+  [[ "${lines[8]}" == $'\x0Dstop</failure>' ]]
+  [[ "${lines[10]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Skipped test with escape characters: &quot;&#39;&lt;&gt;&amp; (0x1b)\" time=\""*"\">" ]]
+  [[ "${lines[11]}" == "        <skipped>&quot;&#39;&lt;&gt;&amp;</skipped>" ]]
 }
 
 @test "junit formatter: test suites" {