测试执行环境的详尽规范。
背景
Bazel BUILD 语言包含的一些规则可用于以多种语言定义自动化测试程序。
使用 bazel test 运行测试。
用户也可以直接执行测试二进制文件。这是允许的行为，但并不认可，因为此类调用将不符合下述授权。
测试应该是“封闭”的：也就是说，测试应该只访问已声明其依赖项的资源。如果测试未正确封闭，将无法提供历史可重现的结果。这可能是一个重大问题，涉及到找出问题原因（确定哪些更改破坏了测试）、发布工程可审核性和测试的资源隔离（自动化测试框架不应对服务器进行 DDOS，因为某些测试恰好与之通信）。
客观
本页面的目的是正式为 Bazel 测试的运行时环境和预期行为建立运行时环境。它还会对测试运行程序和构建系统施加要求。
测试环境规范可帮助测试作者避免依赖未指定的行为，进而让测试基础架构可以更自由地更改实现。该规范缩小了一些漏洞，尽管这些测试没有适当的封闭性、确定性和可重入性，但目前允许通过许多测试。
本页内容具有规范性和权威性。如果此规范与测试运行程序实现的行为不一致，则以该规范为准。
建议的规范
关键字“必须”“不得”“必需”“会”“不会”“应”“不应”“建议”“可以”和“可选”将按照 IETF RFC 2119 中的说明进行解释。
测试目的
Bazel 测试的目的是确认签入代码库的源文件的某个属性。（在本页中，“源文件”包括测试数据、黄金输出以及受版本控制保护的任何其他内容。）一个用户编写测试来断言他们希望保留的不变量。其他用户稍后会执行测试以检查不变量是否已损坏。如果测试依赖于除源文件（非封闭）之外的任何变量，则其值将减小，因为后来的用户无法确定当测试停止通过时，他们的更改存在错误。
因此，测试的结果必须仅取决于：
- 测试已声明其依赖项的源文件
- 已声明测试依赖的构建系统的产品
- 行为由测试运行程序保证保持不变的资源
目前，未强制执行此类行为。但是，测试运行程序保留将来添加此类强制执行的权利。
构建系统的角色
测试规则类似于二进制规则，每个规则都必须生成一个可执行程序。对于某些语言，这是一个存根程序，可将特定语言的自动化测试框架与测试代码结合在一起。测试规则也必须生成其他输出。除了主要测试可执行文件之外，测试运行程序还需要一个包含 runfile 的清单、应在运行时提供给测试的输入文件，并且可能需要有关测试的类型、大小和标记的信息。
构建系统可以使用 runfile 传递代码和数据。（这项优化可以作为一项优化措施，通过在测试之间共享文件（例如使用动态链接）来减小每个测试二进制文件的大小。构建系统应确保生成的可执行文件通过测试运行程序提供的 runfiles 映像加载这些文件，而不是对源代码或输出树中的绝对位置进行硬编码引用。
测试运行程序的角色
从测试运行程序的角度来看，每个测试都是一个可以使用 execve() 调用的程序。可以通过其他方式执行测试；例如，IDE 可能允许在进程中执行 Java 测试。不过，作为独立进程运行测试的结果必须被视为权威结果。如果测试进程运行至完成，并以退出代码为 0 正常终止，则表示测试已通过。任何其他结果均被视为测试失败。特别是，将任何字符串 PASS 或 FAIL 写入 stdout 对测试运行程序没有任何影响。
如果测试的执行时间过长、超出某些资源限制，或者测试运行程序以其他方式检测到禁止的行为，则可能会选择终止测试并将运行视为失败。在向测试进程或其任何子进程发送信号后，运行程序不得将测试报告为已通过。
整个测试目标（而不是单个方法或测试）需要在限定时间内完成。测试的时间限制基于其 timeout 属性，如下表所示：
| 超时 | 时间限制（秒） |
|---|---|
| 短片 | 60 |
| 中 | 300 |
| long | 900 |
| 永恒 | 3600 |
对于未明确指定超时的测试，系统会根据测试的 size 隐式指定超时，如下所示：
| 大小 | 隐含的超时标签 |
|---|---|
| small | 短片 |
| medium | 中 |
| 大 | long |
| 超大 | 永恒 |
没有明确超时设置的“大型”测试将分配 900 秒运行。系统会为超时设置为“short”的“中”测试分配 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 文件中指定测试大小和超时。如果未指定，测试的大小将默认为“medium”。
如果测试的主进程退出，但其一些子进程仍在运行，则测试运行程序应认为运行已完成，并根据从主进程观察到的退出代码将其计为成功或失败。测试运行程序可能会终止任何散乱进程。测试不应以这种方式泄露进程。
测试分片
您可以通过测试分片并行运行测试。如需启用测试分片，请参阅 --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_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。
用户和群组
users 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 核心总数少于请求的 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 树是包含常规文件、符号链接，还是二者兼有。runfiles 树可能包含目录的符号链接。测试应避免在 runfiles 树中使用包含 .. 组件的路径。
runfiles 树中的目录、文件或符号链接（包括遍历符号链接的路径）都不应是可写入的。（由此可见，初始工作目录应不可写入。）测试不得假设 Runfile 的任何部分都是可写入的或归当前用户所有（例如，chmod 和 chgrp 可能会失败）。
Runfiles 树（包括遍历符号链接的路径）在测试执行期间不得更改。父级目录和文件系统装载不得以任何方式更改，否则这些更改会影响对 runfiles 树中的路径的解析结果。
为了捕获提前退出，测试可能会在启动时通过 TEST_PREMATURE_EXIT_FILE 指定的路径创建一个文件，并在退出时将其移除。如果 Bazel 在测试完成后看到该文件，则会认为测试提早退出并将其标记为失败。
代码规范
测试规则中的某些代码具有特殊含义。另请参阅关于 tags 属性的 Bazel 构建百科全书。
| 标记 | 含义 |
|---|---|
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 目录本身依赖于一组 BUILD 文件，这些文件会影响 *_binary() 规则或其任何编译时或运行时依赖项。修改源文件不会影响 runfiles 目录的结构，因此不会触发任何重新构建。
目录
runfiles 目录包含以下内容：
- 指向运行时依赖项的符号链接：作为
*_binary()规则的运行时依赖项的每个 OutputFile 和 CommandRule 都由 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。 - 指向子 runfile 的符号链接：对于作为
*_binary()C 的运行时依赖项的每个*_binary()Z，在 C 的 runfiles 目录中再有一个指向 Z 的 runfile 的链接。符号链接的名称为$(WORKSPACE)/package_name/rule_name.runfiles。符号链接的目标是 runfiles 目录。例如，所有子程序都共用一个通用的 runfiles 目录。