Package org.apache.maven.plugin.surefire.report

Class StatelessXmlReporter

java.lang.Object

org.apache.maven.plugin.surefire.report.StatelessXmlReporter

All Implemented Interfaces:

StatelessReportEventListener<WrappedReportEntry,TestSetStats>

Direct Known Subclasses:

NullStatelessXmlReporter

public class StatelessXmlReporter
extends Object
implements StatelessReportEventListener<WrappedReportEntry,TestSetStats>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	StatelessXmlReporter.ByteConstantsHolder
private static final class	StatelessXmlReporter.EncodingOutputStream

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	phrasedClassName
private final boolean	phrasedFileName
private final boolean	phrasedMethodName
private final boolean	phrasedSuiteName
private final String	reportNameSuffix
private final File	reportsDirectory
private final int	rerunFailingTestsCount
private final Map<String,Deque<WrappedReportEntry>>	testClassMethodRunHistoryMap
private final boolean	trimStackTrace
private static final String	XML_INDENT
private static final String	XML_NL
private final String	xsdSchemaLocation
private final String	xsdVersion

Constructor Summary

Constructors

Constructor	Description
StatelessXmlReporter(File reportsDirectory, String reportNameSuffix, boolean trimStackTrace, int rerunFailingTestsCount, Map<String,Deque<WrappedReportEntry>> testClassMethodRunHistoryMap, String xsdSchemaLocation, String xsdVersion, boolean phrasedFileName, boolean phrasedSuiteName, boolean phrasedClassName, boolean phrasedMethodName)

Method Summary

Modifier and Type	Method	Description
private static void	addCommentElementTestCase(String comment, OutputStreamWriter outputStreamWriter, org.apache.maven.shared.utils.xml.XMLWriter xmlWriter, OutputStream fw)
private static void	addOutputStreamElement(OutputStreamWriter outputStreamWriter, StatelessXmlReporter.EncodingOutputStream eos, org.apache.maven.shared.utils.xml.XMLWriter xmlWriter, Utf8RecodingDeferredFileOutputStream utf8RecodingDeferredFileOutputStream, String name)
private Deque<WrappedReportEntry>	aggregateCacheFromMultipleReruns(WrappedReportEntry testSetReportEntry, TestSetStats testSetStats)
private Map<String,Map<String,List<WrappedReportEntry>>>	arrangeMethodStatistics(WrappedReportEntry testSetReportEntry, TestSetStats testSetStats)
void	cleanTestHistoryMap()	Clean testClassMethodRunHistoryMap
private static boolean	containsEscapesIllegalXml10(String message)
private static void	createOutErrElements(OutputStreamWriter outputStreamWriter, org.apache.maven.shared.utils.xml.XMLWriter ppw, WrappedReportEntry report, OutputStream fw)
private void	createTestSuiteElement(org.apache.maven.shared.utils.xml.XMLWriter ppw, WrappedReportEntry report, TestSetStats testSetStats)
private static String	escapeXml(String text, boolean attribute)	escape for XML 1.0
private static String	extraEscapeAttribute(String message)	Handle stuff that may pop up in java that is not legal in xml.
private static void	extraEscapeElementValue(String message, OutputStreamWriter outputStreamWriter, org.apache.maven.shared.utils.xml.XMLWriter xmlWriter, OutputStream fw)	Writes escaped string or the message within CDATA if all characters are legal.
private Deque<WrappedReportEntry>	getAddMethodRunHistoryMap(String testClassName)
private OutputStream	getOutputStream(WrappedReportEntry testSetReportEntry)
private File	getReportFile(WrappedReportEntry report)
private static void	getTestProblems(OutputStreamWriter outputStreamWriter, org.apache.maven.shared.utils.xml.XMLWriter ppw, WrappedReportEntry report, boolean trimStackTrace, OutputStream fw, String testErrorType, boolean createOutErrElementsInside)
private DefaultReporterFactory.TestResultType	getTestResultType(List<WrappedReportEntry> methodEntryList)	Get the result of a test from a list of its runs in WrappedReportEntry
private static OutputStreamWriter	getWriter(OutputStream fos)
private static boolean	isIllegalEscape(char c)
private static boolean	isIllegalEscape(int c)
private void	serializeTestClass(OutputStream outputStream, OutputStreamWriter fw, org.apache.maven.shared.utils.xml.XMLWriter ppw, List<WrappedReportEntry> methodEntries)
private void	serializeTestClassWithoutRerun(OutputStream outputStream, OutputStreamWriter fw, org.apache.maven.shared.utils.xml.XMLWriter ppw, List<WrappedReportEntry> methodEntries)
private void	serializeTestClassWithRerun(OutputStream outputStream, OutputStreamWriter fw, org.apache.maven.shared.utils.xml.XMLWriter ppw, List<WrappedReportEntry> methodEntries)
private static void	showProperties(org.apache.maven.shared.utils.xml.XMLWriter xmlWriter, Map<String,String> systemProperties)	Adds system properties to the XML report.
private void	startTestElement(org.apache.maven.shared.utils.xml.XMLWriter ppw, WrappedReportEntry report)
void	testSetCompleted(WrappedReportEntry testSetReportEntry, TestSetStats testSetStats)	The callback is called after the test class has been completed and the state of report is final.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XML_INDENT

