bazel: bower support
* npm_binary (download tarball packaged npm apps)
* bower_archive (download a zip file, to be put in WORKSPACE)
* bower_component (defining a bower library, with dependency )
* bower_component_bundle (zipping up libraries together)
* js_component (insert plain js file into bower component bundle)
* bower2bazel.py: run bower to find dependencies, generate a .bzl to
define archives and define components
Tested:
python tools/js/bower2bazel.py -w lib/js/bower_archives.bzl -b \
lib/js/bower_components.bzl
bazel build polygerrit-ui:components
unzip -v bazel-bin/polygerrit-ui/components.zip > /tmp/baz
buck build polygerrit-ui:polygerrit_components
unzip -v buck-out/gen/polygerrit-ui/polygerrit_components/polygerrit_components.bower_components.zip > /tmp/buck
diff /tmp/buck /tmp/baz
The diff corresponds to newer file versions pinned through bower2bazel.
Change-Id: I4f33914d4853bcf8afe78b4719d0e0e83b139031
diff --git a/tools/js/bower2bazel.py b/tools/js/bower2bazel.py
new file mode 100755
index 0000000..8682012
--- /dev/null
+++ b/tools/js/bower2bazel.py
@@ -0,0 +1,228 @@
+#!/usr/bin/env python
+# Copyright (C) 2015 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Suggested call sequence:
+
+python tools/js/bower2bazel.py -w lib/js/bower_archives.bzl -b lib/js/bower_components.bzl
+"""
+
+from __future__ import print_function
+
+import atexit
+import collections
+import json
+import hashlib
+import optparse
+import os
+import shutil
+import subprocess
+import sys
+import tempfile
+import glob
+import bowerutil
+
+# Map license names to our canonical names.
+license_map = {
+ "http://polymer.github.io/LICENSE.txt": "polymer",
+ "Apache-2.0": "Apache2.0",
+
+ # TODO(hanwen): remove these, and add appropriate license files under //lib
+ "BSD": "polymer",
+ "MIT": "polymer",
+}
+
+# list of licenses for packages that don't specify one in their bower.json file.
+package_licenses = {
+ "es6-promise": "es6-promise",
+ "fetch": "fetch",
+ "moment": "moment",
+ "page": "page.js",
+ "promise-polyfill": "promise-polyfill",
+ "webcomponentsjs": "polymer", # self-identifies as BSD.
+}
+
+
+def build_bower_json(version_targets):
+ """Generate bower JSON file, return its path."""
+ bower_json = collections.OrderedDict()
+ bower_json['name'] = 'bower2buck-output'
+ bower_json['version'] = '0.0.0'
+ bower_json['description'] = 'Auto-generated bower.json for dependency management'
+ bower_json['private'] = True
+ bower_json['dependencies'] = {}
+
+ for v in version_targets:
+ fn = os.path.join("bazel-out/local-fastbuild/bin", v.lstrip("/").replace(":", "/"))
+ with open(fn) as f:
+ j = json.load(f)
+ if "" in j:
+ # drop dummy entries.
+ del j[""]
+ bower_json['dependencies'].update(j)
+
+ tmpdir = tempfile.mkdtemp()
+ ret = os.path.join(tmpdir, 'bower.json')
+ with open(ret, 'w') as f:
+ json.dump(bower_json, f, indent=2)
+ return ret
+
+
+def bower_command(args):
+ base = subprocess.check_output(["bazel", "info", "output_base"]).strip()
+ exp = os.path.join(base, "external", "bower", "*npm_binary.tgz")
+ fs = sorted(glob.glob(exp))
+ assert len(fs) == 1, "bower tarball not found or have multiple versions %s" % fs
+ return ["python", os.getcwd() + "/tools/js/run_npm_binary.py", sorted(fs)[0]] + args
+
+
+def main(args):
+ opts = optparse.OptionParser()
+ opts.add_option('-w', help='.bzl output for WORKSPACE')
+ opts.add_option('-b', help='.bzl output for //lib:BUILD')
+ opts, args = opts.parse_args()
+
+ target_str = subprocess.check_output([
+ "bazel", "query", "kind(bower_component_bundle, //polygerrit-ui/...)"])
+ seed_str = subprocess.check_output([
+ "bazel", "query", "attr(seed, 1, kind(bower_component, deps(//polygerrit-ui/...)))"])
+ targets = [s for s in target_str.split('\n') if s]
+ seeds = [s for s in seed_str.split('\n') if s]
+ prefix = "//lib/js:"
+ non_seeds = [s for s in seeds if not s.startswith(prefix)]
+ assert not non_seeds, non_seeds
+ seeds = set([s[len(prefix):] for s in seeds])
+
+ version_targets = [t + "-versions.json" for t in targets]
+
+ subprocess.check_call(['bazel', 'build'] + version_targets)
+ bower_json_path = build_bower_json(version_targets)
+ dir = os.path.dirname(bower_json_path)
+ cmd = bower_command(["install"])
+
+ build_out = sys.stdout
+ if opts.b:
+ build_out = open(opts.b + ".tmp", 'w')
+
+ ws_out = sys.stdout
+ if opts.b:
+ ws_out = open(opts.w + ".tmp", 'w')
+
+ header = """# DO NOT EDIT
+# generated with the following command:
+#
+# %s
+#
+
+""" % ' '.join(sys.argv)
+
+ ws_out.write(header)
+ build_out.write(header)
+
+ oldwd = os.getcwd()
+ os.chdir(dir)
+ subprocess.check_call(cmd)
+
+ interpret_bower_json(seeds, ws_out, build_out)
+ ws_out.close()
+ build_out.close()
+
+ os.chdir(oldwd)
+ os.rename(opts.w + ".tmp", opts.w)
+ os.rename(opts.b + ".tmp", opts.b)
+
+
+def dump_workspace(data, seeds, out):
+ out.write('load("//tools/bzl:js.bzl", "bower_archive")\n')
+ out.write('def load_bower_archives():\n')
+
+ for d in data:
+ if d["name"] in seeds:
+ continue
+ out.write(""" bower_archive(
+ name = "%(name)s",
+ package = "%(normalized-name)s",
+ version = "%(version)s",
+ sha1 = "%(bazel-sha1)s")
+""" % d)
+
+
+def dump_build(data, seeds, out):
+ out.write('load("//tools/bzl:js.bzl", "bower_component")\n')
+ out.write('def define_bower_components():\n')
+ for d in data:
+ out.write(" bower_component(\n")
+ out.write(" name = \"%s\",\n" % d["name"])
+ out.write(" license = \"//lib:LICENSE-%s\",\n" % d["bazel-license"])
+ deps = sorted(d.get("dependencies", {}).keys())
+ if deps:
+ if len(deps) == 1:
+ out.write(" deps = [ \":%s\" ],\n" % deps[0])
+ else:
+ out.write(" deps = [\n")
+ for dep in deps:
+ out.write(" \":%s\",\n" % dep)
+ out.write(" ],\n")
+ if d["name"] in seeds:
+ out.write(" seed = True,\n")
+ out.write(" )\n")
+ # done
+
+
+def interpret_bower_json(seeds, ws_out, build_out):
+ out = subprocess.check_output(["find", "bower_components/", "-name", ".bower.json"])
+
+ data = []
+ for f in sorted(out.split('\n')):
+ if not f:
+ continue
+ pkg = json.load(open(f))
+ pkg_name = pkg["name"]
+
+ pkg["bazel-sha1"] = bowerutil.hash_bower_component(
+ hashlib.sha1(), os.path.dirname(f)).hexdigest()
+ license = pkg.get("license", None)
+ if type(license) == type([]):
+ # WTF? Some package specify a list of licenses. ("GPL", "MIT")
+ pick = license[0]
+ sys.stderr.write("package %s has multiple licenses: %s, picking %s" % (pkg_name, ", ".join(license), pick))
+ license = pick
+
+ if license:
+ license = license_map.get(license, license)
+ else:
+ if pkg_name not in package_licenses:
+ msg = "package %s does not specify license." % pkg_name
+ sys.stderr.write(msg)
+ raise Exception(msg)
+ license = package_licenses[pkg_name]
+
+ pkg["bazel-license"] = license
+
+ # TODO(hanwen): bower packages can also have 'fully qualified'
+ # names, ("PolymerElements/iron-ajax") as well as short names
+ # ("iron-ajax"). It is possible for bower.json files to refer to
+ # long names as their dependencies. If any package does this, we
+ # will have to either 1) strip off the prefix (typically github
+ # user?), or 2) build a map of short name <=> fully qualified
+ # name. For now, we just ignore the problem.
+ pkg["normalized-name"] = pkg["name"]
+ data.append(pkg)
+
+ dump_workspace(data, seeds, ws_out)
+ dump_build(data, seeds, build_out)
+
+
+if __name__ == '__main__':
+ main(sys.argv[1:])
