Merge branch 'master' into history
[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="-target-player 10.0.0"/>
67       <arg line="-exclude-classes ${org_classes} ${it_classes} ${hxasm_classes} ${com_classes}"/>
68       <arg line="-output resources/docs/"/>
69       <arg line="-window-title 'Halcyon and Potlatch2 Developer documentation'" />
70       <arg line="-main-title 'Halcyon and Potlatch2 Developer documentation'" />
71       <arg line="-footer 'Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
72       <arg line="-package net.systemeD.controls 'Custom-built controls used in Poltatch2'" />
73       <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
74       <arg line="-package net.systemeD.halcyon.connection 'The connection to the main OSM server, and the entities'" />
75       <arg line="-package net.systemeD.halcyon.connection.actions 'The undoable actions that apply to OSM data'" />
76       <arg line="-package net.systemeD.halcyon.styleparser 'The logic for parsing MapCSS stylesheets'" />
77       <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
78       <arg line="-package net.systemeD.potlatch2.collections 'Singletons for handling collections loaded from config files'" />
79       <arg line="-package net.systemeD.potlatch2.controller 'The various controller states that p2 can be in'" />
80       <arg line="-package net.systemeD.potlatch2.help 'The Help dialog'" />
81       <arg line="-package net.systemeD.potlatch2.mapfeatures 'The engine behind the mapfeatures parsing'" />
82       <arg line="-package net.systemeD.potlatch2.mapfeatures.editors 'The various widgets used in the Simple panel'" />
83       <arg line="-package net.systemeD.potlatch2.mygpx 'The dialog for loading GPX files from the server'" />
84       <arg line="-package net.systemeD.potlatch2.options 'The options dialog'" />
85       <arg line="-package net.systemeD.potlatch2.panels 'The panels for the left-hand pane of p2'" />
86       <arg line="-package net.systemeD.potlatch2.save 'The save dialog and SaveManager'" />
87       <arg line="-package net.systemeD.potlatch2.tools 'Data manipulation tools'" />
88       <arg line="-package net.systemeD.potlatch2.utils 'Data loading utilities'" />
89       
90       <arg line="-left-frameset-width 300" />
91     </exec>
92   </target>
93
94   <target name="manifests">
95         <!-- Adapted from http://dreamingwell.com/articles/archives/2009/12/excluding-direc.php -->
96         <!-- Generating documentation for a class generates all the dependant documentation too. We
97              don't want to do this for certain projects like org.vanrijkom etc (.swc files are
98              automatically ignored). Unfortunately asdoc only has options for excluding particular
99              classes, and there's lots of them - so this stuff autogenerates the class lists that
100              we want to ignore. -->
101
102         <fileset id="com_sources" dir="${basedir}/com/" />
103         <!-- convert the names of excluded classes to packages with class names -->
104         <pathconvert property="com_classes" pathsep=" " refid="com_sources">
105                 <chainedmapper>
106                         <globmapper from="${basedir}/*" to="*"/>
107                         <mapper type="package" from="*.as" to="*"/>
108                 </chainedmapper>
109         </pathconvert>
110
111         <!-- Get the list of all files in the org directory -->
112         <fileset id="org_sources" dir="${basedir}/org/" />
113         <!-- convert the names of excluded classes to packages with class names -->
114         <pathconvert property="org_classes" pathsep=" " refid="org_sources">
115                 <chainedmapper>
116                         <globmapper from="${basedir}/*" to="*"/>
117                         <mapper type="package" from="*.as" to="*"/>
118                 </chainedmapper>
119         </pathconvert>
120
121         <fileset id="it_sources" dir="${basedir}/it/" />
122         <!-- convert the names of excluded classes to packages with class names -->
123         <pathconvert property="it_classes" pathsep=" " refid="it_sources">
124                 <chainedmapper>
125                         <globmapper from="${basedir}/*" to="*"/>
126                         <mapper type="package" from="*.as" to="*"/>
127                 </chainedmapper>
128         </pathconvert>
129
130         <fileset id="hxasm_sources" dir="${basedir}/hxasm/" />
131         <!-- convert the names of excluded classes to packages with class names -->
132         <pathconvert property="hxasm_classes" pathsep=" " refid="hxasm_sources">
133                 <chainedmapper>
134                         <globmapper from="${basedir}/*" to="*"/>
135                         <mapper type="package" from="*.as" to="*"/>
136                 </chainedmapper>
137         </pathconvert>
138
139         <!-- if we end up with third-party stuff in the net/ folder, then do something like this -->
140         <!-- <fileset id="net_sources" dir="${basedir}/net/">
141                <exclude name="**net.systemeD**"/>
142         </fileset> -->
143
144         <!-- echo the exlcusions for debugging purposes -->
145         <!--<echo message="manifests = ${org_classes} ${it_classes} ${hxasm_classes}"/>-->
146   </target>
147
148   <!-- ======================================= -->
149   <!-- Unit Test Targets -->
150   <!-- ======================================= -->
151  
152   <target name="compileTestRunner" depends="init" description="Compiles the test runner application.">
153    
154     <!-- Compile TestRunner MXML as a SWF -->
155     <mxmlc file="${test.src.dir}/${test.application.name}.mxml"
156       output="${test.bin.dir}/${test.application.name}.swf">
157      
158       <!--<load-config filename="${FLEX_HOME}/frameworks/air-config.xml" />-->
159
160       <!-- we need to supply source paths for the real source and the test source. But passing
161           the potlatch2 top-level directory causes a problem since that also contains the test source.
162           We could move every source folder (net, org, it and hxasm) into a src/ folder, or alternatively
163           set up a fake root folder in the test folder with symlinks to the four directories concerned.
164           It's a bodge, but it works. -->
165       <source-path path-element="${test.fakeroot.dir}" />
166       <source-path path-element="${test.src.dir}" />
167        
168       <!-- The TestRunner needs the flexunit libraries in the build/libs folder -->
169       <library-path dir="${LIBS_DIR}" append="true">
170          <include name="*.swc" />
171       </library-path>
172
173        
174       <!-- Sets java.awt.headless=true so font compilation works in headless environments -->
175       <compiler.headless-server>true</compiler.headless-server>
176       <target-player>10.0.0</target-player>
177      </mxmlc>
178      
179      <echo message="The ${test.application.name}.swf test runner has been created in ${test.bin.dir}" />
180   </target>
181    
182   <target name="runTestsAndReport" depends="init" description="Launches the test runner, captures results, generates test report artifacts.">
183
184       <mkdir dir="${report.dir}" />
185       <mkdir dir="${report.html.dir}" />
186   
187      <!-- Run FlexUnit Ant Task to execute the unit tests and capture reporting data -->
188      <!-- on linux, make sure that gflashplayer is in your PATH and launches a standalone flashplayer binary -->
189      <taskdef resource="flexUnitTasks.tasks" classpath="${LIBS_DIR}/flexUnitTasks-4.1.0_RC2-28.jar" />
190      <flexunit swf="${test.bin.dir}/${test.application.name}.swf" toDir="${report.dir}"
191        haltonfailure="false" verbose="false" localTrusted="true" player="flash" />
192        
193       <!-- Generate html JUnit-style reports based on test results -->
194       <junitreport todir="${report.dir}">
195         <fileset dir="${report.dir}">
196           <include name="TEST-*.xml" />
197         </fileset>
198         <report format="frames" todir="${report.html.dir}" />
199       </junitreport>
200          
201          <echo message="The unit test reports have been created in ${report.dir}" />
202   </target>
203
204   <target name="test" depends="init, compileTestRunner, runTestsAndReport" description="Compiles unit tests and generates test report artifacts." />
205
206   <!-- ======================================= -->
207   <!-- Locale Targets -->
208   <!-- ======================================= -->
209
210   <!-- Deploy compiled Localization Resource Bundles and resources. -->
211   <macrodef name="deployLocale" description="Deploying the compiled swfs">
212     <attribute name="locale" default="en_GB"/>
213     <sequential>
214       <echo>Copying @{locale}.swf to deploy directory...</echo>
215
216       <mkdir dir="${basedir}/resources/locales"/>
217       <copy file="${basedir}/l10n/locale/bundles/@{locale}.swf" tofile="${basedir}/resources/locales/@{locale}.swf" />
218
219     </sequential>
220   </macrodef>
221
222   <!-- Compiles Localization Resource Bundle. -->
223   <macrodef name="compileLocale" description="Compiles the Resource package for the given locale">
224     <attribute name="locale" default="en_GB"/>
225     <sequential>
226
227       <!--
228       Invoke MXMLC
229       - also include the MX Framework locale assets
230       Note: this requires user to invoke copyLocale.exe prior to running this script
231       -->
232       <mxmlc output="${basedir}/l10n/locale/bundles/@{locale}.swf">
233 <!--         <locale>@{locale}</locale> -->
234
235
236         <source-path path-element="${basedir}/l10n/locale/@{locale}"/>
237         <include-resource-bundles>help_dialog</include-resource-bundles>
238         <include-resource-bundles>p2_main</include-resource-bundles>
239
240 <!--        <source-path path-element="${src.dir}/locale/framework/bundles/{locale}/src"/>
241         <include-resource-bundles>collections</include-resource-bundles>
242         <include-resource-bundles>containers</include-resource-bundles>
243         <include-resource-bundles>controls</include-resource-bundles>
244         <include-resource-bundles>core</include-resource-bundles>
245         <include-resource-bundles>effects</include-resource-bundles>
246         <include-resource-bundles>formatters</include-resource-bundles>
247         <include-resource-bundles>logging</include-resource-bundles>
248         <include-resource-bundles>SharedResources</include-resource-bundles>
249         <include-resource-bundles>skins</include-resource-bundles>
250         <include-resource-bundles>states</include-resource-bundles>
251         <include-resource-bundles>styles</include-resource-bundles>
252         <include-resource-bundles>utils</include-resource-bundles>
253         <include-resource-bundles>validators</include-resource-bundles>-->
254       </mxmlc>
255
256     </sequential>
257   </macrodef>
258
259   <target name="buildLocales">
260     <echo>Building Localization .swf's</echo>
261     <compileLocale locale="en_US" />
262     <compileLocale locale="en_GB" />
263     <compileLocale locale="fr_FR" />
264     <compileLocale locale="de_DE" />
265     <compileLocale locale="pl_PL" />
266   </target>
267
268
269   <target name="deployLocales" depends="buildLocales">
270     <echo>Deploying the compiled swf and assets package for the given locales</echo>
271     <deployLocale locale="en_US" />
272     <deployLocale locale="en_GB" />
273     <deployLocale locale="fr_FR" />
274     <deployLocale locale="de_DE" />
275     <deployLocale locale="pl_PL" />
276   </target>
277
278
279   <target name="clean"
280     description="clean up" >
281     <!-- Delete the ${build} and ${dist} directory trees -->
282     <!--
283
284     FIXME what is supposed to be cleaned?
285
286     <delete dir="${build}"/>
287     <delete dir="${dist}"/>
288
289     -->
290   </target>
291
292
293 </project>