使用宏创建自定义动词

报告问题 查看源代码

与 Bazel 的日常互动主要通过以下几个命令进行:buildtestrun。但有时,您可能会感觉受到限制:您可能想要将软件包推送到代码库、为最终用户发布文档,或使用 Kubernetes 部署应用。但是 Bazel 没有 publishdeploy 命令 - 这些操作分别适合何处?

bazel run 命令

Bazel 注重封闭性、可再现性和增量,这意味着 buildtest 命令对上述任务没有帮助。这些操作可能会在沙盒中运行,具有有限的网络访问权限,并且不保证会针对每个 bazel build 重新运行这些操作。

而应使用 bazel run:对于您希望对其产生副作用的任务而言,它是一项主力资源。Bazel 用户已习惯创建可执行文件的规则,而规则作者可以遵循一组常见的模式,将其扩展到“自定义动词”。

实际应用:rules_k8s

rules_k8s(适用于 Bazel 的 Kubernetes 规则)为例。假设您有以下目标:

# BUILD file in //application/k8s
k8s_object(
    name = "staging",
    kind = "deployment",
    cluster = "testing",
    template = "deployment.yaml",
)

staging 目标上使用 bazel build 时,k8s_object 规则会构建标准 Kubernetes YAML 文件。不过,其他目标也由 k8s_object 宏创建,名称类似于 staging.apply:staging.delete。这些构建脚本用来执行这些操作,使用 bazel run staging.apply 执行时,这些脚本的行为类似于我们自己的 bazel k8s-applybazel k8s-delete 命令。

另一个示例:ts_api_guardian_test

在 Angular 项目中也可以看到此模式。ts_api_guardian_test会生成两个目标。第一个是标准的 nodejs_test 目标,它会将一些生成的输出与“黄金”文件(即包含预期输出的文件)进行比较。这可以通过常规的 bazel test 调用进行构建和运行。在 angular-cli 中,您可以使用 bazel test //etc/api:angular_devkit_core_api 运行一个此类目标

随着时间的推移,该黄金文件可能会因合理原因而需要更新。 手动更新此文件既繁琐又容易出错,因此此宏还提供了一个 nodejs_binary 目标,用于更新黄金文件,而不是与其进行比较。实际上,可以编写相同的测试脚本,使其根据调用方式在“验证”或“接受”模式下运行。这遵循您已了解的模式:没有原生 bazel test-accept 命令,但使用 bazel run //etc/api:angular_devkit_core_api.accept 可以实现相同的效果。

这种模式可能非常强大,一旦您学会识别它,它便会很常见。

调整您自己的规则

是此模式的核心。宏的使用方式与规则类似,但可以创建多个目标。通常,他们会使用指定名称创建一个执行主要构建操作的目标:可能会构建普通二进制文件、Docker 映像或源代码的归档。在此模式中,系统会创建其他目标,以生成根据主要目标的输出执行附带效应(例如发布生成的二进制文件或更新预期的测试输出)的脚本。

为了说明这一点,可以用 Sphinx 封装一条虚拟规则,用宏创建一个额外的目标,让用户可以在准备就绪后发布网站。请参考以下使用 Sphinx 生成网站的现有规则:

_sphinx_site = rule(
     implementation = _sphinx_impl,
     attrs = {"srcs": attr.label_list(allow_files = [".rst"])},
)

接下来,请考虑如下规则,该规则会构建一个脚本,在运行时发布生成的页面:

_sphinx_publisher = rule(
    implementation = _publish_impl,
    attrs = {
        "site": attr.label(),
        "_publisher": attr.label(
            default = "//internal/sphinx:publisher",
            executable = True,
        ),
    },
    executable = True,
)

最后,定义以下宏,以同时为上述两条规则创建目标:

def sphinx_site(name, srcs = [], **kwargs):
    # This creates the primary target, producing the Sphinx-generated HTML.
    _sphinx_site(name = name, srcs = srcs, **kwargs)
    # This creates the secondary target, which produces a script for publishing
    # the site generated above.
    _sphinx_publisher(name = "%s.publish" % name, site = name, **kwargs)

BUILD 文件中,使用该宏,就像它只创建主要目标一样:

sphinx_site(
    name = "docs",
    srcs = ["index.md", "providers.md"],
)

在此示例中,系统会创建一个“docs”目标,就像该宏是一条标准的单个 Bazel 规则一样。构建后,该规则会生成一些配置并运行 Sphinx 来生成一个 HTML 网站,以供手动检查。不过,系统还会创建额外的“docs.publish”目标,该目标会构建用于发布网站的脚本。检查主目标的输出后,您可以使用 bazel run :docs.publish 将其发布以供公开使用,就像虚构的 bazel publish 命令一样。

_sphinx_publisher 规则的实现方式并无明显差异。通常,此类操作会编写一个启动器 Shell 脚本。此方法通常涉及使用 ctx.actions.expand_template 编写非常简单的 Shell 脚本,在本示例中,使用主要目标的输出路径调用发布商二进制文件。这样一来,发布商实现就可以保持通用,_sphinx_site 规则只能生成 HTML,而只需将这两个小脚本组合在一起即可。

rules_k8s 中,.apply 的确会这样做:expand_template 基于 apply.sh.tpl 编写了一个非常简单的 Bash 脚本,该脚本会运行 kubectl 并输出主要目标的输出。然后,此脚本便可以与 bazel run :staging.apply 一起构建和运行,从而有效地为 k8s_object 目标提供 k8s-apply 命令。