はじめに
仕事で JavaのTesting Frameworkとして Spockを利用する予定があったので、一生懸命勉強していたが、政治的な理由によって Spockではなく JUnitが採用されてしまった！
というわけで、急遽 JUnitで利用できそうな Mockフレームワークを調査。
PowerMockというのがなかなかいけているので、それを調べた。
今回のテスト対象コードは、以前書いたSpock Frameworkのときのと同じです。
package sample;
public class MockSample {
private MessageManager mgr;
public void setMgr(MessageManager mgr) {
this.mgr = mgr;
}
public MockSample() {
mgr = new MessageManagerImpl();
}
public void sendMsg(String msg) {
mgr.send(msg);
}
public int sendMsg2(String msg) {
return mgr.send2(msg);
}
public void sendMsg3(String msg) {
MessageManager mgr2 = new MessageManagerImpl();
mgr2.send(msg);
}
public static int sendMsg4(String msg) {
return MessageManagerStatic.send(msg);
}
private void sendMsg5(String msg) {
mgr.send(msg);
}
}
package sample;
public interface MessageManager {
void send(String msg);
int send2(String msg);
}
package sample;
public class MessageManagerImpl implements MessageManager {
@Override
public void send(String msg) {
System.out.println(msg);
}
@Override
public int send2(String msg) {
System.out.println(msg);
return 0;
}
}
package sample;
public class MessageManagerStatic {
public static int send(String msg) {
System.out.println(msg);
return 0;
}
}
PowerMock Install w/ gradle
Gradleをビルドツールで利用しているので、gradleの方法を書く。
公式wikiには、Mavenのやり方が書いてあるので、そちらを参照。
build.gradleの dependenciesに以下を追加する。
もっと最新バージョンが出ているらしいが不安定だとwikiに書いてあったので、安定バージョンを。
dependencies {
testCompile junit:junit:4.12
testCompile org.powermock:powermock-module-junit4:1.6.2
testCompile org.powermock:powermock-api-mockito:1.6.2
}
テスト！テスト！テスト！
テストする内容は、比較のためSpock Frameworkと同じにしてます。
まずは、お決まりのおまじないアノテーション2つを書く
-
@RunWith(PowerMockRunner.class)
-
@PrepareForTest({MockSample.class, MessageManagerStatic.class})
-
MockSample.class メソッド内のインスタンスモック用
-
MessageManagerStatic メソッド内のスタティックメソッドモック用
呼び出し引数と回数をチェック
-
-
times で 呼び出し回数をチェック
-
Mockito.veirfy(spy).send(“Hello”) で引数にHelloが来たかチェック
@Test
public void 呼び出し引数をチェック() {
MessageManager spy = PowerMockito.spy(new MessageManagerImpl());
sample.setMgr(spy);
sample.sendMsg("Hello");
sample.sendMsg("Hello");
Mockito.verify(spy, times(2)).send("Hello");
}
戻り値を返す
- when(spy.send2(“Hello”)).thenReturn(1) で 1を返す.
@Test
public void 戻り値を返す() {
MessageManager spy = PowerMockito.spy(new MessageManagerImpl());
when(spy.send2("Hello")).thenReturn(1);
sample.setMgr(spy);
int ret = sample.sendMsg2("Hello");
Mockito.verify(spy, times(1)).send2("Hello");
assertThat(1, is(ret));
}
メソッド内で生成されるインスタンスをモックに置き換える
- PowerMockit.whenNiewでMessageManagerImplがnew されたときに、作成したmockオブジェクトにすり替える。
この機能は、いろんなフレームワークを試しきたが、PowerMock/Mockitoで初めて見た。
@Test
public void メソッド内で生成されるインスタンスをモックに置き換える() throws Exception {
// https://github.com/powermock/powermock/wiki/MockConstructor
MessageManagerImpl mock = PowerMockito.mock(MessageManagerImpl.class);
PowerMockito.whenNew(MessageManagerImpl.class).withNoArguments().thenReturn(mock);
sample.sendMsg3("Hello");
Mockito.verify(mock).send("Hello");
}
staticなメソッドをテストする
オブジェクト内のメソッドからstaticメソッドを呼んでいたって、モックを利用することで、戻り値を書き換えることができる。
@Test
public void staticなメソッドをテストする() {
// https://github.com/powermock/powermock/wiki/Mockito#mocking-static-method
PowerMockito.mockStatic(MessageManagerStatic.class);
Mockito.when(MessageManagerStatic.send("Hello")).thenReturn(1);
int ret = sample.sendMsg4("Hello");
assertThat(1, is(ret));
}
例外を発生させる
モックのメソッドが呼ばれたら例外を発生させることもできる。 PowerMockito.doThrow(new Exception).when(mock).send(“Hello”)で実現している。
@Test
public void 例外が発生しないことを確認する() {
try {
sample.sendMsg("Hello");
} catch (Exception e) {
fail(e.getMessage());
}
}
@Test(expected = IllegalStateException.class)
public void 例外が発生したこと確認する() throws Exception {
MessageManagerImpl mock = PowerMockito.mock(MessageManagerImpl.class);
PowerMockito.doThrow(new IllegalStateException()).when(mock).send("Hello");
PowerMockito.whenNew(MessageManagerImpl.class).withNoArguments().thenReturn(mock);
sample.sendMsg3("Hello");
}
おわりに
PowerMock, メソッド内で生成されるインスタンスをモックに置き換える機能がとても強力。
しかし、最大の問題点は、ドキュメントが少ないことだ。いろいろネットで情報を漁ってみたものの、情報量が少ない。
やっぱりSpockを使いたいなあ。
今回のコードはgithubにもあげています。