测试百科全书

测试执行环境的详尽规范。

背景

Bazel 构建语言包含可用于以多种语言定义自动测试程序的规则。

测试使用 bazel test 运行。

用户也可以直接执行测试二进制文件。我们允许这样做,但不认可,因为此类调用不符合下文规定的要求。

测试应该是封闭测试:也就是说,它们应该只访问它们已声明依赖项的资源。如果测试未正常封闭,测试将无法提供历史可重现的结果。这可能是严重的问题所在(确定哪个更改破坏了测试),发布工程可审核性,以及测试的资源隔离(自动化测试框架不应对服务器执行 DDOS,因为某些测试碰巧与服务器进行通信)。

目标

本页面的目标是正式建立 Bazel 测试的运行时环境和预期行为。此外,它还会对测试运行程序和构建系统施加要求。

测试环境规范可帮助测试作者避免依赖未指定的行为,从而可让测试基础架构更自由地更改实现。该规范填补了一些漏洞,这些漏洞目前虽然未通过正确封闭、确定性和可重入,但仍然允许许多测试通过。

本页面既是规范性权威指南,如果此规范与测试运行程序的实现行为不一致,则以该规范为准。

建议的规范

关键字“必须”、“不得”、“必需”、“必须”、“不得”、“应”、“应”

测试目的

Bazel 测试的目的是确认签入代码库的源文件的某些属性。(在此页面上,“源文件”包括测试数据、黄金输出以及版本控制下的任何其他内容。)一位用户编写了一个测试,以声明他们希望保留的不变形式。其他用户稍后执行测试,以检查是否保持不变保持不变。如果测试依赖于除源文件(非封闭)之外的任何变量,则其值会减小,因为当后续的测试停止时,用户无法确定他们的更改是否是错误的。

因此,测试结果必须仅取决于:

  • 测试声明了依赖项的源文件
  • 测试声明了依赖项的构建系统的产品
  • 由测试运行程序保证行为保持不变的资源

目前,不会强制执行此类行为。不过,测试运行程序保留将来添加此类强制执行的权利。

构建系统的角色

测试规则类似于二进制规则,因为它们都必须生成可执行程序。对于某些语言,这是一个存根程序,它将特定于语言的自动化测试框架与测试代码相结合。测试规则还必须生成其他输出。除了主要测试可执行文件之外,测试运行程序还需要 runfiles 的清单,输入文件应在运行时提供给测试,并且可能需要有关测试的类型、大小和标记的信息。

构建系统可以使用 Runfile 来提供代码以及数据。(这可用作优化,通过在测试之间共享文件(如通过使用动态链接)来减小每个测试二进制文件。)构建系统应确保生成的可执行文件通过测试运行程序提供的 Runfiles 映像加载这些文件,而不是硬编码引用在源代码或输出树中的绝对位置。

测试运行程序的角色

从测试运行程序的角度来看,每个测试都是一个可通过 execve() 调用的程序。您还可以通过其他方式执行测试;例如,Android Studio 可能允许执行进程中的 Java 测试。但是,将测试作为独立进程运行测试的结果必须被视为权威性结果。如果测试过程运行完成,且在退出代码为零的情况下正常终止,则表示测试已通过。任何其他结果都会被视为测试失败。特别是,将任何字符串 PASSFAIL 写入 stdout 对测试运行程序没有意义。

如果测试的执行时间过长、超出资源上限或者测试运行程序检测到禁止的行为,则可能会终止测试并将运行视为失败。在向测试进程或其任何子级发送信号后,运行程序不得报告测试已通过。

整个测试目标(不是单个方法或测试)的运行时间有限。测试的时间限制以下表的 timeout 属性为基础:

timeout 时间限制(秒)
短片 60
300
long 900
永恒 3600

未明确指定超时的测试具有根据测试的 size 隐含的信息,如下所示:

大小 暗示超时标签
small 短片
long
超大 永恒

未指定显式超时设置的“大”测试将分配 900 秒。超时时长为“short”的“medium”测试将分配 60 秒。

timeout 不同的是,size 还会确定在本地运行测试时其他资源(如 RAM)的使用量峰值,如通用定义中所述。

sizetimeout 标签的所有组合都是合法的,因此,系统可能会声明“超大”测试的超时时长为“短”。毫无疑问,它很快就会完成一些非常可怕的事情。

无论超时,测试都可能会任意返回结果。测试不会因过度超时而受到惩罚,但可能会发出警告:一般情况下,您应将超时设置为尽可能严格,不会产生任何不稳定性。

如果在已知运行缓慢的情况下手动运行测试,则可使用 --test_timeout bazel 标志替换测试超时时间。--test_timeout 值以秒为单位。例如,--test_timeout=120 会将测试超时设置为两分钟。

此外,您还可以使用测试超时建议下限,如下所示:

timeout 最短时间(秒)
短片 0
30
long 300
永恒 900

例如,如果“中等”测试用时 5.5 秒完成,不妨考虑设置 timeout = "short"size = "small"。使用 bazel --test_verbose_timeout_warnings 命令行选项将显示指定大小过大的测试。

根据此处的规范,在 Build 文件中指定测试大小和超时。如果未指定,测试的大小将默认为“medium”。

如果测试的主进程退出,但其部分子级仍在运行,则测试运行程序应认为运行已完成,并根据从主进程观察到的退出代码将其计为成功或失败。测试运行程序可能会终止任何离散进程。测试不应以这种方式泄露进程。

测试分片

