blob: cf8d2765244a0c4f9a5126ccaee7f65b10f2c990 [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
24 if srcs and jar_target:
25 base = get_base_path()
26 files = '%s\n%s\n' % (name, base) + '\n'.join(['%s/%s' % (base, s) for s in srcs])
27
28 genrule(
29 name = name + '-checkstyle-files',
30 bash = "echo '%s' > $OUT" % files,
31 srcs = srcs,
32 out = 'checkstyle-files.txt',
33 )
34
35 sh_test(
36 name = name + '-checkstyle',
Thomas Vachuska275d2e82016-07-14 17:41:34 -070037 test = '//tools/build/conf:start-buck-daemon',
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070038 deps = [ jar_target ],
39 args = [
Thomas Vachuska275d2e82016-07-14 17:41:34 -070040 '$(location //tools/build/conf:buck-daemon-jar)',
41 'checkstyle',
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070042 '$(location :' + name + '-checkstyle-files)',
43 '$(location //tools/build/conf:checkstyle-xml)',
44 '$(location //tools/build/conf:suppressions-xml)',
45 ],
46 test_rule_timeout_ms = 20000,
47 labels = [ 'checkstyle' ],
48 )
Brian O'Connor40a3fbd2016-06-08 13:54:46 -070049
Ray Milkeyc340e282016-06-30 14:45:42 -070050def java_doc(
51 name,
52 title,
53 pkgs,
54 paths,
55 srcs = [],
56 deps = [],
57 visibility = [],
58 do_it_wrong = False,
59 ):
60 if do_it_wrong:
61 sourcepath = paths
62 else:
63 sourcepath = ['$SRCDIR/' + n for n in paths]
Ray Milkey2a749832016-08-02 15:22:20 -070064
65 if len(srcs) != 0:
Ray Milkeyc340e282016-06-30 14:45:42 -070066 cmd = ' '.join([
Ray Milkey2a749832016-08-02 15:22:20 -070067 'while ! test -f .buckconfig; do cd ..; done;',
68 'javadoc',
69 '-tag onos.rsModel:a:"onos model"',
70 '-quiet',
71 '-protected',
72 '-encoding UTF-8',
73 '-charset UTF-8',
74 '-notimestamp',
75 '-windowtitle "' + title + '"',
76 '-link http://docs.oracle.com/javase/8/docs/api',
77 '-subpackages ',
78 ':'.join(pkgs),
79 '-sourcepath ',
80 ':'.join(sourcepath),
81 ' -classpath ',
82 ':'.join(['$(classpath %s)' % n for n in deps]),
83 '-d $TMP',
84 ]) + ';jar cf $OUT -C $TMP .'
85
86 genrule(
87 name = name,
88 cmd = cmd,
89 srcs = srcs,
90 out = name + '.jar',
91 visibility = visibility,
Ray Milkeyc340e282016-06-30 14:45:42 -070092)
93
94
Brian O'Connor42c38cf2016-04-05 17:05:57 -070095def osgi_jar(
Brian O'Connore4da59d2016-04-08 00:32:18 -070096 name = None,
97 srcs = None,
Brian O'Connor1f165982016-04-06 21:36:09 -070098 group_id = ONOS_GROUP_ID,
99 version = ONOS_VERSION,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700100 deps = [],
101 visibility = ['PUBLIC'],
102 license = 'NONE',
103 description = '',
104 debug = False,
Brian O'Connore5817c92016-04-06 15:41:48 -0700105 import_packages = '*',
Yuta HIGUCHIf05db402016-08-12 18:36:33 -0700106 dynamicimport_packages = '',
Brian O'Connore5817c92016-04-06 15:41:48 -0700107 export_packages = '*',
Ray Milkey2a749832016-08-02 15:22:20 -0700108 package_name_root = 'org.onosproject',
Brian O'Connore5817c92016-04-06 15:41:48 -0700109 include_resources = NONE,
110 web_context = NONE,
Brian O'Connore8468b52016-07-25 13:42:36 -0700111 api_title = NONE,
112 api_version = NONE,
113 api_package = NONE,
114 api_description = NONE,
Brian O'Connore4da59d2016-04-08 00:32:18 -0700115 resources = NONE,
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700116 resources_root = None,
Brian O'Connoree674952016-09-13 16:31:45 -0700117 tests = None,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700118 **kwargs
119 ):
120
Brian O'Connore4da59d2016-04-08 00:32:18 -0700121 # if name and _get_name() != name:
122 # print _get_name(), '!=', name
123 if name is None:
124 name = _get_name()
125
126 if srcs is None:
127 srcs = glob([SRC + '/*.java'])
128
129 if resources == NONE and resources_root is not None:
130 resources = glob([resources_root + '**'])
131 elif resources == NONE:
132 resources = glob([RESOURCES_ROOT + '**'])
133
134 if resources and not resources_root:
135 resources_root = RESOURCES_ROOT
136
Brian O'Connore8468b52016-07-25 13:42:36 -0700137 if api_title != NONE:
Brian O'Connoree674952016-09-13 16:31:45 -0700138 r = 'WEB-INF/classes/apidoc/swagger.json=swagger.json'
Brian O'Connore8468b52016-07-25 13:42:36 -0700139 include_resources = include_resources + ',' + r if include_resources != NONE else r
140
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700141 mvn_coords = group_id + ':' + name + ':' + version
142
Brian O'Connore8468b52016-07-25 13:42:36 -0700143 onos_jar(
Brian O'Connoree674952016-09-13 16:31:45 -0700144 name = name,
145 srcs = srcs + glob(['src/main/webapp/**']),
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700146 deps = deps,
Brian O'Connoree674952016-09-13 16:31:45 -0700147 visibility = visibility,
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700148 resources = resources,
149 resources_root = resources_root,
Brian O'Connoree674952016-09-13 16:31:45 -0700150 bundle_name = name,
151 group_id = group_id,
152 bundle_version = version,
153 bundle_license = license,
154 bundle_description = description,
155 import_packages = import_packages,
156 export_packages = export_packages,
157 include_resources = include_resources,
158 dynamicimport_packages = dynamicimport_packages,
Brian O'Connore8468b52016-07-25 13:42:36 -0700159 web_context = web_context,
160 api_title = api_title,
161 api_version = api_version,
162 api_package = api_package,
163 api_description = api_description,
Brian O'Connoree674952016-09-13 16:31:45 -0700164 tests = tests,
165 maven_coords = mvn_coords,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700166 **kwargs
167 )
168
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700169 ### Checkstyle
Brian O'Connor40a3fbd2016-06-08 13:54:46 -0700170 checkstyle(
Brian O'Connorbe95f682016-05-18 15:40:19 -0700171 name = name + '-checkstyle-files',
Brian O'Connor4847ea32016-04-29 16:33:06 -0700172 srcs = srcs,
Brian O'Connoree674952016-09-13 16:31:45 -0700173 jar_target = ':'+ name,
Brian O'Connor40a3fbd2016-06-08 13:54:46 -0700174 )
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700175
Ray Milkeyc340e282016-06-30 14:45:42 -0700176 java_doc(
177 name = name + '-javadoc',
178 title = 'Java Docs',
Ray Milkey2a749832016-08-02 15:22:20 -0700179 pkgs = [ package_name_root ],
Ray Milkeyc340e282016-06-30 14:45:42 -0700180 paths = [ 'src/main/java' ],
181 srcs = srcs,
182 deps = deps,
183 visibility = visibility,
184 do_it_wrong = False,
185 )
186
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700187 # TODO add project config for intellij
188 # project_config(
Brian O'Connoree674952016-09-13 16:31:45 -0700189 # src_target = ':' + name,
Brian O'Connorb3cc6042016-04-25 11:55:51 -0700190 # src_roots = [ 'src/main/java' ],
191 # test_target = ':' + name + '-tests',
192 # test_roots = [ 'src/test/java' ],
193 # )
194
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700195 ### .m2 Install
Brian O'Connorb86c9202016-04-05 20:15:04 -0700196 mvn_cmd = ' '.join(( 'mvn install:install-file',
197 '-Dfile=$(location :%s)' % name,
198 '-DgroupId=%s' % group_id,
199 '-DartifactId=%s' % name,
200 '-Dversion=%s' % version,
201 '-Dpackaging=jar' ))
Brian O'Connore5817c92016-04-06 15:41:48 -0700202 cmd = mvn_cmd + ' > $OUT'
203 if FORCE_INSTALL:
204 # Add a random number to the command to force this rule to run.
205 # TODO We should make this configurable from CLI, perhaps with a flag.
206 cmd = 'FOO=%s ' % random.random() + cmd
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700207 genrule(
208 name = name + '-install',
Brian O'Connorb86c9202016-04-05 20:15:04 -0700209 bash = cmd,
Brian O'Connor42c38cf2016-04-05 17:05:57 -0700210 out = 'install.log',
211 visibility = visibility,
212 )
213
Brian O'Connore4da59d2016-04-08 00:32:18 -0700214def osgi_jar_with_tests(
215 name = None,
216 deps = [],
Brian O'Connoree674952016-09-13 16:31:45 -0700217 group_id = ONOS_GROUP_ID,
218 version = ONOS_VERSION,
Brian O'Connore4da59d2016-04-08 00:32:18 -0700219 test_srcs = None,
220 test_deps = [ '//lib:TEST' ],
221 test_resources = None,
222 test_resources_root = None,
223 visibility = [ 'PUBLIC' ],
224 **kwargs
225 ):
226
227 if name is None:
228 name = _get_name()
229
230 osgi_jar(name = name,
231 deps = deps,
Brian O'Connoree674952016-09-13 16:31:45 -0700232 group_id = group_id,
233 version = version,
Brian O'Connore4da59d2016-04-08 00:32:18 -0700234 visibility = visibility,
Brian O'Connoree674952016-09-13 16:31:45 -0700235 tests = [':' + name + '-tests'],
Brian O'Connore4da59d2016-04-08 00:32:18 -0700236 **kwargs)
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700237
238 if test_resources and not test_resources_root:
Brian O'Connore4da59d2016-04-08 00:32:18 -0700239 test_resources_root = TEST_RESOURCES_ROOT
240 if test_resources_root and not test_resources:
241 test_resources = glob([test_resources_root + '**'])
242 if not test_resources and not test_resources_root:
243 test_resources = glob([TEST_RESOURCES_ROOT + '**'])
244 if test_resources:
245 test_resources_root = TEST_RESOURCES_ROOT
Brian O'Connor0f6677d2016-04-06 23:26:51 -0700246
Brian O'Connore4da59d2016-04-08 00:32:18 -0700247 if test_srcs is None:
248 test_srcs = glob([TEST + '/*.java'])
249
Brian O'Connoree674952016-09-13 16:31:45 -0700250 mvn_coords = group_id + ':' + name + ':jar:tests:' + version
251
Brian O'Connore4da59d2016-04-08 00:32:18 -0700252 java_test(
253 name = name + '-tests',
254 srcs = test_srcs,
255 deps = deps +
256 test_deps +
Brian O'Connoree674952016-09-13 16:31:45 -0700257 [':' + name + '#non-osgi'],
Brian O'Connore4da59d2016-04-08 00:32:18 -0700258 resources = test_resources,
259 resources_root = test_resources_root,
Brian O'Connoree674952016-09-13 16:31:45 -0700260 maven_coords = mvn_coords,
261 visibility = visibility,
Brian O'Connorbe95f682016-05-18 15:40:19 -0700262 )
263
Brian O'Connor40a3fbd2016-06-08 13:54:46 -0700264 checkstyle(
265 name = name + '-tests',
266 srcs = test_srcs,
267 jar_target = ':' + name + '-tests',
268 )