Merge pull request #2 from pauldraper/pauldraper/black

Convert black to worker

Author: Jake Gutierrez

.bazelversion

@@ -1 +1 @@
-5.0.0-pre.20211011.2
+5.3.0

README.md

@@ -1,22 +1,205 @@
 # rules_file
 
-Bazel rules for basic file operations, like creating directories, and formatting.
+Bazel rules for basic file operations, such as creating directories and formatting.
 
-## Example
+## Directory
 
-To use buildifier as a formatter,
+Create a directory from files:
+
+```bzl
+load("@rules_file//file:rules.bzl", "directory")
+
+directory(
+    name = "example",
+    srcs = glob(["**/*.txt"]),
+)
+```
+
+Create a directory from a tarball:
+
+```bzl
+load("@rules_file//file:rules.bzl", "untar")
+
+untar(
+    name = "example",
+    src = "example.tar",
+)
+```
+
+## Package-less Files
+
+Access files without regard to package structure. This can be helpful for formatting or Bazel integration tests.
+
+### Workspace Example
+
+Create a new repository containing all workspace files.
 
 **WORKSPACE.bazel**
 
 ```bzl
-workspace(name = "example")
+files(
+    name = "files"
+    build = "BUILD.file.bazel",
+    root_file = "//:WORKSPACE.bazel",
+)
+```
+
+**BAZEL.bazel**
+
+```
+load("@rules_file//file:rules.bzl", "bazelrc_deleted_packages")
+
+bazelrc_deleted_packages(
+    name = "gen_bazelrc",
+    output = "deleted.bazelrc",
+    packages = ["@files//:packages"],
+)
+```
+
+**files.bazel**
+
+```bzl
+# note: files is the symlink to the workspace
+filegroup(
+    name = "example",
+    srcs = glob(["files/**/*.txt"]),
+    visibility = ["//visibility:public"],
+)
+```
+
+Generate deleted.bazelrc:
+
+```
+bazel run :gen_bazelrc
+```
+
+**.bazelrc**
+
+```
+import %workspace%/deleted.bazelrc
+```
+
+Now `@files//:example` is all \*.txt files in the workspace.
+
+### Bazel Integration Test Example
+
+Use files in the test directory as data for a Bazel integration test.
+
+**BAZEL.bazel**
+
+```
+load("@rules_file//file:rules.bzl", "bazelrc_deleted_packages", "find_packages")
+
+filegroup(
+    name = "test",
+    srcs = glob(["test/**/*.bazel" "test/**/*.txt"]),
+)
+
+find_packages(
+    name = "test_packages",
+    roots = ["test"],
+)
+
+bazelrc_deleted_packages(
+    name = "gen_bazelrc",
+    output = "deleted.bazelrc",
+    packages = [":test_packages"],
+)
+```
+
+Generate `deleted.bazelrc` by running:
+
+```
+bazel run :gen_bazelrc
+```
 
