Rustでテストコードをどこに書くべきか

質問内容

Rustを最近勉強し始めました。

Rustでテストコードを書きたいのですが、Rustではどこにテストコードを書くのがベストプラクティスなのでしょうか？ドキュメントを見てみると、Rustではコードとテストコードが下のように同じファイルにかけるということが謳われていました。

rust
1// ... (コード)
2
3#[cfg(test)]
4mod tests {
5    #[test]
6    fn test_fn_name(){
7        //...
8    }
9}

これはRustでは実際のコードとテストコードを同じファイルに書けと言うことなのでしょうか？

今、私はモジュールを書いていて、下のようなディレクトリ構造を作っています。

bash
1└── module_name
2    └── mod.rs

このようなときに、mod.rsのコードのテストをmodule_nameディレクトリ内に別ファイルとして作る（もしくはプロジェクトのルートディレクトリ直下にtestsディレクトリを作ってすべてのテストコードをその下に置く）という手法はRustではどれくらい一般的なのでしょうか？

初歩的な質問で申し訳ありませんがよろしくお願いします

行動規範の内容に同意します

回答1件

ベストアンサー

Rust/Cargoが提供するテストの枠組みはunit test, integration test, doctestの3種類に分けられますが、ここではunit testの話だと思いますのでその前提で話を進めます。

まず仕組みとしては

というものでした。そうするとunit testの置き方には大まかに以下の3つの方法が考えられます。

では実際にいくつかの著名ライブラリを見てみます。

まず標準ライブラリの std::num では2の方式が使われています。網羅的に見たわけではないですが、他のモジュールでもおおよそ同じ方式が使われていそうです。
log crateでも2の方式が使われているようです。
chrono crateでは1の方式が使われている例がありました。
num crate (の個別の実装)では2の方式と1の方式を両方発見できました。
parking_lot では2の方式が発見できました。
ほかにもいくつか思いついたライブラリを見てみましたが、2が主流で1が傍流という感じでした。