web-dev-qa-db-ja.com

voidメソッドをモックして例外をスローするにはどうすればよいですか？

私はこのような構造を持っています：

public class CacheWrapper {
    private Map<Object, Object> innerMap;

    public CacheWrapper() {
        //initialize the innerMap with an instance for an in-memory cache
        //that works on external server
        //current implementation is not relevant for the problem
        innerMap = ...;
    }

    public void putInSharedMemory(Object key, Object value) {
        innerMap.put(key, value);
    }

    public Object getFromSharedMemory(Object key) {
        return innerMap.get(key);
    }
}

そして、私のクライアントクラス（あなたはそれがこのように見えると言うことができます）：

public class SomeClient {
    //Logger here, for exception handling
    Logger log = ...;
    private CacheWrapper cacheWrapper;
    //getter and setter for cacheWrapper...

    public Entity getEntity(String param) {
        Entity someEntity = null;
        try {
            try {
                entity = cacheWrapper.getFromSharedMemory(param);
            } catch (Exception e) {
                //probably connection failure occurred here
                log.warn("There was a problem when getting from in-memory " + param + " key.", e);
            }
            if (entity == null) {
                entity = ...; //retrieve it from database
                //store in in-memory cache
                try {
                    cacheWrapper.put(param, entity);
                } catch (Exception e) {
                    //probably connection failure occurred here
                    log.warn("There was a problem when putting in in-memory " + param + " key.", e);
                }
            }
        } catch (Exception e) {
            logger.error(".......", e);
        }
        return entity;
    }
}

SomeClient#getEntityメソッドのユニットテストを作成していますすべてのシナリオをカバーする必要があります。たとえば、cacheWrapperによってスローされる例外があるシナリオをカバーする必要があります。私が従うアプローチは、CacheWrapperクラスのモックを作成し、CacheWrapperクラスのメソッドを作成してRuntimeExceptionをスローし、このモックをSomeClientのインスタンスに設定してSomeclient#getEntityをテストすることです。問題は、putInSharedMemoryであるため、voidメソッドをモックしようとするときです。これを行うには多くの方法を試しましたが、どれも機能しません。 プロジェクトにはPowerMockとEasyMockの依存関係があります。

私の試みは次のとおりです。

  1. EasyMock.<Void>expectを使用します。これにより、コンパイラエラーが発生しました。

  2. CacheWrapper#putInSharedMemoryをスタブしようとしました。次のエラーメッセージで例外が発生したため、機能しませんでした。

    Java.lang.AssertionError：予期しないメソッド呼び出しputInSharedMemory（ "foo"、com.company.domain.Entity@609fc98）

  3. Mockito依存関係をプロジェクトに追加PowerMockitoクラスの機能を利用します。しかし、EasyMockと統合されていないため、例外が発生しました。これは発生した例外です。

    Java.lang.ClassCastException：org.powermock.api.easymock.internal.invocationcontrol.EasyMockMethodInvocationControlはorg.powermock.api.mockito.internal.invocationcontrol.MockitoMethodInvocationControlにキャストできません

この単体テストサンプルのコードは次のとおりです。

@Test
public void getEntityWithCacheWrapperException() {
    CacheWrapper cacheWrapper = mockThrowsException();
    SomeClient someClient = new SomeClient();
    someClient.setCacheWrapper(cacheWrapper);
    Entity entity = someClient.getEntity();
    //here.....................^
    //cacheWrapper.putInSharedMemory should throw an exception

    //start asserting here...
}

//...

