测试执行环境的详尽规范。
背景
Bazel BUILD 语言包含一些规则，可用于以多种语言定义自动化测试程序。
测试使用 bazel test 运行。
用户也可以直接执行测试二进制文件。虽然允许这种做法，但不予以认可，因为此类调用不符合下文所述的要求。
测试应是密封的：也就是说，它们应仅访问已声明依赖项的资源。如果测试未正确密封，则无法提供可重现历史结果。这可能会对查找罪魁祸首（确定哪项更改破坏了测试）、发布工程可审核性和测试资源隔离造成严重影响（自动化测试框架不应对服务器进行 DDoS 攻击，因为某些测试恰好与之通信）。
目标
本页的目标是正式建立 Bazel 测试的运行时环境和预期行为。它还会对测试运行程序和构建系统施加要求。
测试环境规范可帮助测试作者避免依赖未指定的行为，从而让测试基础架构能够更自由地进行实现更改。该规范缩小了一些漏洞，目前许多测试虽然未正确实现密封性、确定性和可重入性，但仍能通过测试。
本页面旨在提供规范性和权威性信息。如果此规范与测试运行程序的实现行为不一致，则以规范为准。
拟议规范
关键字“必须”“不得”“必需”“会”“不会”“应”“不应”“建议”“可以”和“可选”将按 IETF RFC 2119 中的描述进行解释。
测试目的
Bazel 测试的目的是确认签入到代码库中的源文件的一些属性。（在此页面上，“源文件”包括测试数据、标准输出以及受版本控制的任何其他内容。）一位用户编写了一项测试，用于断言他们希望保持的不变性。其他用户稍后会执行该测试，以检查是否破坏了不变量。如果测试依赖于源文件以外的任何变量（非密封），其价值会降低，因为当测试停止通过时，后续用户无法确定是他们的更改导致了问题。
因此，测试结果必须仅取决于：
- 测试声明了依赖项的源文件
- 测试声明了依赖项的构建系统的软件包
- 测试运行程序保证其行为保持不变的资源
目前，系统不会强制执行此类行为。不过，测试运行程序保留日后添加此类强制执行措施的权利。
构建系统的角色
测试规则与二进制规则类似，因为每条规则都必须生成可执行程序。对于某些语言，这是一个桩程序，用于将特定于语言的测试框架与测试代码结合使用。测试规则还必须生成其他输出。除了主要测试可执行文件之外，测试运行程序还需要 runfiles 清单，即应在运行时提供给测试的输入文件，并且可能需要测试的类型、大小和标记的相关信息。
构建系统可能会使用 runfile 来传送代码和数据。（这可以用作优化，通过在测试之间共享文件（例如通过使用动态链接），使每个测试二进制文件变小。）构建系统应确保生成的可执行文件通过测试运行程序提供的 runfiles 映像加载这些文件，而不是对源代码树或输出树中的绝对位置进行硬编码引用。
测试运行程序的角色
从测试运行程序的角度来看，每个测试都是一个可通过 execve() 调用的程序。可能还有其他方法可以执行测试；例如，IDE 可能允许在进程中执行 Java 测试。不过，必须将作为独立进程运行测试的结果视为权威结果。如果测试进程运行到完成并正常终止（退出代码为零），则表示测试已通过。任何其他结果都将被视为测试失败。具体而言，将任何字符串 PASS 或 FAIL 写入标准输出对测试运行程序没有意义。
如果测试执行时间过长、超出某些资源限制，或者测试运行程序以其他方式检测到禁止的行为，则可能会选择终止测试并将运行视为失败。在向测试进程或其任何子进程发送信号后，运行程序不得报告测试已通过。
整个测试目标（而非单个方法或测试）有有限的时间来运行到完成。测试的时限取决于其 timeout 属性，具体取决于下表：
| 超时 | 时限（秒） |
|---|---|
| 短片 | 60 |
| 适中 | 300 |
| long | 900 |
| 永恒 | 3600 |
如果测试未明确指定超时，系统会根据测试的 size 隐式指定一个超时，如下所示：
| size | 隐含的超时标签 |
|---|---|
| 小 | 短片 |
| 中 | 适中 |
| large | long |
| 巨大 | 永恒 |
如果“大型”测试未设置明确的超时设置，则系统会为其分配 900 秒的运行时间。如果“中等”测试的超时设置为“短”，则系统会为其分配 60 秒的时间。
与 timeout 不同，size 还会确定在本地运行测试时其他资源（如 RAM）的假设峰值用量，如常见定义中所述。
所有 size 和 timeout 标签组合都是合法的，因此可以声明“巨大”测试的超时设置为“短”。它可能会非常迅速地做出一些非常可怕的事情。
无论超时时间如何，测试都可能会非常快地返回结果。测试不会因超长超时而受到处罚，但系统可能会发出警告：通常，您应尽可能缩短超时设置，以免出现任何不稳定的情况。
在已知运行缓慢的情况下手动运行时，可以使用 --test_timeout bazel 标志替换测试超时设置。--test_timeout 值以秒为单位。例如，--test_timeout=120 将测试超时设置为两分钟。
我们还建议为测试超时设置下限，如下所示：
| 超时 | 最短时间（秒） |
|---|---|
| 短片 | 0 |
| 适中 | 30 |
| long | 300 |
| 永恒 | 900 |
例如，如果“中等”测试在 5.5 秒内完成，请考虑设置 timeout =
"short" 或 size = "small"。使用 bazel --test_verbose_timeout_warnings 命令行选项会显示指定大小过大的测试。
请根据此处的规范在 BUILD 文件中指定测试大小和超时。如果未指定，测试的大小将默认为“中等”。
如果测试的主进程退出，但其某些子进程仍在运行，测试运行程序应根据从主进程观察到的退出代码，将运行视为已完成并将其计为成功或失败。测试运行程序可能会终止所有无效进程。测试不应以这种方式泄露进程。
测试分片
测试可以通过测试分片进行并行处理。请参阅 --test_sharding_strategy 和 shard_count 以启用测试分片。启用分片后，每个分片都会启动一次测试运行程序。环境变量 TEST_TOTAL_SHARDS 是分片数量，而 TEST_SHARD_INDEX 是分片索引，从 0 开始。运行程序会使用此信息来选择要运行的测试，例如使用轮替策略。并非所有测试运行程序都支持分片。如果运行程序支持分片，则必须创建或更新 TEST_SHARD_STATUS_FILE 指定的文件的上次修改日期。否则，如果启用了 --incompatible_check_sharding_support，当测试分片时，Bazel 会使测试失败。
初始条件
执行测试时，测试运行程序必须建立特定的初始条件。
测试运行程序必须使用 argv[0] 中测试可执行文件的路径调用每项测试。此路径必须是相对路径，并且位于测试的当前目录（位于 runfiles 树中，见下文）下。除非用户明确请求，否则测试运行程序不应向测试传递任何其他参数。
初始环境块的构成如下：
| 变量 | 值 | 状态 |
|---|---|---|
HOME |
$TEST_TMPDIR 的值 |
推荐 |
LANG |
unset | 必填 |
LANGUAGE |
unset | 必填 |
LC_ALL |
unset | 必填 |
LC_COLLATE |
unset | 必填 |
LC_CTYPE |
unset | 必填 |
LC_MESSAGES |
unset | 必填 |
LC_MONETARY |
unset | 必填 |
LC_NUMERIC |
unset | 必填 |
LC_TIME |
unset | 必填 |
LD_LIBRARY_PATH |
以英文冒号分隔的包含共享库的目录列表 | 可选 |
JAVA_RUNFILES |
$TEST_SRCDIR 的值 |
已弃用 |
LOGNAME |
$USER 的值 |
必填 |
PATH |
/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin:. |
推荐 |
PWD |
$TEST_SRCDIR/workspace-name |
推荐 |
SHLVL |
2 |
推荐 |
TEST_INFRASTRUCTURE_FAILURE_FILE |
可写目录中私有文件的绝对路径（此文件应仅用于报告源自测试基础架构的失败，而不能作为报告测试不稳定失败的通用机制。在本文档中，测试基础架构是指并非特定于测试的系统或库，但可能会因故障而导致测试失败。第一行是导致失败的测试基础架构组件的名称，第二行是失败的人类可读说明。系统会忽略其他行。） | 可选 |
TEST_LOGSPLITTER_OUTPUT_FILE |
可写目录中私有文件的绝对路径（用于写入 Logsplitter 协议缓冲区日志） | 可选 |
TEST_PREMATURE_EXIT_FILE |
可写目录中私有文件的绝对路径（用于捕获对 exit() 的调用） |
可选 |
TEST_RANDOM_SEED |
如果使用 --runs_per_test 选项，则系统会为每次单独的测试运行将 TEST_RANDOM_SEED 设置为 run number（从 1 开始）。 |
可选 |
TEST_RUN_NUMBER |
如果使用 --runs_per_test 选项，则系统会为每次单独的测试运行将 TEST_RUN_NUMBER 设置为 run number（从 1 开始）。 |
可选 |
TEST_TARGET |
被测目标的名称 | 可选 |
TEST_SIZE |
测试 size |
可选 |
TEST_TIMEOUT |
测试 timeout（以秒为单位） |
可选 |
TEST_SHARD_INDEX |
分片编号（如果使用 sharding） |
可选 |
TEST_SHARD_STATUS_FILE |
要触摸的文件的路径，用于指明对 sharding 的支持 |
可选 |
TEST_SRCDIR |
runfiles 树基底的绝对路径 | 必填 |
TEST_TOTAL_SHARDS |
总计
shard count（如果使用了 sharding） |
可选 |
TEST_TMPDIR |
可写私有目录的绝对路径 | 必填 |
TEST_WORKSPACE |
本地代码库的工作区名称 | 可选 |
TEST_UNDECLARED_OUTPUTS_DIR |
指向私有可写目录的绝对路径（用于写入未声明的测试输出）。写入 TEST_UNDECLARED_OUTPUTS_DIR 目录的所有文件都将被压缩并添加到 bazel-testlogs 下的 outputs.zip 文件中。 |
可选 |
TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR |
指向私有可写目录的绝对路径（用于写入未声明的测试输出注解 .part 和 .pb 文件）。 |
可选 |
TEST_WARNINGS_OUTPUT_FILE |
可写目录中私有文件的绝对路径（用于写入测试目标警告） | 可选 |
TESTBRIDGE_TEST_ONLY |
--test_filter 的值（如果已指定） |
可选 |
TZ |
UTC |
必填 |
USER |
getpwuid(getuid())->pw_name 的值 |
必填 |
XML_OUTPUT_FILE |
测试操作应将测试结果 XML 输出文件写入的位置。 否则，Bazel 会在测试操作中生成一个默认的 XML 输出文件来封装测试日志。XML 架构基于 JUnit 测试结果架构。 | 可选 |
BAZEL_TEST |
表示测试可执行文件由 bazel test 驱动 |
必填 |
该环境可能包含其他条目。测试不应依赖于上述未列出的任何环境变量的存在、不存在或值。
初始工作目录应为 $TEST_SRCDIR/$TEST_WORKSPACE。
当前进程 ID、进程组 ID、会话 ID 和父进程 ID 未指定。该进程可以是，也可以不是进程组主进程或会话主进程。进程可以有控制终端，也可以没有。该进程可能有零个或多个正在运行或未收割的子进程。当测试代码获得控制权时，进程不应具有多个线程。
文件描述符 0 (stdin) 应处于打开状态以供读取，但其附加的对象未指定。测试不得从中读取内容。文件描述符 1 (stdout) 和 2 (stderr) 应处于打开写入状态，但未指定它们附加到什么。它可以是终端、管道、常规文件或任何其他可以写入字符的对象。它们可能会在打开的文件表中共享条目（这意味着它们无法独立跳转）。测试不应继承任何其他打开的文件描述符。
初始 umask 应为 022 或 027。
不得有待处理的闹钟或间隔计时器。
已屏蔽信号的初始掩码应为空。所有信号都应设置为其默认操作。
初始资源限制（软限制和硬限制）应设置如下：
| 资源 | 限制 |
|---|---|
RLIMIT_AS |
无限制 |
RLIMIT_CORE |
未指定 |
RLIMIT_CPU |
无限制 |
RLIMIT_DATA |
无限制 |
RLIMIT_FSIZE |
无限制 |
RLIMIT_LOCKS |
无限制 |
RLIMIT_MEMLOCK |
无限制 |
RLIMIT_MSGQUEUE |
未指定 |
RLIMIT_NICE |
未指定 |
RLIMIT_NOFILE |
至少 1024 |
RLIMIT_NPROC |
未指定 |
RLIMIT_RSS |
无限制 |
RLIMIT_RTPRIO |
未指定 |
RLIMIT_SIGPENDING |
未指定 |
RLIMIT_STACK |
无限制，或 2044KB <= rlim <= 8192KB |
初始进程时间（由 times() 返回）和资源利用率（由 getrusage() 返回）未指定。
初始调度政策和优先级未指定。
宿主系统的角色
除了测试运行程序直接控制的用户上下文方面之外，测试执行所在的操作系统还必须满足特定属性，测试运行才有效。
文件系统
测试观察到的根目录不一定是真实的根目录。
/proc 应已挂载。
所有构建工具都应位于本地安装程序使用的 /usr 下的绝对路径中。
以 /home 开头的路径可能无法使用。测试不应访问任何此类路径。
/tmp 应可写入，但测试应避免使用这些路径。
测试不得假定任何常量路径可供其独占使用。
测试不得假定已为任何已装载的文件系统启用 atime。
用户和群组
用户 root、nobody 和 unittest 必须存在。必须存在 root、nobody 和 eng 组。
必须以非根用户身份执行测试。真实用户 ID 和有效用户 ID 必须相同；群组 ID 也是如此。除此之外，当前用户 ID、群组 ID、用户名和群组名称未指定。未指定一组补充组 ID。
当前用户 ID 和群组 ID 必须具有相应的名称，可以使用 getpwuid() 和 getgrgid() 检索这些名称。但对于补充组 ID，情况可能并非如此。
当前用户必须有一个主目录。它可能无法写入。测试不得尝试向其中写入内容。
网络
主机名未指定。它可以包含或不包含英文句点。解析主机名必须提供当前主机的 IP 地址。解析第一个点后截断的主机名也必须可行。主机名 localhost 必须解析。
其他资源
系统会向测试授予至少一个 CPU 核心。也可能有其他方法，但我们无法保证。此核心的其他性能方面未指定。您可以通过向测试规则添加标记“cpu:n”（其中 n 为正整数）将预留的 CPU 核心数增加到更高数量。如果机器的总 CPU 核心数少于请求的核心数，Bazel 仍会运行测试。如果测试使用分片，则每个分片都会预留此处指定的 CPU 核心数量。
测试可以创建子进程，但不能创建进程组或会话。
测试可使用的输入文件数量有限。此限制可能会发生变化，但目前在数万个输入范围内。
时间和日期
未指定当前时间和日期。未指定系统时区。
X Windows 可能可用，也可能不可用。需要 X 服务器的测试应启动 Xvfb。
测试与文件系统的互动
除非另有说明，否则测试环境变量中指定的所有文件路径都指向本地文件系统中的某个位置。
测试应仅在 $TEST_TMPDIR 和 $TEST_UNDECLARED_OUTPUTS_DIR（如果已设置）指定的目录中创建文件。
这些目录最初为空。
测试不得尝试移除、chmod 或以其他方式更改这些目录。
这些目录可能是符号链接。
$TEST_TMPDIR/. 的文件系统类型仍未指定。
测试还可以将 .part 文件写入 $TEST_UNDECLARED_OUTPUTS_ANNOTATIONS_DIR，以对未声明的输出文件进行注解。
在极少数情况下，测试可能会被迫在 /tmp 中创建文件。例如，Unix 域套接字的路径长度限制通常要求在 /tmp 下创建套接字。Bazel 将无法跟踪此类文件；测试本身必须注意保持密封性，使用唯一的路径以避免与其他同时运行的测试和非测试进程冲突，并清理它在 /tmp 中创建的文件。
一些热门测试框架（例如 JUnit4 TemporaryFolder 或 Go TempDir）有自己的方法可以在 /tmp 下创建临时目录。这些测试框架包含用于清理 /tmp 中文件的功能，因此即使它们在 TEST_TMPDIR 之外创建文件，您也可以使用它们。
测试必须通过 runfiles 机制或执行环境的其他部分（专门用于提供输入文件）访问输入。
测试不得通过从其自身可执行文件的位置推断出的路径访问构建系统的其他输出。
未指定 runfiles 树是否包含常规文件、符号链接或二者混合。runfile 树可能包含指向目录的符号链接。测试应避免在 runfile 树中使用包含 .. 组件的路径。
runfiles 树中的任何目录、文件或符号链接（包括遍历符号链接的路径）都应不可写。（因此，初始工作目录不应可写。）测试不得假定运行文件的任何部分都是可写的，或者归当前用户所有（例如，chmod 和 chgrp 可能会失败）。
在测试执行期间，runfile 树（包括遍历符号链接的路径）不得更改。父目录和文件系统挂载不得以任何方式更改，以免影响解析 runfile 树中路径的结果。
为了捕获提前退出，测试可能会在启动时在 TEST_PREMATURE_EXIT_FILE 指定的路径中创建文件，并在退出时将其移除。如果 Bazel 在测试完成时看到该文件，则会假定测试提前退出，并将其标记为失败。
执行平台
与任何其他操作一样，测试操作的执行平台是通过工具链解析确定的。每条测试规则都有一个隐式定义的
test 执行组，除非被替换，否则对 @bazel_tools//tools/test:default_test_toolchain_type 有强制性的工具链要求。此类工具链不会以提供程序的形式携带任何数据，但可用于影响测试操作的执行平台。默认情况下，Bazel 会注册两个此类工具链：
- 如果
--@bazel_tools//tools/test:incompatible_use_default_test_toolchain处于停用状态（当前默认状态），则有效的测试工具链为@bazel_tools//tools/test:legacy_test_toolchain。此工具链不会强加任何约束条件，因此，系统会为第一个注册的执行平台配置未手动指定执行约束条件的测试操作。这通常不是多平台 build 中的预期行为，因为这可能会导致在 Windows 机器上针对 Linux 构建的测试二进制文件在 Windows 上执行。 - 如果启用了
--@bazel_tools//tools/test:incompatible_use_default_test_toolchain，则有效的测试工具链为@bazel_tools//tools/test:default_test_toolchain。此工具链要求执行平台与测试规则的目标平台的所有约束条件相匹配。具体而言，如果目标平台也注册为执行平台，则与此工具链兼容。如果找不到此类平台，测试规则会因工具链解析错误而失败。
用户可以为此类型注册其他工具链，以影响此行为，并且其工具链将优先于默认工具链。测试规则作者可以定义自己的测试工具链类型，还可以为其注册默认工具链。
代码惯例
测试规则中的某些标记具有特殊含义。另请参阅 关于 tags 属性的 Bazel Build 百科全书。
| 标记 | 含义 |
|---|---|
exclusive |
同时不运行任何其他测试 |
external |
测试具有外部依赖项；停用测试缓存 |
large |
test_suite 惯例；一系列大型测试 |
manual * |
请勿在通配符目标模式（例如 :...、:* 或 :all）中添加测试目标 |
medium |
test_suite 惯例；一系列中等测试 |
small |
test_suite 惯例；一系列小型测试 |
smoke |
test_suite 惯例；表示应先运行此脚本，然后再将代码更改提交到版本控制系统 |
Runfile
在以下示例中，假设有一个标记为 //foo/bar:unittest 的 *_binary() 规则，该规则对标记为 //deps/server:server 的规则具有运行时依赖项。
位置
目标 //foo/bar:unittest 的 runfiles 目录是目录 $(WORKSPACE)/$(BINDIR)/foo/bar/unittest.runfiles。此路径称为 runfiles_dir。
依赖项
runfiles 目录被声明为 *_binary() 规则的编译时依赖项。runfiles 目录本身取决于影响 *_binary() 规则或其任何编译时或运行时依赖项的一组 BUILD 文件。修改源文件不会影响 runfiles 目录的结构，因此不会触发任何重新构建。
目录
runfiles 目录包含以下内容：
- 指向运行时依赖项的符号链接：每个 OutputFile 和 CommandRule 都是
*_binary()规则的运行时依赖项，由 runfiles 目录中的一个符号链接表示。符号链接的名称为$(WORKSPACE)/package_name/rule_name。例如，服务器的符号链接将命名为$(WORKSPACE)/deps/server/server，完整路径为$(WORKSPACE)/foo/bar/unittest.runfiles/$(WORKSPACE)/deps/server/server。符号链接的目标是 OutputFile 或 CommandRule 的 OutputFileName()，表示为绝对路径。因此，符号链接的目标可能为$(WORKSPACE)/linux-dbg/deps/server/42/server。