org.apache.maven.plugin.surefire.report

Class XMLReporter

java.lang.Object

org.apache.maven.plugin.surefire.report.AbstractReporter

org.apache.maven.plugin.surefire.report.XMLReporter

All Implemented Interfaces:

Reporter

public class XMLReporter
extends AbstractReporter

XML format reporter writing to TEST-reportName[-suffix].xml file like written and read by Ant's <junit> and <junitreport> tasks, then supported by many tools like CI servers.

<?xml version="1.0" encoding="UTF-8"?>
 <testsuite name="suite name" [group="group"] tests="0" failures="0" errors="0" skipped="0" time="0,###.###">
  <properties>
    <property name="name" value="value"/>
    [...]
  </properties>
  <testcase time="0,###.###" name="test name [classname="class name"] [group="group"]"/>
  <testcase time="0,###.###" name="test name [classname="class name"] [group="group"]">
    <error message="message" type="exception class name">stacktrace</error>
    <system-out>system out content (present only if not empty)</system-out>
    <system-err>system err content (present only if not empty)</system-err>
  </testcase>
  <testcase time="0,###.###" name="test name [classname="class name"] [group="group"]">
    <failure message="message" type="exception class name">stacktrace</failure>
    <system-out>system out content (present only if not empty)</system-out>
    <system-err>system err content (present only if not empty)</system-err>
  </testcase>
  <testcase time="0,###.###" name="test name [classname="class name"] [group="group"]">
    <skipped/>
  </testcase>
  [...]

Version:

$Id: XMLReporter.java 1237087 2012-01-28 16:22:34Z krosenvold $

Author:

Johnny R. Ruiz III

See Also:

Ant's format enhancement proposal (not yet implemented by Ant 1.8.2)

Constructor Summary

Constructors

Constructor and Description
XMLReporter(boolean trimStackTrace, File reportsDirectory)
XMLReporter(boolean trimStackTrace, File reportsDirectory, String reportNameSuffix)

Method Summary

Methods

Modifier and Type	Method and Description
Iterator	getResults()
void	reset() Restores the instance of the reporter, making the instance re-usable for a subsequent run in the same thread.
void	testError(ReportEntry report, String stdOut, String stdErr) Event fired when a test ended with an error (non anticipated problem)
void	testFailed(ReportEntry report, String stdOut, String stdErr) Event fired when a test ended with a failure (anticipated problem)
void	testSetCompleted(ReportEntry report) Indicates end of a given test-set
void	testSetStarting(ReportEntry report) Indicates the start of a given test-set
void	testSkipped(ReportEntry report)
void	testSucceeded(ReportEntry report) Event fired when a test ended successfully
void	writeMessage(byte[] b, int off, int len)
void	writeMessage(String message) Writes a message that will be displayed in all free-text format reporters.

Methods inherited from class org.apache.maven.plugin.surefire.report.AbstractReporter

testStarting

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLReporter

public XMLReporter(boolean trimStackTrace,
           File reportsDirectory)

XMLReporter

public XMLReporter(boolean trimStackTrace,
           File reportsDirectory,
           String reportNameSuffix)

Method Detail

writeMessage

public void writeMessage(String message)

Description copied from interface: Reporter

Writes a message that will be displayed in all free-text format reporters. These messages will be output regardless, as opposed to #writeDetailMessage, which is controlled by reportFormat.

Parameters:

message - The message to write.

writeMessage

public void writeMessage(byte[] b,
                int off,
                int len)

Specified by:

writeMessage in interface Reporter

Overrides:

writeMessage in class AbstractReporter

testSetStarting

public void testSetStarting(ReportEntry report)
                     throws ReporterException

Description copied from interface: Reporter

Indicates the start of a given test-set

Specified by:

testSetStarting in interface Reporter

Overrides:

testSetStarting in class AbstractReporter

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

testSetCompleted

public void testSetCompleted(ReportEntry report)
                      throws ReporterException

Description copied from interface: Reporter

Indicates end of a given test-set

Specified by:

testSetCompleted in interface Reporter

Overrides:

testSetCompleted in class AbstractReporter

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

testSucceeded

public void testSucceeded(ReportEntry report)

Description copied from interface: Reporter

Event fired when a test ended successfully

Specified by:

testSucceeded in interface Reporter

Overrides:

testSucceeded in class AbstractReporter

Parameters:

report - The report entry to log for

testError

public void testError(ReportEntry report,
             String stdOut,
             String stdErr)

Description copied from interface: Reporter

Event fired when a test ended with an error (non anticipated problem)

Specified by:

testError in interface Reporter

Overrides:

testError in class AbstractReporter

Parameters:

report - The report entry to log for

stdOut - standard output from the test case

stdErr - error output from the test case

testFailed

public void testFailed(ReportEntry report,
              String stdOut,
              String stdErr)

Description copied from interface: Reporter

Event fired when a test ended with a failure (anticipated problem)

Specified by:

testFailed in interface Reporter

Overrides:

testFailed in class AbstractReporter

Parameters:

report - The report entry to log for

stdOut - standard output from the test case

stdErr - error output from the test case

testSkipped

public void testSkipped(ReportEntry report)

Specified by:

testSkipped in interface Reporter

Overrides:

testSkipped in class AbstractReporter

getResults

public Iterator getResults()

reset

public void reset()

Description copied from interface: Reporter

Restores the instance of the reporter, making the instance re-usable for a subsequent run in the same thread.

Specified by:

reset in interface Reporter

Overrides:

reset in class AbstractReporter