RustでUnit Testを書く方法

# はじめに
rustでユニットテストを書く方法について、初めてrustでユニットテストを書く方向けにまとめました。
ある程度、他の言語でユニットテストを書いたことがある前提で書いています。
今回のコードは、[Khigashiguchi/rust_books_unittest](https://github.com/Khigashiguchi/rust_books_unittest)に残しています。

# 動作環境
- macOS High Sierra version 10.13.1
- rustc 1.21.0 (3b72af97e 2017-10-09)
- cargo 0.22.0 (3423351a5 2017-10-06)

# テストを実行してみる。
rustでは、cargoコマンドにてテストを実行することができます。まずは、```cargo new project_name```で作ったプロジェクトで実行してみましょう。

```bash
$ cargo new adder
$ cd adder
$ cargo test

Compiling adder v0.1.0 (file:///Users/user/src/hobby/rust/adder)
    Finished dev [unoptimized + debuginfo] target(s) in 0.41 secs
     Running target/debug/deps/adder-2ebe68c5b435e203

running 1 test
test tests::it_works ... ok

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

   Doc-tests adder

running 0 tests

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

```cargo new``` をした際に、src/lib.rsにテストコードが自動生成されているため、上記のようなテスト結果が表示されます。
デフォルトでは、src/lib.rsに以下のコードが書かれています。

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

```#[test]``` という記述で、cargoはテストメソッドだと認識します。

## 失敗するテストが含まれている場合

例えば、src/lib.rsに以下のコードを追記します。以下のコードでは、テストメソッド内でpanicを返すためにテスト結果はfailedになるはずです。

```rust
    #[test]
    fn another() {
        panic!("Make this test faild")
    }
```

テストを実行します。

```bash
$ cargo test

running 2 tests
test tests::exploration ... ok
test tests::another ... FAILED

failures:

---- tests::another stdout ----
	thread 'tests::another' panicked at 'Make this test faild', src/lib.rs:9:8
note: Run with `RUST_BACKTRACE=1` for a backtrace.


failures:
    tests::another

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

error: test failed, to rerun pass '--lib'
```
テストの失敗と該当箇所が出力されています。

# 実際にテストコードを書いてみる
## boolチェック

```assert!``` を使うことで、結果のassertをすることができます。

src/lib.rsを下記のように書き換えてみます。

```rust
#[derive(Debug)]
pub struct Rectangle {
    length: u32,
    width: u32,
}

impl Rectangle {
    pub fn can_hold(&self, other: &Rectangle) -> bool {
        self.length > other.length && self.width > other.width
    }
}

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

    #[test]
    fn larger_can_hold_smaller() {
        let larger = Rectangle { length: 8, width: 7 };
        let smaller = Rectangle { length : 5, width: 1 };

        assert!(larger.can_hold(&smaller));
    }
```

実行してみましょう。

```bash
$ cargo test

running 1 tests
test tests::larger_can_hold_smaller ... ok
```

```assert!``` を利用した場合、trueの場合は成功、falseの場合は失敗と判定することができます。

複数のテストケースを実行することも可能です。

先ほどのsrc/lib.rsに以下のコードを追記してみます。

```rust
    #[test]
    fn smaller_cannnot_hold_larger() {
        let larger = Rectangle { length: 8, width: 7 };
        let smaller = Rectangle { length: 5, width: 1 };

        assert!(!smaller.can_hold(&larger));
    }
```

再度実行します。

```bash
$ cargo test

running 2 tests
test tests::larger_can_hold_smaller ... ok
test tests::smaller_cannnot_hold_larger ... ok
```
テスト結果の行が２行になっていることが確認できます。

## 値の比較
assert_eq!にて値の等価性チェックが可能です。以下のコードをsrc/lib.rsに追記いたします。

```#[derive(Debug)]``` 以下に下記コードを追加

```rust
pub fn add_two(a: i32) -> i32 {
    a + 2
}
```

```#[cfg(test)]``` 以下に下記コードを追加

```rust
    #[test]
    fn it_adds_two() {
        assert_eq!(4, add_two(2));
    }
```
テストを再実行いたします。

```
$ cargo test

running 2 tests
test tests::larger_can_hold_smaller ... ok
test tests::smaller_cannnot_hold_larger ... ok
test tests::it_adds_two ... ok
```

```assert_eq!``` を利用した場合、値が等しいかどうかを判定することできます。上記の例では成功していますが、失敗した場合の結果を見てみます。先ほど追記したコードにバグを仕込んで確認してみます。

```rust
pub fn add_two(a: i32) -> i32 {
    a + 3
}
```

テストを再実行します。

```bash
$ cargo test

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

left・rightにて値が異なるためというテスト結果が出力されました。次に備えて、仕込んだバグは戻しておきましょう。

## custom message
テスト結果で出力されるメッセージをassertごとに設定することができます。

以下のコードをsrc/lib.rsに追加します。

```#[derive(Debug)]``` 以下に下記コードを追加

```rust
pub fn greeting(name: &str) -> String {
    format!("Hello!")
}
```

```#[cfg(test)]``` 以下に下記コードを追加

```rust
    #[test]
    fn greeting_contains_name() {
        let result = greeting("Carol");
        assert!(result.contains("Carol"), "Greeting did not contain name, value was `{}`", result);
    }
```

再度、テストを実行します。

```bash
$ cargo test

---- tests::greeting_contains_name stdout ----
	thread 'tests::greeting_contains_name' panicked at 'Greeting did not contain name, value was `Hello`', src/lib.rs:53:8
note: Run with `RUST_BACKTRACE=1` for a backtrace.
```
テスト失敗の結果レポートに```Greeting did not contain name, value was Hello``` というメッセージが表示されました。
assert_eq!の第二引数に文字列を設定することで、カスタムメッセージを設定することができます。
次に進むためにちゃんとテストが通るコードに戻しておきます。

```rust
pub fn greeting(name: &str) -> String {
    format!("Hello!, {}", name)
}
```

## panicチェック
panicが帰ってきているかどうかもユニットテストで確認したい点です。こちらも、```should_panic``` で確認することができます。
src/lib.rsにコードを追記しましょう。

```#[derive(Debug)]``` 以下に下記コードを追加

```rust
pub struct Guess {
    value: u32,
}

impl Guess {
    pub fn new(value: u32) -> Guess {
        if value < 1 || value > 100 {
            panic!("Guess value must be between 1 and 100, got {}.", value);
        }

        Guess {
            value
        }
    }
}
```

```#[cfg(test)]``` 以下に下記コードを追加

```rust
    #[test]
    #[should_panic]
    fn greater_than_100() {
        Guess::new(200);
    }
```

再度、テストを実行します。テストがちゃんと通っていることが確認できます。```#[should_panic]``` をテストメソッドの前に書くことで実現できます。

ただし、同一メソッド内で複数panicを返す場合には、このテストでは不十分です。そのために、どのようなメッセージが返ってきているかどうかもテスト対象に含めましょう。テストコードを以下のように修正します。

```rust
    #[test]
    #[should_panic(expected = "Guess value must be less than or equal to 100")]
    fn greater_than_100() {
        Guess::new(200);
```

```expected = "Guess value must be less than or equal to 100")``` という記述によりメッセージの確認をすることができます。

## 一部のテストのみ実行したい場合

```cargo test fn名``` というコマンドで一部のテストのみ実行することができます。

例えば、以下のようになります。

```bash
$ cargo test greater_than_100

running 1 test
test tests::greater_than_100 ... ok
```

また、メソッド名の部分一致で複数のメソッドを同時にテストすることも可能です。

## private methodのテスト
rustでは、private methodもテスト可能になっています。今まで書いたテスト対象メソッドの修飾詞```pub``` を外して実行して結果を確認してみてください。

# 最後に
本記事は、[The Rust Programming Language](https://doc.rust-lang.org/book/)のSecond editionの内容をもとに書いています。rustを勉強するには、こちらの公式ドキュメントで勉強するのがおすすめです。

# 参考
- [Khigashiguchi/rust_books_unittest](https://github.com/Khigashiguchi/rust_books_unittest)
- [Rust-book second edition: How to Write Tests](https://doc.rust-lang.org/book/second-edition/ch11-01-writing-tests.html)