从脚本调用 Bazel

报告问题 查看源代码 每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

您可以从脚本中调用 Bazel 来执行构建、运行测试或查询依赖关系图。Bazel 旨在实现有效的脚本编写,但本部分列出了一些需要注意的细节,以便使您的脚本更加可靠。

选择输出基础

--output_base 选项用于控制 Bazel 进程应将 build 的输出写入何处,以及 Bazel 在内部使用的各种工作文件,其中一个是用于防止多个 Bazel 进程同时更改输出库的锁定文件。

为脚本选择正确的输出基本目录取决于多种因素。如果您需要将 build 输出放在特定位置,则需要使用相应的输出库。如果您向 Bazel 发出“只读”调用(例如 bazel query),锁定因素将更为重要。特别是,如果您需要同时运行脚本的多个实例,则需要为每个实例提供不同的(或随机的)输出基础。

如果您使用默认的输出库值,则会与用户的交互式 Bazel 命令争用同一锁定。如果用户发出长时间运行的命令(例如 build),脚本必须等待这些命令完成才能继续运行。

有关服务器模式的注意事项

默认情况下,Bazel 使用长时间运行的服务器进程作为优化措施。在脚本中运行 Bazel 时,请不要忘记在完成服务器操作后调用 shutdown,或者指定 --max_idle_secs=5,以便空闲服务器及时自行关闭。

我会获得什么退出代码?

Bazel 会尝试区分因所考虑的源代码而导致的失败与阻止 Bazel 正常执行的外部错误。Bazel 执行可能会产生以下退出代码:

所有命令通用的退出代码

  • 0 - 成功
  • 2 - 命令行问题、标志或命令组合错误或非法,或者环境变量错误。您必须修改命令行。
  • 8 - 构建已中断,但我们已通过有序关停终止构建。
  • 9 - 服务器锁已持有,并且已传递 --noblock_for_lock
  • 32 - 外部环境故障,但不在本机上。

  • 33 - Bazel 内存不足并崩溃。您需要修改命令行。

  • 34 - 预留供 Google 内部使用。

  • 35 - 预留供 Google 内部使用。

  • 36 - 本地环境问题,疑似永久性。

  • 37 - 未处理的异常 / 内部 Bazel 错误。

  • 38 - 预留供 Google 内部使用。

  • 39 - Bazel 所需的 Blob 从远程缓存中逐出。

  • 41-44 - 预留供 Google 内部使用。

  • 45 - 向 Build Event Service 发布结果时出错。

  • 47 - 预留供 Google 内部使用。

命令 bazel buildbazel test 的返回代码

  • 1 - 构建失败。
  • 3 - 构建正常,但部分测试失败或超时。
  • 4 - 构建成功,但即使请求了测试,也未找到任何测试。

对于 bazel run

  • 1 - 构建失败。
  • 如果 build 成功,但执行的子进程返回非零退出代码,则该代码也将是命令的退出代码。

对于 bazel query

  • 3 - 部分成功,但查询在输入 BUILD 文件集中遇到 1 个或多个错误,因此操作结果并非 100% 可靠。这可能是因为命令行中存在 --keep_going 选项。
  • 7 - 命令失败。

未来的 Bazel 版本可能会添加其他退出代码,将通用失败退出代码 1 替换为具有特定含义的其他非零值。不过,所有非零退出值始终表示错误。

读取 .bazelrc 文件

默认情况下,Bazel 会从基本工作区目录或用户的主目录中读取 .bazelrc 文件。这是否可取取决于您的脚本;如果您的脚本需要完全密封(例如在进行发布 build 时),您应使用 --bazelrc=/dev/null 选项停用对 .bazelrc 文件的读取。如果您想使用用户偏好的设置执行 build,那么默认行为会更好。

命令日志

您还可以通过以下命令找到命令日志文件,其中包含 Bazel 输出:

bazel info command_log

命令日志文件包含最新 Bazel 命令的交错 stdout 和 stderr 流。请注意,运行 bazel info 会覆盖此文件的内容,因为该命令随后会成为最新的 Bazel 命令。不过,除非您更改 --output_base--output_user_root 选项的设置,否则命令日志文件的位置不会发生变化。

解析输出

Bazel 输出非常易于解析,可用于多种用途。以下两个选项可能对您的脚本有所帮助:--noshow_progress(用于抑制进度消息)和 --show_result n(用于控制是否打印“build up-to-date”消息);您可以解析这些消息,以了解哪些目标已成功构建,以及它们创建的输出文件的位置。如果您依赖这些消息,请务必指定一个非常大的 n 值。

通过分析来排查性能问题

请参阅性能分析部分。