Implements the 'output_to_workspace' option

Author: pcj

bzl/base/class.bzl

@@ -1,3 +1,56 @@
+def implement_compile_attributes(lang, self):
+    """Add attributes for the X_proto_compile rule"""
+
+    name = lang.name
+    attrs = self["attrs"]
+
+    # Add "gen_java = X" option where X is True if this is the first
+    # language specified.
+    flag = "gen_" + name
+    attrs[flag] = attr.bool(
+        default = True,
+    )
+
+    # Add a "gen_java_plugin_options=[]".
+    opts = flag + "_plugin_options"
+    attrs[opts] = attr.string_list()
+
+    # If there is a plugin binary, create this label now.
+    if hasattr(lang, "protobuf") and hasattr(lang.protobuf, "executable"):
+        attrs["gen_protobuf_" + name + "_plugin"] = attr.label(
+            default = Label(lang.protobuf.executable),
+            cfg = HOST_CFG,
+            executable = True,
+        )
+
+    # If this language supports gRPC, add this boolean flag in.
+    # However, if we didn't load grpc, we don't actually want to
+    # generate the label for the executable lest we actually need to
+    # have the executable available.  TODO: figure out how to write a
+    # variable in the loading phase of workspace and read it here.
+
+    if hasattr(lang, "grpc"):
+      attrs["gen_grpc_" + name] = attr.bool()
+      if hasattr(lang.grpc, "executable"):
+        attrs["gen_grpc_" + name + "_plugin"] = attr.label(
+          default = Label(lang.grpc.executable),
+          cfg = HOST_CFG,
+          executable = True,
+        )
+
+
+def implement_compile_outputs(lang, self):
+    """Add customizable outputs for the proto_compile rule"""
+    if hasattr(lang, "protobuf") and hasattr(lang.protobuf, "outputs"):
+        self["outputs"] += lang.protobuf.outputs
+    if hasattr(lang, "grpc") and hasattr(lang.grpc, "outputs"):
+        self["outputs"] += lang.grpc.outputs
+
+
+def implement_compile_output_to_genfiles(lang, self):
+    self["output_to_genfiles"] = getattr(lang, "output_to_genfiles", self["output_to_genfiles"])
+
+
 def get_generated_filename_extensions(lang, self):
     ctx = self.get("ctx", None)
     with_grpc = self["with_grpc"]
@@ -132,59 +185,6 @@ def post_execute(lang, self):
     pass
 
 
