在 WORKSPACE 规则中查找非封闭行为

报告问题 查看源代码

在下文中,宿主机是运行 Bazel 的机器。

使用远程执行时,实际的构建和/或测试步骤不是在主机上进行的,而是发送到远程执行系统。但是,解析工作区规则所涉及的步骤发生在主机上。如果您的工作区规则访问有关在执行期间使用的主机的信息,您的构建可能会因环境之间的不兼容而中断。

调整 Bazel 规则以实现远程执行的过程中,您需要找到并修复此类工作区规则。本页面介绍如何使用工作区日志查找可能存在问题的工作区规则。

查找非封闭规则

工作区规则允许开发者将依赖项添加到外部工作区,但它们足够丰富,允许在此过程中执行任意处理。所有相关命令都是在本地执行的,并且可能是非封闭的。通常,非封闭行为是通过 repository_ctx 引入的,这允许与宿主机互动。

从 Bazel 0.18 开始,您可以通过向 Bazel 命令添加 --experimental_workspace_rules_log_file=[PATH] 标志来获取一些非封闭操作的日志。此处的 [PATH] 是将用于创建日志的文件名。

需注意的事项:

  • 日志会在事件执行时捕获这些事件。如果某些步骤已缓存,则它们不会显示在日志中,因此,为了获得完整的结果,请务必提前运行 bazel clean --expunge

  • 有时函数可能会重新执行,在这种情况下,相关事件将在日志中多次出现。

  • Workspace 规则目前仅记录 Starlark 事件。

如需查找在工作区初始化期间执行了哪些操作,请执行以下操作:

  1. 运行 bazel clean --expunge。此命令将清理本地缓存和任何缓存代码库,确保所有初始化都将重新运行。

  2. --experimental_workspace_rules_log_file=/tmp/workspacelog 添加到 Bazel 命令中并运行构建。

    这会生成一个列出 WorkspaceEvent 类型消息的二进制 proto 文件

  3. 下载 Bazel 源代码,然后使用以下命令导航到 Bazel 文件夹。您需要源代码才能使用工作区日志解析器解析工作区日志。

    git clone https://github.com/bazelbuild/bazel.git
    cd bazel
    
  4. 在 Bazel 源代码库中,将整个工作区日志转换为文本。

    bazel build src/tools/workspacelog:parser
    bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog > /tmp/workspacelog.txt
    
  5. 输出可能会非常详细并包含来自 Bazel 规则的输出。

    要从输出中排除特定规则,请使用 --exclude_rule 选项。例如:

    bazel build src/tools/workspacelog:parser
    bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog \
        --exclude_rule "//external:local_config_cc" \
        --exclude_rule "//external:dep" > /tmp/workspacelog.txt
    
  6. 打开 /tmp/workspacelog.txt 并检查是否存在不安全的操作。

该日志包含 WorkspaceEvent 消息,其中概述了对 repository_ctx 执行的某些可能的非封闭操作。

突出显示为可能非封闭的操作如下:

  • execute:在主机环境中执行任意命令。检查这些配置是否会在主机环境中引入任何依赖项。

  • downloaddownload_and_extract:为确保封闭构建,请务必指定 sha256

  • filetemplate:这本身不是封闭的,但可能是一种将主机环境依赖项引入代码库的机制。确保您了解输入的来源,并且不依赖于主机环境。

  • os:这本身并不是封闭的,而是让您轻松获得主机环境中的依赖项。封闭构建通常不会这样命名。在评估您的使用情况是否处于封闭状态时,请注意,此设置在主机上运行,而不是在工作器上运行。从主机获取环境细节通常不适合远程构建。

  • symlink:这通常安全,但会查找危险信号。指向代码库外部或绝对路径的任何符号链接都会导致远程工作器出现问题。如果符号链接是基于主机属性创建的,可能也会出现问题。

  • which:检查主机上安装的程序通常是有问题的,因为工作器可能具有不同的配置。