単体テスト

テストは、テスト対象ではないコードが期待どおりに機能していることを検証する Rust 関数です。テスト関数の本体は通常、何らかのセットアップを行い、 テストしたいコードを実行し、その結果が期待どおりであるかをアサートします。

ほとんどの単体テストは、#[cfg(test)] attribute を付けた tests mod に配置します。 テスト関数には #[test] 属性を付けます。

テスト関数内の何かが panics すると、テストは失敗します。いくつかの 補助 macros があります。

• assert!(expression) - expression が false に評価されるとパニックします。
• assert_eq!(left, right) と assert_ne!(left, right) - 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() {
        // このアサートは発火し、テストは失敗します。
        // private 関数もテストできることに注意してください！
        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(())
    }
}

詳細については、"The Edition Guide" を参照してください。

パニックのテスト

特定の状況下でパニックすべき関数を確認するには、属性 #[should_panic] を使用します。この属性は、パニックメッセージのテキストを指定する 任意のパラメーター expected = を受け取ります。関数が複数の方法でパニックする可能性がある場合、 テストが正しいパニックをテストしていることを確認するのに役立ちます。

注: Rust では省略形 #[should_panic = "message"] も使用できます。これは #[should_panic(expected = "message")] とまったく同じように動作します。どちらも有効ですが、後者の方がより一般的に 使用され、より明示的だと考えられています。

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"] // これも動作します
    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