/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.taskdefs.optional.junit;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Date;
import java.util.Hashtable;
import java.util.Map;
import java.util.Properties;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import junit.framework.AssertionFailedError;
import junit.framework.Test;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.util.DOMElementWriter;
import org.apache.tools.ant.util.DateUtils;
import org.apache.tools.ant.util.FileUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
/**
* Prints XML output of the test to a specified Writer.
*
* @see FormatterElement
*/
public class XMLJUnitResultFormatter implements JUnitResultFormatter, XMLConstants, IgnoredTestListener {
private static final double ONE_SECOND = 1000.0;
/** constant for unnnamed testsuites/cases */
private static final String UNKNOWN = "unknown";
private static DocumentBuilder getDocumentBuilder() {
try {
return DocumentBuilderFactory.newInstance().newDocumentBuilder();
} catch (final Exception exc) {
throw new ExceptionInInitializerError(exc);
}
}
/**
* The XML document.
*/
private Document doc;
/**
* The wrapper for the whole testsuite.
*/
private Element rootElement;
/**
* Element for the current test.
*
* The keying of this map is a bit of a hack: tests are keyed by caseName(className) since
* the Test we get for Test-start isn't the same as the Test we get during test-assumption-fail,
* so we can't easily match Test objects without manually iterating over all keys and checking
* individual fields.
*/
private final Hashtable<String, Element> testElements = new Hashtable<>();
/**
* tests that failed.
*/
private final Map<Test, Test> failedTests = new Hashtable<>();
/**
* Tests that were skipped.
*/
private final Map<String, Test> skippedTests = new Hashtable<>();
/**
* Tests that were ignored. See the note above about the key being a bit of a hack.
*/
private final Map<String, Test> ignoredTests = new Hashtable<>();
/**
* Timing helper.
*/
private final Map<String, Long> testStarts = new Hashtable<>();
/**
* Where to write the log to.
*/
private OutputStream out;
/** {@inheritDoc}. */
@Override
public void setOutput(final OutputStream out) {
this.out = out;
}
/** {@inheritDoc}. */
@Override
public void setSystemOutput(final String out) {
formatOutput(SYSTEM_OUT, out);
}
/** {@inheritDoc}. */
@Override
public void setSystemError(final String out) {
formatOutput(SYSTEM_ERR, out);
}
/**
* The whole testsuite started.
* @param suite the testsuite.
*/
@Override
public void startTestSuite(final JUnitTest suite) {
doc = getDocumentBuilder().newDocument();
rootElement = doc.createElement(TESTSUITE);
final String n = suite.getName();
rootElement.setAttribute(ATTR_NAME, n == null ? UNKNOWN : n);
//add the timestamp
final String timestamp = DateUtils.format(new Date(),
DateUtils.ISO8601_DATETIME_PATTERN);
rootElement.setAttribute(TIMESTAMP, timestamp);
//and the hostname.
rootElement.setAttribute(HOSTNAME, getHostname());
// Output properties
final Element propsElement = doc.createElement(PROPERTIES);
rootElement.appendChild(propsElement);
final Properties props = suite.getProperties();
if (props != null) {
for (String name : props.stringPropertyNames()) {
final Element propElement = doc.createElement(PROPERTY);
propElement.setAttribute(ATTR_NAME, name);
propElement.setAttribute(ATTR_VALUE, props.getProperty(name));
propsElement.appendChild(propElement);
}
}
}
/**
* get the local hostname
* @return the name of the local host, or "localhost" if we cannot work it out
*/
private String getHostname() {
String hostname = "localhost";
try {
final InetAddress localHost = InetAddress.getLocalHost();
if (localHost != null) {
hostname = localHost.getHostName();
}
} catch (final UnknownHostException e) {
// fall back to default 'localhost'
}
return hostname;
}
/**
* The whole testsuite ended.
* @param suite the testsuite.
* @throws BuildException on error.
*/
@Override
public void endTestSuite(final JUnitTest suite) throws BuildException {
rootElement.setAttribute(ATTR_TESTS, Long.toString(suite.runCount()));
rootElement.setAttribute(ATTR_FAILURES, Long.toString(suite.failureCount()));
rootElement.setAttribute(ATTR_ERRORS, Long.toString(suite.errorCount()));
rootElement.setAttribute(ATTR_SKIPPED, Long.toString(suite.skipCount()));
rootElement.setAttribute(
ATTR_TIME, Double.toString(suite.getRunTime() / ONE_SECOND));
if (out != null) {
Writer wri = null;
try {
wri = new BufferedWriter(new OutputStreamWriter(out, "UTF8"));
wri.write("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n");
new DOMElementWriter().write(rootElement, wri, 0, " ");
} catch (final IOException exc) {
throw new BuildException("Unable to write log file", exc);
} finally {
if (wri != null) {
try {
wri.flush();
} catch (final IOException ex) {
// ignore
}
}
if (out != System.out && out != System.err) {
FileUtils.close(wri);
}
}
}
}
/**
* Interface TestListener.
*
* <p>A new Test is started.
* @param t the test.
*/
@Override
public void startTest(final Test t) {
testStarts.put(createDescription(t), System.currentTimeMillis());
}
private static String createDescription(final Test test) throws BuildException {
return JUnitVersionHelper.getTestCaseName(test) + "("
+ JUnitVersionHelper.getTestCaseClassName(test) + ")";
}
/**
* Interface TestListener.
*
* <p>A Test is finished.
* @param test the test.
*/
@Override
public void endTest(final Test test) {
final String testDescription = createDescription(test);
// Fix for bug #5637 - if a junit.extensions.TestSetup is
// used and throws an exception during setUp then startTest
// would never have been called
if (!testStarts.containsKey(testDescription)) {
startTest(test);
}
Element currentTest;
if (!failedTests.containsKey(test)
&& !skippedTests.containsKey(testDescription)
&& !ignoredTests.containsKey(testDescription)) {
currentTest = doc.createElement(TESTCASE);
final String n = JUnitVersionHelper.getTestCaseName(test);
currentTest.setAttribute(ATTR_NAME,
n == null ? UNKNOWN : n);
// a TestSuite can contain Tests from multiple classes,
// even tests with the same name - disambiguate them.
currentTest.setAttribute(ATTR_CLASSNAME,
JUnitVersionHelper.getTestCaseClassName(test));
rootElement.appendChild(currentTest);
testElements.put(createDescription(test), currentTest);
} else {
currentTest = testElements.get(testDescription);
}
final Long l = testStarts.get(createDescription(test));
currentTest.setAttribute(ATTR_TIME,
Double.toString((System.currentTimeMillis() - l) / ONE_SECOND));
}
/**
* Interface TestListener for JUnit <= 3.4.
*
* <p>A Test failed.
* @param test the test.
* @param t the exception.
*/
public void addFailure(final Test test, final Throwable t) {
formatError(FAILURE, test, t);
}
/**
* Interface TestListener for JUnit > 3.4.
*
* <p>A Test failed.
* @param test the test.
* @param t the assertion.
*/
@Override
public void addFailure(final Test test, final AssertionFailedError t) {
addFailure(test, (Throwable) t);
}
/**
* Interface TestListener.
*
* <p>An error occurred while running the test.
* @param test the test.
* @param t the error.
*/
@Override
public void addError(final Test test, final Throwable t) {
formatError(ERROR, test, t);
}
private void formatError(final String type, final Test test, final Throwable t) {
if (test != null) {
endTest(test);
failedTests.put(test, test);
}
final Element nested = doc.createElement(type);
Element currentTest = test == null ? rootElement
: testElements.get(createDescription(test));
currentTest.appendChild(nested);
final String message = t.getMessage();
if (message != null && message.length() > 0) {
nested.setAttribute(ATTR_MESSAGE, t.getMessage());
}
nested.setAttribute(ATTR_TYPE, t.getClass().getName());
final String strace = JUnitTestRunner.getFilteredTrace(t);
final Text trace = doc.createTextNode(strace);
nested.appendChild(trace);
}
private void formatOutput(final String type, final String output) {
final Element nested = doc.createElement(type);
rootElement.appendChild(nested);
nested.appendChild(doc.createCDATASection(output));
}
@Override
public void testIgnored(final Test test) {
formatSkip(test, JUnitVersionHelper.getIgnoreMessage(test));
if (test != null) {
ignoredTests.put(createDescription(test), test);
}
}
public void formatSkip(final Test test, final String message) {
if (test != null) {
endTest(test);
}
final Element nested = doc.createElement("skipped");
if (message != null) {
nested.setAttribute("message", message);
}
Element currentTest = test == null ? rootElement
: testElements.get(createDescription(test));
currentTest.appendChild(nested);
}
@Override
public void testAssumptionFailure(final Test test, final Throwable failure) {
formatSkip(test, failure.getMessage());
skippedTests.put(createDescription(test), test);
}
} // XMLJUnitResultFormatter