build.xml - flaka - Simplifying Ant build scripts.

Source path: svn/ trunk/ build.xml

‹r375

r402

<project name="ant-flaka" default="package" xmlns:au="antlib:org.apache.ant.antunit">
  <description>
    ////////////////////////////////////////////////////////////////////////
    //     PLEASE USE ANT 1.8 OR NEWER WHEN CREATING A RELEASE            //
    ////////////////////////////////////////////////////////////////////////

    ========================================================================
    === This is the build script building the Flaka project from scratch ===
    ========================================================================

    Use option -p to see a list of targets. By  default, Flaka gets compiled
    and packaged as

          ${dist.dir}/ant-flaka-${version}.jar   

    In addition, file

         ${basedir}/ant-flaka.jar 

    gets also created. Both files should be the same. The latter is intended 
    when working on Flaka itself. Having a version-less jar  file  simplifies 
    some configuration files, especially when using Eclipse.

    Use target `package-all' to generate all distribution packages and pick
    them from folder ${build.dir}.

    You can at *any time* (assuming that you are online) remove folder 

      ${build.dir}.

    manually in order to start building from scratch.

    Run 

      ant -p

    for a list of targets.
     
    Please make sure to have red the build instructions in file

         ${basedir}/README.txt

     Good Luck.
     ==========
  </description>
  <!--
      ;;
      ;; This a Ant build script.
      ;;
      ;; It shall build Flaka from scratch. Notice that you need to satisfy
      ;; some requirements. Please consult README.txt for details.
      ;;
  -->

  <!--
      =====================================================================
      >> depot.url <<
      This is the property pointing to a Maven 2 like repository to satisfy 
      dependency libraries.
      =====================================================================
  -->
  <condition property="ant-gte-180">
    <available classname="org.apache.tools.ant.property.GetProperty" />
  </condition>

  <diagnostics />

  <property 
      name="depot.url" 
      value="http://download.haefelinger.it/flaka/dependencies" 
      />
  <!-- remember also to change displayversion below -->
  <property
      name="version"
      value="1.03.00-SNAPSHOT"
      />
  <property
      name="displayversion"
      value="1.3.0" 
      />
  <property 
      name="src.dir" 
      value="src" 
      />
  <property 
      name="test.dir" 
      value="test" 
      />
  <property 
      name="build.dir" 
      value="${basedir}/build" 
      />
  <property 
      name="dist.dir" 
      value="${build.dir}/dist" 
      />
  <property 
      name="lib.dir" 
      value="${build.dir}/lib" 
      />
  <property 
      name="libsrc.dir" 
      value="${build.dir}/libsrc" 
      />
  <property 
      name="librun.dir" 
      value="${build.dir}/librun" 
      />
  <property 
      name="obj.dir" 
      value="${build.dir}/classes" 
      />
  <property 
      name="javadoc.dir" 
      value="${build.dir}/javadoc" 
      />


  <!-- Define property libs.fetched if a certain file is available -->
  <available 
      file="${lib.dir}/fetched/README.txt" 
      property="libs.fetched"/>

  <!--///////////////////////////////////////////////////////////////////////-->
  <!-- Java compiler settings                                                -->
  <!--                                                                       -->
  <!-- Make sure to be backward compatible with Java 1.5                     -->
  <!--///////////////////////////////////////////////////////////////////////-->

  <presetdef name="javac">
    <javac 
        includeantruntime = "true" 
        source            = "1.5"
        target            = "1.5"
        verbose           = "true"
        />
  </presetdef>

    
  <!-- ;;
       ;; Dependencies
       ;; 
       ;; List here the dependencies. Use type = 'inline' to specify whether
       ;; the dependency gets merged with the final jar file.
  -->
  <macrodef name="fetch-required-jars">
    <sequential>
      <fetchjar 
          group="junit" 
          name="junit" 
          version="3.8.1"
          dest="${librun.dir}/junit.jar"
          />
      <fetchjar 
          group="jdom" 
          name="jdom" 
          version="1.0"
          type="inline"
          />
      <fetchjar 
          group="commons-httpclient" 
          name="commons-httpclient" 
          version="3.1"
          type="inline"
          />
      <fetchjar 
          group="org/apache/ant" 
          name="ant-antunit" 
          version="1.1"
          dest="${librun.dir}/ant-antunit.jar"
          />
      <!-- JUEL has not been uploaded into a Maven 2 repository yet -->
      <fetchjar 
          group="juel-impl" 
          name="juel" 
          version="2.2.1" 
          type="inline"
          />
      <!-- Required when using Eclipse | Javadoc -->
      <fetchjar 
          group="org/apache/ant" 
          name="ant" 
          version="1.8.1" 
          dest="${librun.dir}/ant-1.8.1.jar"
          />
      <fetchjar 
          group="org/apache/ant" 
          name="ant-launcher" 
          version="1.8.1" 
          dest="${librun.dir}/ant-launcher-1.8.1.jar"
          />
      <fetchjar 
          group="org/apache/ant" 
          name="ant" 
          version="1.7.1" 
          dest="${librun.dir}/ant-1.7.1.jar"
          />
      <fetchjar 
          group="org/apache/ant" 
          name="ant-launcher" 
          version="1.7.1" 
          dest="${librun.dir}/ant-launcher-1.7.1.jar"
          />
      <fetchjar 
          group="org/apache/ant" 
          name="ant"
          version="1.8.1"
          basename="ant-sources-1.8.1"
          dest="${libsrc.dir}/ant-sources-1.8.1.jar"
          />
      <fetchjar 
          group="juel-impl" 
          name="juel" 
          version="2.2.1"
          basename="juel-sources-2.2.1"
          dest="${libsrc.dir}/juel-sources-2.2.1.jar"
          />
      <fetchjar 
          group="org.codehaus.groovy" 
          name="groovy-all" 
          version="1.8.0"
          />
    </sequential>
  </macrodef>


  <macrodef name="fetchjar">
    <attribute name="group" />
    <attribute name="name" />
    <attribute name="version" />
    <attribute name="type" default=""/>
    <attribute name="basename" default="@{name}-@{version}" />
    <attribute name="dest" default="${lib.dir}/@{basename}.jar" />
    <sequential>
      <echo>fetching @{name} ..</echo>
      <mkdir dir="${lib.dir}" />
      <mkdir dir="${libsrc.dir}" />
      <mkdir dir="${librun.dir}" />
      <get src="${depot.url}/@{group}/@{name}/@{version}/@{basename}.jar" 
           dest="@{dest}" 
           verbose="On"/>
      <!-- Now it gets really cumbersome with standard Ant -->
      <!-- All I want to say is that if type='inline', then I want to append some text -->
      <!-- to a file. The way to do so is to define a (unused) property depending on   -->
      <!-- that condition. Then, in the echo task below, I do add something depending  -->
      <!-- on the property's value. Notice that task echo does *not* support 'if' or   -->
      <!-- 'unless'. -->
      <condition 
          property="@{basename}.inline" 
          value="@{basename}.jar&#10;" 
          else="">
        <equals 
            arg1="@{type}" 
            arg2="inline" 
            casesensitive="true" 
            trim="true" />
      </condition>
      <echo
          file="${lib.dir}/__inline__.txt" 
          message="${@{basename}.inline}" 
          append="true" />
    </sequential>
  </macrodef>

  <target name="init" unless="libs.fetched">
    <fetch-required-jars />
    <mkdir dir="${lib.dir}/fetched/" />
    <tstamp>
      <format property="libs.fetched" pattern="dd-MM-yyyy HH:mm:ss -Z" />
    </tstamp>
    <echo file="${lib.dir}/fetched/README.txt">
      ====================================================================
      Remove this file's parent folder (or this file) to re-fetch required 
      libraries from repository.
      ====================================================================
      
      Last repository used:
      ${depot.url}

      This file has been created:
      ${libs.fetched}
    </echo>
    
  </target>

  
  <target name="clean" >
    <sequential>
      <delete dir="${obj.dir}" />
    </sequential>
  </target>
  
  <target name="clean-dist" >
    <sequential>
      <delete dir="${build.dir}" />
    </sequential>
  </target>

  <target name="compile" depends="init">
    <sequential>
      <!-- TODO: use M2 names -->
      <mkdir dir="${obj.dir}"/>
      <javac srcdir="src" destdir="${obj.dir}">
        <classpath>
          <fileset dir="${lib.dir}">
            <include name="*.jar"/>
          </fileset>
        </classpath>
        <exclude name="it/haefelinger/flaka/el/ELPropertyExpander.java" unless="ant-gte-180" />
        <exclude name="it/haefelinger/flaka/el/ELPropertyEvaluator.java" unless="ant-gte-180" />
        <exclude name="**/*PropertyHelper12*" unless="ant-gte-180" />
      </javac>
    </sequential>
  </target>

  <macrodef name="test-init">
    <sequential>
      <mkdir dir="${build.dir}/test-classes" />
      <javac srcdir="test" destdir="${build.dir}/test-classes"> 
        <include name="**/*Test.java" />
        <classpath>
          <pathelement path="${obj.dir}"/>
          <fileset dir="${lib.dir}">
            <include name="*.jar"/>
          </fileset>
          <fileset dir="${librun.dir}">
            <include name="junit.jar"/>
          </fileset>
        </classpath>
      </javac>
    </sequential>
  </macrodef>

  <macrodef name="test-exec">
    <attribute name="name"     default="ant-flaka" />
    <attribute name="basename" default="@{name}-${version}" />
    <sequential>
      <mkdir dir="${build.dir}/test" />
      <junit>
        <classpath>
          <pathelement path="${build.dir}/test-classes"/>
          <fileset dir="${dist.dir}">
            <include name="@{basename}.jar" />
          </fileset>
          <fileset dir="${lib.dir}">
            <include name="*.jar"/>
          </fileset>
          <fileset dir="${librun.dir}">
            <include name="junit.jar"/>
          </fileset>
        </classpath>
        <formatter type="brief" usefile="false"/>
        <formatter type="xml"/>
        <batchtest todir="${build.dir}/test">
          <fileset dir="${build.dir}/test-classes">
            <include name="**/*Test.class" />
          </fileset>
        </batchtest>
        <jvmarg value="-ea"/>   
      </junit>
      <!-- Add ant-antunit.jar to classpath -->
      <taskdef uri="antlib:org.apache.ant.antunit"
               resource="org/apache/ant/antunit/antlib.xml"
               classpath="${librun.dir}/ant-antunit.jar" />
      <!-- Add ant-flaka.jar to classpath -->
      <taskdef uri="antlib:it.haefelinger.flaka"
               resource="it/haefelinger/flaka/antlib.xml"
               classpath="${dist.dir}/@{basename}.jar" />
      <au:antunit>
        <fileset dir="test">
          <include name="test-*.xml" />
          <exclude name="test-18*-no-ns.xml" />
          <exclude name="test-18*.xml" unless="ant-gte-180"/>
          <exclude name="test-scndeps.xml" />
          <exclude name="test-set-default-target.xml" />
        </fileset>
        <au:plainlistener/>
      </au:antunit>
    </sequential>
  </macrodef>

  <target name="test-init181" if="ant-gte-180">
    <taskdef uri="antlib:it.haefelinger.flaka.prop"
             resource="it/haefelinger/flaka/prop/antlib.xml"
             classpath="${dist.dir}/ant-flaka-${version}.jar" />
  </target>

  <target name="test" depends="package,test-init181" >
    <test-init />
    <test-exec />
  </target>

  <macrodef name="zip-merge">
    <attribute name="libfile" />
    <element name="zip-element" implicit="true"/>
    <sequential>
      <zip destfile="@{libfile}" update="true">
        <zip-element/>
      </zip>
    </sequential>
  </macrodef>

  <macrodef name="inline-dependencies">
    <attribute name="file" />
    <sequential>
      <zip-merge libfile="@{file}">
        <zipgroupfileset dir="${lib.dir}">
          <patternset>
            <includesfile name="${lib.dir}/__inline__.txt"/> 
          </patternset>
        </zipgroupfileset>
      </zip-merge>
    </sequential>
  </macrodef>


  <macrodef name="package">
    <attribute name="name"     default="ant-flaka" />
    <attribute name="distdir"  default="${dist.dir}" />
    <attribute name="basename" default="@{name}-${version}" />
    <attribute name="barename" default="@{name}-bare-${version}" />
    <attribute name="objdir"   default="${obj.dir}" />
    <sequential>
      <mkdir dir="@{distdir}" />
      <delete dir="@{distdir}">
        <include name="**" />
      </delete>
      <jar jarfile="@{distdir}/@{basename}.jar">
        <fileset dir="@{objdir}">
          <include name="**/*.class" />
          <include name="**/antlib.xml" />
        </fileset>
        <fileset dir="src">
          <include name="**/antlib.xml" />
        </fileset>
      </jar>
      <!-- Provide also a stripped version, i.e. not having any dependencies -->
      <!-- inlined. Just in case of conflicts or if better libs are avail- -->
      <!-- able. -->
      <copy 
          tofile="@{distdir}/@{barename}.jar" 
          verbose="true" 
          overwrite="true" 
          file="@{distdir}/@{basename}.jar"  
          />
      <!-- Inline (non-system) dependencies -->
      <inline-dependencies 
          file="@{distdir}/@{basename}.jar"
          />
      <!-- Provide a non-versioned copy for simplified usage (for example -->
      <!-- when using Eclipse ..) -->
      <copy 
          tofile="@{name}.jar" 
          verbose="true" 
          overwrite="true" 
          file="@{distdir}/@{basename}.jar"  
          />
    </sequential>
  </macrodef>

  <target name="package" depends="compile"
          description=">> use me to create jar packages">
    <sequential>
      <package />
    </sequential>
  </target>


  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <!--                       J A V A D O C                         -->
  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->

  <presetdef name="javadoc">
    <javadoc
        packagenames    = "it.haefelinger.flaka.*"
        sourcepath      = "${src.dir}"
        >
      <classpath>
        <fileset dir="${lib.dir}">
          <include name="**/*.jar"/>
        </fileset>
        <fileset dir="${librun.dir}">
          <include name="**/*.jar"/>
        </fileset>
      </classpath> 
      <link href="http://download.oracle.com/javase/6/docs/api" />
      <link href="http://www.jdom.org/docs/apidocs" />
      <link href="http://logging.apache.org/log4j/1.2/apidocs" />
      <link href="http://javadoc.haefelinger.it/org.apache.ant/1.8.1" />
      <link href="http://javadoc.haefelinger.it/net.sourceforge.cruisecontrol/2.8.2" />
      <link href="http://javadoc.haefelinger.it/net.sourceforge.juel/2.2.1" />
      <link href="http://logging.apache.org/log4j/1.2/apidocs" />
      <link href="http://hc.apache.org/httpclient-3.x/apidocs" />
    </javadoc>
  </presetdef>


  <macrodef name="javadoc-exec" >
    <sequential>
      <mkdir dir="${javadoc.dir}"/>
      <javadoc destdir="${javadoc.dir}" >
        <fileset dir="${src.dir}" defaultexcludes="yes">
          <include name="**/*.java" />
        </fileset>
      </javadoc>      
    </sequential>
  </macrodef>

  <macrodef name="package-javadoc-exec" >
    <sequential>
      <!-- create dist folder directory -->
      <mkdir dir="${dist.dir}"/>
      <zip zipfile="${dist.dir}/flaka-javadoc-${version}.zip">
        <zipfileset dir="${javadoc.dir}"
                    prefix="it.haefelinger.flaka/"
                    >
          <include name="**/*" />
        </zipfileset>
      </zip>
    </sequential>
  </macrodef>

  
  <target name="javadoc" depends="init">
    <javadoc-exec />
  </target>
  
  <target name="package-javadoc" depends="javadoc">
    <package-javadoc-exec />
  </target>

  <macrodef name="package-javadoc">
    <sequential>
      <javadoc-exec />
      <package-javadoc-exec />
    </sequential>
  </macrodef>

  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <!--                    P A C K A G E - S O U R C E S            -->
  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->

  <macrodef name="package-sources-exec" >
    <attribute name="prefix" default="flaka-sources-${version}" />
    <sequential>
      <!-- create dist folder directory -->
      <mkdir dir="${dist.dir}"/>
      <zip zipfile="${dist.dir}/@{prefix}.zip">
        <zipfileset dir="${src.dir}" prefix="@{prefix}/">
          <include name="**/*.java" />
          <exclude name=".svn/" />
          <exclude name=".git/" />
          <exclude name="CVS" />
        </zipfileset>
      </zip>
    </sequential>
  </macrodef>


  
  <target name="package-sources">
    <package-sources-exec />
  </target>

  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <!--                    P A C K A G E - R E B U I L D            -->
  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->

  <macrodef name="package-rebuild-exec" >
    <attribute name="prefix" default="flaka-${version}/" />
    <sequential>
      <!-- create dist folder directory -->
      <mkdir dir="${dist.dir}"/>
      <zip zipfile="${dist.dir}/flaka-${version}.zip">
        <zipfileset dir="." prefix="@{prefix}">
          <exclude name="build/" />
          <exclude name=".project" />
          <exclude name=".settings/" />
          <exclude name=".classpath" />
          <exclude name=".svn/" />
          <exclude name=".git/" />
          <exclude name="CVS" />
          <exclude name="**/removeme/" />
          <exclude name="tryme.xml" />
          <exclude name="**/*tryme*" />
          <exclude name="tmp/" />
          <exclude name="var/" />
          <exclude name="test/**/*.jar" />
          <exclude name="test/build/" />
        </zipfileset>
      </zip>
    </sequential>
  </macrodef>


  
  <target name="package-rebuild" depends="package">
    <package-rebuild-exec />
  </target>


  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <!--                    P A C K A G E - A L L                    -->
  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->

  <target name="package-all" depends="package" 
          description=">> use me for packaging each and everything">
    <package-javadoc />
    <package-sources-exec />
    <package-rebuild-exec />
  </target>

  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <!--                    P A C K A G E - D I S T                  -->
  <!--:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::-->
  <target name="-ensure180" unless="ant-gte-180">
    <echo>
      ////////////////////////////////////////////////////////////////
      You are supposed to use ANT 1.8 or newer when building a release
                       meant for distribution.
      ////////////////////////////////////////////////////////////////
    </echo>
    <fail>
      unsupported Ant version used for building a release: ${ant.version}
    </fail>
  </target>
  
  <target name="package-dist" depends="-ensure180,test,package-all" 
          description=">> use me when building a release - requires 1.8 or newer">
  </target>

  <macrodef name="gcupload-available">
    <attribute name="p" default="gc-file-missing" />
    <attribute name="f" />
    <sequential>
      <condition property="@{p}" value="@{f}">
        <not>
          <available file="@{f}" />
        </not>
      </condition>
    </sequential>
  </macrodef>

  <macrodef name="gcupload-ready">
    <attribute name="p" default="gc-file-missing" />
    <sequential>
       <fail if="gc-file-missing">
        Error: a file to be released is missing, please make sure that it is available: ${gc-file-missing}
      </fail>
    </sequential>
  </macrodef>

  <macrodef name="gcupload">
    <attribute name="displayversion" />
    <attribute name="version" />
    <sequential>
      <fail unless="gcname">
        Property `gcname', your username @ google.code is not set. Make sure that you 
        also set `gcpass', your google code's password (which is not the same as your
        gmail password).
      </fail>
      <fail unless="gcpass">
        Property `gcname', your username @ google.code is not set. Make sure that you 
        also set `gcpass', your google code's password (which is not the same as your
        gmail password).
      </fail>
      <taskdef classname="net.bluecow.googlecode.ant.GoogleCodeUploadTask" 
               classpath="${basedir}/lib/ant-googlecode-0.0.3.jar" 
               name="_gcupload"/>

      <presetdef name="_gcupload">
        <_gcupload
            username    = "${gcname}" 
            password    = "${gcpass}" 
            projectname = "flaka" 
            />
      </presetdef>

      <!-- check that we have all files ready for uploading -->
      <fail if="gc-file-missing">
        property gc-file-missing is already set, please make sure to wipe it.
      </fail>

      <gcupload-available f="${dist.dir}/ant-flaka-${version}.jar" />
      <gcupload-available f="${dist.dir}/ant-flaka-bare-${version}.jar" />
      <gcupload-available f="${dist.dir}/flaka-sources-${version}.zip" />
      <gcupload-available f="${dist.dir}/flaka-javadoc-${version}.zip" />
      <gcupload-available f="${dist.dir}/flaka-${version}.zip" />
      <gcupload-ready />
      
      <_gcupload 
          filename="${dist.dir}/ant-flaka-${version}.jar" 
          targetfilename="ant-flaka-${version}.jar"
          summary="Flaka ${displayversion} - Ant plugin, fully charged (dependencies inlined)."
          labels="Featured, Type-Package, OpSys-All" 
          />
       <_gcupload 
          filename="${dist.dir}/ant-flaka-bare-${version}.jar" 
          targetfilename="ant-flaka-bare-${version}.jar"
          summary="Flaka ${displayversion} - Ant plugin, requires additional dependencies."
          labels="Type-Package, OpSys-All" 
          />
       <_gcupload 
          filename="${dist.dir}/flaka-sources-${version}.zip" 
          targetfilename="flaka-sources-${version}.zip"
          summary="Flaka ${displayversion} - Source code only."
          labels="Type-Source, OpSys-All" 
          />
       <_gcupload 
          filename="${dist.dir}/flaka-javadoc-${version}.zip" 
          targetfilename="flaka-javadoc-${version}.zip"
          summary="Flaka ${displayversion} - Javadoc only."
          labels="Type-Docs, OpSys-All" 
          />
       <_gcupload 
          filename="${dist.dir}/flaka-${version}.zip" 
          targetfilename="flaka-${version}.zip"
          summary="Flaka ${displayversion} - Complete development package (but 3rdparth dependencies)."
          labels="Type-Archive, OpSys-All" 
          />
    </sequential>
  </macrodef>

  <target name="deploy">
    <gcupload displayversion="${displayversion}" version="${version}" />
  </target>

</project>

Show details Hide details

Change log

r378 by whaefelinger on Jun 16, 2011 Diff

poor mans merge completed

Go to:

Older revisions

r375 by whaefelinger on Jun 16, 2011 Diff

applied changes of whanno372 -
bypassing any Subversion crap to get
going, cause I have better things to
do than playing around with SCM giving
you so much trouble

r342 by whaefelinger on Jun 11, 2011 Diff

merging in changes from revision 334
(branches/RELEASE)

r334 by whaefelinger on Jun 11, 2011 Diff

bumping version to 1.2.2-SNAPSHOT

All revisions of this file

File info

Size: 23279 bytes, 728 lines

View raw file