private static final String XML_INDENT

See Also:

• Constant Field Values

XML_NL

private static final String XML_NL

See Also:

• Constant Field Values

reportsDirectory

private final File reportsDirectory

reportNameSuffix

private final String reportNameSuffix

trimStackTrace

private final boolean trimStackTrace

rerunFailingTestsCount

private final int rerunFailingTestsCount

xsdSchemaLocation

private final String xsdSchemaLocation

xsdVersion

private final String xsdVersion

testClassMethodRunHistoryMap

private final Map<String,Deque<WrappedReportEntry>> testClassMethodRunHistoryMap

phrasedFileName

private final boolean phrasedFileName

phrasedSuiteName

private final boolean phrasedSuiteName

phrasedClassName

private final boolean phrasedClassName

phrasedMethodName

private final boolean phrasedMethodName

Constructor Details

StatelessXmlReporter

public StatelessXmlReporter(File reportsDirectory,
 String reportNameSuffix,
 boolean trimStackTrace,
 int rerunFailingTestsCount,
 Map<String,Deque<WrappedReportEntry>> testClassMethodRunHistoryMap,
 String xsdSchemaLocation,
 String xsdVersion,
 boolean phrasedFileName,
 boolean phrasedSuiteName,
 boolean phrasedClassName,
 boolean phrasedMethodName)

Method Details

testSetCompleted

public void testSetCompleted(WrappedReportEntry testSetReportEntry,
 TestSetStats testSetStats)

Description copied from interface: StatelessReportEventListener

The callback is called after the test class has been completed and the state of report is final.

Specified by:

testSetCompleted in interface StatelessReportEventListener<WrappedReportEntry,TestSetStats>

Parameters:

testSetReportEntry - WrappedReportEntry

testSetStats - TestSetStats

arrangeMethodStatistics

private Map<String,Map<String,List<WrappedReportEntry>>> arrangeMethodStatistics(WrappedReportEntry testSetReportEntry,
 TestSetStats testSetStats)

aggregateCacheFromMultipleReruns

private Deque<WrappedReportEntry> aggregateCacheFromMultipleReruns(WrappedReportEntry testSetReportEntry,
 TestSetStats testSetStats)

serializeTestClass

private void serializeTestClass(OutputStream outputStream,
 OutputStreamWriter fw,
 org.apache.maven.shared.utils.xml.XMLWriter ppw,
 List<WrappedReportEntry> methodEntries)
                         throws IOException

Throws:

IOException

serializeTestClassWithoutRerun

private void serializeTestClassWithoutRerun(OutputStream outputStream,
 OutputStreamWriter fw,
 org.apache.maven.shared.utils.xml.XMLWriter ppw,
 List<WrappedReportEntry> methodEntries)
                                     throws IOException

Throws:

IOException

serializeTestClassWithRerun

