source: subversion/applications/editors/josm/plugins/build-common.xml @ 32175

Last change on this file since 32175 was 32175, checked in by donvip, 3 years ago

don't include signature files of signed libraries

File size: 22.6 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!--
3** Template for the build targets common to all plugins
4** ====================================================
5**
6** To override a property, add it to the plugin build.xml _before_
7** this template has been imported.
8** To override a target, add it _after_ this template has been imported.
9**
10** Paths are relative to the build.xml that imports this template.
11**
12-->
13<project name="plugin_common" basedir="." xmlns:jacoco="antlib:org.jacoco.ant">
14
15    <property name="josm"                   location="../../core/dist/josm-custom.jar"/>
16    <property name="josm.test.build.dir"    location="../../core/test/build"/>
17    <property name="groovy.jar"             location="../00_core_tools/groovy-all-2.4.6.jar"/>
18    <property name="plugin.build.dir"       location="build"/>
19    <property name="plugin.test.dir"        location="test"/>
20    <property name="plugin.src.dir"         location="src"/>
21    <property name="plugin.lib.dir"         location="lib"/>
22    <!-- this is the directory where the plugin jar is copied to -->
23    <property name="plugin.dist.dir"        location="../../dist"/>
24    <property name="ant.build.javac.target" value="1.7"/>
25    <property name="ant.build.javac.source" value="1.7"/>
26    <property name="plugin.jar"             location="${plugin.dist.dir}/${ant.project.name}.jar"/>
27
28    <!-- For Windows-specific stuff -->
29    <condition property="isWindows">
30        <os family="Windows"/>
31    </condition>
32    <target name="-jaxb_win" if="isWindows">
33        <property name="xjc" value="${java.home}\..\bin\xjc.exe" />
34    </target>
35    <target name="-jaxb_nix" unless="isWindows">
36        <property name="xjc" value="${java.home}/../bin/xjc" />
37    </target>
38
39    <!-- To be overriden in plugin build file before inclusion if other plugins are required -->
40    <fileset id="plugin.requires.jars" dir="${plugin.dist.dir}" includes="nothing"/>
41
42    <!--
43    **********************************************************
44    ** init - initializes the build
45    **********************************************************
46    -->
47    <target name="init">
48        <mkdir dir="${plugin.build.dir}"/>
49    </target>
50    <!--
51    **********************************************************
52    ** compile - compiles the source tree
53    **********************************************************
54    -->
55    <target name="compile" depends="init">
56        <echo message="compiling sources for ${plugin.jar} ..."/>
57        <javac srcdir="src" debug="true" destdir="${plugin.build.dir}" includeantruntime="false" encoding="UTF-8">
58            <compilerarg value="-Xlint:deprecation"/>
59            <compilerarg value="-Xlint:unchecked"/>
60            <classpath>
61                <pathelement location="${josm}"/>
62                <fileset dir="${plugin.lib.dir}" erroronmissingdir="no">
63                    <include name="**/*.jar"/>
64                    <exclude name="**/*-sources.jar"/>
65                    <exclude name="**/*-javadoc.jar"/>
66                </fileset>
67                <fileset refid="plugin.requires.jars"/>
68            </classpath>
69        </javac>
70    </target>
71    <!--
72    **********************************************************
73    ** setup-dist - copies files for distribution
74    **********************************************************
75    -->
76    <target name="setup-dist-default">
77        <copy todir="${plugin.build.dir}/resources" failonerror="no" includeemptydirs="no">
78            <fileset dir="resources"/>
79        </copy>
80        <copy todir="${plugin.build.dir}/images" failonerror="no" includeemptydirs="no">
81            <fileset dir="images"/>
82        </copy>
83        <copy todir="${plugin.build.dir}/data" failonerror="no" includeemptydirs="no">
84            <fileset dir="data"/>
85        </copy>
86        <copy todir="${plugin.build.dir}">
87            <fileset dir=".">
88                <include name="README"/>
89                <include name="LICENSE*"/>
90                <include name="*GPL*"/>
91            </fileset>
92        </copy>
93    </target>
94    <target name="setup-dist">
95        <antcall target="setup-dist-default" />
96    </target>
97    <!--
98    **********************************************************
99    ** dist - creates the plugin jar
100    **********************************************************
101    -->
102    <target name="dist" depends="compile,revision">
103        <echo message="creating ${ant.project.name}.jar ... "/>
104        <antcall target="setup-dist" />
105        <delete file="MANIFEST" failonerror="no"/>
106        <manifest file="MANIFEST" mode="update">
107            <attribute name="Plugin-Mainversion" value="${plugin.main.version}"/>
108            <attribute name="Plugin-Version" value="${version.entry.commit.revision}"/>
109            <attribute name="Plugin-Class" value="${plugin.class}" />
110            <attribute name="Plugin-Description" value="${plugin.description}" />
111            <attribute name="Plugin-Date" value="${version.entry.commit.date}" />
112            <attribute name="Author" value="${plugin.author}"/>
113        </manifest>
114        <antcall target="add-manifest-attribute">
115            <param name="manifest.attribute" value="Plugin-Link"/>
116            <param name="property.name" value="plugin.link"/>
117            <param name="property.value" value="${plugin.link}"/>
118        </antcall>
119        <antcall target="add-manifest-attribute">
120            <param name="manifest.attribute" value="Plugin-Icon"/>
121            <param name="property.name" value="plugin.icon"/>
122            <param name="property.value" value="${plugin.icon}"/>
123        </antcall>
124        <antcall target="add-manifest-attribute">
125            <param name="manifest.attribute" value="Plugin-Early"/>
126            <param name="property.name" value="plugin.early"/>
127            <param name="property.value" value="${plugin.early}"/>
128        </antcall>
129        <antcall target="add-manifest-attribute">
130            <param name="manifest.attribute" value="Plugin-Requires"/>
131            <param name="property.name" value="plugin.requires"/>
132            <param name="property.value" value="${plugin.requires}"/>
133        </antcall>
134        <antcall target="add-manifest-attribute">
135            <param name="manifest.attribute" value="Plugin-Stage"/>
136            <param name="property.name" value="plugin.stage"/>
137            <param name="property.value" value="${plugin.stage}"/>
138        </antcall>
139        <antcall target="add-manifest-attribute">
140            <param name="manifest.attribute" value="Plugin-Canloadatruntime"/>
141            <param name="property.name" value="plugin.canloadatruntime"/>
142            <param name="property.value" value="${plugin.canloadatruntime}"/>
143        </antcall>
144        <antcall target="additional-manifest" />
145        <jar destfile="${plugin.jar}" basedir="${plugin.build.dir}" manifest="MANIFEST" manifestencoding="UTF-8">
146            <restrict>
147                <not><or>
148                    <name name="META-INF/maven/*"/>
149                    <name name="META-INF/DEPENDENCIES"/>
150                    <name name="META-INF/LICENSE"/>
151                    <name name="META-INF/NOTICE"/>
152                    <name name="META-INF/*.RSA"/>
153                    <name name="META-INF/*.SF"/>
154                </or></not>
155                <archives>
156                    <zips>
157                        <fileset dir="${plugin.lib.dir}" includes="*.jar" excludes="*-sources.jar, *-javadoc.jar" erroronmissingdir="no"/>
158                    </zips>
159                </archives>
160            </restrict>
161        </jar>
162        <delete file="MANIFEST" failonerror="no"/>
163        <antcall target="post-dist" />
164    </target>
165    <target name="post-dist">
166        <!-- to be overidden by plugins that need to perform additional tasks on resulting jar -->
167    </target>
168    <target name="add-manifest-attribute" depends="check-manifest-attribute" if="have-${property.name}">
169        <manifest file="MANIFEST" mode="update">
170            <attribute name="${manifest.attribute}" value="${property.value}" />
171        </manifest>
172    </target>
173    <!-- target to add additional entries, empty in commons -->
174    <target name="additional-manifest">
175    </target>
176    <target name="check-manifest-attribute">
177        <condition property="have-${property.name}">
178            <and>
179                <isset property="${property.name}"/>
180                <not>
181                    <equals arg1="${property.value}" arg2=""/>
182                </not>
183                <not>
184                    <equals arg1="${property.value}" arg2="..."/>
185                </not>
186            </and>
187        </condition>
188    </target>
189    <!--
190    **********************************************************
191    ** revision - extracts the current revision number for the
192    **    file build.number and stores it in the XML property
193    **    version.*
194    **********************************************************
195    -->
196    <!--
197      ** Initializes the REVISION.XML file from SVN information
198    -->
199    <target name="init-svn-revision-xml">
200        <exec append="false" output="REVISION.XML" executable="svn" failifexecutionfails="false" resultproperty="svn.info.result">
201            <env key="LANG" value="C"/>
202            <arg value="info"/>
203            <arg value="--xml"/>
204            <arg value="."/>
205        </exec>
206        <condition property="svn.info.success">
207            <equals arg1="${svn.info.result}" arg2="0" />
208        </condition>
209    </target>
210    <!--
211      ** Initializes the REVISION.XML file from git-svn information.
212         Obtains the revision from the git-svn-id field.
213    -->
214    <target name="init-git-svn-revision-xml" unless="svn.info.success">
215        <exec append="false" output="REVISION.XML" executable="git" failifexecutionfails="false" resultproperty="git.svn.info.result">
216            <arg value="log"/>
217            <arg value="-1"/>
218            <arg value="--grep=git-svn-id"/>
219            <!--
220            %B:  raw body (unwrapped subject and body)
221            %n:  new line
222            %ai: author date, ISO 8601 format
223            -->
224            <arg value="--pretty=format:%B%n%ai"/>
225            <arg value="."/>
226        </exec>
227        <replaceregexp file="REVISION.XML" flags="s"
228                       match=".*git-svn-id: [^@]*@([0-9]+).*(\d{4}-\d{2}-\d{2}.\d{2}\:\d{2}\:\d{2}\s*[+-]\d{2}:?\d{2})\s*$"
229                       replace="&lt;info&gt;&lt;entry&gt;&lt;commit revision=&quot;\1&quot;&gt;&lt;date&gt;\2&lt;/date&gt;&lt;/commit&gt;&lt;/entry&gt;&lt;/info&gt;"/>
230       <condition property="git.svn.fail">
231           <not>
232               <and>
233                   <equals arg1="${git.svn.info.result}" arg2="0" />
234                   <length file="REVISION.XML" when="greater" length="1" />
235               </and>
236           </not>
237       </condition>
238    </target>
239    <!--
240      ** Initializes the REVISION.XML file from git (w/o svn) information.
241         Uses Unix date as revision number.
242    -->
243    <target name="init-git-revision-xml" if="git.svn.fail">
244        <exec append="false" output="REVISION.XML" executable="git" failifexecutionfails="false" resultproperty="git.info.result">
245            <arg value="log"/>
246            <arg value="-1"/>
247            <arg value="--pretty=format:%at%n%ai"/>
248            <arg value="."/>
249        </exec>
250        <replaceregexp file="REVISION.XML" flags="s"
251                       match="\s*(\d*)\s+(\d{4}-\d{2}-\d{2}.\d{2}\:\d{2}\:\d{2}\s*[+-]\d{2}:?\d{2})\s*$"
252                       replace="&lt;info&gt;&lt;entry&gt;&lt;commit revision=&quot;\1&quot;&gt;&lt;date&gt;\2&lt;/date&gt;&lt;/commit&gt;&lt;/entry&gt;&lt;/info&gt;"/>
253       <condition property="git.fail">
254           <not>
255               <and>
256                   <equals arg1="${git.info.result}" arg2="0" />
257                   <length file="REVISION.XML" when="greater" length="1" />
258               </and>
259           </not>
260       </condition>
261    </target>
262    <target name="init-revision-fallback" if="git.fail">
263        <tstamp>
264            <format property="current.time" pattern="yyyy-MM-dd'T'HH:mm:ss.SSS" />
265        </tstamp>
266        <echo file="REVISION.XML"><![CDATA[<info><entry><commit revision="UNKNOWN"><date>${current.time}</date></commit></entry></info>]]></echo>
267    </target>
268    <target name="revision" depends="init-svn-revision-xml, init-git-svn-revision-xml, init-git-revision-xml, init-revision-fallback">
269      <xmlproperty file="REVISION.XML" prefix="version" keepRoot="false" collapseAttributes="true"/>
270      <delete file="REVISION.XML"/>
271    </target>
272    <!--
273    **********************************************************
274    ** clean - clean up the build environment
275    **********************************************************
276    -->
277    <target name="clean">
278        <delete dir="${plugin.build.dir}"/>
279        <delete file="${plugin.jar}"/>
280    </target>
281    <!--
282    **********************************************************
283    ** install - install the plugin in your local JOSM installation
284    **********************************************************
285    -->
286    <target name="install" depends="dist">
287        <property environment="env"/>
288        <condition property="josm.plugins.dir" value="${env.APPDATA}/JOSM/plugins">
289            <and>
290                <os family="windows"/>
291            </and>
292        </condition>
293        <condition property="josm.plugins.dir" value="${user.home}/Library/JOSM/plugins">
294            <and>
295                <os family="mac"/>
296            </and>
297        </condition>
298        <condition property="josm.plugins.dir" value="${user.home}/.josm/plugins">
299            <and>
300                <not><os family="windows"/></not>
301                <not><os family="mac"/></not>
302            </and>
303        </condition>
304        <copy file="${plugin.jar}" todir="${josm.plugins.dir}"/>
305    </target>
306    <!--
307    ************************** Publishing the plugin ***********************************
308    -->
309    <!--
310    ** extracts the JOSM release for the JOSM version in ../core and saves it in the
311    ** property ${coreversion.info.entry.revision}
312    **
313    -->
314    <target name="core-info">
315        <exec append="false" output="core.info.xml" executable="svn" failifexecutionfails="false">
316            <env key="LANG" value="C"/>
317            <arg value="info"/>
318            <arg value="--xml"/>
319            <arg value="../../core"/>
320        </exec>
321        <xmlproperty file="core.info.xml" prefix="coreversion" keepRoot="true" collapseAttributes="true"/>
322        <echo>Building against core revision ${coreversion.info.entry.revision}.</echo>
323        <echo>Plugin-Mainversion is set to ${plugin.main.version}.</echo>
324        <delete file="core.info.xml"/>
325    </target>
326    <!--
327    ** commits the source tree for this plugin
328    -->
329    <target name="commit-current">
330        <echo>Commiting the plugin source with message '${commit.message}' ...</echo>
331        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
332            <env key="LANG" value="C"/>
333            <arg value="commit"/>
334            <arg value="-m"/>
335            <arg value="${commit.message}"/>
336            <arg value="."/>
337        </exec>
338    </target>
339    <!--
340    ** updates (svn up) the source tree for this plugin
341    -->
342    <target name="update-current">
343        <echo>Updating plugin source ...</echo>
344        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
345            <env key="LANG" value="C"/>
346            <arg value="up"/>
347            <arg value="."/>
348        </exec>
349        <echo>Updating ${plugin.jar} ...</echo>
350        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
351            <env key="LANG" value="C"/>
352            <arg value="up"/>
353            <arg value="../dist/${plugin.jar}"/>
354        </exec>
355    </target>
356    <!--
357    ** commits the plugin.jar
358    -->
359    <target name="commit-dist">
360        <echo>
361    ***** Properties of published ${plugin.jar} *****
362    Commit message    : '${commit.message}'
363    Plugin-Mainversion: ${plugin.main.version}
364    JOSM build version: ${coreversion.info.entry.revision}
365    Plugin-Version    : ${version.entry.commit.revision}
366    ***** / Properties of published ${plugin.jar} *****
367
368    Now commiting ${plugin.jar} ...
369    </echo>
370        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
371            <env key="LANG" value="C"/>
372            <arg value="-m"/>
373            <arg value="${commit.message}"/>
374            <arg value="commit"/>
375            <arg value="${plugin.jar}"/>
376        </exec>
377    </target>
378    <!-- ** make sure svn is present as a command line tool ** -->
379    <target name="ensure-svn-present">
380        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false" failonerror="false" resultproperty="svn.exit.code">
381            <env key="LANG" value="C"/>
382            <arg value="--version"/>
383        </exec>
384        <fail message="Fatal: command 'svn --version' failed. Please make sure svn is installed on your system.">
385            <!-- return code not set at all? Most likely svn isn't installed -->
386            <condition>
387                <not>
388                    <isset property="svn.exit.code"/>
389                </not>
390            </condition>
391        </fail>
392        <fail message="Fatal: command 'svn --version' failed. Please make sure a working copy of svn is installed on your system.">
393            <!-- error code from SVN? Most likely svn is not what we are looking on this system -->
394            <condition>
395                <isfailure code="${svn.exit.code}"/>
396            </condition>
397        </fail>
398    </target>
399
400    <target name="publish" depends="ensure-svn-present,core-info,commit-current,update-current,clean,dist,commit-dist">
401    </target>
402
403    <path id="test.classpath">
404        <fileset dir="../00_core_test_lib">
405            <include name="**/*.jar"/>
406        </fileset>
407        <fileset dir="${plugin.test.dir}/lib" erroronmissingdir="no">
408            <include name="**/*.jar"/>
409            <exclude name="**/*-sources.jar"/>
410            <exclude name="**/*-javadoc.jar"/>
411        </fileset>
412        <fileset dir="lib" erroronmissingdir="no">
413            <include name="**/*.jar"/>
414            <exclude name="**/*-sources.jar"/>
415            <exclude name="**/*-javadoc.jar"/>
416        </fileset>
417        <pathelement path="${plugin.test.dir}/data"/>
418        <pathelement path="${josm.test.build.dir}/unit"/>
419        <pathelement path="${josm}"/>
420        <pathelement path="${plugin.jar}"/>
421        <pathelement path="${groovy.jar}"/>
422    </path>
423    <macrodef name="init-test-preferences">
424        <sequential>
425            <copy file="${plugin.test.dir}/config/preferences.template.xml" tofile="${plugin.test.dir}/config/unit-josm.home/preferences.xml"/>
426            <replace file="${plugin.test.dir}/config/unit-josm.home/preferences.xml" encoding="UTF-8" token="@OSM_USERNAME@" value="${osm.username}"/>
427            <replace file="${plugin.test.dir}/config/unit-josm.home/preferences.xml" encoding="UTF-8" token="@OSM_PASSWORD@" value="${osm.password}"/>
428        </sequential>
429    </macrodef>
430    <target name="test-init">
431        <mkdir dir="${plugin.test.dir}/build"/>
432        <mkdir dir="${plugin.test.dir}/build/unit"/>
433        <mkdir dir="${plugin.test.dir}/report"/>
434        <init-test-preferences/>
435    </target>
436    <target name="test-clean">
437        <delete dir="${plugin.test.dir}/build"/>
438        <delete dir="${plugin.test.dir}/report"/>
439        <delete file="${plugin.test.dir}/jacoco.exec" />
440        <delete file="${plugin.test.dir}/config/unit-josm.home/preferences.xml" />
441        <delete dir="${plugin.test.dir}/config/unit-josm.home/cache" failonerror="false"/>
442    </target>
443    <target name="test-compile" depends="test-init,dist">
444        <taskdef name="groovyc" classname="org.codehaus.groovy.ant.Groovyc" classpath="${groovy.jar}"/>
445        <sequential>
446            <groovyc srcdir="${plugin.test.dir}/unit" destdir="${plugin.test.dir}/build/unit" encoding="UTF-8">
447                <classpath>
448                    <fileset refid="plugin.requires.jars"/>
449                    <path refid="test.classpath"/>
450                </classpath>
451                <javac target="1.7" source="1.7" debug="on" encoding="UTF-8">
452                    <compilerarg value="-Xlint:all"/>
453                    <compilerarg value="-Xlint:-serial"/>
454                </javac>
455            </groovyc>
456        </sequential>
457    </target>
458    <target name="test" depends="dist, test-clean, test-compile"
459        description="Run unit tests. OSM API (TEST) account shall be set with -Dosm.username and -Dosm.password">
460        <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml" classpath="../00_core_tools/jacocoant.jar" />
461        <sequential>
462            <echo message="Running unit tests with JUnit"/>
463            <jacoco:coverage destfile="${plugin.test.dir}/jacoco.exec">
464                <junit printsummary="yes" fork="true" forkmode="once" dir="${basedir}">
465                    <jvmarg value="-Dfile.encoding=UTF-8"/>
466                    <sysproperty key="josm.home" value="${plugin.test.dir}/config/unit-josm.home"/>
467                    <sysproperty key="josm.test.data" value="${plugin.test.dir}/data"/>
468                    <sysproperty key="java.awt.headless" value="true"/>
469                    <sysproperty key="suppressPermanentFailure" value="${suppressPermanentFailure}"/>
470                    <classpath>
471                        <fileset refid="plugin.requires.jars"/>
472                        <path refid="test.classpath"/>
473                        <pathelement path="${plugin.test.dir}/build/unit"/>
474                    </classpath>
475                    <formatter type="plain"/>
476                    <formatter type="xml"/>
477                    <batchtest fork="yes" todir="${plugin.test.dir}/report">
478                        <fileset dir="${plugin.test.dir}/build/unit" includes="**/*Test.class"/>
479                    </batchtest>
480                </junit>
481            </jacoco:coverage>
482        </sequential>
483    </target>
484
485    <target name="runjosm" depends="install">
486        <java jar="${josm}" fork="true">
487        </java>
488    </target>
489
490    <target name="profilejosm" depends="install">
491        <nbprofiledirect>
492        </nbprofiledirect>
493        <java jar="${josm}" fork="true">
494            <jvmarg value="${profiler.info.jvmargs.agent}"/>
495        </java>
496    </target>
497    <!--
498    ** shows a help text
499    -->
500    <target name="help">
501        <echo>
502    You can use following targets:
503    * dist        This default target builds the plugin jar file
504    * clean       Cleanup automatical created files
505    * test        Run unit tests (if any)
506    * publish     Checkin source code, build jar and checkin plugin jar
507                  (requires proper entry for SVN commit message!)
508    * install     Install the plugin in current system
509    * runjosm     Install plugin and start josm
510    * profilejosm Install plugin and start josm in profiling mode
511
512    There are other targets, which usually should not be called manually.
513        </echo>
514    </target>
515</project>
Note: See TracBrowser for help on using the repository browser.