-def implement_compile_attributes(lang, self):
-    """Add attributes for the X_proto_compile rule"""
-
-    name = lang.name
-    attrs = self["attrs"]
-
-    # Add "gen_java = X" option where X is True if this is the first
-    # language specified.
-    flag = "gen_" + name
-    attrs[flag] = attr.bool(
-        default = True,
-    )
-
-    # Add a "gen_java_plugin_options=[]".
-    opts = flag + "_plugin_options"
-    attrs[opts] = attr.string_list()
-
-    # If there is a plugin binary, create this label now.
-    if hasattr(lang, "protobuf") and hasattr(lang.protobuf, "executable"):
-        attrs["gen_protobuf_" + name + "_plugin"] = attr.label(
-            default = Label(lang.protobuf.executable),
-            cfg = HOST_CFG,
-            executable = True,
-        )
-
-    # If this language supports gRPC, add this boolean flag in.
-    # However, if we didn't load grpc, we don't actually want to
-    # generate the label for the executable lest we actually need to
-    # have the executable available.  TODO: figure out how to write a
-    # variable in the loading phase of workspace and read it here.
-
-    if hasattr(lang, "grpc"):
-      attrs["gen_grpc_" + name] = attr.bool()
-      if hasattr(lang.grpc, "executable"):
-        attrs["gen_grpc_" + name + "_plugin"] = attr.label(
-          default = Label(lang.grpc.executable),
-          cfg = HOST_CFG,
-          executable = True,
-        )
-
-
-def implement_compile_outputs(lang, self):
-    """Add customizable outputs for the proto_compile rule"""
-    if hasattr(lang, "protobuf") and hasattr(lang.protobuf, "outputs"):
-        self["outputs"] += lang.protobuf.outputs
-    if hasattr(lang, "grpc") and hasattr(lang.grpc, "outputs"):
-        self["outputs"] += lang.grpc.outputs
-
-
-def implement_compile_output_to_genfiles(lang, self):
-    self["output_to_genfiles"] = getattr(lang, "output_to_genfiles", self["output_to_genfiles"])
-
-
 CLASS = struct(
     name = "base",
 

bzl/cpp/rules.bzl

@@ -12,6 +12,7 @@ def cc_proto_library(
     grpc_plugin_options = [],
     imports = [],
     lang = CPP,
+    output_to_workspace = False,
     protobuf_plugin_options = [],
     protobuf_plugin = None,
     proto_compile = cc_proto_compile,
@@ -33,6 +34,7 @@ def cc_proto_library(
   args["gen_protobuf_" + lang.name + "_plugin"] = protobuf_plugin
   args["gen_" + lang.name + "_plugin_options"] = protobuf_plugin_options
   args["gen_grpc_" + lang.name + "_plugin"] = grpc_plugin
+  args["output_to_workspace"] = output_to_workspace
   args["proto_deps"] = [d + ".pb" for d in proto_deps]
   args["protoc"] = protoc
   args["protos"] = protos

bzl/go/rules.bzl

@@ -12,6 +12,7 @@ def go_proto_library(
     grpc_plugin_options = [],
     imports = [],
     lang = GO,
+    output_to_workspace = False,
     protobuf_plugin_options = [],
     protobuf_plugin = None,
     proto_compile = go_proto_compile,
@@ -34,6 +35,7 @@ def go_proto_library(
   args["gen_protobuf_" + lang.name + "_plugin"] = protobuf_plugin
   args["gen_" + lang.name + "_plugin_options"] = protobuf_plugin_options
   args["gen_grpc_" + lang.name + "_plugin"] = grpc_plugin
+  args["output_to_workspace"] = output_to_workspace
   args["protoc"] = protoc
   args["protos"] = protos
   args["verbose"] = verbose

bzl/grpc_gateway/rules.bzl

@@ -14,6 +14,7 @@ def grpc_gateway_proto_library(
     grpc_plugin_options = [],
     imports = [],
     lang = GATEWAY,
+    output_to_workspace = False,
     protobuf_plugin_options = [],
     protobuf_plugin = None,
     proto_compile = grpc_gateway_proto_compile,
@@ -50,6 +51,7 @@ def grpc_gateway_proto_library(
   args["gen_protobuf_" + GO.name + "_plugin"] = GO.protobuf.executable
   args[GO.name + "_import_map"] = go_import_map + GATEWAY.default_go_import_map
 
+  args["output_to_workspace"] = output_to_workspace
   args["proto_deps"] = [d + ".pb" for d in proto_deps]
   args["protoc"] = protoc
   args["protos"] = protos

bzl/java/class.bzl

@@ -1,12 +1,11 @@
 load("//bzl:base/class.bzl", BASE = "CLASS", "build_plugin_out")
+load("//bzl:util.bzl", "invoke", "invokesuper")
 
 
 def _build_generated_files(lang, self):
     """Build a jar file for protoc to dump java classes into."""
 
     ctx = self.get("ctx", None)
-    if ctx == None:
-        fail("Java implementation requires bazel context")
 
     srcjar = ctx.outputs.srcjar
     basename = srcjar.basename[:-len(".srcjar")]

bzl/java/rules.bzl

@@ -11,6 +11,7 @@ def java_proto_library(
     grpc_plugin_options = [],
     imports = [],
     lang = JAVA,
+    output_to_workspace = False,
     protobuf_plugin_options = [],
     protobuf_plugin = None,
     proto_compile = java_proto_compile,
@@ -32,6 +33,7 @@ def java_proto_library(
   args["gen_protobuf_" + lang.name + "_plugin"] = protobuf_plugin
   args["gen_" + lang.name + "_plugin_options"] = protobuf_plugin_options
   args["gen_grpc_" + lang.name + "_plugin"] = grpc_plugin
+  args["output_to_workspace"] = output_to_workspace
   args["proto_deps"] = [d + "_pb" for d in deps]
   args["protoc"] = protoc
   args["protos"] = protos

bzl/protoc.bzl

@@ -32,12 +32,31 @@ def _execute_rule(self):
     for i in range(len(outputs)):
       print(" > output%s: %s" % (i, outputs[i]))
 
+  if ctx.attr.output_to_workspace:
+    manifest = ["//" + file.short_path for file in self["provides"]]
+    print(
+"""
+>**************************************************************************
+* - Generating files into the workspace...  This is potentially           *
+*   dangerous (may overwrite existing files) and violates bazel's         *
+*   sandbox policy.                                                       *
+* - Disregard "ERROR: output 'foo.pb.*' was not created." messages.       *
+* - Build will halt following the "not all outputs were created" message. *
+* - Output manifest is printed below.                                     *
+**************************************************************************<
+%s
+>*************************************************************************<
+""" % "\n".join(manifest)
+    )
+
   ctx.action(
-      mnemonic="ProtoCompile",
-      executable=ctx.executable.protoc,
-      arguments=arguments,
-      inputs=inputs,
-      outputs=outputs,
+    mnemonic="ProtoCompile",
+    executable=ctx.executable.protoc,
+    arguments=arguments,
+    inputs=inputs,
+    outputs=outputs,
+    env = {
+    }
   )
 
 
@@ -81,7 +100,9 @@ def _protoc_rule_impl(ctx):
 
   gendir = _get_gendir(ctx)
   outdir = gendir
-  #outdir = gendir + "/" + ctx.label.package
+
+  if ctx.attr.output_to_workspace:
+    outdir = "."
 
   self = {
     "ctx": ctx,
@@ -220,11 +241,17 @@ def implement(spec):
     invoke("implement_compile_outputs", lang, self)
     invoke("implement_compile_output_to_genfiles", lang, self)
 
-  # Generation location.  cpp requires genfiles, everyone else not.
+  # Flag to place generated files in bazel-genfiles.  cpp requires
+  # genfiles, everyone else not.
   attrs["output_to_genfiles"] = attr.bool(
     default = self["output_to_genfiles"],
   )
 
+  # Flag to place generated files in the bazel workspace.  May violate sandbox constraints.
+  attrs["output_to_workspace"] = attr.bool(
+    default = False,
+  )
+
   return rule(
     implementation = _protoc_rule_impl,
     attrs = self["attrs"],

examples/helloworld/grpc_gateway/BUILD

@@ -5,10 +5,29 @@ load("//bzl:go/class.bzl", GO = "CLASS")
 load("//bzl:grpc_gateway/class.bzl", GRPC_GATEWAY = "CLASS")
 load("//bzl:grpc_gateway/rules.bzl", "grpc_gateway_proto_library", "grpc_gateway_binary")
 
+
+go_test(
+    name = "greeter_test",
+    size = "small",
+    srcs = [
+        "greeter.go",
+        "greeter_test.go",
+    ],
+    deps = [
+        ":gateway",
+        "//examples/helloworld/go/server:greeter",
+        "//examples/helloworld/proto:go",
+        "@com_github_golang_protobuf//:jsonpb",
+    ] + GRPC_GATEWAY.grpc.compile_deps,
+)
+
+# Alternate form
+#
 # grpc_gateway_proto_library(
 #     name = "gateway",
+#     output_to_workspace = True,
 #     protos = ["helloworld.proto"],
-#     verbose = 2,
+#     verbose = 0,
 # )
 
 grpc_gateway_binary(
@@ -32,19 +51,3 @@ grpc_gateway_binary(
 #         "@org_golang_x_net//:context",
 #     ],
 # )
-
-
-go_test(
-    name = "greeter_test",
-    size = "small",
-    srcs = [
-        "greeter.go",
-        "greeter_test.go",
-    ],
-    deps = [
-        ":gateway",
-        "//examples/helloworld/go/server:greeter",
-        "//examples/helloworld/proto:go",
-        "@com_github_golang_protobuf//:jsonpb",
-    ] + GRPC_GATEWAY.grpc.compile_deps,
-)