junit: Remove ANSI Codes

to avoid invalid XML characters
martin-schulze-vireso · Mar 17, 2024 · bb4a720 · bb4a720
1 parent db381c7
commit bb4a720
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -27,6 +27,7 @@ The format is based on [Keep a Changelog][kac] and this project adheres to
 * fix `--gather-test-outputs-in` fails on tests with multiple `/` (#789)
 * install does not create unused `/usr/share/bats` anymore (#857)
 * ensure IFS is unchanged in `{setup,teardown}{_suite,_file,}`, `@test` and free code (#879)
+* junit formatter: remove ANSI Codes to avoid invalid XML character (#886)
 
 ### Changed
 

diff --git a/libexec/bats-core/bats-format-junit b/libexec/bats-core/bats-format-junit
@@ -103,8 +103,12 @@ xml_escape() {
   output=${output//>/\&gt;}
   output=${output//'"'/\&quot;}
   output=${output//\'/\&#39;}
+  # remove ANSI Color codes
   local CONTROL_CHAR=$'\033'
-  output=${output//$CONTROL_CHAR/\&#27;}
+  local REGEX="$CONTROL_CHAR\[[0-9;]+m"
+  while [[ "$output" =~ $REGEX ]]; do
+      output=${output//${BASH_REMATCH[0]}/}
+  done
   printf "%s" "$output"
 }
 

diff --git a/test/junit-formatter.bats b/test/junit-formatter.bats
@@ -54,12 +54,12 @@ TESTSUITES_REGEX="<testsuites time=\"$FLOAT_REGEX\">"
 
   echo "$output"
   [[ "${lines[2]}" == "<testsuite name=\"$ESCAPED_TEST_FILE_NAME\" tests=\"3\" failures=\"1\" errors=\"0\" skipped=\"1\" time=\""*"\" timestamp=\""*"\" hostname=\""*"\">" ]]
-  [[ "${lines[3]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Successful test with escape characters: &quot;&#39;&lt;&gt;&amp;&#27;[0m (0x1b)\" time=\""*"\" />" ]]
-  [[ "${lines[4]}" == "    <testcase classname=\"$ESCAPED_TEST_FILE_NAME\" name=\"Failed test with escape characters: &quot;&#39;&lt;&gt;&amp;&#27;[0m (0x1b)\" "* ]]
+  [[ "${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;&#27;[0m&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;&#27;[0m (0x1b)\" time=\""*"\">" ]]
-  [[ "${lines[10]}" == "        <skipped>&quot;&#39;&lt;&gt;&amp;&#27;[0m</skipped>" ]]
+  [[ "${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>" ]]
 }
 
 @test "junit formatter: test suites" {