シミュレートされたユーザー入力を使用したJUnitテスト

ユーザー入力を必要とするメソッドのJUnitテストをいくつか作成しようとしています。テスト対象のメソッドは、次のメソッドのようになります。

public static int testUserInput() {
    Scanner keyboard = new Scanner(System.in);
    System.out.println("Give a number between 1 and 10");
    int input = keyboard.nextInt();

    while (input < 1 || input > 10) {
        System.out.println("Wrong number, try again.");
        input = keyboard.nextInt();
    }

    return input;
}

JUnitテストメソッドで私や他の誰かが手動でこれを行う代わりに、プログラムを自動的にintに渡す方法はありますか？ユーザー入力をシミュレートするのが好きですか？

前もって感謝します。

System.setIn（InputStream in）を呼び出すことにより、System.inを独自のストリームに置き換えることができます。InputStreamはバイト配列にすることができます：

InputStream sysInBackup = System.in; // backup System.in to restore it later
ByteArrayInputStream in = new ByteArrayInputStream("My string".getBytes());
System.setIn(in);

// do your thing

// optionally, reset System.in to its original
System.setIn(sysInBackup);

INとOUTをパラメーターとして渡すことにより、さまざまなアプローチでこのメソッドをよりテストしやすくすることができます。

public static int testUserInput(InputStream in,PrintStream out) {
    Scanner keyboard = new Scanner(in);
    out.println("Give a number between 1 and 10");
    int input = keyboard.nextInt();

    while (input < 1 || input > 10) {
        out.println("Wrong number, try again.");
        input = keyboard.nextInt();
    }

    return input;
}

コードをテストドライブするには、システムの入出力関数のラッパーを作成する必要があります。これは、依存性注入を使用して行うことができ、新しい整数を要求できるクラスを提供します。

public static class IntegerAsker {
    private final Scanner scanner;
    private final PrintStream out;

    public IntegerAsker(InputStream in, PrintStream out) {
        scanner = new Scanner(in);
        this.out = out;
    }

    public int ask(String message) {
        out.println(message);
        return scanner.nextInt();
    }
}

次に、モックフレームワーク（私はMockitoを使用）を使用して、関数のテストを作成できます。

@Test
public void getsIntegerWhenWithinBoundsOfOneToTen() throws Exception {
    IntegerAsker asker = mock(IntegerAsker.class);
    when(asker.ask(anyString())).thenReturn(3);

    assertEquals(getBoundIntegerFromUser(asker), 3);
}

@Test
public void asksForNewIntegerWhenOutsideBoundsOfOneToTen() throws Exception {
    IntegerAsker asker = mock(IntegerAsker.class);
    when(asker.ask("Give a number between 1 and 10")).thenReturn(99);
    when(asker.ask("Wrong number, try again.")).thenReturn(3);

    getBoundIntegerFromUser(asker);

    verify(asker).ask("Wrong number, try again.");
}

次に、テストに合格する関数を記述します。整数の要求/取得の重複を削除でき、実際のシステムコールがカプセル化されるため、関数ははるかにクリーンになります。

public static void main(String[] args) {
    getBoundIntegerFromUser(new IntegerAsker(System.in, System.out));
}

public static int getBoundIntegerFromUser(IntegerAsker asker) {
    int input = asker.ask("Give a number between 1 and 10");
    while (input < 1 || input > 10)
        input = asker.ask("Wrong number, try again.");
    return input;
}

これはあなたの小さな例にとってはやり過ぎのように思えるかもしれませんが、このように開発しているより大きなアプリケーションを構築している場合は、かなり早く成果を上げることができます。

同様のコードをテストする一般的な方法の1つは、このStackOverflowの回答と同様に、スキャナーとPrintWriterを取り込むメソッドを抽出し、次のことをテストすることです。

public void processUserInput() {
  processUserInput(new Scanner(System.in), System.out);
}

/** For testing. Package-private if possible. */
public void processUserInput(Scanner scanner, PrintWriter output) {
  output.println("Give a number between 1 and 10");
  int input = scanner.nextInt();

  while (input < 1 || input > 10) {
    output.println("Wrong number, try again.");
    input = scanner.nextInt();
  }

  return input;
}

最後まで出力を読み取ることができず、すべての入力を事前に指定する必要があることに注意してください。

