src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java - ant - Git at Google

 /*
  * The Apache Software License, Version 1.1
  *
  * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowlegement:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowlegement may appear in the software itself,
  *    if and wherever such third-party acknowlegements normally appear.
  *
  * 4. The names "The Jakarta Project", "Ant", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
  *    from this software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache"
  *    nor may "Apache" appear in their names without prior written
  *    permission of the Apache Group.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */

 package org.apache.tools.ant.taskdefs.optional.junit;

 import java.io.OutputStream;
 import java.io.Writer;
 import java.io.OutputStreamWriter;
 import java.io.IOException;


 import java.util.Properties;
 import java.util.Enumeration;
 import java.util.Hashtable;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Text;
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.util.DOMElementWriter;

 import junit.framework.AssertionFailedError;
 import junit.framework.Test;


 /**
  * Prints XML output of the test to a specified Writer.
  *
  * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
  * @author <a href="mailto:ehatcher@apache.org">Erik Hatcher</a>
  *
  * @see FormatterElement
  */

 public class XMLJUnitResultFormatter implements JUnitResultFormatter, XMLConstants {

     private static DocumentBuilder getDocumentBuilder() {
         try {
             return DocumentBuilderFactory.newInstance().newDocumentBuilder();
         }
         catch(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.
      */
     private Hashtable testElements = new Hashtable();
     /**
      * Timing helper.
      */
     private Hashtable testStarts = new Hashtable();
     /**
      * Where to write the log to.
      */
     private OutputStream out;

     public XMLJUnitResultFormatter() {}

     public void setOutput(OutputStream out) {
         this.out = out;
     }

     public void setSystemOutput(String out) {
         formatOutput(SYSTEM_OUT, out);
     }

     public void setSystemError(String out) {
         formatOutput(SYSTEM_ERR, out);
     }

     /**
      * The whole testsuite started.
      */
     public void startTestSuite(JUnitTest suite) {
         doc = getDocumentBuilder().newDocument();
         rootElement = doc.createElement(TESTSUITE);
         rootElement.setAttribute(ATTR_NAME, suite.getName());

         // Output properties
         Element propsElement = doc.createElement(PROPERTIES);
         rootElement.appendChild(propsElement);
         Properties props = suite.getProperties();
         if (props != null) {
             Enumeration e = props.propertyNames();
             while (e.hasMoreElements()) {
                 String name = (String) e.nextElement();
                 Element propElement = doc.createElement(PROPERTY);
                 propElement.setAttribute(ATTR_NAME, name);
                 propElement.setAttribute(ATTR_VALUE, props.getProperty(name));
                 propsElement.appendChild(propElement);
             }
         }
     }

     /**
      * The whole testsuite ended.
      */
     public void endTestSuite(JUnitTest suite) throws BuildException {
         rootElement.setAttribute(ATTR_TESTS, ""+suite.runCount());
         rootElement.setAttribute(ATTR_FAILURES, ""+suite.failureCount());
         rootElement.setAttribute(ATTR_ERRORS, ""+suite.errorCount());
         rootElement.setAttribute(ATTR_TIME, ""+(suite.getRunTime()/1000.0));
         if (out != null) {
             Writer wri = null;
             try {
                 wri = new OutputStreamWriter(out, "UTF8");
                 wri.write("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n");
                 (new DOMElementWriter()).write(rootElement, wri, 0, "  ");
                 wri.flush();
             } catch(IOException exc) {
                 throw new BuildException("Unable to write log file", exc);
             } finally {
                 if (out != System.out && out != System.err) {
                     if (wri != null) {
                         try {
                             wri.close();
                         } catch (IOException e) {}
                     }
                 }
             }
         }
     }

     /**
      * Interface TestListener.
      *
      * <p>A new Test is started.
      */
     public void startTest(Test t) {
         testStarts.put(t, new Long(System.currentTimeMillis()));

         Element currentTest = doc.createElement(TESTCASE);
         currentTest.setAttribute(ATTR_NAME,
                                  JUnitVersionHelper.getTestCaseName(t));
         rootElement.appendChild(currentTest);
         testElements.put(t, currentTest);
     }

     /**
      * Interface TestListener.
      *
      * <p>A Test is finished.
      */
     public void endTest(Test test) {
         Element currentTest = (Element) testElements.get(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 (currentTest == null) {
             startTest(test);
             currentTest = (Element) testElements.get(test);
         }

         Long l = (Long) testStarts.get(test);
         currentTest.setAttribute(ATTR_TIME,
                                  ""+((System.currentTimeMillis()-l.longValue())
                                            / 1000.0));
     }

     /**
      * Interface TestListener for JUnit &lt;= 3.4.
      *
      * <p>A Test failed.
      */
     public void addFailure(Test test, Throwable t) {
         formatError(FAILURE, test, t);
     }

     /**
      * Interface TestListener for JUnit &gt; 3.4.
      *
      * <p>A Test failed.
      */
     public void addFailure(Test test, AssertionFailedError t) {
         addFailure(test, (Throwable) t);
     }

     /**
      * Interface TestListener.
      *
      * <p>An error occured while running the test.
      */
     public void addError(Test test, Throwable t) {
         formatError(ERROR, test, t);
     }

     private void formatError(String type, Test test, Throwable t) {
         if (test != null) {
             endTest(test);
         }

         Element nested = doc.createElement(type);
         Element currentTest = null;
         if (test != null) {
             currentTest = (Element) testElements.get(test);
         } else {
             currentTest = rootElement;
         }

         currentTest.appendChild(nested);

         String message = t.getMessage();
         if (message != null && message.length() > 0) {
             nested.setAttribute(ATTR_MESSAGE, t.getMessage());
         }
         nested.setAttribute(ATTR_TYPE, t.getClass().getName());

         String strace = JUnitTestRunner.getFilteredTrace(t);
         Text trace = doc.createTextNode(strace);
         nested.appendChild(trace);
     }

     private void formatOutput(String type, String output) {
         Element nested = doc.createElement(type);
         rootElement.appendChild(nested);
         Text content = doc.createTextNode(output);
         nested.appendChild(content);
     }

 } // XMLJUnitResultFormatter
	/*
	* The Apache Software License, Version 1.1
	*
	* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution, if
	* any, must include the following acknowlegement:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowlegement may appear in the software itself,
	* if and wherever such third-party acknowlegements normally appear.
	*
	* 4. The names "The Jakarta Project", "Ant", and "Apache Software
	* Foundation" must not be used to endorse or promote products derived
	* from this software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache"
	* nor may "Apache" appear in their names without prior written
	* permission of the Apache Group.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/

	package org.apache.tools.ant.taskdefs.optional.junit;

	import java.io.OutputStream;
	import java.io.Writer;
	import java.io.OutputStreamWriter;
	import java.io.IOException;




	import java.util.Properties;
	import java.util.Enumeration;
	import java.util.Hashtable;
	import javax.xml.parsers.DocumentBuilder;
	import javax.xml.parsers.DocumentBuilderFactory;
	import org.w3c.dom.Document;
	import org.w3c.dom.Element;
	import org.w3c.dom.Text;
	import org.apache.tools.ant.BuildException;
	import org.apache.tools.ant.util.DOMElementWriter;

	import junit.framework.AssertionFailedError;
	import junit.framework.Test;


	/**
	* Prints XML output of the test to a specified Writer.
	*
	* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
	* @author <a href="mailto:ehatcher@apache.org">Erik Hatcher</a>
	*
	* @see FormatterElement
	*/

	public class XMLJUnitResultFormatter implements JUnitResultFormatter, XMLConstants {

	private static DocumentBuilder getDocumentBuilder() {
	try {
	return DocumentBuilderFactory.newInstance().newDocumentBuilder();
	}
	catch(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.
	*/
	private Hashtable testElements = new Hashtable();
	/**
	* Timing helper.
	*/
	private Hashtable testStarts = new Hashtable();
	/**
	* Where to write the log to.
	*/
	private OutputStream out;

	public XMLJUnitResultFormatter() {}

	public void setOutput(OutputStream out) {
	this.out = out;
	}

	public void setSystemOutput(String out) {
	formatOutput(SYSTEM_OUT, out);
	}

	public void setSystemError(String out) {
	formatOutput(SYSTEM_ERR, out);
	}

	/**
	* The whole testsuite started.
	*/
	public void startTestSuite(JUnitTest suite) {
	doc = getDocumentBuilder().newDocument();
	rootElement = doc.createElement(TESTSUITE);
	rootElement.setAttribute(ATTR_NAME, suite.getName());

	// Output properties
	Element propsElement = doc.createElement(PROPERTIES);
	rootElement.appendChild(propsElement);
	Properties props = suite.getProperties();
	if (props != null) {
	Enumeration e = props.propertyNames();
	while (e.hasMoreElements()) {
	String name = (String) e.nextElement();
	Element propElement = doc.createElement(PROPERTY);
	propElement.setAttribute(ATTR_NAME, name);
	propElement.setAttribute(ATTR_VALUE, props.getProperty(name));
	propsElement.appendChild(propElement);
	}
	}
	}

	/**
	* The whole testsuite ended.
	*/
	public void endTestSuite(JUnitTest suite) throws BuildException {
	rootElement.setAttribute(ATTR_TESTS, ""+suite.runCount());
	rootElement.setAttribute(ATTR_FAILURES, ""+suite.failureCount());
	rootElement.setAttribute(ATTR_ERRORS, ""+suite.errorCount());
	rootElement.setAttribute(ATTR_TIME, ""+(suite.getRunTime()/1000.0));
	if (out != null) {
	Writer wri = null;
	try {
	wri = new OutputStreamWriter(out, "UTF8");
	wri.write("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n");
	(new DOMElementWriter()).write(rootElement, wri, 0, " ");
	wri.flush();
	} catch(IOException exc) {
	throw new BuildException("Unable to write log file", exc);
	} finally {
	if (out != System.out && out != System.err) {
	if (wri != null) {
	try {
	wri.close();
	} catch (IOException e) {}
	}
	}
	}
	}
	}

	/**
	* Interface TestListener.
	*
	* <p>A new Test is started.
	*/
	public void startTest(Test t) {
	testStarts.put(t, new Long(System.currentTimeMillis()));

	Element currentTest = doc.createElement(TESTCASE);
	currentTest.setAttribute(ATTR_NAME,
	JUnitVersionHelper.getTestCaseName(t));
	rootElement.appendChild(currentTest);
	testElements.put(t, currentTest);
	}

	/**
	* Interface TestListener.
	*
	* <p>A Test is finished.
	*/
	public void endTest(Test test) {
	Element currentTest = (Element) testElements.get(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 (currentTest == null) {
	startTest(test);
	currentTest = (Element) testElements.get(test);
	}

	Long l = (Long) testStarts.get(test);
	currentTest.setAttribute(ATTR_TIME,
	""+((System.currentTimeMillis()-l.longValue())
	/ 1000.0));
	}

	/**
	* Interface TestListener for JUnit <= 3.4.
	*
	* <p>A Test failed.
	*/
	public void addFailure(Test test, Throwable t) {
	formatError(FAILURE, test, t);
	}

	/**
	* Interface TestListener for JUnit > 3.4.
	*
	* <p>A Test failed.
	*/
	public void addFailure(Test test, AssertionFailedError t) {
	addFailure(test, (Throwable) t);
	}

	/**
	* Interface TestListener.
	*
	* <p>An error occured while running the test.
	*/
	public void addError(Test test, Throwable t) {
	formatError(ERROR, test, t);
	}

	private void formatError(String type, Test test, Throwable t) {
	if (test != null) {
	endTest(test);
	}

	Element nested = doc.createElement(type);
	Element currentTest = null;
	if (test != null) {
	currentTest = (Element) testElements.get(test);
	} else {
	currentTest = rootElement;
	}

	currentTest.appendChild(nested);

	String message = t.getMessage();
	if (message != null && message.length() > 0) {
	nested.setAttribute(ATTR_MESSAGE, t.getMessage());
	}
	nested.setAttribute(ATTR_TYPE, t.getClass().getName());

	String strace = JUnitTestRunner.getFilteredTrace(t);
	Text trace = doc.createTextNode(strace);
	nested.appendChild(trace);
	}

	private void formatOutput(String type, String output) {
	Element nested = doc.createElement(type);
	rootElement.appendChild(nested);
	Text content = doc.createTextNode(output);
	nested.appendChild(content);
	}

	} // XMLJUnitResultFormatter