blob: 79e8ba06b8b44bf0de66fd6f19cfbd1eca6e319f [file] [log] [blame]
Ray Milkeyd7be3622018-07-12 10:29:21 -07001"""
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
19
20 Bazel and npm are incompatibe in how they deal with files. npm likes to follow links
21 to get back to the original canonical path names, and bazel uses links extensively when
22 populating the sandbox. To get around these problems, the rules that follow use filegroups
23 to specify the files as dependencies and then use a genrule to convert the files into a tar
24 ball. Once the tar ball is unrolled into the sandbox, the links are broken, but the build is
25 still hermetic since those files are referred to as dependencies in the genrule.
26
27 Also note that the onos-gui.tar contains files from //tools/gui and //web/gui, so the files are placed into
28 the sandbox at the proper locations and then returned as a tar ball.
29"""
Ray Milkey6b3775a2018-06-28 11:18:44 -070030
31COMPILE_DEPS = CORE_DEPS + JACKSON + KRYO + [
32 "@javax_ws_rs_api//jar",
33 "@servlet_api//jar",
34 "@jetty_websocket//jar",
35 "@jetty_util//jar",
36 "@jersey_media_multipart//jar",
37 "@org_apache_karaf_shell_console//jar",
38 "@jersey_server//jar",
39 "//cli:onos-cli",
40 "//incubator/api:onos-incubator-api",
41 "//incubator/net:onos-incubator-net",
42 "//utils/rest:onlab-rest",
43 "//core/store/serializers:onos-core-serializers",
44]
45
46TEST_DEPS = TEST + [
47 "//core/api:onos-api-tests",
48 "//drivers/default:onos-drivers-default",
49]
50
Ray Milkeyd7be3622018-07-12 10:29:21 -070051"""
52 Files that get put at the top level of the tar ball
53"""
Ray Milkey6b3775a2018-06-28 11:18:44 -070054
55filegroup(
56 name = "_root_level_files",
57 srcs =
58 [
59 ":src/main/webapp/bower.json",
60 ":src/main/webapp/bs-config.js",
61 ":src/main/webapp/dev_server.js",
62 ":src/main/webapp/package.json",
63 ],
64)
65
Ray Milkeyd7be3622018-07-12 10:29:21 -070066"""
67 Files that get put into the WEB-INF directory of the tar ball
68"""
69
Ray Milkey6b3775a2018-06-28 11:18:44 -070070filegroup(
71 name = "_web_inf_classes_files",
72 srcs =
73 [
74 ":src/main/webapp/error.html",
75 ":src/main/webapp/index.html",
76 ":src/main/webapp/login.html",
77 ":src/main/webapp/nav.html",
78 ":src/main/webapp/not-ready.html",
79 ":src/main/webapp/onos.js",
80 ],
81)
82
Ray Milkeyd7be3622018-07-12 10:29:21 -070083"""
84 webapp raw files
85"""
86
Ray Milkey6b3775a2018-06-28 11:18:44 -070087filegroup(
88 name = "_raw_classes_files",
89 srcs = glob(["src/main/webapp/raw/**"]),
90)
91
Ray Milkeyd7be3622018-07-12 10:29:21 -070092"""
Ray Milkeyd7be3622018-07-12 10:29:21 -070093 Install node.js and npm, and gather files needed from //tools/gui
94"""
95
96genrule(
97 name = "_onos-gui-npm-install",
98 srcs = [
99 "@nodejs//:bin/npm",
Sean Condonf6af2a52018-08-19 10:43:24 +0100100 "@nodejs//:bin/node",
101 "@nodejs//:bin/node.js",
102 "@nodejs//:bin/nodejs/bin/node",
103 "@nodejs//:bin/nodejs/bin/npm",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700104 "//tools/gui:tools-gui-gulp",
Thomas Vachuska34328622018-08-03 09:21:17 -0700105 ],
106 outs = ["onos-gui-npm-install.jar"],
Ray Milkeyd7be3622018-07-12 10:29:21 -0700107 cmd = " ROOT=`pwd` &&" +
Thomas Vachuska06206132018-08-06 16:43:43 -0700108 " export HOME=. &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700109 " export XDG_CONFIG_HOME=$(@D)/config &&" + # npm config cache to the sandbos
Ray Milkeycc9620a2018-07-31 14:22:40 -0700110 " export BABEL_DISABLE_CACHE=1 &&" + # turn off babel cache
Ray Milkeyd7be3622018-07-12 10:29:21 -0700111 " NPM=$$ROOT/$(location @nodejs//:bin/npm) &&" +
112 " mkdir -p tools/gui &&" +
113 " cd tools/gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700114 " jar xf ../../$(location //tools/gui:tools-gui-gulp) &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700115 " $$NPM install --no-cache --loglevel=error >npm-install.out 2>&1 &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700116 " find . -name package.json | while read pjson; do egrep -v '/execroot/' $$pjson > ptmp; mv ptmp $$pjson; done &&" +
117 " find package.json gulpfile.babel.js node_modules gulp-tasks -type f -exec touch -t 201806280000 {} \; &&" +
118 " jar Mcf $$ROOT/$@ package.json gulpfile.babel.js node_modules gulp-tasks",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700119)
120
121"""
122 Run npm build to create node.js files
123"""
124
125genrule(
126 name = "_onos-gui-npm-build",
127 srcs = [
128 "@nodejs//:bin/npm",
Sean Condonf6af2a52018-08-19 10:43:24 +0100129 "@nodejs//:bin/node",
130 "@nodejs//:bin/node.js",
131 "@nodejs//:bin/nodejs/bin/node",
132 "@nodejs//:bin/nodejs/bin/npm",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700133 ":_onos-gui-npm-install",
134 ":_web_app_all",
135 ],
Thomas Vachuska34328622018-08-03 09:21:17 -0700136 outs = ["onos-gui-npm-build.jar"],
Ray Milkeyd7be3622018-07-12 10:29:21 -0700137 cmd = "(ROOT=`pwd` &&" +
Thomas Vachuska06206132018-08-06 16:43:43 -0700138 " export HOME=. &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700139 " export XDG_CONFIG_HOME=$(@D)/config &&" +
140 " export BABEL_DISABLE_CACHE=1" +
141 " NPM=$(location @nodejs//:bin/npm) &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700142 " (mkdir -p web/gui && cd web/gui && jar xf ../../$(location :_web_app_all)) &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700143 " mkdir -p tools/gui && cd tools/gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700144 " jar xf $$ROOT/$(location :_onos-gui-npm-install) &&" +
145 " chmod a+x ./node_modules/gulp/bin/gulp.js &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700146 " $$ROOT/$$NPM run build --no-cache --loglevel=error >npm-build.out &&" +
147 " cd ../../web/gui/src/main/webapp &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700148 " find dist vendor data README.md _doc _dev app/fw app/*.css app/*.js app/*.txt -type f -exec touch -t 201806280000 {} \; &&" +
149 " jar Mcf $$ROOT/$@ dist vendor data README.md _doc _dev app/fw app/*.css app/*.js app/*.txt)",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700150)
151
152"""
153 Make a jar file of all the webapp files. Useful for breaking symblic links in the sandbox
154"""
155
156genrule(
157 name = "_web_app_all",
Jian Lid486a732018-08-03 00:32:11 +0900158 srcs = glob(
159 [
160 "src/main/webapp/**",
161 "src/main/webapp/app/**/*.js",
162 ],
163 exclude = [
164 "src/main/webapp/tests/**",
165 "src/main/webapp/node_modules/**",
166 "src/main/webapp/dist/**",
167 "src/main/webapp/vendor/**",
168 "src/main/webapp/npm-debug.log",
169 ],
170 ),
Thomas Vachuska34328622018-08-03 09:21:17 -0700171 outs = ["web_app_all.jar"],
172 cmd = "cd web/gui &&" +
173 " find src/main/webapp -type f -exec touch -t 201806280000 {} \; &&" +
174 " jar Mcf ../../$@ src/main/webapp",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700175)
176
177"""
178 app/view is packaged as a tar file because it has subdirectories that need to be preserved
179"""
180
Ray Milkey6b3775a2018-06-28 11:18:44 -0700181genrule(
182 name = "_app_view_tar",
183 srcs = glob(["src/main/webapp/app/view/**"]),
Thomas Vachuska34328622018-08-03 09:21:17 -0700184 outs = ["app_view_tar.jar"],
Ray Milkey6b3775a2018-06-28 11:18:44 -0700185 cmd = " ROOT=`pwd` &&" +
186 " cd web/gui/src/main/webapp/app/view &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700187 " find . -type f -exec touch -t 201806280000 {} \; &&" +
188 " jar Mcf $$ROOT/$@ .",
Ray Milkey6b3775a2018-06-28 11:18:44 -0700189)
190
Ray Milkeyd7be3622018-07-12 10:29:21 -0700191"""
192 Builds the java jar for the java code provided by the GUI
193"""
194
195osgi_jar_with_tests(
196 name = "_onos-gui-base-jar",
197 exclude_tests = [
198 "org.onosproject.ui.impl.AbstractUiImplTest",
199 "org.onosproject.ui.impl.topo.model.AbstractTopoModelTest",
200 ],
201 test_deps = TEST_DEPS,
202 web_context = "/onos/ui",
203 deps = COMPILE_DEPS,
204)
205
206"""
207 Builds the tar ball for the ONOS GUI
208"""
209
Ray Milkey6b3775a2018-06-28 11:18:44 -0700210genrule(
211 name = "onos-gui",
212 srcs = [
213 ":_onos-gui-npm-build",
214 ":_onos-gui-base-jar",
215 ":_root_level_files",
216 ":_web_inf_classes_files",
217 ":_raw_classes_files",
218 ":_app_view_tar",
219 ],
220 outs = ["onos-gui.jar"],
221 cmd = " ROOT=`pwd` &&" +
222 " mkdir -p gui/WEB-INF/classes &&" +
223 " cd gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700224 " jar xf $$ROOT/$(location :_onos-gui-npm-build) &&" +
225 " (cd WEB-INF/classes && mkdir -p app/view && cd app/view && jar xf $$ROOT/$(location :_app_view_tar)) &&" +
Ray Milkey6b3775a2018-06-28 11:18:44 -0700226 " for i in $(locations :_root_level_files); do cp $$ROOT/$$i .; done &&" +
227 " for i in $(locations :_web_inf_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/; done &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700228 " mkdir ./WEB-INF/classes/raw && " +
229 " for i in $(locations :_raw_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/raw/; done &&" +
Ray Milkey6b3775a2018-06-28 11:18:44 -0700230 " jar xf $$ROOT/$(location :_onos-gui-base-jar) &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700231 " find . -type f -exec touch -t 201806280000 {} \; &&" +
Ray Milkey6b3775a2018-06-28 11:18:44 -0700232 " jar cmf META-INF/MANIFEST.MF $$ROOT/$@ .",
Ray Milkey6b3775a2018-06-28 11:18:44 -0700233 output_to_bindir = 1,
234 visibility = ["//visibility:public"],
235)