JMockitの期待へのガイド

1. イントロ

この記事は、JMockitシリーズの2回目の記事です。 JMockitの基本に既に精通していることを前提としているため、first articleを読むことをお勧めします。

今日は、さらに深く掘り下げて、期待に焦点を合わせます。より具体的または一般的な引数の一致を定義する方法と、値を定義するより高度な方法を示します。

2. 一致する引数値

次のアプローチは、ExpectationsとVerificationsの両方に適用されます。

2.1. 「任意の」フィールド

JMockitは、引数のマッチングをより一般的にするためのユーティリティフィールドのセットを提供します。これらのユーティリティの1つは、anyXフィールドです。

これらは、任意の値が渡されたことを確認し、プリミティブ型（および対応するラッパークラス）ごとに1つ、文字列用に1つ、およびタイプObjectの「ユニバーサル」な値があります。

例を見てみましょう：

public interface ExpectationsCollaborator {
    String methodForAny1(String s, int i, Boolean b);
    void methodForAny2(Long l, List lst);
}

@Test
public void test(@Mocked ExpectationsCollaborator mock) throws Exception {
    new Expectations() {{
        mock.methodForAny1(anyString, anyInt, anyBoolean);
        result = "any";
    }};

    Assert.assertEquals("any", mock.methodForAny1("barfooxyz", 0, Boolean.FALSE));
    mock.methodForAny2(2L, new ArrayList<>());

    new FullVerifications() {{
        mock.methodForAny2(anyLong, (List) any);
    }};
}

anyフィールドを使用するときは、期待されるタイプにキャストする必要があることを考慮に入れる必要があります。フィールドの完全なリストはdocumentationにあります。

2.2. 「with」メソッド

JMockitは、一般的な引数のマッチングを支援するいくつかのメソッドも提供します。これらはwithXメソッドです。

これらにより、anyXフィールドよりも少し高度なマッチングが可能になります。ここで、foo、1に等しくない整数、null以外のBoolean、および任意のインスタンスを含む文字列でトリガーされるメソッドの期待値を定義する例を見ることができます。 Listクラスの：

public interface ExpectationsCollaborator {
    String methodForWith1(String s, int i);
    void methodForWith2(Boolean b, List l);
}

@Test
public void testForWith(@Mocked ExpectationsCollaborator mock) throws Exception {
    new Expectations() {{
        mock.methodForWith1(withSubstring("foo"), withNotEqual(1));
        result = "with";
    }};

    assertEquals("with", mock.methodForWith1("barfooxyz", 2));
    mock.methodForWith2(Boolean.TRUE, new ArrayList<>());

    new Verifications() {{
        mock.methodForWith2(withNotNull(), withInstanceOf(List.class));
    }};
}

JMockitのdocumentationでwithXメソッドの完全なリストを確認できます。

特別なwith(Delegate)とwithArgThat(Matcher)は、それぞれのサブセクションで説明されることを考慮に入れてください。

2.3. ヌルはヌルではありません

遅かれ早かれ理解するのに良いことは、nullがモックに渡された引数を定義するためにnullが使用されていないということです。

実際には、nullはsyntactic sugarとして使用され、オブジェクトが渡されることを定義します（したがって、参照型のパラメーターにのみ使用できます）。特定のパラメーターがnull参照を受け取ることを具体的に確認するために、withNull()マッチャーを使用できます。

次の例では、渡された引数が次の場合にトリガーされるモックの動作を定義します：任意の文字列、任意のリスト、およびnull参照：

public interface ExpectationsCollaborator {
    String methodForNulls1(String s, List l);
    void methodForNulls2(String s, List l);
}

@Test
public void testWithNulls(@Mocked ExpectationsCollaborator mock){
    new Expectations() {{
        mock.methodForNulls1(anyString, null);
        result = "null";
    }};

    assertEquals("null", mock.methodForNulls1("blablabla", new ArrayList()));
    mock.methodForNulls2("blablabla", null);

    new Verifications() {{
        mock.methodForNulls2(anyString, (List) withNull());
    }};
}

違いに注意してください。nullは任意のリストを意味し、withNull()はリストへのnull参照を意味します。特に、これにより、宣言されたパラメーター型に値をキャストする必要がなくなります（3番目の引数はキャストする必要がありますが、2番目の引数はキャストしない必要があることを参照）。

これを使用できる唯一の条件は、少なくとも1つの明示的な引数マッチャーが期待値に使用されていることです（withメソッドまたはanyフィールドのいずれか）。

2.4. 「タイムズ」フィールド

場合によっては、モックされたメソッドに期待されるconstrainthe number of invocationsが必要になります。このため、JMockitには予約語times、minTimes、およびmaxTimesがあります（3つすべてで非負の整数のみが許可されます）。

public interface ExpectationsCollaborator {
    void methodForTimes1();
    void methodForTimes2();
    void methodForTimes3();
}

@Test
public void testWithTimes(@Mocked ExpectationsCollaborator mock) {
    new Expectations() {{
        mock.methodForTimes1(); times = 2;
        mock.methodForTimes2();
    }};

    mock.methodForTimes1();
    mock.methodForTimes1();
    mock.methodForTimes2();
    mock.methodForTimes3();
    mock.methodForTimes3();
    mock.methodForTimes3();

    new Verifications() {{
        mock.methodForTimes3(); minTimes = 1; maxTimes = 3;
    }};
}

この例では、times = 2;行を使用してmethodForTimes1()の正確に2回の呼び出し（1回ではなく、3回ではなく、正確に2回）を実行する必要があると定義しました。

次に、デフォルトの動作（繰り返し制約が指定されていない場合はminTimes = 1;が使用されます）を使用して、methodForTimes2().に対して少なくとも1回の呼び出しが行われるように定義しました。

最後に、minTimes = 1;の後にmaxTimes = 3;を使用して、methodForTimes3()に対して1〜3回の呼び出しが発生することを定義しました。

minTimesが最初に割り当てられている限り、minTimesとmaxTimesの両方を同じ期待値に指定できることを考慮してください。一方、timesは単独でのみ使用できます。

2.5. カスタム引数マッチング

引数の照合は、単に値を指定したり、事前定義されたユーティリティ（anyXまたはwithX）を使用したりするほど直接的ではない場合があります。

その場合、JMockitはHamcrestのMatcherインターフェースに依存します。特定のテストシナリオのマッチャーを定義し、そのマッチャーをwithArgThat()呼び出しで使用する必要があります。

特定のクラスを渡されたオブジェクトに一致させる例を見てみましょう。

public interface ExpectationsCollaborator {
    void methodForArgThat(Object o);
}

public class Model {
    public String getInfo(){
        return "info";
    }
}

@Test
public void testCustomArgumentMatching(@Mocked ExpectationsCollaborator mock) {
    new Expectations() {{
        mock.methodForArgThat(withArgThat(new BaseMatcher

TOC

JMockitの期待へのガイド