如何编写测试
测试是 Rust 函数，用于验证非测试代码是否按预期方式运行。测试函数的主体通常执行以下三个操作：
- 设置所需的数据或状态。
- 运行您要测试的代码。
- 断言结果是你所期望的。
让我们看看 Rust 为编写这些操作的测试提供的特性，包括 test 属性、几个宏和 should_panic 属性。
测试函数的结构
最简单的情况下，Rust 中的测试是一个带有 test 属性的函数。属性是关于 Rust 代码片段的元数据；一个例子是我们在第 5 章中与结构体一起使用的 derive 属性。要将一个函数转换为测试函数，只需在 fn 前一行添加 #[test]。当你使用 cargo test 命令运行测试时，Rust 会构建一个测试运行器二进制文件，该文件运行带有注解的函数并报告每个测试函数是否通过或失败。
每当我们使用 Cargo 创建一个新的库项目时，都会自动生成一个包含测试函数的测试模块。这个模块为你提供了一个编写测试的模板，这样每次开始新项目时，你就不必查找确切的结构和语法。你可以根据需要添加任意多的测试函数和测试模块！
我们将通过实验模板测试来探索测试工作的一些方面，然后再实际测试任何代码。然后我们将编写一些调用我们编写的一些代码并断言其行为正确的实际测试。
让我们创建一个名为 adder 的新库项目，它将添加两个数字：
$ cargo new adder --lib
Created library `adder` project
$ cd adder
src/lib.rs 文件中的内容在你的 adder 库中应该像
列表 11-1。
pub fn add(left: u64, right: u64) -> u64 {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
let result = add(2, 2);
assert_eq!(result, 4);
}
}cargo new现在，让我们只关注 it_works 函数。注意 #[test]
注解：这个属性表示这是一个测试函数，因此测试运行器知道将此函数视为测试。我们可能在 tests 模块中还有非测试函数，用于帮助设置常见场景或执行常见操作，所以我们总是需要指明哪些函数是测试。
示例函数体使用 assert_eq! 宏来断言 result，其中包含 2 加 2 的结果，等于 4。这个断言作为典型测试格式的一个例子。让我们运行它以查看此测试是否通过。
cargo test 命令会运行我们项目中的所有测试，如列表 11-2 所示。
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.57s
Running unittests src/lib.rs (file:///projects/adder/target/debug/deps/adder-7acb243c25ffd9dc)
running 1 test
test tests::it_works ... ok
test result: ok. 1 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 编译并运行了测试。我们看到一行 running 1 test。下一行显示了生成的测试函数的名称，称为 tests::it_works，以及运行该测试的结果是 ok。总体摘要 test result: ok. 表示所有测试都通过了，而 1 passed; 0 failed 部分统计了通过或失败的测试数量。
可以将测试标记为忽略，这样在特定情况下它不会运行；我们将在本章后面的“除非特别要求否则忽略某些测试”部分中介绍。因为我们在这里没有这样做，所以摘要显示0 ignored。
0 measured 统计数据是用于测量性能的基准测试。
截至本文撰写时，基准测试仅在 nightly Rust 中可用。请参阅 关于基准测试的文档 以了解更多信息。
我们可以传递一个参数给cargo test命令来仅运行名称与字符串匹配的测试；这被称为过滤，我们将在“按名称运行测试子集”部分中介绍。在这里，我们没有过滤正在运行的测试，因此总结的末尾显示0 filtered out。
从 Doc-tests adder 开始的测试输出部分是关于任何文档测试的结果。我们还没有任何文档测试，但 Rust 可以编译出现在我们 API 文档中的任何代码示例。此功能有助于保持您的文档和代码同步！我们将在第 14 章的 “文档注释作为测试” 部分讨论如何编写文档测试。目前，我们将忽略 Doc-tests 输出。
让我们开始根据自己的需求自定义测试。首先，将 it_works 函数的名称更改为其他名称，例如 exploration，如下所示：
文件名: src/lib.rs
pub fn add(left: usize, right: usize) -> usize {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn exploration() {
let result = add(2, 2);
assert_eq!(result, 4);
}
}然后再次运行 cargo test。现在的输出显示 exploration 而不是 it_works：
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.59s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test tests::exploration ... ok
test result: ok. 1 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
现在我们将添加另一个测试，但这次我们将创建一个失败的测试！当测试函数中的某些内容引发恐慌时，测试就会失败。每个测试都在一个新线程中运行，当主线程看到测试线程已死亡时，该测试就会被标记为失败。在第 9 章中，我们讨论了引发恐慌的最简单方法是调用 panic! 宏。将新测试作为名为 another 的函数输入，因此您的 src/lib.rs 文件看起来像列表 11-3。
pub fn add(left: usize, right: usize) -> usize {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn exploration() {
let result = add(2, 2);
assert_eq!(result, 4);
}
#[test]
fn another() {
panic!("Make this test fail");
}
}panic! macro再次使用 cargo test 运行测试。输出应该如清单 11-4 所示，显示我们的 exploration 测试通过了，而 another 失败了。
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.72s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 2 tests
test tests::another ... FAILED
test tests::exploration ... ok
failures:
---- tests::another stdout ----
thread 'tests::another' panicked at src/lib.rs:17:9:
Make this test fail
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::another
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`
而不是 ok，行 test tests::another 显示 FAILED。在各个结果和摘要之间出现了两个新的部分：第一部分显示每个测试失败的详细原因。在这种情况下，我们得到的详细信息是 another 失败是因为它在 src/lib.rs 文件的第 17 行 panicked at 'Make this test fail'。下一部分仅列出所有失败测试的名称，当有很多测试和很多详细的失败测试输出时，这非常有用。我们可以使用失败测试的名称来仅运行该测试，以便更容易地调试它；我们将在 “控制测试的运行方式” 部分中更详细地讨论运行测试的方法。
总结行显示在最后：总体而言，我们的测试结果是FAILED。我们有一个测试通过，一个测试失败。
现在你已经看到了在不同场景下的测试结果，让我们来看看一些除了panic!之外在测试中有用的宏。
使用 assert! 宏检查结果
assert! 宏由标准库提供，当你希望确保测试中的某个条件评估为 true 时非常有用。我们给 assert! 宏一个评估为布尔值的参数。如果值为 true，则不会发生任何事情，测试通过。如果值为 false，assert! 宏会调用 panic! 使测试失败。使用 assert! 宏有助于我们检查代码是否按我们预期的方式运行。
在第 5 章，列表 5-15 中，我们使用了一个 Rectangle 结构体和一个 can_hold 方法，这些内容在列表 11-5 中再次列出。让我们将这段代码放在 src/lib.rs 文件中，然后使用 assert! 宏编写一些测试。
#[derive(Debug)]
struct Rectangle {
width: u32,
height: u32,
}
impl Rectangle {
fn can_hold(&self, other: &Rectangle) -> bool {
self.width > other.width && self.height > other.height
}
}Rectangle struct and its can_hold method from Chapter 5can_hold 方法返回一个布尔值，这意味着它是 assert! 宏的完美用例。在清单 11-6 中，我们编写了一个测试，通过创建一个宽度为 8 和高度为 7 的 Rectangle 实例，并断言它可以容纳另一个宽度为 5 和高度为 1 的 Rectangle 实例来测试 can_hold 方法。
#[derive(Debug)]
struct Rectangle {
width: u32,
height: u32,
}
impl Rectangle {
fn can_hold(&self, other: &Rectangle) -> bool {
self.width > other.width && self.height > other.height
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn larger_can_hold_smaller() {
let larger = Rectangle {
width: 8,
height: 7,
};
let smaller = Rectangle {
width: 5,
height: 1,
};
assert!(larger.can_hold(&smaller));
}
}can_hold that checks whether a larger rectangle can indeed hold a smaller rectangle注意 use super::*; 这一行在 tests 模块内。 tests 模块是一个遵循我们在第 7 章 “模块树中引用项的路径”
部分讨论的通常可见性规则的普通模块。因为 tests 模块是一个内部模块，我们需要将外部模块中的待测试代码引入到内部模块的作用域中。这里我们使用了一个通配符，所以我们在外部模块中定义的任何内容都对这个 tests 模块可用。
我们已经将测试命名为larger_can_hold_smaller，并且创建了我们需要的两个Rectangle实例。然后我们调用了assert!宏，并将larger.can_hold(&smaller)的调用结果传递给它。这个表达式应该返回true，所以我们的测试应该通过。让我们看看结果！
$ cargo test
Compiling rectangle v0.1.0 (file:///projects/rectangle)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
running 1 test
test tests::larger_can_hold_smaller ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests rectangle
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
它通过了！让我们再加一个测试，这次断言一个较小的矩形不能包含一个较大的矩形：
文件名: src/lib.rs
#[derive(Debug)]
struct Rectangle {
width: u32,
height: u32,
}
impl Rectangle {
fn can_hold(&self, other: &Rectangle) -> bool {
self.width > other.width && self.height > other.height
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn larger_can_hold_smaller() {
// --snip--
let larger = Rectangle {
width: 8,
height: 7,
};
let smaller = Rectangle {
width: 5,
height: 1,
};
assert!(larger.can_hold(&smaller));
}
#[test]
fn smaller_cannot_hold_larger() {
let larger = Rectangle {
width: 8,
height: 7,
};
let smaller = Rectangle {
width: 5,
height: 1,
};
assert!(!smaller.can_hold(&larger));
}
}因为在这种情况下 can_hold 函数的正确结果是 false，所以我们需要在将其传递给 assert! 宏之前否定该结果。因此，如果 can_hold 返回 false，我们的测试将通过：
$ cargo test
Compiling rectangle v0.1.0 (file:///projects/rectangle)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
running 2 tests
test tests::larger_can_hold_smaller ... ok
test tests::smaller_cannot_hold_larger ... ok
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests rectangle
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
两个测试通过了！现在让我们看看当我们在代码中引入一个错误时，测试结果会发生什么变化。我们将通过将比较宽度时的大于号替换为小于号来更改can_hold方法的实现：
#[derive(Debug)]
struct Rectangle {
width: u32,
height: u32,
}
// --snip--
impl Rectangle {
fn can_hold(&self, other: &Rectangle) -> bool {
self.width < other.width && self.height > other.height
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn larger_can_hold_smaller() {
let larger = Rectangle {
width: 8,
height: 7,
};
let smaller = Rectangle {
width: 5,
height: 1,
};
assert!(larger.can_hold(&smaller));
}
#[test]
fn smaller_cannot_hold_larger() {
let larger = Rectangle {
width: 8,
height: 7,
};
let smaller = Rectangle {
width: 5,
height: 1,
};
assert!(!smaller.can_hold(&larger));
}
}现在运行测试会产生以下结果：
$ cargo test
Compiling rectangle v0.1.0 (file:///projects/rectangle)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
running 2 tests
test tests::larger_can_hold_smaller ... FAILED
test tests::smaller_cannot_hold_larger ... ok
failures:
---- tests::larger_can_hold_smaller stdout ----
thread 'tests::larger_can_hold_smaller' panicked at src/lib.rs:28:9:
assertion failed: larger.can_hold(&smaller)
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::larger_can_hold_smaller
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`
我们的测试捕获了这个bug！因为 larger.width 是 8 而 smaller.width 是 5，所以在 can_hold 中宽度的比较现在返回 false：8 不小于 5。
使用 assert_eq! 和 assert_ne! 宏测试相等性
验证功能的一种常见方法是测试代码测试结果与你期望代码返回的值之间的相等性。你可以通过使用 assert! 宏并传递一个使用 == 运算符的表达式来实现这一点。然而，这是一个非常常见的测试，因此标准库提供了一对宏——assert_eq! 和 assert_ne!——以更方便地执行此测试。这些宏分别比较两个参数的相等性或不相等性。如果断言失败，它们还会打印这两个值，这使得更容易看到 为什么 测试失败；相反，assert! 宏仅指示 == 表达式得到了一个 false 值，而不会打印导致 false 值的值。
在清单 11-7 中，我们编写了一个名为 add_two 的函数，该函数将其参数加 2，然后我们使用 assert_eq! 宏测试此函数。
pub fn add_two(a: usize) -> usize {
a + 2
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_adds_two() {
let result = add_two(2);
assert_eq!(result, 4);
}
}add_two using the assert_eq! macro让我们检查它是否通过！
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test tests::it_adds_two ... ok
test result: ok. 1 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
我们创建一个名为result的变量，该变量保存调用add_two(2)的结果。然后我们将result和4作为参数传递给assert_eq!。此测试的输出行为test tests::it_adds_two ... ok，ok文本表示我们的测试通过了！
让我们在代码中引入一个错误，看看assert_eq!在失败时是什么样子。将add_two函数的实现更改为加3：
pub fn add_two(a: usize) -> usize {
a + 3
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_adds_two() {
let result = add_two(2);
assert_eq!(result, 4);
}
}再次运行测试：
$ cargo test
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 tests::it_adds_two ... FAILED
failures:
---- tests::it_adds_two stdout ----
thread 'tests::it_adds_two' panicked at src/lib.rs:12:9:
assertion `left == right` failed
left: 5
right: 4
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::it_adds_two
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
我们的测试捕获了这个bug！it_adds_two 测试失败了，消息告诉我们 assertion `left == right` failed 以及 left 和 right 的值是什么。这条消息帮助我们开始调试：left 参数，我们调用 add_two(2) 的结果，是 5，但 right 参数是 4。你可以想象，当我们有很多测试时，这将特别有帮助。
请注意，在某些语言和测试框架中，相等性断言函数的参数被称为 expected 和 actual，并且我们指定参数的顺序很重要。然而，在 Rust 中，它们被称为 left 和 right，并且我们指定期望值和代码生成值的顺序并不重要。我们可以将此测试中的断言写为 assert_eq!(4, result)，这将产生相同的失败消息，显示 assertion failed: `(left == right)`。
assert_ne! 宏会在我们给它的两个值不相等时通过，如果它们相等则失败。这个宏在我们不确定一个值 会 是什么，但知道这个值肯定 不应该 是什么的情况下最有用。例如，如果我们正在测试一个保证会以某种方式改变其输入的函数，但输入被改变的方式取决于我们运行测试的星期几，那么最好的断言可能是函数的输出不等于输入。
在表面之下，assert_eq! 和 assert_ne! 宏分别使用 == 和 != 运算符。当断言失败时，这些宏使用调试格式打印其参数，这意味着被比较的值必须实现 PartialEq 和 Debug 特性。所有原始类型和大多数标准库类型都实现了这些特性。对于你自己定义的结构体和枚举，你需要实现 PartialEq 以断言这些类型的相等性。你还需要实现 Debug 以在断言失败时打印值。因为这两个特性都是可派生特性，如第 5 章列表 5-12 中所述，这通常只需在你的结构体或枚举定义中添加 #[derive(PartialEq, Debug)] 注解即可。有关这些和其他可派生特性的更多详细信息，请参阅附录 C，“可派生特性”，。
添加自定义失败消息
您还可以向 assert!、assert_eq! 和 assert_ne! 宏添加自定义消息，作为可选参数与失败消息一起打印。在必需参数之后指定的任何参数都会传递给 format! 宏（在第 8 章的“使用 + 运算符或 format! 宏进行连接”部分讨论），因此您可以传递一个包含 {} 占位符的格式字符串和要填入这些占位符的值。自定义消息对于记录断言的含义很有用；当测试失败时，您将更好地了解代码的问题所在。
例如，假设我们有一个通过名字问候人的函数，我们想要测试我们传递给函数的名字是否出现在输出中：
文件名: src/lib.rs
pub fn greeting(name: &str) -> String {
format!("Hello {name}!")
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn greeting_contains_name() {
let result = greeting("Carol");
assert!(result.contains("Carol"));
}
}这个程序的要求尚未确定，我们相当确定问候语开头的Hello文本将会更改。我们决定当需求变更时，不想更新测试，因此我们不会检查greeting函数返回值的完全相等性，而是断言输出包含输入参数的文本。
现在让我们通过更改 greeting 以排除 name 来引入一个错误，看看默认的测试失败是什么样的：
pub fn greeting(name: &str) -> String {
String::from("Hello!")
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn greeting_contains_name() {
let result = greeting("Carol");
assert!(result.contains("Carol"));
}
}运行此测试会产生以下结果：
$ cargo test
Compiling greeter v0.1.0 (file:///projects/greeter)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s
Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
running 1 test
test tests::greeting_contains_name ... FAILED
failures:
---- tests::greeting_contains_name stdout ----
thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
assertion failed: result.contains("Carol")
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::greeting_contains_name
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
这个结果只是表明断言失败以及断言所在的行。一个更有用的失败消息会打印出 greeting 函数的值。让我们添加一个自定义的失败消息，该消息由一个带有占位符的格式字符串组成，占位符用从 greeting 函数获取的实际值填充：
pub fn greeting(name: &str) -> String {
String::from("Hello!")
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn greeting_contains_name() {
let result = greeting("Carol");
assert!(
result.contains("Carol"),
"Greeting did not contain name, value was `{result}`"
);
}
}现在当我们运行测试时，我们将获得一个更具信息性的错误消息：
$ cargo test
Compiling greeter v0.1.0 (file:///projects/greeter)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.93s
Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
running 1 test
test tests::greeting_contains_name ... FAILED
failures:
---- tests::greeting_contains_name stdout ----
thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
Greeting did not contain name, value was `Hello!`
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::greeting_contains_name
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
我们可以从测试输出中看到实际得到的值，这将帮助我们调试实际发生的情况，而不是我们期望发生的情况。
使用 should_panic 检查恐慌
除了检查返回值之外，确保我们的代码按预期处理错误条件也很重要。例如，考虑我们在第 9 章，列表 9-13 中创建的 Guess 类型。使用 Guess 的其他代码依赖于 Guess 实例将仅包含 1 到 100 之间的值的保证。我们可以编写一个测试，以确保尝试使用该范围之外的值创建 Guess 实例时会引发恐慌。
我们通过在测试函数中添加属性 should_panic 来实现这一点。如果函数内的代码引发恐慌，则测试通过；如果函数内的代码没有引发恐慌，则测试失败。
列表 11-8 显示了一个测试，该测试检查 Guess::new 的错误条件是否在我们预期时发生。
pub struct Guess {
value: i32,
}
impl Guess {
pub fn new(value: i32) -> Guess {
if value < 1 || value > 100 {
panic!("Guess value must be between 1 and 100, got {value}.");
}
Guess { value }
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[should_panic]
fn greater_than_100() {
Guess::new(200);
}
}panic!我们将 #[should_panic] 属性放在 #[test] 属性之后和它所应用的测试函数之前。让我们看看当这个测试通过时的结果：
$ cargo test
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
running 1 test
test tests::greater_than_100 - should panic ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests guessing_game
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
看起来不错！现在让我们通过移除 new 函数在值大于 100 时会 panic 的条件来引入一个 bug：
pub struct Guess {
value: i32,
}
// --snip--
impl Guess {
pub fn new(value: i32) -> Guess {
if value < 1 {
panic!("Guess value must be between 1 and 100, got {value}.");
}
Guess { value }
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[should_panic]
fn greater_than_100() {
Guess::new(200);
}
}当我们运行列表 11-8 中的测试时，它将失败：
$ cargo test
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s
Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
running 1 test
test tests::greater_than_100 - should panic ... FAILED
failures:
---- tests::greater_than_100 stdout ----
note: test did not panic as expected
failures:
tests::greater_than_100
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
在这种情况下，我们没有得到非常有帮助的信息，但当我们查看测试函数时，我们看到它被标注为#[should_panic]。我们得到的失败意味着测试函数中的代码没有引发恐慌。
使用 should_panic 的测试可能不精确。如果测试因与我们预期不同的原因而恐慌，should_panic 测试也会通过。为了使 should_panic 测试更精确，我们可以在 should_panic 属性中添加一个可选的 expected 参数。测试框架将确保失败消息包含提供的文本。例如，考虑列表 11-9 中 Guess 的修改代码，其中 new 函数会根据值是太小还是太大而产生不同的恐慌消息。
pub struct Guess {
value: i32,
}
// --snip--
impl Guess {
pub fn new(value: i32) -> Guess {
if value < 1 {
panic!(
"Guess value must be greater than or equal to 1, got {value}."
);
} else if value > 100 {
panic!(
"Guess value must be less than or equal to 100, got {value}."
);
}
Guess { value }
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[should_panic(expected = "less than or equal to 100")]
fn greater_than_100() {
Guess::new(200);
}
}panic! with a panic message containing a specified substring这个测试会通过，因为我们放在 should_panic 属性的 expected 参数中的值是 Guess::new 函数抛出的恐慌消息的子字符串。我们可以指定我们期望的整个恐慌消息，在这种情况下是 Guess value must be less than or equal to 100, got 200。你选择指定的内容取决于恐慌消息中有多少是唯一的或动态的，以及你希望你的测试有多精确。在这种情况下，恐慌消息的子字符串足以确保测试函数中的代码执行 else if value > 100 分支。
要查看带有 expected 消息的 should_panic 测试失败时会发生什么，让我们再次通过交换 if value < 1 和 else if value > 100 块的主体来引入一个错误：
pub struct Guess {
value: i32,
}
impl Guess {
pub fn new(value: i32) -> Guess {
if value < 1 {
panic!(
"Guess value must be less than or equal to 100, got {value}."
);
} else if value > 100 {
panic!(
"Guess value must be greater than or equal to 1, got {value}."
);
}
Guess { value }
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[should_panic(expected = "less than or equal to 100")]
fn greater_than_100() {
Guess::new(200);
}
}这次当我们运行 should_panic 测试时，它将失败：
$ cargo test
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
running 1 test
test tests::greater_than_100 - should panic ... FAILED
failures:
---- tests::greater_than_100 stdout ----
thread 'tests::greater_than_100' panicked at src/lib.rs:12:13:
Guess value must be greater than or equal to 1, got 200.
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
note: panic did not contain expected string
panic message: `"Guess value must be greater than or equal to 1, got 200."`,
expected substring: `"less than or equal to 100"`
failures:
tests::greater_than_100
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
失败消息表明这个测试确实如我们所料发生了崩溃，但崩溃消息中并没有包含预期的字符串less than or equal to 100。在这种情况下，我们实际得到的崩溃消息是Guess value must be greater than or equal to 1, got 200. 现在我们可以开始找出我们的错误在哪里了！
在测试中使用 Result<T, E>
我们到目前为止的所有测试在失败时都会引发恐慌。我们也可以编写使用Result<T, E>的测试！这是来自列表 11-1 的测试，重写为使用Result<T, E>并返回一个Err而不是引发恐慌：
pub fn add(left: usize, right: usize) -> usize {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() -> Result<(), String> {
let result = add(2, 2);
if result == 4 {
Ok(())
} else {
Err(String::from("two plus two does not equal four"))
}
}
}it_works 函数现在具有 Result<(), String> 返回类型。在函数体中，我们不再调用 assert_eq! 宏，而是当测试通过时返回 Ok(())，当测试失败时返回带有 String 的 Err。
编写测试以返回 Result<T, E> 可以让你在测试的主体中使用问号操作符，这是一种方便的编写测试的方法，如果测试中的任何操作返回 Err 变体，测试应该失败。
你不能在使用 Result<T, E> 的测试上使用 #[should_panic] 注解。为了断言一个操作返回一个 Err 变体，不要 在 Result<T, E> 值上使用问号操作符。相反，使用 assert!(value.is_err())。
现在你已经了解了多种编写测试的方法，让我们来看看当我们运行测试时发生了什么，并探索我们可以与cargo test一起使用的不同选项。