public CacheWrapper mockThrowsException() {
    CacheWrapper cacheWrapper = PowerMock.createMock(CacheWrapper.class);
    //mocking getFromSharedMemory method
    //this works like a charm
    EasyMock.expect(cacheWrapper.getFromSharedMemory(EasyMock.anyObject()))
        .andThrow(new RuntimeException("This is an intentional Exception")).anyTimes();

    //mocking putInSharedMemory method
    //the pieces of code here were not executed at the same time
    //instead they were commented and choose one approach after another

    //attempt 1: compiler exception: <Void> is not applicable for <void>
    EasyMock.<Void>expect(cacheWrapper.putInSharedMemory(EasyMock.anyObject(), EasyMock.anyObject()))
        .andThrow(new RuntimeException("This is an intentional Exception")).anyTimes();

    //attempt 2: stubbing the method
    //exception when executing the test:
     //Unexpected method call putInSharedMemory("foo", com.company.domain.Entity@609fc98)
    Method method = PowerMock.method(CacheWrapper.class, "putInSharedMemory", Object.class, Object.class);
    PowerMock.stub(method).toThrow(new RuntimeException("Exception on purpose."));

    //attempt 3: added dependency to Mockito integrated to PowerMock
    //bad idea: the mock created by PowerMock.createMock() belongs to EasyMock, not to Mockito
    //so it breaks when performing the when method
    //exception:
    //Java.lang.ClassCastException: org.powermock.api.easymock.internal.invocationcontrol.EasyMockMethodInvocationControl
    //cannot be cast to org.powermock.api.mockito.internal.invocationcontrol.MockitoMethodInvocationControl
    //at org.powermock.api.mockito.internal.expectation.PowerMockitoStubberImpl.when(PowerMockitoStubberImpl.Java:54)
    PowerMockito.doThrow(new RuntimeException("Exception on purpose."))
        .when(cacheWrapper).putInSharedMemory(EasyMock.anyObject(), EasyMock.anyObject());

    PowerMock.replay(cacheWrapper);
    return cacheWrapper;
}

CacheWrapperの実装を変更することはできません。サードパーティのライブラリに由来するためです。また、EasyMock#getLastCallでテストを実行しているため、SomeClient#getEntityを使用できません。

どうすればこれを克服できますか？

javaunit-testingexceptionpowermockeasymock
12
Luiggi Mendoza

どのクラスも最終クラスではないため、PowerMockitoに頼らずに「純粋なmockito」を使用できます。

_final CacheWrapper wrapper = Mockito.spy(new CacheWrapper());

Mockito.doThrow(something)
    .when(wrapper).putInSharedMemory(Matchers.any(), Matchers.any());
_

スタブへの「メソッド引数」は実際には引数マッチャーであることに注意してください。特定の値を置くことができます（特定のメソッドに「囲まれていない」場合、.equals()を呼び出します）。そのため、引数ごとにスタブの動作を異なる方法でガイドできます。

また、Mockitoで.replay()を使用する必要はありません。これは非常に便利です。

最後に、doCallRealMethod()も使用できることに注意してください。その後、それはあなたのシナリオに依存します...

（注：Mavenで利用可能な最後のmockitoバージョンは1.10.17 FWIWです）

17
fge

EasyMockまたはMockitoを使用していますか？両方とも異なるフレームワークです。

PowerMockitoは、これらの両方のフレームワークで使用できるスーパーセット（または補足）です。 PowerMockitoを使用すると、MockitoまたはEasyMockでできないことを実行できます。

Voidメソッドをスタブ化して例外をスローするには、これを試してください。

EasyMock：

// First make the actual call to the void method.
cacheWrapper.putInSharedMemory("key", "value");
EasyMock.expectLastCall().andThrow(new RuntimeException());

小切手：

Mockito：

 // Create a CacheWrapper spy and stub its method to throw an exception.
 // Syntax for stubbing a spy's method is different from stubbing a mock's method (check Mockito's docs).
 CacheWrapper spyCw = spy(new CacheWrapper()); 
 Mockito.doThrow(new RuntimeException())
     .when(spyCw)
     .putInSharedMemory(Matchers.any(), Matchers.any());

 SomeClient sc = new SomeClient();
 sc.setCacheWrapper(spyCw);

 // This will call spyCw#putInSharedMemory that will throw an exception.
 sc.getEntity("key");
5
nhylated

次のような expectLastCall を使用します。

    cacheWrapper.putInSharedMemory(EasyMock.anyObject(), EasyMock.anyObject())
    EasyMock.expectLastCall().andThrow(new RuntimeException("This is an intentional Exception")).anyTimes();
2
NiematojakTomasz