Prune control characters from Xml CDATA

Closes #1566

CHANGES.txt

@@ -1,4 +1,5 @@
 Current
+Fixed: GITHUB-1566: Invalid XML characters in Params in testng-results.xml (Krishnan Mahadevan)
 Fixed: GITHUB-1554: @Parameters and parameter injection not wroking when used on the same method (Krishnan Mahadevan)
 Fixed: GITHUB-990: NullPointerExceptions after a superclass configuration method fails with configfailurepolicy="continue" (Krishnan Mahadevan)
 Fixed: GITHUB-461 : Annotate annotations with @Documented (Krishnan Mahadevan)

src/main/java/org/testng/reporters/XMLStringBuffer.java

@@ -305,6 +305,9 @@ public void setDefaultComment(String defaultComment) {
    * Add a CDATA tag.
    */
   public void addCDATA(String content) {
+    if (content != null) {
+        content = content.replaceAll("\\p{Cc}", "");
+    }
     m_buffer.append(m_currentIndent);
     if (content == null) {
       m_buffer.append("<![CDATA[null]]>");

src/test/java/test/reports/Issue1566Sample.java

@@ -0,0 +1,17 @@
+package test.reports;
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+public class Issue1566Sample {
+    @DataProvider
+    public Object[][] dataProvider() {
+        return new Object[][]{{
+                "test \u000C"
+        }};
+    }
+
+    @Test(dataProvider = "dataProvider")
+    public void test(String argument) {
+    }
+}

src/test/java/test/reports/XmlReporterTest.java

@@ -0,0 +1,37 @@
+package test.reports;
+
+import org.testng.Assert;
+import org.testng.TestNG;
+import org.testng.annotations.Test;
+import org.testng.reporters.XMLReporter;
+import test.SimpleBaseTest;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.util.UUID;
+import java.util.regex.Pattern;
+
+public class XmlReporterTest extends SimpleBaseTest {
+    @Test(description = "GITHUB-1566")
+    public void testMethod() throws IOException {
+        String suiteName = UUID.randomUUID().toString();
+        File fileLocation = createDirInTempDir(suiteName);
+        TestNG testng = create(fileLocation.toPath(), Issue1566Sample.class);
+        testng.setUseDefaultListeners(true);
+        testng.run();
+        File file = new File(fileLocation, XMLReporter.FILE_NAME);
+        boolean flag = false;
+        Pattern pattern = Pattern.compile("\\p{Cc}");
+        try(BufferedReader reader = new BufferedReader(new FileReader(file))) {
+            String line;
+            while ((line = reader.readLine()) != null) {
+                if (pattern.matcher(line).find()) {
+                    flag = true;
+                }
+            }
+        }
+        Assert.assertFalse(flag, "Should not have found a control character");
+    }
+}

src/test/resources/testng.xml

@@ -104,6 +104,7 @@
 -->
       <class name="test.simple.IncludedExcludedTest" />
       <class name="test.reports.ReportTest" />
+      <class name="test.reports.XmlReporterTest"/>
       <class name="test.annotationtransformer.AnnotationTransformerTest" />
 <!--
       <class name="test.jar.JarTest" />