標準入出力のテスト方法

Question

Rustで標準入出力のテストをしたいのですが、書き方がわかりません。
どのように書けばいいのでしょうか。

Answer 1

こんにちは。恐らく以下のようにprintln!などを用いて標準出力をしているのだと思います。

// 関数側
fn output_name(name: &str) {
    println!("name: {}", name)
}

// 呼び出し側
fn call_output_name() {
    output_name("bob");
}

これはどこかに出力するという意味では Writeトレイトで抽象化できるので以下のように書き換えられます。

use std::io::{self, Write};

// 関数側: 引数の `w` が増える代わりに出力先を外部から指定できるようになった
fn output_name<W: Write>(w: &mut W, name: &str) -> io::Result<()> {
    writeln!(w, "name: {}", name)
}

// 呼び出し側: 標準出力を獲得して渡してあげる。Rustはマルチスレッド前提なので標準出力にもロックが必要
fn call_output_name() {
    let stdout = io::stdout();
    let mut stdout = stdout.lock();
    output_name(&mut stdout, "bob").expect("outputting name")
}

さて、これをテストするには Vec<u8>にもWriteが実装されていることを利用して以下のようにメモリに書き出させるとテストできるかと思います

#[test]
fn test_output_name() {
    let mut buf = Vec::<u8>::new();
    let result = output_name(&mut buf, "bob");
    assert!(result.is_ok());
    assert_eq!(buf, b"name: bob\n");
}

以上が一般的な方法かと思います。

もし、Writeを使わずに実際に標準出力に書き出された文字列を観測したいのであればforkやpipeなどのシステムコールを駆使して出来ないこともないです。しかしながらナイーブなところもあるので両者の挙動を理解していない限りおすすめしません。