aboutsummaryrefslogtreecommitdiff
path: root/java_grpc_library.bzl
diff options
context:
space:
mode:
authorSimon Horlick <simonhorlick@gmail.com>2017-06-23 04:06:49 +0800
committerEric Anderson <ejona@google.com>2017-06-22 13:06:49 -0700
commit6d9e149dcb1556d9a9626183b2484cfc24f647b4 (patch)
tree857dd0046f4703e6afa4108d35edd58e86d0c581 /java_grpc_library.bzl
parent51ce204f53e235c7fc433f00a6dbb76a4f47b1f3 (diff)
downloadgrpc-grpc-java-6d9e149dcb1556d9a9626183b2484cfc24f647b4.tar.gz
build: Add Bazel java_grpc_library rule
Bazel third party dependencies are specified in repositories.bzl which gives the consumer the ability to opt-out of any dependencies they use directly in their own project. Fixes #2756
Diffstat (limited to 'java_grpc_library.bzl')
-rw-r--r--java_grpc_library.bzl131
1 files changed, 131 insertions, 0 deletions
diff --git a/java_grpc_library.bzl b/java_grpc_library.bzl
new file mode 100644
index 000000000..008457e48
--- /dev/null
+++ b/java_grpc_library.bzl
@@ -0,0 +1,131 @@
+def _path_ignoring_repository(f):
+ if (len(f.owner.workspace_root) == 0):
+ return f.short_path
+ return f.path[len(f.owner.workspace_root)+1:]
+
+def _gensource_impl(ctx):
+ if len(ctx.attr.srcs) > 1:
+ fail("Only one src value supported", "srcs")
+ for s in ctx.attr.srcs:
+ if s.label.package != ctx.label.package:
+ print(("in srcs attribute of {0}: Proto source with label {1} should be in "
+ + "same package as consuming rule").format(ctx.label, s.label))
+ # Use .jar since .srcjar makes protoc think output will be a directory
+ srcdotjar = ctx.new_file(ctx.label.name + "_src.jar")
+
+ srcs = [f for dep in ctx.attr.srcs for f in dep.proto.direct_sources]
+ includes = [f for dep in ctx.attr.srcs for f in dep.proto.transitive_imports]
+
+ flavor = ctx.attr.flavor
+ if flavor == "normal":
+ flavor = ""
+ ctx.action(
+ inputs = [ctx.executable._java_plugin] + srcs + includes,
+ outputs = [srcdotjar],
+ executable = ctx.executable._protoc,
+ arguments = [
+ "--plugin=protoc-gen-grpc-java=" + ctx.executable._java_plugin.path,
+ "--grpc-java_out={0},enable_deprecated={1}:{2}"
+ .format(flavor, str(ctx.attr.enable_deprecated).lower(), srcdotjar.path)]
+ + ["-I{0}={1}".format(_path_ignoring_repository(include), include.path) for include in includes]
+ + [src.short_path for src in srcs])
+ ctx.action(
+ command = "cp $1 $2",
+ inputs = [srcdotjar],
+ outputs = [ctx.outputs.srcjar],
+ arguments = [srcdotjar.path, ctx.outputs.srcjar.path])
+
+_gensource = rule(
+ attrs = {
+ "srcs": attr.label_list(
+ mandatory = True,
+ non_empty = True,
+ providers = ["proto"],
+ ),
+ "flavor": attr.string(
+ values = [
+ "normal",
+ "lite", # Not currently supported
+ ],
+ default = "normal",
+ ),
+ "enable_deprecated": attr.bool(
+ default = False,
+ ),
+ "_protoc": attr.label(
+ default = Label("@com_google_protobuf//:protoc"),
+ executable = True,
+ cfg = "host",
+ ),
+ "_java_plugin": attr.label(
+ default = Label("@grpc_java//compiler:grpc_java_plugin"),
+ executable = True,
+ cfg = "host",
+ ),
+ },
+ outputs = {
+ "srcjar": "%{name}.srcjar",
+ },
+ implementation = _gensource_impl,
+)
+
+def java_grpc_library(name, srcs, deps, flavor=None,
+ enable_deprecated=None, visibility=None,
+ **kwargs):
+ """Generates and compiles gRPC Java sources for services defined in a proto
+ file. This rule is compatible with java_proto_library and java_lite_proto_library.
+
+ Do note that this rule only scans through the proto file for RPC services. It
+ does not generate Java classes for proto messages. You will need a separate
+ java_proto_library or java_lite_proto_library rule.
+
+ Args:
+ name: (str) A unique name for this rule. Required.
+ srcs: (list) a single proto_library target that contains the schema of the
+ service. Required.
+ deps: (list) a single java_proto_library target for the proto_library in
+ srcs. Required.
+ flavor: (str) "normal" (default) for normal proto runtime. "lite"
+ for the lite runtime.
+ visibility: (list) the visibility list
+ **kwargs: Passed through to generated targets
+ """
+ if flavor == None:
+ flavor = "normal"
+
+ if len(deps) > 1:
+ print("Multiple values in 'deps' is deprecated in " + name)
+
+ gensource_name = name + "__do_not_reference__srcjar"
+ _gensource(
+ name = gensource_name,
+ srcs = srcs,
+ flavor = flavor,
+ enable_deprecated = enable_deprecated,
+ visibility = ["//visibility:private"],
+ **kwargs
+ )
+
+ added_deps = [
+ "@grpc_java//core",
+ "@grpc_java//stub",
+ "@grpc_java//protobuf",
+ "@com_google_guava//jar",
+ ]
+ if flavor == "normal":
+ added_deps += ["@com_google_protobuf_java//:protobuf_java"]
+ elif flavor == "lite":
+ # TODO: This is currently blocked on https://github.com/google/protobuf/issues/2762
+ added_deps += ["@com_google_protobuf_java_lite//:protobuf_java_lite"]
+ else:
+ fail("Unknown flavor type", "flavor")
+
+ native.java_library(
+ name = name,
+ srcs = [gensource_name],
+ visibility = visibility,
+ deps = [
+ "@com_google_code_findbugs_jsr305//jar",
+ ] + deps + added_deps,
+ **kwargs
+ )