blob: be8e3f3fe62ddc4ff96c294bc2d995c1c22215ad [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
Thomas Vachuska277ec4e2018-08-29 17:59:47 +0000111 ' if [[ ! -z $${HTTP_PROXY-} ]]; then NPM_ARGS="--proxy $$HTTP_PROXY --without-ssl --insecure"; else NPM_ARGS=""; fi &&' +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700112 " NPM=$$ROOT/$(location @nodejs//:bin/npm) &&" +
113 " mkdir -p tools/gui &&" +
114 " cd tools/gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700115 " jar xf ../../$(location //tools/gui:tools-gui-gulp) &&" +
Ray Milkey61289c12018-08-27 17:09:25 -0700116 " $$NPM $$NPM_ARGS install --no-cache --loglevel=error >npm-install.out 2>&1 &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700117 " find . -name package.json | while read pjson; do egrep -v '/execroot/' $$pjson > ptmp; mv ptmp $$pjson; done &&" +
118 " find package.json gulpfile.babel.js node_modules gulp-tasks -type f -exec touch -t 201806280000 {} \; &&" +
119 " jar Mcf $$ROOT/$@ package.json gulpfile.babel.js node_modules gulp-tasks",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700120)
121
122"""
123 Run npm build to create node.js files
124"""
125
126genrule(
127 name = "_onos-gui-npm-build",
128 srcs = [
129 "@nodejs//:bin/npm",
Sean Condonf6af2a52018-08-19 10:43:24 +0100130 "@nodejs//:bin/node",
131 "@nodejs//:bin/node.js",
132 "@nodejs//:bin/nodejs/bin/node",
133 "@nodejs//:bin/nodejs/bin/npm",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700134 ":_onos-gui-npm-install",
135 ":_web_app_all",
136 ],
Thomas Vachuska34328622018-08-03 09:21:17 -0700137 outs = ["onos-gui-npm-build.jar"],
Ray Milkeyd7be3622018-07-12 10:29:21 -0700138 cmd = "(ROOT=`pwd` &&" +
Thomas Vachuska06206132018-08-06 16:43:43 -0700139 " export HOME=. &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700140 " export XDG_CONFIG_HOME=$(@D)/config &&" +
Ray Milkey61289c12018-08-27 17:09:25 -0700141 " export BABEL_DISABLE_CACHE=1 &&" +
142 ' if [[ ! -z $${HTTP_PROXY-} ]]; then NPM_ARGS="--proxy $$HTTP_PROXY --without-ssl --insecure"; else NPM_ARGS=""; fi &&' +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700143 " NPM=$(location @nodejs//:bin/npm) &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700144 " (mkdir -p web/gui && cd web/gui && jar xf ../../$(location :_web_app_all)) &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700145 " mkdir -p tools/gui && cd tools/gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700146 " jar xf $$ROOT/$(location :_onos-gui-npm-install) &&" +
147 " chmod a+x ./node_modules/gulp/bin/gulp.js &&" +
Ray Milkey61289c12018-08-27 17:09:25 -0700148 " $$ROOT/$$NPM $$NPM_ARGS run build --no-cache --loglevel=error >npm-build.out &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700149 " cd ../../web/gui/src/main/webapp &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700150 " find dist vendor data README.md _doc _dev app/fw app/*.css app/*.js app/*.txt -type f -exec touch -t 201806280000 {} \; &&" +
151 " 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 -0700152)
153
154"""
155 Make a jar file of all the webapp files. Useful for breaking symblic links in the sandbox
156"""
157
158genrule(
159 name = "_web_app_all",
Jian Lid486a732018-08-03 00:32:11 +0900160 srcs = glob(
161 [
162 "src/main/webapp/**",
163 "src/main/webapp/app/**/*.js",
164 ],
165 exclude = [
166 "src/main/webapp/tests/**",
167 "src/main/webapp/node_modules/**",
168 "src/main/webapp/dist/**",
169 "src/main/webapp/vendor/**",
170 "src/main/webapp/npm-debug.log",
171 ],
172 ),
Thomas Vachuska34328622018-08-03 09:21:17 -0700173 outs = ["web_app_all.jar"],
174 cmd = "cd web/gui &&" +
175 " find src/main/webapp -type f -exec touch -t 201806280000 {} \; &&" +
176 " jar Mcf ../../$@ src/main/webapp",
Ray Milkeyd7be3622018-07-12 10:29:21 -0700177)
178
179"""
180 app/view is packaged as a tar file because it has subdirectories that need to be preserved
181"""
182
Ray Milkey6b3775a2018-06-28 11:18:44 -0700183genrule(
184 name = "_app_view_tar",
185 srcs = glob(["src/main/webapp/app/view/**"]),
Thomas Vachuska34328622018-08-03 09:21:17 -0700186 outs = ["app_view_tar.jar"],
Ray Milkey6b3775a2018-06-28 11:18:44 -0700187 cmd = " ROOT=`pwd` &&" +
188 " cd web/gui/src/main/webapp/app/view &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700189 " find . -type f -exec touch -t 201806280000 {} \; &&" +
190 " jar Mcf $$ROOT/$@ .",
Ray Milkey6b3775a2018-06-28 11:18:44 -0700191)
192
Ray Milkeyd7be3622018-07-12 10:29:21 -0700193"""
194 Builds the java jar for the java code provided by the GUI
195"""
196
197osgi_jar_with_tests(
198 name = "_onos-gui-base-jar",
199 exclude_tests = [
200 "org.onosproject.ui.impl.AbstractUiImplTest",
201 "org.onosproject.ui.impl.topo.model.AbstractTopoModelTest",
202 ],
203 test_deps = TEST_DEPS,
204 web_context = "/onos/ui",
205 deps = COMPILE_DEPS,
206)
207
Sean Condon3c8e5582018-08-28 23:22:43 +0100208genrule(
209 name = "onos-gui-java-for-gui2",
210 srcs = glob([
211 "src/main/java/org/onosproject/ui/impl/Main*Resource.java",
212 "src/main/java/org/onosproject/ui/impl/ApplicationResource.java",
213 ]),
214 outs = ["onos-gui-java-for-gui2.srcjar"],
215 cmd = "jar cf $@ $(SRCS)",
216 visibility = ["//visibility:public"],
217)
218
Ray Milkeyd7be3622018-07-12 10:29:21 -0700219"""
220 Builds the tar ball for the ONOS GUI
221"""
222
Ray Milkey6b3775a2018-06-28 11:18:44 -0700223genrule(
224 name = "onos-gui",
225 srcs = [
226 ":_onos-gui-npm-build",
227 ":_onos-gui-base-jar",
228 ":_root_level_files",
229 ":_web_inf_classes_files",
230 ":_raw_classes_files",
231 ":_app_view_tar",
232 ],
233 outs = ["onos-gui.jar"],
234 cmd = " ROOT=`pwd` &&" +
235 " mkdir -p gui/WEB-INF/classes &&" +
236 " cd gui &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700237 " jar xf $$ROOT/$(location :_onos-gui-npm-build) &&" +
238 " (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 -0700239 " for i in $(locations :_root_level_files); do cp $$ROOT/$$i .; done &&" +
240 " for i in $(locations :_web_inf_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/; done &&" +
Ray Milkeyd7be3622018-07-12 10:29:21 -0700241 " mkdir ./WEB-INF/classes/raw && " +
242 " for i in $(locations :_raw_classes_files); do cp $$ROOT/$$i ./WEB-INF/classes/raw/; done &&" +
Ray Milkey6b3775a2018-06-28 11:18:44 -0700243 " jar xf $$ROOT/$(location :_onos-gui-base-jar) &&" +
Thomas Vachuska34328622018-08-03 09:21:17 -0700244 " find . -type f -exec touch -t 201806280000 {} \; &&" +
Ray Milkey6b3775a2018-06-28 11:18:44 -0700245 " jar cmf META-INF/MANIFEST.MF $$ROOT/$@ .",
Ray Milkey6b3775a2018-06-28 11:18:44 -0700246 output_to_bindir = 1,
247 visibility = ["//visibility:public"],
248)