ユニットテスト - Rust By Example
Description: Rust by Example (RBE) is a collection of runnable examples that illustrate various Rust concepts and standard libraries.

## Keyboard shortcuts

Press `←` or `→` to navigate between chapters

Press `S` or `/` to search in the book

Press `?` to show this help

Press `Esc` to hide this help

# ユニットテスト

テストは、テスト以外のコードが想定通りに動いているかを確かめるRustの関数です。一般にテスト関数は、準備をしてからテストしたいコードを実行し、そしてその結果が期待したものであるか確認します。

大抵の場合ユニットテストは`#[cfg(test)]`アトリビュートを付けた`tests`モジュールに配置されます。テスト関数には`#[test]`アトリビュートを付与します。

テスト関数内部でパニックするとテストは失敗となります。次のようなマクロが用意されています。

- `assert!(expression)` - 式を評価した結果が`false`であればパニックします。
- `assert_eq!(left, right)`と`assert_ne!(left, right)` - 左右の式を評価した結果が、それぞれ等しくなること、ならないことをテストします。

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

    // 誤った加算をする関数がテストに通らないことを示します。
    #[allow(dead_code)]
    fn bad_add(a: i32, b: i32) -> i32 {
        a - b
    }

    #[cfg(test)]
    mod tests {
        // 外部のスコープから（mod testsに）名前をインポートする便利なイディオム。
        use super::*;

        #[test]
        fn test_add() {
            assert_eq!(add(1, 2), 3);
        }

        #[test]
        fn test_bad_add() {
            // このアサーションはパニックして、テストは失敗します。
            // プライベートな関数もテストすることができます。
            assert_eq!(bad_add(1, 2), 3);
        }
    }

`cargo test`でテストを実行できます。

    $ cargo test

    running 2 tests
    test tests::test_bad_add ... FAILED
    test tests::test_add ... ok

    failures:

    ---- tests::test_bad_add stdout ----
            thread 'tests::test_bad_add' panicked at 'assertion failed: `(left == right)`
      left: `-1`,
     right: `3`', src/lib.rs:21:8
    note: Run with `RUST_BACKTRACE=1` for a backtrace.

    failures:
        tests::test_bad_add

    test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out

## テストと`?`

ここまでに例示したユニットテストは返り値の型を持っていませんでしたが、Rust 2018ではユニットテストが`Result<()>`を返し、内部で`?`を使えるようになりました！これにより、ユニットテストをさらに簡潔に記述できます。

    fn sqrt(number: f64) -> Result<f64, String> {
        if number >= 0.0 {
            Ok(number.powf(0.5))
        } else {
            Err("negative floats don't have square roots".to_owned())
        }
    }

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

        #[test]
        fn test_sqrt() -> Result<(), String> {
            let x = 4.0;
            assert_eq!(sqrt(x)?.powf(2.0), x);
            Ok(())
        }
    }

詳細はエディションガイドを参照してください。

## パニックをテストする

ある条件下でパニックすべき関数をテストするには、`#[should_panic]`アトリビュートを使います。このアトリビュートはパニックメッセージをオプションの引数`expected =`で受け取れます。パニックの原因が複数あるときに、想定した原因でパニックが発生したことを確認できます。

Note: Rust also allows a shorthand form `#[should_panic = "message"]`, which works exactly like `#[should_panic(expected = "message")]`. Both are valid; the latter is more commonly used and is considered more explicit.

    pub fn divide_non_zero_result(a: u32, b: u32) -> u32 {
        if b == 0 {
            panic!("Divide-by-zero error");
        } else if a < b {
            panic!("Divide result is zero");
        }
        a / b
    }

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

        #[test]
        fn test_divide() {
            assert_eq!(divide_non_zero_result(10, 2), 5);
        }

        #[test]
        #[should_panic]
        fn test_any_panic() {
            divide_non_zero_result(1, 0);
        }

        #[test]
        #[should_panic(expected = "Divide result is zero")]
        fn test_specific_panic() {
            divide_non_zero_result(1, 10);
        }

        #[test]
        #[should_panic = "Divide result is zero"] // This also works
        fn test_specific_panic_shorthand() {
            divide_non_zero_result(1, 10);
        }
    }

テストを実行すると、次の結果を得られます。

    $ cargo test

    running 4 tests
    test tests::test_any_panic ... ok
    test tests::test_divide ... ok
    test tests::test_specific_panic ... ok
    test tests::test_specific_panic_shorthand ... ok

    test result: ok. 4 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

       Doc-tests tmp-test-should-panic

    running 0 tests

    test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

## 実行するテストを指定する

`cargo test`にテストの名前を与えると、そのテストだけが実行されます。

    $ cargo test test_any_panic
    running 1 test
    test tests::test_any_panic ... ok

    test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 3 filtered out

       Doc-tests tmp-test-should-panic

    running 0 tests

    test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

テスト名の一部を指定すると、それにマッチするすべてのテストが実行されます。

    $ cargo test panic
    running 3 tests
    test tests::test_any_panic ... ok
    test tests::test_specific_panic ... ok
    test tests::test_specific_panic_shorthand ... ok

    test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out

       Doc-tests tmp-test-should-panic

    running 0 tests

    test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

## テストを除外する

テストを実行から除外するには、`#[ignore]`アトリビュートを使います。また、`cargo test -- --ignored`で、除外したテストのみを実行できます。

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

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

        #[test]
        fn test_add() {
            assert_eq!(add(2, 2), 4);
        }

        #[test]
        fn test_add_hundred() {
            assert_eq!(add(100, 2), 102);
            assert_eq!(add(2, 100), 102);
        }

        #[test]
        #[ignore]
        fn ignored_test() {
            assert_eq!(add(0, 0), 0);
        }
    }

    $ cargo test
    running 3 tests
    test tests::ignored_test ... ignored
    test tests::test_add ... ok
    test tests::test_add_hundred ... ok

    test result: ok. 2 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out

       Doc-tests tmp-ignore

    running 0 tests

    test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

    $ cargo test -- --ignored
    running 1 test
    test tests::ignored_test ... ok

    test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

       Doc-tests tmp-ignore

    running 0 tests

    test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out