blob: 28b0624ccb1814d57cac5916e4e39c00a9981453 [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
20 The GUI2 Angular 6 elements are built here with Angular CLI 'ng'
21 Some work is being done in the Bazel community to integrate Bazel and
22 Angular 6, (Angular Buildtools Convergence -
23 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
40COMPILE_DEPS = CORE_DEPS + JACKSON + KRYO + [
41 "@javax_ws_rs_api//jar",
42 "@servlet_api//jar",
43 "@jetty_websocket//jar",
44 "@jetty_util//jar",
45 "@jersey_media_multipart//jar",
46 "@jersey_server//jar",
47 "//utils/rest:onlab-rest",
48 "//core/store/serializers:onos-core-serializers",
49]
50
51TEST_DEPS = TEST + [
52 "//core/api:onos-api-tests",
53 "//drivers/default:onos-drivers-default",
54]
55
56"""
57 Files that get put at the top level of the tar ball
58"""
59
60filegroup(
61 name = "_root_level_files",
62 srcs =
63 [
64 ":angular.json",
65 ":karma.conf.js",
66 ":package.json",
67 ":package-lock.json",
68 ":protractor.conf.js",
69 ":src/main/tsconfig.json",
70 ":src/main/tslint.json",
71 ":tsconfig.json",
72 ],
73)
74
75filegroup(
76 name = "_e2e_test_files",
77 srcs = [
78 ":e2e/app.e2e-spec.ts",
79 ":e2e/app.po.ts",
80 ":e2e/tsconfig.e2e.json",
81 ],
82)
83
84"""
85 Files that get put into the WEB-INF directory of the tar ball
86"""
87
88filegroup(
89 name = "_web_inf_classes_files",
90 srcs =
91 [
92 ":src/main/webapp/error.html",
93 ":src/main/webapp/login.html",
94 ":src/main/webapp/nav.html",
95 ":src/main/webapp/not-ready.html",
96 ":src/main/webapp/onos.theme.css",
97 ],
98)
99
100"""
Sean Condonf6af2a52018-08-19 10:43:24 +0100101 Run ng build to create outputs in production mode
102 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 +0100103
104 To avoid the overhead of having several "npm install" invocations, we just do
105 it once in the //web/gui2-fw-lib which is really the core for the whole Angular 6
106 structure in ONOS. This copies files in to node_modules, but because the gui2-fw-lib
107 has not been generated at that time we copy it in separately below with the 'tar' cmd
108 and then 'mv'
Sean Condonf6af2a52018-08-19 10:43:24 +0100109"""
110
111genrule(
112 name = "_onos-gui2-ng-build",
113 srcs = [
114 "@nodejs//:bin/npm",
115 "@nodejs//:bin/node",
116 "@nodejs//:bin/node.js",
117 "@nodejs//:bin/nodejs/bin/node",
118 "@nodejs//:bin/nodejs/bin/npm",
Sean Condon5ca00262018-09-06 17:55:25 +0100119 "//web/gui2-fw-lib:onos-gui2-fw-npm-install",
120 "//web/gui2-fw-lib:onos-gui2-fw-ng-build",
121 "//web/gui2-fw-lib:gui2_fw_lib_ext_css",
Sean Condon87b78502018-09-17 20:53:24 +0100122 "//apps/faultmanagement/fm-gui2-lib:fm-gui2-lib-build",
Sean Condon5ca00262018-09-06 17:55:25 +0100123 ":_root_level_files",
Sean Condonf6af2a52018-08-19 10:43:24 +0100124 ":_web_app_all",
125 ],
126 outs = [
127 "onos-gui2-ng-build-prod.log",
128 "onos-gui2-ng-build.jar",
129 ],
130 cmd = "ROOT=`pwd` &&" +
131 " export HOME=. &&" +
132 " export XDG_CONFIG_HOME=$(@D)/config &&" +
133 " NODE=$(location @nodejs//:bin/node) &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100134 " INSTALL_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-npm-install)) &&" + # An array of filenames - sorted by time created
135 " 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 +0100136 " mkdir -p web/gui2 && cd web/gui2 &&" +
137 " jar xf ../../$(location :_web_app_all) &&" +
138 " jar xf $$ROOT/$${INSTALL_FILES[0]} &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100139 " tar xf $$ROOT/$${FWLIB_FILES[0]} &&" +
140 " mv package/ node_modules/gui2-fw-lib/ &&" +
Sean Condon87b78502018-09-17 20:53:24 +0100141 # Add in modules from external packages
142 " FM_GUI2_LIB_FILES=($(locations //apps/faultmanagement/fm-gui2-lib:fm-gui2-lib-build)) &&" + # An array of filenames - sorted by time created
143 " tar xf $$ROOT/$${FM_GUI2_LIB_FILES[0]} &&" +
144 " mv package/ node_modules/fm-gui2-lib/ &&" +
145 # End of add in modules from external packages
Sean Condon5ca00262018-09-06 17:55:25 +0100146 " mkdir -p src/main/webapp/app/fw &&" +
147 " (cd src/main/webapp/app/fw &&" +
148 " jar xf $$ROOT/$(location //web/gui2-fw-lib:gui2_fw_lib_ext_css)) &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100149 " chmod +x $$ROOT/web/gui2/node_modules/@angular/cli/bin/ng &&" +
Thomas Vachuska0c19e652018-08-28 10:57:07 -0700150 " export PATH=$$ROOT/$$(dirname $${NODE}):$$ROOT/web/gui2/node_modules/@angular/cli/bin:$$PATH &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100151 " node -v > ../../$(location onos-gui2-ng-build-prod.log) &&" +
152 " npm -v >> ../../$(location onos-gui2-ng-build-prod.log) &&" +
153 " ng -v >> ../../$(location onos-gui2-ng-build-prod.log) &&" +
154 # Build it in production mode - optimization is turned off because of Angular CLI 6.0.x bug https://github.com/angular/angular-cli/issues/7799
Sean Condon5ca00262018-09-06 17:55:25 +0100155 " ng build --extract-css --prod --optimization=false --preserve-symlinks" +
Sean Condon87b78502018-09-17 20:53:24 +0100156 " --base-href /onos/ui2/ --deploy-url /onos/ui2/ >> $$ROOT/$(location onos-gui2-ng-build-prod.log) 2>&1 ||" +
157 " if [ $$? -eq 0 ]; then echo 'Successfully ran build';" +
158 " else " +
159 " echo 'Error running \'ng build\' on \'//web/gui2:_onos-gui2-ng-build\'. \\\n" +
160 " See bazel-genfiles/web/gui2/onos-gui2-ng-build-prod.log for more details' >&2;" +
161 #" tail -n 100 ../../$(location onos-gui2-ng-test.log) >&2;" +
162 " exit 1;" +
163 " fi;" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100164 " cd src/main/webapp/dist && jar Mcf $$ROOT/$(location onos-gui2-ng-build.jar) .",
165 message = "Angular CLI 6 build",
166)
167
168"""
169 Run 'ng test' to run Angular test and 'ng lint' for checkstyle
170 See bazel-genfiles/web/gui2/onos-gui2-ng-lint.log or
171 bazel-genfiles/web/gui2/onos-gui2-ng-test.log for details of the Angular CLI output
172"""
173
174genrule(
175 name = "_onos-gui2-ng-test-genrule",
176 srcs = [
177 "@nodejs//:bin/npm",
178 "@nodejs//:bin/node",
179 "@nodejs//:bin/node.js",
180 "@nodejs//:bin/nodejs/bin/node",
181 "@nodejs//:bin/nodejs/bin/npm",
Sean Condon5ca00262018-09-06 17:55:25 +0100182 "//web/gui2-fw-lib:onos-gui2-fw-npm-install",
183 "//web/gui2-fw-lib:onos-gui2-fw-ng-build",
184 "//web/gui2-fw-lib:gui2_fw_lib_ext_css",
Sean Condonf6af2a52018-08-19 10:43:24 +0100185 ":_web_app_all",
186 ":_web_app_tests",
187 ":_angular_all",
188 ],
189 outs = [
190 "onos-gui2-ng-ver.log",
191 "onos-gui2-ng-lint.log",
192 "onos-gui2-ng-test.log",
193 ],
194 cmd = " ROOT=`pwd` &&" +
195 " export HOME=. &&" +
196 " export XDG_CONFIG_HOME=$(@D)/config &&" +
197 " NODE=$(location @nodejs//:bin/node) &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100198 " INSTALL_FILES=($(locations //web/gui2-fw-lib:onos-gui2-fw-npm-install)) &&" + # An array of filenames - sorted by time created
199 " 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 +0100200 " mkdir -p web/gui2 &&" +
201 " cd web/gui2 &&" +
202 " jar xf ../../$(location :_angular_all) &&" +
203 " jar xf ../../$(location :_web_app_all) &&" +
204 " jar xf ../../$(location :_web_app_tests) &&" +
205 " jar xf $$ROOT/$${INSTALL_FILES[0]} &&" +
Sean Condon5ca00262018-09-06 17:55:25 +0100206 " tar xf $$ROOT/$${FWLIB_FILES[0]} &&" +
207 " mv package/ node_modules/gui2-fw-lib/ &&" +
208 " mkdir -p src/main/webapp/app/fw &&" +
209 " (cd src/main/webapp/app/fw &&" +
210 " jar xf $$ROOT/$(location //web/gui2-fw-lib:gui2_fw_lib_ext_css)) &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100211 " chmod +x $$ROOT/web/gui2/node_modules/@angular/cli/bin/ng &&" +
Thomas Vachuska0c19e652018-08-28 10:57:07 -0700212 " export PATH=$$ROOT/$$(dirname $${NODE}):$$ROOT/web/gui2/node_modules/@angular/cli/bin:$$PATH &&" +
Sean Condonf6af2a52018-08-19 10:43:24 +0100213 " node -v > ../../$(location onos-gui2-ng-ver.log) &&" +
214 " npm -v >> ../../$(location onos-gui2-ng-ver.log) &&" +
215 " ng -v >> ../../$(location onos-gui2-ng-ver.log) &&" +
216 " ng lint > ../../$(location onos-gui2-ng-lint.log);" +
217 " if [ -f /usr/bin/chromium-browser ]; then " + # Add to this for Mac and Chrome
218 " export CHROME_BIN=/usr/bin/chromium-browser; " +
219 " elif [ -f /opt/google/chrome/chrome ]; then " +
220 " export CHROME_BIN=/opt/google/chrome/chrome; " +
221 " else " +
222 " MSG='Warning: Step onos-gui2-ng-test skipped because \\n" +
223 " no binary for ChromeHeadless browser was found at /usr/bin/chromium-browser. \\n" +
224 " Install Google Chrome or Chromium Browser to allow this step to run.';" +
225 " echo -e $$MSG >&2;" +
226 " echo -e $$MSG > ../../$(location onos-gui2-ng-test.log);" +
227 " exit 0;" +
228 " fi;" +
229 " ng test --preserve-symlinks --code-coverage --browsers=ChromeHeadless" +
230 " --watch=false > ../../$(location onos-gui2-ng-test.log) 2>&1 ||" +
231 " if [ $$? -eq 0 ]; then echo 'Successfully ran tests';" +
232 " else " +
233 " echo 'Error running \'ng test\' on \'//web/gui2:onos-gui2-ng-test\'. \\\n" +
234 " See bazel-genfiles/web/gui2/onos-gui2-ng-test.log for more details' >&2;" +
235 #" tail -n 100 ../../$(location onos-gui2-ng-test.log) >&2;" +
236 " exit 1;" +
237 " fi;",
238 message = "Angular CLI 6 lint and test",
239)
240
241"""
242 Make a jar file of all the webapp files. Useful for breaking symblic links in the sandbox
243"""
244
245genrule(
246 name = "_web_app_all",
247 srcs = glob(
248 [
249 "src/main/webapp/**",
250 ],
251 exclude = [
252 "src/main/webapp/**/*.spec.ts", # Don't track tests here
253 "src/main/webapp/tests/**",
254 "src/main/webapp/node_modules/**",
255 "src/main/webapp/dist/**",
256 "src/main/webapp/doc/**",
Sean Condon87b78502018-09-17 20:53:24 +0100257 "src/main/webapp/app/fw/**",
Sean Condonf6af2a52018-08-19 10:43:24 +0100258 ],
259 ),
260 outs = ["web_app_all.jar"],
261 cmd = "cd web/gui2 &&" +
262 " find src/main/webapp -type f -exec touch -t 201808280000 {} \; &&" +
263 " jar Mcf ../../$@ src/main/webapp",
264)
265
266"""
267 Make a jar file of all the webapp test (*.spec.ts) files.
268"""
269
270genrule(
271 name = "_web_app_tests",
272 srcs = glob(
273 [
274 "src/main/webapp/**/*.spec.ts",
275 ],
276 exclude = [
277 "src/main/webapp/tests/**",
278 "src/main/webapp/node_modules/**",
279 "src/main/webapp/dist/**",
280 "src/main/webapp/doc/**",
281 ],
282 ),
283 outs = ["web_app_tests.jar"],
284 cmd = "cd web/gui2 &&" +
285 " find src/main/webapp -type f -exec touch -t 201808280000 {} \; &&" +
286 " jar Mcf ../../$@ src/main/webapp",
287)
288
289"""
290 Make a jar file of all the supporting files. Useful for breaking symblic links in the sandbox
291"""
292
293genrule(
294 name = "_angular_all",
295 srcs = [
296 ":_e2e_test_files",
297 ":_root_level_files",
298 ],
299 outs = ["angular_all.jar"],
300 cmd = " cd web/gui2 && jar Mcf ../../$@ .",
301)
302
303"""
304 Builds the java jar for the java code provided by the GUI2
305"""
306
307osgi_jar_with_tests(
308 name = "_onos-gui2-base-jar",
Sean Condon87b78502018-09-17 20:53:24 +0100309 srcs =
310 glob([
311 "src/main/java/**",
312 ]) + [
313 "//web/gui:onos-gui-java-for-gui2",
314 ],
Sean Condon3c8e5582018-08-28 23:22:43 +0100315 suppress_checkstyle = True,
Sean Condonf6af2a52018-08-19 10:43:24 +0100316 test_deps = TEST_DEPS,
317 web_context = "/onos/ui2",
318 deps = COMPILE_DEPS,
319)
320
321"""
322 Builds the tar ball for the ONOS GUI2
323"""
324
325genrule(
326 name = "onos-gui2",
327 srcs = [
328 ":_onos-gui2-ng-build",
329 ":_onos-gui2-base-jar",
330 ":_web_inf_classes_files",
Sean Condon3c8e5582018-08-28 23:22:43 +0100331 "src/main/webapp/WEB-INF/web.xml",
Sean Condonf6af2a52018-08-19 10:43:24 +0100332 ],
333 outs = ["onos-gui2.jar"],
334 cmd = " ROOT=`pwd` &&" +
335 " mkdir -p web/gui2/WEB-INF/classes &&" +
336 " cd web/gui2 &&" +
337 " BUILD_FILES=($(locations :_onos-gui2-ng-build)) &&" + # An array of filenames - sorted by time created
338 " for i in $(locations :_web_inf_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/; done &&" +
339 " (cd WEB-INF/classes && jar xf $$ROOT/$${BUILD_FILES[1]}) &&" +
340 " jar xf $$ROOT/$(location :_onos-gui2-base-jar) &&" +
341 " find . -type f -exec touch -t 201808280000 {} \; &&" +
Sean Condon3c8e5582018-08-28 23:22:43 +0100342 " jar cmf META-INF/MANIFEST.MF $$ROOT/$@ WEB-INF/web.xml WEB-INF/classes",
Sean Condonf6af2a52018-08-19 10:43:24 +0100343 output_to_bindir = 1,
344 visibility = ["//visibility:public"],
345)
346
347"""
348 Wrap the genrule for testing in a test
349"""
350
351sh_test(
352 name = "onos-gui2-ng-tests",
353 size = "small",
354 srcs = [
355 ":ng-test.sh",
356 ],
357 data = [
358 ":_onos-gui2-ng-test-genrule",
359 ],
360 deps = [
361 "@bazel_tools//tools/bash/runfiles",
362 ],
363)