Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SUREFIRE-2212] surefire-report-parser: parse element content only if needed to prevent OOME #687

Closed
wants to merge 2 commits into from
Closed

[SUREFIRE-2212] surefire-report-parser: parse element content only if needed to prevent OOME #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5542df8
[SUREFIRE-2212] parse element content only if needed to prevent OOME
Nov 14, 2023
267d185
add test case for large file parsing
Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...ort-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ public final class TestSuiteXmlParser extends DefaultHandler {

private boolean valid;

private boolean parseContent;

public TestSuiteXmlParser(ConsoleLogger consoleLogger) {
this.consoleLogger = consoleLogger;
}
Expand Down Expand Up @@ -157,12 +159,14 @@ public void startElement(String uri, String localName, String qName, Attributes
break;
case "failure":
currentElement = new StringBuilder();
parseContent = true;

testCase.setFailure(attributes.getValue("message"), attributes.getValue("type"));
currentSuite.incrementNumberOfFailures();
break;
case "error":
currentElement = new StringBuilder();
parseContent = true;

testCase.setError(attributes.getValue("message"), attributes.getValue("type"));
currentSuite.incrementNumberOfErrors();
Expand All @@ -181,6 +185,7 @@ public void startElement(String uri, String localName, String qName, Attributes
break;
case "time":
currentElement = new StringBuilder();
parseContent = true;
break;
default:
break;
Expand Down Expand Up @@ -215,6 +220,7 @@ public void endElement(String uri, String localName, String qName) throws SAXExc
default:
break;
}
parseContent = false;
// TODO extract real skipped reasons
}

Expand All @@ -225,7 +231,7 @@ public void endElement(String uri, String localName, String qName) throws SAXExc
public void characters(char[] ch, int start, int length) {
assert start >= 0;
assert length >= 0;
if (valid && isNotBlank(start, length, ch)) {
if (valid && parseContent && isNotBlank(start, length, ch)) {
currentElement.append(ch, start, length);
}
}
Expand Down
84 changes: 80 additions & 4 deletions ...parser/src/test/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@
*/
package org.apache.maven.plugins.surefire.report;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
Expand Down Expand Up @@ -632,4 +631,81 @@ public void shouldTestIsNumeric() {
assertTrue(TestSuiteXmlParser.isNumeric(new StringBuilder("0?51M2"), 2, 4));
assertFalse(TestSuiteXmlParser.isNumeric(new StringBuilder("0?51M2"), 2, 5));
}

@Test
public void shouldParseLargeFile() throws Exception {
// Create test file
Path tempFile = Files.createTempFile("largeReport", ".xml");

try (BufferedWriter w = Files.newBufferedWriter(tempFile)) {
w.write("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
+ "<testsuite failures=\"1\" time=\"2.413\" errors=\"0\" skipped=\"0\" tests=\"2\" name=\"largeFile.TestSurefire3\">\n"
+ " <properties></properties>\n"
+ " <testcase time=\"0.005\" classname=\"largeFile.TestSurefire3\" name=\"testSuccess\" />\n"
+ " <testcase time=\"2.20\" classname=\"largeFile.TestSurefire3\" name=\"testFailure\">\n"
+ " <failure message=\"test failure\" type=\"junit.framework.AssertionFailedError\">junit.framework.AssertionFailedError: \n"
+ "\tat junit.framework.Assert.fail(Assert.java:47)\n"
+ "\tat largeFile.TestSurefire3.testFailure(TestSurefire3.java:40)\n"
+ "</failure>\n"
+ " <system-err><![CDATA[\n");

// Adding CDATA which should be ignored during parsing and not cause memory issues
for (int i = 0; i < 100000; i++) {
w.write(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n");
w.flush();
}
w.write("]]></system-err>\n" + " </testcase>\n" + "</testsuite>\n");
w.flush();
}

System.err.println(Files.size(tempFile));

// Parse test file
TestSuiteXmlParser testSuiteXmlParser = new TestSuiteXmlParser(consoleLogger);

try (InputStreamReader is = new InputStreamReader(Files.newInputStream(tempFile), UTF_8)) {
List<ReportTestSuite> parse = testSuiteXmlParser.parse(is);

assertThat(parse.size(), is(1));
ReportTestSuite report = parse.get(0);
assertThat(report.getFullClassName(), is("largeFile.TestSurefire3"));
assertThat(report.getName(), is("TestSurefire3"));
assertThat(report.getPackageName(), is("largeFile"));
assertThat(report.getNumberOfTests(), is(2));
assertThat(report.getNumberOfSkipped(), is(0));
assertThat(report.getNumberOfErrors(), is(0));
assertThat(report.getNumberOfFailures(), is(1));
assertThat(report.getNumberOfFlakes(), is(0));
assertThat(report.getTimeElapsed(), is(2.413f));
assertThat(report.getTestCases().size(), is(2));

List<ReportTestCase> tests = report.getTestCases();
assertThat(tests.get(0).getFullClassName(), is("largeFile.TestSurefire3"));
assertThat(tests.get(0).getName(), is("testSuccess"));
assertNull(tests.get(0).getFailureDetail());
assertThat(tests.get(0).getClassName(), is("TestSurefire3"));
assertThat(tests.get(0).getTime(), is(0.005f));
assertThat(tests.get(0).getFullName(), is("largeFile.TestSurefire3.testSuccess"));
assertThat(tests.get(0).hasError(), is(false));

assertThat(tests.get(1).getFullClassName(), is("largeFile.TestSurefire3"));
assertThat(tests.get(1).getName(), is("testFailure"));
assertThat(
tests.get(1).getFailureDetail(),
is("junit.framework.AssertionFailedError: \n"
+ "\tat junit.framework.Assert.fail(Assert.java:47)\n"
+ "\tat largeFile.TestSurefire3.testFailure(TestSurefire3.java:40)\n"));
assertThat(tests.get(1).getClassName(), is("TestSurefire3"));
assertThat(tests.get(1).getTime(), is(2.20f));
assertThat(tests.get(1).getFailureErrorLine(), is("40"));
assertThat(tests.get(1).getFailureMessage(), is("test failure"));
assertThat(tests.get(1).getFullName(), is("largeFile.TestSurefire3.testFailure"));
assertThat(tests.get(1).getFailureType(), is("junit.framework.AssertionFailedError"));
assertThat(tests.get(1).hasError(), is(false));
}

// Delete test file
Files.delete(tempFile);
}
}