[Java][Spring]JUnit + JMockitでユニットテストとカバレッジを導入する

Joinしたプロジェクトでユニットテストをしていないと分かったときの絶望感。

ということで、Java + Spring Frameworkという構成のプロジェクトにJMockitでユニットテストとカバレッジレポートを導入します。

構成

Java 8
Spring Framework 4.1系
JUnit 4系
JMockit 1.21
Eclipse

STSを利用している場合EclipseをSTSと読み替えてください。
ほぼ同じです。

準備

pom.xml

プロジェクトの依存関係にテスト関係のライブラリを追加します。
pom.xmlに以下を追加してください。

<dependencies>
    :
    <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-test</artifactId>
         <version>${spring-ver}</version>
    </dependency>
    <dependency>
        <groupId>org.jmockit</groupId>
        <artifactId>jmockit</artifactId>
        <version>1.21</version>
    </dependency>
    <dependency>
        <groupId>org.jmockit</groupId>
        <artifactId>jmockit-coverage</artifactId>
        <version>1.21</version>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>${junit-ver}</version>
        <scope>test</scope>
    </dependency>
    :
<dependencies>

メモ

JMockitはグループIDが変わっています。

1.8以前：com.googlecode.jmockit
1.8から：org.jmockit

STSの設定

1.pom.xmlを編集後にプロジェクトを更新する
2.プロジェクトの設定を開き、[ ビルドパス > ライブラリ ]で外部 Jar 追加(Add External JARs)をクリックし、手元のMavenローカル・リポジトリからjmockit.jarを選択する。
3.ビルドの順番(Order and Export)で、JUnitより先にjmockitが読み込まれるようにする。

メモ

eclipseのメニュー名称は環境によって若干異なるようですね。

また、Mavenのローカル・リポジトリの場所が分からないという場合はEclipseの設定を開き、[ Maven > ユーザ設定 ]をチェックしてみてください。
通常はホーム直下に.m2があると思います。

私の場合は次の場所でした。(win)

C:\Users\atuweb\.m2\repository\org\jmockit\jmockit\1.21

また、ビルドの順番にJUnitが見当たらない場合は、JMockitをMaven Dependenciesの上にすればOKです。

テストを実装する

ディレクトリとパッケージ

テスト用のディレクトリをsrc/test/javaに追加し、この下にパッケージを追加していく
パッケージの構成はテスト対象のクラスと合わせる

例
net.atuweb.game.web.service.UserService.javaをテストする場合
net.atuweb.game.web.service.UserServiceTest.javaをクラスを作成する

テストクラスの書き方

// JMockitを動かすためのアノテーション
@RunWith(JMockit.class)
public class UserServiceTest {

    // テスト対象のサービスクラスをnewする
    private UserService targetService = new UserServiceImpl();

    // テスト対象クラスで@Autowiredしているものは@Mockedを宣言する
    @Mocked
    private CacheService cacheService;

    // テストではDIされないため、モックしたものをそれぞれDeencapsulation.setField()する
    @Before
    public void setUp() throws Exception {
        Deencapsulation.setField(targetService, cacheService);
    }

    // @Testアノテーションをつけたものがテスト対象と見做される
    @Test
    public void getSkillsTest() {
        MSkill skill1 = new MSkill();
        skill1.setId(17);
        :
        MSkill skill2 = new MSkill();
        skill2.setId(18);
        :

        // テスト対象メソッド内でDIされたインスタンスの処理結果をセットし、任意の状態を作り出す
        // resultは開業せずに同じ行に書くほうが多いようだ
        new NonStrictExpectations() {{
            cacheService.findSkill(17);      result = skill1;
            cacheService.findSkill(anyInt);  result = skill2;
            :
        }};

        // テスト対象メソッドの実行と、結果の検証
        List<UserSkill> skills = targetService.getSkills(888L);
        assertEquals(skills.size(), 2);
        assertEquals(skills.get(0).getId(), skill1.getId());
        :
    }

    // プライベートなメソッドのテストではリフレクションを用いる
    @Test
    public void calcHpTest() throws Exception {
        Method method = UserServiceImpl.class.getDeclaredMethod(
            "calcHp",
            Integer.class,
            int.class,
            int.class
        );
        method.setAccessible(true);

        assertEquals((Integer)method.invoke(targetService, 1, 3, 2), new Integer(2));
        :
    }
}