To spawn a new Java VM to prevent interferences between
* different testcases, you need to enable fork.
*
- * @author Thomas Haas
- * @author Stefan Bodewig
+ * @author Thomas Haas
+ * @author Stefan Bodewig
* @author Stephane Bailliez
*/
public class JUnitTask extends Task {
+
+ private CommandlineJava commandline = new CommandlineJava();
+ private Vector tests = new Vector();
+ private Vector batchTests = new Vector();
+ private Vector formatters = new Vector();
+ private File dir = null;
+
+ private Integer timeout = null;
+ private boolean summary = false;
+
+ /**
+ * Tells this task to halt when there is an error in a test.
+ * this property is applied on all BatchTest (batchtest) and JUnitTest (test)
+ * however it can possibly be overridden by their own properties.
+ * @param value true if it should halt, otherwise false
+ */
+ public void setHaltonerror(boolean value) {
+ Enumeration enum = allTests();
+ while (enum.hasMoreElements()) {
+ BaseTest test = (BaseTest) enum.nextElement();
+ test.setHaltonerror(value);
+ }
+ }
+
+ /**
+ * Tells this task to halt when there is a failure in a test.
+ * this property is applied on all BatchTest (batchtest) and JUnitTest (test)
+ * however it can possibly be overridden by their own properties.
+ * @param value true if it should halt, otherwise false
+ */
+ public void setHaltonfailure(boolean value) {
+ Enumeration enum = allTests();
+ while (enum.hasMoreElements()) {
+ BaseTest test = (BaseTest) enum.nextElement();
+ test.setHaltonfailure(value);
+ }
+ }
+
+ /**
+ * Tells whether a JVM should be forked for each testcase. It avoids interference
+ * between testcases and possibly avoids hanging the build.
+ * this property is applied on all BatchTest (batchtest) and JUnitTest (test)
+ * however it can possibly be overridden by their own properties.
+ * @param value true if a JVM should be forked, otherwise false
+ * @see #setTimeout(Integer)
+ * @see #haltOntimeout(boolean)
+ */
+ public void setFork(boolean value) {
+ Enumeration enum = allTests();
+ while (enum.hasMoreElements()) {
+ BaseTest test = (BaseTest) enum.nextElement();
+ test.setFork(value);
+ }
+ }
+
+ /**
+ * Tells whether the task should print a short summary of the task.
+ * @param value true to print a summary, false otherwise.
+ * @see SummaryJUnitResultFormatter
+ */
+ public void setPrintsummary(boolean value) {
+ summary = value;
+ }
+
+ /**
+ * Set the timeout value (in milliseconds). If the test is running for more than this
+ * value, the test will be canceled. (works only when in 'fork' mode).
+ * @param value the maximum time (in milliseconds) allowed before declaring the test
+ * as 'timed-out'
+ * @see #setFork(boolean)
+ * @see #haltOnTimeout(boolean)
+ */
+ public void setTimeout(Integer value) {
+ timeout = value;
+ }
+
+ /**
+ * Set the maximum memory to be used by all forked JVMs.
+ * @param max the value as defined by -mx or -Xmx
+ * in the java command line options.
+ */
+ public void setMaxmemory(String max) {
+ if (Project.getJavaVersion().startsWith("1.1")) {
+ createJvmarg().setValue("-mx"+max);
+ } else {
+ createJvmarg().setValue("-Xmx"+max);
+ }
+ }
+
+ /**
+ * Set a new VM to execute the testcase. Default is java. Ignored if no JVM is forked.
+ * @param value the new VM to use instead of java
+ * @see #setFork(boolean)
+ */
+ public void setJvm(String value) {
+ commandline.setVm(value);
+ }
+
+ /**
+ * Create a new JVM argument. Ignored if no JVM is forked.
+ * @return create a new JVM argument so that any argument can be passed to the JVM.
+ * @see #setFork(boolean)
+ */
+ public Commandline.Argument createJvmarg() {
+ return commandline.createVmArgument();
+ }
+
+ /**
+ * The directory to invoke the VM in. Ignored if no JVM is forked.
+ * @param dir the directory to invoke the JVM from.
+ * @see #setFork(boolean)
+ */
+ public void setDir(File dir) {
+ this.dir = dir;
+ }
+
+ /**
+ * Add a nested sysproperty element. This might be useful to tranfer
+ * Ant properties to the testcases when JVM forking is not enabled.
+ */
+ public void addSysproperty(Environment.Variable sysp) {
+ commandline.addSysproperty(sysp);
+ }
+
+ /**
+ * create a classpath to use for forked jvm
+ */
+ public Path createClasspath() {
+ return commandline.createClasspath(project).createPath();
+ }
+
+ /**
+ * Add a new single testcase.
+ * @param test a new single testcase
+ * @see JUnitTest
+ */
+ public void addTest(JUnitTest test) {
+ tests.addElement(test);
+ }
+
+ /**
+ * Create a new set of testcases (also called ..batchtest) and add it to the list.
+ * @return a new instance of a batch test.
+ * @see BatchTest
+ */
+ public BatchTest createBatchTest() {
+ BatchTest test = new BatchTest(project);
+ batchTests.addElement(test);
+ return test;
+ }
+
+ /**
+ * Add a new formatter to all tests of this task.
+ */
+ public void addFormatter(FormatterElement fe) {
+ formatters.addElement(fe);
+ }
+
+ /**
+ * Creates a new JUnitRunner and enables fork of a new Java VM.
+ */
+ public JUnitTask() throws Exception {
+ commandline.setClassname("org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner");
+ }
+
+ /**
+ * Runs the testcase.
+ */
+ public void execute() throws BuildException {
+ Enumeration list = getIndividualTests();
+ try {
+ while (list.hasMoreElements()) {
+ JUnitTest test = (JUnitTest)list.nextElement();
+ if ( test.shouldRun(project)) {
+ execute(test);
+ }
+ }
+ } finally {
+ //@todo here we should run test aggregation (SBa)
+ }
+ }
+
+ protected void execute(JUnitTest test) throws BuildException {
+ // set the default values if not specified
+ //@todo should be moved to the test class (?) (SBa)
+ if (test.getTodir() == null) {
+ test.setTodir(project.resolveFile("."));
+ }
+
+ if (test.getOutfile() == null) {
+ test.setOutfile( "TEST-" + test.getName() );
+ }
+
+ // execute the test and get the return code
+ int exitValue = JUnitTestRunner.ERRORS;
+ boolean wasKilled = false;
+ if (!test.getFork()) {
+ exitValue = executeInVM(test);
+ } else {
+ ExecuteWatchdog watchdog = createWatchdog();
+ exitValue = executeAsForked(test, watchdog);
+ // null watchdog means no timeout, you'd better not check with null
+ if (watchdog != null) {
+ //info will be used in later version do nothing for now
+ //wasKilled = watchdog.killedProcess();
+ }
+ }
+
+ // if there is an error/failure and that it should halt, stop everything otherwise
+ // just log a statement
+ boolean errorOccurredHere = exitValue == JUnitTestRunner.ERRORS;
+ boolean failureOccurredHere = exitValue != JUnitTestRunner.SUCCESS;
+ if (errorOccurredHere && test.getHaltonerror()
+ || failureOccurredHere && test.getHaltonfailure()) {
+ throw new BuildException("Test "+test.getName()+" failed",
+ location);
+ } else if (errorOccurredHere || failureOccurredHere) {
+ log("TEST "+test.getName()+" FAILED", Project.MSG_ERR);
+ }
+ }
+
+ /**
+ * Execute a testcase by forking a new JVM. The command will block until
+ * it finishes. To know if the process was destroyed or not, use the
+ * killedProcess() method of the watchdog class.
+ * @param test the testcase to execute.
+ * @param watchdog the watchdog in charge of cancelling the test if it
+ * exceeds a certain amount of time. Can be null, in this case
+ * the test could probably hang forever.
+ */
+ private int executeAsForked(JUnitTest test, ExecuteWatchdog watchdog) throws BuildException {
+ CommandlineJava cmd = (CommandlineJava) commandline.clone();
+
+ cmd.setClassname("org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner");
+ cmd.createArgument().setValue(test.getName());
+ cmd.createArgument().setValue("haltOnError=" + test.getHaltonerror());
+ cmd.createArgument().setValue("haltOnFailure=" + test.getHaltonfailure());
+ if (summary) {
+ log("Running " + test.getName(), Project.MSG_INFO);
+ cmd.createArgument().setValue("formatter=org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter");
+ }
+
+ StringBuffer formatterArg = new StringBuffer(128);
+ final FormatterElement[] feArray = mergeFormatters(test);
+ for (int i = 0; i < feArray.length; i++) {
+ FormatterElement fe = feArray[i];
+ formatterArg.append("formatter=");
+ formatterArg.append(fe.getClassname());
+ File outFile = getOutput(fe,test);
+ if (outFile != null) {
+ formatterArg.append(",");
+ formatterArg.append( outFile );
+ }
+ cmd.createArgument().setValue(formatterArg.toString());
+ formatterArg.setLength(0);
+ }
+
+ Execute execute = new Execute(new LogStreamHandler(this, Project.MSG_INFO, Project.MSG_WARN), watchdog);
+ execute.setCommandline(cmd.getCommandline());
+ if (dir != null) {
+ execute.setWorkingDirectory(dir);
+ execute.setAntRun(project);
+ }
+
+ log("Executing: "+cmd.toString(), Project.MSG_VERBOSE);
+ try {
+ return execute.execute();
+ } catch (IOException e) {
+ throw new BuildException("Process fork failed.", e, location);
+ }
+ }
+
+ // in VM is not very nice since it could probably hang the
+ // whole build. IMHO this method should be avoided and it would be best
+ // to remove it in future versions. TBD. (SBa)
+
+ /**
+ * Execute inside VM.
+ */
+ private int executeInVM(JUnitTest test) throws BuildException {
+ if (dir != null) {
+ log("dir attribute ignored if running in the same VM", Project.MSG_WARN);
+ }
+
+ CommandlineJava.SysProperties sysProperties = commandline.getSystemProperties();
+ if (sysProperties != null) {
+ sysProperties.setSystem();
+ }
+ try {
+ log("Using System properties " + System.getProperties(), Project.MSG_VERBOSE);
+ AntClassLoader cl = null;
+ Path classpath = commandline.getClasspath();
+ if (classpath != null) {
+ log("Using CLASSPATH " + classpath, Project.MSG_VERBOSE);
+
+ cl = new AntClassLoader(project, classpath, false);
+ // make sure the test will be accepted as a TestCase
+ cl.addSystemPackageRoot("junit");
+ // will cause trouble in JDK 1.1 if omitted
+ cl.addSystemPackageRoot("org.apache.tools.ant");
+ }
+ JUnitTestRunner runner = new JUnitTestRunner(test, test.getHaltonerror(), test.getHaltonfailure(), cl);
+
+ if (summary) {
+ log("Running " + test.getName(), Project.MSG_INFO);
+
+ SummaryJUnitResultFormatter f = new SummaryJUnitResultFormatter();
+ f.setOutput( getDefaultOutput() );
+ runner.addFormatter(f);
+ }
+
+ final FormatterElement[] feArray = mergeFormatters(test);
+ for (int i = 0; i < feArray.length; i++) {
+ FormatterElement fe = feArray[i];
+ File outFile = getOutput(fe,test);
+ if (outFile == null) {
+ fe.setOutput( getDefaultOutput() );
+ }
+ runner.addFormatter(fe.createFormatter());
+ }
+
+ runner.run();
+ return runner.getRetCode();
+ } finally{
+ if (sysProperties != null) {
+ sysProperties.restoreSystem();
+ }
+ }
+ }
+
+ /**
+ * @return null if there is a timeout value, otherwise the
+ * watchdog instance.
+ */
+ protected ExecuteWatchdog createWatchdog() throws BuildException {
+ if (timeout == null){
+ return null;
+ }
+ return new ExecuteWatchdog(timeout.intValue());
+ }
+
+ /**
+ * get the default output for a formatter.
+ */
+ protected OutputStream getDefaultOutput(){
+ return new LogOutputStream(this, Project.MSG_INFO);
+ }
+
+ /**
+ * Merge all individual tests from the batchtest with all individual tests
+ * and return an enumeration over all JUnitTest.
+ */
+ protected Enumeration getIndividualTests(){
+ Enumeration[] enums = new Enumeration[ batchTests.size() + 1];
+ for (int i = 0; i < batchTests.size(); i++) {
+ BatchTest batchtest = (BatchTest)batchTests.elementAt(i);
+ enums[i] = batchtest.elements();
+ }
+ enums[enums.length - 1] = tests.elements();
+ return Enumerations.fromCompound(enums);
+ }
+
+ protected Enumeration allTests() {
+ Enumeration[] enums = { tests.elements(), batchTests.elements() };
+ return Enumerations.fromCompound(enums);
+ }
+
+ private FormatterElement[] mergeFormatters(JUnitTest test){
+ Vector feVector = (Vector)formatters.clone();
+ FormatterElement[] fes = test.getFormatters();
+ FormatterElement[] feArray = new FormatterElement[feVector.size() + fes.length];
+ feVector.copyInto(feArray);
+ System.arraycopy(fes, 0, feArray, feVector.size(), fes.length);
+ return feArray;
+ }
+
+ /** return the file or null if does not use a file */
+ protected File getOutput(FormatterElement fe, JUnitTest test){
+ if (fe.getUseFile()) {
+ String filename = test.getOutfile() + fe.getExtension();
+ File destFile = new File( test.getTodir(), filename );
+ String absFilename = destFile.getAbsolutePath();
+ return project.resolveFile(absFilename);
+ }
+ return null;
+ }
- private CommandlineJava commandline = new CommandlineJava();
- private Vector tests = new Vector();
- private Vector batchTests = new Vector();
- private Vector formatters = new Vector();
- private File dir = null;
-
- private Integer timeout = null;
- private boolean summary = false;
-
- public void setHaltonerror(boolean value) {
- Enumeration enum = allTests();
- while (enum.hasMoreElements()) {
- BaseTest test = (BaseTest) enum.nextElement();
- test.setHaltonerror(value);
- }
- }
-
- public void setHaltonfailure(boolean value) {
- Enumeration enum = allTests();
- while (enum.hasMoreElements()) {
- BaseTest test = (BaseTest) enum.nextElement();
- test.setHaltonfailure(value);
- }
- }
-
- public void setPrintsummary(boolean value) {
- summary = value;
- }
-
- public void setMaxmemory(String max) {
- if (Project.getJavaVersion().startsWith("1.1")) {
- createJvmarg().setValue("-mx"+max);
- } else {
- createJvmarg().setValue("-Xmx"+max);
- }
- }
-
- public void setTimeout(Integer value) {
- timeout = value;
- }
-
- public void setFork(boolean value) {
- Enumeration enum = allTests();
- while (enum.hasMoreElements()) {
- BaseTest test = (BaseTest) enum.nextElement();
- test.setFork(value);
- }
- }
-
- public void setJvm(String value) {
- commandline.setVm(value);
- }
-
- public Commandline.Argument createJvmarg() {
- return commandline.createVmArgument();
- }
-
- public Path createClasspath() {
- return commandline.createClasspath(project).createPath();
- }
-
- public void addTest(JUnitTest test) {
- tests.addElement(test);
- }
-
- public BatchTest createBatchTest() {
- BatchTest test = new BatchTest(project);
- batchTests.addElement(test);
- return test;
- }
-
- public void addFormatter(FormatterElement fe) {
- formatters.addElement(fe);
- }
-
- /**
- * The directory to invoke the VM in.
- *
- *
Ignored if fork=false. - */ - public void setDir(File dir) { - this.dir = dir; - } - - /** - * Creates a new JUnitRunner and enables fork of a new Java VM. - */ - public JUnitTask() throws Exception { - commandline.setClassname("org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner"); - } - - /** - * Runs the testcase. - */ - public void execute() throws BuildException { - boolean errorOccurred = false; - boolean failureOccurred = false; - - Vector runTests = (Vector) tests.clone(); - - Enumeration list = batchTests.elements(); - while (list.hasMoreElements()) { - BatchTest test = (BatchTest)list.nextElement(); - Enumeration list2 = test.elements(); - while (list2.hasMoreElements()) { - runTests.addElement(list2.nextElement()); - } - } - - list = runTests.elements(); - while (list.hasMoreElements()) { - JUnitTest test = (JUnitTest)list.nextElement(); - - if (!test.shouldRun(project)) { - continue; - } - - if (test.getTodir() == null){ - test.setTodir(project.resolveFile(".")); - } - - if (test.getOutfile() == null) { - test.setOutfile( "TEST-" + test.getName() ); - } - - int exitValue = JUnitTestRunner.ERRORS; - - if (!test.getFork()) { - - if (dir != null) { - log("dir attribute ignored if running in the same VM", - Project.MSG_WARN); - } - - JUnitTestRunner runner = null; - - Path classpath = commandline.getClasspath(); - if (classpath != null) { - log("Using CLASSPATH " + classpath, Project.MSG_VERBOSE); - AntClassLoader l = new AntClassLoader(project, classpath, - false); - // make sure the test will be accepted as a TestCase - l.addSystemPackageRoot("junit"); - // will cause trouble in JDK 1.1 if omitted - l.addSystemPackageRoot("org.apache.tools.ant"); - runner = new JUnitTestRunner(test, test.getHaltonerror(), - test.getHaltonfailure(), l); - } else { - runner = new JUnitTestRunner(test, test.getHaltonerror(), - test.getHaltonfailure()); - } - - if (summary) { - log("Running " + test.getName(), Project.MSG_INFO); - - SummaryJUnitResultFormatter f = - new SummaryJUnitResultFormatter(); - f.setOutput(new LogOutputStream(this, Project.MSG_INFO)); - runner.addFormatter(f); - } - - for (int i=0; i