Rustでparameterized testを書く

rstestを使ってparameterized test/パラメータテストを書く方法を整理します。

はじめに
Rustでparameterized testを書く
- 選択肢
- rstestでparameterized test
おわりに
参考

はじめに

Rustでは、parameterized testを実装する機能はデフォルトでは提供されていません。

Pythonのpytestに慣れた身としては、Rustでもparameterized testを書きたい気持ちがあります。

今回はそのやり方をまとめます。

選択肢

Rustでparameterized testを書くやり方には、ざっと調べただけでもいくつか選択肢があります。

macroで書く
test-caseを利用して書く
rstestを利用して書く

まず、外部crateに頼らないのであればmacroで書くやり方があります。外部crateを利用する場合は、test-caseやrstestが人気そうです。

test-caseはparameterized testを実装するためのテストツールです。 rstestはpytestに似たfixtureベースのテストフレームワークで、parameterized testもサポートされています。

今回は、より用途も広く使えそうなrstestを使ってみます。

GitHub starの推移を見てもrstestの方がより安定して人気がありそうです：

rstestでparameterized test

まずはrstestをdev-dependenciesに追加します。

cargo add --dev rstest

実際のテストコードを書くには、下記のようにします。

pub fn add(left: usize, right: usize) -> usize {
    left + right
}

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

    #[rstest]
    #[case(0, 0, 0)]
    #[case(1, 1, 2)]
    #[case(2, 1, 3)]
    #[case(3, 2, 5)]
    #[case(4, 3, 7)]
    fn parametrized_works(#[case] left: usize, #[case] right: usize, #[case] expected: usize) {
        let result = add(left, right);
        assert_eq!(result, expected);
    }
}

#[case(0, 0, 0)]のようにして入力パラメータを用意し、テスト関数の引数に#[case]注釈を付けて渡します。

cargo test結果も、それぞれのパラメータ分がちゃんと表示されます。

$ cargo test

# 中略

test tests::parametrized_works::case_1 ... ok
test tests::parametrized_works::case_2 ... ok
test tests::parametrized_works::case_3 ... ok
test tests::parametrized_works::case_4 ... ok
test tests::parametrized_works::case_5 ... ok

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