kdnakt blog

hello there.

Rust dojo第76回を開催した

第76回です。前回はこちら。

kdnakt.hatenablog.com

[第76回の様子]

2023/04/26に第76回を開催した。

内容としてはRust By Example 日本語版21. テストの「21.1. ユニットテスト」に取り組んだ。
参加者は自分を入れて5人。久しぶりにドライバをやって手を動かした〜。

[学んだこと]

  • 21.1. ユニットテスト
  • ユニットテストの基本
  • 他の言語と同様、rustのテストも関数である
  • 大抵の場合、#[cfg(test)]アトリビュートを付けたtestsモジュールに#[test]アトリビュートを付けた関数を書く
  • テストを失敗させるにはパニックさせればよい
  • 式を引数にとるassert!()マクロと、2つの引数をとって評価するassert_eq!()、assert_ne!()マクロが用意されている
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
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(())
    }
}
  • ここで?演算子がErrを返すと次のようになる
    • 実行結果がエラーになったことはわかるが、panicの場合と違って何行目で問題が起きたのかパッと分からないので、個人的にはpanicの方が良さそうな気もした
#[test]
fn test_sqrt() -> Result<(), String> {
    // 4.0が正しいがあえて-4.0に変えてみる
    let x = -4.0;
    assert_eq!(sqrt(x)?.powf(2.0), x);
    Ok(())
}

//実行結果
running 1 test
test tests::test_sqrt ... FAILED

failures:

---- tests::test_sqrt stdout ----
Error: "negative floats don't have square roots"

failures:
    tests::test_sqrt

test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
  • ▼パニックをテストする
  • ある関数がパニックすることをテストするには#[should_panic]アトリビュートを使う
  • パニックメッセージを検証する場合にはオプションのexpected引数で指定できる
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);
    }
}
  • ▼実行するテストを指定する
  • cargo testコマンドにテスト名やその一部を指定するとマッチするテストが実行される
  • 先のdivide_non_zero_result()の例でいうと、$ cargo test test_any_panicでtest_any_panic()のみをテストできる
  • また、$ cargo test panicで名前にpanicが含まれる2つのテストを実行できる
  • ▼テストを除外する
  • #[ignore]アトリビュートを使うとテストが実行されなくなる
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で実行されるのは2つだけ
$ 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; finished in 0.00s
  • cargo test -- --ignoredコマンドで、除外されたテストのみを実行できる(サイトの説明では除外されたテストを含めて、と書かれていたが実際の動きと違ったので、プルリクエストを送っておいた
$ cargo test -- --ignored
running 1 test
test tests::ignored_test ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s

[まとめ]

モブプログラミングスタイルでRust dojoを開催した。
やはりテストが書けると安心できる。

今週のプルリクエストはこちら。

github.com