控制测试的运行方式 -- Rust教程|Rust中文文档|Rust编程|Rust官方文档

控制测试的运行方式

正如cargo run编译您的代码，然后运行生成的二进制文件cargo test在测试模式下编译代码并运行生成的测试二元的。生成的二进制文件的默认行为cargo test是运行并行所有测试并捕获测试运行期间生成的输出，防止显示输出并使其更易于读取与测试结果相关的输出。但是，您可以指定命令行选项来更改此默认行为。

一些命令行选项转到cargo test，有些会进入结果测试二元的。要分隔这两种类型的参数，请列出转到cargo test后跟分隔符，然后是转到测试二进制文件。运行--cargo test --help显示您可以使用的选项跟cargo test，然后运行cargo test -- --help显示选项可以在分隔符之后使用。

并行或连续运行测试

当您运行多个测试时，默认情况下，它们使用线程这意味着他们更快地完成运行，您也能更快地获得反馈。因为测试同时运行，您必须确保您的测试不依赖于彼此共享或任何共享状态（包括共享环境），例如当前工作目录或环境变量。

例如，假设您的每个测试都运行一些代码，该代码在磁盘上创建一个文件命名 test-output.txt 并将一些数据写入该文件。然后每个测试都会读取该文件中的数据，并断言该文件包含特定值这在每次测试中都是不同的。由于测试同时运行，因此一个 test 可能会在另一个测试写入和读取文件。第二个测试将失败，而不是因为代码是不正确，但因为测试在运行时相互干扰并行。一种解决方案是确保每个测试写入不同的文件; 另一种解决方案是一次运行一个测试。

如果您不想并行运行测试，或者想要更精细的控制使用的线程数，您可以发送--test-threads旗以及要用于测试二进制文件的线程数。查看以下示例：

$ cargo test -- --test-threads=1

我们将测试线程数设置为1，告诉程序不要使用任何排比。使用一个线程运行测试比运行测试花费的时间更长它们并行，但如果它们共享，则测试不会相互干扰州。

显示函数输出

默认情况下，如果测试通过，Rust 的测试库会捕获打印到标准输出。例如，如果我们调用println!in a test 和 the test 传递，我们不会看到println!终端中的输出;我们只会看到行，指示测试通过。如果测试失败，我们将看到打印到标准输出以及失败消息的其余部分。

举个例子，示例 11-10 有一个 silly 函数，它打印了参数并返回 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

当我们再次运行 Example 11-10 中的测试时，使用--show-outputflag 的请参阅以下输出：

$ 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 所示，然后选择要运行的 VPN。

文件名： 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 test.而不是将你想要运行的所有测试列为参数，你可以改为注释使用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 -- --ignored相反。如果要运行所有测试无论它们是否被忽略，您都可以运行cargo test -- --include-ignored.

Rust 编程语言