11 テストを書く

[lemonadern]

https://doc.rust-jp.rs/book-ja/ch11-01-writing-tests.html

「プログラムのテストは、バグの存在を示すには非常に効率的な手法であるが、 バグの不在を示すには望み薄く不適切である」
エドガー・W・ダイクストラ

[lemonadern]

基本

• 評価に利用するマクロ
  • assert!, assert_eq!, assert_ne!
  • カスタム失敗メッセージ設定
• should_panic さらに詳しくエラーを捕捉する
• Result をテストで扱う

[lemonadern]

• テスト用のモジュールを用意する
• 直前に #[test] を置いた関数はテスト用の関数として扱われる (アプリのモジュールに含まれない)
• #[should_panic] を使うと、処理がパニックすることを確認するテストを書ける

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
    #[test]
    #[should_panic]
    fn fail() {
        panic!("Make this test fail");
    }
}

[lemonadern]

評価に利用するマクロ

• assert!()
  • true が返ることをassertする
• assert_eq!()
  • 2つの値が等しいことをassertする
• assert_ne!()
  • 2つの値が等しくないことをassertする

[lemonadern]

これらのマクロは、追加引数として失敗時のメッセージを渡すことができる

    #[test]
    fn greeting_contains_name() {
        let result = greeting("Carol");
        assert!(
            result.contains("Carol"),
            //挨拶(greeting)は名前を含んでいません。その値は`{}`でした
            "Greeting did not contain name, value was `{}`",
            result
        );
    }

[lemonadern]

should_panic 属性で詳しくエラーを捕捉する

• should_panic 属性はpanicすることしか示さない（想定外の理由でパニックしていても気づかない）
• should_panic 属性に expected 引数を追加すると、panic 時のメッセージにそのテキストが含まれていることを確かめてくれる

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

    #[test]
    //予想値は100以下でなければなりません
    #[should_panic(expected = "Guess value must be less than or equal to 100")]
    fn greater_than_100() {
        Guess::new(200);
    }
}

[lemonadern]

Result を テストで扱う

関数の返り値の型を Result にして、Ok または Err を直接返すことでテストの成功・失敗を表現できる

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() -> Result<(), String> {
        if 2 + 2 == 4 {
            Ok(())
        } else {
            Err(String::from("two plus two does not equal four"))
        }
    }
}

• このとき、この関数内では ? を利用できる

[lemonadern]

テストの実行のされ方を制御する

• スレッド数の制御
• 標準出力の表示
• テストを選んで実行する
• テストを無視する

[lemonadern]

スレッド数の制御

• デフォルトでは平行にテストが実行される
• 平行に実行したくないケース・スレッド数を制御したい場合は、 --test-threads フラグを利用する

// スレッド数を1に設定
cargo test -- --test-threads=1

[lemonadern]

標準出力の表示

• デフォルトでは、テスト成功時にはprintln出力は表示されない
• 全て出力させたい場合は --nocapture フラグを利用する

cargo test -- --nocapture

[lemonadern]

テストを選んで実行する

• 名前を引数に渡してテストを実行すると、その名前を含むモジュールやテスト関数のテストだけが実行される

cargo test add // add を含むテストが実行される

[lemonadern]

テストを無視する

• テスト関数に #[ignore] を属性をつけると、標準でそのテストが無視される
• --ignored フラグを渡してテストを実行すると、ignoredなテストだけが実行される

cargo test -- --ignored

[lemonadern]

テストの体系化

https://doc.rust-jp.rs/book-ja/ch11-03-test-organization.html

• 単体テストと結合テスト

[lemonadern]

単体テスト

• テスト対象のコードと同じファイルに書ける
• #[cfg(test)] を使って、tests モジュールがビルド時にコンパイルされないようにする

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

• 実装のモジュールの内部にテストを記述できるので、プライベート関数のテストも可能

// 非公開関数
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));
    }
}

[lemonadern]

結合テスト

• tests ディレクトリに書く（srcの隣）
• extern crate hoge; でhogeのインポートを行う
  • tests ディレクトリのテストはそれぞれ個別のクレート

extern crate adder;

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

• tests ディレクトリの中身は cargo test 時にしかコンパイルされない
• --test <file_name> とすると tests/<file_name>.rs ファイルにあるテストが全て実行される

[lemonadern]

結合テスト内のサブモジュール

https://doc.rust-jp.rs/book-ja/ch11-03-test-organization.html#%E7%B5%90%E5%90%88%E3%83%86%E3%82%B9%E3%83%88%E5%86%85%E3%81%AE%E3%82%B5%E3%83%96%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%BC%E3%83%AB

WIP

[lemonadern]

バイナリクレート用の結合テスト

https://doc.rust-jp.rs/book-ja/ch11-03-test-organization.html#%E3%83%90%E3%82%A4%E3%83%8A%E3%83%AA%E3%82%AF%E3%83%AC%E3%83%BC%E3%83%88%E7%94%A8%E3%81%AE%E7%B5%90%E5%90%88%E3%83%86%E3%82%B9%E3%83%88
WIP