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

Class JUnitTestRunner

public class JUnitTestRunner extends Object implements TestListener, JUnitTaskMirror.JUnitTestRunnerMirror

Simple Testrunner for JUnit that runs all tests of a testsuite.

This TestRunner expects a name of a TestCase class as its argument. If this class provides a static suite() method it will be called and the resulting Test will be run. So, the signature should be


     public static junit.framework.Test suite()
 

If no such method exists, all public methods starting with "test" and taking no argument will be run.

Summary output is generated at the end.

Since: Ant 1.2

Constructor Summary
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure)
Constructor for fork=true or when the user hasn't specified a classpath.
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput)
Constructor for fork=true or when the user hasn't specified a classpath.
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, boolean logTestListenerEvents)
Constructor for fork=true or when the user hasn't specified a classpath.
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, ClassLoader loader)
Constructor to use when the user has specified a classpath.
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, ClassLoader loader)
Constructor to use when the user has specified a classpath.
JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, boolean logTestListenerEvents, ClassLoader loader)
Constructor to use when the user has specified a classpath.
Method Summary
voidaddError(Test test, Throwable t)
Interface TestListener.
voidaddFailure(Test test, Throwable t)
Interface TestListener for JUnit <= 3.4.
voidaddFailure(Test test, AssertionFailedError t)
Interface TestListener for JUnit > 3.4.
voidaddFormatter(JUnitResultFormatter f)
Add a formatter.
voidaddFormatter(JUnitTaskMirror.JUnitResultFormatterMirror f)
{@inheritDoc}.
voidendTest(Test test)
Interface TestListener.
static StringfilterStack(String stack)
Filters stack frames from internal JUnit and Ant classes
static StringgetFilteredTrace(Throwable t)
Returns a filtered stack trace.
intgetRetCode()
Returns what System.exit() would return in the standalone version.
voidhandleErrorFlush(String output)
{@inheritDoc}.
voidhandleErrorOutput(String output)
{@inheritDoc}.
voidhandleFlush(String output)
{@inheritDoc}.
inthandleInput(byte[] buffer, int offset, int length)
Handle input.
voidhandleOutput(String output)
Handle a string destined for standard output.
static voidmain(String[] args)
Entry point for standalone (forked) mode.
voidrun()
Run the test.
voidsetPermissions(Permissions permissions)
Permissions for the test run.
voidstartTest(Test t)
Interface TestListener.

Constructor Detail

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure)
Constructor for fork=true or when the user hasn't specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found.

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput)
Constructor for fork=true or when the user hasn't specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found. showOutput whether to send output to System.out/.err as well as formatters.

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, boolean logTestListenerEvents)
Constructor for fork=true or when the user hasn't specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found. showOutput whether to send output to System.out/.err as well as formatters. logTestListenerEvents whether to print TestListener events.

Since: Ant 1.7

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, ClassLoader loader)
Constructor to use when the user has specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found. loader the classloader to use running the test.

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, ClassLoader loader)
Constructor to use when the user has specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found. showOutput whether to send output to System.out/.err as well as formatters. loader the classloader to use running the test.

JUnitTestRunner

public JUnitTestRunner(JUnitTest test, boolean haltOnError, boolean filtertrace, boolean haltOnFailure, boolean showOutput, boolean logTestListenerEvents, ClassLoader loader)
Constructor to use when the user has specified a classpath.

Parameters: test the test to run. haltOnError whether to stop the run if an error is found. filtertrace whether to filter junit.*.* stack frames out of exceptions haltOnFailure whether to stop the run if failure is found. showOutput whether to send output to System.out/.err as well as formatters. logTestListenerEvents whether to print TestListener events. loader the classloader to use running the test.

Since: Ant 1.7

Method Detail

addError

public void addError(Test test, Throwable t)
Interface TestListener.

An error occurred while running the test.

Parameters: test the test. t the error thrown by the test.

addFailure

public void addFailure(Test test, Throwable t)
Interface TestListener for JUnit <= 3.4.

A Test failed.

Parameters: test the test. t the exception thrown by the test.

addFailure

public void addFailure(Test test, AssertionFailedError t)
Interface TestListener for JUnit > 3.4.

A Test failed.

Parameters: test the test. t the assertion thrown by the test.

addFormatter

public void addFormatter(JUnitResultFormatter f)
Add a formatter.

Parameters: f the formatter to add.

addFormatter

public void addFormatter(JUnitTaskMirror.JUnitResultFormatterMirror f)
{@inheritDoc}.

endTest

public void endTest(Test test)
Interface TestListener.

A Test is finished.

Parameters: test the test.

filterStack

public static String filterStack(String stack)
Filters stack frames from internal JUnit and Ant classes

Parameters: stack the stack trace to filter.

Returns: the filtered stack.

getFilteredTrace

public static String getFilteredTrace(Throwable t)
Returns a filtered stack trace. This is ripped out of junit.runner.BaseTestRunner.

Parameters: t the exception to filter.

Returns: the filtered stack trace.

getRetCode

public int getRetCode()
Returns what System.exit() would return in the standalone version.

Returns: 2 if errors occurred, 1 if tests failed else 0.

handleErrorFlush

public void handleErrorFlush(String output)
{@inheritDoc}.

handleErrorOutput

public void handleErrorOutput(String output)
{@inheritDoc}.

handleFlush

public void handleFlush(String output)
{@inheritDoc}.

handleInput

public int handleInput(byte[] buffer, int offset, int length)
Handle input.

Parameters: buffer not used. offset not used. length not used.

Returns: -1 always.

Throws: IOException never.

Since: Ant 1.6

See Also: (byte[], int, int)

handleOutput

public void handleOutput(String output)
Handle a string destined for standard output.

Parameters: output the string to output

main

public static void main(String[] args)
Entry point for standalone (forked) mode. Parameters: testcaseclassname plus parameters in the format key=value, none of which is required.
keydescriptiondefault value
haltOnErrorhalt test on errors?false
haltOnFailurehalt test on failures?false
formatterA JUnitResultFormatter given as classname,filename. If filename is ommitted, System.out is assumed.none
showoutputsend output to System.err/.out as well as to the formatters?false
logtestlistenereventslog TestListener events to System.out.false

Parameters: args the command line arguments.

Throws: IOException on error.

run

public void run()
Run the test.

setPermissions

public void setPermissions(Permissions permissions)
Permissions for the test run.

Parameters: permissions the permissions to use.

Since: Ant 1.6

startTest

public void startTest(Test t)
Interface TestListener.

A new Test is started.

Parameters: t the test.