cargo-test(1)

概要

cargo test [选项] [测试名称] [-- 测试选项]

测试过滤参数 TESTNAME 和两个破折号 (--) 之后的所有参数都传递给测试二进制文件，从而传递给 libtest（rustc 内置的单元测试和微基准测试框架）。如果您要将参数传递给 Cargo 和二进制文件，则 -- 之后的参数将传递给二进制文件，之前的参数将传递给 Cargo。有关 libtest 参数的详细信息，请参阅 cargo test -- --help 的输出，并查看 rustc 书籍中有关测试工作原理的章节，网址为 https://doc.rust-lang.net.cn/rustc/tests/index.html。

例如，这将筛选名称中包含 foo 的测试，并在 3 个线程上并行运行它们

cargo test foo -- --test-threads 3

测试使用 rustc 的 --test 选项构建，该选项通过将代码与 libtest 链接来创建特殊的可执行文件。可执行文件会自动在多个线程中运行所有使用 #[test] 属性注释的函数。#[bench] 注释的函数也将运行一次迭代以验证其功能。

如果包包含多个测试目标，则每个目标都会编译成上述的特殊可执行文件，然后按顺序运行。

可以通过在目标清单设置中设置 harness = false 来禁用 libtest 测试框架，在这种情况下，您的代码需要提供自己的 main 函数来处理测试运行。

文档测试

默认情况下也会运行文档测试，这由 rustdoc 处理。它从库目标的文档注释中提取代码示例，然后执行它们。

与普通测试目标不同，每个代码块都使用 rustc 动态编译成 doctest 可执行文件。这些可执行文件在单独的进程中并行运行。代码块的编译实际上是由 libtest 控制的测试函数的一部分，因此 --jobs 等某些选项可能不会生效。请注意，doctest 的这种执行模型不保证将来会发生变化；请注意不要依赖它。

有关编写文档测试的更多信息，请参阅 rustdoc 书籍。

测试的工作目录

运行每个单元测试和集成测试时，工作目录设置为测试所属包的根目录。将测试的工作目录设置为包的根目录，可以使测试能够使用相对路径可靠地访问包的文件，而无论 cargo test 从何处执行。

对于文档测试，调用 rustdoc 时，工作目录设置为工作空间根目录，也是 rustdoc 用作每个文档测试的编译目录的目录。运行每个文档测试时，工作目录设置为测试所属包的根目录，并通过 rustdoc 的 --test-run-directory 选项进行控制。

选项

测试选项

--no-run: 编译但不运行测试。
--no-fail-fast: 运行所有测试，无论是否失败。如果没有此标志，Cargo 将在第一个可执行文件失败后退出。Rust 测试框架将运行可执行文件中的所有测试直至完成，此标志仅适用于整个可执行文件。

包选择

默认情况下，当未给出包选择选项时，选择的包取决于选择的清单文件（如果未给出 --manifest-path，则基于当前工作目录）。如果清单是工作空间的根目录，则选择工作空间的默认成员，否则仅选择清单定义的包。

可以使用根清单中的 workspace.default-members 键显式设置工作空间的默认成员。如果未设置，则虚拟工作空间将包含所有工作空间成员（相当于传递 --workspace），而非虚拟工作空间将仅包含根 crate 本身。

-p 规范…
--package spec…: 仅测试指定的包。请参阅 cargo-pkgid(1) 了解 SPEC 格式。此标志可以指定多次，并支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理 glob 模式之前意外扩展它们，您必须在每个模式周围使用单引号或双引号。
--workspace: 测试工作区中的所有成员。
--all: 已弃用的 --workspace 别名。
--exclude SPEC…: 排除指定的包。必须与 --workspace 标志一起使用。此标志可以指定多次，并支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理 glob 模式之前意外扩展它们，您必须在每个模式周围使用单引号或双引号。

目标选择

当未给出目标选择选项时，cargo test 将构建所选包的以下目标

lib - 用于与二进制文件、示例、集成测试和文档测试链接
bins（仅在构建集成测试并且所需功能可用时）
examples - 以确保它们编译
lib 作为单元测试
bins 作为单元测试
集成测试
lib 目标的文档测试

