控制测试的运行方式
就像 cargo run
编译你的代码,然后运行生成的二进制文件一样,
cargo test
在 test 模式下编译您的代码并运行生成的 test 二进制文件。cargo test
生成的二进制文件的默认行为是并行运行所有测试并捕获测试运行期间生成的输出,从而防止显示输出,并使其更易于读取与测试结果相关的输出。但是,您可以指定命令行选项来更改此默认行为。
一些命令行选项转到 cargo test
,一些转到生成的 test 二进制文件。要分隔这两种类型的参数,请列出进入 cargo test
的参数,后跟分隔符 --
然后列出进入 test 二进制文件的参数。运行 cargo test --help
将显示可与 cargo test
一起使用的选项,运行 cargo test -- --help
将显示可在分隔符后使用的选项。
并行或连续运行测试
当您运行多个测试时,默认情况下,它们使用线程并行运行,这意味着它们更快地完成运行,并且您更快地获得反馈。由于测试同时运行,因此您必须确保测试不相互依赖或任何共享状态,包括共享环境,例如当前工作目录或环境变量。
例如,假设您的每个测试都运行一些代码,该代码在磁盘上创建一个名为 test-output.txt 的文件,并将一些数据写入该文件。然后,每个测试都会读取该文件中的数据,并断言该文件包含特定值,该值在每个测试中都不同。由于测试同时运行,因此一个测试可能会在另一个测试写入和读取文件之间的时间内覆盖文件。然后,第二个测试将失败,不是因为代码不正确,而是因为测试在并行运行时相互干扰。一种解决方案是确保每个测试写入不同的文件;另一种解决方案是一次运行一个测试。
如果您不想并行运行测试,或者想要对使用的线程数进行更精细的控制,则可以将 --test-threads
标志和要使用的线程数发送到测试二进制文件。请看以下示例:
$ cargo test -- --test-threads=1
我们将测试线程数设置为 1
,告诉程序不要使用任何并行度。使用一个线程运行测试比并行运行测试花费的时间更长,但如果测试共享状态,则测试不会相互干扰。
显示函数输出
默认情况下,如果测试通过,Rust 的测试库会捕获打印到标准输出的任何内容。例如,如果我们在测试中调用 println!
并且测试通过,我们将不会在终端中看到 println!
输出;我们只会看到指示测试通过的行。如果测试失败,我们将看到打印到标准输出的任何内容以及失败消息的其余部分。
举个例子,示例 11-10 有一个愚蠢的函数,它打印了它的参数值并返回 10,还有一个通过的测试和一个失败的测试。
文件名: src/lib.rs
fn prints_and_returns_10(a: i32) -> i32 {
println!("I got the value {a}");
10
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn this_test_will_pass() {
let value = prints_and_returns_10(4);
assert_eq!(value, 10);
}
#[test]
fn this_test_will_fail() {
let value = prints_and_returns_10(8);
assert_eq!(value, 5);
}
}
示例 11-10:测试调用
println!
当我们使用 cargo test
运行这些测试时,我们将看到以下输出:
$ cargo test
Compiling silly-function v0.1.0 (file:///projects/silly-function)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
running 2 tests
test tests::this_test_will_fail ... FAILED
test tests::this_test_will_pass ... ok
failures:
---- tests::this_test_will_fail stdout ----
I got the value 8
thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
assertion `left == right` failed
left: 10
right: 5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::this_test_will_fail
test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
请注意,在此输出中,我们没有看到 I got the value 4
,该值是在通过的测试运行时打印的。该输出已被捕获。失败的测试的输出 I got the value 8
显示在测试摘要输出的部分中,该部分还显示了测试失败的原因。
如果我们也想看到通过测试的打印值,我们可以告诉 Rust 也使用 --show-output
显示成功测试的输出:
$ cargo test -- --show-output
当我们使用 --show-output
标志再次运行示例 11-10 中的测试时,我们会看到以下输出:
$ cargo test -- --show-output
Compiling silly-function v0.1.0 (file:///projects/silly-function)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
running 2 tests
test tests::this_test_will_fail ... FAILED
test tests::this_test_will_pass ... ok
successes:
---- tests::this_test_will_pass stdout ----
I got the value 4
successes:
tests::this_test_will_pass
failures:
---- tests::this_test_will_fail stdout ----
I got the value 8
thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
assertion `left == right` failed
left: 10
right: 5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::this_test_will_fail
test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
按名称运行测试子集
有时,运行完整的测试套件可能需要很长时间。如果您正在处理特定区域中的代码,则可能只想运行与该代码相关的测试。您可以通过将要作为参数运行的测试的名称传递给 cargo test
来选择要运行的测试。
为了演示如何运行测试的子集,我们首先为 add_two
函数创建三个测试,如示例 11-11 所示,然后选择要运行的测试。
文件名: src/lib.rs
pub fn add_two(a: usize) -> usize {
a + 2
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn add_two_and_two() {
let result = add_two(2);
assert_eq!(result, 4);
}
#[test]
fn add_three_and_two() {
let result = add_two(3);
assert_eq!(result, 5);
}
#[test]
fn one_hundred() {
let result = add_two(100);
assert_eq!(result, 102);
}
}
示例 11-11:具有三个不同名称的三个测试
如果我们在不传递任何参数的情况下运行测试,正如我们之前看到的,所有测试都将并行运行:
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 3 tests
test tests::add_three_and_two ... ok
test tests::add_two_and_two ... ok
test tests::one_hundred ... ok
test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
运行单个测试
我们可以将任何测试函数的名称传递给 cargo test
以仅运行该测试:
$ cargo test one_hundred
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.69s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test tests::one_hundred ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s
仅运行名为 one_hundred
的测试;其他两个测试与该名称不匹配。测试输出通过在末尾显示 2 filtered out
来告诉我们还有更多测试未运行。
我们不能以这种方式指定多个测试的名称;将仅使用给定给 cargo test
的第一个值。但是有一种方法可以运行多个测试。
筛选以运行多个测试
我们可以指定测试名称的一部分,并且将运行名称与该值匹配的任何测试。例如,因为我们的两个测试名称包含 add
,我们可以通过运行 cargo test add
来运行这两个测试:
$ cargo test add
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 2 tests
test tests::add_three_and_two ... ok
test tests::add_two_and_two ... ok
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
此命令运行名称中包含 add
的所有测试,并筛选出名为 one_hundred
的测试。另请注意,出现测试的模块将成为测试名称的一部分,因此我们可以通过筛选模块名称来运行模块中的所有测试。
除非特别要求,否则忽略某些测试
有时,执行一些特定的测试可能非常耗时,因此您可能希望在大多数 cargo 测试
运行期间排除它们。与其将要运行的所有测试列为参数,不如使用 ignore
属性对耗时的测试进行注释以排除它们,如下所示:
文件名: src/lib.rs
pub fn add(left: usize, right: usize) -> usize {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
let result = add(2, 2);
assert_eq!(result, 4);
}
#[test]
#[ignore]
fn expensive_test() {
// code that takes an hour to run
}
}
在 #[test]
之后,我们将 #[ignore]
行添加到我们想要排除的测试中。现在,当我们运行测试时,it_works
运行,但 expensive_test
不会:
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 2 tests
test tests::expensive_test ... ignored
test tests::it_works ... ok
test result: ok. 1 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
expensive_test
函数列为 ignored
。如果我们只想运行被忽略的测试,我们可以使用 cargo test -- --ignored
:
$ cargo test -- --ignored
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test expensive_test ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
通过控制运行哪些测试,您可以确保您的货物测试结果
将快速返回。当您需要检查忽略
的测试的结果并且您有时间等待结果时,您可以运行 cargo test -- --ignored
来代替。如果要运行所有测试,无论它们是否被忽略,都可以运行 cargo test -- --include-ignored
.