16 Dec 2012, 23:02

JMockのインストールとEclipseでの使い方まとめ

JMockとは、JAVAでモックオブジェクトを簡単に作成するためのフレームワーク。
モックオブジェクトを利用すると、以下のことが簡単にテストできる。

  • メゾッドが何回呼ばれたか。
  • メソッドがどんな引数で呼ばれたか。
  • メソッドから任意の値を返す。
  • メゾッドがどんなシーケンスで呼ばれたか。

などなど。他にもできることはたくさん。

JMockの設定方法

JMockのダウンロード

以下のサイトより、ダウンロード。
ここでは、最新安定版の 2.5.1 jmock-2.5.1-jars.zipを落とす。

jMock – Downloads

Eclipseでビルド・パスを通す

ダウンロードしたzipファイルを解凍し、任意の場所に置く。
(ここでは、jmockと名前を変更してC:\src\jmockにおいた)

EclipseからJMockライブラリを利用するために、ビルド・パスを通す。
プロジェクトを選択して、[ブロパティ] > [Javaのビルドパス]を選択。
[ライブラリ]タブ > [ライブラリの追加] > [ユーザライブラリ] > [次へ]
[ユーザライブラリ] > [新規]を選択。

ライブラリを作成するために、[JMock2]と名前をつける。
続いて、[外部Jar追加]。ここでは、以下のJarを追加。

  • jmock-2.5.1.jar
  • jmock-junit4-2.5.1.jar
  • hamcrest-library-1.1.jar
  • hamcrest-core-1.1.jar

JMockを動かしてみる

JMockを動かしてみる。JMockを利用するためには、テスト対象のコードは以下。

public class Sample {

    private External external;

    public int num() {
        return external.get_num();
    }

    public void setExternal(External external) {
        this.external = external;
    }
}

インタフェースの用意

JMockを利用してモックオブジェクトを作成するためには、

クラスのメソッドがインタフェース化されている必要がある。

インタフェースを利用することで、『実体』と『モック』を置き換えることができる。

public interface External {
    int get_num();
}

テストコードの追加

続いて、テストコードの追加。ここでは、1回呼ばれることを検証している。oneOf

されに、生成されたモックの戻り値として返して貰いたい数字を指定している(10)

import static org.junit.Assert.*;

import org.jmock.Expectations;
import org.jmock.Mockery;
import org.jmock.integration.junit4.JMock;
import org.jmock.integration.junit4.JUnit4Mockery;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

@RunWith(JMock.class)   // TestRunnerを使う宣言
public class mock_sampleTest {
    private final Mockery context = new JUnit4Mockery(); //モッカリー生成
    private External external;
    private Sample impl;

    @Before  // 事前処理宣言
    public void setUp() throws Exception {
        external = context.mock(External.class);  //インタフェースのモック生成
        impl = new Sample();                       //テスト対象の宣言
        impl.setExternal(external);
    }

    @Test
    public void firstMockGenerate() {
        context.checking(new Expectations() {{
            oneOf(external).get_num();      //1回呼びだされる
            will(returnValue(10));          //10を返す
        }});
        assertEquals(10, impl.num());       //メソッド呼び出し
    }
}

モッカリーとは、テスト実行中にモックを呼び出す。

モッカリーやモック生成は定型文なので、コピペで。

テストを実行すると、グリーンバーが出てテストが成功することがわかる。

おまけ

Eclipseだと、もともと入っているJUnitとJMockでのものが競合する場合がある。

そんなときは、以下の解決方法を参照。

EclipseにJMockを入れてSecurityExceptionが発生。