-
Notifications
You must be signed in to change notification settings - Fork 522
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace genrules with copy_file/write_file rules (#658)
The new rules are in bazel_skylib 0.8.0. Their advantages over genrule are: - cleaner rule interface - no Bash required on Windows - compatible with Bazel's Bash-less test execution on Windows See bazelbuild/bazel#6622
- Loading branch information
1 parent
688774b
commit 843d8e4
Showing
7 changed files
with
290 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
third_party/github.com/bazelbuild/bazel-skylib/rules/copy_file.bzl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Copyright 2019 The Bazel Authors. All rights reserved. | ||
| # | ||
| # 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. | ||
|
|
||
| """A rule that copies a file to another place. | ||
| native.genrule() is sometimes used to copy files (often wishing to rename them). | ||
| The 'copy_file' rule does this with a simpler interface than genrule. | ||
| The rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command | ||
| on Windows (no Bash is required). | ||
| """ | ||
|
|
||
| load( | ||
| "//third_party/github.com/bazelbuild/bazel-skylib:rules/private/copy_file_private.bzl", | ||
| _copy_file = "copy_file", | ||
| ) | ||
|
|
||
| copy_file = _copy_file |
130 changes: 130 additions & 0 deletions
130
third_party/github.com/bazelbuild/bazel-skylib/rules/private/copy_file_private.bzl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # Copyright 2019 The Bazel Authors. All rights reserved. | ||
| # | ||
| # 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. | ||
|
|
||
| """Implementation of copy_file macro and underlying rules. | ||
| These rules copy a file to another location using Bash (on Linux/macOS) or | ||
| cmd.exe (on Windows). '_copy_xfile' marks the resulting file executable, | ||
| '_copy_file' does not. | ||
| """ | ||
|
|
||
| def _common_impl(ctx, is_executable): | ||
| if ctx.attr.is_windows: | ||
| # Most Windows binaries built with MSVC use a certain argument quoting | ||
| # scheme. Bazel uses that scheme too to quote arguments. However, | ||
| # cmd.exe uses different semantics, so Bazel's quoting is wrong here. | ||
| # To fix that we write the command to a .bat file so no command line | ||
| # quoting or escaping is required. | ||
| bat = ctx.actions.declare_file(ctx.label.name + "-cmd.bat") | ||
| ctx.actions.write( | ||
| output = bat, | ||
| # Do not use lib/shell.bzl's shell.quote() method, because that uses | ||
| # Bash quoting syntax, which is different from cmd.exe's syntax. | ||
| content = "@copy /Y \"%s\" \"%s\" >NUL" % ( | ||
| ctx.file.src.path.replace("/", "\\"), | ||
| ctx.outputs.out.path.replace("/", "\\"), | ||
| ), | ||
| is_executable = True, | ||
| ) | ||
| ctx.actions.run( | ||
| inputs = [ctx.file.src, bat], | ||
| outputs = [ctx.outputs.out], | ||
| executable = "cmd.exe", | ||
| arguments = ["/C", bat.path.replace("/", "\\")], | ||
| mnemonic = "CopyFile", | ||
| progress_message = "Copying files", | ||
| use_default_shell_env = True, | ||
| ) | ||
| else: | ||
| ctx.actions.run_shell( | ||
| inputs = [ctx.file.src], | ||
| outputs = [ctx.outputs.out], | ||
| command = "cp -f \"$1\" \"$2\"", | ||
| arguments = [ctx.file.src.path, ctx.outputs.out.path], | ||
| mnemonic = "CopyFile", | ||
| progress_message = "Copying files", | ||
| use_default_shell_env = True, | ||
| ) | ||
|
|
||
| files = depset(direct = [ctx.outputs.out]) | ||
| runfiles = ctx.runfiles(files = [ctx.outputs.out]) | ||
| if is_executable: | ||
| return [DefaultInfo(files = files, runfiles = runfiles, executable = ctx.outputs.out)] | ||
| else: | ||
| return [DefaultInfo(files = files, runfiles = runfiles)] | ||
|
|
||
| def _impl(ctx): | ||
| return _common_impl(ctx, False) | ||
|
|
||
| def _ximpl(ctx): | ||
| return _common_impl(ctx, True) | ||
|
|
||
| _ATTRS = { | ||
| "src": attr.label(mandatory = True, allow_single_file = True), | ||
| "out": attr.output(mandatory = True), | ||
| "is_windows": attr.bool(mandatory = True), | ||
| } | ||
|
|
||
| _copy_file = rule( | ||
| implementation = _impl, | ||
| provides = [DefaultInfo], | ||
| attrs = _ATTRS, | ||
| ) | ||
|
|
||
| _copy_xfile = rule( | ||
| implementation = _ximpl, | ||
| executable = True, | ||
| provides = [DefaultInfo], | ||
| attrs = _ATTRS, | ||
| ) | ||
|
|
||
| def copy_file(name, src, out, is_executable = False, **kwargs): | ||
| """Copies a file to another location. | ||
| `native.genrule()` is sometimes used to copy files (often wishing to rename them). The 'copy_file' rule does this with a simpler interface than genrule. | ||
| This rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command on Windows (no Bash is required). | ||
| Args: | ||
| name: Name of the rule. | ||
| src: A Label. The file to make a copy of. (Can also be the label of a rule | ||
| that generates a file.) | ||
| out: Path of the output file, relative to this package. | ||
| is_executable: A boolean. Whether to make the output file executable. When | ||
| True, the rule's output can be executed using `bazel run` and can be | ||
| in the srcs of binary and test rules that require executable sources. | ||
| **kwargs: further keyword arguments, e.g. `visibility` | ||
| """ | ||
| if is_executable: | ||
| _copy_xfile( | ||
| name = name, | ||
| src = src, | ||
| out = out, | ||
| is_windows = select({ | ||
| "@bazel_tools//src/conditions:host_windows": True, | ||
| "//conditions:default": False, | ||
| }), | ||
| **kwargs | ||
| ) | ||
| else: | ||
| _copy_file( | ||
| name = name, | ||
| src = src, | ||
| out = out, | ||
| is_windows = select({ | ||
| "@bazel_tools//src/conditions:host_windows": True, | ||
| "//conditions:default": False, | ||
| }), | ||
| **kwargs | ||
| ) |
85 changes: 85 additions & 0 deletions
85
third_party/github.com/bazelbuild/bazel-skylib/rules/private/write_file_private.bzl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # Copyright 2019 The Bazel Authors. All rights reserved. | ||
| # | ||
| # 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. | ||
|
|
||
| """Implementation of write_file macro and underlying rules. | ||
| These rules write a UTF-8 encoded text file, using Bazel's FileWriteAction. | ||
| '_write_xfile' marks the resulting file executable, '_write_file' does not. | ||
| """ | ||
|
|
||
| def _common_impl(ctx, is_executable): | ||
| # ctx.actions.write creates a FileWriteAction which uses UTF-8 encoding. | ||
| ctx.actions.write( | ||
| output = ctx.outputs.out, | ||
| content = "\n".join(ctx.attr.content) if ctx.attr.content else "", | ||
| is_executable = is_executable, | ||
| ) | ||
| files = depset(direct = [ctx.outputs.out]) | ||
| runfiles = ctx.runfiles(files = [ctx.outputs.out]) | ||
| if is_executable: | ||
| return [DefaultInfo(files = files, runfiles = runfiles, executable = ctx.outputs.out)] | ||
| else: | ||
| return [DefaultInfo(files = files, runfiles = runfiles)] | ||
|
|
||
| def _impl(ctx): | ||
| return _common_impl(ctx, False) | ||
|
|
||
| def _ximpl(ctx): | ||
| return _common_impl(ctx, True) | ||
|
|
||
| _ATTRS = { | ||
| "content": attr.string_list(mandatory = False, allow_empty = True), | ||
| "out": attr.output(mandatory = True), | ||
| } | ||
|
|
||
| _write_file = rule( | ||
| implementation = _impl, | ||
| provides = [DefaultInfo], | ||
| attrs = _ATTRS, | ||
| ) | ||
|
|
||
| _write_xfile = rule( | ||
| implementation = _ximpl, | ||
| executable = True, | ||
| provides = [DefaultInfo], | ||
| attrs = _ATTRS, | ||
| ) | ||
|
|
||
| def write_file(name, out, content = [], is_executable = False, **kwargs): | ||
| """Creates a UTF-8 encoded text file. | ||
| Args: | ||
| name: Name of the rule. | ||
| out: Path of the output file, relative to this package. | ||
| content: A list of strings. Lines of text, the contents of the file. | ||
| Newlines are added automatically after every line except the last one. | ||
| is_executable: A boolean. Whether to make the output file executable. When | ||
| True, the rule's output can be executed using `bazel run` and can be | ||
| in the srcs of binary and test rules that require executable sources. | ||
| **kwargs: further keyword arguments, e.g. `visibility` | ||
| """ | ||
| if is_executable: | ||
| _write_xfile( | ||
| name = name, | ||
| content = content, | ||
| out = out, | ||
| **kwargs | ||
| ) | ||
| else: | ||
| _write_file( | ||
| name = name, | ||
| content = content, | ||
| out = out, | ||
| **kwargs | ||
| ) |
30 changes: 30 additions & 0 deletions
30
third_party/github.com/bazelbuild/bazel-skylib/rules/write_file.bzl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Copyright 2019 The Bazel Authors. All rights reserved. | ||
| # | ||
| # 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. | ||
|
|
||
| """A rule that writes a UTF-8 encoded text file from user-specified contents. | ||
| native.genrule() is sometimes used to create a text file. The 'write_file' and | ||
| macro does this with a simpler interface than genrule. | ||
| The rules generated by the macro do not use Bash or any other shell to write the | ||
| file. Instead they use Starlark's built-in file writing action | ||
| (ctx.actions.write). | ||
| """ | ||
|
|
||
| load( | ||
| "//third_party/github.com/bazelbuild/bazel-skylib:rules/private/write_file_private.bzl", | ||
| _write_file = "write_file", | ||
| ) | ||
|
|
||
| write_file = _write_file |