从脚本调用 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(用于控制是否输出“build 最新”消息);可以解析这些消息,以发现已成功构建的目标以及所创建的输出文件的位置。如果您依赖这些消息,请务必指定一个非常大的 n 值。

通过分析排查性能问题

请参阅性能剖析部分。