[Rustのはじめ方] Part28: 単体テストとドキュメントテスト

// src/lib.rs や src/main.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); // resultが4と等しいかチェック
    }

    #[test]
    fn another_test() {
        // ここに別のテストを記述
        assert!(true); // 単純にtrueであることを表明
    }
}

pub struct Guess {
    value: i32,
}

impl Guess {
    pub fn new(value: i32) -> Guess {
        if value < 1 || value > 100 {
            panic!("Guess value must be between 1 and 100, got {}.", value);
        }
        Guess { value }
    }
}

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

    #[test]
    #[should_panic] // このテストはパニックすることを期待する
    fn greater_than_100() {
        Guess::new(200);
    }

    #[test]
    #[should_panic(expected = "Guess value must be between 1 and 100")] // 特定のメッセージでパニックすることを期待
    fn less_than_1() {
        Guess::new(0);
    }
}

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

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

    #[test]
    fn internal() {
        assert_eq!(internal_adder(2, 2), 4); // プライベート関数をテスト
    }
}

cargo test

cargo test it_works # it_works 関数のみ実行
cargo test tests:: # tests モジュール内の全テストを実行

// src/lib.rs

/// Adds two to the given number.
///
/// # Examples
///
/// ```/// let arg = 5;
/// let answer = my_crate::add_two(arg);
///
/// assert_eq!(7, answer);
/// ```
/// // 上記の ``` ``` 内のコードがドキュメントテストとして実行される
pub fn add_two(x: i32) -> i32 {
    x + 2
}

// もしクレート名が必要なら、実際のクレート名に置き換えるか、
// または以下のように `use` を使って書くこともできます。
/// ```
/// use your_crate_name::add_two; // use 文も書ける
/// assert_eq!(add_two(3), 5);
/// ```

// エラーを期待するドキュメントテスト
/// ```should_panic
/// use your_crate_name::add_two;
/// // パニックする例
/// // add_two(-100); // 例：もし負数を扱わない仕様ならパニックさせるなど
/// ```

// コンパイルエラーになるべきコード（例：型エラーなど）を示す場合
/// ```compile_fail
/// use your_crate_name::add_two;
/// // let result = add_two("hello"); // 文字列は渡せない
/// ```

// デフォルトで表示されないが、テストはされるコード
/// ```rust,ignore
/// // このコードはドキュメントには表示されにくいが、テストは実行される（状況による）
/// // 通常はテスト不要な補助コードなどに使うことがある
/// ```
/// // `ignore` は主にドキュメント生成ツールでの表示制御に使われることが多いが、
/// // `cargo test` では実行されることに注意。テスト実行も無視したい場合は `#` でコメントアウトする。

// コードブロック内で `?` を使う場合（main関数や #[test] 関数内でのみ有効）
/// ```rust
/// fn main() -> Result<(), std::io::Error> { // Result を返す関数内なら `?` が使える
///     // use std::fs::File;
///     // let file = File::open("nonexistent_file.txt")?;
///     Ok(())
/// }
/// ```

#[cfg(test)]
mod tests {
    // 単体テストはここに書く
}

// ダミーのクレート名設定（実際のクレート名に依存しないように）
// もし lib.rs なら、通常はクレート名が Cargo.toml で定義される
// 以下はドキュメントテスト内でクレート名を解決するための例（通常不要）
/**
```
# extern crate your_crate_name; // クレート名を仮定
# fn main() {
# let arg = 5;
# let answer = your_crate_name::add_two(arg);
# assert_eq!(7, answer);
# }
```
*/
pub mod your_crate_name { // ドキュメントテスト用のダミーモジュール
    pub use super::add_two;
}

cargo test