-load("@rules_file//file:workspace.bzl", "files")
+**.bazelrc**
+
+```
+import %workspace%/deleted.bazelrc
+```
+
+## Generate
+
+In some cases, it is necessary to version control build products in the workspace (bootstrapping, working with other tools).
+
+These rules build the outputs, and copy them to the workspace or check for differences.
+
+**BUILD.bazel**
+
+```bzl
+load("@rules_file//file:rules.bzl", "bazelrc_deleted_packages")
+load("@rules_file//file:rules.bzl", "generate", "generate_test")
+
+genrule(
+    name = "example",
+    cmd = "echo GENERATED! > $@",
+    outs = ["out/example.txt"],
+)
+
+generate(
+    name = "example_gen",
+    srcs = "example.txt",
+    data = ["out/example.txt"],
+    data_strip_prefix = "out",
+)
+
+generate_test(
+    name = "example_diff",
+    generate = ":example_gen",
+)
+
+bazelrc_deleted_packages(
+    name = "gen_bazelrc",
+    output = "deleted.bazelrc",
+    packages = ["@files//:packages"],
+)
+```
+
+
+
+To overwrite the workspace file:
+
+```bzl
+bazel run :example_gen
+```
+
+To check for differences (e.g. in CI):
+
+```bzl
+bazel test :example_diff
+```
+
+## Format
+
+Formatting is a particular case of the checked-in build products pattern.
+
+The code formatting is a regular Bazel action. The formatted result can be using to overwrite workspace files, or to check for differences.
+
+This repository has rules for buildifier, black, and gofmt. It is also used for [prettier](https://github.com/rivethealth/rules_javascript).
+
+### Buildifier Example
+
+**WORKSPACE.bazel**
+
+```bzl
+BUILDTOOLS_VERSION = "3.5.0"
+
+http_archive(
+    name = "com_github_bazelbuild_buildtools",
+    sha256 = "f5b666935a827bc2b6e2ca86ea56c796d47f2821c2ff30452d270e51c2a49708",
+    strip_prefix = "buildtools-%s" % BUILDTOOLS_VERSION,
+    url = "https://github.com/bazelbuild/buildtools/archive/%s.zip" % BUILDTOOLS_VERSION,
+)
+
+load("@com_github_bazelbuild_buildtools//buildifier:deps.bzl", "buildifier_dependencies")
+
+buildifier_dependencies()
 
 files(
-    name = "example_files"
+    name = "files"
     build = "BUILD.file.bazel",
-    root_file = "@example//WORKSPACE.bazel",
+    root_file = "//:WORKSPACE.bazel",
 )
 ```
 
@@ -31,23 +214,21 @@ buildifier(
 )
 
 format(
-    name = "format",
-    srcs = ["@example_files//:buildifier_files"],
+    name = "buildifier_format",
+    srcs = ["@files//:buildifier_files"],
     formatter = ":buildifier",
     strip_prefix = "files",
 )
 
 generate_test(
-    name = "test",
+    name = "buildifier_diff",
     generate = ":format",
 )
 ```
 
-**BUILD.file.bazel**
+**files.bazel**
 
 ```bzl
-package(default_visibility = ["//visibility:public"])
-
 filegroup(
     name = "buildifier_files",
     srcs = glob(
@@ -57,23 +238,31 @@ filegroup(
             "files/**/BUILD",
             "files/**/WORKSPACE",
         ],
-        ["**/bazel-*/**"],
     ),
+    visibility = ["//visibility:public"],
 )
 ```
 
-Then run
+Generate deleted.bazelrc:
+
+```
+bazel run :gen_bazelrc
+```
+
+**.bazelrc**
+
+```
+import %workspace%/deleted.bazelrc
+```
+
+To format:
+
+```sh
+bazel run :buildifier_format
+```
+
+To check format:
 
 ```sh
-packages="$(\
-    find .-name BUILD -o -name BUILD.bazel \
-    | sed -e 's:/[^/]*$::' -e 's:^\./::' -e 's:^:@example_files//files/:' -e 's:/.$::' \
-    | tr '\n' , \
-    | sed 's/,$//' \
-)"
-
-# format
-bazel run "--deleted_packages=$packages" //:format
-# test
-bazel run "--deleted_packages=$packages" //:test
+bazel run :buildifier_diff
 ```

WORKSPACE.bazel

@@ -73,14 +73,24 @@ load("@com_github_bazelbuild_buildtools//buildifier:deps.bzl", "buildifier_depen
 
 buildifier_dependencies()
 
+# Rivet Bazel Util
+RIVET_BAZEL_UTIL_VERSION = "f0c1bbe0935c3994e4c1ea4b3370a47d8df9819e"
+
+http_archive(
+    name = "rivet_bazel_util",
+    sha256 = "3d89e5037d34e7fb5202f7ca7d6b26e008de1c27e97bd0c257fa362c3d61240e",
+    strip_prefix = "rivet-bazel-util-%s" % RIVET_BAZEL_UTIL_VERSION,
+    url = "https://github.com/rivethealth/rivet-bazel-util/archive/%s.zip" % RIVET_BAZEL_UTIL_VERSION,
+)
+
 # Format
 
 load("//file:workspace.bzl", "files")
 
 files(
-    name = "rules_file_files",
-    build = "@rules_file//:BUILD.file.bazel",
-    root_file = "@rules_file//:WORKSPACE.bazel",
+    name = "files",
+    build = "@rules_file//:files.bazel",
+    root_file = "//:WORKSPACE.bazel",
 )
 
 load("//rules:init.bzl", "file_init")

black/format/BUILD.bazel

@@ -0,0 +1,6 @@
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "src",
+    srcs = glob(["src/**/*.py"]),
+)

black/format/src/__main__.py

@@ -0,0 +1,67 @@
+import argparse
+import black
+import contextlib
+import io
+import pathlib
+import setproctitle
+import sys
+from bazelwatcher2 import worker
+
+setproctitle.setproctitle("black-worker")
+
+parser = argparse.ArgumentParser(prog="black-worker")
+parser.add_argument("--black-option", action="append", default=[], dest="black_options")
+parser.add_argument("src", type=pathlib.Path)
+parser.add_argument("dest", type=pathlib.Path)
+
+
+@contextlib.contextmanager
+def _detach_wrapper(wrapper):
+    try:
+        yield wrapper
+    finally:
+        wrapper.detach()
+
+
+@contextlib.contextmanager
+def _modify_std():
+    real_stdin = sys.stdin
+    real_stderr = sys.stderr
+    real_stdout = sys.stdout
+    try:
+        yield
+    finally:
+        sys.stdin = real_stdin
+        sys.stdout = real_stdout
+        sys.stderr = real_stderr
+
+
+def _run(args):
+    args = parser.parse_args(args)
+
+    output = io.BytesIO()
+    try:
+        with _modify_std(), args.src.open() as stdin, args.dest.open(
+            "w"
+        ) as stdout, _detach_wrapper(
+            io.TextIOWrapper(output, write_through=True)
+        ) as stderr:
+            sys.stdin = stdin
+            sys.stdout = stdout
+            sys.stderr = stderr
+            black.main(
+                args.black_options + ["-q", "--stdin-filename", str(args.src), "-"]
+            )
+    except SystemExit as e:
+        exit_code = e.code
+    else:
+        exit_code = 0
+
+    return worker.WorkResult(exit_code=exit_code, output=output.getvalue())
+
+
+def _worker_factory(_):
+    return lambda args, _: _run(args)
+
+
+worker.main(_worker_factory)