使用 Docker Sandbox 对 Bazel Remote Execution 进行问题排查

在本地成功的 Bazel 构建在远程执行时可能会失败，这是因为远程构建存在一些不会影响本地构建的限制和要求。为远程执行调整 Bazel 规则一文中介绍了此类失败的最常见原因。

本页面介绍了如何识别和解决使用 Docker 沙盒功能进行远程执行时出现的最常见问题。该功能对 build 施加的限制与远程执行相同。这样，您就可以在无需远程执行服务的情况下对 build 进行问题排查。

Docker 沙盒功能会模拟远程执行的限制，如下所示：

• 构建操作在工具链容器中执行。您可以使用相同的工具链容器，通过支持容器化远程执行的服务在本地和远程运行 build。

• 没有无关数据跨越容器边界。只有明确声明的输入和输出会进入和离开容器，并且只有在关联的 build 操作成功完成后才会发生这种情况。

• 每个操作都在一个全新的容器中执行。系统会为每个生成的 build 操作创建一个新的唯一容器。

您可以使用以下方法之一排查这些问题：

• 以原生方式排查问题。使用此方法，Bazel 及其构建操作会在本地机器上以原生方式运行。Docker 沙盒功能对构建施加的限制与远程执行的限制相同。不过，此方法不会检测到泄漏到 build 中的本地工具、状态和数据，这些泄漏会导致远程执行出现问题。

• 在 Docker 容器中进行问题排查。 使用此方法，Bazel 及其构建操作会在 Docker 容器内运行，这样一来，除了施加与远程执行相同的限制之外，您还可以检测从本地机器泄漏到构建中的工具、状态和数据。即使部分 build 失败，此方法也能让您深入了解 build。此方法为实验性方法，未获得官方支持。

前提条件

在开始排查问题之前，请先执行以下操作（如果您尚未这样做）：

• 安装 Docker 并配置运行 Docker 所需的权限。
• 安装 Bazel 0.14.1 或更高版本。早期版本不支持 Docker 沙盒功能。
• 按照此处的说明，将固定为使用最新版本的 bazel-toolchains 代码库添加到 build 的 WORKSPACE 文件中。
• 将标志添加到 .bazelrc 文件以启用该功能。在 Bazel 项目的根目录中创建该文件（如果尚不存在）。以下标志是参考示例。请参阅 bazel-toolchains 代码库中的最新 .bazelrc 文件，并复制其中为配置 docker-sandbox 定义的标志的值。

# Docker Sandbox Mode
build:docker-sandbox --host_javabase=<...>
build:docker-sandbox --javabase=<...>
build:docker-sandbox --crosstool_top=<...>
build:docker-sandbox --experimental_docker_image=<...>
build:docker-sandbox --spawn_strategy=docker --strategy=Javac=docker --genrule_strategy=docker
build:docker-sandbox --define=EXECUTOR=remote
build:docker-sandbox --experimental_docker_verbose
build:docker-sandbox --experimental_enable_docker_sandbox

如果您的规则需要其他工具，请执行以下操作：

1. 通过使用 Dockerfile 安装工具并构建本地映像，创建自定义 Docker 容器。

2. 将上述 --experimental_docker_image 标志的值替换为自定义容器映像的名称。

原生问题排查

此方法直接在本地计算机上执行 Bazel 及其所有构建操作，是一种可靠的方法，可用于确认您的构建在远程执行时是否会成功。

不过，使用此方法时，本地安装的工具、二进制文件和数据可能会泄露到您的 build 中，尤其是当 build 使用 configure 样式 WORKSPACE 规则时。此类内存泄漏会导致远程执行出现问题；如需检测此类内存泄漏，除了进行原生问题排查之外，还应在 Docker 容器中进行问题排查。

第 1 步：运行 build

1. 将 --config=docker-sandbox 标志添加到执行 build 的 Bazel 命令。例如：

   bazel --bazelrc=.bazelrc build --config=docker-sandbox target

2. 运行 build 并等待其完成。由于 Docker 沙盒功能，构建运行速度将比正常速度慢最多四倍。

您可能会遇到以下错误：

ERROR: 'docker' is an invalid value for docker spawn strategy.

如果确实如此，请使用 --experimental_docker_verbose 标志再次运行 build。 此标志会启用详细的错误消息。此错误通常是由 Docker 安装故障或当前用户账号缺少执行权限所致。如需了解详情，请参阅 Docker 文档。如果问题仍然存在，请跳至在 Docker 容器中排查问题。

第 2 步：解决检测到的问题

以下是开发者最常遇到的问题及其解决方法。

