Proptest 用于 Rust：完整指南及示例

什么是 Proptest，为什么需要它？

\n\n

Proptest 是 Rust 语言中一个强大的 基于属性的测试（property-based testing）库。与传统的单元测试不同（在单元测试中，您手动指定具体的输入数据和预期结果），基于属性的测试允许您描述程序对于任何有效输入数据都应满足的属性。该库会自动生成大量随机测试用例，并检查这些属性是否成立。

\n\n

为什么需要它？

\n

\n
• 发现隐藏的错误：随机数据通常能发现开发者甚至未曾想到的边界情况。
\n
• 减少测试代码量：无需编写数十个示例，只需编写一个属性。
\n
• 自动最小化（shrinking）：如果测试失败，Proptest 会自动尝试找到能重现错误的最小输入数据集。
\n
• 记录规范：属性是关于代码行为的、可验证的正式断言。
\n

\n\n

Proptest 的灵感来源于 Haskell 的 QuickCheck 库，但针对 Rust 的特性进行了适配，包括所有权、借用和 trait 的处理。

\n\n

安装

\n\n

Proptest 是一个 Rust 库，因此通过包管理器 Cargo 安装。将其添加到您的 Cargo.toml 文件的 [dev-dependencies] 部分：

\n\n

[dev-dependencies]\nproptest = "1.4"

\n\n

之后，运行 cargo build 或 cargo test 命令来下载并编译该库。Proptest 仅在测试期间使用，因此不会增加最终二进制文件的大小。

\n\n

对于异步代码（tokio, async-std），可能需要额外配置，但在大多数情况下，标准安装就足够了。

\n\n

快速入门及代码示例

\n\n

让我们编写一个简单的测试，验证 reverse（字符串反转）函数是一个对合运算：应用两次会返回原始字符串。

\n\n

// src/lib.rs\npub fn reverse(s: &str) -> String {\n    s.chars().rev().collect()\n}\n\n#[cfg(test)]\nmod tests {\n    use super::*;\n    use proptest::prelude::*;\n\n    proptest! {\n        #[test]\n        fn test_reverse_involution(s in ".*") { // ".*" — 任意字符串\n            let reversed = reverse(&s);\n            let double_reversed = reverse(&reversed);\n            prop_assert_eq!(s, double_reversed);\n        }\n    }\n}

\n\n

运行测试：cargo test。Proptest 将生成 256 个随机字符串（默认数量）并检查属性是否成立。如果测试失败，您将看到一条包含最小可重现示例的消息。

\n\n

主要方法和函数

\n\n

以下是 Proptest 的关键组件。每个都提供了描述、参数和示例。

\n\n

1. proptest! — 用于定义测试的宏

\n

描述： 启动基于属性测试的主要宏。它接受一个包含测试函数的代码块，并自动生成输入数据。

\n

参数： 在宏内部，您使用 #[test] 属性定义测试。输入数据以 param in strategy 的形式指定。

\n

示例：

\n

proptest! {\n    #[test]\n    fn test_addition_commutative(a in 0..100i32, b in 0..100i32) {\n        prop_assert_eq!(a + b, b + a);\n    }\n}

\n\n

2. prop_assert! 和 prop_assert_eq! — 断言

\n

描述： 类似于标准的 assert!