Rust 编程语言

测试组织

正如本章开头所提到的，测试是一门复杂的学科，不同的人使用不同的术语和组织方式。Rust 社区从两个主要类别来考虑测试：单元测试和集成测试。 单元测试规模较小，更专注，一次只测试一个模块，并且可以测试私有接口。 集成测试完全独立于您的库，并以任何其他外部代码相同的方式使用您的代码，仅使用公共接口，并且每个测试可能会运行多个模块。

编写这两种测试都很重要，以确保您的库的各个部分能够按照您的预期单独和一起工作。

单元测试

单元测试的目的是独立于其余代码测试每个代码单元，以便快速查明代码在哪些地方按预期工作，哪些地方没有按预期工作。您需要将单元测试放在 src 目录中，与它们正在测试的代码位于同一个文件中。约定是在每个文件中创建一个名为 tests 的模块来包含测试函数，并使用 cfg(test) 对该模块进行注释。

测试模块和 #[cfg(test)]

测试模块上的 #[cfg(test)] 注释告诉 Rust 仅在运行 cargo test 时编译和运行测试代码，而在运行 cargo build 时不编译和运行。当您只想构建库时，这可以节省编译时间，并且可以节省生成的已编译工件中的空间，因为测试不包含在内。您将看到，由于集成测试位于不同的目录中，因此它们不需要 #[cfg(test)] 注释。但是，由于单元测试与代码位于同一文件中，因此您将使用 #[cfg(test)] 来指定它们不应包含在编译结果中。

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

文件名：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);
    }
}

这段代码是自动生成的测试模块。属性 cfg 代表 配置，并告诉 Rust 仅在给定某个配置选项的情况下才包含以下项目。在这种情况下，配置选项是 test，它由 Rust 提供，用于编译和运行测试。通过使用 cfg 属性，Cargo 仅在我们使用 cargo test 主动运行测试时才编译我们的测试代码。这包括可能在此模块内的任何辅助函数，以及使用 #[test] 注释的函数。

测试私有函数

在测试社区中，关于是否应该直接测试私有函数存在争议，其他语言也使得测试私有函数变得困难或不可能。无论您遵循哪种测试理念，Rust 的隐私规则都允许您测试私有函数。考虑清单 11-12 中的代码，其中包含私有函数 internal_adder。

文件名：src/lib.rs

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

fn internal_adder(a: i32, b: i32) -> i32 {
    a + b
}

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

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

清单 11-12：测试私有函数

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

集成测试

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

tests 目录

我们在项目目录的顶层创建一个 tests 目录，与 src 目录位于同一级别。Cargo 知道在此目录中查找集成测试文件。然后，我们可以根据需要创建任意数量的测试文件，Cargo 会将每个文件编译为一个单独的 Crate。

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

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

在 tests/integration_test.rs 文件中输入清单 11-13 中的代码

文件名：tests/integration_test.rs

use adder::add_two;

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

清单 11-13：对 adder Crate 中函数的集成测试

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

我们不需要在 tests/integration_test.rs 中使用 #[cfg(test)] 注释任何代码。Cargo 会特殊对待 tests 目录，并且仅在运行 cargo test 时编译此目录中的文件。现在运行 cargo test

$ cargo test
   Compiling adder v0.1.0 (file:///projects/adder)
    Finished test [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

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

单元测试的第一部分与我们之前看到的一样：每个单元测试一行（一个名为 internal 的测试，我们在清单 11-12 中添加了它），然后是单元测试的汇总行。

集成测试部分以 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 [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
}

当我们再次运行测试时，我们将在测试输出中看到 common.rs 文件的新部分，即使该文件不包含任何测试函数，我们也没有从任何地方调用 setup 函数

$ cargo test
   Compiling adder v0.1.0 (file:///projects/adder)
    Finished test [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;

mod common;

#[test]
fn it_adds_two() {
    common::setup();
    assert_eq!(4, adder::add_two(2));
}

请注意，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 文件中的逻辑。使用该结构，集成测试可以测试库 crate，并使用 use 使重要功能可用。如果重要功能正常，则 src/main.rs 文件中的少量代码也将正常工作，并且不需要测试少量代码。

总结

Rust 的测试功能提供了一种方法来指定代码应如何运行，以确保即使在您进行更改时它也能继续按预期工作。单元测试分别测试库的不同部分，并且可以测试私有实现细节。集成测试检查库的许多部分是否可以正常协同工作，并且它们使用库的公共 API 以与外部代码相同的方式测试代码。即使 Rust 的类型系统和所有权规则有助于防止某些类型的错误，但测试对于减少与代码预期行为相关的逻辑错误仍然很重要。

让我们结合您在本章和前几章中学到的知识来开展一个项目！