Rust 程序设计语言

测试的组织

正如本章开头所提到的，测试是一门复杂的学科，不同的人使用不同的术语和组织方式。Rust 社区从两个主要类别来思考测试：单元测试和集成测试。单元测试规模小且更聚焦，每次隔离地测试一个模块，可以测试私有接口。集成测试完全在你的库的外部，以与其他外部代码相同的方式使用你的代码，只使用公共接口，并且每个测试可能会涉及多个模块。

编写两种测试都很重要，以确保你的库的各个部分分别和组合在一起时都能按照你的预期工作。

单元测试

单元测试的目的是将每个代码单元与其余代码隔离进行测试，以快速定位代码在哪些地方符合预期、哪些地方不符合预期。你可以将单元测试放在 src 目录下的每个文件中，与它们所测试的代码放在一起。惯例是在每个文件中创建一个名为 tests 的模块来包含测试函数，并用 cfg(test) 对该模块进行注解。

tests 模块与 #[cfg(test)]

tests 模块上的 #[cfg(test)] 注解告诉 Rust 只在你运行 cargo test 时才编译和运行测试代码，而在运行 cargo build 时不这样做。当你只想构建库时，这可以节省编译时间，并在生成的编译产物中节省空间，因为测试不会被包含进来。你会看到，由于集成测试放在不同的目录中，它们不需要 #[cfg(test)] 注解。但由于单元测试与代码放在同一个文件中，你需要使用 #[cfg(test)] 来指定它们不应被包含在编译结果中。

回想一下，当我们在本章第一节生成新的 adder 项目时，Cargo 为我们生成了如下代码：

文件名：src/lib.rs

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);
    }
}

在自动生成的 tests 模块上，属性 cfg 代表配置（configuration），告诉 Rust 下面的项只有在给定某个配置选项时才应被包含。在本例中，配置选项是 test，Rust 提供它用于编译和运行测试。通过使用 cfg 属性，只有当我们通过 cargo test 主动运行测试时，Cargo 才会编译我们的测试代码。这包括除了用 #[test] 注解的函数之外，该模块内可能存在的任何辅助函数。

私有函数的测试

测试社区内部存在关于是否应该直接测试私有函数的争论，其他语言让测试私有函数变得困难甚至不可能。无论你坚持哪种测试理念，Rust 的隐私规则确实允许你测试私有函数。考虑列表 11-12 中带有私有函数 internal_adder 的代码。

pub fn add_two(a: u64) -> u64 {
    internal_adder(a, 2)
}

fn internal_adder(left: u64, right: u64) -> u64 {
    left + right
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn internal() {
        let result = internal_adder(2, 2);
        assert_eq!(result, 4);
    }
}

注意，internal_adder 函数没有被标记为 pub。测试只是 Rust 代码，而 tests 模块只是另一个模块。正如我们在“在模块树中引用项的路径”中讨论的，子模块中的项可以使用其祖先模块中的项。在这个测试中，我们使用 use super::* 将 tests 模块的父模块的所有项引入作用域，然后测试就可以调用 internal_adder。如果你认为不应该测试私有函数，Rust 中没有任何东西会强迫你这么做。

集成测试

在 Rust 中，集成测试完全在你的库的外部。它们以与任何其他代码相同的方式使用你的库，这意味着它们只能调用属于你的库公共 API 的函数。它们的目的是测试你库的多个部分是否能正确地协同工作。单独工作正常的代码单元在集成时可能会出现问题，因此对集成代码的测试覆盖同样重要。要创建集成测试，你首先需要一个 tests 目录。

tests 目录

我们在项目目录的顶层、src 旁边创建一个 tests 目录。Cargo 知道在此目录中查找集成测试文件。然后我们可以创建任意数量的测试文件，Cargo 会将每个文件作为一个单独的 crate 进行编译。

让我们创建一个集成测试。在 src/lib.rs 文件中仍保留列表 11-12 的代码，创建一个 tests 目录，并创建一个名为 tests/integration_test.rs 的新文件。你的目录结构应该如下所示：

adder
├── Cargo.lock
├── Cargo.toml
├── src
│   └── lib.rs
└── tests
    └── integration_test.rs

将列表 11-13 中的代码输入到 tests/integration_test.rs 文件中。

use adder::add_two;

#[test]
fn it_adds_two() {
    let result = add_two(2);
    assert_eq!(result, 4);
}

tests 目录中的每个文件都是一个单独的 crate，因此我们需要将库引入到每个测试 crate 的作用域中。因此，我们在代码顶部添加了 use adder::add_two;，这在单元测试中是不需要的。

我们不需要用 #[cfg(test)] 注解 tests/integration_test.rs 中的任何代码。Cargo 对 tests 目录有特殊处理，只在我们运行 cargo test 时编译该目录中的文件。现在运行 cargo test：