private void serializeTestClassWithRerun(OutputStream outputStream,
 OutputStreamWriter fw,
 org.apache.maven.shared.utils.xml.XMLWriter ppw,
 List<WrappedReportEntry> methodEntries)
                                  throws IOException

Throws:

IOException

cleanTestHistoryMap

public void cleanTestHistoryMap()

Clean testClassMethodRunHistoryMap

getTestResultType

private DefaultReporterFactory.TestResultType getTestResultType(List<WrappedReportEntry> methodEntryList)

Get the result of a test from a list of its runs in WrappedReportEntry

Parameters:

methodEntryList - the list of runs for a given test

Returns:

the TestResultType for the given test

getAddMethodRunHistoryMap

private Deque<WrappedReportEntry> getAddMethodRunHistoryMap(String testClassName)

getOutputStream

private OutputStream getOutputStream(WrappedReportEntry testSetReportEntry)
                              throws IOException

Throws:

IOException

getWriter

private static OutputStreamWriter getWriter(OutputStream fos)

getReportFile

private File getReportFile(WrappedReportEntry report)

startTestElement

private void startTestElement(org.apache.maven.shared.utils.xml.XMLWriter ppw,
 WrappedReportEntry report)
                       throws IOException

Throws:

IOException

createTestSuiteElement

private void createTestSuiteElement(org.apache.maven.shared.utils.xml.XMLWriter ppw,
 WrappedReportEntry report,
 TestSetStats testSetStats)
                             throws IOException

Throws:

IOException

getTestProblems

private static void getTestProblems(OutputStreamWriter outputStreamWriter,
 org.apache.maven.shared.utils.xml.XMLWriter ppw,
 WrappedReportEntry report,
 boolean trimStackTrace,
 OutputStream fw,
 String testErrorType,
 boolean createOutErrElementsInside)
                             throws IOException

Throws:

IOException

createOutErrElements

private static void createOutErrElements(OutputStreamWriter outputStreamWriter,
 org.apache.maven.shared.utils.xml.XMLWriter ppw,
 WrappedReportEntry report,
 OutputStream fw)
                                  throws IOException

Throws:

IOException

addOutputStreamElement

private static void addOutputStreamElement(OutputStreamWriter outputStreamWriter,
 StatelessXmlReporter.EncodingOutputStream eos,
 org.apache.maven.shared.utils.xml.XMLWriter xmlWriter,
 Utf8RecodingDeferredFileOutputStream utf8RecodingDeferredFileOutputStream,
 String name)
                                    throws IOException

Throws:

IOException

showProperties

private static void showProperties(org.apache.maven.shared.utils.xml.XMLWriter xmlWriter,
 Map<String,String> systemProperties)
                            throws IOException

Adds system properties to the XML report.

Parameters:

xmlWriter - The test suite to report to

Throws:

IOException

extraEscapeAttribute

private static String extraEscapeAttribute(String message)

Handle stuff that may pop up in java that is not legal in xml.

Parameters:

message - The string

Returns:

The escaped string or returns itself if all characters are legal

extraEscapeElementValue

private static void extraEscapeElementValue(String message,
 OutputStreamWriter outputStreamWriter,
 org.apache.maven.shared.utils.xml.XMLWriter xmlWriter,
 OutputStream fw)
                                     throws IOException

Writes escaped string or the message within CDATA if all characters are legal.

Parameters:

message - The string

Throws:

IOException

addCommentElementTestCase

private static void addCommentElementTestCase(String comment,
 OutputStreamWriter outputStreamWriter,
 org.apache.maven.shared.utils.xml.XMLWriter xmlWriter,
 OutputStream fw)
                                       throws IOException

Throws:

IOException

containsEscapesIllegalXml10

private static boolean containsEscapesIllegalXml10(String message)

isIllegalEscape

private static boolean isIllegalEscape(char c)

isIllegalEscape

private static boolean isIllegalEscape(int c)

escapeXml

private static String escapeXml(String text,
 boolean attribute)

escape for XML 1.0

Parameters:

text - The string

attribute - true if the escaped value is inside an attribute

Returns:

The escaped string