source: osm/applications/editors/josm/plugins/build-common.xml@ 35766

Last change on this file since 35766 was 35766, checked in by simon04, 3 years ago

see #16860 - Apache Ivy: fallback to core ivysettings.xml when plugin ivy_settings.xml does not exist
File size: 39.8 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="checkstyle-build.dir" location="../00_core_tools/checkstyle/build"/>
21 <property name="annotations.jar" location="../00_core_tools/spotbugs/spotbugs-annotations.jar"/>
22 <property name="core.tools.ivy" location="../00_core_tools/ivy.xml"/>
23 <property name="plugin.tools.dir" location="../00_tools"/>
24 <property name="plugin.build.dir" location="build"/>
25 <property name="plugin.test.dir" location="test"/>
26 <property name="plugin.src.dir" location="src"/>
27 <property name="plugin.resources.dir" location="resources"/>
28 <property name="plugin.doc.dir" location="javadoc"/>
29 <property name="plugin.lib.dir" location="lib"/>
30 <!-- this is the directory where the plugin jar is copied to -->
31 <property name="plugin.dist.dir" location="../../dist"/>
32 <property name="java.lang.version" value="8" />
33 <property name="javadoc.executable" value="javadoc" />
34 <property name="javadoc.link" value="https://docs.oracle.com/javase/8/docs/api" />
35 <property name="manifest" value="MANIFEST"/>
36 <property name="manifest.unixoid" value="MANIFEST-unixoid"/>
37 <property name="manifest.windows" value="MANIFEST-windows"/>
38 <property name="manifest.osx" value="MANIFEST-osx"/>
39 <property name="plugin.jar" location="${plugin.dist.dir}/${ant.project.name}.jar"/>
40 <property name="plugin.unixoid.jar" location="${plugin.dist.dir}/${ant.project.name}-unixoid.jar"/>
41 <property name="plugin.windows.jar" location="${plugin.dist.dir}/${ant.project.name}-windows.jar"/>
42 <property name="plugin.osx.jar" location="${plugin.dist.dir}/${ant.project.name}-osx.jar"/>
43 <property name="plugin.sources.jar" location="${plugin.dist.dir}/${ant.project.name}-sources.jar"/>
44 <property name="plugin.javadoc.jar" location="${plugin.dist.dir}/${ant.project.name}-javadoc.jar"/>
45 <property name="ivy.home" location="${user.home}/.ant"/>
46 <property name="ivy.jar.dir" location="${ivy.home}/lib"/>
47 <property name="ivy.jar.file" location="${ivy.jar.dir}/ivy.jar"/>
48 <property name="ivy.version" value="2.5.0"/>
49 <property name="jacoco.inclbootstrapclasses" value="false" />
50 <property name="jacoco.inclnolocationclasses" value="false" />
51 <property name="junit.printsummary" value="on" />
52
53 <!-- For platform-specific stuff -->
54 <condition property="isWindows"><os family="Windows"/></condition>
55 <condition property="isUnix"><os family="Unix"/></condition>
56 <condition property="isMac"><os family="Mac"/></condition>
57 <!-- For Java specific stuff by version -->
58 <condition property="isJava9"><matches string="${ant.java.version}" pattern="(1.)?(9|1[0-9])" /></condition>
59 <condition property="isJava10"><matches string="${ant.java.version}" pattern="1[0-9]" /></condition>
60 <condition property="isJava11"><matches string="${ant.java.version}" pattern="1[1-9]" /></condition>
61 <condition property="isJava12"><matches string="${ant.java.version}" pattern="1[2-9]" /></condition>
62 <condition property="isJava13"><matches string="${ant.java.version}" pattern="1[3-9]" /></condition>
63 <condition property="isJava14"><matches string="${ant.java.version}" pattern="1[4-9]" /></condition>
64 <condition property="isJava15"><matches string="${ant.java.version}" pattern="1[5-9]" /></condition>
65 <condition property="isJava16"><matches string="${ant.java.version}" pattern="1[6-9]" /></condition>
66 <condition property="isJava18"><matches string="${ant.java.version}" pattern="1[8-9]" /></condition>
67 <!-- Disable jacoco on Java 18+, see https://github.com/jacoco/jacoco/pull/1132 -->
68 <condition property="coverageByDefault">
69 <not>
70 <isset property="isJava18"/>
71 </not>
72 </condition>
73 <target name="-jaxb_windows" if="isWindows">
74 <property name="xjc" value="${plugin.tools.dir}${file.separator}jaxb-ri${file.separator}bin${file.separator}xjc.bat" />
75 </target>
76 <target name="-jaxb_linux" unless="isWindows">
77 <property name="xjc" value="${plugin.tools.dir}${file.separator}jaxb-ri${file.separator}bin${file.separator}xjc.sh" />
78 </target>
79
80 <!-- To be overriden in plugin build file before inclusion if other plugins are required -->
81 <fileset id="plugin.requires.jars" dir="${plugin.dist.dir}" includes="nothing"/>
82
83 <fileset id="jaxb.jars" dir="${plugin.tools.dir}/jaxb-ri/lib" includes="**/*.jar"/>
84
85 <path id="plugin.classpath">
86 <pathelement location="${josm}"/>
87 <fileset dir="${plugin.lib.dir}" erroronmissingdir="no">
88 <include name="**/*.jar"/>
89 <exclude name="**/*-sources.jar"/>
90 <exclude name="**/*-javadoc.jar"/>
91 <exclude name="**/*-unixoid.jar" unless="isUnix"/>
92 <exclude name="**/*-windows.jar" unless="isWindows"/>
93 <exclude name="**/*-osx.jar" unless="isMac"/>
94 </fileset>
95 <fileset refid="plugin.requires.jars"/>
96 <fileset refid="jaxb.jars"/>
97 </path>
98
99 <!--
100 **********************************************************
101 ** init - initializes the build
102 **********************************************************
103 -->
104 <target name="init">
105 <mkdir dir="${plugin.build.dir}"/>
106 </target>
107 <!--
108 **********************************************************
109 ** compile - compiles the source tree
110 **********************************************************
111 -->
112 <target name="pre-compile">
113 <!-- to be overridden by plugins that need to perform additional tasks before compiling -->
114 </target>
115 <target name="compile" depends="init, pre-compile, resolve-tools" unless="skip-compile">
116 <echo message="compiling sources for ${plugin.jar} ..."/>
117 <path id="jdk8.boot.classpath">
118 <path refid="errorprone_javac.classpath"/>
119 <fileset refid="jaxb.jars"/>
120 </path>
121 <javac srcdir="${plugin.src.dir}" debug="true" destdir="${plugin.build.dir}" includeantruntime="false"
122 encoding="UTF-8" release="${java.lang.version}" fork="yes">
123 <compilerarg value="-J-Xbootclasspath/p:${toString:jdk8.boot.classpath}" unless:set="isJava9"/>
124 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
125 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
126 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
127 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
128 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
129 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
130 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
131 <compilerarg value="-J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
132 <compilerarg value="-J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED" if:set="isJava11" unless:set="noErrorProne"/>
133 <compilerarg line="-XDcompilePolicy=simple"/>
134 <compilerarg value="-processorpath"/>
135 <compilerarg pathref="errorprone.classpath"/>
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 -Xep:JavaUtilDate:OFF -Xep:DoNotCallSuggester:OFF -Xep:BanSerializableRead:OFF -Xep:RestrictedApiChecker: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 release="${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:agent destfile="${plugin.test.dir}/jacoco.exec" enabled="${coverageByDefault}" inclbootstrapclasses="${jacoco.inclbootstrapclasses}" inclnolocationclasses="${jacoco.inclnolocationclasses}" property="jacocoagent"/>
605 <junitlauncher printsummary="${junit.printsummary}">
606 <classpath>
607 <fileset refid="plugin.requires.jars"/>
608 <path refid="test.classpath"/>
609 <pathelement path="${plugin.test.dir}/build/unit"/>
610 </classpath>
611 <testclasses outputDir="${plugin.test.dir}/report">
612 <fileset dir="${plugin.test.dir}/build/unit" includes="**/*Test.class"/>
613 <fork>
614 <jvmarg value="${jacocoagent}" if:set="jacocoagent" />
615 <jvmarg value="-Dfile.encoding=UTF-8"/>
616 <jvmarg value="-javaagent:${jmockit.jar}"/>
617 <jvmarg value="-Djunit.jupiter.extensions.autodetection.enabled=true"/>
618 <jvmarg value="-Djunit.jupiter.execution.parallel.enabled=true"/>
619 <jvmarg value="--add-modules" if:set="isJava9" unless:set="isJava11" />
620 <jvmarg value="java.activation,java.se.ee" if:set="isJava9" unless:set="isJava11" />
621 <jvmarg value="--add-opens" if:set="isJava9" />
622 <jvmarg value="java.base/java.lang.reflect=ALL-UNNAMED" if:set="isJava9" />
623 <jvmarg value="--add-opens" if:set="isJava9" />
624 <jvmarg value="java.desktop/javax.imageio.spi=ALL-UNNAMED" if:set="isJava9" />
625 <jvmarg value="--add-exports" if:set="isJava9" />
626 <jvmarg value="java.desktop/com.sun.imageio.spi=ALL-UNNAMED" if:set="isJava9" />
627 <jvmarg value="-XX:+ShowCodeDetailsInExceptionMessages" if:set="isJava14" unless:set="isJava15" />
628 <sysproperty key="josm.home" value="../00_core_test_config/unit-josm.home"/>
629 <sysproperty key="josm.test.data" value="${plugin.test.dir}/data"/>
630 <sysproperty key="java.awt.headless" value="true"/>
631 <sysproperty key="suppressPermanentFailure" value="${suppressPermanentFailure}"/>
632 <sysproperty key="junit.jupiter.execution.parallel.enabled" value="${junit.jupiter.execution.parallel.enabled}" if:set="junit.jupiter.execution.parallel.enabled"/>
633 <sysproperty key="junit.jupiter.execution.parallel.mode.default" value="${junit.jupiter.execution.parallel.mode.default}" if:set="junit.jupiter.execution.parallel.mode.default"/>
634 <sysproperty key="junit.jupiter.execution.parallel.mode.classes.default" value="${junit.jupiter.execution.parallel.mode.classes.default}" if:set="junit.jupiter.execution.parallel.mode.classes.default"/>
635 </fork>
636 <listener type="legacy-plain" />
637 <listener type="legacy-xml" />
638 </testclasses>
639 </junitlauncher>
640 </sequential>
641 </target>
642
643 <target name="checkstyle-compile" depends="resolve-tools">
644 <mkdir dir="${checkstyle-build.dir}"/>
645 <javac sourcepath="" srcdir="../00_core_tools/checkstyle/src" failonerror="true"
646 destdir="${checkstyle-build.dir}" release="${java.lang.version}" debug="on"
647 includeantruntime="false" createMissingPackageInfoClass="false"
648 encoding="UTF-8" classpathref="checkstyle.classpath">
649 </javac>
650 </target>
651 <target name="checkstyle" depends="checkstyle-compile">
652 <taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties">
653 <classpath refid="checkstyle.classpath"/>
654 <classpath path="${checkstyle-build.dir}"/>
655 </taskdef>
656 <checkstyle config="${basedir}/../checkstyle-config.xml">
657 <fileset dir="${basedir}/src" includes="**/*.java" excludes="boofcv/**/*.java,
658 com/google/**/*.java,
659 crosby/**/*.java,
660 edu/princeton/**/*.java,
661 net/boplicity/**/*.java,
662 org/apache/**/*.java,
663 org/dinopolis/**/*.java,
664 org/kaintoch/**/*.java,
665 org/marvinproject/**/*.java,
666 org/netbeans/**/*.java,
667 org/openstreetmap/josm/plugins/dataimport/io/tcx/**/*.java,
668 org/openstreetmap/josm/plugins/ohe/parser/**/*.java,
669 org/openstreetmap/josm/plugins/pdfimport/pdfbox/operators/**/*.java
670 org/openstreetmap/josm/plugins/roadsigns/javacc/**/*.java,
671 org/osgeo/**/*.java,
672 "/>
673 <fileset dir="${basedir}/test" includes="**/*.java" erroronmissingdir="false"/>
674 <formatter type="xml" toFile="checkstyle-josm-${ant.project.name}.xml"/>
675 </checkstyle>
676 </target>
677
678 <target name="spotbugs" depends="compile,resolve-tools">
679 <taskdef name="spotbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" classpath="${toString:spotbugs.classpath}"/>
680 <spotbugs output="xml"
681 outputFile="spotbugs-josm-${ant.project.name}.xml"
682 classpath="${toString:spotbugs.classpath}"
683 pluginList=""
684 excludeFilter="../spotbugs-filter.xml"
685 effort="less"
686 reportLevel="low"
687 nested="false"
688 jvmargs="-Xmx1024m"
689 >
690 <auxClasspath refid="plugin.classpath" />
691 <sourcePath path="${basedir}/src" />
692 <class location="${plugin.build.dir}" />
693 </spotbugs>
694 </target>
695
696 <target name="runjosm" depends="install">
697 <java jar="${josm}" fork="true"/>
698 </target>
699
700 <target name="profilejosm" depends="install">
701 <nbprofiledirect>
702 </nbprofiledirect>
703 <java jar="${josm}" fork="true">
704 <jvmarg value="${profiler.info.jvmargs.agent}"/>
705 </java>
706 </target>
707 <!--
708 ** shows a help text
709 -->
710 <target name="help">
711 <echo>
712 You can use following targets:
713 * dist This default target builds the plugin jar file
714 * clean Cleanup automatically created files
715 * test Run unit tests (if any)
716 * publish Checkin source code, build jar and checkin plugin jar
717 (requires proper entry for SVN commit message!)
718 * install Install the plugin in current system
719 * runjosm Install plugin and start josm
720 * profilejosm Install plugin and start josm in profiling mode
721
722 There are other targets, which usually should not be called manually.
723 </echo>
724 </target>
725 <!--
726 ** Ivy tasks
727 -->
728 <target name="download-ivy">
729 <mkdir dir="${ivy.jar.dir}"/>
730 <get src="https://josm.openstreetmap.de/nexus/content/repositories/public/org/apache/ivy/ivy/${ivy.version}/ivy-${ivy.version}.jar"
731 dest="${ivy.jar.file}"
732 usetimestamp="true"/>
733 </target>
734 <target name="init-ivy" depends="download-ivy">
735 <path id="ivy.lib.path">
736 <fileset dir="${ivy.jar.dir}" includes="*.jar"/>
737 </path>
738 <taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path"/>
739 </target>
740 <target name="resolve-tools" depends="init-ivy" description="Resolves tools using Apache Ivy">
741 <ivy:resolve file="${core.tools.ivy}"/>
742 <ivy:cachepath file="${core.tools.ivy}" pathid="errorprone.classpath" conf="errorprone"/>
743 <ivy:cachepath file="${core.tools.ivy}" pathid="errorprone_javac.classpath" conf="errorprone_javac"/>
744 <ivy:cachepath file="${core.tools.ivy}" pathid="checkstyle.classpath" conf="checkstyle"/>
745 <ivy:cachepath file="${core.tools.ivy}" pathid="spotbugs.classpath" conf="spotbugs"/>
746 </target>
747 <target name="clean_ivy">
748 <delete failonerror="false">
749 <fileset dir="${plugin.lib.dir}">
750 <include name="**/*.jar"/>
751 <exclude name="**/*-custom.jar" />
752 </fileset>
753 </delete>
754 </target>
755 <target name="fetch_dependencies" depends="clean_ivy, init-ivy">
756 <echo>fetching dependencies with ivy</echo>
757 <available property="plugin.ivysettings.exists" file="ivy_settings.xml"/>
758 <ivy:settings file="ivy_settings.xml" if:set="plugin.ivysettings.exists"/>
759 <ivy:settings file="${josm.ivysettings}" unless:set="plugin.ivysettings.exists"/>
760 <ivy:resolve />
761 <ivy:retrieve pattern="${plugin.lib.dir}/[artifact]-[revision](-[classifier]).[ext]" conf="default" />
762 </target>
763</project>
Note: See TracBrowser for help on using the repository browser.