从脚本调用 Bazel

报告问题 查看源代码

您可以从脚本调用 Bazel 以执行构建、运行测试或查询依赖项图。Bazel 的设计宗旨是实现有效脚本,但本部分列出了一些需要注意的细节,以便让您的脚本更加可靠。

选择输出基

--output_base 选项控制 Bazel 进程应将输出的输出写入到的位置,以及 Bazel 在内部使用的各种工作文件,其中一个锁是可以防止多个 Bazel 进程并发更改输出库。

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

如果您使用默认输出基值,则会争用用户的交互式 Bazel 命令使用的锁。如果用户发出长时间运行的命令(如构建),您的脚本必须等待这些命令运行完成,然后才能继续。

服务器模式注意事项

默认情况下,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 - 将结果发布到构建事件服务时出错。

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

bazel buildbazel test 命令命令的返回值

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

对于 bazel run

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

对于 bazel query

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

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

读取 .bazelrc 文件

默认情况下,Bazel 会从基本工作区目录或用户的主目录读取 .bazelrc 文件。这是否是您的脚本的选择;如果您的脚本需要具有完美的封闭性(例如在执行发布 build 时),您应使用 --bazelrc=/dev/null 选项停用读取 .bazelrc 文件。如果您想使用用户的首选设置执行构建,默认行为更好。

命令日志

此外,您还可以在以下命令中找到 Bazel 输出命令文件:

bazel info command_log

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

解析输出

Bazel 输出非常易于解析,可用于许多用途。可能对脚本有用的两个选项是 --noshow_progress(禁止显示进度消息)和 --show_result n(控制是否输出“构建最新”消息);这些消息可能会被解析以发现已成功构建的目标及其创建的输出文件的位置。如果您依赖于这些消息,请务必指定非常大的 n 值。

通过性能分析排查性能问题

请参阅性能分析部分。