BAZEL + bash：执行 bash/python 脚本进行代码生成并在 bazel 系统中使用

Question

我是 Bazel 的新手。我有一个用 Bazel 构建的项目。 但是一些源文件是预先编码生成的，然后用 Bazel 编译它们。 现在我可以独立运行 bash 脚本并运行 bazel 命令：

.
|-- project
|   |-- BUILD (will depend on temp_output:codegen)
|   |-- scripts
|   |   |-- codegen.sh (read config.yaml and generate codegen.cpp/hpp and a BUILD.bazel)
|   |-- config
|   |   |-- config.yaml
|   |-- temp_output
|   |   |-- codegen.cpp (not existed before running codegen.sh)
|   |   |-- codegen.hpp (not existed before running codegen.sh)
|   |   |-- BAZEL.build (not existed before running codegen.sh)
|-- WORKSPACE



$ ./scripts/codegen.sh
$ bazel build :project

codegen.sh 中做了什么：

1. 阅读 config.yaml，其中包含一些其他 WORKSPACE 路径和名称。
2. 查询该 WORKSPACE 中的目标。
3. 创建 cpp/hpp 文件以包含一些头文件。
4. 创建一个新的 BUILD 文件，添加依赖这些目标。

我的目标是将 bash 脚本嵌入到 bazel 系统中。我尝试使用规则 + action.run。但失败的原因是：

1. 沙盒目录不可读写。
2. 在沙盒中找不到输入文件。

有什么奇特的方法可以做到这一点吗？或者有什么可以参考的例子？

Answer 1

执行此操作的简单方法是使用genrule。 project/BUILD 中的类似内容：

genrule(
    name = "run_codegen",
    srcs = [
        "codegen.sh",
        "config.yaml",
    ],
    outs = [
        "codegen.cpp",
        "codegen.hpp",
    ],
    cmd = "$(location codegen.sh) --config $(location config.yaml) --cpp $(location codegen.cpp) --hpp $(location codegen.hpp)",
)

cc_library(
    name = "codegen",
    hdrs = [ "codegen.hpp" ],
    srcs = [ "codegen.cpp" ],
)

注意事项：

• 使用$(location) 获取输入和输出文件的路径。如果脚本使用相对路径，我会修改它以将路径作为参数，或者编写一个包装脚本来创建一个临时目录并根据标志将内容移入/移出那里。创建路径的唯一其他可靠方法是使用 "make" variables，但这些方法通常更难使用，并且相对于对 genrule 的修改更脆弱。
• 未生成BUILD 文件。您只能通过repository rule 执行此操作，并且它变得更加复杂。对于这个用例，我认为您不需要，只需将规则写入project/BUILD。

如果您出于某种原因想要将其嵌入规则而不是使用 genrule，请确保您使用 File.path 来获取要嵌入命令的所有路径。这相当于$(location)。如果没有看到它的副本，很难更具体地说明为什么您的规则不起作用。