4 <!-- Default entry point for the build -->
5 <target name="all" depends="clean, init, compile, jar" />
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}" />
11 <path id="module.build.path">
12 <fileset dir="${external.lib.dir}">
13 <include name="**/*.jar"/>
17 <path id="module.testbuild.path">
18 <fileset dir="${test.lib.dir}">
19 <include name="**/*.jar"/>
25 <target name="init" depends="import_header,startup">
29 <!-- ============================================================================
31 ============================================================================ -->
33 <target name="ant.deps">
36 <target name="deps" depends="import_header">
37 <antcall target="module.build.deps">
38 <param name="download.dir" value="${external.lib.dir}"/>
40 <antcall target="test.d">
41 <param name="download.dir" value="${test.lib.dir}"/>
43 <antcall target="ant.d">
44 <param name="download.dir" value="${ant.downloaded.lib.dir}"/>
46 <antcall target="module.test.deps">
47 <param name="download.dir" value="${test.lib.dir}"/>
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}"/>
62 <target name="clean-deps" depends="init_directory_properties">
64 <fileset dir="${external.lib.dir}" includes="*"/>
67 <fileset dir="${test.lib.dir}" includes="*"/>
70 <fileset dir="${ant.downloaded.lib.dir}" includes="*"/>
74 <!-- ============================================================================
75 Compilation of java code.
76 ============================================================================ -->
78 <!-- Compilation of java code, requires a srcdirs variable to be
79 set to a path of one of more directories separated by : or ;
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" />
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}"/>
99 <!-- Compilation of regular source code and generated source code
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}"/>
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"/>
113 <!-- ============================================================================
114 Generating a jar file.
115 ============================================================================ -->
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}" />
130 <!-- ============================================================================
132 ============================================================================ -->
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"/>
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">
157 <!-- ============================================================================
158 Generate javadoc in pdf format
159 ============================================================================ -->
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" />
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>
179 <!-- ============================================================================
181 ============================================================================ -->
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}">
192 <echo>Results are available in ${module.doccheck.dir}"</echo>
195 <!-- ============================================================================
196 Copy build results to a standard location.
197 ============================================================================ -->
199 <target name="clean-dist" depends="clean">
201 <fileset dir="${module.dist.dir}" includes="**"/>
205 <target name="dist-lite-product" depends="deps,jar">
206 <mkdir dir="${module.dist.dir}"/>
208 <fileset dir="${module.dist.dir}" excludes="**/CVS" />
210 <copy todir="${module.dist.dir}" flatten="yes">
211 <fileset dir="${module.build.dir}">
212 <include name="**/*.jar" />
214 <fileset dir="${module.build.dir}">
215 <include name="**/*.pdf" />
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}" />
228 <target name="dist-lite" depends="clean,dist-lite-product,dist-lite-test">
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}" />
242 depends="dist-lite,dist-javadoc"
243 description="copying compiled sources to dist location and copy documentation to forrest site">
245 message="Copying build results for ${module.name} to a location where other modules can find it." />
248 <!-- ============================================================================
250 ============================================================================ -->
252 <target name="checkstyle-impl">
253 <checkstyle config="${build.dir}/${checkstyle.rules}"
254 failOnViolation="false">
256 <pathelement path="${checkstyle.classpath}"/>
258 <fileset dir="${checkstyle.srcdir}" includes="**/*.java"/>
259 <formatter type="xml" tofile="${module.checkstyle.dir}/${checkstyle.report}.xml"/>
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>
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"/>
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"/>
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" />
290 <fileset dir="${module.test.dir}">
291 <include name="**/*.java" />
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" />
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" />
315 <rules dir="." includes="macker.xml" />
316 <classes dir="${module.classes.dir}">
317 <include name="**/*.class" />
320 <pathelement path="${module.classes.dir}" />
321 <path refid="module.build.path" />
327 <!-- ===========================================================================
329 =========================================================================== -->
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" />
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">
346 <path refid="test.classpath"/>
349 <copy todir="${module.testclasses.dir}">
350 <fileset dir="${module.test.dir}" excludes="**/*.java" />
351 <fileset dir="${module.testresource.dir}" />
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.
360 <target name="base-test-clean">
361 <delete file="coverage.ec"/>
362 <delete file="coverage.em"/>
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"/>
377 <formatter type="xml" />
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" />
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" />
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" />
408 <target name="base-test">
409 <antcall target="base-test-allclasses" />
410 <antcall target="base-test-singleclass" />
413 <!-- Run junit test -->
416 <antcall target="base-test">
417 <param name="testedclasses" value="${module.classes.dir}" />
421 <!-- reporting target used by other targets. This should not depend on
422 the test target to avoid unnecessary duplicate runs of the tests -->
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" />
431 <report todir="${module.report.dir}/html/unit" />
435 <!-- Run junit tests with HTML reporting -->
437 <target name="junit-reports" depends="test">
438 <antcall target="base-reports" />
439 <antcall target="emma-reports" />
442 <target name="reports">
443 <antcall target="junit-reports">
444 <param name="emma.enabled" value="true"/>
448 <!-- Instrument classes using emma -->
450 <target name="emma" depends="init_directory_properties">
451 <emma enabled="${emma.enabled}">
452 <instr instrpath="${module.classes.dir}" mode="overwrite"/>
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" />
463 <txt outfile="${module.emmareport.dir}/report.txt"/>
464 <html outfile="${module.emmareport.dir}/index.html"/>
466 <dirset dir="${src}" >
475 <!-- ============================================================================
477 ============================================================================ -->
479 <!-- Runs a main program found in the test source tree.
481 - my.test.program: class name of the program to run
482 - my.args: arguments to be passed to the program -->
483 <target name="runTestProgram" depends="testclasses">
484 <java classname="${my.test.program}">
485 <arg line="${my.args}"/>
487 <path refid="xmlschemas.path" />
488 <path refid="junit.path" />
489 <pathelement path="${module.testclasses.dir}" />
490 <pathelement path="${testedclasses}" />
491 <pathelement path="${testlibrary}" />
492 <pathelement path="${module.classes.dir}" />
493 <pathelement path="${log4j.properties.dir}" /><!-- for log4j.properties -->
494 <!-- the test resource directory is added to the path as well to make it
495 easy to access resources from tests -->
496 <pathelement path="${module.testresource.dir}" />
497 <path refid="module.testbuild.path" />
498 <path refid="module.build.path" />
503 <property name="database.starter"
504 value="org.wamblee.persistence.test.DatabaseStarter"/>
505 <target name="startdb">
506 <echo>After the database has started, you must populate the database in some way.
507 For instance, using the schemaupdate ant target</echo>
508 <antcall target="runTestProgram">
509 <param name="my.test.program" value="${database.starter}"/>
510 <param name="my.args" value=""/>
514 <property name="schemaupdater"
515 value="org.wamblee.test.HibernateUtils"/>
516 <target name="schemaupdate">
517 <antcall target="runTestProgram">
518 <param name="my.test.program" value="${schemaupdater}"/>
519 <param name="my.args" value="${hibernate.filelist}"/>
523 <target name="schemaexport" depends="init">
524 <mkdir dir="${module.sql.dir}" />
525 <echo>Generating schema in output file ${module.sql.dir}/hibernate.sql</echo>
526 <antcall target="runTestProgram">
527 <param name="my.test.program" value="${schemaupdater}"/>
528 <param name="my.args" value="-export ${module.sql.dir}/hibernate.sql ${hibernate.filelist}"/>
532 <!-- INCLUDED MARKER -->
533 <property name="build_trailer_included" value="true" />