org.testng.reporters.XMLReporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of testng Show documentation
Show all versions of testng Show documentation
TestNG is a testing framework.
package org.testng.reporters;
import org.testng.IReporter;
import org.testng.ISuite;
import org.testng.ISuiteResult;
import org.testng.ITestContext;
import org.testng.ITestNGMethod;
import org.testng.Reporter;
import org.testng.internal.Utils;
import org.testng.xml.XmlSuite;
import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
/**
* The main entry for the XML generation operation
*
* @author Cosmin Marginean, Mar 16, 2007
*/
public class XMLReporter implements IReporter {
public static final String FILE_NAME = "testng-results.xml";
private final XMLReporterConfig config = new XMLReporterConfig();
private XMLStringBuffer rootBuffer;
@Override
public void generateReport(List xmlSuites, List suites,
String outputDirectory) {
if (Utils.isStringEmpty(config.getOutputDirectory())) {
config.setOutputDirectory(outputDirectory);
}
rootBuffer = new XMLStringBuffer("");
rootBuffer.push(XMLReporterConfig.TAG_TESTNG_RESULTS);
writeReporterOutput(rootBuffer);
for (int i = 0; i < suites.size(); i++) {
writeSuite(suites.get(i).getXmlSuite(), suites.get(i));
}
rootBuffer.pop();
Utils.writeUtf8File(config.getOutputDirectory(), FILE_NAME, rootBuffer.toXML());
}
private void writeReporterOutput(XMLStringBuffer xmlBuffer) {
// TODO: Cosmin - maybe a element isn't indicated for each line
xmlBuffer.push(XMLReporterConfig.TAG_REPORTER_OUTPUT);
List output = Reporter.getOutput();
for (String line : output) {
if (line != null) {
xmlBuffer.push(XMLReporterConfig.TAG_LINE);
xmlBuffer.addCDATA(line);
xmlBuffer.pop();
}
}
xmlBuffer.pop();
}
private void writeSuite(XmlSuite xmlSuite, ISuite suite) {
switch (config.getFileFragmentationLevel()) {
case XMLReporterConfig.FF_LEVEL_NONE:
writeSuiteToBuffer(rootBuffer, suite);
break;
case XMLReporterConfig.FF_LEVEL_SUITE:
case XMLReporterConfig.FF_LEVEL_SUITE_RESULT:
File suiteFile = referenceSuite(rootBuffer, suite);
writeSuiteToFile(suiteFile, suite);
}
}
private void writeSuiteToFile(File suiteFile, ISuite suite) {
XMLStringBuffer xmlBuffer = new XMLStringBuffer("");
writeSuiteToBuffer(xmlBuffer, suite);
File parentDir = suiteFile.getParentFile();
if (parentDir.exists() || suiteFile.getParentFile().mkdirs()) {
Utils.writeFile(parentDir.getAbsolutePath(), FILE_NAME, xmlBuffer.toXML());
}
}
private File referenceSuite(XMLStringBuffer xmlBuffer, ISuite suite) {
String relativePath = suite.getName() + File.separatorChar + FILE_NAME;
File suiteFile = new File(config.getOutputDirectory(), relativePath);
Properties attrs = new Properties();
attrs.setProperty(XMLReporterConfig.ATTR_URL, relativePath);
xmlBuffer.addEmptyElement(XMLReporterConfig.TAG_SUITE, attrs);
return suiteFile;
}
private void writeSuiteToBuffer(XMLStringBuffer xmlBuffer, ISuite suite) {
xmlBuffer.push(XMLReporterConfig.TAG_SUITE, getSuiteAttributes(suite));
writeSuiteGroups(xmlBuffer, suite);
Map results = suite.getResults();
XMLSuiteResultWriter suiteResultWriter = new XMLSuiteResultWriter(config);
for (Map.Entry result : results.entrySet()) {
suiteResultWriter.writeSuiteResult(xmlBuffer, result.getValue());
}
xmlBuffer.pop();
}
private void writeSuiteGroups(XMLStringBuffer xmlBuffer, ISuite suite) {
xmlBuffer.push(XMLReporterConfig.TAG_GROUPS);
Map> methodsByGroups = suite.getMethodsByGroups();
for (Map.Entry> entry : methodsByGroups.entrySet()) {
Properties groupAttrs = new Properties();
groupAttrs.setProperty(XMLReporterConfig.ATTR_NAME, entry.getKey());
xmlBuffer.push(XMLReporterConfig.TAG_GROUP, groupAttrs);
Set groupMethods = getUniqueMethodSet(entry.getValue());
for (ITestNGMethod groupMethod : groupMethods) {
Properties methodAttrs = new Properties();
methodAttrs.setProperty(XMLReporterConfig.ATTR_NAME, groupMethod.getMethodName());
methodAttrs.setProperty(XMLReporterConfig.ATTR_METHOD_SIG, groupMethod.toString());
methodAttrs.setProperty(XMLReporterConfig.ATTR_CLASS, groupMethod.getRealClass().getName());
xmlBuffer.addEmptyElement(XMLReporterConfig.TAG_METHOD, methodAttrs);
}
xmlBuffer.pop();
}
xmlBuffer.pop();
}
private Properties getSuiteAttributes(ISuite suite) {
Properties props = new Properties();
props.setProperty(XMLReporterConfig.ATTR_NAME, suite.getName());
// Calculate the duration
Map results = suite.getResults();
Date minStartDate = new Date();
Date maxEndDate = null;
// TODO: We could probably optimize this in order not to traverse this twice
for (Map.Entry result : results.entrySet()) {
ITestContext testContext = result.getValue().getTestContext();
Date startDate = testContext.getStartDate();
Date endDate = testContext.getEndDate();
if (minStartDate.after(startDate)) {
minStartDate = startDate;
}
if (maxEndDate == null || maxEndDate.before(endDate)) {
maxEndDate = endDate != null ? endDate : startDate;
}
}
// The suite could be completely empty
if (maxEndDate == null) {
maxEndDate = minStartDate;
}
addDurationAttributes(config, props, minStartDate, maxEndDate);
return props;
}
/**
* Add started-at, finished-at and duration-ms attributes to the tag
*/
public static void addDurationAttributes(XMLReporterConfig config, Properties attributes,
Date minStartDate, Date maxEndDate) {
SimpleDateFormat format = new SimpleDateFormat(XMLReporterConfig.getTimestampFormat());
String startTime = format.format(minStartDate);
String endTime = format.format(maxEndDate);
long duration = maxEndDate.getTime() - minStartDate.getTime();
attributes.setProperty(XMLReporterConfig.ATTR_STARTED_AT, startTime);
attributes.setProperty(XMLReporterConfig.ATTR_FINISHED_AT, endTime);
attributes.setProperty(XMLReporterConfig.ATTR_DURATION_MS, Long.toString(duration));
}
private Set getUniqueMethodSet(Collection methods) {
Set result = new LinkedHashSet();
for (ITestNGMethod method : methods) {
result.add(method);
}
return result;
}
// TODO: This is not the smartest way to implement the config
public int getFileFragmentationLevel() {
return config.getFileFragmentationLevel();
}
public void setFileFragmentationLevel(int fileFragmentationLevel) {
config.setFileFragmentationLevel(fileFragmentationLevel);
}
public int getStackTraceOutputMethod() {
return config.getStackTraceOutputMethod();
}
public void setStackTraceOutputMethod(int stackTraceOutputMethod) {
config.setStackTraceOutputMethod(stackTraceOutputMethod);
}
public String getOutputDirectory() {
return config.getOutputDirectory();
}
public void setOutputDirectory(String outputDirectory) {
config.setOutputDirectory(outputDirectory);
}
public boolean isGenerateGroupsAttribute() {
return config.isGenerateGroupsAttribute();
}
public void setGenerateGroupsAttribute(boolean generateGroupsAttribute) {
config.setGenerateGroupsAttribute(generateGroupsAttribute);
}
public boolean isSplitClassAndPackageNames() {
return config.isSplitClassAndPackageNames();
}
public void setSplitClassAndPackageNames(boolean splitClassAndPackageNames) {
config.setSplitClassAndPackageNames(splitClassAndPackageNames);
}
public String getTimestampFormat() {
return config.getTimestampFormat();
}
public void setTimestampFormat(String timestampFormat) {
config.setTimestampFormat(timestampFormat);
}
public boolean isGenerateDependsOnMethods() {
return config.isGenerateDependsOnMethods();
}
public void setGenerateDependsOnMethods(boolean generateDependsOnMethods) {
config.setGenerateDependsOnMethods(generateDependsOnMethods);
}
public void setGenerateDependsOnGroups(boolean generateDependsOnGroups) {
config.setGenerateDependsOnGroups(generateDependsOnGroups);
}
public boolean isGenerateDependsOnGroups() {
return config.isGenerateDependsOnGroups();
}
}