测试可以通过测试分片并行处理。如需启用测试分片,请参阅 --test_sharding_strategyshard_count。启用分片后,每个分片会启动一次测试运行程序。环境变量 TEST_TOTAL_SHARDS 是分片数量,TEST_SHARD_INDEX 是分片索引(从 0 开始)。运行程序使用此信息来选择要运行的测试(例如,使用轮询策略)。并非所有测试运行程序都支持分片。如果运行程序支持分片,则必须创建或更新 TEST_SHARD_STATUS_FILE 指定的文件的上次修改日期。否则,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 protobuffer 日志) 可选
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 输出文件的位置。XML 架构基于 JUnit 测试结果架构 可选
BAZEL_TEST 表示测试可执行文件由 bazel test 驱动 必需

该环境可能包含其他条目。测试不应依赖于上方未列出的任何环境变量的存在、缺失或值。

初始工作目录应为 $TEST_SRCDIR/$TEST_WORKSPACE

当前的进程 ID、进程组 ID、会话 ID 和父级进程 ID 未指定。该进程不一定是进程组主管或会话主管。进程不一定有控制终端。该进程中可以有 0 个或多个正在运行或未回收的子进程。当测试代码获得控制时,进程不应有多个线程。

文件描述符 0 (stdin) 应该处于打开状态,但读取时未指定。不得通过此测试读取测试数据。文件描述符 1 (stdout) 和文件 2 (stderr) 应该开放写入,但其附加的内容未指定。它可以是终端、竖线字符、常规文件或可以写入字符的任何其他内容。他们可能会共享开放文件表中的条目(这意味着他们无法独立查找)。测试不应继承其他任何打开的文件描述符。

初始 umask 应为 022027

闹钟或计时器不会处于待处理状态。

被屏蔽信号的初始掩码应该为空。所有信号都应设置为其默认操作。

软资源和硬资源的初始资源限制应按如下方式设置:

资源 限制
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 应可写入,但测试应避免使用这些路径。

测试不得假设任何常量路径都可用于其专属用途。

测试不得假设为任何装载的文件系统启用了时间。

用户和组

必须有根用户、无人和单元测试。组 root、nobody 和 eng 必须存在。

测试必须以非根用户的身份执行。真实有效的用户 ID 必须相等;群组 ID 也是如此。除此之外,未指定当前用户 ID、群组 ID、用户名和群组名称。未指定一组补充组 ID。

当前用户 ID 和群组 ID 必须具有相应的名称,可通过 getpwuid()getgrgid() 进行检索。互补组 ID 可能并非如此。

当前用户必须拥有主目录。该分区可能无法写入。测试不得尝试向其写入数据。

网络

未指定主机名。该点可能包含点,也可能不包含点。解析主机名必须提供当前主机的 IP 地址。解析主机名中第一个点后截断的部分也应能够解决问题。主机名 localhost 必须解析。

其他资源

测试被授予至少一个 CPU 核心。其他过滤条件可能也可用,但不能保证。我们未指定该核心的其他性能方面。您可以通过将标记“cpu:n”添加到测试规则中,将预留增加到更多 CPU 核心(其中 n 是一个正数)。如果机器的总 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 TemporaryFolderGo TempDir)都有自己的方式在 /tmp 下创建临时目录。这些测试框架包含清理 /tmp 中的文件的功能,因此即使它们在 TEST_TMPDIR 之外创建文件,您也可以使用这些测试框架。

测试必须通过 runfiles 机制或专门用于使输入文件可供执行的执行环境的其他部分访问输入。

测试不得在从其自身可执行文件的位置推断的路径访问构建系统的其他输出。

它未指定 runfiles 树是包含常规文件、符号链接还是混合。runfiles 树可能包含指向目录的符号链接。测试应避免在 runfiles 树中使用包含 .. 组件的路径。

runfiles 树中的任何目录、文件或符号链接(包括遍历符号链接的路径)均不得写入数据。(因此,初始工作目录不应可写入。)测试不得假设运行文件的任何部分可写入或归当前用户所有(例如,chmodchgrp 可能会失败)。

在测试执行期间,runfiles 树(包括遍历符号链接的路径)不得更改。父目录和文件系统装载不得以任何影响 runfiles 树中路径结果的方式发生变化。

为了捕获早期退出,测试可能会在启动时在 TEST_PREMATURE_EXIT_FILE 指定的路径中创建文件,并在退出时将其移除。如果 Bazel 在测试完成后看到文件,则会假定测试提前退出并标记为失败。

代码规范

测试规则中的某些标记具有特殊含义。另请参阅 关于 tags 属性的 Bazel 构建百科全书

标记 含义
exclusive 不同时运行其他测试
external test 具有外部依赖项;停用测试缓存
large test_suite 惯例;大型测试套件
manual * 不在 :...:*:all 等通配符目标模式中添加测试目标
medium test_suite 惯例;中型测试套件
small test_suite 惯例;小型测试套件
smoke test_suite 惯例;表示应在将代码更改提交到版本控制系统之前运行

运行文件

在下例中,我们假设存在一条名为 //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 目录包含以下内容:

  • 运行时依赖项的符号链接:作为 *_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
  • 指向子运行文件的符号链接:对于 *_binary() C 的每个 *_binary() Z,运行时 C 的 runfiles 目录中有第二个链接指向 Z 的运行文件。符号链接的名称为 $(WORKSPACE)/package_name/rule_name.runfiles。符号链接的目标为 runfiles 目录。例如,所有子程序共用一个通用的 filefile 目录。