可以通过在清单设置中为目标设置 test 标志来更改默认行为。将 examples 设置为 test = true 将构建示例并将其作为测试运行，将示例的 main 函数替换为 libtest 工具。如果您不希望替换 main 函数，请同时包含 harness = false，在这种情况下，示例将按原样构建和执行。

将目标设置为 test = false 将阻止默认情况下对其进行测试。按名称获取目标的目标选择选项（例如 --example foo）会忽略 test 标志，并且始终会测试给定的目标。

可以通过在清单中为库设置 doctest = false 来禁用库的文档测试。

有关每个目标设置的更多信息，请参阅配置目标。

如果要选择测试集成测试或基准测试，则会自动构建二进制目标。这允许集成测试执行二进制文件以练习和测试其行为。构建集成测试时会设置 CARGO_BIN_EXE_<name> 环境变量，以便它可以使用 env 宏来定位可执行文件。

传递目标选择标志将仅测试指定的测试目标。

请注意，--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理 glob 模式之前意外扩展它们，您必须在每个 glob 模式周围使用单引号或双引号。

--lib: 测试包的库。
--bin name…: 测试指定的二进制文件。此标志可以指定多次，并支持常见的 Unix glob 模式。
--bins: 测试所有二进制目标。
--example name…: 测试指定的示例。此标志可以指定多次，并支持常见的 Unix glob 模式。
--examples: 测试所有示例目标。
--test name…: 测试指定的集成测试。此标志可以指定多次，并支持常见的 Unix glob 模式。
--tests: 测试测试模式下所有设置了 test = true 清单标志的目标。默认情况下，这包括作为单元测试构建的库和二进制文件，以及集成测试。请注意，这也会构建任何所需的依赖项，因此 lib 目标可能会构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标的清单设置中设置 test 标志来启用或禁用目标。
--bench name…: 测试指定的基准测试。此标志可以指定多次，并支持常见的 Unix glob 模式。
--benches: 测试基准测试模式下所有设置了 bench = true 清单标志的目标。默认情况下，这包括作为基准测试构建的库和二进制文件，以及基准测试目标。请注意，这也会构建任何所需的依赖项，因此 lib 目标可能会构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 bench 标志来启用或禁用目标。
--all-targets: 测试所有目标。这等效于指定 --lib --bins --tests --benches --examples。

--doc: 仅测试库的文档。这不能与其他目标选项混合使用。

功能选择

功能标志允许您控制启用哪些功能。当未给出功能选项时，将为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

-F features
--features features: 要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。此标志可以指定多次，这将启用所有指定的功能。
--all-features: 激活所有选定包的所有可用功能。
--no-default-features: 不要激活所选包的 default 功能。

编译选项

--target triple

测试给定的体系结构。默认值为主机体系结构。三元组的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取支持的目标列表。此标志可以指定多次。

这也可以使用 build.target 配置值指定。

请注意，指定此标志会使 Cargo 在目标工件放置在单独目录中的不同模式下运行。有关更多详细信息，请参阅构建缓存文档。

-r

--release

使用 release 配置文件测试优化的工件。另请参阅 --profile 选项以按名称选择特定配置文件。

--profile name

使用给定的配置文件进行测试。有关配置文件的更多详细信息，请参阅参考。

--timings=fmts

输出有关每个编译花费多长时间的信息，并跟踪随时间推移的并发信息。接受可选的逗号分隔的输出格式列表；没有参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，需要 -Zunstable-options。有效的输出格式

html（不稳定，需要 -Zunstable-options）：将包含编译报告的人类可读文件 cargo-timing.html 写入 target/cargo-timings 目录。如果您想查看旧的运行，还可以将报告写入文件名中带有时间戳的同一目录。HTML 输出仅适用于人类阅读，不提供机器可读的计时数据。
json（不稳定，需要 -Zunstable-options）：发出有关计时信息的机器可读 JSON 信息。

输出选项

--target-dir directory: 所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为工作区根目录中的 target。

显示选项

默认情况下，Rust 测试工具会隐藏测试执行的输出，以保持结果的可读性。可以通过将 --nocapture 传递给测试二进制文件来恢复测试输出（例如，用于调试）

