bodewig 01/05/04 01:03:55
Modified: . WHATSNEW build.xml
docs/manual/OptionalTasks junit.html
src/main/org/apache/tools/ant/taskdefs/optional/junit
FormatterElement.java
Added: src/main/org/apache/tools/ant/taskdefs/optional/junit
BriefJUnitResultFormatter.java
Log:
Add a new formatter "brief" for <junit>
PR: 1175
Submitted by: Robert Watkins <robert.watkins@qsipayments.com>
Revision Changes Path
1.106 +8 -0 jakarta-ant/WHATSNEW
Index: WHATSNEW
===================================================================
RCS file: /home/cvs/jakarta-ant/WHATSNEW,v
retrieving revision 1.105
retrieving revision 1.106
diff -u -r1.105 -r1.106
--- WHATSNEW 2001/05/03 07:46:33 1.105
+++ WHATSNEW 2001/05/04 08:03:43 1.106
@@ -15,6 +15,9 @@
* The <pvcs> task has been move to a package of its own.
+* JUnitResultFormater has two additional methods that must be
+ implemented by custom formatters.
+
Other changes:
--------------
@@ -50,6 +53,8 @@
with the "file" attribute to specify whether the "file" you're
looking for is a file or a directory.
+* New <junit> formatter named "brief"
+
Fixed bugs:
-----------
@@ -79,6 +84,9 @@
* If the quiet attribute has been set, <delete> will handle <fileset>s
with non-existing directories gracefully.
+
+* Output written by testcases will now be captured by the <junit> task
+ and passed to the formatters.
Changes from Ant 1.2 to Ant 1.3
===========================================
1.149 +1 -1 jakarta-ant/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-ant/build.xml,v
retrieving revision 1.148
retrieving revision 1.149
diff -u -r1.148 -r1.149
--- build.xml 2001/05/01 10:31:42 1.148
+++ build.xml 2001/05/04 08:03:44 1.149
@@ -615,7 +615,7 @@
<sysproperty key="build.tests" value="${build.tests}"/>
- <formatter type="plain" usefile="false" />
+ <formatter type="brief" usefile="false" />
<batchtest>
<fileset dir="${tests.dir}">
1.4 +12 -5 jakarta-ant/docs/manual/OptionalTasks/junit.html
Index: junit.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/junit.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- junit.html 2001/04/10 13:58:19 1.3
+++ junit.html 2001/05/04 08:03:49 1.4
@@ -25,7 +25,11 @@
</tr>
<tr>
<td valign="top">printsummary</td>
- <td valign="top">Print one line statistics for each testcase.</td>
+ <td valign="top">Print one line statistics for each testcase. Can
+ take the values "on", "off" and
+ "withOutAndErr" - "withOutAndErr" is the same
+ as "on" but also includes the test's output
+ (written to System.out and System.err).</td>
<td align="center" valign="top">No, default is "off"</td>
</tr>
<tr>
@@ -122,9 +126,11 @@
name of the test and can be set by the <code>outfile</code> attribute
of <code><test></code>.
-<p>There are two predefined formatters, one prints the test results in
-XML format, the other emits plain text. Custom formatters that need to
-implement
+<p>There are three predefined formatters, one prints the test results
+in XML format, the other emit plain text. The formatter named
+"brief" will only print detailed information for testcases
+that failed, while "plain" gives a little statistics line
+for all test cases. Custom formatters that need to implement
<code>org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter</code>
can be specified.</p>
@@ -136,7 +142,8 @@
</tr>
<tr>
<td valign="top">type</td>
- <td valign="top">Use a predefined formatter (either "xml" or "plain").</td>
+ <td valign="top">Use a predefined formatter (either
+ "xml", "plain" or "brief").</td>
<td align="center" rowspan="2">Exactly one of these.</td>
</tr>
<tr>
1.4 +7 -3 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java
Index: FormatterElement.java
===================================================================
RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- FormatterElement.java 2001/01/03 14:18:44 1.3
+++ FormatterElement.java 2001/05/04 08:03:53 1.4
@@ -79,8 +79,12 @@
if ("xml".equals(type.getValue())) {
setClassname("org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter");
setExtension(".xml");
- } else { // must be plain, ensured by TypeAttribute
- setClassname("org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter");
+ } else {
+ if ("brief".equals(type.getValue())) {
+ setClassname("org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter");
+ } else { // must be plain, ensured by TypeAttribute
+ setClassname("org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter");
+ }
setExtension(".txt");
}
}
@@ -160,7 +164,7 @@
*/
public static class TypeAttribute extends EnumeratedAttribute {
public String[] getValues() {
- return new String[] {"plain", "xml"};
+ return new String[] {"plain", "xml", "brief"};
}
}
}
1.1 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java
Index: BriefJUnitResultFormatter.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 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 org.apache.tools.ant.BuildException;
import junit.framework.*;
/**
* Prints plain text output of the test to a specified Writer.
* Inspired by the PlainJUnitResultFormatter.
* @author <a href="mailto:robertdw@bigpond.net.au">Robert Watkins</a>
*/
public class BriefJUnitResultFormatter implements JUnitResultFormatter {
/**
* Where to write the log to.
*/
private java.io.OutputStream m_out;
/**
* Used for writing the results.
*/
private java.io.PrintWriter m_output;
/**
* Used as part of formatting the results.
*/
private java.io.StringWriter m_results;
/**
* Used for writing formatted results to.
*/
private java.io.PrintWriter m_resultWriter;
/**
* Formatter for timings.
*/
private java.text.NumberFormat m_numberFormat = java.text.NumberFormat.getInstance();
/**
* Output suite has written to System.out
*/
private String systemOutput = null;
/**
* Output suite has written to System.err
*/
private String systemError = null;
public BriefJUnitResultFormatter() {
m_results = new java.io.StringWriter();
m_resultWriter = new java.io.PrintWriter(m_results);
}
/**
* Sets the stream the formatter is supposed to write its results to.
*/
public void setOutput(java.io.OutputStream out) {
m_out = out;
m_output = new java.io.PrintWriter(out);
}
public void setSystemOutput(String out) {
systemOutput = out;
}
public void setSystemError(String err) {
systemError = err;
}
protected java.io.PrintWriter output() { return m_output; }
protected java.io.PrintWriter resultWriter() { return m_resultWriter; }
/**
* The whole testsuite started.
*/
public void startTestSuite(JUnitTest suite) throws BuildException {
}
/**
* The whole testsuite ended.
*/
public void endTestSuite(JUnitTest suite) throws BuildException {
String newLine = System.getProperty("line.separator");
StringBuffer sb = new StringBuffer("Testsuite: ");
sb.append(suite.getName());
sb.append(newLine);
sb.append("Tests run: ");
sb.append(suite.runCount());
sb.append(", Failures: ");
sb.append(suite.failureCount());
sb.append(", Errors: ");
sb.append(suite.errorCount());
sb.append(", Time elapsed: ");
sb.append(m_numberFormat.format(suite.getRunTime()/1000.0));
sb.append(" sec");
sb.append(newLine);
sb.append(newLine);
// append the err and output streams to the log
if (systemOutput != null && systemOutput.length() > 0) {
sb.append("------------- Standard Output ---------------" )
.append(newLine)
.append(systemOutput)
.append("------------- ---------------- ---------------" )
.append(newLine);
}
if (systemError != null && systemError.length() > 0) {
sb.append("------------- Standard Error -----------------" )
.append(newLine)
.append(systemError)
.append("------------- ---------------- ---------------" )
.append(newLine);
}
if ( output() != null) {
try {
output().write(sb.toString());
resultWriter().close();
output().write(m_results.toString());
output().flush();
} finally {
if (m_out != (Object)System.out &&
m_out != (Object)System.err) {
try {
m_out.close();
} catch (java.io.IOException e) {}
}
}
}
}
/**
* A test started.
*/
public void startTest(Test test) {
}
/**
* A test ended.
*/
public void endTest(Test test) {
}
/**
* A test failed.
*/
public void addFailure(Test test, AssertionFailedError failure) {
formatError("\tFAILED", test, failure);
}
/**
* A test caused an error.
*/
public void addError(Test test, Throwable error) {
formatError("\tCaused an ERROR", test, error);
}
/**
* Format the test for printing..
*/
protected String formatTest(Test test) {
if (test == null) {
return "Null Test: ";
}
else {
return "Testcase: " + test.toString() + ":";
}
}
/**
* Format an error and print it.
*/
protected void formatError(String type, Test test, Throwable error) {
if (test != null) {
endTest(test);
}
resultWriter().println(formatTest(test) + ":" + type);
resultWriter().println(error.getMessage());
error.printStackTrace(resultWriter());
resultWriter().println("");
}
}
|