wamblee.org Git - utils/blob - build/trailer.xml

   1 <!-- PROPERTIES -->
   2
   3
   4 <!-- Default entry point for the build -->
   5 <target name="all" depends="clean, init, compile, jar" />
   6
   7 <target name="startup" depends="init_directory_properties">
   8   <property name="module.classpath_id" value="module.build.path" />
   9   <property name="module.classpath" refid="${module.classpath_id}" />
  10
  11   <path id="module.build.path">
  12     <fileset dir="${external.lib.dir}">
  13       <include name="**/*.jar"/>
  14     </fileset>
  15   </path>
  16
  17   <path id="module.testbuild.path">
  18     <fileset dir="${test.lib.dir}">
  19       <include name="**/*.jar"/>
  20     </fileset>
  21   </path>
  22
  23 </target>
  24
  25 <target name="init" depends="import_header,startup">
  26         <tstamp />
  27 </target>
  28
  29 <!-- ============================================================================
  30         Cleanup
  31         ============================================================================ -->
  32
  33 <target name="ant.deps">
  34 </target>
  35
  36 <target name="deps" depends="import_header">
  37   <antcall target="module.build.deps">
  38     <param name="download.dir" value="${external.lib.dir}"/>
  39   </antcall>
  40   <antcall target="test.d">
  41     <param name="download.dir" value="${test.lib.dir}"/>
  42   </antcall>
  43   <antcall target="ant.d">
  44     <param name="download.dir" value="${ant.downloaded.lib.dir}"/>
  45   </antcall>
  46   <antcall target="module.test.deps">
  47     <param name="download.dir" value="${test.lib.dir}"/>
  48   </antcall>
  49 </target>
  50
  51 <target name="clean" depends="init_directory_properties,base-test-clean">
  52         <delete dir="${module.classes.dir}" />
  53         <delete dir="${module.testclasses.dir}" />
  54         <delete dir="${module.testoutput.dir}" />
  55         <delete dir="${module.jars.dir}" />
  56         <delete dir="${module.docbase.dir}" />
  57         <delete dir="${module.report.dir}" />
  58         <delete dir="${module.sql.dir}" />
  59         <delete dir="${module.build.dir}"/>
  60 </target>
  61
  62 <target name="clean-deps" depends="init_directory_properties">
  63   <delete>
  64     <fileset dir="${external.lib.dir}" includes="*"/>
  65   </delete>
  66   <delete>
  67     <fileset dir="${test.lib.dir}" includes="*"/>
  68   </delete>
  69   <delete>
  70     <fileset dir="${ant.downloaded.lib.dir}" includes="*"/>
  71   </delete>
  72 </target>
  73
  74 <!-- ============================================================================
  75         Compilation of java code.
  76         ============================================================================ -->
  77
  78 <!--  Compilation of java code, requires a srcdirs variable to be
  79       set to a path of one of more directories separated by : or ;
  80 -->
  81 <target name="compile-impl" depends="init">
  82         <mkdir dir="${module.classes.dir}" />
  83         <echo level="info" message="compile ${module.name}, source dirs ${srcdirs}" />
  84         <javac srcdir="${srcdirs}" source="${javac.source}"
  85                 destdir="${module.classes.dir}" classpath="${module.classpath}"
  86                 debug="${javac.debug}" debuglevel="${javac.debug.level}" />
  87         <copy todir="${module.classes.dir}">
  88                 <fileset dir="${module.source.dir}" excludes="**/*.java" />
  89         </copy>
  90 </target>
  91
  92 <!--  Compilation of regular source code -->
  93 <target name="compile-src" unless="ejbsource.available" depends="init">
  94     <antcall target="compile-impl">
  95         <param name="srcdirs" value="${module.source.dir}"/>
  96     </antcall>
  97 </target>
  98
  99 <!--  Compilation of regular source code and generated source code
 100       for EJBs -->
 101 <target name="compile-src-ejb" if="ejbsource.available" depends="init">
 102     <antcall target="compile-impl">
 103         <param name="srcdirs" value="${module.source.dir}:${module.ejbsource.dir}"/>
 104     </antcall>
 105 </target>
 106
 107 <target name="compile" depends="init">
 108     <available file="${module.ejbsource.dir}" type="dir" property="ejbsource.available"/>
 109     <antcall target="compile-src"/>
 110     <antcall target="compile-src-ejb"/>
 111 </target>
 112
 113 <!-- ============================================================================
 114         Generating a jar file.
 115         ============================================================================ -->
 116
 117 <target name="jar" depends="compile">
 118         <mkdir dir="${module.jars.dir}" />
 119         <echo level="info" message="jar cdmvbase ${module.name}" />
 120         <!-- Hack: how to remove the schemas directory from the jar when it does not exist -->
 121         <mkdir dir="${xmlschemas.dir}" />
 122         <jar jarfile="${module.jars.dir}/${module.jar.name}"
 123                 compress="${jarcompress}">
 124                 <fileset dir="${module.classes.dir}" />
 125                 <fileset dir="${xmlschemas.dir}" />
 126         </jar>
 127 </target>
 128
 129
 130 <!-- ============================================================================
 131         Generate javadoc.
 132         ============================================================================ -->
 133
 134 <target name="javadoc" depends="init">
 135         <!-- create javadocs -->
 136         <javadoc packagenames="*" destdir="${module.javadoc.dir}"
 137                 author="true" version="true" use="true" private="yes"
 138                 windowtitle="Dragon documentation" source="${javac.source}"
 139                 sourcepath="${module.source.dir}"
 140                 classpath="${module.classpath}">
 141                 <arg value="-docfilessubdirs"/>
 142                 <arg value="-overview"/>
 143                 <arg value="${module.source.dir}/overview.html"/>
 144         </javadoc>
 145 </target>
 146
 147 <target name="testjavadoc" depends="testclasses">
 148         <!-- create javadocs -->
 149         <javadoc packagenames="*" destdir="${module.testjavadoc.dir}"
 150                 author="true" version="true" use="true" private="yes"
 151                 windowtitle="Dragon test documentation" source="${javac.source}"
 152                 sourcepath="${module.test.dir}"
 153                 classpathref="test.classpath">
 154         </javadoc>
 155 </target>
 156
 157 <!-- ============================================================================
 158         Generate javadoc in pdf format
 159         ============================================================================ -->
 160
 161 <target name="pdfdoc" depends="init">
 162         <!-- create javadocs -->
 163         <mkdir dir="${module.pdfdoc.dir}" />
 164         <javadoc packagenames="*" author="true" version="true" private="yes"
 165                 source="${javac.source}" doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet"
 166                 docletpathref="pdfdoclet.path"
 167                 classpath="${module.classpath}"
 168                 sourcepath="${module.source.dir}"
 169                 additionalparam="-pdf ${module.pdfdoc.dir}/${module.name}.pdf">
 170                 <!-- fileset dir="${module.source.dir}">
 171                         <include name="**/*.java" />
 172                 </fileset -->
 173         </javadoc>
 174         <echo
 175                 message="Unfortuantely, this target will have generated some errors but the pdf will still look fine" />
 176         <echo>Result is available in ${module.pdfdoc.dir}"</echo>
 177 </target>
 178
 179 <!-- ============================================================================
 180         Check javadoc
 181         ============================================================================ -->
 182
 183 <target name="doccheck" depends="init">
 184         <mkdir dir="${module.doccheck.dir}" />
 185         <javadoc packagenames="*" destdir="${module.doccheck.dir}"
 186                 author="true" version="true"
 187                 doclet="com.sun.tools.doclets.doccheck.DocCheck"
 188                 docletpathref="doccheck.path"
 189                 classpath="${module.classpath}"
 190                 sourcepath="${module.source.dir}">
 191         </javadoc>
 192         <echo>Results are available in ${module.doccheck.dir}"</echo>
 193 </target>
 194
 195 <!-- ============================================================================
 196         Copy build results to a standard location.
 197         ============================================================================ -->
 198
 199 <target name="clean-dist" depends="clean">
 200   <delete>
 201     <fileset dir="${module.dist.dir}" includes="**"/>
 202   </delete>
 203 </target>
 204
 205 <target name="dist-lite-product" depends="deps,jar">
 206     <mkdir dir="${module.dist.dir}"/>
 207         <delete>
 208                 <fileset dir="${module.dist.dir}" excludes="**/CVS" />
 209         </delete>
 210         <copy todir="${module.dist.dir}" flatten="yes">
 211                 <fileset dir="${module.build.dir}">
 212                         <include name="**/*.jar" />
 213                 </fileset>
 214                 <fileset dir="${module.build.dir}">
 215                         <include name="**/*.pdf" />
 216                 </fileset>
 217         </copy>
 218 </target>
 219
 220 <target name="dist-lite-test" depends="deps,testclasses">
 221     <jar destfile="${module.dist.dir}/${module.testjar.name}"
 222                 basedir="${module.testclasses.dir}"
 223                 includes="**/*.class"/>
 224     <jar destfile="${module.dist.dir}/${module.testresourcesjar.name}"
 225                 basedir="${module.testresource.dir}" />
 226 </target>
 227
 228 <target name="dist-lite" depends="clean,dist-lite-product,dist-lite-test">
 229 </target>
 230
 231 <target name="dist-javadoc" depends="javadoc,pdfdoc,testjavadoc">
 232     <jar destfile="${module.dist.dir}/${module.javadocjar.name}"
 233                 basedir="${module.javadoc.dir}" />
 234         <jar destfile="${module.dist.dir}/${module.testjavadocjar.name}"
 235                 basedir="${module.testjavadoc.dir}" />
 236         <copy todir="${module.api.forrest.dir}">
 237                 <fileset dir="${module.javadoc.dir}" />
 238         </copy>
 239 </target>
 240
 241 <target name="dist"
 242         depends="dist-lite,dist-javadoc"
 243         description="copying compiled sources to dist location and copy documentation to forrest site">
 244         <echo
 245                 message="Copying build results for ${module.name} to a location where other modules can find it." />
 246 </target>
 247
 248 <!-- ============================================================================
 249         Check style,
 250         ============================================================================ -->
 251
 252 <target name="checkstyle-impl">
 253    <checkstyle config="${build.dir}/${checkstyle.rules}"
 254                 failOnViolation="false">
 255                 <classpath>
 256                   <pathelement path="${checkstyle.classpath}"/>
 257                 </classpath>
 258                 <fileset dir="${checkstyle.srcdir}" includes="**/*.java"/>
 259                 <formatter type="xml" tofile="${module.checkstyle.dir}/${checkstyle.report}.xml"/>
 260         </checkstyle>
 261         <style style="${build.dir}/checkstyle-simple.xsl"
 262                    in="${module.checkstyle.dir}/${checkstyle.report}.xml"
 263                    out="${module.checkstyle.dir}/${checkstyle.report}.html"/>
 264         <echo>Results are available at ${module.checkstyle.dir}/${checkstyle.report}.html</echo>
 265 </target>
 266
 267 <target name="checkstyle" depends="testclasses">
 268     <mkdir dir="${module.checkstyle.dir}"/>
 269         <antcall target="checkstyle-impl">
 270           <param name="checkstyle.classpath" refid="module.build.path"/>
 271           <param name="checkstyle.srcdir" value="${module.source.dir}"/>
 272           <param name="checkstyle.report" value="source-results"/>
 273         </antcall>
 274         <antcall target="checkstyle-impl">
 275           <param name="checkstyle.classpath" refid="module.testbuild.path"/>
 276           <param name="checkstyle.srcdir" value="${module.test.dir}"/>
 277           <param name="checkstyle.report" value="test-results"/>
 278         </antcall>
 279 </target>
 280
 281 <!-- ============================================================================
 282         Formatting source code.
 283         ============================================================================ -->
 284 <target name="format" depends="init">
 285         <jalopy loglevel="INFO" classpathref="module.testbuild.path"
 286                 convention="${jalopy.rules}">
 287                 <fileset dir="${module.source.dir}">
 288                         <include name="**/*.java" />
 289                 </fileset>
 290                 <fileset dir="${module.test.dir}">
 291                         <include name="**/*.java" />
 292                 </fileset>
 293         </jalopy>
 294 </target>
 295
 296 <!-- =========================================================================
 297         Check redundancy in the code
 298         ========================================================================= -->
 299 <target name="simian" depends="init">
 300         <simian threshold="7">
 301                 <fileset dir="${module.source.dir}" includes="**/*.java" />
 302         </simian>
 303 </target>
 304
 305
 306 <!-- =========================================================================
 307         Check dependencies using macker.
 308         ========================================================================= -->
 309 <property name="macker.file" value="macker.xml" />
 310 <target name="macker" depends="compile">
 311         <available file="${macker.file}" property="macker.file.found" />
 312         <fail message="Macker source file ${macker.file} was not found."
 313                 unless="macker.file.found" />
 314         <macker>
 315                 <rules dir="." includes="macker.xml" />
 316                 <classes dir="${module.classes.dir}">
 317                         <include name="**/*.class" />
 318                 </classes>
 319                 <classpath>
 320                     <pathelement path="${module.classes.dir}" />
 321                         <path refid="module.build.path" />
 322                 </classpath>
 323         </macker>
 324 </target>
 325
 326
 327 <!-- ===========================================================================
 328         JUnit tests.
 329         =========================================================================== -->
 330
 331 <target name="testclasses" depends="compile">
 332         <mkdir dir="${module.test.dir}" />
 333         <mkdir dir="${module.testresource.dir}" />
 334         <mkdir dir="${module.testclasses.dir}" />
 335                 <path id="test.classpath">
 336                 <pathelement path="${module.classes.dir}" />
 337                 <pathelement path="${module.test.dir}" />
 338                 <path refid="module.testbuild.path" />
 339                 <path refid="module.build.path" />
 340         </path>
 341         <javac srcdir="${module.test.dir}"
 342                 destdir="${module.testclasses.dir}"
 343                 debug="${javac.debug}" debuglevel="${javac.debug.level}" compiler="modern"
 344                 source="${javac.source}" failonerror="yes">
 345                 <classpath>
 346                     <path refid="test.classpath"/>
 347                 </classpath>
 348         </javac>
 349         <copy todir="${module.testclasses.dir}">
 350                 <fileset dir="${module.test.dir}" excludes="**/*.java" />
 351                 <fileset dir="${module.testresource.dir}" />
 352         </copy>
 353 </target>
 354
 355 <!-- test-base is a target mean to be used by other targets.
 356         It expects one parameter names 'testedclasses' to indicate the directory
 357         where the compiled test classes reside.
 358 -->
 359
 360 <target name="base-test-clean">
 361   <delete file="coverage.ec"/>
 362   <delete file="coverage.em"/>
 363 </target>
 364
 365
 366 <target name="base-test-impl" depends="testclasses">
 367         <mkdir dir="${module.report.dir}" />
 368         <antcall target="emma"/>
 369         <junit haltonfailure="${junit.halt.on.failure}" printsummary="on" dir="." fork="yes" showoutput="yes">
 370                 <batchtest todir="${module.report.dir}">
 371                         <fileset dir="${module.testclasses.dir}">
 372                                 <include name="${testclassnames}" />
 373                                 <!--  exclude inner classes -->
 374                                 <exclude name="**/*$$*.class"/>
 375                         </fileset>
 376                 </batchtest>
 377                 <formatter type="xml" />
 378                 <classpath>
 379                         <path refid="xmlschemas.path" />
 380                         <pathelement path="${module.testclasses.dir}" />
 381                         <pathelement path="${testedclasses}" />
 382                         <pathelement path="${testlibrary}" />
 383                         <pathelement path="${module.classes.dir}" />
 384                         <pathelement path="${log4j.properties.dir}" /><!--  for log4j.properties -->
 385                         <!-- the test resource directory is added to the path as well to make it
 386                                 easy to access resources from tests -->
 387                         <pathelement path="${module.testresource.dir}" />
 388                         <path refid="module.testbuild.path" />
 389                         <path refid="module.build.path" />
 390                 </classpath>
 391         </junit>
 392 </target>
 393
 394 <target name="base-test-allclasses" unless="test">
 395         <echo>Testing all classes</echo>
 396         <antcall target="base-test-impl">
 397                 <param name="testclassnames" value="**/*Test.class" />
 398         </antcall>
 399 </target>
 400
 401 <target name="base-test-singleclass" if="test">
 402         <echo>Testing testcases that conform to the pattern *${test}*</echo>
 403         <antcall target="base-test-impl">
 404                 <param name="testclassnames" value="**/*${test}*.class" />
 405         </antcall>
 406 </target>
 407
 408 <target name="base-test">
 409         <antcall target="base-test-allclasses" />
 410         <antcall target="base-test-singleclass" />
 411 </target>
 412
 413 <!-- Run junit test -->
 414
 415 <target name="test">
 416         <antcall target="base-test">
 417                 <param name="testedclasses" value="${module.classes.dir}" />
 418         </antcall>
 419 </target>
 420
 421 <!-- reporting target used by other targets. This should not depend on
 422         the test target to avoid unnecessary duplicate runs of the tests -->
 423
 424 <target name="base-reports" depends="init">
 425         <mkdir dir="${module.report.dir}/html" />
 426         <mkdir dir="${module.report.dir}/html/unit" />
 427         <junitreport todir="${module.report.dir}" tofile="${unitreport}">
 428                 <fileset dir="${module.report.dir}">
 429                         <include name="TEST-*.xml" />
 430                 </fileset>
 431                 <report todir="${module.report.dir}/html/unit" />
 432         </junitreport>
 433 </target>
 434
 435 <!-- Run junit tests with HTML reporting -->
 436
 437 <target name="junit-reports" depends="test">
 438         <antcall target="base-reports" />
 439         <antcall target="emma-reports" />
 440 </target>
 441
 442 <target name="reports">
 443   <antcall target="junit-reports">
 444     <param name="emma.enabled" value="true"/>
 445   </antcall>
 446 </target>
 447
 448  <!-- Instrument classes using emma -->
 449
 450   <target name="emma" depends="init_directory_properties">
 451     <emma enabled="${emma.enabled}">
 452       <instr instrpath="${module.classes.dir}" mode="overwrite"/>
 453     </emma>
 454   </target>
 455
 456   <target name="emma-reports" depends="init_directory_properties" if="emma.enabled">
 457     <mkdir dir="${module.emmareport.dir}"/>
 458     <emma enabled="${emma.enabled}" >
 459       <report sourcepath="${module.source.dir}">
 460         <!-- collect all EMMA data dumps (metadata and runtime): -->
 461         <infileset dir="." includes="*.em, *.ec" />
 462
 463         <txt outfile="${module.emmareport.dir}/report.txt"/>
 464         <html outfile="${module.emmareport.dir}/index.html"/>
 465         <!-- sourcepath>
 466           <dirset dir="${src}" >
 467             <include name="." />
 468           </dirset>
 469         </sourcepath -->
 470       </report>
 471     </emma>
 472   </target>
 473
 474 <!-- =======================================================================
 475    FORREST
 476    ======================================================================-->
 477   <target name="forrest" description="runs Forrest">
 478     <property name="forrest.home" location="${env.FORREST_HOME}" />
 479     <property name="forrest.ant.home" location="${forrest.home}/tools/ant" />
 480     <java classname="org.apache.tools.ant.Main" fork="true" failonerror="true" maxmemory="128M">
 481       <classpath>
 482         <fileset dir="${forrest.ant.home}/lib">
 483           <include name="*.jar" />
 484         </fileset>
 485         <pathelement path="${java.home}/../lib/tools.jar" />
 486       </classpath>
 487       <sysproperty key="ant.home" value="${forrest.ant.home}" />
 488       <sysproperty key="forrest.home" value="${forrest.home}" />
 489       <sysproperty key="basedir" value="${basedir}" />
 490       <sysproperty key="java.endorsed.dirs" value="${forrest.home}/lib/endorsed" />
 491       <arg line="-f ${forrest.home}/main/forrest.build.xml" />
 492     </java>
 493   </target>
 494
 495 <!--  ============================================================================
 496       Database targets
 497       ============================================================================ -->
 498
 499 <!--  Runs a main program found in the test source tree.
 500       Properties:
 501          - my.test.program: class name of the program to run
 502          - my.args: arguments to be passed to the program -->
 503 <target name="runTestProgram" depends="testclasses">
 504         <java classname="${my.test.program}">
 505             <arg line="${my.args}"/>
 506                 <classpath>
 507                         <path refid="xmlschemas.path" />
 508                         <path refid="junit.path" />
 509                         <pathelement path="${module.testclasses.dir}" />
 510                         <pathelement path="${testedclasses}" />
 511                         <pathelement path="${testlibrary}" />
 512                         <pathelement path="${module.classes.dir}" />
 513                         <pathelement path="${log4j.properties.dir}" /><!--  for log4j.properties -->
 514                         <!-- the test resource directory is added to the path as well to make it
 515                                 easy to access resources from tests -->
 516                         <pathelement path="${module.testresource.dir}" />
 517                         <path refid="module.testbuild.path" />
 518                         <path refid="module.build.path" />
 519                 </classpath>
 520         </java>
 521 </target>
 522
 523 <property name="database.starter"
 524           value="org.wamblee.persistence.test.DatabaseStarter"/>
 525 <target name="startdb">
 526     <echo>After the database has started, you must populate the database in some way.
 527           For instance, using the schemaupdate ant target</echo>
 528     <antcall target="runTestProgram">
 529         <param name="my.test.program" value="${database.starter}"/>
 530         <param name="my.args" value=""/>
 531     </antcall>
 532 </target>
 533
 534 <property name="schemaupdater"
 535           value="org.wamblee.test.HibernateUtils"/>
 536 <target name="schemaupdate">
 537     <antcall target="runTestProgram">
 538         <param name="my.test.program" value="${schemaupdater}"/>
 539         <param name="my.args" value="${hibernate.filelist}"/>
 540     </antcall>
 541 </target>
 542
 543 <target name="schemaexport" depends="init">
 544     <mkdir dir="${module.sql.dir}" />
 545     <echo>Generating schema in output file ${module.sql.dir}/hibernate.sql</echo>
 546     <antcall target="runTestProgram">
 547         <param name="my.test.program" value="${schemaupdater}"/>
 548         <param name="my.args" value="-export ${module.sql.dir}/hibernate.sql ${hibernate.filelist}"/>
 549     </antcall>
 550 </target>
 551
 552 <!-- INCLUDED MARKER -->
 553 <property name="build_trailer_included" value="true" />
 554
 555