如何在Bazel中校验--action_env参数值有效性并全局执行？

问题背景 #

在基于Bazel的项目里，我通过--action_env手动修改构建环境来避免不必要的缓存命中（这是复杂方案的临时替代手段）。目前我用Shell脚本包裹bazel run，添加--action_env和--host_action_env并校验参数值的有效性，现在想把校验逻辑移入Bazel体系，让每次执行bazel build时都触发校验。但我尝试创建的check_environment_variables规则并未执行，相关代码如下：

BUILD文件 #

load("//:check_env.bzl", "check_environment_variables")
check_environment_variables()

check_env.bzl文件 #

def _check_environment_variables(ctx):
    my_env = ctx.attr.env_var["MY_ENV"]
    print("provided value for MY_ENV:", my_env)
    if not my_env == "foo":
        fail("MY_ENV must be set to 'foo'")
    return []    

check_environment_variables = rule(
    implementation=_check_environment_variables,
    attrs={},
)

问题原因 #

你的规则未执行主要有两个原因：

1. 该规则既没有产出可被其他目标依赖的产物，也没有被任何构建目标依赖，Bazel的构建图会自动跳过这类无依赖的孤立规则
2. 规则实现里直接访问ctx.attr.env_var，但attrs中并未定义这个属性；同时，获取构建环境变量应该用ctx.os.environ，而非自定义属性

可行解决方案 #

方案1：使用repository_rule（推荐） #

repository_rule会在构建初始化阶段执行，无需依赖任何目标，只要环境变量变化就会重新触发，非常适合全局环境校验：

修改check_env.bzl：

def _check_env_repo_impl(ctx):
    my_env = ctx.os.environ.get("MY_ENV")
    if not my_env == "foo":
        fail("MY_ENV must be set to 'foo'")
    # 生成空的BUILD文件让仓库合法
    ctx.file("BUILD", "")

check_env_repo = repository_rule(
    implementation = _check_env_repo_impl,
    environ = ["MY_ENV"],  # 声明依赖的环境变量，变量变化时自动重新执行
)

在WORKSPACE文件中加载并调用该规则：

load("//:check_env.bzl", "check_env_repo")
check_env_repo(name = "check_my_env")

方案2：普通规则绑定到所有构建目标 #

如果需要在构建阶段执行校验，可以让所有目标依赖这个规则：

修改check_env.bzl：

def _check_env_impl(ctx):
    my_env = ctx.os.environ.get("MY_ENV")
    if not my_env == "foo":
        fail("MY_ENV must be set to 'foo'")
    # 返回空的DefaultInfo标记规则执行完成
    return [DefaultInfo()]

check_environment_variables = rule(
    implementation = _check_env_impl,
    attrs = {},
    environ = ["MY_ENV"],  # 声明依赖的环境变量
)

在BUILD文件中，让所有需要校验的目标依赖该规则：

load("//:check_env.bzl", "check_environment_variables")

check_environment_variables(name = "check_my_env")

# 示例：让C++二进制目标依赖校验规则
cc_binary(
    name = "my_bin",
    srcs = ["main.cc"],
    deps = [":check_my_env"],
)

关键注意点 #

• 无论哪种方案，都必须通过environ属性声明依赖的环境变量，这样Bazel才能感知变量变化，确保校验逻辑在变量更新时重新执行
• repository_rule的执行时机更早，适合全局环境检查；普通规则则需要被目标依赖才能触发，适合针对特定构建流程的校验

内容的提问来源于stack exchange，提问作者frans