diff --git a/src/main/org/apache/ant/antunit/AntUnit.java b/src/main/org/apache/ant/antunit/AntUnit.java
index 5a63131..9cfc2b6 100644
--- a/src/main/org/apache/ant/antunit/AntUnit.java
+++ b/src/main/org/apache/ant/antunit/AntUnit.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2005 The Apache Software Foundation
+ * Copyright 2005-2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -46,30 +46,75 @@ import org.apache.tools.ant.types.FileSet;
*/
public class AntUnit extends Task {
+ /**
+ * name of the magic setUp target.
+ */
private static final String SETUP = "setUp";
+ /**
+ * prefix that identifies test targets.
+ */
private static final String TEST = "test";
+ /**
+ * name of the magic tearDown target.
+ */
private static final String TEARDOWN = "tearDown";
+ /**
+ * The build files to process.
+ */
private ArrayList filesets = new ArrayList();
+
+ /**
+ * project instance for the build file currently under test.
+ */
private Project newProject;
+ /**
+ * listeners.
+ */
private ArrayList listeners = new ArrayList();
+ /**
+ * has a failure occured?
+ */
private int failures=0;
+ /**
+ * has an error occured?
+ */
private int errors=0;
+ /**
+ * stop testing if an error or failure occurs?
+ */
private boolean failOnError=true;
- public static final String ERROR_TESTS_FAILED = "Tests failed with ";
- public static final String ERROR_NO_FILESET = "You must specify at least one nested"
- + " fileset.";
+ /**
+ * Message to print if an error or failure occured.
+ */
+ public static final String ERROR_TESTS_FAILED = "Tests failed with ";
+
+ /**
+ * Message if no tests have been specified.
+ */
+ public static final String ERROR_NO_FILESET =
+ "You must specify at least one nested fileset.";
+
+ /**
+ * adds build files to run as tests.
+ */
public void add(FileSet fs) {
filesets.add(fs);
}
+ /**
+ * Adds a test listener.
+ */
public void add(AntUnitListener al) {
listeners.add(al);
}
+ /**
+ * stop testing if an error or failure occurs?
+ */
public void setFailOnError(boolean failOnError) {
this.failOnError = failOnError;
}
@@ -90,6 +135,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Processes a fileset.
+ */
private void doFileSet(FileSet fs) {
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
File fromDir = fs.getDir(getProject());
@@ -99,7 +147,11 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Processes a single build file.
+ */
private void doFile(File f) {
+ // setup project instance
newProject = new Project();
newProject.setDefaultInputStream(getProject().getDefaultInputStream());
newProject.setJavaVersionProperty();
@@ -107,10 +159,16 @@ public class AntUnit extends Task {
getProject().initSubProject(newProject);
newProject.setUserProperty("ant.file" , f.getAbsolutePath());
attachListeners(f, newProject);
+
+ // read build file
ProjectHelper.configureProject(newProject, f);
+
+ // find targets
Map targets = newProject.getTargets();
Target setUp = (Target) targets.get(SETUP);
Target tearDown = (Target) targets.get(TEARDOWN);
+
+ // start test
newProject.fireBuildStarted();
Throwable caught = null;
try {
@@ -131,6 +189,10 @@ public class AntUnit extends Task {
} catch (BuildException e) {
BuildException orig = e;
boolean failed = false;
+
+ // try to see whether the BuildException masks
+ // an AssertionFailedException. if so, treat
+ // it as failure instead of error.
Throwable t = e.getCause();
while (t != null && t instanceof BuildException) {
if (t instanceof AssertionFailedException) {
@@ -140,10 +202,12 @@ public class AntUnit extends Task {
}
t = ((BuildException) t).getCause();
}
+
if (!failed) {
fireError(name, e);
}
} finally {
+ // clean up
if (tearDown != null) {
newProject.executeTarget(TEARDOWN);
}
@@ -158,6 +222,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Redirect output to new project instance.
+ */
public void handleOutput(String outputToHandle) {
if (newProject != null) {
newProject.demuxOutput(outputToHandle, false);
@@ -166,6 +233,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Redirect input to new project instance.
+ */
public int handleInput(byte[] buffer, int offset, int length)
throws IOException {
if (newProject != null) {
@@ -174,6 +244,9 @@ public class AntUnit extends Task {
return super.handleInput(buffer, offset, length);
}
+ /**
+ * Redirect flush to new project instance.
+ */
public void handleFlush(String toFlush) {
if (newProject != null) {
newProject.demuxFlush(toFlush, false);
@@ -182,6 +255,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Redirect error output to new project instance.
+ */
public void handleErrorOutput(String errorOutputToHandle) {
if (newProject != null) {
newProject.demuxOutput(errorOutputToHandle, true);
@@ -190,6 +266,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Redirect error flush to new project instance.
+ */
public void handleErrorFlush(String errorOutputToFlush) {
if (newProject != null) {
newProject.demuxFlush(errorOutputToFlush, true);
@@ -198,6 +277,10 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Wraps all registered test listeners in BuildListeners and
+ * attaches them to the new project instance.
+ */
private void attachListeners(File buildFile, Project p) {
Iterator it = listeners.iterator();
while (it.hasNext()) {
@@ -208,6 +291,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * invokes addFailure on all registered test listeners.
+ */
private void fireFail(String targetName, AssertionFailedException ae) {
failures++;
Iterator it = listeners.iterator();
@@ -217,6 +303,9 @@ public class AntUnit extends Task {
}
}
+ /**
+ * invokes addError on all registered test listeners.
+ */
private void fireError(String targetName, Throwable t) {
errors++;
Iterator it = listeners.iterator();
@@ -226,14 +315,19 @@ public class AntUnit extends Task {
}
}
+ /**
+ * Adapts AntUnitListener to BuildListener.
+ */
private class BuildToAntUnitListener implements BuildListener {
private String buildFile;
private AntUnitListener a;
+
BuildToAntUnitListener(String buildFile, AntUnitListener a) {
this.buildFile = buildFile;
this.a = a;
a.setOutput(new LogOutputStream(AntUnit.this, Project.MSG_INFO));
}
+
public void buildStarted(BuildEvent event) {
a.startTestSuite(buildFile);
}
diff --git a/src/main/org/apache/ant/antunit/AntUnitListener.java b/src/main/org/apache/ant/antunit/AntUnitListener.java
index fecb670..23b439f 100644
--- a/src/main/org/apache/ant/antunit/AntUnitListener.java
+++ b/src/main/org/apache/ant/antunit/AntUnitListener.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2005 The Apache Software Foundation
+ * Copyright 2005-2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,12 +23,36 @@ import java.io.OutputStream;
* A test listener for <antunit>.
*/
public interface AntUnitListener {
+ /**
+ * Sets the stream the listener shall write its output to.
+ *
+ * Usually points to Ant's logging system.
+ */
void setOutput(OutputStream out);
+ /**
+ * Invoked once per build file, before any targets get executed.
+ */
void startTestSuite(String buildFile);
+ /**
+ * Invoked once per build file, after all targets have been executed.
+ */
void endTestSuite(String buildFile);
+ /**
+ * Invoked before a test target gets executed.
+ */
void startTest(String target);
+ /**
+ * Invoked after a test target has been executed.
+ */
void endTest(String target);
+ /**
+ * Invoked if an assert tasked caused an error during execution.
+ */
void addFailure(String target, AssertionFailedException ae);
+ /**
+ * Invoked if any error other than a failed assertion occured
+ * during execution.
+ */
void addError(String target, Throwable ae);
}
\ No newline at end of file
diff --git a/src/main/org/apache/ant/antunit/AssertTask.java b/src/main/org/apache/ant/antunit/AssertTask.java
index 177c70a..136aee0 100644
--- a/src/main/org/apache/ant/antunit/AssertTask.java
+++ b/src/main/org/apache/ant/antunit/AssertTask.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2005 The Apache Software Foundation
+ * Copyright 2005-2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -47,8 +47,14 @@ import org.apache.tools.ant.taskdefs.condition.ConditionBase;
*/
public class AssertTask extends ConditionBase {
+ /**
+ * Message to use when the assertion fails.
+ */
private String message = AssertionFailedException.DEFAULT_MESSAGE;
+ /**
+ * Message to use when the assertion fails.
+ */
public void setMessage(String value) {
this.message = value;
}
diff --git a/src/main/org/apache/ant/antunit/LogCapturer.java b/src/main/org/apache/ant/antunit/LogCapturer.java
index 368370b..6b1d5b2 100644
--- a/src/main/org/apache/ant/antunit/LogCapturer.java
+++ b/src/main/org/apache/ant/antunit/LogCapturer.java
@@ -23,9 +23,9 @@ import org.apache.tools.ant.Project;
/**
* Captures log messages generated during an antunit task run and
- * makes it available to tasks via a project reference.
+ * makes them available to tasks via a project reference.
*
- * This class captures all messaged generated during the build and
+ *
This class captures all messages generated during the build and
* adds itself as project reference to the project using the id
* ant.antunit.log.
*/
diff --git a/src/main/org/apache/ant/antunit/LogContains.java b/src/main/org/apache/ant/antunit/LogContains.java
index 2ce2e6a..bc57819 100644
--- a/src/main/org/apache/ant/antunit/LogContains.java
+++ b/src/main/org/apache/ant/antunit/LogContains.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2005 The Apache Software Foundation
+ * Copyright 2005-2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,16 +26,25 @@ import org.apache.tools.ant.taskdefs.condition.Condition;
/**
* A condition that tests the log output of the current project for a
* given string.
+ *
+ * Works in conjunction with {@link LogCapturer LogCapturer} and
+ * needs the context provided by AntUnit.
*/
public class LogContains extends ProjectComponent implements Condition {
private String text;
private int logLevel = Project.MSG_INFO;
+ /**
+ * Test the log shall contain.
+ */
public void setText(String t) {
text = t;
}
+ /**
+ * minimal log priority to consult.
+ */
public void setLevel(Echo.EchoLevel echoLevel) {
logLevel = echoLevel.getLevel();
}
diff --git a/src/main/org/apache/ant/antunit/PlainAntUnitListener.java b/src/main/org/apache/ant/antunit/PlainAntUnitListener.java
index f59353a..fb0bab5 100644
--- a/src/main/org/apache/ant/antunit/PlainAntUnitListener.java
+++ b/src/main/org/apache/ant/antunit/PlainAntUnitListener.java
@@ -26,7 +26,8 @@ import java.text.NumberFormat;
import org.apache.tools.ant.BuildException;
/**
- * A test listener for <antunit>.
+ * A test listener for <antunit> modeled aftern the Plain JUnit
+ * test listener that is part of Ant.
*/
public class PlainAntUnitListener implements AntUnitListener {
/**
@@ -44,7 +45,13 @@ public class PlainAntUnitListener implements AntUnitListener {
*/
private PrintWriter wri;
+ /**
+ * keeps track of the numer of executed targets, the failures an errors.
+ */
private int runCount, failureCount, errorCount;
+ /**
+ * time for the starts of the current test-suite and test-target.
+ */
private long start, testStart;
public void setOutput(OutputStream out) {
@@ -85,23 +92,6 @@ public class PlainAntUnitListener implements AntUnitListener {
sb.append(" sec");
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 (out != null) {
try {
out.write(sb.toString().getBytes());
@@ -131,6 +121,7 @@ public class PlainAntUnitListener implements AntUnitListener {
double seconds = (System.currentTimeMillis() - testStart) / 1000.0;
wri.println(" took " + nf.format(seconds) + " sec");
}
+
public void addFailure(String target, AssertionFailedException ae) {
failureCount++;
formatError("\tFAILED", ae);