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

Last change on this file was 35463, checked in by simon04, 4 days ago

see #josm16860, see #josm19087 - resolve test libraries using Ivy

File size: 37.5 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" xmlns:if="ant:if" xmlns:unless="ant:unless" xmlns:ivy="antlib:org.apache.ivy.ant">
14
15    <property name="josm"                   location="../../core/dist/josm-custom.jar"/>
16    <property name="josm.ivy"               location="../../core/ivy.xml"/>
17    <property name="josm.ivysettings"       location="../../core/ivysettings.xml"/>
18    <property name="josm.test.build.dir"    location="../../core/test/build"/>
19    <property name="jmockit.jar"            location="../00_core_test_lib/jmockit.jar"/>
20    <property name="error_prone_core.jar"   location="../00_core_tools/error_prone_core.jar"/>
21    <property name="error_prone_javac.jar"  location="../00_core_tools/error_prone_javac.jar"/>
22    <property name="auto-value-annotations.jar" location="../00_core_tools/auto-value-annotations.jar"/>
23    <property name="dataflow.jar"           location="../00_core_tools/dataflow-shaded.jar"/>
24    <property name="javacutil.jar"          location="../00_core_tools/javacutil.jar"/>
25    <property name="failureaccess.jar"      location="../00_core_tools/failureaccess.jar"/>
26    <property name="checkstyle-build.dir"   location="../00_core_tools/checkstyle/build"/>
27    <property name="jformatstring.jar"      location="../00_core_tools/spotbugs/jFormatString-3.0.0.jar"/>
28    <property name="annotations.jar"        location="../00_core_tools/spotbugs/spotbugs-annotations.jar"/>
29    <property name="core.tools.ivy"         location="../00_core_tools/ivy.xml"/>
30    <property name="plugin.tools.dir"       location="../00_tools"/>
31    <property name="plugin.build.dir"       location="build"/>
32    <property name="plugin.test.dir"        location="test"/>
33    <property name="plugin.src.dir"         location="src"/>
34    <property name="plugin.resources.dir"   location="resources"/>
35    <property name="plugin.doc.dir"         location="javadoc"/>
36    <property name="plugin.lib.dir"         location="lib"/>
37    <!-- this is the directory where the plugin jar is copied to -->
38    <property name="plugin.dist.dir"        location="../../dist"/>
39    <property name="java.lang.version"      value="1.8" />
40    <property name="javadoc.executable"     value="javadoc" />
41    <property name="javadoc.link"           value="https://docs.oracle.com/javase/8/docs/api" />
42    <property name="manifest"               value="MANIFEST"/>
43    <property name="manifest.unixoid"       value="MANIFEST-unixoid"/>
44    <property name="manifest.windows"       value="MANIFEST-windows"/>
45    <property name="manifest.osx"           value="MANIFEST-osx"/>
46    <property name="plugin.jar"             location="${plugin.dist.dir}/${ant.project.name}.jar"/>
47    <property name="plugin.unixoid.jar"     location="${plugin.dist.dir}/${ant.project.name}-unixoid.jar"/>
48    <property name="plugin.windows.jar"     location="${plugin.dist.dir}/${ant.project.name}-windows.jar"/>
49    <property name="plugin.osx.jar"         location="${plugin.dist.dir}/${ant.project.name}-osx.jar"/>
50    <property name="plugin.sources.jar"     location="${plugin.dist.dir}/${ant.project.name}-sources.jar"/>
51    <property name="plugin.javadoc.jar"     location="${plugin.dist.dir}/${ant.project.name}-javadoc.jar"/>
52    <property name="ivy.home"               location="${user.home}/.ant"/>
53    <property name="ivy.jar.dir"            location="${ivy.home}/lib"/>
54    <property name="ivy.jar.file"           location="${ivy.jar.dir}/ivy.jar"/>
55    <property name="ivy.version"            value="2.5.0"/>
56
57    <!-- For platform-specific stuff -->
58    <condition property="isWindows"><os family="Windows"/></condition>
59    <condition property="isUnix"><os family="Unix"/></condition>
60    <condition property="isMac"><os family="Mac"/></condition>
61    <!-- For Java specific stuff by version -->
62    <condition property="isJava9"><matches string="${ant.java.version}" pattern="(1.)?(9|1[0-9])" /></condition>
63    <condition property="isJava10"><matches string="${ant.java.version}" pattern="1[0-9]" /></condition>
64    <condition property="isJava11"><matches string="${ant.java.version}" pattern="1[1-9]" /></condition>
65    <condition property="isJava12"><matches string="${ant.java.version}" pattern="1[2-9]" /></condition>
66    <condition property="isJava13"><matches string="${ant.java.version}" pattern="1[3-9]" /></condition>
67    <condition property="isJava16"><matches string="${ant.java.version}" pattern="1[6-9]" /></condition>
68    <!-- Disable jacoco on Java 16+, see https://github.com/jacoco/jacoco/pull/992 -->
69    <condition property="coverageByDefault">
70        <not>
71            <isset property="isJava16"/>
72        </not>
73    </condition>
74    <target name="-jaxb_windows" if="isWindows">
75        <property name="xjc" value="${plugin.tools.dir}${file.separator}jaxb-ri${file.separator}bin${file.separator}xjc.bat" />
76    </target>
77    <target name="-jaxb_linux" unless="isWindows">
78        <property name="xjc" value="${plugin.tools.dir}${file.separator}jaxb-ri${file.separator}bin${file.separator}xjc.sh" />
79    </target>
80
81    <!-- To be overriden in plugin build file before inclusion if other plugins are required -->
82    <fileset id="plugin.requires.jars" dir="${plugin.dist.dir}" includes="nothing"/>
83
84    <fileset id="jaxb.jars" dir="${plugin.tools.dir}/jaxb-ri/lib" includes="**/*.jar"/>
85
86    <path id="jdk8.boot.classpath">
87        <pathelement location="${error_prone_javac.jar}"/>
88        <fileset refid="jaxb.jars"/>
89    </path>
90    <path id="plugin.classpath">
91        <pathelement location="${josm}"/>
92        <fileset dir="${plugin.lib.dir}" erroronmissingdir="no">
93            <include name="**/*.jar"/>
94            <exclude name="**/*-sources.jar"/>
95            <exclude name="**/*-javadoc.jar"/>
96            <exclude name="**/*-unixoid.jar" unless="isUnix"/>
97            <exclude name="**/*-windows.jar" unless="isWindows"/>
98            <exclude name="**/*-osx.jar" unless="isMac"/>
99        </fileset>
100        <fileset refid="plugin.requires.jars"/>
101        <fileset refid="jaxb.jars"/>
102    </path>
103    <path id="processor.path">
104        <pathelement location="${error_prone_core.jar}"/>
105        <pathelement location="${dataflow.jar}"/>
106        <pathelement location="${javacutil.jar}"/>
107        <pathelement location="${failureaccess.jar}"/>
108        <pathelement location="${jformatstring.jar}"/>
109        <pathelement location="${auto-value-annotations.jar}"/>
110    </path>
111
112    <!--
113    **********************************************************
114    ** init - initializes the build
115    **********************************************************
116    -->
117    <target name="init">
118        <mkdir dir="${plugin.build.dir}"/>
119    </target>
120    <!--
121    **********************************************************
122    ** compile - compiles the source tree
123    **********************************************************
124    -->
125    <target name="pre-compile">
126        <!-- to be overridden by plugins that need to perform additional tasks before compiling -->
127    </target>
128    <target name="compile" depends="init, pre-compile" unless="skip-compile">
129        <echo message="compiling sources for ${plugin.jar} ..."/>
130        <javac srcdir="${plugin.src.dir}" debug="true" destdir="${plugin.build.dir}" includeantruntime="false"
131            encoding="UTF-8" target="${java.lang.version}" source="${java.lang.version}" fork="yes">
132            <compilerarg value="-J-Xbootclasspath/p:${toString:jdk8.boot.classpath}" unless:set="isJava9"/>
133            <compilerarg line="-XDcompilePolicy=simple"/>
134            <compilerarg value="-processorpath"/>
135            <compilerarg pathref="processor.path"/>
136            <compilerarg value="-Xlint:deprecation"/>
137            <compilerarg value="-Xlint:unchecked"/>
138            <compilerarg value="-Xplugin:ErrorProne -Xep:StringSplitter:OFF -Xep:ReferenceEquality:OFF -Xep:InsecureCryptoUsage:OFF -Xep:FutureReturnValueIgnored:OFF -Xep:JdkObsolete:OFF -Xep:EqualsHashCode:OFF"/>
139            <compilerarg line="-Xmaxwarns 1000"/>
140            <classpath refid="plugin.classpath"/>
141        </javac>
142    </target>
143    <!--
144    **********************************************************
145    ** setup-dist - copies files for distribution
146    **********************************************************
147    -->
148    <target name="setup-dist-default">
149        <copy todir="${plugin.build.dir}/resources" failonerror="no" includeemptydirs="no">
150            <fileset dir="${plugin.resources.dir}"/>
151        </copy>
152        <copy todir="${plugin.build.dir}/images" failonerror="no" includeemptydirs="no">
153            <fileset dir="images"/>
154        </copy>
155        <copy todir="${plugin.build.dir}/data" failonerror="no" includeemptydirs="no">
156            <fileset dir="data"/>
157        </copy>
158        <copy todir="${plugin.build.dir}">
159            <fileset dir=".">
160                <include name="README"/>
161                <include name="LICENSE*"/>
162                <include name="*GPL*"/>
163                <exclude name="*.md"/>
164            </fileset>
165        </copy>
166    </target>
167    <target name="setup-dist">
168        <antcall target="setup-dist-default" />
169    </target>
170    <!--
171    **********************************************************
172    ** dist - creates the plugin jars
173    **********************************************************
174    -->
175    <target name="dist" depends="compile,javadoc,revision" unless="skip-dist">
176        <echo message="creating ${ant.project.name}.jar ... "/>
177        <antcall target="setup-dist" />
178        <delete failonerror="no">
179            <fileset dir="." includes="${manifest}*" />
180        </delete>
181        <manifest file="${manifest}" mode="update">
182            <attribute name="Plugin-Mainversion" value="${plugin.main.version}"/>
183            <attribute name="Plugin-Version" value="${version.entry.commit.revision}"/>
184            <attribute name="Plugin-Class" value="${plugin.class}" />
185            <attribute name="Plugin-Description" value="${plugin.description}" />
186            <attribute name="Plugin-Date" value="${version.entry.commit.date}" />
187            <attribute name="Author" value="${plugin.author}"/>
188        </manifest>
189        <antcall target="add-manifest-attribute">
190            <param name="manifest.attribute" value="Plugin-Link"/>
191            <param name="property.name" value="plugin.link"/>
192            <param name="property.value" value="${plugin.link}"/>
193        </antcall>
194        <antcall target="add-manifest-attribute">
195            <param name="manifest.attribute" value="Plugin-Icon"/>
196            <param name="property.name" value="plugin.icon"/>
197            <param name="property.value" value="${plugin.icon}"/>
198        </antcall>
199        <antcall target="add-manifest-attribute">
200            <param name="manifest.attribute" value="Plugin-Early"/>
201            <param name="property.name" value="plugin.early"/>
202            <param name="property.value" value="${plugin.early}"/>
203        </antcall>
204        <antcall target="add-manifest-attribute">
205            <param name="manifest.attribute" value="Plugin-Provides"/>
206            <param name="property.name" value="plugin.provides"/>
207            <param name="property.value" value="${plugin.provides}"/>
208        </antcall>
209        <antcall target="add-manifest-attribute">
210            <param name="manifest.attribute" value="Plugin-Requires"/>
211            <param name="property.name" value="plugin.requires"/>
212            <param name="property.value" value="${plugin.requires}"/>
213        </antcall>
214        <antcall target="add-manifest-attribute">
215            <param name="manifest.attribute" value="Plugin-Stage"/>
216            <param name="property.name" value="plugin.stage"/>
217            <param name="property.value" value="${plugin.stage}"/>
218        </antcall>
219        <antcall target="add-manifest-attribute">
220            <param name="manifest.attribute" value="Plugin-Canloadatruntime"/>
221            <param name="property.name" value="plugin.canloadatruntime"/>
222            <param name="property.value" value="${plugin.canloadatruntime}"/>
223        </antcall>
224        <antcall target="add-manifest-attribute">
225            <param name="manifest.attribute" value="Plugin-Minimum-Java-Version"/>
226            <param name="property.name" value="plugin.minimum.java.version"/>
227            <param name="property.value" value="${plugin.minimum.java.version}"/>
228        </antcall>
229        <antcall target="additional-manifest" />
230        <antcall target="build-jar" />
231        <jar destfile="${plugin.sources.jar}" basedir="${plugin.src.dir}" level="9"/>
232        <jar destfile="${plugin.javadoc.jar}" basedir="${plugin.doc.dir}" level="9"/>
233        <delete failonerror="no">
234            <fileset dir="." includes="${manifest}*" />
235        </delete>
236        <antcall target="post-dist" />
237    </target>
238    <target name="build-jar">
239        <jar destfile="${plugin.jar}" basedir="${plugin.build.dir}" manifest="${manifest}" manifestencoding="UTF-8" duplicate="preserve" level="9">
240            <restrict>
241                <not><or>
242                    <name name="META-INF/maven/*"/>
243                    <name name="META-INF/DEPENDENCIES"/>
244                    <name name="META-INF/LICENSE"/>
245                    <name name="META-INF/NOTICE"/>
246                    <name name="META-INF/*.RSA"/>
247                    <name name="META-INF/*.SF"/>
248                    <name name="module-info.class"/>
249                </or></not>
250                <archives>
251                    <zips>
252                        <fileset dir="${plugin.lib.dir}" includes="*.jar" excludes="*-sources.jar, *-javadoc.jar" erroronmissingdir="no"/>
253                    </zips>
254                </archives>
255            </restrict>
256        </jar>
257    </target>
258    <target name="post-dist">
259        <!-- to be overridden by plugins that need to perform additional tasks on resulting jar -->
260    </target>
261    <target name="add-manifest-attribute" depends="check-manifest-attribute" if="have-${property.name}">
262        <manifest file="${manifest}" mode="update">
263            <attribute name="${manifest.attribute}" value="${property.value}" />
264        </manifest>
265    </target>
266    <!-- target to add additional entries, empty in commons -->
267    <target name="additional-manifest">
268    </target>
269    <target name="check-manifest-attribute">
270        <condition property="have-${property.name}">
271            <and>
272                <isset property="${property.name}"/>
273                <not>
274                    <equals arg1="${property.value}" arg2=""/>
275                </not>
276                <not>
277                    <equals arg1="${property.value}" arg2="..."/>
278                </not>
279            </and>
280        </condition>
281    </target>
282    <target name="pre-javadoc">
283        <!-- to be overridden by plugins that need to perform additional tasks before generating javadoc -->
284    </target>
285    <target name="javadoc" depends="pre-javadoc" unless="skip-javadoc">
286        <javadoc destdir="${plugin.doc.dir}"
287                executable="${javadoc.executable}"
288                encoding="UTF-8"
289                windowtitle="JOSM-${ant.project.name}"
290                use="true"
291                private="true"
292                linksource="true"
293                author="false">
294            <classpath refid="plugin.classpath"/>
295            <sourcepath>
296                <pathelement path="${plugin.src.dir}" />
297                <pathelement path="gen" />
298                <pathelement path="includes" />
299            </sourcepath>
300            <link href="${javadoc.link}"/>
301            <link href="https://josm.openstreetmap.de/doc"/>
302            <doctitle><![CDATA[<h2>JOSM-${ant.project.name} - Javadoc</h2>]]></doctitle>
303            <bottom><![CDATA[<a href="https://josm.openstreetmap.de/wiki/Plugins">JOSM Plugins</a>]]></bottom>
304            <arg line="-tag license:X" />
305            <arg value="-html5" if:set="isJava9" />
306            <arg value="--add-modules" if:set="isJava9" unless:set="isJava11" />
307            <arg value="java.activation,java.se.ee" if:set="isJava9" unless:set="isJava11" />
308            <arg value="--add-exports" if:set="isJava9" unless:set="noJavaFX" />
309            <arg value="javafx.graphics/com.sun.javafx.application=ALL-UNNAMED" if:set="isJava9" unless:set="noJavaFX" />
310        </javadoc>
311    </target>
312    <!--
313    **********************************************************
314    ** revision - extracts the current revision number for the
315    **    file build.number and stores it in the XML property
316    **    version.*
317    **********************************************************
318    -->
319    <!--
320      ** Initializes the REVISION.XML file from SVN information
321    -->
322    <target name="init-svn-revision-xml" unless="skip-revision">
323        <exec append="false" output="REVISION.XML" executable="svn" failifexecutionfails="false" resultproperty="svn.info.result">
324            <env key="LANG" value="C"/>
325            <arg value="info"/>
326            <arg value="--xml"/>
327            <arg value="."/>
328        </exec>
329        <condition property="svn.info.fail">
330            <not>
331                <and>
332                    <equals arg1="${svn.info.result}" arg2="0" />
333                    <length file="REVISION.XML" when="greater" length="1" />
334                </and>
335            </not>
336        </condition>
337    </target>
338    <!--
339      ** Initializes the REVISION.XML file from git-svn information.
340         Obtains the revision from the git-svn-id field.
341    -->
342    <target name="init-git-svn-revision-xml" if="svn.info.fail" unless="skip-revision">
343        <exec append="false" output="REVISION.XML" executable="git" failifexecutionfails="false" resultproperty="git.svn.info.result">
344            <arg value="log"/>
345            <arg value="-1"/>
346            <arg value="--grep=git-svn-id"/>
347            <!--
348            %B:  raw body (unwrapped subject and body)
349            %n:  new line
350            %ai: author date, ISO 8601 format
351            -->
352            <arg value="--pretty=format:%B%n%ai"/>
353            <arg value="."/>
354        </exec>
355        <replaceregexp file="REVISION.XML" flags="s"
356                       match=".*git-svn-id: [^@]*@([0-9]+).*(\d{4}-\d{2}-\d{2}.\d{2}\:\d{2}\:\d{2}\s*[+-]\d{2}:?\d{2})\s*$"
357                       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;"/>
358       <condition property="git.svn.fail">
359           <not>
360               <and>
361                   <equals arg1="${git.svn.info.result}" arg2="0" />
362                   <length file="REVISION.XML" when="greater" length="1" />
363               </and>
364           </not>
365       </condition>
366    </target>
367    <!--
368      ** Initializes the REVISION.XML file from git (w/o svn) information.
369         Uses Unix date as revision number.
370    -->
371    <target name="init-git-revision-xml" if="git.svn.fail" unless="skip-revision">
372        <exec append="false" output="REVISION.XML" executable="git" failifexecutionfails="false" resultproperty="git.info.result">
373            <arg value="log"/>
374            <arg value="-1"/>
375            <arg value="--pretty=format:%at%n%ai"/>
376            <arg value="."/>
377        </exec>
378        <replaceregexp file="REVISION.XML" flags="s"
379                       match="\s*(\d*)\s+(\d{4}-\d{2}-\d{2}.\d{2}\:\d{2}\:\d{2}\s*[+-]\d{2}:?\d{2})\s*$"
380                       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;"/>
381       <condition property="git.fail">
382           <not>
383               <and>
384                   <equals arg1="${git.info.result}" arg2="0" />
385                   <length file="REVISION.XML" when="greater" length="1" />
386               </and>
387           </not>
388       </condition>
389    </target>
390    <target name="init-revision-fallback" if="git.fail" unless="skip-revision">
391        <tstamp>
392            <format property="current.time" pattern="yyyy-MM-dd'T'HH:mm:ss.SSS" />
393        </tstamp>
394        <echo file="REVISION.XML"><![CDATA[<info><entry><commit revision="UNKNOWN"><date>${current.time}</date></commit></entry></info>]]></echo>
395    </target>
396    <target name="revision" depends="init-svn-revision-xml, init-git-svn-revision-xml, init-git-revision-xml, init-revision-fallback" unless="skip-revision">
397      <xmlproperty file="REVISION.XML" prefix="version" keepRoot="false" collapseAttributes="true"/>
398      <delete file="REVISION.XML"/>
399    </target>
400    <!--
401    **********************************************************
402    ** clean - clean up the build environment
403    **********************************************************
404    -->
405    <target name="clean">
406        <delete dir="${plugin.build.dir}"/>
407        <delete dir="${plugin.doc.dir}"/>
408        <delete dir="${checkstyle-build.dir}"/>
409        <delete file="${plugin.jar}"/>
410        <delete file="${plugin.sources.jar}"/>
411        <delete file="${plugin.javadoc.jar}"/>
412    </target>
413    <!--
414    **********************************************************
415    ** install - install the plugin in your local JOSM installation
416    **********************************************************
417    -->
418    <target name="install" depends="dist">
419        <property environment="env"/>
420        <condition property="josm.plugins.dir" value="${env.APPDATA}/JOSM/plugins">
421            <and>
422                <os family="windows"/>
423            </and>
424        </condition>
425        <condition property="josm.plugins.dir" value="${user.home}/Library/JOSM/plugins">
426            <and>
427                <os family="mac"/>
428            </and>
429        </condition>
430        <condition property="josm.plugins.dir" value="${user.home}/.josm/plugins">
431            <and>
432                <not><os family="windows"/></not>
433                <not><os family="mac"/></not>
434            </and>
435        </condition>
436        <copy file="${plugin.jar}" todir="${josm.plugins.dir}"/>
437    </target>
438    <!--
439    ************************** Publishing the plugin ***********************************
440    -->
441    <!--
442    ** extracts the JOSM release for the JOSM version in ../core and saves it in the
443    ** property ${coreversion.info.entry.revision}
444    **
445    -->
446    <target name="core-info">
447        <exec append="false" output="core.info.xml" executable="svn" failifexecutionfails="false">
448            <env key="LANG" value="C"/>
449            <arg value="info"/>
450            <arg value="--xml"/>
451            <arg value="../../core"/>
452        </exec>
453        <xmlproperty file="core.info.xml" prefix="coreversion" keepRoot="true" collapseAttributes="true"/>
454        <echo>Building against core revision ${coreversion.info.entry.revision}.</echo>
455        <echo>Plugin-Mainversion is set to ${plugin.main.version}.</echo>
456        <delete file="core.info.xml"/>
457    </target>
458    <!--
459    ** commits the source tree for this plugin
460    -->
461    <target name="commit-current">
462        <echo>Commiting the plugin source with message '${commit.message}' ...</echo>
463        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
464            <env key="LANG" value="C"/>
465            <arg value="commit"/>
466            <arg value="-m"/>
467            <arg value="${commit.message}"/>
468            <arg value="."/>
469        </exec>
470    </target>
471    <!--
472    ** updates (svn up) the source tree for this plugin
473    -->
474    <target name="update-current">
475        <echo>Updating plugin source ...</echo>
476        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
477            <env key="LANG" value="C"/>
478            <arg value="up"/>
479            <arg value="."/>
480        </exec>
481        <echo>Updating ${plugin.jar} ...</echo>
482        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
483            <env key="LANG" value="C"/>
484            <arg value="up"/>
485            <arg value="${plugin.jar}"/>
486        </exec>
487    </target>
488    <!--
489    ** commits the plugin.jar
490    -->
491    <target name="commit-dist">
492        <echo>
493    ***** Properties of published ${plugin.jar} *****
494    Commit message    : '${commit.message}'
495    Plugin-Mainversion: ${plugin.main.version}
496    JOSM build version: ${coreversion.info.entry.revision}
497    Plugin-Version    : ${version.entry.commit.revision}
498    ***** / Properties of published ${plugin.jar} *****
499
500    Now committing ${plugin.jar} ...
501    </echo>
502        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
503            <env key="LANG" value="C"/>
504            <arg value="-m"/>
505            <arg value="${commit.message}"/>
506            <arg value="commit"/>
507            <arg value="${plugin.jar}"/>
508        </exec>
509    </target>
510    <!-- ** make sure svn is present as a command line tool ** -->
511    <target name="ensure-svn-present">
512        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false" failonerror="false" resultproperty="svn.exit.code">
513            <env key="LANG" value="C"/>
514            <arg value="--version"/>
515        </exec>
516        <fail message="Fatal: command 'svn --version' failed. Please make sure svn is installed on your system.">
517            <!-- return code not set at all? Most likely svn isn't installed -->
518            <condition>
519                <not>
520                    <isset property="svn.exit.code"/>
521                </not>
522            </condition>
523        </fail>
524        <fail message="Fatal: command 'svn --version' failed. Please make sure a working copy of svn is installed on your system.">
525            <!-- error code from SVN? Most likely svn is not what we are looking on this system -->
526            <condition>
527                <isfailure code="${svn.exit.code}"/>
528            </condition>
529        </fail>
530    </target>
531
532    <target name="publish" depends="ensure-svn-present,core-info,commit-current,update-current,clean,dist,commit-dist">
533    </target>
534
535    <macrodef name="init-test-preferences">
536        <sequential>
537            <copy file="../00_core_test_config/preferences.template.xml" tofile="../00_core_test_config/unit-josm.home/preferences.xml"/>
538            <replace file="../00_core_test_config/unit-josm.home/preferences.xml" encoding="UTF-8" token="@OSM_USERNAME@" value="${osm.username}"/>
539            <replace file="../00_core_test_config/unit-josm.home/preferences.xml" encoding="UTF-8" token="@OSM_PASSWORD@" value="${osm.password}"/>
540        </sequential>
541    </macrodef>
542    <target name="check-test">
543        <available file="${plugin.test.dir}" type="dir" property="test.present"/>
544    </target>
545    <target name="test-init" depends="check-test" if="test.present" unless="skip-test">
546        <mkdir dir="${plugin.test.dir}/build"/>
547        <mkdir dir="${plugin.test.dir}/build/unit"/>
548        <mkdir dir="${plugin.test.dir}/report"/>
549        <init-test-preferences/>
550        <ivy:settings file="${josm.ivysettings}" id="ivy.core.settings"/>
551        <ivy:resolve settingsRef="ivy.core.settings" file="${josm.ivy}" conf="test,jacocoant"/>
552        <ivy:retrieve settingsRef="ivy.core.settings" pattern="../00_core_test_lib/[artifact].[ext]" conf="test"/>
553        <ivy:retrieve settingsRef="ivy.core.settings" pattern="../00_core_tools/[conf].[ext]" conf="jacocoant"/>
554        <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml" classpath="../00_core_tools/jacocoant.jar"/>
555        <path id="test.classpath">
556            <!-- JMockit must be included before JUnit in the classpath -->
557            <pathelement path="${jmockit.jar}"/>
558            <fileset dir="../00_core_test_lib">
559                <include name="**/*.jar"/>
560                <exclude name="**/jmockit*.jar"/>
561            </fileset>
562            <fileset dir="${plugin.test.dir}/lib" erroronmissingdir="no">
563                <include name="**/*.jar"/>
564                <exclude name="**/*-sources.jar"/>
565                <exclude name="**/*-javadoc.jar"/>
566            </fileset>
567            <fileset dir="lib" erroronmissingdir="no">
568                <include name="**/*.jar"/>
569                <exclude name="**/*-sources.jar"/>
570                <exclude name="**/*-javadoc.jar"/>
571            </fileset>
572            <pathelement path="${plugin.resources.dir}"/>
573            <pathelement path="${plugin.test.dir}/data"/>
574            <pathelement path="${josm.test.build.dir}/unit"/>
575            <pathelement path="${josm}"/>
576            <pathelement path="${plugin.jar}"/>
577            <pathelement path="${annotations.jar}"/>
578        </path>
579    </target>
580    <target name="test-clean">
581        <delete dir="${plugin.test.dir}/build"/>
582        <delete dir="${plugin.test.dir}/report"/>
583        <delete file="${plugin.test.dir}/jacoco.exec" />
584        <delete file="../00_core_test_config/unit-josm.home/preferences.xml" />
585        <delete dir="../00_core_test_config/unit-josm.home/cache" failonerror="false"/>
586    </target>
587    <target name="test-compile" depends="test-init,dist" if="test.present" unless="skip-test">
588        <sequential>
589            <javac debug="on" includeantruntime="false" srcdir="${plugin.test.dir}/unit" destdir="${plugin.test.dir}/build/unit" encoding="UTF-8"
590                target="${java.lang.version}" source="${java.lang.version}">
591                <classpath>
592                    <fileset refid="plugin.requires.jars"/>
593                    <path refid="test.classpath"/>
594                </classpath>
595                <compilerarg value="-Xlint:all"/>
596                <compilerarg value="-Xlint:-serial"/>
597            </javac>
598        </sequential>
599    </target>
600    <target name="test" depends="dist, test-clean, test-compile" if="test.present" unless="skip-test"
601        description="Run unit tests. OSM API (TEST) account shall be set with -Dosm.username and -Dosm.password">
602        <sequential>
603            <echo message="Running unit tests with JUnit"/>
604            <jacoco:coverage destfile="${plugin.test.dir}/jacoco.exec" enabled="${coverageByDefault}">
605                <junit printsummary="yes" fork="true" forkmode="once" dir="${basedir}">
606                    <jvmarg value="-Dfile.encoding=UTF-8"/>
607                    <jvmarg value="-javaagent:${jmockit.jar}"/>
608                    <jvmarg value="--add-modules" if:set="isJava9" unless:set="isJava11" />
609                    <jvmarg value="java.activation,java.se.ee" if:set="isJava9" unless:set="isJava11" />
610                    <jvmarg value="--add-opens" if:set="isJava9" />
611                    <jvmarg value="java.base/java.lang.reflect=ALL-UNNAMED" if:set="isJava9" />
612                    <jvmarg value="--add-opens" if:set="isJava9" />
613                    <jvmarg value="java.desktop/javax.imageio.spi=ALL-UNNAMED" if:set="isJava9" />
614                    <jvmarg value="--add-exports" if:set="isJava9" />
615                    <jvmarg value="java.desktop/com.sun.imageio.spi=ALL-UNNAMED" if:set="isJava9" />
616                    <sysproperty key="josm.home" value="../00_core_test_config/unit-josm.home"/>
617                    <sysproperty key="josm.test.data" value="${plugin.test.dir}/data"/>
618                    <sysproperty key="java.awt.headless" value="true"/>
619                    <sysproperty key="suppressPermanentFailure" value="${suppressPermanentFailure}"/>
620                    <classpath>
621                        <fileset refid="plugin.requires.jars"/>
622                        <path refid="test.classpath"/>
623                        <pathelement path="${plugin.test.dir}/build/unit"/>
624                    </classpath>
625                    <formatter type="plain"/>
626                    <formatter type="xml"/>
627                    <batchtest fork="yes" todir="${plugin.test.dir}/report">
628                        <fileset dir="${plugin.test.dir}/build/unit" includes="**/*Test.class"/>
629                    </batchtest>
630                </junit>
631            </jacoco:coverage>
632        </sequential>
633    </target>
634
635    <target name="checkstyle-compile" depends="resolve-tools">
636        <mkdir dir="${checkstyle-build.dir}"/>
637        <javac sourcepath="" srcdir="../00_core_tools/checkstyle/src" failonerror="true"
638            destdir="${checkstyle-build.dir}" target="${java.lang.version}" source="${java.lang.version}" debug="on"
639            includeantruntime="false" createMissingPackageInfoClass="false"
640            encoding="UTF-8" classpathref="checkstyle.classpath">
641        </javac>
642    </target>
643    <target name="checkstyle" depends="checkstyle-compile">
644        <taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties">
645            <classpath refid="checkstyle.classpath"/>
646            <classpath path="${checkstyle-build.dir}"/>
647        </taskdef>
648        <checkstyle config="${basedir}/../checkstyle-config.xml">
649            <fileset dir="${basedir}/src" includes="**/*.java" excludes="boofcv/**/*.java,
650                                                                         com/google/**/*.java,
651                                                                         crosby/**/*.java,
652                                                                         edu/princeton/**/*.java,
653                                                                         net/boplicity/**/*.java,
654                                                                         org/apache/**/*.java,
655                                                                         org/dinopolis/**/*.java,
656                                                                         org/kaintoch/**/*.java,
657                                                                         org/marvinproject/**/*.java,
658                                                                         org/netbeans/**/*.java,
659                                                                         org/openstreetmap/josm/plugins/dataimport/io/tcx/**/*.java,
660                                                                         org/openstreetmap/josm/plugins/ohe/parser/**/*.java,
661                                                                         org/openstreetmap/josm/plugins/pdfimport/pdfbox/operators/**/*.java
662                                                                         org/openstreetmap/josm/plugins/roadsigns/javacc/**/*.java,
663                                                                         org/osgeo/**/*.java,
664                                                                         "/>
665            <fileset dir="${basedir}/test" includes="**/*.java" erroronmissingdir="false"/>
666            <formatter type="xml" toFile="checkstyle-josm-${ant.project.name}.xml"/>
667        </checkstyle>
668    </target>
669
670    <target name="spotbugs" depends="compile,resolve-tools">
671        <taskdef name="spotbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" classpath="${toString:spotbugs.classpath}"/>
672        <spotbugs output="xml"
673                outputFile="spotbugs-josm-${ant.project.name}.xml"
674                classpath="${toString:spotbugs.classpath}"
675                pluginList=""
676                excludeFilter="../spotbugs-filter.xml"
677                effort="less"
678                reportLevel="low"
679                nested="false"
680                jvmargs="-Xmx1024m"
681                >
682            <auxClasspath refid="plugin.classpath" />
683            <sourcePath path="${basedir}/src" />
684            <class location="${plugin.build.dir}" />
685        </spotbugs>
686    </target>
687
688    <target name="runjosm" depends="install">
689        <java jar="${josm}" fork="true"/>
690    </target>
691
692    <target name="profilejosm" depends="install">
693        <nbprofiledirect>
694        </nbprofiledirect>
695        <java jar="${josm}" fork="true">
696            <jvmarg value="${profiler.info.jvmargs.agent}"/>
697        </java>
698    </target>
699    <!--
700    ** shows a help text
701    -->
702    <target name="help">
703        <echo>
704    You can use following targets:
705    * dist        This default target builds the plugin jar file
706    * clean       Cleanup automatically created files
707    * test        Run unit tests (if any)
708    * publish     Checkin source code, build jar and checkin plugin jar
709                  (requires proper entry for SVN commit message!)
710    * install     Install the plugin in current system
711    * runjosm     Install plugin and start josm
712    * profilejosm Install plugin and start josm in profiling mode
713
714    There are other targets, which usually should not be called manually.
715        </echo>
716    </target>
717    <!--
718    ** Ivy tasks
719    -->
720    <target name="download-ivy">
721        <mkdir dir="${ivy.jar.dir}"/>
722        <get src="https://josm.openstreetmap.de/nexus/content/repositories/public/org/apache/ivy/ivy/${ivy.version}/ivy-${ivy.version}.jar"
723             dest="${ivy.jar.file}"
724             usetimestamp="true"/>
725    </target>
726    <target name="init-ivy" depends="download-ivy">
727        <path id="ivy.lib.path">
728            <fileset dir="${ivy.jar.dir}" includes="*.jar"/>
729        </path>
730        <taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path"/>
731    </target>
732    <target name="resolve-tools" depends="init-ivy" description="Resolves tools using Apache Ivy">
733        <ivy:resolve file="${core.tools.ivy}"/>
734        <ivy:cachepath file="${core.tools.ivy}" pathid="checkstyle.classpath" conf="checkstyle"/>
735        <ivy:cachepath file="${core.tools.ivy}" pathid="spotbugs.classpath" conf="spotbugs"/>
736    </target>
737    <target name="clean_ivy">
738        <delete failonerror="false">
739            <fileset dir="${plugin.lib.dir}">
740                <include name="**/*.jar"/>
741                <exclude name="**/*-custom.jar" />
742            </fileset>
743        </delete>
744    </target>
745    <target name="fetch_dependencies" depends="clean_ivy, init-ivy">
746        <echo>fetching dependencies with ivy</echo>
747        <ivy:settings file="ivy_settings.xml" />
748        <ivy:resolve />
749        <ivy:retrieve pattern="${plugin.lib.dir}/[artifact]-[revision](-[classifier]).[ext]" conf="default" />
750    </target>
751</project>
Note: See TracBrowser for help on using the repository browser.