path: root/common.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="common" basedir="." default="" xmlns:ivy="antlib:org.apache.ivy.ant" xmlns:antcontrib="antlib:net.sf.antcontrib" xmlns:cs="antlib:com.puppycrawl.tools.checkstyle">

    <tstamp>
        <format property="build.date" pattern="yyyy-MM-dd" />
    </tstamp>

    <dirname property="vaadin.basedir" file="${ant.file.common}" />
    <property name="gwt.basedir" location="${vaadin.basedir}/../gwt" />
    <property file="${vaadin.basedir}/build.properties" />

    <property name="modules.to.publish.to.maven" value="shared,server,client,client-compiler,client-compiled,themes,push" />
    <property name="modules.to.publish.to.download" value="${modules.to.publish.to.maven},all" />

    <ivy:settings file="${vaadin.basedir}/ivysettings.xml" />
    <ivy:settings file="${vaadin.basedir}/ivysettings.xml" id="ivysettings" />
    <ivy:resolve log="download-only" file="${vaadin.basedir}/ivy-taskdefs.xml" conf="taskdefs" />
    <ivy:cachepath pathid="taskdefs.classpath" conf="taskdefs" />
    <taskdef uri="antlib:net.sf.antcontrib" resource="net/sf/antcontrib/antlib.xml" classpathref="taskdefs.classpath" />
    <!-- ant contrib for Maven integration -->
    <taskdef resource="org/apache/maven/artifact/ant/antlib.xml" uri="antlib:org.apache.maven.artifact.ant" classpathref="taskdefs.classpath" />

    <!-- FIXME These are not available in other files -->
    <antcontrib:propertyregex property="vaadin.version.major" input="${vaadin.version}" regexp="([^\.]*)\.([^\.]*)\.([^\.]*)" select="\1" />
    <antcontrib:propertyregex property="vaadin.version.minor" input="${vaadin.version}" regexp="([^\.]*)\.([^\.]*)\.([^\.]*)" select="\2" />
    <antcontrib:propertyregex property="vaadin.version.revision" input="${vaadin.version}" regexp="([^\.]*)\.([^\.]*)\.([^\.]*)" select="\3" />
    <filterset begintoken="@" endtoken="@" id="filter-vaadin.version">
        <filter token="version" value="${vaadin.version}" />
    </filterset>

    <union id="empty.reference" />

    <property name="filtered.webcontent.dir" location="${vaadin.basedir}/result/filteredWebContent" />
    <property name="release-notes-tickets-file" location="${vaadin.basedir}/result/release-notes-tickets.html" />

    <target name="filter.webcontent" unless="webcontent.filtered" depends="fetch-release-notes-tickets">
        <property name="webcontent.filtered" value="true" />
        <!-- Running without build.release-notes will cause an error, which 
            is ignored -->
        <loadfile property="release-notes-tickets" srcFile="${release-notes-tickets-file}" failonerror="false" />

        <delete dir="${filtered.webcontent.dir}" />
        <copy todir="${filtered.webcontent.dir}">
            <fileset dir="${vaadin.basedir}/WebContent">
                <include name="img/**" />
            </fileset>
        </copy>
        <copy todir="${filtered.webcontent.dir}">
            <fileset dir="${vaadin.basedir}/WebContent">
                <patternset>
                    <include name="release-notes.html" />
                    <include name="license.html" />
                    <include name="licenses/**" />
                    <include name="css/**" />
                </patternset>
            </fileset>
            <filterchain>
                <expandproperties />
                <replacetokens begintoken="@" endtoken="@">
                    <token key="version" value="${vaadin.version}" />
                </replacetokens>
                <replacetokens begintoken="@" endtoken="@">
                    <token key="version-minor" value="${vaadin.version.major}.${vaadin.version.minor}" />
                </replacetokens>
                <replacetokens begintoken="@" endtoken="@">
                    <token key="builddate" value="${build.date}" />
                </replacetokens>
                <replacetokens begintoken="@" endtoken="@">
                    <token key="release-notes-tickets" value="${release-notes-tickets}" />
                </replacetokens>
            </filterchain>
        </copy>
    </target>

    <target name="fetch-release-notes-tickets" unless="built.release-notes" if="build.release-notes">
        <mkdir dir="${vaadin.basedir}/result" />
        <subant buildpath="${vaadin.basedir}/buildhelpers" target="fetch-release-notes-tickets" antfile="build.xml" inheritall="true">
            <property name="output" location="${release-notes-tickets-file}" />
        </subant>
        <property name="built.release-notes" value="1" />
    </target>

    <fileset dir="${filtered.webcontent.dir}" id="common.files.for.all.jars">
        <patternset>
            <include name="release-notes.html" />
            <include name="license.html" />
            <include name="licenses/**" />
            <include name="css/**" />
            <include name="img/**" />
        </patternset>
    </fileset>


    <target name="pom.xml" description="Generates a pom.xml based on the Ivy configuration. Either for a snapshot or a release version" depends="pom.xml.release,pom.xml.snapshot">
    </target>

    <target name="pom.xml.release" if="build.release">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <property name="ivy.xml" location="${result.dir}/../ivy.xml" />
        <property name="pom.xml" location="${result.dir}/lib/${module.name}-${vaadin.version}.pom" />
        <property name="conf" value="build, build-provided" />
        <property name="vaadin.maven.version" value="${vaadin.version}" />

        <ivy:makepom templatefile="${vaadin.basedir}/pom-template.xml" ivyfile="${ivy.xml}" pomfile="${pom.xml}" conf="${conf}">
            <mapping conf="build" scope="compile" />
            <mapping conf="build-provided" scope="provided" />
        </ivy:makepom>
    </target>

    <target name="pom.xml.snapshot" unless="build.release">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <property name="ivy.xml" location="${result.dir}/../ivy.xml" />
        <property name="pom.xml" location="${result.dir}/lib/${module.name}-${vaadin.version}.pom" />
        <property name="temp.pom.xml" location="${pom.xml}.temp" />
        <property name="conf" value="build, build-provided" />
        <property name="vaadin.maven.version" value="${vaadin.version.major}.${vaadin.version.minor}-SNAPSHOT" />

        <ivy:makepom templatefile="${vaadin.basedir}/pom-template.xml" ivyfile="${ivy.xml}" pomfile="${temp.pom.xml}" conf="${conf}">
            <mapping conf="build" scope="compile" />
            <mapping conf="build-provided" scope="provided" />
        </ivy:makepom>
        <copy file="${temp.pom.xml}" tofile="${pom.xml}">
            <filterchain>
                <replacestring from="${vaadin.version}" to="${vaadin.maven.version}" />
            </filterchain>
        </copy>
        <delete file="${temp.pom.xml}" />
    </target>


    <target name="sources.jar" depends="compile, filter.webcontent">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <fail unless="module.name" message="No module.name parameter given" />
        <fail unless="src" message="No src directory parameter given" />

        <property name="sources.jar" location="${result.dir}/lib/${module.name}-${vaadin.version}-sources.jar" />

        <jar file="${sources.jar}" compress="true">
            <fileset dir="${src}">
                <patternset>
                    <include name="**/*.java" />
                    <include name="**/*.properties" />
                </patternset>
            </fileset>
            <fileset refid="common.files.for.all.jars" />
            <restrict>
                <union refid="extra.jar.includes" />
                <name name="*.java" />
            </restrict>
        </jar>

    </target>

    <target name="javadoc.jar" depends="dependencies, filter.webcontent">
      <fail unless="result.dir" message="No result.dir parameter given" />
        <fail unless="module.name" message="No module.name parameter given" />
        <property name="src" location="{$result.dir}/../src" />
        <property name="javadoc.dir" value="${result.dir}/javadoc" />
        <property name="javadoc.jar" location="${result.dir}/lib/${module.name}-${vaadin.version}-javadoc.jar" />

        <antcontrib:if>
            <!--
              Most straight forward way to skip javadocs is to provide
              an empty javadoc.jar. Ivy publish won't allow leaving the file
              out without using conf attribute. Using conf would make internal
              dependency resolution unnecessary complicated.
             -->
        	<isset property="nojavadoc" />
              <then>
                <jar file="${javadoc.jar}" compress="true">
                  <fileset refid="common.files.for.all.jars" />
                </jar>
              </then>
            <else>
              <javadoc destdir="${javadoc.dir}" author="true" version="true" use="true" windowtitle="${module.name}">
                <packageset dir="${src}" excludes="${classes.exclude}" />

                  <doctitle>&lt;h1>${module.name}&lt;/h1></doctitle>
                  <!-- <header><![CDATA[<script type="text/javascript" src=".html-style/style.js"></script>]]></header> -->
                  <bottom>${javadoc.bottom}</bottom>
                  <link offline="true" href="http://docs.oracle.com/javase/6/docs/api/" packagelistLoc="build/javadoc/j2se-1.6.0" />
                  <link offline="true" href="http://java.sun.com/j2ee/1.4/docs/api/" packagelistLoc="build/javadoc/j2ee-1.4" />
                  <classpath refid="classpath.compile.dependencies" />
              </javadoc>

              <!-- Create a javadoc jar -->
              <jar file="${javadoc.jar}" compress="true">
                <fileset dir="${javadoc.dir}" />
                <fileset refid="common.files.for.all.jars" />
              </jar>
            </else>
        </antcontrib:if>
    </target>

    <target name="jar" depends="compile, pom.xml, filter.webcontent">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <fail unless="module.name" message="No module.name parameter given" />

        <property name="result.jar" location="${result.dir}/lib/${module.name}-${vaadin.version}.jar" />
        <property name="classes" location="{$result.dir}/classes" />
        <property name="src" location="{$result.dir}/../src" />

        <union id="jar.files">
            <fileset dir="${classes}" excludes="${classes.exclude}" erroronmissingdir="false"/>
            <fileset dir="${src}" excludes="${jar.exclude}" erroronmissingdir="false" />
            <fileset refid="common.files.for.all.jars" />
            <union refid="extra.jar.includes" />
        </union>

        <jar destfile="${result.jar}" duplicate="fail" index="true">
            <manifest>
                <attribute name="Implementation-Vendor" value="${vaadin.vendor}" />
                <attribute name="Implementation-URL" value="${vaadin.url}" />
                <attribute name="Implementation-Version" value="${vaadin.version}" />
            </manifest>
            <union refid="jar.files" />
        </jar>

        <antcall target="common.make-osgi-bundle">
            <param name="jar" value="${result.jar}" />
            <param name="bundle-version" value="${vaadin.version}" />
            <param name="bundle-name" value="${module.name}" />
            <param name="bundle-symbolic" value="${module.symbolic}" />
            <param name="bundle-vendor" value="${vaadin.vendor}" />
        </antcall>

    </target>

    <!-- Add OSGi attributes to the manifest of the given jar -->
    <target name="make-osgi-bundle">
        <fail unless="jar" message="No jar parameter given" />
        <fail unless="bundle-name" message="No bundle-name parameter given" />
        <fail unless="bundle-symbolic" message="No bundle-symbolic parameter given" />
        <fail unless="bundle-version" message="No bundle-version parameter given" />
        <fail unless="bundle-vendor" message="No bundle-vendor parameter given" />

        <property name="bundle-manifestversion" value="2" />

        <jar file="${jar}" update="true">
            <manifest>
                <attribute name="Bundle-Version" value="${bundle-version}" />
                <attribute name="Bundle-ManifestVersion" value="${bundle-manifestversion}" />
                <attribute name="Bundle-Name" value="${bundle-name}" />
                <attribute name="Bundle-SymbolicName" value="${bundle-symbolic}" />
                <attribute name="Bundle-Vendor" value="${bundle-vendor}" />
                <attribute name="Bundle-RequiredExecutionEnvironment" value="JavaSE-${vaadin.java.version}" />
            </manifest>
        </jar>

        <antcontrib:if>
            <isset property="import-package" />
            <then>
                <jar file="${result.jar}" update="true">
                    <manifest>
                        <attribute name="Import-Package" value="${import-package}" />
                    </manifest>
                </jar>
            </then>
        </antcontrib:if>
        <antcontrib:if>
            <isset property="require-bundle" />
            <then>
                <jar file="${result.jar}" update="true">
                    <manifest>
                        <attribute name="Require-Bundle" value="${require-bundle}" />
                    </manifest>
                </jar>
            </then>
        </antcontrib:if>
        <antcontrib:if>
            <isset property="export-package" />
            <then>
                <jar file="${result.jar}" update="true">
                    <manifest>
                        <attribute name="Export-Package" value="${export-package}" />
                    </manifest>
                </jar>
            </then>
        </antcontrib:if>

        <!-- Generate the Export-Package attribute in the manifest -->
        <java classname="com.vaadin.buildhelpers.GeneratePackageExports" failonerror="true" fork="yes">
            <arg value="${jar}" />
            <arg line="com/vaadin com/google ${osgi.extra.package.prefixes}" />
            <classpath refid="vaadin.buildhelpers.classpath" />
            <jvmarg value="-Dvaadin.version=${vaadin.version}" />
        </java>
    </target>

    <target name="compile" description="Compiles the module" depends="dependencies, directories" if="src-exists">
        <fail unless="module.name" message="No module name given" />

        <javac srcdir="${src}" destdir="${classes}" source="${vaadin.java.version}" target="${vaadin.java.version}" debug="true" encoding="UTF-8" includeantruntime="false">
            <classpath refid="classpath.compile.dependencies" />
            <classpath refid="classpath.compile.custom" />
        </javac>
        <copy todir="${classes}">
            <fileset dir="${src}" includes="${extra.classes}"/>
        </copy>
    </target>

    <target name="exec-buildhelper" depends="compile">
        <fail unless="main.class" message="No main class given in 'main.class'" />
        <fail unless="output" message="No output file given in 'output'" />
        <java classname="${main.class}" output="${output}" failonerror="true" fork="yes">
            <classpath refid="vaadin.buildhelpers.classpath" />
            <classpath refid="classpath.compile.dependencies" />
            <jvmarg value="-Dvaadin.version=${vaadin.version}" />
        </java>
    </target>

    <target name="directories">
        <property name="result.dir" location="result" />
        <property name="src" location="${result.dir}/../src" />
        <property name="classes" location="${result.dir}/classes" />
        <available file="${src}" type="dir" property="src-exists" />
        <mkdir dir="${classes}" />
    </target>

    <target name="test.run" depends="test.compile">
        <fail unless="module.name" message="No module name given" />

        <property name="result.dir" location="result" />
        <property name="classes" location="${result.dir}/classes" />
        <property name="test.src" location="${result.dir}/../tests/src" />
        <property name="test.classes" location="${result.dir}/tests/classes" />

        <!-- Ensure report dir is empty before running tests -->
        <property name="report.dir" location="${result.dir}/reports" />
        <delete dir="${report.dir}" />
        <mkdir dir="${report.dir}" />

        <junit showoutput="no" printsummary="no" fork="yes">
            <formatter type="xml" />
            <jvmarg value="-ea" />
            <classpath location="${test.classes}" />
            <classpath location="${classes}" />
            <classpath refid="classpath.compile.custom" />
            <classpath refid="classpath.test.dependencies" />

            <batchtest fork="yes" todir="${report.dir}">
                <fileset dir="${test.src}">
                    <exclude name="**/Abstract*" />
                    <exclude name="**/Mock*" />
                    <exclude name="com/vaadin/tests/data/bean/*" />
                    <exclude name="com/vaadin/tests/util/*" />
                    <exclude name="com/vaadin/benchmarks/*" />
                    <exclude name="**/VaadinClasses.java" />
                    <exclude name="**/*TestRunner.java" />
                    <exclude name="**/SQLTestsConstants.java" />
                </fileset>
            </batchtest>
        </junit>
    </target>

    <target name="test.compile" description="Compiles tests" depends="compile, dependencies.test">
        <fail unless="module.name" message="No module name given" />
        <property name="result.dir" location="result" />
        <property name="base.dir" location="${result.dir}/.." />
        <property name="test.src" location="${base.dir}/tests/src" />
        <property name="test.resources" location="${base.dir}/tests/resources" />
        <property name="test.classes" location="${result.dir}/tests/classes" />
        <property name="classes" location="${result.dir}/classes" />

        <mkdir dir="${test.classes}" />

        <javac srcdir="${test.src}" destdir="${test.classes}" source="${vaadin.java.version}" target="${vaadin.java.version}" debug="true" encoding="UTF-8" includeantruntime="false">
            <classpath refid="classpath.test.dependencies" />
            <classpath location="${classes}" />
            <classpath refid="classpath.test.custom" />
        </javac>

        <!-- Copy resources -->
        <copy todir="${test.classes}" failonerror="false">
            <fileset dir="${test.resources}" />
        </copy>
    </target>

    <target name="dependencies" description="Resolves dependencies needed by this module">
        <property name='conf' value="build, build-provided" />
        <ivy:resolve log="download-only" resolveid="common" conf="${conf}" />
        <ivy:cachepath pathid="classpath.compile.dependencies" conf="${conf}" />
    </target>

    <target name="dependencies.test" description="Resolves dependencies needed by test">
        <ivy:resolve log="download-only" resolveid="common" conf="test" />
        <ivy:cachepath pathid="classpath.test.dependencies" conf="test" />
    </target>

    <target name="remove-test-reports">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <delete dir="${result.dir}/reports" />
    </target>

    <target name="clean" depends="remove-test-reports">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <delete dir="${result.dir}" />
    </target>

    <target name="publish-local" description="Publishes the given module to the local repository">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <property name="conf" value="*(public)" />

        <ivy:resolve log="download-only" conf="${conf}" />
        <ivy:publish settingsref="ivysettings" conf="${conf}" resolver="build-temp" overwrite="true" forcedeliver="true">
            <!-- <artifacts pattern="${result.dir}/[artifact]-[revision].[ext]" 
                /> -->
            <artifacts pattern="${result.dir}/lib/[artifact]-[revision](-[classifier]).[ext]" />

        </ivy:publish>
    </target>

    <target name="publish.to.local.maven">
        <property name="conf" value="*(public)" />

        <ivy:resolve log="download-only" conf="${conf}" />
        <ivy:publish conf="${conf}" resolver="local-maven" overwrite="true">
        </ivy:publish>
    </target>

    <!-- Checkstyle conf -->
    <property name="cs.dir" location="${vaadin.basedir}/checkstyle" />
    <property name="cs.xml" location="${cs.dir}/vaadin-checkstyle.xml" />
    <property name="cs.header-file" location="${cs.dir}/header" />
    <property name="cs.import-control-file" location="${cs.dir}/import-control.xml" />
    <taskdef resource="checkstyletask.properties" uri="antlib:com.puppycrawl.tools.checkstyle" classpathref="taskdefs.classpath" />

    <target name="checkstyle">
        <fail unless="result.dir" message="No result.dir parameter given" />
        <fail unless="cs.src" message="No cs.src parameter given" />
        <property name="result.dir.full" location="${result.dir}" />
        <mkdir dir="${result.dir}" />
        <echo>##teamcity[importData type='checkstyle' path='${result.dir.full}/checkstyle-errors.xml']</echo>
        <cs:checkstyle config="${cs.xml}" failOnViolation="false">
            <fileset dir="${cs.src}" includes="**/*.java">
                <exclude name="com/vaadin/sass/internal/parser/Parser.java" />
                <exclude name="com/vaadin/sass/internal/parser/ParserConstants.java" />
                <exclude name="com/vaadin/sass/internal/parser/ParserTokenManager.java" />
            </fileset>
            <formatter type="xml" toFile="${result.dir}/checkstyle-errors.xml" />
            <property key="checkstyle.header.file" file="${cs.header-file}" />
            <property key="checkstyle.importControl.file" file="${cs.import-control-file}" />
        </cs:checkstyle>
    </target>
</project>