$ cargo test
   Compiling adder v0.1.0 (file:///projects/adder)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 1.31s
     Running unittests src/lib.rs (target/debug/deps/adder-1082c4b063a8fbe6)

running 1 test
test tests::internal ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

     Running tests/integration_test.rs (target/debug/deps/integration_test-1082c4b063a8fbe6)

running 1 test
test 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

输出的三个部分分别包括单元测试、集成测试和文档测试。请注意，如果某个部分中的任何测试失败，后续部分将不会运行。例如，如果一个单元测试失败，就不会有集成测试和文档测试的输出，因为只有当所有单元测试都通过时，这些测试才会运行。

单元测试的第一部分与我们之前看到的相同：每个单元测试一行（我们在列表 11-12 中添加的名为 internal 的测试），然后是单元测试的摘要行。

集成测试部分以 Running tests/integration_test.rs 这一行开始。接下来，该集成测试中的每个测试函数有一行，在 Doc-tests adder 部分开始之前，有一行是集成测试结果的摘要。

每个集成测试文件都有自己的部分，因此如果我们在 tests 目录中添加更多文件，将会有更多的集成测试部分。

我们仍然可以通过将测试函数的名称作为参数传给 cargo test 来运行某个特定的集成测试函数。要运行某个特定集成测试文件中的所有测试，请使用 cargo test 的 --test 参数，后跟文件名：

$ cargo test --test integration_test
   Compiling adder v0.1.0 (file:///projects/adder)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 0.64s
     Running tests/integration_test.rs (target/debug/deps/integration_test-82e7799c1bc62298)

running 1 test
test it_adds_two ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

此命令只运行 tests/integration_test.rs 文件中的测试。

集成测试中的子模块

随着你添加更多的集成测试，你可能希望在 tests 目录中创建更多文件来帮助组织它们；例如，你可以按测试的功能对测试函数进行分组。如前所述，tests 目录中的每个文件都会被编译为自己的单独 crate，这对于创建单独的作用域来更紧密地模仿最终用户使用你的 crate 的方式很有用。然而，这意味着 tests 目录中的文件与 src 中的文件行为不同，正如你在第 7 章中所学的如何将代码分离到模块和文件中。

当你有一组辅助函数要在多个集成测试文件中使用，并试图按照第 7 章“将模块分离到不同文件”一节中的步骤将它们提取到一个公共模块时，tests 目录文件的不同行为最为明显。例如，如果我们创建 tests/common.rs 并在其中放置一个名为 setup 的函数，我们可以向 setup 添加一些代码，这些代码我们希望能从多个测试文件中的多个测试函数中调用：

文件名：tests/common.rs

pub fn setup() {
    // setup code specific to your library's tests would go here
}

当我们再次运行测试时，即使此文件不包含任何测试函数，我们也没有从任何地方调用 setup 函数，测试输出中仍然会出现一个针对 common.rs 文件的新部分：

$ cargo test
   Compiling adder v0.1.0 (file:///projects/adder)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 0.89s
     Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)

running 1 test
test tests::internal ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

     Running tests/common.rs (target/debug/deps/common-92948b65e88960b4)

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

     Running tests/integration_test.rs (target/debug/deps/integration_test-92948b65e88960b4)

running 1 test
test 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

让 common 出现在测试结果中并显示 running 0 tests 并不是我们想要的。我们只是想与其他集成测试文件共享一些代码。为了避免 common 出现在测试输出中，我们将创建 tests/common/mod.rs 而不是 tests/common.rs。项目目录现在看起来如下：

├── Cargo.lock
├── Cargo.toml
├── src
│   └── lib.rs
└── tests
    ├── common
    │   └── mod.rs
    └── integration_test.rs

这是我们在第 7 章“备用文件路径”中提到的一种较旧的命名约定，Rust 也能理解。以这种方式命名文件告诉 Rust 不要将 common 模块当作集成测试文件。当我们将 setup 函数代码移动到 tests/common/mod.rs 并删除 tests/common.rs 文件后，测试输出中的部分将不再出现。tests 目录的子目录中的文件不会被编译为单独的 crate，也不会在测试输出中拥有对应的部分。

创建 tests/common/mod.rs 之后，我们可以从任何集成测试文件中将其作为模块来使用。下面是一个从 tests/integration_test.rs 中的 it_adds_two 测试调用 setup 函数的例子：

文件名：tests/integration_test.rs

use adder::add_two;

mod common;

#[test]
fn it_adds_two() {
    common::setup();

    let result = add_two(2);
    assert_eq!(result, 4);
}

注意，mod common; 声明与我们在列表 7-21 中演示的模块声明相同。然后，在测试函数中，我们可以调用 common::setup() 函数。

二进制 crate 的集成测试

如果我们的项目是一个只包含 src/main.rs 文件而没有 src/lib.rs 文件的二进制 crate，我们就无法在 tests 目录中创建集成测试，也无法用 use 语句将 src/main.rs 文件中定义的函数引入作用域。只有库 crate 才会暴露其他 crate 可以使用的函数；二进制 crate 意味着要独立运行。

这就是为什么提供二进制文件的 Rust 项目通常有一个简单的 src/main.rs 文件，它调用存放在 src/lib.rs 文件中的逻辑。使用这种结构，集成测试可以通过 use 测试库 crate，使重要功能可用。如果重要功能正常工作，src/main.rs 文件中的少量代码也会正常工作，而那少量代码不需要测试。

总结

Rust 的测试功能提供了一种方式来指定代码应如何工作，以确保即使在你做出修改时，它仍能按预期工作。单元测试分别演练库的不同部分，可以测试私有实现细节。集成测试检查库的多个部分是否能正确地协同工作，它们使用库的公共 API 以外部代码使用它的相同方式来测试代码。尽管 Rust 的类型系统和所有权规则有助于防止某些类型的 bug，测试对于减少与代码预期行为相关的逻辑 bug 仍然很重要。

让我们把你在本章和之前章节中学到的知识结合起来，去做一个项目吧！