build.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
    AntRun, a general-purpose Ant build script
    Copyright (C) 2015-2023  Sylvain Hallé

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-->
<project
  name="AntRun"
  default="dist"
  basedir="."
  xmlns:jacoco="antlib:org.jacoco.ant">
  
  <!-- The build script's version number. Do not edit! -->
  <property name="antrun.version" value="1.8"/>
  
  <!-- Load project properties from XML file -->
  <xmlproperty file="config.xml"/>
  
  <!--
    Default values. Note that Ant's properties cannot be overwritten once
    set; therefore, any property with the same name defined in config.xml
    will have precedence over the values below.
  -->
  
  <!-- The project's display name -->
  <property name="build.name" value="AntRun"/>
  
  <!-- The project's version number -->
  <property name="build.version" value="1.0"/>
  
  <!-- The target JDK version for the build -->
  <property name="build.targetjdk" value="11"/>
  
  <!-- The folder where libraries (ant-contrib, etc.) will be downloaded
       if necessary -->
  <property name="build.libdir" value="Source/Core/lib"/>

  <!-- The folder with the project's source files -->
  <property name="build.srcdir" value="Source/Core/src"/>
  
  <!-- The folder where the compiled files should go -->
  <property name="build.bindir" value="Source/Core/bin"/>
  
  <!-- The folder where the downloaded dependencies (if any) should go -->
  <property name="build.depdir" value="Source/Core/dep"/>
  
  <!-- The folder with the project's test source files -->
  <property name="build.test.srcdir" value="Source/CoreTest/src"/>
  
  <!-- The folder where the compiled test files should go -->
  <property name="build.test.bindir" value="Source/CoreTest/bin"/>
  
  <!-- The folder where the Javadoc files should go -->
  <property name="build.docdir" value="doc"/>
  
  <!-- The folder where the jUnit test reports should go -->
  <property name="test.reportdir" value="tests/junit"/>
  
    <!-- The folder where the coverage test reports should go -->
  <property name="coverage.reportdir" value="tests/coverage"/>
  
  <!-- The project's main class. This is used for the generation of the
       runable JAR file in the "jar" target -->
  <property name="build.mainclass" value="ca.uqac.lif.antrun.Main"/>
  
  <!-- Debug level. If set to true, will produce more detailed reports
       on test code coverage. Set to false for production. -->
  <property name="build.debug" value="true"/>
  
  <!-- Target jar file -->
  <property name="build.jar.filename" value="AntRun.jar"/>
  
  <!-- Generate a jar with the documentation -->
  <property name="build.jar.withdoc" value="false"/>
  
  <!-- Generate a jar with the sources -->
  <property name="build.jar.withsrc" value="false"/>
  
  <!-- Generate a jar with the dependencies -->
  <property name="build.jar.withdeps" value="true"/>
  
  <!-- Base name of the jar to produce (used by the "zip" target) -->
  <basename property="build.jar.basename" file="${build.jar.filename}" suffix=".jar"/>
  
  <!-- The filename pattern to recognize test source files -->
  <property name="build.test.filenamepattern.src" value="**/*Test.java"/>
  
  <!-- The filename pattern to recognize test binary files -->
  <property name="build.test.filenamepattern.bin" value="**/*Test.class"/>
  
  <!-- Target: initialization
       All other targets should ultimately
       depend on this one (except perhaps very simple ones such as
       "clean" and "wipe".
  -->
  <target name="init" depends="ant-contrib,xmltask"
    description="Initialize the project">
    <!-- Load ant-contrib -->
    <taskdef resource="net/sf/antcontrib/antlib.xml"
      classpath="${build.libdir}/ant-contrib-1.0b3.jar"/>
    <!-- Load xmltask -->
    <taskdef name="xmltask" classname="com.oopsconsultancy.xmltask.ant.XmlTask"
      classpath="${build.libdir}/${xmltask.jarname}"/>
    <!-- Set the extension dir -->
    <propertyregex property="build.extdir" 
               input="${java.ext.dirs}" 
               regexp="[${path.separator}]([^${path.separator}]+)$" 
               select="\1"/>
    <echo level="info">Your extension folder is ${build.extdir}</echo>
    <!-- Create depdir -->
    <mkdir dir="${build.depdir}"/>
    <!-- Create a global classpath that other tasks will refer to -->
    <path id="build.classpath">
      <pathelement location="${build.bindir}"/>
      <fileset dir="${build.depdir}">
        <include name="*.jar"/>
      </fileset>
      <fileset dir="${build.libdir}">
        <include name="*.jar"/>
      </fileset>
      <pathelement path="${java.class.path}"/>
    </path>
    <path id="build.test.classpath">
      <pathelement location="${build.bindir}"/>
      <fileset dir="${build.depdir}">
        <include name="*.jar"/>
      </fileset>
      <fileset dir="${build.libdir}">
        <include name="*.jar"/>
      </fileset>
      <pathelement location="${build.test.bindir}"/>
      <pathelement path="${java.class.path}"/>
    </path>
    <!-- Create empty doc folders -->
    <mkdir dir="${build.docdir}"/>
    <mkdir dir="${build.docdir}/doc-files"/>
  </target>
  
  <!-- Target: zip
       Zips the jar
  -->
  <target name="zip" description="Zips the compiled jar">
    <delete file="${build.jar.basename}-${build.version}.zip"/>
    <zip basedir="." destfile="${build.jar.basename}-${build.version}.zip" includes="${build.jar.filename},Readme.md"/>
  </target>
  
  <!-- Target: dist
       This is the default target when Ant is invoked without an argument.
  -->
  <target name="dist" depends="jar" description="Same as jar">
    <!-- Do nothing -->
  </target>
  
  <!-- Target: compile
       Compiles the main project
  -->
  <target name="compile" depends="init,junit,download-deps" description="Compile the sources">
    <mkdir dir="${build.bindir}"/>
    <javac
      release="${build.targetjdk}"
      srcdir="${build.srcdir}"
      destdir="${build.bindir}"
      debug="${build.debug}"
      includeantruntime="false">
      <classpath refid="build.classpath"/>
    </javac>
    <copy todir="${build.bindir}" includeemptydirs="false">
      <fileset dir="${build.srcdir}" excludes="**/*.java,doc-files/**"/>
    </copy>
  </target>
  
  <!-- Target: compile-tests
       Compiles the unit tests
  -->
  <target name="compile-tests" depends="init,compile,junit" description="Compile the test sources">
    <mkdir dir="${build.test.bindir}"/>
    <javac
      release="${build.targetjdk}"
      srcdir="${build.test.srcdir}"
      destdir="${build.test.bindir}"
      debug="${build.debug}"
      includeantruntime="false">
      <classpath refid="build.classpath"/>
    </javac>
    <copy todir="${build.test.bindir}" includeemptydirs="false">
      <fileset dir="${build.test.srcdir}" excludes="**/*.java,doc-files/**"/>
    </copy>
  </target>
  
  <!-- Target: javadoc
       Generates the javadoc associated to the project
  -->
  <target name="javadoc" depends="init" description="Generate the documentation">
    <mkdir dir="${build.docdir}"/>
    <mkdir dir="${build.docdir}/doc-files"/>
    <javadoc sourcepath="${build.srcdir}"
             destdir="${build.docdir}"
             packagenames="*"
             excludepackagenames=""
             defaultexcludes="yes"
             author="true"
             version="true"
             use="true"
             Encoding="utf8"
             docencoding="utf8"
             charset="utf8"
             windowtitle="${build.name} Documentation">
      <doctitle><![CDATA[<h1>]]>${build.name}<![CDATA[ Documentation</h1>]]></doctitle>
      <bottom><![CDATA[<i>Copyright&nbsp;&#169; ]]>${build.author}<![CDATA[. All Rights Reserved.</i>]]></bottom>
      <link href="http://docs.oracle.com/javase/6/docs/api/"/>
      <classpath refid="build.classpath"/>
    </javadoc>
    <if>
      <available file="${build.srcdir}/doc-files" type="dir"/>
      <then>
      	<copy todir="${build.docdir}/doc-files" includeemptydirs="false">
      		<fileset dir="${build.srcdir}/doc-files"/>
      	</copy>
      </then>
    </if>
  </target>
  
  <!-- Target: jar
       Generates a JAR file with the compiled files and javadoc
  -->
  <target name="jar" depends="compile" description="Create the runnable JAR">
      <tstamp>
         <format property="TODAY" pattern="yyyy-MM-dd HH:mm:ss" />
      </tstamp>
      <jar destfile="${build.jar.filename}" filesetmanifest="skip">
	  <manifest>
	      <attribute name="Main-Class" value="${build.mainclass}"/>
	      <attribute name="Class-Path" value="."/>
	      <attribute name="Built-By" value="${user.name}"/>
	      <attribute name="Built-Date" value="${TODAY}"/>
          <attribute name="Implementation-Version" value="${build.version}"/>
	  </manifest>
	  <fileset dir="${build.bindir}">
	    <filename name="**/*"/>
        <not>
          <filename name="${build.test.filenamepattern.bin}"/>
        </not>
	  </fileset>
	  <zipgroupfileset dir="${build.depdir}">
	    <include name="**/*.jar" if="${build.jar.withdeps}"/>
	  </zipgroupfileset>
	  <fileset dir="${build.srcdir}">
	     <include name="**/*" if="${build.jar.withsrc}"/>
	  </fileset>
	  <fileset dir="${build.docdir}">
	    <include name="**/*" if="${build.jar.withdoc}"/>
	  </fileset>
      </jar>
  </target>
  
  <!-- Target: test
       Performs tests with jUnit and generates code coverage report
       with JaCoCo
  -->
  <target name="test" depends="junit,jacoco,compile,compile-tests" description="Perform unit tests and generate coverage report">
    <mkdir dir="${test.reportdir}"/>
    <mkdir dir="${coverage.reportdir}"/>
    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
      <classpath path="${build.libdir}/jacocoant.jar"/>
    </taskdef>
    <!-- Run jUnit. Since the jacoco task does not support the nested
         junitlauncher task (required by jUnit5), we run jUnit manually and
         pass the JaCoCo agent as a parameter to the JVM. -->
    <jacoco:agent property="agentvmparam" enabled="true" destfile="${test.reportdir}/jacoco.exec" />
    <java classpathref="build.test.classpath" classname="org.junit.platform.console.ConsoleLauncher" fork="true" failonerror="true">
      <jvmarg value="${agentvmparam}" />
      <arg line="--scan-classpath" />
      <arg line="--reports-dir ${test.reportdir}" />
    </java>
    <!-- jUnit report -->
    <junitreport todir="${test.reportdir}">
        <fileset dir="${test.reportdir}">
            <include name="TEST-*.xml"/>
        </fileset>
        <report format="frames" todir="${test.reportdir}"/>
    </junitreport>
    <!-- JaCoCo report -->
    <jacoco:report>
      <executiondata>
        <file file="${test.reportdir}/jacoco.exec"/>
      </executiondata>
      <structure name="${build.name}">
        <classfiles>
            <fileset dir="${build.bindir}"/>
        </classfiles>
        <sourcefiles encoding="UTF-8">
            <fileset dir="${build.srcdir}"/>
        </sourcefiles>
      </structure>
      <html destdir="${coverage.reportdir}"/>
      <xml destfile="${test.reportdir}/report.xml"/>
    </jacoco:report>
    <!-- Fail if some test has failed -->
    <fail if="test.failed"/>
  </target>
  
  <!-- Target: all
       Downloads deps, compiles, runs tests, creates JAR
  -->
  <target name="all" depends="init,test,jar" description="Setup, compile, run tests, create JAR">
  </target>
  
  <!-- Target: install-deps
       Copies whatever was fetched by the download-deps task into the
       system's extension folder. This task should probably be run as
       administrator to work.
  -->
  <target name="install-deps" depends="init">
    <copy todir="${build.extdir}" includeemptydirs="false">
      <fileset dir="${build.depdir}" includes="*.jar" />
    </copy>
  </target>
  
  <!-- Target: wipe
       Wipes any temporary files or directories
  -->
  <target name="wipe" description="Wipes the project: deletes everything but sources">
    <delete>
      <fileset dir="." includes="**/*~"/>
    </delete>
    <delete dir="${build.libdir}"/>
    <delete dir="${build.bindir}"/>
    <delete dir="${build.test.bindir}"/>
    <delete dir="${build.docdir}"/>
    <delete dir="${build.depdir}"/>
    <delete dir="${test.reportdir}"/>
    <delete dir="${coverage.reportdir}"/>
    <delete file="jacoco.exec"/>
  </target>
  
  <!-- Target: clean
       Deletes compiled files and test reports
  -->
  <target name="clean" description="Cleans compiled files and test reports">
    <delete>
      <fileset dir="." includes="**/*~"/>
    </delete>
    <delete dir="${build.bindir}"/>
    <delete dir="${build.test.bindir}"/>
    <delete dir="${test.reportdir}"/>
    <delete dir="${coverage.reportdir}"/>
    <delete file="jacoco.exec"/>
  </target>
  
  <!-- Target: show-properties
       Prints all the properties.
  -->
  <target name="show-properties" depends="init" description="Print all properties">
      <echoproperties/>
  </target>
  
  <!-- Target: dummy
       Do nothing. This is only to test the build file
  -->
  <target name="dummy" description="Do nothing">
      <!-- Do nothing -->
  </target>
  
  <!-- Target: run
       Invokes the runnable jar generated by the "dist" target
  -->
  <target name="run" description="Invoke the runnable JAR">
    <java jar="${build.jar.filename}" fork="true"/>
  </target>
  
  <!-- Target: antrun-version
       Shows the version of AntRun
  -->
  <target name="antrun-version" description="Show build script version">
    <echo message="This is AntRun version ${antrun.version}" level="info"/>
  </target>
  
  <!-- ==========================================
    Bootstrap targets
    The following targets download the necessary dependencies
    the build script requires
    ========================================== -->
  
  <!-- Target: ant-contrib.
       Downloads ant-contrib, only if it does not exist
  -->
  <condition property="ant-contrib.absent" value="false" else="true">
    <available file="${build.libdir}/ant-contrib-1.0b3.jar"/>
  </condition>
  <target name="ant-contrib" if="${ant-contrib.absent}"
    description="Install ant-contrib if not present">
    <echo message="ant-contrib is not installed. Downloading..." level="info"/>
    <mkdir dir="${build.libdir}"/>
    <get src="http://sylvainhalle.github.io/AntRun/dependencies/ant-contrib-1.0b3-bin.zip" dest="${build.libdir}/ant-contrib-1.0b3-bin.zip"/>
    <unzip src="${build.libdir}/ant-contrib-1.0b3-bin.zip" dest="${build.libdir}">
      <patternset>
        <include name="**/*.jar"/>
      </patternset>
      <mapper type="flatten"/>
    </unzip>
  </target>
  
  <!-- Target: xmltask
       Download XmlTask JAR if not present, and put it in the lib folder
  -->
  <property name="xmltask.jarname" value="xmltask.jar"/>
  <condition property="xmltask.absent" value="false" else="true">
    <available file="${build.libdir}/${xmltask.jarname}"/>
  </condition>
  <target name="xmltask" if="${xmltask.absent}">
    <mkdir dir="${build.libdir}"/>
    <get src="http://sylvainhalle.github.io/AntRun/dependencies/xmltask.jar" dest="${build.libdir}/${xmltask.jarname}"/>
  </target>

  <!-- Target: junit
       Download jUnit JARs if not present, and puts them in the lib folder
  -->
  <condition property="junit.absent" value="false" else="true">
    <and>
      <available file="${build.libdir}/junit-jupiter-api-5.7.2.jar"/>
      <available file="${build.libdir}/junit-jupiter-engine-5.7.2.jar"/>
      <available file="${build.libdir}/junit-jupiter-params-5.7.2.jar"/>
      <available file="${build.libdir}/junit-platform-console-standalone-1.7.2.jar"/>
      <available file="${build.libdir}/junit-vintage-engine-5.7.2.jar"/>
      <available file="${build.libdir}/apiguardian-api-1.1.2.jar"/>
    </and>
  </condition>
  <target name="junit" if="${junit.absent}" description="Install jUnit if not present">
    <mkdir dir="${build.libdir}"/>
    <get src="https://repo1.maven.org/maven2/org/junit/jupiter/junit-jupiter-api/5.7.2/junit-jupiter-api-5.7.2.jar" dest="${build.libdir}/junit-jupiter-api-5.7.2.jar"/>
    <get src="https://repo1.maven.org/maven2/org/junit/jupiter/junit-jupiter-engine/5.7.2/junit-jupiter-engine-5.7.2.jar" dest="${build.libdir}/junit-jupiter-engine-5.7.2.jar"/>
    <get src="https://repo1.maven.org/maven2/org/junit/jupiter/junit-jupiter-params/5.7.2/junit-jupiter-params-5.7.2.jar" dest="${build.libdir}/junit-jupiter-params-5.7.2.jar"/>
    <get src="https://repo1.maven.org/maven2/org/junit/platform/junit-platform-console-standalone/1.7.2/junit-platform-console-standalone-1.7.2.jar" dest="${build.libdir}/junit-platform-console-standalone-1.7.2.jar"/>
    <get src="https://repo1.maven.org/maven2/org/junit/vintage/junit-vintage-engine/5.7.2/junit-vintage-engine-5.7.2.jar" dest="${build.libdir}/junit-vintage-engine-5.7.2.jar"/>
    <get src="https://repo1.maven.org/maven2/org/apiguardian/apiguardian-api/1.1.2/apiguardian-api-1.1.2.jar" dest="${build.libdir}/apiguardian-api-1.1.2.jar"/>
  </target>
  
  <!-- Target: jacoco
       Download JaCoCo if not present, and put it in the lib folder
  -->
  <property name="jacoco.jarname" value="jacocoant.jar"/>
  <condition property="jacoco.absent" value="false" else="true">
    <available file="${build.libdir}/${jacoco.jarname}"/>
  </condition>
  <target name="jacoco" if="${jacoco.absent}" description="Install JaCoCo if not present">
    <mkdir dir="${build.libdir}"/>
    <get src="http://search.maven.org/remotecontent?filepath=org/jacoco/jacoco/0.8.6/jacoco-0.8.6.zip" dest="${build.libdir}/jacoco.zip"/>
    <unzip src="${build.libdir}/jacoco.zip" dest="${build.libdir}">
      <patternset>
        <include name="**/*.jar"/>
      </patternset>
      <mapper type="flatten"/>
    </unzip>
  </target>
  
  <!-- Task: check-deps
       Loops through all dependencies specified in config.xml; checks if
       the target class name exists in the classpath and prints a status
       message for each.
  -->
  <target name="check-deps" depends="init" description="Check dependency status">
    <sequential>
    <mkdir dir="${build.depdir}"/>
    <xmltask source="config.xml">
      <call path="/build/dependencies/dependency">
        <param name="depname" path="name/text()"/>
        <param name="classname" path="classname/text()"/>
        <actions>
          <if>
            <available classname="@{classname}" classpathref="build.classpath"/>
            <then>
              <echo message="@{depname} is installed" level="info"/>
            </then>
            <else>
              <echo message="@{depname} is missing from the classpath" level="info"/>
            </else>
          </if>
        </actions>
      </call>
    </xmltask>
    </sequential>
  </target>
  
  <!-- Task: download-deps
       Loops through all dependencies specified in config.xml; checks if
       the target class name exists in the classpath; if not, downloads the
       files specified in the <files> section to ${build.depdir}. In the case of
       a zip, unzips all jar files found in the archive and copies them to
       ${build.depdir}.
  -->
  <target name="download-deps" depends="init" description="Download unsatisfied JAR dependencies">
    <sequential>
    <mkdir dir="${build.depdir}"/>
    <xmltask source="config.xml">
      <call path="/build/dependencies/dependency">
        <param name="bundle" path="bundle/text()"/>
        <param name="depname" path="name/text()"/>
        <param name="classname" path="classname/text()"/>
        <actions>
          <var name="depdest" value="${build.depdir}"/>
          <if>
            <equals arg1="false" arg2="@{bundle}" casesensitive="true" trim="true"/>
            <then>
              <var name="depdest" value="${build.libdir}"/>
            </then>
          </if>
          <echo message="Checking if @{depname} is installed" level="info"/>
          <if>
            <available classname="@{classname}" classpathref="build.classpath"/>
            <then>
              <!-- It's there, do nothing -->
            </then>
            <else>
              <echo message="@{depname} not present in classpath. Downloading and copying into ${depdest}..." level="info"/>
              <xmltask source="config.xml">
                <call path="/build/dependencies/dependency[name='@{depname}']/files/jar">
                  <param name="url" path="text()"/>
                  <actions>
                    <get src="@{url}" dest="${depdest}"/>
                  </actions>
                </call>
                <call path="/build/dependencies/dependency[name='@{depname}']/files/zip">
                  <param name="url" path="text()"/>
                  <actions>
                    <get src="@{url}" dest="${depdest}"/>
                    <var name="basename" unset="true"/>
                    <basename property="basename" file="@{url}"/>
		            <unzip src="${depdest}/${basename}" dest="${depdest}">
		              <patternset>
                        <include name="**/*.jar"/>
		              </patternset>
		              <mapper type="flatten"/>
		            </unzip>
                  </actions>
                </call>
                <call path="/build/dependencies/dependency[name='@{depname}']/files/tgz">
                  <param name="url" path="text()"/>
                  <actions>
                    <get src="@{url}" dest="${depdest}"/>
                    <var name="basename" unset="true"/>
                    <basename property="basename" file="@{url}"/>
		            <untar src="${depdest}/${basename}" dest="${depdest}" compression="gzip">
		              <patternset>
                        <include name="**/*.jar"/>
		              </patternset>
		              <mapper type="flatten"/>
		            </untar>
                  </actions>
                </call>
              </xmltask>
            </else>
          </if>
          
        </actions>
      </call>
    </xmltask>
    </sequential>
  </target>
</project>
<!-- :tabWidth=2: -->