Mockitoを使用してクラスのメンバー変数をモックする

私は特に開発とユニットテストの初心者です。私の要件はかなり単純だと思いますが、私はこれについて他の考えを知りたいと思っています。

私のように2つのクラスがあるとしましょう-

public class First {

    Second second ;

    public First(){
        second = new Second();
    }

    public String doSecond(){
        return second.doSecond();
    }
}

class Second {

    public String doSecond(){
        return "Do Something";
    }
}

First.doSecond()メソッドをテストするための単体テストを書いているとしましょう。しかし、私はSecond.doSecond()そのようにクラスをモックしたいとします。私はこれを行うためにMockitoを使用しています。

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

モックが有効にならず、アサーションが失敗することを確認しています。テストしたいクラスのメンバー変数をモックする方法はありません。？

モックを渡すことができるように、メンバー変数にアクセスする方法を提供する必要があります（最も一般的な方法は、パラメーターを受け取るセッターメソッドまたはコンストラクターです）。

コードがこれを行う方法を提供していない場合、TDD（テスト駆動開発）に対して誤って因数分解されます。

コードを変更できない場合、これは不可能です。しかし、依存関係注入が好きで、Mockitoはそれをサポートしています。

public class First {    
    @Resource
    Second second;

    public First() {
        second = new Second();
    }

    public String doSecond() {
        return second.doSecond();
    }
}

あなたのテスト：

@RunWith(MockitoJUnitRunner.class)
public class YourTest {
   @Mock
   Second second;

   @InjectMocks
   First first = new First();

   public void testFirst(){
      when(second.doSecond()).thenReturn("Stubbed Second");
      assertEquals("Stubbed Second", first.doSecond());
   }
}

これはとても簡単です。

コードをよく見るとsecond、テストのプロパティがSecondモックではなくのインスタンスであることがわかりfirstます（コードでモックを渡さない）。

最も簡単な方法はsecond、Firstクラスののセッターを作成し、モックを明示的に渡すことです。

このような：

public class First {

Second second ;

public First(){
    second = new Second();
}

public String doSecond(){
    return second.doSecond();
}

    public void setSecond(Second second) {
    this.second = second;
    }


}

class Second {

public String doSecond(){
    return "Do Something";
}
}

....

public void testFirst(){
Second sec = mock(Second.class);
when(sec.doSecond()).thenReturn("Stubbed Second");


First first = new First();
first.setSecond(sec)
assertEquals("Stubbed Second", first.doSecond());
}

もう1つは、SecondインスタンスをFirstのコンストラクタパラメータとして渡すことです。

コードを変更できない場合、リフレクションを使用するのが唯一のオプションだと思います。

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");


    First first = new First();
    Field privateField = PrivateObject.class.
        getDeclaredField("second");

    privateField.setAccessible(true);

    privateField.set(first, sec);

    assertEquals("Stubbed Second", first.doSecond());
}

ただし、制御できないコードでテストを実行することはまれであるため、おそらく可能です（外部ライブラリをテストする必要があるシナリオで、作成者がテストを実行しなかったことが想像できますが、:)）

メンバー変数を変更できない場合、これを回避する別の方法は、powerMockitを使用して呼び出すことです

Second second = mock(Second.class)
when(second.doSecond()).thenReturn("Stubbed Second");
whenNew(Second.class).withAnyArguments.thenReturn(second);

ここで問題は、新しいSecondへのすべての呼び出しが同じモックインスタンスを返すことです。しかし、あなたの単純なケースではこれはうまくいきます。

Mockitoがスーパーコンストラクターを呼び出さないため、プライベート値が設定されないという同じ問題がありました。これが私が反射でモックをどのように増強するかです。

最初に、これらのリフレクションメソッドを含む多くの便利なユーティリティを含むTestUtilsクラスを作成しました。リフレクションアクセスは、毎回実装するのが少し面倒です。私はこれらのメソッドを作成して、何らかの理由でモックパッケージがなく、インクルードするよう招待されなかったプロジェクトでコードをテストしました。

public class TestUtils {
    // get a static class value
    public static Object reflectValue(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(classToReflect, fieldNameValueToFetch);
            reflectField.setAccessible(true);
            Object reflectValue = reflectField.get(classToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // get an instance value
    public static Object reflectValue(Object objToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameValueToFetch);
            Object reflectValue = reflectField.get(objToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // find a field in the class tree
    public static Field reflectField(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField = null;
            Class<?> classForReflect = classToReflect;
            do {
                try {
                    reflectField = classForReflect.getDeclaredField(fieldNameValueToFetch);
                } catch (NoSuchFieldException e) {
                    classForReflect = classForReflect.getSuperclass();
                }
            } while (reflectField==null || classForReflect==null);
            reflectField.setAccessible(true);
            return reflectField;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch +" from "+ classToReflect);
        }
        return null;
    }
    // set a value with no setter
    public static void refectSetValue(Object objToReflect, String fieldNameToSet, Object valueToSet) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameToSet);
            reflectField.set(objToReflect, valueToSet);
        } catch (Exception e) {
            fail("Failed to reflectively set "+ fieldNameToSet +"="+ valueToSet);
        }
    }

}

次に、このようなプライベート変数を使用してクラスをテストできます。これは、ユーザーが制御できないクラスツリーの奥深くをモックする場合に役立ちます。

@Test
public void testWithRectiveMock() throws Exception {
    // mock the base class using Mockito
    ClassToMock mock = Mockito.mock(ClassToMock.class);
    TestUtils.refectSetValue(mock, "privateVariable", "newValue");
    // and this does not prevent normal mocking
    Mockito.when(mock.somthingElse()).thenReturn("anotherThing");
    // ... then do your asserts
}

ここのページで、実際のプロジェクトのコードを変更しました。コンパイルの問題が発生する可能性があります。あなたは一般的な考えを理解していると思います。コードを入手して、必要に応じて自由に使用してください。

他の多くの人はすでに、コードを再検討してテストしやすくするようにアドバイスしています。優れたアドバイスであり、通常、私が提案するものよりも単純です。

コードを変更してテストしやすくすることができない場合は、PowerMock：https ://code.google.com/p/powermock/

PowerMockはMockitoを拡張し（新しいモックフレームワークを学ぶ必要がないため）、追加の機能を提供します。これには、コンストラクタにモックを返す機能が含まれます。強力ですが、少し複雑です。慎重に使用してください。

別のモックランナーを使用している。また、コンストラクターを呼び出すクラスを準備する必要があります。（これは一般的な問題です-構築されたクラスではなく、コンストラクターを呼び出すクラスを準備してください）

@RunWith(PowerMockRunner.class)
@PrepareForTest({First.class})

次に、テスト設定でwhenNewメソッドを使用して、コンストラクターにモックを返させることができます

whenNew(Second.class).withAnyArguments().thenReturn(mock(Second.class));

はい、次のテストが示すように、これを行うことができます（私が開発したJMockitモッキングAPIを使用して作成）。

@Test
public void testFirst(@Mocked final Second sec) {
    new NonStrictExpectations() {{ sec.doSecond(); result = "Stubbed Second"; }};

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

ただし、Mockitoでは、そのようなテストを作成することはできません。これは、モック対象のクラスのサブクラスが作成されるMockitoでモッキングが実装される方法が原因です。この「モック」サブクラスのインスタンスのみがモック動作を実行できるため、テスト済みのコードで他のインスタンスの代わりにそれらを使用する必要があります。

mockitoでSpringのReflectionTestUtilsの代替が必要な場合は、

Whitebox.setInternalState(first, "second", sec);