JUnitXMLReporter

java.lang.Object
- org.testng.reporters.JUnitXMLReporter

All Implemented Interfaces:

IConfigurationListener, IConfigurationListener2, IResultListener, IResultListener2, ITestListener, ITestNGListener
```
public class JUnitXMLReporter
extends java.lang.Object
implements IResultListener2
```
A JUnit XML report generator (replacing the original JUnitXMLReporter that was based on XML APIs).

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.util.Map<java.lang.String,java.util.regex.Pattern>`	`ATTR_ESCAPES`
`private static java.util.regex.Pattern`	`ENTITY`
`private static java.util.regex.Pattern`	`GREATER`
`private static java.util.regex.Pattern`	`LESS`
`private java.util.Queue<ITestResult>`	`m_allTests`
`private java.util.Queue<ITestResult>`	`m_configIssues`
`private int`	`m_fileNameIncrementer`
`private java.util.Map<java.lang.String,java.lang.String>`	`m_fileNameMap`
`private int`	`m_numFailed`
`private static java.util.regex.Pattern`	`QUOTE`
`private static java.util.regex.Pattern`	`SINGLE_QUOTE`

Constructor Summary

Constructors
Constructor and Description

JUnitXMLReporter()

Constructors
Constructor and Description
`JUnitXMLReporter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beforeConfiguration(ITestResult tr)` Invoked before a configuration method is invoked.
`private void`	`createElement(XMLStringBuffer doc, ITestResult tr)`
`private void`	`createElementFromIgnoredTests(XMLStringBuffer doc, ITestContext context)`
`private void`	`createElementFromTestResults(XMLStringBuffer document, java.util.Collection<ITestResult> results)`
`private void`	`createFailureElement(XMLStringBuffer doc, ITestResult tr)`
`private void`	`createSkipElement(XMLStringBuffer doc)`
`private java.lang.String`	`encodeAttr(java.lang.String attr)`
`private java.lang.String`	`generateFileName(ITestContext context)` This method guarantees unique file names for reports. Also, this will guarantee that the old reports are overwritten when tests are run again.
`protected void`	`generateReport(ITestContext context)` generate the XML report given what we know from all the test results
`private java.util.Set<java.lang.String>`	`getPackages(ITestContext context)`
`private java.util.Properties`	`getPropertiesFor(ITestNGMethod method, long elapsedTimeMillis)`
`void`	`onConfigurationFailure(ITestResult itr)` Invoked whenever a configuration method failed.
`void`	`onConfigurationSkip(ITestResult itr)` Invoked whenever a configuration method was skipped.
`void`	`onConfigurationSuccess(ITestResult itr)` Invoked whenever a configuration method succeeded.
`void`	`onFinish(ITestContext context)` Invoked after all the tests have run and all their Configuration methods have been called.
`void`	`onStart(ITestContext context)` Invoked after the test class is instantiated and before any configuration method is called.
`void`	`onTestFailedButWithinSuccessPercentage(ITestResult tr)` Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.
`void`	`onTestFailure(ITestResult tr)` Invoked each time a test fails.
`void`	`onTestSkipped(ITestResult tr)` Invoked each time a test is skipped.
`void`	`onTestStart(ITestResult result)` Invoked each time before a test will be invoked.
`void`	`onTestSuccess(ITestResult tr)` Invoked each time a test succeeds.
`private java.lang.String`	`replaceAmpersand(java.lang.String str, java.util.regex.Pattern pattern)`
`private void`	`resetAll()` Reset all member variables for next test.
`(package private) static java.lang.String`	`timeAsGmt()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENTITY
```
private static final java.util.regex.Pattern ENTITY
```
  - LESS
```
private static final java.util.regex.Pattern LESS
```
  - GREATER
```
private static final java.util.regex.Pattern GREATER
```
  - SINGLE_QUOTE
```
private static final java.util.regex.Pattern SINGLE_QUOTE
```
  - QUOTE
```
private static final java.util.regex.Pattern QUOTE
```
  - ATTR_ESCAPES
```
private static final java.util.Map<java.lang.String,java.util.regex.Pattern> ATTR_ESCAPES
```
  - m_numFailed
```
private int m_numFailed
```
  - m_allTests
```
private java.util.Queue<ITestResult> m_allTests
```
  - m_configIssues
```
private java.util.Queue<ITestResult> m_configIssues
```
  - m_fileNameMap
```
private java.util.Map<java.lang.String,java.lang.String> m_fileNameMap
```
  - m_fileNameIncrementer
```
private int m_fileNameIncrementer
```
- Constructor Detail
  - JUnitXMLReporter
```
public JUnitXMLReporter()
```
- Method Detail
  - onTestStart
```
public void onTestStart(ITestResult result)
```
    Description copied from interface: ITestListener
    
    Invoked each time before a test will be invoked. The ITestResult is only partially filled with the references to class, method, start millis and status.
    
    Specified by:
    
    onTestStart in interface ITestListener
    
    Parameters:
    
    result - the partially filled ITestResult
    
    See Also:
    
    ITestResult.STARTED
  - beforeConfiguration
```
public void beforeConfiguration(ITestResult tr)
```
    Description copied from interface: IConfigurationListener2
    
    Invoked before a configuration method is invoked.
    
    Specified by:
    
    beforeConfiguration in interface IConfigurationListener2
  - onTestSuccess
