blob: 1a53d100bc3260831925e20268b953bb92eeacf9 [file] [log] [blame]
Brian O'Connorb86c9202016-04-05 20:15:04 -07001import random
Brian O'Connor42c38cf2016-04-05 17:05:57 -07002
3DEBUG_ARG='JAVA_TOOL_OPTIONS="-Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=5005,suspend=y"'
Brian O'Connore5817c92016-04-06 15:41:48 -07004FORCE_INSTALL=True
5NONE='NONE'
Brian O'Connor42c38cf2016-04-05 17:05:57 -07006
Brian O'Connore4da59d2016-04-08 00:32:18 -07007SRC = 'src/main/java/**/'
8TEST = 'src/test/java/**/'
Brian O'Connor0f6677d2016-04-06 23:26:51 -07009RESOURCES_ROOT = 'src/main/resources/'
Brian O'Connore4da59d2016-04-08 00:32:18 -070010TEST_RESOURCES_ROOT = 'src/test/resources/'
11
Ray Milkey171b89a2016-07-28 15:22:26 -070012include_defs('//onos.defs')
Brian O'Connore4da59d2016-04-08 00:32:18 -070013
14def _get_name():
15 base_path = get_base_path()
16 return ONOS_ARTIFACT_BASE + base_path.replace('/', '-') #TODO Unix-separator
Brian O'Connor1f165982016-04-06 21:36:09 -070017
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070018def checkstyle(
19 name,
20 srcs = None,
21 jar_target = None,
22 ):
23
Yuta HIGUCHI295ee072017-06-21 15:48:21 -070024 if srcs:
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070025 base = get_base_path()
Brian O'Connorca509302017-11-27 18:40:08 -080026 # module name; base filepath; files (line-separated); empty line (to signify end of stream)
27 files = '%s\n%s\n' % (name, base) + '\n'.join(['%s/%s' % (base, s) for s in srcs]) + '\n\n'
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070028
29 genrule(
30 name = name + '-checkstyle-files',
31 bash = "echo '%s' > $OUT" % files,
32 srcs = srcs,
33 out = 'checkstyle-files.txt',
34 )
35
36 sh_test(
37 name = name + '-checkstyle',
Thomas Vachuska275d2e82016-07-14 17:41:34 -070038 test = '//tools/build/conf:start-buck-daemon',
Yuta HIGUCHI295ee072017-06-21 15:48:21 -070039 deps = [ ':' + name + '-checkstyle-files',
Ray Milkey2d572dd2017-04-14 10:01:24 -070040 '//tools/build/conf:onos-java-header',
41 '//tools/build/conf:onos-build-conf', ],
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070042 args = [
Thomas Vachuska275d2e82016-07-14 17:41:34 -070043 '$(location //tools/build/conf:buck-daemon-jar)',
44 'checkstyle',
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070045 '$(location :' + name + '-checkstyle-files)',
46 '$(location //tools/build/conf:checkstyle-xml)',
47 '$(location //tools/build/conf:suppressions-xml)',
48 ],
Brian O'Connorca509302017-11-27 18:40:08 -080049 #TODO test_rule_timeout_ms seems to be ignored on Linux
Ray Milkey84dafd92017-10-25 16:20:23 -070050 test_rule_timeout_ms = 45000,
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070051 labels = [ 'checkstyle' ],
52 )
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070053
Ray Milkeyc340e282016-06-30 14:45:42 -070054def java_doc(
55 name,
56 title,
57 pkgs,
58 paths,
59 srcs = [],
60 deps = [],
61 visibility = [],
62 do_it_wrong = False,
63 ):
64 if do_it_wrong:
65 sourcepath = paths
66 else:
67 sourcepath = ['$SRCDIR/' + n for n in paths]
Ray Milkey2a749832016-08-02 15:22:20 -070068
69 if len(srcs) != 0:
Ray Milkeyc340e282016-06-30 14:45:42 -070070 cmd = ' '.join([
Ray Milkey2a749832016-08-02 15:22:20 -070071 'while ! test -f .buckconfig; do cd ..; done;',
72 'javadoc',
73 '-tag onos.rsModel:a:"onos model"',
74 '-quiet',
75 '-protected',
76 '-encoding UTF-8',
77 '-charset UTF-8',
78 '-notimestamp',
79 '-windowtitle "' + title + '"',
80 '-link http://docs.oracle.com/javase/8/docs/api',
81 '-subpackages ',
82 ':'.join(pkgs),
83 '-sourcepath ',
84 ':'.join(sourcepath),
85 ' -classpath ',
86 ':'.join(['$(classpath %s)' % n for n in deps]),
87 '-d $TMP',
88 ]) + ';jar cf $OUT -C $TMP .'
89
90 genrule(
91 name = name,
92 cmd = cmd,
93 srcs = srcs,
94 out = name + '.jar',
95 visibility = visibility,
Ray Milkeyc340e282016-06-30 14:45:42 -070096)
97
Brian O'Connor9c2c8232016-11-08 17:13:14 -080098def sonar(
99 name,
100 test = False
101 ):
102
103 cmd = '; '.join([ 'rm -f $OUT',
104 'printf "%(src_base)s = " >> $OUT',
105 '%(srcs)s >> $OUT',
106 'echo "%(binary_base)s = %(classes)s" >> $OUT',
107 'printf "%(lib_base)s = " >> $OUT',
108 '%(libraries)s >> $OUT'
109 ]) % {
110 'srcs' : "echo $(srcs :%s) | sed 's/ /,/g'" % name,
111 'classes' : ("$(bin_dir :%s#non-osgi)" if not test else "$(bin_dir :%s)") % name,
112 'libraries' : "echo $(classpath :%s) | sed 's/:/,/g'" % name,
113 'src_base' : 'sonar.sources' if not test else 'sonar.tests',
114 'binary_base' : 'sonar.java.binaries' if not test else 'sonar.java.test.binaries',
115 'lib_base' : 'sonar.java.libraries' if not test else 'sonar.java.test.libraries'
116 }
117 # FIXME do we need to specify dep here or with the expander cover it?
118 genrule(
119 name = name + "-sonar",
120 cmd = cmd,
121 out = 'sonar-project.properties'
122 )
Ray Milkeyc340e282016-06-30 14:45:42 -0700123
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700124def osgi_jar(
Brian O'Connore4da59d2016-04-08 00:32:18 -0700125 name = None,
126 srcs = None,
Brian O'Connor1f165982016-04-06 21:36:09 -0700127 group_id = ONOS_GROUP_ID,
128 version = ONOS_VERSION,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700129 deps = [],
130 visibility = ['PUBLIC'],
131 license = 'NONE',
132 description = '',
133 debug = False,
Brian O'Connore5817c92016-04-06 15:41:48 -0700134 import_packages = '*',
Yuta HIGUCHIf05db402016-08-12 18:36:33 -0700135 dynamicimport_packages = '',
Viswanath KSPd4923cf2017-05-24 13:03:51 +0530136 embedded_dependencies = '',
Yuta HIGUCHI29d640c2017-04-19 19:37:18 -0700137 export_packages = '!.,!*.impl.*,!*.internal.*,*',
Ray Milkey2a749832016-08-02 15:22:20 -0700138 package_name_root = 'org.onosproject',
Brian O'Connor79b70672016-10-20 13:44:52 -0700139 include_resources = {},
Brian O'Connore5817c92016-04-06 15:41:48 -0700140 web_context = NONE,
Brian O'Connor79b70672016-10-20 13:44:52 -0700141 api_title = None,
Brian O'Connore8468b52016-07-25 13:42:36 -0700142 api_version = NONE,
143 api_package = NONE,
144 api_description = NONE,
Brian O'Connore4da59d2016-04-08 00:32:18 -0700145 resources = NONE,
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700146 resources_root = None,
Brian O'Connoree674952016-09-13 16:31:45 -0700147 tests = None,
Thomas Vachuska73436b52017-03-22 19:50:47 -0700148 do_javadocs = True,
149 do_checkstyle = True,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700150 **kwargs
151 ):
152
Brian O'Connore4da59d2016-04-08 00:32:18 -0700153 # if name and _get_name() != name:
154 # print _get_name(), '!=', name
155 if name is None:
156 name = _get_name()
157
158 if srcs is None:
159 srcs = glob([SRC + '/*.java'])
160
161 if resources == NONE and resources_root is not None:
162 resources = glob([resources_root + '**'])
163 elif resources == NONE:
164 resources = glob([RESOURCES_ROOT + '**'])
165
166 if resources and not resources_root:
167 resources_root = RESOURCES_ROOT
168
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700169 mvn_coords = group_id + ':' + name + ':' + version
170
Brian O'Connore8468b52016-07-25 13:42:36 -0700171 onos_jar(
Brian O'Connoree674952016-09-13 16:31:45 -0700172 name = name,
173 srcs = srcs + glob(['src/main/webapp/**']),
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700174 deps = deps,
Brian O'Connoree674952016-09-13 16:31:45 -0700175 visibility = visibility,
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700176 resources = resources,
177 resources_root = resources_root,
Brian O'Connoree674952016-09-13 16:31:45 -0700178 bundle_name = name,
179 group_id = group_id,
180 bundle_version = version,
181 bundle_license = license,
182 bundle_description = description,
183 import_packages = import_packages,
184 export_packages = export_packages,
185 include_resources = include_resources,
186 dynamicimport_packages = dynamicimport_packages,
Viswanath KSPd4923cf2017-05-24 13:03:51 +0530187 embedded_dependencies = embedded_dependencies,
Brian O'Connore8468b52016-07-25 13:42:36 -0700188 web_context = web_context,
189 api_title = api_title,
190 api_version = api_version,
191 api_package = api_package,
192 api_description = api_description,
Brian O'Connoree674952016-09-13 16:31:45 -0700193 tests = tests,
194 maven_coords = mvn_coords,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700195 **kwargs
196 )
197
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700198 ### Checkstyle
Thomas Vachuska73436b52017-03-22 19:50:47 -0700199 if do_checkstyle:
200 checkstyle(
Yuta HIGUCHI9312a802017-06-12 20:01:27 -0700201 name = name,
Thomas Vachuska73436b52017-03-22 19:50:47 -0700202 srcs = srcs,
Thomas Vachuska73436b52017-03-22 19:50:47 -0700203 )
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700204
Thomas Vachuska73436b52017-03-22 19:50:47 -0700205 if do_javadocs:
206 java_doc(
207 name = name + '-javadoc',
208 title = 'Java Docs',
209 pkgs = [ package_name_root ],
210 paths = [ 'src/main/java' ],
211 srcs = srcs,
212 deps = deps,
213 visibility = visibility,
214 do_it_wrong = False,
215 )
Ray Milkeyc340e282016-06-30 14:45:42 -0700216
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700217 # TODO add project config for intellij
218 # project_config(
Brian O'Connoree674952016-09-13 16:31:45 -0700219 # src_target = ':' + name,
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700220 # src_roots = [ 'src/main/java' ],
221 # test_target = ':' + name + '-tests',
222 # test_roots = [ 'src/test/java' ],
223 # )
224
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700225 ### .m2 Install
Brian O'Connorb86c9202016-04-05 20:15:04 -0700226 mvn_cmd = ' '.join(( 'mvn install:install-file',
227 '-Dfile=$(location :%s)' % name,
228 '-DgroupId=%s' % group_id,
229 '-DartifactId=%s' % name,
230 '-Dversion=%s' % version,
231 '-Dpackaging=jar' ))
Brian O'Connore5817c92016-04-06 15:41:48 -0700232 cmd = mvn_cmd + ' > $OUT'
233 if FORCE_INSTALL:
234 # Add a random number to the command to force this rule to run.
235 # TODO We should make this configurable from CLI, perhaps with a flag.
236 cmd = 'FOO=%s ' % random.random() + cmd
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700237 genrule(
238 name = name + '-install',
Brian O'Connorb86c9202016-04-05 20:15:04 -0700239 bash = cmd,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700240 out = 'install.log',
241 visibility = visibility,
242 )
Brian O'Connor9c2c8232016-11-08 17:13:14 -0800243 sonar(
244 name = name,
245 )
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700246
Brian O'Connore4da59d2016-04-08 00:32:18 -0700247def osgi_jar_with_tests(
248 name = None,
249 deps = [],
Brian O'Connoree674952016-09-13 16:31:45 -0700250 group_id = ONOS_GROUP_ID,
251 version = ONOS_VERSION,
Brian O'Connore4da59d2016-04-08 00:32:18 -0700252 test_srcs = None,
253 test_deps = [ '//lib:TEST' ],
254 test_resources = None,
255 test_resources_root = None,
256 visibility = [ 'PUBLIC' ],
257 **kwargs
258 ):
259
260 if name is None:
261 name = _get_name()
262
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700263 if test_resources and not test_resources_root:
Brian O'Connore4da59d2016-04-08 00:32:18 -0700264 test_resources_root = TEST_RESOURCES_ROOT
265 if test_resources_root and not test_resources:
266 test_resources = glob([test_resources_root + '**'])
267 if not test_resources and not test_resources_root:
268 test_resources = glob([TEST_RESOURCES_ROOT + '**'])
269 if test_resources:
270 test_resources_root = TEST_RESOURCES_ROOT
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700271
Brian O'Connore4da59d2016-04-08 00:32:18 -0700272 if test_srcs is None:
273 test_srcs = glob([TEST + '/*.java'])
274
Brian O'Connoree674952016-09-13 16:31:45 -0700275 mvn_coords = group_id + ':' + name + ':jar:tests:' + version
276
Brian O'Connor9c2c8232016-11-08 17:13:14 -0800277 if test_srcs:
278 java_test(
279 name = name + '-tests',
280 srcs = test_srcs,
281 deps = deps +
282 test_deps +
283 [':' + name + '#non-osgi'],
284 resources = test_resources,
285 resources_root = test_resources_root,
286 maven_coords = mvn_coords,
287 visibility = visibility,
288 )
Brian O'Connorbe95f682016-05-18 15:40:19 -0700289
Brian O'Connor9c2c8232016-11-08 17:13:14 -0800290 checkstyle(
Yuta HIGUCHI295ee072017-06-21 15:48:21 -0700291 name = name + '-tests',
Brian O'Connor9c2c8232016-11-08 17:13:14 -0800292 srcs = test_srcs,
Brian O'Connor9c2c8232016-11-08 17:13:14 -0800293 )
294
295 sonar(
296 name = name + '-tests',
297 test = True
298 )
299
300 osgi_jar(name = name,
301 deps = deps,
302 group_id = group_id,
303 version = version,
304 visibility = visibility,
305 tests = [':' + name + '-tests'],
306 **kwargs)
307 else:
308 osgi_jar(name = name,
309 deps = deps,
310 group_id = group_id,
311 version = version,
312 visibility = visibility,
313 **kwargs)
Thomas Vachuskabe1a1962016-10-25 16:59:29 -0700314
315def tar_file(
316 name,
317 srcs,
Brian O'Connor30322dd2017-08-14 19:11:29 -0700318 other_tars = [],
Thomas Vachuskabee8a912018-02-28 10:02:16 -0800319 flat = False,
Thomas Vachuskabe1a1962016-10-25 16:59:29 -0700320 root = None,
321 out = None,
322 visibility = [ 'PUBLIC' ],
323 ):
324
Brian O'Connor30322dd2017-08-14 19:11:29 -0700325 cmds = [ 'mkdir -p $TMP/%(root_dir)s',
326 'cp -R -L $SRCDIR/* $TMP/%(root_dir)s' ]
327 for t in other_tars:
328 cmds += [ 'tar -zxf $(location %s)' % t + ' -C $TMP/%(root_dir)s' ]
Thomas Vachuskabee8a912018-02-28 10:02:16 -0800329
330 if flat:
331 cmds += [ 'find $TMP/%(root_dir)s -type f -exec mv {} $TMP/%(root_dir)s \;',
332 'find $TMP/%(root_dir)s/* -type d -d -exec rmdir {} \;' ]
333
Brian O'Connor30322dd2017-08-14 19:11:29 -0700334 cmds += [ 'tar -C $TMP -zcf $OUT %(root_dir)s' ]
335
336 cmd = ' && '.join(cmds) % {
Thomas Vachuskabe1a1962016-10-25 16:59:29 -0700337 'root_dir': root if root is not None else name
338 }
339
340 genrule(
341 name = name,
342 srcs = srcs,
343 bash = cmd,
344 out = out if out is not None else ( root if root is not None else name ) + '.tar.gz',
345 visibility = visibility,
346 )
Ray Milkey5c5454b2017-01-25 13:26:30 -0800347
348def only_lib_dep_pom(
349 name,
350 src,
351 out,
352 version = ONOS_VERSION,
353 onosGroupId = ONOS_GROUP_ID,
354 visibility = [ 'PUBLIC' ],
355 ):
356
Ray Milkeye46d31a2017-02-01 12:16:18 -0800357 cmd = 'grep -v \<module\> ' + src + ' | sed "s#<modules>#<modules><module>lib</module>#" >$OUT'
Ray Milkey5c5454b2017-01-25 13:26:30 -0800358
359 genrule(
360 name = name,
361 srcs = [ src ],
362 bash = cmd,
363 out = out,
364 visibility = visibility,
365 maven_coords = onosGroupId + ':onos:pom:' + version,
366 )
367
368def pass_thru_pom(
369 name,
370 src,
371 out,
372 artifactId,
373 version = ONOS_VERSION,
374 onosGroupId = ONOS_GROUP_ID,
375 visibility = [ 'PUBLIC' ],
376 ):
377
378 cmd = 'cp ' + src + ' $OUT'
379
380 genrule(
381 name = name,
382 srcs = [ src ],
383 bash = cmd,
384 out = out,
385 visibility = visibility,
386 maven_coords = onosGroupId + ':' + artifactId + ':pom:' + version,
387 )