blob: bd0b3300942f9340e01a8fa084a2cbbfb920c056 [file] [log] [blame]
Sean Condonf6af2a52018-08-19 10:43:24 +01001"""
2 Copyright 2018-present Open Networking Foundation
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15"""
16
17"""
18 Rules to build the ONOS GUI 2
19
Sean Condon0c577f62018-11-18 22:40:05 +000020 The GUI2 Angular 7 elements are built here with Angular CLI 'ng'
Sean Condonf6af2a52018-08-19 10:43:24 +010021 Some work is being done in the Bazel community to integrate Bazel and
Sean Condon0c577f62018-11-18 22:40:05 +000022 Angular 7, (Angular Buildtools Convergence -
Sean Condonf6af2a52018-08-19 10:43:24 +010023 https://docs.google.com/document/d/1OlyiUnoTirUj4gecGxJeZBcjHcFr36RvLsvpBl2mxA8/preview)
24 but it is in the very early stages (Aug'18) and not yet fit
25 for production and at present it works as a replacement for Angular CLI
26 (which is not desirable).
27
28 There are plans to extend Bazel it to work with Angular CLI, and if works
29 well this Bazel file may be rearchiteced in future.
30
31 Bazel and npm are incompatibe in how they deal with files. npm likes to
32 follow links to get back to the original canonical path names, and bazel
33 uses links extensively when populating the sandbox. To get around these
34 problems, the rules that follow use filegroups to specify the files as
35 dependencies and then use a genrule to convert the files into a tar ball.
36 Once the tar ball is unrolled into the sandbox, the links are broken, but
37 the build is still hermetic since those files are referred to as dependencies in the genrule.
38"""
39
Sean Condonb2c483c2019-01-16 20:28:55 +000040COMPILE_DEPS = CORE_DEPS + JACKSON + KRYO + CLI + [
Sean Condonf6af2a52018-08-19 10:43:24 +010041 "@javax_ws_rs_api//jar",
42 "@servlet_api//jar",
43 "@jetty_websocket//jar",
Sean Condonb2c483c2019-01-16 20:28:55 +000044 "@jetty_websocket_api//jar",
Sean Condonf6af2a52018-08-19 10:43:24 +010045 "@jetty_util//jar",
46 "@jersey_media_multipart//jar",
47 "@jersey_server//jar",
Ray Milkey427e9752018-11-15 16:34:48 -080048 "@jersey_hk2//jar",
Sean Condonf6af2a52018-08-19 10:43:24 +010049 "//utils/rest:onlab-rest",
50 "//core/store/serializers:onos-core-serializers",
51]
52
53TEST_DEPS = TEST + [
54 "//core/api:onos-api-tests",
55 "//drivers/default:onos-drivers-default",
56]
57
58"""
59 Files that get put at the top level of the tar ball
60"""
61
62filegroup(
63 name = "_root_level_files",
64 srcs =
65 [
66 ":angular.json",
67 ":karma.conf.js",
68 ":package.json",
69 ":package-lock.json",
70 ":protractor.conf.js",
71 ":src/main/tsconfig.json",
72 ":src/main/tslint.json",
73 ":tsconfig.json",
74 ],
75)
76
77filegroup(
78 name = "_e2e_test_files",
79 srcs = [
80 ":e2e/app.e2e-spec.ts",
81 ":e2e/app.po.ts",
82 ":e2e/tsconfig.e2e.json",
83 ],
84)
85
86"""
87 Files that get put into the WEB-INF directory of the tar ball
88"""
89
90filegroup(
91 name = "_web_inf_classes_files",
92 srcs =
93 [
94 ":src/main/webapp/error.html",
95 ":src/main/webapp/login.html",
96 ":src/main/webapp/nav.html",
97 ":src/main/webapp/not-ready.html",
Sean Condon55c30532018-10-29 12:26:57 +000098 ":src/main/webapp/onos.global.css",
Sean Condonf6af2a52018-08-19 10:43:24 +010099 ],
100)
101
102"""
Sean Condonf6af2a52018-08-19 10:43:24 +0100103 Run ng build to create outputs in production mode
104 See bazel-genfiles/web/gui2/onos-gui2-ng-build-prod.log for details of the Angular CLI output
Sean Condon5ca00262018-09-06 17:55:25 +0100105
106 To avoid the overhead of having several "npm install" invocations, we just do
Sean Condon0c577f62018-11-18 22:40:05 +0000107 it once in the //web/gui2-fw-lib which is really the core for the whole Angular 7
Sean Condon5ca00262018-09-06 17:55:25 +0100108 structure in ONOS. This copies files in to node_modules, but because the gui2-fw-lib
109 has not been generated at that time we copy it in separately below with the 'tar' cmd
110 and then 'mv'
Sean Condonf6af2a52018-08-19 10:43:24 +0100111"""
112
113genrule(
114 name = "_onos-gui2-ng-build",
115 srcs = [
116 "@nodejs//:bin/npm",
117 "@nodejs//:bin/node",
118 "@nodejs//:bin/node.js",
119 "@nodejs//:bin/nodejs/bin/node",
120 "@nodejs//:bin/nodejs/bin/npm",
Sean Condon5ca00262018-09-06 17:55:25 +0100121 "//web/gui2-fw-lib:onos-gui2-fw-npm-install",
122 "//web/gui2-fw-lib:onos-gui2-fw-ng-build",
123 "//web/gui2-fw-lib:gui2_fw_lib_ext_css",
Sean Condon87b78502018-09-17 20:53:24 +0100124 "//apps/faultmanagement/fm-gui2-lib:fm-gui2-lib-build",
Sean Condon5ca00262018-09-06 17:55:25 +0100125 ":_root_level_files",
Sean Condonf6af2a52018-08-19 10:43:24 +0100126 ":_web_app_all",
127 ],
128 outs = [
129 "onos-gui2-ng-build-prod.log",
130 "onos-gui2-ng-build.jar",
131 ],
132 cmd = "ROOT=`pwd` &&" +
133 " export HOME=. &&" +
134 " export XDG_CONFIG_HOME=$(@D)/config &&" +
135 " NODE=$(location @nodejs//:bin/node) &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100136 " INSTALL_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-npm-install)) &&" + # An array of filenames - sorted by time created
137 " FWLIB_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-ng-build)) &&" + # An array of filenames - sorted by time created
Sean Condonf6af2a52018-08-19 10:43:24 +0100138 " mkdir -p web/gui2 && cd web/gui2 &&" +
139 " jar xf ../../$(location :_web_app_all) &&" +
140 " jar xf $$ROOT/$${INSTALL_FILES[0]} &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100141 " tar xf $$ROOT/$${FWLIB_FILES[0]} &&" +
142 " mv package/ node_modules/gui2-fw-lib/ &&" +
Sean Condon87b78502018-09-17 20:53:24 +0100143 # Add in modules from external packages
144 " FM_GUI2_LIB_FILES=($(locations //apps/faultmanagement/fm-gui2-lib:fm-gui2-lib-build)) &&" + # An array of filenames - sorted by time created
145 " tar xf $$ROOT/$${FM_GUI2_LIB_FILES[0]} &&" +
146 " mv package/ node_modules/fm-gui2-lib/ &&" +
147 # End of add in modules from external packages
Sean Condon5ca00262018-09-06 17:55:25 +0100148 " mkdir -p src/main/webapp/app/fw &&" +
149 " (cd src/main/webapp/app/fw &&" +
150 " jar xf $$ROOT/$(location //web/gui2-fw-lib:gui2_fw_lib_ext_css)) &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100151 " chmod +x $$ROOT/web/gui2/node_modules/@angular/cli/bin/ng &&" +
Thomas Vachuska0c19e652018-08-28 10:57:07 -0700152 " export PATH=$$ROOT/$$(dirname $${NODE}):$$ROOT/web/gui2/node_modules/@angular/cli/bin:$$PATH &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100153 " node -v > ../../$(location onos-gui2-ng-build-prod.log) &&" +
154 " npm -v >> ../../$(location onos-gui2-ng-build-prod.log) &&" +
Sean Condon0c577f62018-11-18 22:40:05 +0000155 " ng version >> ../../$(location onos-gui2-ng-build-prod.log) &&" +
156 " ng build --extract-css --prod --preserve-symlinks" +
Sean Condon87b78502018-09-17 20:53:24 +0100157 " --base-href /onos/ui2/ --deploy-url /onos/ui2/ >> $$ROOT/$(location onos-gui2-ng-build-prod.log) 2>&1 ||" +
158 " if [ $$? -eq 0 ]; then echo 'Successfully ran build';" +
159 " else " +
160 " echo 'Error running \'ng build\' on \'//web/gui2:_onos-gui2-ng-build\'. \\\n" +
161 " See bazel-genfiles/web/gui2/onos-gui2-ng-build-prod.log for more details' >&2;" +
162 #" tail -n 100 ../../$(location onos-gui2-ng-test.log) >&2;" +
163 " exit 1;" +
164 " fi;" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100165 " cd src/main/webapp/dist && jar Mcf $$ROOT/$(location onos-gui2-ng-build.jar) .",
Sean Condon0c577f62018-11-18 22:40:05 +0000166 message = "Angular CLI 7 build",
Sean Condonf6af2a52018-08-19 10:43:24 +0100167)
168
169"""
170 Run 'ng test' to run Angular test and 'ng lint' for checkstyle
171 See bazel-genfiles/web/gui2/onos-gui2-ng-lint.log or
172 bazel-genfiles/web/gui2/onos-gui2-ng-test.log for details of the Angular CLI output
173"""
174
175genrule(
176 name = "_onos-gui2-ng-test-genrule",
177 srcs = [
178 "@nodejs//:bin/npm",
179 "@nodejs//:bin/node",
180 "@nodejs//:bin/node.js",
181 "@nodejs//:bin/nodejs/bin/node",
182 "@nodejs//:bin/nodejs/bin/npm",
Sean Condon5ca00262018-09-06 17:55:25 +0100183 "//web/gui2-fw-lib:onos-gui2-fw-npm-install",
184 "//web/gui2-fw-lib:onos-gui2-fw-ng-build",
185 "//web/gui2-fw-lib:gui2_fw_lib_ext_css",
Sean Condonf6af2a52018-08-19 10:43:24 +0100186 ":_web_app_all",
187 ":_web_app_tests",
188 ":_angular_all",
189 ],
190 outs = [
191 "onos-gui2-ng-ver.log",
192 "onos-gui2-ng-lint.log",
193 "onos-gui2-ng-test.log",
194 ],
195 cmd = " ROOT=`pwd` &&" +
196 " export HOME=. &&" +
197 " export XDG_CONFIG_HOME=$(@D)/config &&" +
198 " NODE=$(location @nodejs//:bin/node) &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100199 " INSTALL_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-npm-install)) &&" + # An array of filenames - sorted by time created
200 " FWLIB_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-ng-build)) &&" + # An array of filenames - sorted by time created
Sean Condonf6af2a52018-08-19 10:43:24 +0100201 " mkdir -p web/gui2 &&" +
202 " cd web/gui2 &&" +
203 " jar xf ../../$(location :_angular_all) &&" +
204 " jar xf ../../$(location :_web_app_all) &&" +
205 " jar xf ../../$(location :_web_app_tests) &&" +
206 " jar xf $$ROOT/$${INSTALL_FILES[0]} &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100207 " tar xf $$ROOT/$${FWLIB_FILES[0]} &&" +
208 " mv package/ node_modules/gui2-fw-lib/ &&" +
209 " mkdir -p src/main/webapp/app/fw &&" +
210 " (cd src/main/webapp/app/fw &&" +
211 " jar xf $$ROOT/$(location //web/gui2-fw-lib:gui2_fw_lib_ext_css)) &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100212 " chmod +x $$ROOT/web/gui2/node_modules/@angular/cli/bin/ng &&" +
Thomas Vachuska0c19e652018-08-28 10:57:07 -0700213 " export PATH=$$ROOT/$$(dirname $${NODE}):$$ROOT/web/gui2/node_modules/@angular/cli/bin:$$PATH &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100214 " node -v > ../../$(location onos-gui2-ng-ver.log) &&" +
215 " npm -v >> ../../$(location onos-gui2-ng-ver.log) &&" +
Sean Condon50855cf2018-12-23 15:37:42 +0000216 " ng version >> ../../$(location onos-gui2-ng-ver.log);" +
217 " ng lint > ../../$(location onos-gui2-ng-lint.log) 2>&1 ||" +
218 " if [ $$? -eq 0 ]; then echo 'Successfully ran lint';" +
219 " else " +
220 " echo 'Error running \'ng lint\' on \'//web/gui2:onos-gui2-ng-test\'. \\\n" +
221 " See bazel-genfiles/web/gui2/onos-gui2-ng-lint.log for more details' >&2;" +
222 " exit 1;" +
223 " fi;" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100224 " if [ -f /usr/bin/chromium-browser ]; then " + # Add to this for Mac and Chrome
225 " export CHROME_BIN=/usr/bin/chromium-browser; " +
226 " elif [ -f /opt/google/chrome/chrome ]; then " +
227 " export CHROME_BIN=/opt/google/chrome/chrome; " +
228 " else " +
229 " MSG='Warning: Step onos-gui2-ng-test skipped because \\n" +
230 " no binary for ChromeHeadless browser was found at /usr/bin/chromium-browser. \\n" +
231 " Install Google Chrome or Chromium Browser to allow this step to run.';" +
232 " echo -e $$MSG >&2;" +
233 " echo -e $$MSG > ../../$(location onos-gui2-ng-test.log);" +
234 " exit 0;" +
235 " fi;" +
236 " ng test --preserve-symlinks --code-coverage --browsers=ChromeHeadless" +
237 " --watch=false > ../../$(location onos-gui2-ng-test.log) 2>&1 ||" +
238 " if [ $$? -eq 0 ]; then echo 'Successfully ran tests';" +
239 " else " +
240 " echo 'Error running \'ng test\' on \'//web/gui2:onos-gui2-ng-test\'. \\\n" +
241 " See bazel-genfiles/web/gui2/onos-gui2-ng-test.log for more details' >&2;" +
242 #" tail -n 100 ../../$(location onos-gui2-ng-test.log) >&2;" +
243 " exit 1;" +
244 " fi;",
Sean Condon0c577f62018-11-18 22:40:05 +0000245 message = "Angular CLI 7 lint and test",
Sean Condonf6af2a52018-08-19 10:43:24 +0100246)
247
248"""
249 Make a jar file of all the webapp files. Useful for breaking symblic links in the sandbox
250"""
251
252genrule(
253 name = "_web_app_all",
254 srcs = glob(
255 [
256 "src/main/webapp/**",
257 ],
258 exclude = [
259 "src/main/webapp/**/*.spec.ts", # Don't track tests here
260 "src/main/webapp/tests/**",
261 "src/main/webapp/node_modules/**",
262 "src/main/webapp/dist/**",
263 "src/main/webapp/doc/**",
Sean Condon87b78502018-09-17 20:53:24 +0100264 "src/main/webapp/app/fw/**",
Sean Condonf6af2a52018-08-19 10:43:24 +0100265 ],
266 ),
267 outs = ["web_app_all.jar"],
268 cmd = "cd web/gui2 &&" +
269 " find src/main/webapp -type f -exec touch -t 201808280000 {} \; &&" +
270 " jar Mcf ../../$@ src/main/webapp",
271)
272
273"""
274 Make a jar file of all the webapp test (*.spec.ts) files.
275"""
276
277genrule(
278 name = "_web_app_tests",
279 srcs = glob(
280 [
281 "src/main/webapp/**/*.spec.ts",
282 ],
283 exclude = [
284 "src/main/webapp/tests/**",
285 "src/main/webapp/node_modules/**",
286 "src/main/webapp/dist/**",
287 "src/main/webapp/doc/**",
288 ],
289 ),
290 outs = ["web_app_tests.jar"],
291 cmd = "cd web/gui2 &&" +
292 " find src/main/webapp -type f -exec touch -t 201808280000 {} \; &&" +
293 " jar Mcf ../../$@ src/main/webapp",
294)
295
296"""
297 Make a jar file of all the supporting files. Useful for breaking symblic links in the sandbox
298"""
299
300genrule(
301 name = "_angular_all",
302 srcs = [
303 ":_e2e_test_files",
304 ":_root_level_files",
305 ],
306 outs = ["angular_all.jar"],
307 cmd = " cd web/gui2 && jar Mcf ../../$@ .",
308)
309
310"""
311 Builds the java jar for the java code provided by the GUI2
312"""
313
314osgi_jar_with_tests(
315 name = "_onos-gui2-base-jar",
Sean Condon87b78502018-09-17 20:53:24 +0100316 srcs =
317 glob([
318 "src/main/java/**",
319 ]) + [
320 "//web/gui:onos-gui-java-for-gui2",
321 ],
Sean Condonb2c483c2019-01-16 20:28:55 +0000322 exclude_tests = [
323 "org.onosproject.ui.impl.AbstractUiImplTest",
324 "org.onosproject.ui.impl.topo.model.AbstractTopoModelTest",
325 ],
326 karaf_command_packages = [
327 "org.onosproject.ui.impl.cli",
328 "org.onosproject.ui.impl.topo",
329 ],
Sean Condon3c8e5582018-08-28 23:22:43 +0100330 suppress_checkstyle = True,
Sean Condonf6af2a52018-08-19 10:43:24 +0100331 test_deps = TEST_DEPS,
332 web_context = "/onos/ui2",
333 deps = COMPILE_DEPS,
334)
335
336"""
337 Builds the tar ball for the ONOS GUI2
338"""
339
340genrule(
341 name = "onos-gui2",
342 srcs = [
343 ":_onos-gui2-ng-build",
344 ":_onos-gui2-base-jar",
345 ":_web_inf_classes_files",
Sean Condonb2c483c2019-01-16 20:28:55 +0000346 "//web/gui:onos-gui-lion-for-gui2",
Sean Condon0d064ec2019-02-04 21:53:53 +0000347 "//web/gui:onos-gui-data-for-gui2",
Sean Condon3c8e5582018-08-28 23:22:43 +0100348 "src/main/webapp/WEB-INF/web.xml",
Sean Condonf6af2a52018-08-19 10:43:24 +0100349 ],
350 outs = ["onos-gui2.jar"],
351 cmd = " ROOT=`pwd` &&" +
352 " mkdir -p web/gui2/WEB-INF/classes &&" +
353 " cd web/gui2 &&" +
354 " BUILD_FILES=($(locations :_onos-gui2-ng-build)) &&" + # An array of filenames - sorted by time created
355 " for i in $(locations :_web_inf_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/; done &&" +
356 " (cd WEB-INF/classes && jar xf $$ROOT/$${BUILD_FILES[1]}) &&" +
357 " jar xf $$ROOT/$(location :_onos-gui2-base-jar) &&" +
Sean Condonb2c483c2019-01-16 20:28:55 +0000358 " unzip -q $$ROOT/$(location //web/gui:onos-gui-lion-for-gui2) web/gui/src/main/resources/**/* &&" +
359 " mv web/gui/src/main/resources/org/onosproject/ui/lion* WEB-INF/classes/org/onosproject/ui/ &&" +
360 " mv web/gui/src/main/resources/core WEB-INF/classes/ &&" +
Sean Condon0d064ec2019-02-04 21:53:53 +0000361 " unzip -q $$ROOT/$(location //web/gui:onos-gui-data-for-gui2) web/gui/src/main/webapp/data/**/* &&" +
362 " mv web/gui/src/main/webapp/data WEB-INF/classes/ &&" +
Sean Condonb2c483c2019-01-16 20:28:55 +0000363 " find . -type f -exec touch -t 201901200000 {} \; &&" +
364 " jar cmf META-INF/MANIFEST.MF $$ROOT/$@ WEB-INF/web.xml WEB-INF/classes OSGI-INF/*.xml",
Sean Condonf6af2a52018-08-19 10:43:24 +0100365 output_to_bindir = 1,
366 visibility = ["//visibility:public"],
367)
368
369"""
370 Wrap the genrule for testing in a test
371"""
372
373sh_test(
374 name = "onos-gui2-ng-tests",
375 size = "small",
376 srcs = [
377 ":ng-test.sh",
378 ],
379 data = [
380 ":_onos-gui2-ng-test-genrule",
381 ],
382 deps = [
383 "@bazel_tools//tools/bash/runfiles",
384 ],
385)