| + + + Use with directories + |
|
+ + subant can be used with directory sets to execute a build from different directories. + 2 different options are offered : + +
|
genericantfile is set, this attribute is ignored.
genericantfile, in order to run the same build file with different basedirs.antfile is ignored.
+ <ant>'s output attribute.
+ Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!
+ subant can be used with directory sets to execute a build from different directories. + 2 different options are offered : +
+/somepath/otherpath/mybuild.xml
+ with different base directories, use the genericantfile attribute
+ directory1/mybuild.xml, directory2/mybuild.xml, ....,
+ use the antfile attribute. The subant task does not set the base directory for you in this case.
<project name="subant" default="subant1">
@@ -41,5 +56,15 @@
where a file called build.xml can be found.
All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead
+
+ <subant target="compile" genericantfile="/opt/project/build1.xml">
+ <dirset dir="." includes="projects*"/>
+ </subant>
+
+
+ assuming the subdirs of the project dir are called projects1, projects2, projects3
+ this snippet will execute the compile target of /opt/project/build1.xml,
+ setting the basedir to projects1, projects2, projects3
+
* Calls a given target for all defined sub-builds. This is an extension * of ant for bulk project execution. - * + *
+ *
+ * subant can be used with directory sets to execute a build from different directories. + * 2 different options are offered + *
+ *true. Otherwise,
* a warning log message is simply output.
*/
- private void execute(File file)
+ private void execute(File file, File directory)
throws BuildException {
if (!file.exists() || file.isDirectory() || !file.canRead()) {
String msg = "Invalid file: "+file;
@@ -150,7 +185,7 @@ public class SubAnt
return;
}
- Ant ant = createAntTask();
+ Ant ant = createAntTask(directory);
String antfilename = null;
try {
antfilename = file.getCanonicalPath();
@@ -172,8 +207,9 @@ public class SubAnt
}
/**
- * Sets the default build file name to append to directory
- * names found in the build path -default "build.xml"
+ * Build file name, to use in conjunction with directories.genericantfile is set, this attribute is ignored.
*
* @param antfile the short build file name. Defaults to "build.xml".
*/
@@ -181,6 +217,17 @@ public class SubAnt
this.antfile = antfile;
}
+ /**
+ * Build file path, to use in conjunction with directories.genericantfile, in order to run the same build file with different basedirs.antfile is ignored.
+ *
+ * @param afile (path of the generic ant file, absolute or relative to project base directory)
+ * */
+ public void setGenericAntfile(File afile) {
+ this.genericantfile=afile;
+ }
+
/**
* Sets whether to fail with a build exception on error, or go on.
*
@@ -190,6 +237,16 @@ public class SubAnt
this.failOnError = failOnError;
}
+ /**
+ * Sets whether to continue or fail with a build exception if the build
+ * file is missing, false by default.
+ *
+ * @param ignoreMissingBuildFile the new value for this boolean flag.
+ */
+ public void setIgnoreMissingBuildFile(boolean ignoreMissingBuildFile) {
+ this.ignoreMissingBuildFile = ignoreMissingBuildFile;
+ }
+
/**
* The target to call on the different sub-builds. Set to "" to execute
* the default target.
@@ -200,6 +257,16 @@ public class SubAnt
this.target = target;
}
+ /**
+ * Corresponds to <ant>'s
+ * output attribute.
+ *
+ * @param s the filename to write the output to.
+ */
+ public void setOutput(String s) {
+ this.output = s;
+ }
+
/**
* Corresponds to <ant>'s
* inheritall attribute.
@@ -288,13 +355,13 @@ public class SubAnt
/**
* Set the buildpath to be used to find sub-projects.
- *
+ *
* @param s an Ant Path object containing the buildpath.
*/
public void setBuildpath(Path s) {
getBuildpath().append(s);
}
-
+
/**
* Creates a nested build path, and add it to the implicit build path.
*
@@ -339,26 +406,37 @@ public class SubAnt
/**
* Creates the <ant> task configured to run a specific target.
*
+ * @param directory : if not null the directory where the build should run
+ *
* @return the ant task, configured with the explicit properties and
* references necessary to run the sub-build.
*/
- private Ant createAntTask() {
+ private Ant createAntTask(File directory) {
Ant ant = (Ant) getProject().createTask("ant");
ant.setOwningTarget(getOwningTarget());
ant.init();
- if(target.length()>0) {
+ if(target != null && target.length()>0) {
ant.setTarget(target);
}
+
+ if (output != null) {
+ ant.setOutput(output);
+ }
+
+ if (directory != null) {
+ ant.setDir(directory);
+ }
+
ant.setInheritAll(inheritAll);
for (Enumeration i = properties.elements(); i.hasMoreElements();) {
copyProperty(ant.createProperty(), (Property) i.nextElement());
}
-
+
for (Enumeration i = propertySets.elements(); i.hasMoreElements();) {
ant.addPropertyset((PropertySet) i.nextElement());
}
-
+
ant.setInheritRefs(inheritRefs);
for (Enumeration i = references.elements(); i.hasMoreElements();) {
ant.addReference((Ant.Reference) i.nextElement());
diff --git a/src/testcases/org/apache/tools/ant/taskdefs/SubAntTest.java b/src/testcases/org/apache/tools/ant/taskdefs/SubAntTest.java
new file mode 100644
index 000000000..9cb4c7091
--- /dev/null
+++ b/src/testcases/org/apache/tools/ant/taskdefs/SubAntTest.java
@@ -0,0 +1,170 @@
+/*
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2003 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 "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
+ *