```
public void onTestSuccess(ITestResult tr)
```
    Invoked each time a test succeeds.
    
    Specified by:
    
    onTestSuccess in interface ITestListener
    
    Parameters:
    
    tr - ITestResult containing information about the run test
    
    See Also:
    
    ITestResult.SUCCESS
  - onTestFailedButWithinSuccessPercentage
```
public void onTestFailedButWithinSuccessPercentage(ITestResult tr)
```
    Description copied from interface: ITestListener
    
    Invoked each time a method fails but has been annotated with successPercentage and this failure still keeps it within the success percentage requested.
    
    Specified by:
    
    onTestFailedButWithinSuccessPercentage in interface ITestListener
    
    Parameters:
    
    tr - ITestResult containing information about the run test
    
    See Also:
    
    ITestResult.SUCCESS_PERCENTAGE_FAILURE
  - onTestFailure
```
public void onTestFailure(ITestResult tr)
```
    Invoked each time a test fails.
    
    Specified by:
    
    onTestFailure in interface ITestListener
    
    Parameters:
    
    tr - ITestResult containing information about the run test
    
    See Also:
    
    ITestResult.FAILURE
  - onTestSkipped
```
public void onTestSkipped(ITestResult tr)
```
    Invoked each time a test is skipped.
    
    Specified by:
    
    onTestSkipped in interface ITestListener
    
    Parameters:
    
    tr - ITestResult containing information about the run test
    
    See Also:
    
    ITestResult.SKIP
  - onStart
```
public void onStart(ITestContext context)
```
    Invoked after the test class is instantiated and before any configuration method is called.
    
    Specified by:
    
    onStart in interface ITestListener
  - onFinish
```
public void onFinish(ITestContext context)
```
    Invoked after all the tests have run and all their Configuration methods have been called.
    
    Specified by:
    
    onFinish in interface ITestListener
  - onConfigurationFailure
```
public void onConfigurationFailure(ITestResult itr)
```
    Description copied from interface: IConfigurationListener
    
    Invoked whenever a configuration method failed.
    
    Specified by:
    
    onConfigurationFailure in interface IConfigurationListener
    
    See Also:
    
    IConfigurationListener.onConfigurationFailure(org.testng.ITestResult)
  - onConfigurationSkip
```
public void onConfigurationSkip(ITestResult itr)
```
    Description copied from interface: IConfigurationListener
    
    Invoked whenever a configuration method was skipped.
    
    Specified by:
    
    onConfigurationSkip in interface IConfigurationListener
    
    See Also:
    
    IConfigurationListener.onConfigurationSkip(org.testng.ITestResult)
  - onConfigurationSuccess
```
public void onConfigurationSuccess(ITestResult itr)
```
    Description copied from interface: IConfigurationListener
    
    Invoked whenever a configuration method succeeded.
    
    Specified by:
    
    onConfigurationSuccess in interface IConfigurationListener
    
    See Also:
    
    IConfigurationListener.onConfigurationSuccess(org.testng.ITestResult)
  - generateReport
```
protected void generateReport(ITestContext context)
```
    generate the XML report given what we know from all the test results
  - timeAsGmt
```
static java.lang.String timeAsGmt()
```
  - createElementFromTestResults
```
private void createElementFromTestResults(XMLStringBuffer document,
                                          java.util.Collection<ITestResult> results)
```
  - createElementFromIgnoredTests
```
private void createElementFromIgnoredTests(XMLStringBuffer doc,
                                           ITestContext context)
```
  - getPropertiesFor
```
private java.util.Properties getPropertiesFor(ITestNGMethod method,
                                              long elapsedTimeMillis)
```
  - getPackages
```
private java.util.Set<java.lang.String> getPackages(ITestContext context)
```
  - createElement
```
private void createElement(XMLStringBuffer doc,
                           ITestResult tr)
```
  - createFailureElement
```
private void createFailureElement(XMLStringBuffer doc,
                                  ITestResult tr)
```
  - createSkipElement
```
private void createSkipElement(XMLStringBuffer doc)
```
  - encodeAttr
```
private java.lang.String encodeAttr(java.lang.String attr)
```
  - replaceAmpersand
```
private java.lang.String replaceAmpersand(java.lang.String str,
                                          java.util.regex.Pattern pattern)
```
  - resetAll
```
private void resetAll()
```
    Reset all member variables for next test.
  - generateFileName
```
private java.lang.String generateFileName(ITestContext context)
```
    This method guarantees unique file names for reports.
    Also, this will guarantee that the old reports are overwritten when tests are run again.
    
    Parameters:
    
    context - test context
    
    Returns:
    
    unique name for the file associated with this test context.

Class JUnitXMLReporter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENTITY

LESS

GREATER

SINGLE_QUOTE

QUOTE

ATTR_ESCAPES

m_numFailed

m_allTests

m_configIssues

m_fileNameMap

m_fileNameIncrementer

Constructor Detail

JUnitXMLReporter

Method Detail

onTestStart

beforeConfiguration

onTestSuccess

onTestFailedButWithinSuccessPercentage

onTestFailure

onTestSkipped

onStart

onFinish

onConfigurationFailure

onConfigurationSkip

onConfigurationSuccess

generateReport

timeAsGmt

createElementFromTestResults

createElementFromIgnoredTests

getPropertiesFor

getPackages

createElement

createFailureElement

createSkipElement

encodeAttr

replaceAmpersand

resetAll

generateFileName