cargo test -- --nocapture

-v

--verbose

使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值指定。

-q

--quiet

不要打印 cargo 日志消息。也可以使用 term.quiet 配置值指定。

--color 何时

控制何时使用彩色输出。有效值

auto（默认）：自动检测终端是否支持彩色。
always：始终显示颜色。
never：从不显示颜色。

也可以使用 term.color 配置值指定。

--message-format fmt

诊断消息的输出格式。可以指定多次，并由逗号分隔的值组成。有效值

human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
short：发出更短、人类可读的文本消息。与 human 和 json 冲突。
json：将 JSON 消息发送到标准输出。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
json-diagnostic-short：确保 JSON 消息的 rendered 字段包含 rustc 的“简短”渲染。不能与 human 或 short 一起使用。
json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入式 ANSI 颜色代码，以遵循 rustc 的默认配色方案。不能与 human 或 short 一起使用。
json-render-diagnostics：指示 Cargo 不要在打印的 JSON 消息中包含 rustc 诊断信息，而是 Cargo 本身应该渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息和其他来自 rustc 的诊断信息仍然会被发送。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径

Cargo.toml 文件的路径。默认情况下，Cargo 在当前目录或任何父目录中搜索 Cargo.toml 文件。

--ignore-rust-version

忽略包中的 rust-version 规范。

--locked

断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全相同。当出现以下任一情况时，Cargo 将退出并报错

缺少锁文件。
由于不同的依赖项解析，Cargo 尝试更改锁文件。

它可以在需要确定性构建的环境中使用，例如在 CI 管道中。

--offline

阻止 Cargo 出于任何原因访问网络。如果没有此标志，Cargo 在需要访问网络而网络不可用时将停止并报错。使用此标志，Cargo 将尝试在可能的情况下在没有网络的情况下继续进行。

请注意，这可能会导致与在线模式不同的依赖项解析。Cargo 将限制自己使用本地下载的 crate，即使本地索引副本中可能指示有更新的版本。请参阅 cargo-fetch(1) 命令以下载依赖项，然后再脱机。

也可以使用 net.offline 配置值指定。

--frozen

等效于同时指定 --locked 和 --offline。

常用选项

+工具链

如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。

--config KEY=VALUE 或路径

覆盖 Cargo 配置值。参数应采用 KEY=VALUE 的 TOML 语法，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅命令行覆盖部分。

-C 路径

在执行任何指定的操作之前更改当前工作目录。例如，这会影响 cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 的目录。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在夜间版通道上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h

--help

打印帮助信息。

-Z 标志

Cargo 的不稳定（仅限夜间版）标志。运行 cargo -Z help 获取详细信息。

其他选项

--jobs 参数会影响测试可执行文件的构建，但不会影响运行测试时使用的线程数。Rust 测试工具包含一个选项来控制使用的线程数

cargo test -j 2 -- --test-threads=2

-j N

--jobs N

要运行的并行作业数。也可以使用 build.jobs 配置值指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数加上提供的值。如果提供了字符串 default，则将值设置回默认值。不应为 0。

--future-incompat-report

显示在执行此命令期间产生的任何未来不兼容警告的未来不兼容报告

请参阅 cargo-report(1)

虽然 cargo test 涉及编译，但它不提供 --keep-going 标志。使用 --no-fail-fast 运行尽可能多的测试，而不会在第一次失败时停止。要“编译”尽可能多的测试，请使用 --tests 单独构建测试二进制文件。例如

cargo build --tests --keep-going
cargo test --tests --no-fail-fast

环境

有关 Cargo 读取的环境变量的详细信息，请参阅参考。

退出状态

0：Cargo 成功。
101：Cargo 未能完成。

示例

执行当前包的所有单元测试和集成测试
```
cargo test
```
仅运行其名称与过滤器字符串匹配的测试
```
cargo test name_filter
```

仅运行特定集成测试中的特定测试

cargo test --test int_test_name -- modname::test_name

另请参阅

cargo(1)、cargo-bench(1)、测试类型、如何编写测试

Cargo 指南