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="module.test.deps">
44 <param name="download.dir" value="${test.lib.dir}"/>
48 <target name="clean" depends="init_directory_properties,base-test-clean">
49 <delete dir="${module.classes.dir}" />
50 <delete dir="${module.testclasses.dir}" />
51 <delete dir="${module.testoutput.dir}" />
52 <delete dir="${module.jars.dir}" />
53 <delete dir="${module.docbase.dir}" />
54 <delete dir="${module.report.dir}" />
55 <delete dir="${module.sql.dir}" />
58 <target name="clean-deps" depends="init_directory_properties">
59 <delete dir="${external.lib.dir}"/>
60 <delete dir="${test.lib.dir}"/>
63 <!-- ============================================================================
64 Compilation of java code.
65 ============================================================================ -->
67 <!-- Compilation of java code, requires a srcdirs variable to be
68 set to a path of one of more directories separated by : or ;
70 <target name="compile-impl" depends="init">
71 <mkdir dir="${module.classes.dir}" />
72 <echo level="info" message="compile ${module.name}, source dirs ${srcdirs}" />
73 <javac srcdir="${srcdirs}" source="${javac.source}"
74 destdir="${module.classes.dir}" classpath="${module.classpath}"
75 debug="${javac.debug}" debuglevel="${javac.debug.level}" />
76 <copy todir="${module.classes.dir}">
77 <fileset dir="${module.source.dir}" excludes="**/*.java" />
81 <!-- Compilation of regular source code -->
82 <target name="compile-src" unless="ejbsource.available" depends="init">
83 <antcall target="compile-impl">
84 <param name="srcdirs" value="${module.source.dir}"/>
88 <!-- Compilation of regular source code and generated source code
90 <target name="compile-src-ejb" if="ejbsource.available" depends="init">
91 <antcall target="compile-impl">
92 <param name="srcdirs" value="${module.source.dir}:${module.ejbsource.dir}"/>
96 <target name="compile" depends="init">
97 <available file="${module.ejbsource.dir}" type="dir" property="ejbsource.available"/>
98 <antcall target="compile-src"/>
99 <antcall target="compile-src-ejb"/>
102 <!-- ============================================================================
103 Generating a jar file.
104 ============================================================================ -->
106 <target name="jar" depends="compile">
107 <mkdir dir="${module.jars.dir}" />
108 <echo level="info" message="jar cdmvbase ${module.name}" />
109 <!-- Hack: how to remove the schemas directory from the jar when it does not exist -->
110 <mkdir dir="${xmlschemas.dir}" />
111 <jar jarfile="${module.jars.dir}/${module.jar.name}"
112 compress="${jarcompress}">
113 <fileset dir="${module.classes.dir}" />
114 <fileset dir="${xmlschemas.dir}" />
119 <!-- ============================================================================
121 ============================================================================ -->
123 <target name="javadoc" depends="init">
124 <!-- create javadocs -->
125 <javadoc packagenames="*" destdir="${module.javadoc.dir}"
126 author="true" version="true" use="true" private="yes"
127 windowtitle="Dragon documentation" source="${javac.source}"
128 sourcepath="${module.source.dir}"
129 classpath="${module.classpath}">
130 <arg value="-docfilessubdirs"/>
131 <arg value="-overview"/>
132 <arg value="${module.source.dir}/overview.html"/>
136 <target name="testjavadoc" depends="testclasses">
137 <!-- create javadocs -->
138 <javadoc packagenames="*" destdir="${module.testjavadoc.dir}"
139 author="true" version="true" use="true" private="yes"
140 windowtitle="Dragon test documentation" source="${javac.source}"
141 sourcepath="${module.test.dir}"
142 classpathref="test.classpath">
146 <!-- ============================================================================
147 Generate javadoc in pdf format
148 ============================================================================ -->
150 <target name="pdfdoc" depends="init">
151 <!-- create javadocs -->
152 <mkdir dir="${module.pdfdoc.dir}" />
153 <javadoc packagenames="*" author="true" version="true" private="yes"
154 source="${javac.source}" doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet"
155 docletpathref="pdfdoclet.path"
156 additionalparam="-pdf ${module.pdfdoc.dir}/${module.name}.pdf">
157 <fileset dir="${module.source.dir}">
158 <include name="**/*.java" />
162 message="Unfortuantely, this target will have generated some errors but the pdf will still look fine" />
165 <!-- ============================================================================
167 ============================================================================ -->
169 <target name="doccheck" depends="init">
170 <mkdir dir="${module.doccheck.dir}" />
171 <javadoc packagenames="*" destdir="${module.doccheck.dir}"
172 author="true" version="true"
173 doclet="com.sun.tools.doclets.doccheck.DocCheck"
174 docletpathref="doccheck.path"
175 classpath="${module.classpath}"
176 sourcepath="${module.source.dir}">
180 <!-- ============================================================================
181 Copy build results to a standard location.
182 ============================================================================ -->
184 <target name="clean-dist" depends="clean">
186 <fileset dir="${module.dist.dir}" includes="**"/>
190 <target name="dist-lite-product" depends="jar">
191 <mkdir dir="${module.dist.dir}"/>
193 <fileset dir="${module.dist.dir}" excludes="**/CVS" />
195 <copy todir="${module.dist.dir}" flatten="yes">
196 <fileset dir="${module.build.dir}">
197 <include name="**/*.jar" />
199 <fileset dir="${module.build.dir}">
200 <include name="**/*.pdf" />
205 <target name="dist-lite-test" depends="testclasses">
206 <jar destfile="${module.dist.dir}/${module.testjar.name}"
207 basedir="${module.testclasses.dir}"
208 includes="**/*.class"/>
209 <jar destfile="${module.dist.dir}/${module.testresourcesjar.name}"
210 basedir="${module.testresource.dir}" />
213 <target name="dist-lite" depends="clean,dist-lite-product,dist-lite-test">
216 <target name="dist-javadoc" depends="javadoc,pdfdoc,testjavadoc">
217 <jar destfile="${module.dist.dir}/${module.javadocjar.name}"
218 basedir="${module.javadoc.dir}" />
219 <jar destfile="${module.dist.dir}/${module.testjavadocjar.name}"
220 basedir="${module.testjavadoc.dir}" />
221 <copy todir="${module.api.forrest.dir}">
222 <fileset dir="${module.javadoc.dir}" />
227 depends="dist-lite,dist-javadoc"
228 description="copying compiled sources to dist location and copy documentation to forrest site">
230 message="Copying build results for ${module.name} to a location where other modules can find it." />
233 <!-- ============================================================================
235 ============================================================================ -->
237 <target name="checkstyle" depends="testclasses">
238 <checkstyle config="${build.dir}/${checkstyle.rules}"
239 failOnViolation="false" classpathref="module.testbuild.path">
240 <fileset dir="${module.source.dir}" includes="**/*.java" />
241 <formatter type="plain" />
243 <checkstyle config="${build.dir}/${checkstyle.test.rules}"
244 failOnViolation="false" classpathref="module.testbuild.path">
245 <fileset dir="${module.test.dir}" includes="**/*.java" />
246 <formatter type="plain" />
250 <!-- ============================================================================
251 Formatting source code.
252 ============================================================================ -->
253 <target name="format" depends="init">
254 <jalopy loglevel="INFO" classpathref="module.testbuild.path"
255 convention="${jalopy.rules}">
256 <fileset dir="${module.source.dir}">
257 <include name="**/*.java" />
259 <fileset dir="${module.test.dir}">
260 <include name="**/*.java" />
265 <!-- =========================================================================
266 Check redundancy in the code
267 ========================================================================= -->
268 <target name="simian" depends="init">
269 <simian threshold="7">
270 <fileset dir="${module.source.dir}" includes="**/*.java" />
275 <!-- =========================================================================
276 Check dependencies using macker.
277 ========================================================================= -->
278 <property name="macker.file" value="macker.xml" />
279 <target name="macker" depends="compile">
280 <available file="${macker.file}" property="macker.file.found" />
281 <fail message="Macker source file ${macker.file} was not found."
282 unless="macker.file.found" />
284 <rules dir="." includes="macker.xml" />
285 <classes dir="${module.classes.dir}">
286 <include name="**/*.class" />
289 <pathelement path="${module.classes.dir}" />
290 <path refid="module.build.path" />
296 <!-- ===========================================================================
298 =========================================================================== -->
300 <target name="testclasses" depends="compile">
301 <mkdir dir="${module.test.dir}" />
302 <mkdir dir="${module.testresource.dir}" />
303 <mkdir dir="${module.testclasses.dir}" />
304 <path id="test.classpath">
305 <pathelement path="${module.classes.dir}" />
306 <pathelement path="${module.test.dir}" />
307 <path refid="module.testbuild.path" />
308 <path refid="module.build.path" />
310 <javac srcdir="${module.test.dir}"
311 destdir="${module.testclasses.dir}"
312 debug="${javac.debug}" debuglevel="${javac.debug.level}" compiler="modern"
313 source="${javac.source}" failonerror="yes">
315 <path refid="test.classpath"/>
318 <copy todir="${module.testclasses.dir}">
319 <fileset dir="${module.test.dir}" excludes="**/*.java" />
320 <fileset dir="${module.testresource.dir}" />
324 <!-- test-base is a target mean to be used by other targets.
325 It expects one parameter names 'testedclasses' to indicate the directory
326 where the compiled test classes reside.
329 <target name="base-test-clean">
330 <delete file="coverage.ec"/>
331 <delete file="coverage.em"/>
335 <target name="base-test-impl" depends="testclasses">
336 <mkdir dir="${module.report.dir}" />
337 <antcall target="emma"/>
338 <junit haltonfailure="${junit.halt.on.failure}" printsummary="on" dir="." fork="yes" showoutput="yes">
339 <batchtest todir="${module.report.dir}">
340 <fileset dir="${module.testclasses.dir}">
341 <include name="${testclassnames}" />
342 <!-- exclude inner classes -->
343 <exclude name="**/*$$*.class"/>
346 <formatter type="xml" />
348 <path refid="xmlschemas.path" />
349 <pathelement path="${module.testclasses.dir}" />
350 <pathelement path="${testedclasses}" />
351 <pathelement path="${testlibrary}" />
352 <pathelement path="${module.classes.dir}" />
353 <pathelement path="${log4j.properties.dir}" /><!-- for log4j.properties -->
354 <!-- the test resource directory is added to the path as well to make it
355 easy to access resources from tests -->
356 <pathelement path="${module.testresource.dir}" />
357 <path refid="module.testbuild.path" />
358 <path refid="module.build.path" />
363 <target name="base-test-allclasses" unless="test">
364 <echo>Testing all classes</echo>
365 <antcall target="base-test-impl">
366 <param name="testclassnames" value="**/*Test.class" />
370 <target name="base-test-singleclass" if="test">
371 <echo>Testing testcases that conform to the pattern *${test}*</echo>
372 <antcall target="base-test-impl">
373 <param name="testclassnames" value="**/*${test}*.class" />
377 <target name="base-test">
378 <antcall target="base-test-allclasses" />
379 <antcall target="base-test-singleclass" />
382 <!-- Run junit test -->
385 <antcall target="base-test">
386 <param name="testedclasses" value="${module.classes.dir}" />
390 <!-- reporting target used by other targets. This should not depend on
391 the test target to avoid unnecessary duplicate runs of the tests -->
393 <target name="base-reports" depends="init">
394 <mkdir dir="${module.report.dir}/html" />
395 <mkdir dir="${module.report.dir}/html/unit" />
396 <junitreport todir="${module.report.dir}" tofile="${unitreport}">
397 <fileset dir="${module.report.dir}">
398 <include name="TEST-*.xml" />
400 <report todir="${module.report.dir}/html/unit" />
404 <!-- Run junit tests with HTML reporting -->
406 <target name="junit-reports" depends="test">
407 <antcall target="base-reports" />
408 <antcall target="emma-reports" />
411 <target name="reports">
412 <antcall target="junit-reports">
413 <param name="emma.enabled" value="true"/>
417 <!-- Instrument classes using emma -->
419 <target name="emma" depends="init_directory_properties">
420 <emma enabled="${emma.enabled}">
421 <instr instrpath="${module.classes.dir}" mode="overwrite"/>
425 <target name="emma-reports" depends="init_directory_properties" if="emma.enabled">
426 <mkdir dir="${module.emmareport.dir}"/>
427 <emma enabled="${emma.enabled}" >
428 <report sourcepath="${module.source.dir}">
429 <!-- collect all EMMA data dumps (metadata and runtime): -->
430 <infileset dir="." includes="*.em, *.ec" />
432 <txt outfile="${module.emmareport.dir}/report.txt"/>
433 <html outfile="${module.emmareport.dir}/index.html"/>
435 <dirset dir="${src}" >
444 <!-- ============================================================================
446 ============================================================================ -->
448 <!-- Runs a main program found in the test source tree.
450 - my.test.program: class name of the program to run
451 - my.args: arguments to be passed to the program -->
452 <target name="runTestProgram" depends="testclasses">
453 <java classname="${my.test.program}">
454 <arg line="${my.args}"/>
456 <path refid="xmlschemas.path" />
457 <path refid="junit.path" />
458 <pathelement path="${module.testclasses.dir}" />
459 <pathelement path="${testedclasses}" />
460 <pathelement path="${testlibrary}" />
461 <pathelement path="${module.classes.dir}" />
462 <pathelement path="${log4j.properties.dir}" /><!-- for log4j.properties -->
463 <!-- the test resource directory is added to the path as well to make it
464 easy to access resources from tests -->
465 <pathelement path="${module.testresource.dir}" />
466 <path refid="module.testbuild.path" />
467 <path refid="module.build.path" />
472 <property name="database.starter"
473 value="org.wamblee.persistence.test.DatabaseStarter"/>
474 <target name="startdb">
475 <echo>After the database has started, you must populate the database in some way.
476 For instance, using the schemaupdate ant target</echo>
477 <antcall target="runTestProgram">
478 <param name="my.test.program" value="${database.starter}"/>
479 <param name="my.args" value=""/>
483 <property name="schemaupdater"
484 value="org.wamblee.test.HibernateUtils"/>
485 <target name="schemaupdate">
486 <antcall target="runTestProgram">
487 <param name="my.test.program" value="${schemaupdater}"/>
488 <param name="my.args" value="${hibernate.filelist}"/>
492 <target name="schemaexport" depends="init">
493 <mkdir dir="${module.sql.dir}" />
494 <echo>Generating schema in output file ${module.sql.dir}/hibernate.sql</echo>
495 <antcall target="runTestProgram">
496 <param name="my.test.program" value="${schemaupdater}"/>
497 <param name="my.args" value="-export ${module.sql.dir}/hibernate.sql ${hibernate.filelist}"/>
501 <!-- INCLUDED MARKER -->
502 <property name="build_trailer_included" value="true" />