[py] Replace devtools genrule with proper generate_devtools rule. (#11392)

jameshilliard · web-flow · commit b803c6862437 · 2023-01-25T11:55:09.000+01:00
The existing genrule does not handle directories properly.
diff --git a/WORKSPACE b/WORKSPACE
@@ -229,12 +229,6 @@ rules_closure_toolchains()
 
 http_archive(
     name = "rules_pkg",
-    patch_args = [
-        "-p1",
-    ],
-    patches = [
-        "//py:rules_pkg_tree.patch",
-    ],
     sha256 = "eea0f59c28a9241156a47d7a8e32db9122f3d50b505fae0f33de6ce4d9b61834",
     urls = [
         "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.8.0/rules_pkg-0.8.0.tar.gz",
diff --git a/py/BUILD.bazel b/py/BUILD.bazel
@@ -4,7 +4,7 @@ load("@rules_python//python:defs.bzl", "py_binary", "py_library")
 load("@rules_python//python:packaging.bzl", "py_package", "py_wheel")
 load("@py_dev_requirements//:requirements.bzl", "requirement")
 load("//common:defs.bzl", "copy_file")
-load("//py:defs.bzl", "py_test_suite")
+load("//py:defs.bzl", "generate_devtools", "py_test_suite")
 load("//py/private:browsers.bzl", "BROWSERS")
 load("//py/private:import.bzl", "py_import")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
@@ -273,18 +273,14 @@ py_binary(
     deps = [requirement("inflection")],
 )
 
-[genrule(
-    name = "create-cdp-srcs-" + n,
-    srcs = [
-        "//common/devtools/chromium/" + n + ":browser_protocol",
-        "//common/devtools/chromium/" + n + ":js_protocol",
-    ],
-    outs = ["selenium/webdriver/common/devtools/" + n],
-    cmd = "$(location :generate) $(location //common/devtools/chromium/" + n + ":browser_protocol) $(location //common/devtools/chromium/" + n + ":js_protocol) $@",
-    tools = [
-        ":generate",
-    ],
-) for n in BROWSER_VERSIONS]
+[generate_devtools(
+    name = "create-cdp-srcs-{}".format(devtools_version),
+    outdir = "selenium/webdriver/common/devtools/{}".format(devtools_version),
+    browser_protocol = "//common/devtools/chromium/{}:browser_protocol".format(devtools_version),
+    generator = ":generate",
+    js_protocol = "//common/devtools/chromium/{}:js_protocol".format(devtools_version),
+    protocol_version = devtools_version,
+) for devtools_version in BROWSER_VERSIONS]
 
 py_test_suite(
     name = "unit",
diff --git a/py/defs.bzl b/py/defs.bzl
@@ -1,7 +1,9 @@
+load("//py/private:generate_devtools.bzl", _generate_devtools = "generate_devtools")
 load("//py/private:import.bzl", _py_import = "py_import")
 load("//py/private:pytest.bzl", _pytest_test = "pytest_test")
 load("//py/private:suite.bzl", _py_test_suite = "py_test_suite")
 
+generate_devtools = _generate_devtools
 pytest_test = _pytest_test
 py_import = _py_import
 py_test_suite = _py_test_suite
diff --git a/py/generate.py b/py/generate.py
@@ -984,7 +984,6 @@ def main(browser_protocol_path, js_protocol_path, output_path):
         browser_protocol_path,
         js_protocol_path,
     ]
-    output_path.mkdir(parents=True)
 
     # Generate util.py
     util_path = output_path / "util.py"
diff --git a/py/private/generate_devtools.bzl b/py/private/generate_devtools.bzl
@@ -0,0 +1,50 @@
+def _generate_devtools_impl(ctx):
+    outdir = ctx.actions.declare_directory(ctx.attr.outdir)
+
+    args = ctx.actions.args()
+    args.add(ctx.file.browser_protocol)
+    args.add(ctx.file.js_protocol)
+    args.add(outdir.path)
+
+    ctx.actions.run(
+        executable = ctx.executable.generator,
+        progress_message = "Generating {} DevTools Protocol bindings for Python".format(ctx.attr.protocol_version),
+        arguments = [args],
+        outputs = [
+            outdir,
+        ],
+        inputs = [
+            ctx.file.browser_protocol,
+            ctx.file.js_protocol,
+        ],
+        use_default_shell_env = True,
+    )
+
+    return DefaultInfo(
+        files = depset([outdir]),
+        runfiles = ctx.runfiles(files = [outdir]),
+    )
+
+generate_devtools = rule(
+    implementation = _generate_devtools_impl,
+    attrs = {
+        "protocol_version": attr.string(
+            mandatory = True,
+            default = "",
+        ),
+        "browser_protocol": attr.label(
+            mandatory = True,
+            allow_single_file = True,
+        ),
+        "js_protocol": attr.label(
+            mandatory = True,
+            allow_single_file = True,
+        ),
+        "outdir": attr.string(),
+        "generator": attr.label(
+            executable = True,
+            cfg = "exec",
+        ),
+        "deps": attr.label_list(),
+    },
+)
diff --git a/py/rules_pkg_tree.patch b/py/rules_pkg_tree.patch

Original file line number	Diff line number	Diff line change
`@@ -984,7 +984,6 @@ def main(browser_protocol_path, js_protocol_path, output_path):`
`984`	`984`	`browser_protocol_path,`
`985`	`985`	`js_protocol_path,`
`986`	`986`	`]`
`987`		`- output_path.mkdir(parents=True)`
`988`	`987`
`989`	`988`	`# Generate util.py`
`990`	`989`	`util_path = output_path / "util.py"`