s3-build.xml

<?xml version="1.0"?>

<!--
  ~ /////////////////////////////////////////////////////////////////////////////
  ~ // This file is part of the "Hyrax Data Server" project.
  ~ //
  ~ //
  ~ // Copyright (c) 2013 OPeNDAP, Inc.
  ~ // Author: Nathan David Potter  <ndp@opendap.org>
  ~ //
  ~ // This library is free software; you can redistribute it and/or
  ~ // modify it under the terms of the GNU Lesser General Public
  ~ // License as published by the Free Software Foundation; either
  ~ // version 2.1 of the License, or (at your option) any later version.
  ~ //
  ~ // This library is distributed in the hope that it will be useful,
  ~ // but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  ~ // Lesser General Public License for more details.
  ~ //
  ~ // You should have received a copy of the GNU Lesser General Public
  ~ // License along with this library; if not, write to the Free Software
  ~ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  ~ //
  ~ // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
  ~ /////////////////////////////////////////////////////////////////////////////
  -->

<!-- Build file for OPeNDAP core software -->

<project
        name="S3_DAP_Service"
        default="all" basedir=".">

    <!-- Global Properties for Java-OPeNDAP software development -->


    <!-- ********************************************* -->
    <!-- Project-wide settings. All directories are    -->
    <!-- relative to the project "Basedir" directory,  -->
    <!-- which is assumed (by this file) to be set to  -->
    <!-- ".."                                          -->
    <!-- - - - - - - - - - - - - - - - - - - - - - - - -->

    <!-- Version Tag: Used for doing distribution builds.
         This property should be set from the command
         line by the distribution build script using
         tag information from CVS.
    -->
    <property name="S3_DAP_SERVICE_SOFTWARE_VERSION" value="Not.A.Release"/>
    <property name="HYRAX_VERSION" value="Not.A.Release"/>
    <!-- property name="CONFIG_FILE" value="ConfigFileNotSpecified"/ -->

    <property name="DEPLOYMENT_CONTEXT" value="s3"/>


    <!-- Compiler Settings -->

    <property name="compile.debug" value="on"/>
    <property name="compile.debuglevel" value="lines,vars,source"/>
    <property name="compile.deprecation" value="on"/>

    <property name="compile.TARGET" value="1.7"/>
    <property name="compile.SOURCE" value="1.7"/>


    <property name="modern.compiler" value="modern"/>
    <property name="classic.compiler" value="classic"/>

    <!--  build.compiler: This is a "magic" property.
         In the javac task, if the "compiler" property is not
         explicitly set, then javac will use the value of this
         property ("build.compiler") to set the compiler type.

    See the online ANT Users Manual.
    Read the section the comipler attribute of the javac task.
    http://ant.apache.org/manual/index.html
    -->
    <property name="build.compiler" value="${modern.compiler}"/>



    <!-- build.sysclasspath
         This is a "magic" property. The value of the build.sysclasspath
         property controls how the system classpath, ie. the classpath in
         effect when Ant is run, affects the behaviour of classpaths in
         Ant. The default behavior varies from Ant to Ant task.

         The values and their meanings are:
            only -   Only the system classpath is used and classpaths
                     specified in build files, etc are ignored. This
                     situation could be considered as the person running
                     the build file knows more about the environment
                     than the person writing the build file
            ignore - The system classpath is ignored. This situation is
                     the reverse of the above. The person running the
                     build trusts the build file writer to get the build
                     file right
            last -   The classpath is concatenated to any specified
                     classpaths at the end. This is a compromise, where
                     the build file writer has priority.
            first -  Any specified classpaths are concatenated to the
                     system classpath. This is the other form of compromise
                     where the build runner has priority.

    Excerpted from the online ANT users Manual
    http://ant.apache.org/manual/sysclasspath.html
    -->
    <property name="build.sysclasspath" value="ignore"/>



    <!-- ********************************************* -->

    <!-- Target to create the build directories -->
    <!-- prior to a compile target. We also mark -->
    <!-- the start time of the build for the log. -->

    <target name="noop" description="Do Nothing Target">
        <echo level="info" message="no-op target in ${ant.file}"/>
    </target>




    <!-- ################################################################# -->
    <!--                      Project Settings                             -->
    <!-- ................................................................. -->



    <!-- Project directories -->
    <property name="src.dir" location="src"/>
    <property name="doc.dir" location="doc"/>
    <property name="lib.dir" location="lib"/>
    <property name="aws.resources"     location="resources/experiments/AWS" />
    <property name="glacier.resources" location="${aws.resources}/Glacier"/>
    <property name="s3.resources"      location="${aws.resources}/s3"/>
    <property name="aws.lib.dir"       location="${aws.resources}/lib"/>
    <property name="hyrax.resources"   location="resources/hyrax"/>



    <!-- Build Directories -->
    <property name="build.dir" location="build"/>
    <property name="build.classes" location="${build.dir}/classes"/>
    <property name="build.doc" location="${build.dir}/doc"/>
    <property name="build.dist" location="${build.dir}/dist"/>
    <property name="build.lib" location="${build.dir}/lib"/>
    <property name="build.run" location="${build.dir}/run"/>
    <property name="build.src" location="${build.dir}/src"/>
    <property name="build.resources" location="${build.dir}/resources"/>
    <property name="build.xsl" location="${build.dir}/xsl"/>


    <!-- Libraries -->
    <property name="json.lib"       value="gson-2.3.1.jar"/>

    <property name="junit.lib"       value="junit-4.4.jar"/>
    <property name="jdom.lib"        value="jdom-1.1.1.jar"/>
    <property name="urlRewrite.lib"      value="urlrewrite-3.2.0.jar"/>


    <property name="slf4j.lib"            value="slf4j-api-1.6.1.jar"/>
    <property name="logback-core.lib"     value="logback-core-0.9.26.jar"/>
    <property name="logback-classic.lib"  value="logback-classic-0.9.26.jar"/>

    <property name="owlim.lib"            value="owlim-lite-4.3.jar"/>
    <property name="openrdf-sesame.lib"   value="openrdf-sesame-2.6.2-onejar.jar" />

    <property name="commons-cli.lib"        value="apache-commons-cli-1.2.jar"/>
    <property name="commons-httpclient.lib" value="apache-commons-httpclient-3.1.jar"/>
    <property name="commons-logging.lib"    value="apache-commons-logging-1.1.3.jar"/>
    <property name="commons-codec.lib"      value="apache-commons-codec-1.8.jar"/>
    <property name="commons-lang.lib"       value="apache-commons-lang-2.5.jar"/>
    <property name="commons-io.lib"         value="apache-commons-io-2.4.jar"/>

    <property name="xalan.lib"         value="xalan.jar"/>
    <property name="xercesImpl.lib"    value="xercesImpl-2.8.1.jar"/>
    <property name="xercesXmlApis.lib" value="xml-apis-2.8.1.jar"/>
    <property name="xsltc.lib"         value="xalan-2.7.1-xsltc.jar"/>

    <property name="saxon-jdom.lib"  value="saxon-9.1.0.5-jdom.jar"/>
    <property name="saxon-s9api.lib" value="saxon-9.1.0.5-s9api.jar"/>
    <property name="saxon.lib"       value="saxon-9.1.0.5.jar"/>

    <property name="catalina.lib"         value="catalina-6.0.14.jar"/>
    <property name="servlet-api.lib"      value="servlet-api-3.0.jar"/>



    <property name="aws.sdk" value="aws-java-sdk-1.8.9.1.jar" />
    <property name="aws.sdk.tools" value="aws-java-sdk-flow-build-tools-1.8.9.1.jar" />

    <property name="jackson.databind" value="jackson-databind-2.4.1.jar" />
    <property name="jackson.core" value="jackson-core-2.4.1.jar" />
    <property name="jackson.annotations" value="jackson-annotations-2.4.1.jar" />



    <property name="owasp-encoder"     value="encoder-1.2.2.jar" />
    <property name="owasp-encoder-jsp" value="encoder-jsp-1.2.2.jar" />



    <!-- Library (class)paths -->
    <path id="compile.classpath">
        <pathelement path="${build.classes}"/>
        <fileset dir="${lib.dir}">
            <include name="${servlet-api.lib}"/>
            <include name="${catalina.lib}"/>

            <include name="${owasp-encoder}"/>
            <include name="${owasp-encoder-jsp}"/>

            <include name="${json.lib}"/>

            <include name="${jdom.lib}"/>
            <include name="${junit.lib}"/>
            <include name="${urlRewrite.lib}"/>

            <!-- Apache Commons tools -->
            <include name="${commons-cli.lib}"/>
            <include name="${commons-httpclient.lib}"/>
            <include name="${commons-lang.lib}"/>
            <include name="${commons-logging.lib}"/>
            <include name="${commons-codec.lib}"/>
            <include name="${commons-io.lib}"/>

            <!-- XML tools -->
            <include name="${saxon-jdom.lib}"/>
            <include name="${saxon-s9api.lib}"/>
            <include name="${saxon.lib}"/>
            <include name="${xalan.lib}"/>
            <include name="${xercesImpl.lib}"/>
            <include name="${xercesXmlApis.lib}"/>

            <!-- Logging Framework -->
            <include name="${slf4j.lib}"/>
            <include name="${logback-core.lib}"/>
            <include name="${logback-classic.lib}"/>

        </fileset>

        <fileset dir="${aws.lib.dir}">
            <include name="**"/>
        </fileset>



    </path>



    <target name="show" description="Show build settings.">

        <echo level="info" message="Project Name:         ${ant.project.name}"/>
        <echo level="info" message="Project File:         ${ant.file}"/>
        <echo level="info" message="HYRAX_VERSION: ${HYRAX_VERSION}"/>
        <echo level="info" message="GLACIER_SERVICE_SOFTWARE_VERSION: ${S3_DAP_SERVICE_SOFTWARE_VERSION}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Project Directories:"/>
        <echo level="info" message="    src.dir:       ${src.dir}"/>
        <echo level="info" message="    doc.dir:       ${doc.dir}"/>
        <echo level="info" message="    lib.dir:       ${lib.dir}"/>
        <echo level="info" message="    aws.resources:     ${aws.resources}"/>
        <echo level="info" message="    glacier.resources: ${glacier.resources}"/>
        <echo level="info" message="    s3dap.resources:   ${s3.resources}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Build Directories:"/>
        <echo level="info" message="    build.dir:      ${build.dir}"/>
        <echo level="info" message="    build.classes:  ${build.classes}"/>
        <echo level="info" message="    build.doc:      ${build.doc}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Ant Properties:"/>
        <echo level="info" message="    ant.file:          ${ant.file}"/>
        <echo level="info" message="    ant.home:          ${ant.home}"/>
        <echo level="info" message="    ant.java.version:  ${ant.java.version}"/>
        <echo level="info" message="    ant.project.name:  ${ant.project.name}"/>
        <echo level="info" message="    ant.version:       ${ant.version}"/>
        <echo level="info" message="    basedir:           ${basedir}"/>
        <echo level="info" message="    user.name:         ${user.name}"/>
        <echo level="info" message="    user.home:         ${user.home}"/>
        <echo level="info" message="    java.home:         ${java.home}"/>
        <echo level="info" message=""/>

    </target>



    <target name="all" depends="clean, server"
            description="Builds lots of stuff.">
    </target>


    <target name="clean" description="Clean up ALL build products.">
        <delete dir="${build.dir}" includeEmptyDirs="true"/>
    </target>


    <!-- target name="clean_retain_dist" description="Clean up build products except the dist directory.">
        <delete verbose="true"  includeEmptyDirs="true">
            <fileset dir="${build.dir}">
                <include name="**/*"/>
                <exclude name="dist/**/*"/>
            </fileset>
        </delete>
    </target -->


    <target name="init" description="Prepare all build directories.">
        <mkdir dir="${build.dir}"/>
        <mkdir dir="${build.classes}"/>
        <mkdir dir="${build.doc}"/>
        <mkdir dir="${build.dist}"/>
        <mkdir dir="${build.lib}"/>
        <mkdir dir="${build.run}"/>
        <mkdir dir="${build.src}"/>
        <mkdir dir="${build.resources}"/>

        <filter token="HyraxVersion" value="${HYRAX_VERSION}"/>
        <filter token="GLACIER_SERVICE_SOFTWARE_VERSION" value="${S3_DAP_SERVICE_SOFTWARE_VERSION}"/>
        <filter token="SERVICE_CONTEXT" value="${DEPLOYMENT_CONTEXT}"/>

        <tstamp/>
        <echo level="info" message="time: ${TSTAMP}"/>
    </target>





    <target  name="PreProcessSourceCode"
             depends="clean,init"