@Test
public void shouldProcessUserInput() {
  StringWriter output = new StringWriter();
  String input = "11\n"       // "Wrong number, try again."
               + "10\n";

  assertEquals(10, systemUnderTest.processUserInput(
      new Scanner(input), new PrintWriter(output)));

  assertThat(output.toString(), contains("Wrong number, try again.")););
}

もちろん、オーバーロードメソッドを作成するのではなく、「スキャナー」と「出力」をテスト対象のシステムの可変フィールドとして保持することもできます。私はクラスをできるだけステートレスに保つのが好きですが、それがあなたやあなたの同僚/インストラクターにとって重要であるならば、それはそれほど大きな譲歩ではありません。

また、テストコードをテスト対象のコードと同じJavaパッケージに配置することもできます（別のソースフォルダーにある場合でも）。これにより、2つのパラメーターのオーバーロードの可視性を緩和してパッケージプライベートにすることができます。

私はなんとかもっと簡単な方法を見つけることができました。ただし、@ StefanBirknerによる外部ライブラリSystem.rulesを使用する必要があります

そこに提供されている例を取り上げただけですが、これ以上簡単にすることはできなかったと思います。

import java.util.Scanner;

public class Summarize {
  public static int sumOfNumbersFromSystemIn() {
    Scanner scanner = new Scanner(System.in);
    int firstSummand = scanner.nextInt();
    int secondSummand = scanner.nextInt();
    return firstSummand + secondSummand;
  }
}

テスト

import static org.junit.Assert.*;
import static org.junit.contrib.java.lang.system.TextFromStandardInputStream.*;

import org.junit.Rule;
import org.junit.Test;
import org.junit.contrib.java.lang.system.TextFromStandardInputStream;

public class SummarizeTest {
  @Rule
  public final TextFromStandardInputStream systemInMock
    = emptyStandardInputStream();

  @Test
  public void summarizesTwoNumbers() {
    systemInMock.provideLines("1", "2");
    assertEquals(3, Summarize.sumOfNumbersFromSystemIn());
  }
}

ただし、私の場合、2番目の入力にスペースがあり、これにより入力ストリーム全体がnullになります。

キーボードから数値を取得するロジックを独自のメソッドに抽出することから始めることができます。次に、キーボードを気にせずに検証ロジックをテストできます。Keyboard.nextInt（）呼び出しをテストするために、モックオブジェクトの使用を検討することをお勧めします。

コンソールをシミュレートするためのstdinからの読み取りに関する問題を修正しました...

私の問題は、特定のオブジェクトを作成するためにコンソールをテストするJUnitで書いてみたいということでした...

問題はあなたが言うすべてのようです：どうすればJUnitテストからStdinに書き込むことができますか？

それから大学で、System.setIn（InputStream）がstdinファイル記述子を変更すると言うようなリダイレクトについて学び、それから書き込むことができます...

しかし、修正する問題がもう1つあります...新しいInputStreamからの読み取りを待機しているJUnitテストブロックなので、InputStreamからの読み取りとJUnitテストからの読み取り用のスレッドを作成する必要があります新しいStdinでのスレッド書き込み...最初に後でstdinから読み取るスレッドを作成して書き込むと、競合条件が発生する可能性があるため、Stdinに書き込みます...読み取る前にInputStreamに書き込むか、書き込む前にInputStreamから読み取ることができます...

これは私のコードです。私の英語のスキルは悪いです。JUnitテストからstdinでの書き込みをシミュレートするための問題と解決策を理解していただければ幸いです。

private void readFromConsole(String data) throws InterruptedException {
    System.setIn(new ByteArrayInputStream(data.getBytes()));

    Thread rC = new Thread() {
        @Override
        public void run() {
            study = new Study();
            study.read(System.in);
        }
    };
    rC.start();
    rC.join();      
}

java.io.Consoleに似たメソッドを定義するインターフェースを作成し、それを使用してSystem.outの読み取りまたは書き込みを行うと便利であることがわかりました。実際の実装はSystem.console（）に委任されますが、JUnitバージョンは、定型入力と期待される応答を備えたモックオブジェクトにすることができます。

たとえば、ユーザーからの定型入力を含むMockConsoleを作成します。モック実装は、readLineが呼び出されるたびに、入力文字列をリストからポップします。また、応答のリストに書き込まれたすべての出力を収集します。テストの最後に、すべてがうまくいけば、すべての入力が読み取られ、出力でアサートできます。