• Bazel runfiles 树引用的文件、工具、二进制文件或资源缺失。。确认受影响目标的所有依赖项都已明确声明。如需了解详情，请参阅管理隐式依赖项。

• 由绝对路径或 PATH 变量引用的文件、工具、二进制文件或资源缺失。确认所有必需的工具都已安装在工具链容器中，并使用工具链规则正确声明指向缺失资源的依赖项。如需了解详情，请参阅通过工具链规则调用 build 工具。

• 二进制文件执行失败。其中一个 build 规则引用了与执行环境（Docker 容器）不兼容的二进制文件。如需了解详情，请参阅管理平台相关二进制文件。如果您无法解决此问题，请与 bazel-discuss@google.com 联系以获取帮助。

• 来自 @local-jdk 的文件缺失或导致错误。本地机器上的 Java 二进制文件泄露到 build 中，但与 build 不兼容。请在规则和目标中使用 java_toolchain，而不是 @local_jdk。如果您需要更多帮助，请发送电子邮件至 bazel-discuss@google.com。

• 其他错误。如需帮助，请发送电子邮件至 bazel-discuss@google.com。

在 Docker 容器中进行问题排查

使用此方法时，Bazel 在宿主 Docker 容器内运行，而 Bazel 的 build 操作在由 Docker 沙盒功能生成的各个工具链容器内执行。沙盒为每个 build 操作生成一个全新的工具链容器，并且每个工具链容器中仅执行一个操作。

此方法可更精细地控制主机环境中安装的工具。通过将 build 的执行与其 build 操作的执行分开，并将已安装的工具保持在最低限度，您可以验证 build 是否对本地执行环境有任何依赖项。

第 1 步：构建容器

1. 创建一个 Dockerfile，用于创建 Docker 容器并安装包含最少一组 build 工具的 Bazel：

   FROM debian:stretch
   
   RUN apt-get update && apt-get install -y apt-transport-https curl software-properties-common git gcc gnupg2 g++ openjdk-8-jdk-headless python-dev zip wget vim
   
   RUN curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add -
   
   RUN add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
   
   RUN apt-get update && apt-get install -y docker-ce
   
   RUN wget https://releases.bazel.build/<latest Bazel version>/release/bazel-<latest Bazel version>-installer-linux-x86_64.sh -O ./bazel-installer.sh && chmod 755 ./bazel-installer.sh
   
   RUN ./bazel-installer.sh
   

2. 以 bazel_container 身份构建容器：

   docker build -t bazel_container - < Dockerfile

第 2 步：启动容器

使用以下命令启动 Docker 容器。在命令中，替换为要构建的源代码在您的主机上所在的路径。

docker run -it \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp:/tmp \
  -v your source code directory:/src \
  -w /src \
  bazel_container \
  /bin/bash

此命令将以 root 身份运行容器，同时映射 Docker 套接字并装载 /tmp 目录。这样一来，Bazel 能够生成其他 Docker 容器，还可以使用 /tmp 下的目录与这些容器共享文件。您的源代码可在容器内的 /src 处找到。

该命令有意从 debian:stretch 基础容器开始，此容器包含与用作工具链容器的 rbe-ubuntu16-04 容器不兼容的二进制文件。如果本地环境中的二进制文件泄漏到工具链容器中，则会导致 build 错误。

第 3 步：测试容器

在 Docker 容器内运行以下命令以对其进行测试：

docker ps
bazel version

第 4 步：运行 build

运行 build，如下所示。输出用户为 root，以便它对应于一个目录，该目录可从以下位置通过相同的绝对路径进行访问：运行 Bazel 的宿主容器内部、由 Docker 沙盒功能生成的工具链容器（Bazel 的 build 操作在其中运行）以及运行宿主容器和操作容器的本地机器。

bazel --output_user_root=/tmp/bazel_docker_root --bazelrc=.bazelrc \ build --config=docker-sandbox target

第 5 步：解决检测到的问题

您可以按如下方式解决 build 失败问题：

• 如果 build 失败并显示“磁盘空间不足”错误，您可以通过使用标志 --memory=XX 启动宿主容器来提高此限制，其中 XX 是以 GB 为单位的分配磁盘空间。此功能尚处于实验阶段，可能会导致无法预测的行为。

• 如果 build 在分析或加载阶段失败，则表明 WORKSPACE 文件中声明的一个或多个 build 规则与远程执行不兼容。如需了解可能的原因和解决方法，请参阅针对远程执行调整 Bazel 规则。

• 如果 build 因任何其他原因而失败，请参阅第 2 步：解决检测到的问题中的问题排查步骤。