rust-tests-guidelines

编写 Rust 测试的指南

为 Rust 代码编写新测试的指南。

指南

1. 针对被测代码的公共 API 编写测试。
2. 仅当私有组件非常复杂，且难以通过公共 API 测试时，才测试私有 API。
3. 对难以预测或比较的输出进行测试时，使用 insta。
4. 适当时，使用 proptest 为关键不变量添加基于属性的测试。
5. 编写测试代码时，应像编写生产代码一样认真。 避免不必要的重复，添加辅助函数以减少样板代码并确保可读性。 测试的意图应当一目了然；如果无法做到，则应清楚地记录。
6. 不要在注释中引用确切的行号，因为行号可能会随时间变化。

代码组织

1. 如果测试不依赖私有 API，请将其放在相关 crate 的 tests 目录下。
2. tests 目录应组织为一个 crate，包含一个 main.rs 文件，并将所有测试放在模块中。 请参考 trie_rs/tests 目录。
3. 如果测试必须依赖私有 API，请使用 #[cfg(test)] 模块，将测试与被测代码放在一起。

处理 extern C 符号

有关如何处理 Rust 测试中未定义的 C 符号，请参阅 CONTRIBUTING.md。