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