您可以从脚本调用 Bazel,以执行构建、运行测试或查询依赖关系图。Bazel 旨在实现有效的脚本编写,但本部分列出了一些需要注意的详细信息,可让您的脚本变得更强大。
选择输出基准
--output_base
选项用于控制 Bazel 进程应将构建的输出写入到何处,以及 Bazel 内部使用的各种工作文件,其中一个是锁,用于防止多个 Bazel 进程对输出基准进行并发更改。
为脚本选择正确的输出基本目录取决于多种因素。如果需要将构建输出放在特定位置,这将决定您需要使用的输出基准。如果您要对 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 内部使用。41-44
- 预留供 Google 内部使用。45
- 将结果发布到构建事件服务时出错。47
- 预留供 Google 内部使用。
命令 bazel build
、bazel 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。
通过分析排查性能问题
请参阅性能剖析部分。