Be lenient about html markup in comments - there's a few errors in them
[potlatch2.git] / build.xml
1 <project name="Potlatch 2" default="debug">
2
3   <!-- load properties from the environment -->
4   <property environment="env" />
5
6   <!-- load previously defined configuration properties file -->
7   <property file="build.properties" />
8
9   <!-- flexTasks comes with flex, but apparently it's good practice to put in the libs folder -->
10   <taskdef resource="flexTasks.tasks" classpath="${basedir}/lib/flexTasks.jar"/>
11
12   <!-- if you are running git-svn, you need to run "git tag -a 0.4 0ac0de" where 0ac0de corresponds to the commitid of
13       potlatch2 v0.4 . You need to do this for each point release while we're still in SVN.
14       If you don't, then expect "git describe" to fail miserably.
15       Produces a build number of the form 0.4-1-g9692243 which means 1 commit later than 0.4, latest commit was 9692243 -->
16   <available file=".git" type="dir" property="git.present"/>
17   <target name="git-buildnumber" description="Store output from git-describe in ${buildnumber}" if="git.present">
18     <exec outputproperty="build_number" executable="git" dir="${basedir}">
19       <arg value="describe" />
20     </exec>
21   </target>
22
23   <!-- if you are running svn ("I pity the fool", etc) then svnversion will give the svn revision number, and the
24        build number will be of the form 24041 -->
25   <available file=".svn" type="dir" property="svn.present"/>
26   <target name="svn-buildnumber" description="Store output from svnversion in ${buildnumber}" if="svn.present">
27     <exec outputproperty="build_number" executable="svnversion" dir="${basedir}" />
28   </target>
29
30   <!-- delete and create the DEPLOY dir again -->
31   <target name="init" depends="git-buildnumber,svn-buildnumber,deployLocales">
32     <echo>Build Number ${build_number}</echo>
33     <copy file="version.as.template" tofile="version.as" overwrite="true" />
34     <replace file="version.as" token="@@@buildnumber@@@" value="${build_number}" />
35   </target>
36
37   <!-- Build and output potlatch2.swf in debug mode -->
38   <target name="debug" depends="init">
39     <mxmlc file="potlatch2.mxml">
40       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
41       <load-config filename="debug-config.xml"/>
42       <source-path path-element="${FLEX_HOME}/frameworks"/>
43       <compiler.debug>true</compiler.debug>
44     </mxmlc>
45   </target>
46
47   <!-- Build and output potlatch2.swf in release mode -->
48   <target name="release" depends="init"> <!-- FIXME convention is dist not release -->
49     <mxmlc file="potlatch2.mxml">
50       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
51       <source-path path-element="${FLEX_HOME}/frameworks"/>
52       <compiler.debug>false</compiler.debug>
53     </mxmlc>
54   </target>
55
56   <target name="halcyon">
57     <mxmlc file="halcyon_viewer.as" />
58   </target>
59
60   <!-- note that there's an asdoc target in Flex 4, if/when we move to that -->
61   <target name="docs" depends="manifests">
62     <exec executable="${ASDOC}" failonerror="true">
63       <arg line="-source-path ."/>
64       <arg line="-doc-sources net/systemeD/"/>
65       <arg line="-external-library-path=lib/"/>
66       <arg line="-external-library-path=${FLEX_HOME}/frameworks/libs/"/>
67       <arg line="-external-library-path=${FLEX_HOME}/frameworks/libs/player/10.2/"/>
68       <arg line="-lenient"/>
69       <arg line="-target-player 10.2.0"/>
70       <arg line="-exclude-classes ${org_classes} ${it_classes} ${hxasm_classes} ${com_classes}"/>
71       <arg line="-output resources/docs/"/>
72       <arg line="-window-title 'Halcyon and Potlatch2 Developer documentation'" />
73       <arg line="-main-title 'Halcyon and Potlatch2 Developer documentation'" />
74       <arg line="-footer 'Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
75       <arg line="-package net.systemeD.controls 'Custom-built controls used in Potlatch2'" />
76       <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
77       <arg line="-package net.systemeD.halcyon.connection 'The connection to the main OSM server, and the entities'" />
78       <arg line="-package net.systemeD.halcyon.connection.actions 'The undoable actions that apply to OSM data'" />
79       <arg line="-package net.systemeD.halcyon.styleparser 'The logic for parsing MapCSS stylesheets'" />
80       <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
81       <arg line="-package net.systemeD.potlatch2.collections 'Singletons for handling collections loaded from config files'" />
82       <arg line="-package net.systemeD.potlatch2.controller 'The various controller states that p2 can be in'" />
83       <arg line="-package net.systemeD.potlatch2.find 'The search dialog for jumping to another place'" />
84       <arg line="-package net.systemeD.potlatch2.help 'The Help dialog'" />
85       <arg line="-package net.systemeD.potlatch2.mapfeatures 'The engine behind the mapfeatures parsing'" />
86       <arg line="-package net.systemeD.potlatch2.mapfeatures.editors 'The various widgets used in the Simple panel'" />
87       <arg line="-package net.systemeD.potlatch2.mygpx 'The dialog for loading GPX files from the server'" />
88       <arg line="-package net.systemeD.potlatch2.options 'The options dialog'" />
89       <arg line="-package net.systemeD.potlatch2.panels 'The panels for the left-hand pane of p2'" />
90       <arg line="-package net.systemeD.potlatch2.save 'The save dialog and SaveManager'" />
91       <arg line="-package net.systemeD.potlatch2.tools 'Data manipulation tools'" />
92       <arg line="-package net.systemeD.potlatch2.utils 'Data loading utilities'" />
93       
94       <arg line="-left-frameset-width 300" />
95     </exec>
96   </target>
97
98   <target name="manifests">
99         <!-- Adapted from http://dreamingwell.com/articles/archives/2009/12/excluding-direc.php -->
100         <!-- Generating documentation for a class generates all the dependant documentation too. We
101              don't want to do this for certain projects like org.vanrijkom etc (.swc files are
102              automatically ignored). Unfortunately asdoc only has options for excluding particular
103              classes, and there's lots of them - so this stuff autogenerates the class lists that
104              we want to ignore. -->
105
106         <fileset id="com_sources" dir="${basedir}/com/" />
107         <!-- convert the names of excluded classes to packages with class names -->
108         <pathconvert property="com_classes" pathsep=" " refid="com_sources">
109                 <chainedmapper>
110                         <globmapper from="${basedir}/*" to="*"/>
111                         <mapper type="package" from="*.as" to="*"/>
112                 </chainedmapper>
113         </pathconvert>
114
115         <!-- Get the list of all files in the org directory -->
116         <fileset id="org_sources" dir="${basedir}/org/" />
117         <!-- convert the names of excluded classes to packages with class names -->
118         <pathconvert property="org_classes" pathsep=" " refid="org_sources">
119                 <chainedmapper>
120                         <globmapper from="${basedir}/*" to="*"/>
121                         <mapper type="package" from="*.as" to="*"/>
122                 </chainedmapper>
123         </pathconvert>
124
125         <fileset id="it_sources" dir="${basedir}/it/" />
126         <!-- convert the names of excluded classes to packages with class names -->
127         <pathconvert property="it_classes" pathsep=" " refid="it_sources">
128                 <chainedmapper>
129                         <globmapper from="${basedir}/*" to="*"/>
130                         <mapper type="package" from="*.as" to="*"/>
131                 </chainedmapper>
132         </pathconvert>
133
134         <fileset id="hxasm_sources" dir="${basedir}/hxasm/" />
135         <!-- convert the names of excluded classes to packages with class names -->
136         <pathconvert property="hxasm_classes" pathsep=" " refid="hxasm_sources">
137                 <chainedmapper>
138                         <globmapper from="${basedir}/*" to="*"/>
139                         <mapper type="package" from="*.as" to="*"/>
140                 </chainedmapper>
141         </pathconvert>
142
143         <!-- if we end up with third-party stuff in the net/ folder, then do something like this -->
144         <!-- <fileset id="net_sources" dir="${basedir}/net/">
145                <exclude name="**net.systemeD**"/>
146         </fileset> -->
147
148         <!-- echo the exlcusions for debugging purposes -->
149         <!--<echo message="manifests = ${org_classes} ${it_classes} ${hxasm_classes}"/>-->
150   </target>
151
152   <!-- ======================================= -->
153   <!-- Unit Test Targets -->
154   <!-- ======================================= -->
155  
156   <target name="compileTestRunner" depends="init" description="Compiles the test runner application.">
157    
158     <!-- Compile TestRunner MXML as a SWF -->
159     <mxmlc file="${test.src.dir}/${test.application.name}.mxml"
160       output="${test.bin.dir}/${test.application.name}.swf">
161      
162       <!--<load-config filename="${FLEX_HOME}/frameworks/air-config.xml" />-->
163
164       <!-- we need to supply source paths for the real source and the test source. But passing
165           the potlatch2 top-level directory causes a problem since that also contains the test source.
166           We could move every source folder (net, org, it and hxasm) into a src/ folder, or alternatively
167           set up a fake root folder in the test folder with symlinks to the four directories concerned.
168           It's a bodge, but it works. -->
169       <source-path path-element="${test.fakeroot.dir}" />
170       <source-path path-element="${test.src.dir}" />
171        
172       <!-- The TestRunner needs the flexunit libraries in the build/libs folder -->
173       <library-path dir="${LIBS_DIR}" append="true">
174          <include name="*.swc" />
175       </library-path>
176
177        
178       <!-- Sets java.awt.headless=true so font compilation works in headless environments -->
179       <compiler.headless-server>true</compiler.headless-server>
180       <target-player>10.0.0</target-player>
181      </mxmlc>
182      
183      <echo message="The ${test.application.name}.swf test runner has been created in ${test.bin.dir}" />
184   </target>
185    
186   <target name="runTestsAndReport" depends="init" description="Launches the test runner, captures results, generates test report artifacts.">
187
188       <mkdir dir="${report.dir}" />
189       <mkdir dir="${report.html.dir}" />
190   
191      <!-- Run FlexUnit Ant Task to execute the unit tests and capture reporting data -->
192      <!-- on linux, make sure that gflashplayer is in your PATH and launches a standalone flashplayer binary -->
193      <taskdef resource="flexUnitTasks.tasks" classpath="${LIBS_DIR}/flexUnitTasks-4.1.0_RC2-28.jar" />
194      <flexunit swf="${test.bin.dir}/${test.application.name}.swf" toDir="${report.dir}"
195        haltonfailure="false" verbose="false" localTrusted="true" player="flash" />
196        
197       <!-- Generate html JUnit-style reports based on test results -->
198       <junitreport todir="${report.dir}">
199         <fileset dir="${report.dir}">
200           <include name="TEST-*.xml" />
201         </fileset>
202         <report format="frames" todir="${report.html.dir}" />
203       </junitreport>
204          
205          <echo message="The unit test reports have been created in ${report.dir}" />
206   </target>
207
208   <target name="test" depends="init, compileTestRunner, runTestsAndReport" description="Compiles unit tests and generates test report artifacts." />
209
210   <!-- ======================================= -->
211   <!-- Locale Targets -->
212   <!-- ======================================= -->
213
214   <!-- Deploy compiled Localization Resource Bundles and resources. -->
215   <macrodef name="deployLocale" description="Deploying the compiled swfs">
216     <attribute name="locale" default="en_GB"/>
217     <sequential>
218       <echo>Copying @{locale}.swf to deploy directory...</echo>
219
220       <mkdir dir="${basedir}/resources/locales"/>
221       <copy file="${basedir}/l10n/locale/bundles/@{locale}.swf" tofile="${basedir}/resources/locales/@{locale}.swf" />
222
223     </sequential>
224   </macrodef>
225
226   <!-- Compiles Localization Resource Bundle. -->
227   <macrodef name="compileLocale" description="Compiles the Resource package for the given locale">
228     <attribute name="locale" default="en_GB"/>
229     <sequential>
230
231       <!--
232       Invoke MXMLC
233       - also include the MX Framework locale assets
234       Note: this requires user to invoke copyLocale.exe prior to running this script
235       -->
236       <mxmlc output="${basedir}/l10n/locale/bundles/@{locale}.swf">
237 <!--         <locale>@{locale}</locale> -->
238
239
240         <source-path path-element="${basedir}/l10n/locale/@{locale}"/>
241         <include-resource-bundles>help_dialog</include-resource-bundles>
242         <include-resource-bundles>p2_main</include-resource-bundles>
243
244 <!--        <source-path path-element="${src.dir}/locale/framework/bundles/{locale}/src"/>
245         <include-resource-bundles>collections</include-resource-bundles>
246         <include-resource-bundles>containers</include-resource-bundles>
247         <include-resource-bundles>controls</include-resource-bundles>
248         <include-resource-bundles>core</include-resource-bundles>
249         <include-resource-bundles>effects</include-resource-bundles>
250         <include-resource-bundles>formatters</include-resource-bundles>
251         <include-resource-bundles>logging</include-resource-bundles>
252         <include-resource-bundles>SharedResources</include-resource-bundles>
253         <include-resource-bundles>skins</include-resource-bundles>
254         <include-resource-bundles>states</include-resource-bundles>
255         <include-resource-bundles>styles</include-resource-bundles>
256         <include-resource-bundles>utils</include-resource-bundles>
257         <include-resource-bundles>validators</include-resource-bundles>-->
258       </mxmlc>
259
260     </sequential>
261   </macrodef>
262
263   <target name="buildLocales">
264     <echo>Building Localization .swf's</echo>
265     <compileLocale locale="en_US" />
266     <compileLocale locale="en_GB" />
267     <compileLocale locale="fr_FR" />
268     <compileLocale locale="de_DE" />
269     <compileLocale locale="pl_PL" />
270   </target>
271
272
273   <target name="deployLocales" depends="buildLocales">
274     <echo>Deploying the compiled swf and assets package for the given locales</echo>
275     <deployLocale locale="en_US" />
276     <deployLocale locale="en_GB" />
277     <deployLocale locale="fr_FR" />
278     <deployLocale locale="de_DE" />
279     <deployLocale locale="pl_PL" />
280   </target>
281
282
283   <target name="clean"
284     description="clean up" >
285     <!-- Delete the ${build} and ${dist} directory trees -->
286     <!--
287
288     FIXME what is supposed to be cleaned?
289
290     <delete dir="${build}"/>
291     <delete dir="${dist}"/>
292
293     -->
294   </target>
295
296
297 </project>