description="Moves selected source code from the development tree into
the build/src directory. The code text is filtered to update version numbers.">

        <echo level="info" message="AntFile: ${ant.file} Moving and filtering Source code."/>
        <echo level="info" message=""/>


        <copy todir="${build.src}" filtering="true">
            <fileset dir="${src.dir}">
                <!-- include all the java files -->
                <include  name="opendap/**/*.java"/>
                <exclude  name="opendap/experiments/**"/>
                <exclude  name="opendap/semantics/**"/>
                <exclude  name="opendap/metacat/**"/>
                <exclude  name="opendap/wcs/**"/>
                <exclude  name="opendap/hai/**"/>
                <exclude  name="opendap/aws/glacier/**"/>
                <exclude  name="opendap/aws/glacier/**"/>
                <exclude  name="opendap/aws/demo.java"/>
                <exclude  name="opendap/aws/s3/Testy.java"/>

                <!-- Exclude async test code -->
                <exclude name="opendap/async/**"/>

            </fileset>

        </copy>

        <copy todir="${build.resources}" filtering="true">
            <fileset dir="${s3.resources}">
                <!-- include all the files -->
                <include name="**"/>
                <exclude name="lib/**"/>
            </fileset>
        </copy>


        <copy todir="${build.resources}/xsl" filtering="true">
            <fileset dir="${hyrax.resources}/xsl">
                <include name="datasetServices.xsl"/>
                <include name="dap4_ifh.xsl"/>
                <include name="version.xsl"/>
            </fileset>
        </copy>

        <copy todir="${build.resources}/nciso" filtering="true">
            <fileset dir="${hyrax.resources}/nciso">
                <include name="**"/>
            </fileset>
        </copy>


        <copy todir="${build.resources}/js" filtering="true">
            <fileset dir="${hyrax.resources}/js">
                <include name="**"/>
            </fileset>
        </copy>



    </target>


    <target
            name="compile"
            depends="PreProcessSourceCode"
            description="Compiles the S3 DAP Service software."
    >
        <echo level="info" message="AntFile: ${ant.file} Compiling OLFS"/>
        <echo level="info"
              message="Using the ${build.compiler} javac compiler"/>
        <echo level="info" message="java.home (ant):       ${java.home}"/>
        <echo level="info" message="Target JVM Version:    ${compile.TARGET}"/>
        <echo level="info" message="Source Syntax Version: ${compile.SOURCE}"/>
        <echo level="info" message=""/>

        <javac compiler="${build.compiler}"
               target="${compile.TARGET}"
               source="${compile.SOURCE}"
               destdir="${build.classes}"
               debug="${compile.debug}"
               debuglevel="${compile.debuglevel}"
               deprecation="${compile.deprecation}">

            <classpath refid="compile.classpath"/>

            <src path="${build.src}"/>

        </javac>

    </target>







    <target
            name="src-dist"
            depends="clean,init"
            description="Builds source distribution"
            >

        <tar destfile="${build.dist}/s3dap-${S3_DAP_SERVICE_SOFTWARE_VERSION}-src.tgz"
             compression="gzip"
                >

            <zipfileset dir="." prefix="s3dap-${S3_DAP_SERVICE_SOFTWARE_VERSION}-src">
                <exclude name="build/**"/>
                <exclude name="doc/javadoc/**"/>
                <exclude name="doc/admin/**"/>
                <!-- Exclude the javadoc directory in the ${doc.dir} dir -->
                <exclude name="doc/_notes/**"/>
                <!-- Exclude the _notes directory in the ${doc.dir} dir -->
                <exclude name="**/*.iml"/>
                <exclude name="**/*.ipr"/>
                <exclude name="**/*.iws"/>
            </zipfileset>

        </tar>

    </target>

    <target
            name="server-dist"
            depends="server"
            description="Packages the war file into tar file with a release related name.">

        <tar destfile="${build.dist}/s3dap-${S3_DAP_SERVICE_SOFTWARE_VERSION}-webapp.tgz"
             compression="gzip"
                >
            <zipfileset dir="${build.dist}" prefix="s3dap-${S3_DAP_SERVICE_SOFTWARE_VERSION}-webapp">
                <include name="${DEPLOYMENT_CONTEXT}.war"/>
                <include name="README"/>
            </zipfileset>

        </tar>

        <delete file="${build.dist}/README"/>
        <delete file="${build.dist}/${DEPLOYMENT_CONTEXT}.war"/>

    </target>


    <target
            name="DISTRO"
            depends="clean,src-dist,server-dist"
            description="Builds complete distribution"
            >

    </target>

    <target name="CollectS3Libraries"
            depends="init"
    >

        <copy todir="${build.lib}" filtering="false">
            <fileset dir="${lib.dir}">
                
                <!-- OWASP Encoding -->
                <include name="${owasp-encoder}"/>
                <include name="${owasp-encoder-jsp}"/>

                <!-- JDOM. JUnit UrlRewrite -->
                <include name="${jdom.lib}"/>
                <include name="${junit.lib}"/>
                <include name="${urlRewrite.lib}"/>

                <include name="${json.lib}"/>

                <!-- Apache Commons tools -->
                <include name="${commons-cli.lib}"/>
                <include name="${commons-httpclient.lib}"/>
                <include name="${commons-lang.lib}"/>
                <include name="${commons-logging.lib}"/>
                <include name="${commons-codec.lib}"/>
                <include name="${commons-io.lib}"/>

                <!-- XML tools -->
                <include name="${saxon-jdom.lib}"/>
                <include name="${saxon-s9api.lib}"/>
                <include name="${saxon.lib}"/>
                <include name="${xalan.lib}"/>
                <include name="${xercesImpl.lib}"/>
                <include name="${xercesXmlApis.lib}"/>

                <!-- Logging Framework -->
                <include name="${slf4j.lib}"/>
                <include name="${logback-core.lib}"/>
                <include name="${logback-classic.lib}"/>

                <!-- AWS libraries -->
                <include name="${aws.sdk}"/>
                <include name="${aws.sdk.tools}"/>
            </fileset>

            <fileset dir="${aws.lib.dir}">
                <include name="**"/>
            </fileset>

        </copy>

    </target>




    <target
            name="server"
            depends="clean,compile,CollectS3Libraries"
            description="Performs a clean build of the core software and assembles the WAR file."
            >


        <echo level="info" message="Building s3 dap service war file."/>
        <echo level="info" message="build.dist: ${build.dist}"/>


        <war destfile="${build.dist}/${DEPLOYMENT_CONTEXT}.war"
             webxml="${s3.resources}/WEB-INF/web.xml"
                >



            <lib dir="${build.lib}">
                <include name="**"/>
            </lib>


            <classes dir="${build.classes}"/>

            <zipfileset dir="${doc.dir}" prefix="docs" >
                <exclude name="src.distribution.readme"/>
                <exclude name="admin/**"/>
                <exclude name="_notes"/>
            </zipfileset>

            <zipfileset dir="${build.resources}" prefix="">
                <include name="**/*"/>
                <exclude name="WEB-INF/web.xml"/>
            </zipfileset>


        </war>

        <delete file="${build.dist}/index.html"/>

    </target>






    <target
            name="doc"
            depends="clean,PreProcessSourceCode"
            description="Builds JavaDoc for the S3 DAP Service software packages, if missing or out of date."
            unless="JavaDocIsUpToDate"
            >

        <javadoc destdir="${build.doc}/javadoc"
                 Author="true"
                 Verbose="true"
                 Version="true"
                 failonerror="true"
                >
            <classpath refid="compile.classpath"/>

            <packageset dir="${build.src}" defaultexcludes="yes"/>


        </javadoc>

    </target>




    <!-- *******************************************************

            S3 Uploader -

            Loads files into an S3 bucket under the supplied upload key.

    -->

    <property name="S3_UPLOAD"       value="-h" />
    <target  name="s3up"
description="Loads files into an S3 bucket under the supplied upload key.
Use -DS3_UPLOAD=&quot;...&quot; to specify the command line options."
             depends="compile">
        <java classname="opendap.aws.s3.SimpleS3Uploader"
              fork="true"
              maxmemory="4096m"
              dir="${build.run}"
        >
            <classpath refid="compile.classpath" />
            <arg line="--s3-bucket-name=${S3_UPLOAD}" />
        </java>

    </target>


    <!-- *******************************************************



   -->

    <property name="REPO_BUILDER"     value="-h"/>
    <target  name="RepositoryBuilder"
description="RepositoryBuilder:
Starting at the supplied point the file system
this code will build a simple XML index of the tree
and transmit the index files and the regular files
to the identified S3 bucket. The resulting index.xml
files in S3 will provide the same logical view of the
regular files as was manifested by the file system.
Use -DREPO_BUILDER=&quot;...&quot; to specify the
command line options."
             depends="compile ">
        <java classname="opendap.aws.s3.SimpleRepositoryUploader"
              fork="true"
              maxmemory="4096m"
              dir="${build.run}"
        >
            <classpath refid="compile.classpath" />
            <arg line="${REPO_BUILDER}" />
        </java>

    </target>




</project>