Using Ant with a Maven project

I recently had to take a Maven 2 WAR project and make it buildable on a system that did not have Maven available. Not being one to duplicate configuration I put together an Ant build script that, when Maven is available, can be used to pull the dependencies into the project file structure in an organized fashion and write out properties about the maven project for use by the script.

Currently the script provides support for doing the equivalent of 'mvn clean package' on a simple Maven managed WAR project.

<br /><project name="Gartner SSO Portlet" basedir="." xmlns:artifact="urn:maven-artifact-ant"><br /> <!--<br /> | The order the scopes are listed here is important, it ensures the correct libraries are available to the correct<br /> | phases and the end build without having duplicates.<br /> +--><br /> <property name="mavenScopes" value="provided,runtime,compile,test" /><br /> <br /> <property name="lib.basedir" value="${basedir}/lib" /><br /> <property name="lib.dir.compile" value="${lib.basedir}/compile" /><br /> <property name="lib.dir.provided" value="${lib.basedir}/provided" /><br /> <property name="lib.dir.test" value="${lib.basedir}/test" /><br /> <property name="lib.dir.runtime" value="${lib.basedir}/runtime" /><br /><br /> <property name="antBuildPropertiesFile" value="${lib.basedir}/build.properties" /><br /><br /> <!-- Maven path related properties not provided by the pom --><br /> <property name="pom.build.resourcesDirectory" value="${basedir}/src/main/resources" /><br /> <property name="pom.build.testResourcesDirectory" value="${basedir}/src/test/resources" /><br /> <property name="pom.build.webappResourcesDirectory" value="${basedir}/src/main/webapp" /><br /> <br /> <property name="dest.dir" value="${basedir}/dist" /><br /><br /><br /> <target name="clean" description="Required by MyUW build process. Cleans all generated files."><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <delete dir="${pom.build.directory}" /><br /> <delete dir="${dest.dir}" /><br /> </target><br /><br /> <target name="dist" description="Required by MyUW build process. Packages a fully build portlet WAR"<br /> depends="resource:resources, compiler:compile, jspc:compile, resource:testResources, compiler:testCompile, surefire:test, war:war"><br /><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <mkdir dir="${dest.dir}"/><br /> <copy file="${pom.build.directory}/${pom.build.finalName}.war" todir="${dest.dir}" /><br /> </target><br /><br /> <br /> <target name="updateAntBuild" description="Updates the dependencies used by the Ant only build, requires Maven be installed."><br /> <!-- remove libraries from previous execution --><br /> <delete dir="${lib.basedir}" /><br /><br /> <!-- load the project's POM --><br /> <artifact:pom file="${basedir}/pom.xml" id="project.pom" /><br /><br /> <!-- Remove the basedir path from pom properties. --><br /> <length property="baseDir.length" string="${basedir}/"/><br /> <property name="localDirRegEx" value=".{${baseDir.length}}(.*)" /><br /> <propertyregex property="build.sourceDirectory" input="${project.pom.build.sourceDirectory}" regexp="${localDirRegEx}" select="\1" /><br /> <propertyregex property="build.testSourceDirectory" input="${project.pom.build.testSourceDirectory}" regexp="${localDirRegEx}" select="\1" /><br /> <propertyregex property="build.directory" input="${project.pom.build.directory}" regexp="${localDirRegEx}" select="\1" /><br /> <propertyregex property="build.outputDirectory" input="${project.pom.build.outputDirectory}" regexp="${localDirRegEx}" select="\1" /><br /> <propertyregex property="build.testOutputDirectory" input="${project.pom.build.testOutputDirectory}" regexp="${localDirRegEx}" select="\1" /><br /><br /> <!-- write out pom information to a .properties file to be used by the ant build --><br /> <mkdir dir="${lib.basedir}" /><br /> <echo file="${antBuildPropertiesFile}"><br />pom.build.finalName=${project.pom.build.finalName}<br />pom.build.sourceDirectory=$${basedir}/${build.sourceDirectory}<br />pom.build.testSourceDirectory=$${basedir}/${build.testSourceDirectory}<br />pom.build.directory=$${basedir}/${build.directory}<br />pom.build.outputDirectory=$${basedir}/${build.outputDirectory}<br />pom.build.testOutputDirectory=$${basedir}/${build.testOutputDirectory}<br /> </echo><br /><br /> <!-- iterate over the declared classpath scopes --><br /> <for param="scope" list="${mavenScopes}" delimiter=","><br /> <sequential><br /> <!-- load the appropriate classpath using the pom --><br /> <artifact:dependencies pathid="project.pom.@{scope}.classpath" verbose="false" usescope="@{scope}"><br /> <pom refid="project.pom" /><br /> </artifact:dependencies><br /><br /> <!-- create a property for the directory the dependencies will be copied to --><br /> <property name="lib.dir.@{scope}" value="${lib.basedir}/@{scope}" /><br /><br /> <!-- create the destination directory --><br /> <mkdir dir="${lib.dir.@{scope}}" /><br /><br /> <!-- iterate over the path and copy the files to the destination directory --><br /> <!-- trycatch needed so that empty path sets don't crash the build or write ugly error messages --><br /> <trycatch><br /> <try><br /> <for param="pathFile"><br /> <path refid="project.pom.@{scope}.classpath" /><br /> <sequential><br /> <basename file="@{pathFile}" property="@{pathFile}.name"/><br /><br /> <!-- Only copy the dependency if it hasn't already be copied into a previous scope --><br /> <var name="includeFile" value="true" /><br /> <var name="doneLooking" value="false" /><br /> <for param="orderedScope" list="${mavenScopes}" delimiter=","><br /> <sequential><br /> <if><br /> <and><br /> <equals arg1="false" arg2="${doneLooking}" /><br /> <not><br /> <equals arg1="@{scope}" arg2="@{orderedScope}" /><br /> </not><br /> </and><br /> <then><br /> <if><br /> <available file="${lib.basedir}/@{orderedScope}/${@{pathFile}.name}" /><br /> <then><br /> <var name="includeFile" value="false" /><br /> <var name="doneLooking" value="true" /><br /> </then><br /> </if><br /> </then><br /> <else><br /> <var name="doneLooking" value="true" /><br /> </else><br /> </if><br /> </sequential><br /> </for><br /> <br /> <if><br /> <equals arg1="true" arg2="${includeFile}" /><br /> <then><br /> <copy file="@{pathFile}" todir="${lib.dir.@{scope}}" /><br /> </then><br /> </if> <br /> </sequential><br /> </for><br /> </try><br /> <catch /><br /> </trycatch><br /> </sequential><br /> </for><br /> </target><br /> <br /> <br /> <!--<br /> | Utility targets that mimic the maven goals needed to build the project<br /> +--><br /> <target name="resource:resources"><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <mkdir dir="${pom.build.outputDirectory}" /><br /> <copy todir="${pom.build.outputDirectory}"><br /> <fileset dir="${pom.build.resourcesDirectory}" /><br /> </copy><br /> </target><br /><br /> <target name="compiler:compile"><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <mkdir dir="${pom.build.outputDirectory}" /><br /> <javac srcdir="${pom.build.sourceDirectory}" destdir="${pom.build.outputDirectory}"><br /> <classpath><br /> <fileset dir="${lib.dir.provided}" /><br /> <fileset dir="${lib.dir.runtime}" /><br /> <fileset dir="${lib.dir.compile}" /><br /> </classpath><br /> </javac><br /> </target><br /><br /> <target name="jspc:compile"><br /> <echo>Not Implemented</echo><br /> </target><br /><br /> <target name="resource:testResources"><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <mkdir dir="${pom.build.testOutputDirectory}" /><br /> <copy todir="${pom.build.testOutputDirectory}"><br /> <fileset dir="${pom.build.testResourcesDirectory}" /><br /> </copy><br /> </target><br /><br /> <target name="compiler:testCompile"><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <mkdir dir="${pom.build.testOutputDirectory}" /><br /> <javac srcdir="${pom.build.testSourceDirectory}" destdir="${pom.build.testOutputDirectory}"><br /> <classpath><br /> <fileset dir="${lib.dir.provided}" /><br /> <fileset dir="${lib.dir.runtime}" /><br /> <fileset dir="${lib.dir.compile}" /><br /> <fileset dir="${lib.dir.test}" /><br /> <pathelement location="${pom.build.outputDirectory}" /><br /> </classpath><br /> </javac><br /> </target><br /><br /> <target name="surefire:test"><br /> <property file="${antBuildPropertiesFile}" /><br /> <property name="pom.build.test.reportsDirectory" value="${pom.build.directory}/surefire-reports" /><br /><br /> <mkdir dir="${pom.build.test.reportsDirectory}" /><br /> <junit fork="true" showoutput="true" printsummary="yes"><br /> <classpath><br /> <fileset dir="${lib.dir.provided}" /><br /> <fileset dir="${lib.dir.runtime}" /><br /> <fileset dir="${lib.dir.compile}" /><br /> <fileset dir="${lib.dir.test}" /><br /> <pathelement location="${pom.build.outputDirectory}" /><br /> <pathelement location="${pom.build.testOutputDirectory}" /><br /> </classpath><br /><br /> <formatter type="plain" /><br /><br /> <batchtest fork="yes" todir="${pom.build.test.reportsDirectory}"><br /> <fileset dir="${pom.build.testOutputDirectory}" /><br /> </batchtest><br /> </junit><br /> </target><br /><br /> <target name="war:war"><br /> <property file="${antBuildPropertiesFile}" /><br /><br /> <property name="pom.war.directory" value="${pom.build.directory}/${pom.build.finalName}" /><br /> <mkdir dir="${pom.build.directory}/${pom.build.finalName}" /><br /> <copy todir="${pom.war.directory}"><br /> <fileset dir="${pom.build.webappResourcesDirectory}" /><br /> </copy><br /> <copy todir="${pom.war.directory}/WEB-INF/classes"><br /> <fileset dir="${pom.build.outputDirectory}" /><br /> </copy><br /> <copy todir="${pom.war.directory}/WEB-INF/lib"><br /> <fileset dir="${lib.dir.runtime}" /><br /> </copy><br /> <war destfile="${pom.war.directory}.war" webxml="${pom.war.directory}/WEB-INF/web.xml"><br /> <fileset dir="${pom.war.directory}" /><br /> </war><br /> </target><br /><br /><br /> <!--<br /> | Custom ant tasks used to support building the portlet.<br /> +--><br /> <taskdef resource="net/sf/antcontrib/antlib.xml"><br /> <classpath><br /> <pathelement location="${basedir}/bootstrap/ant-contrib-1.0b3.jar" /><br /> </classpath><br /> </taskdef><br /><br /> <typedef resource="org/apache/maven/artifact/ant/antlib.xml" uri="urn:maven-artifact-ant"><br /> <classpath><br /> <pathelement location="${basedir}/bootstrap/maven-ant-tasks-2.0.7.jar" /><br /> </classpath><br /> </typedef><br /></project><br />

As you can see at the end of the script it depends on Ant Contrib and Maven Ant Tasks.