Java

StrutsのActionをMockitoを使ってUnitTestする #javaadventja2010

まさる（高野将、TAKANO Sho） — Fri, 17 Dec 2010 05:19:00 GMT

このエントリは Java Advent Calendar -ja 2010 : ATND の 5日目のものです。

やぁ、みなさんStruts使ってますか！最近「いつまでStruts1を使い続けるの？ - 達人プログラマーを目指して」とか「Strutsの終焉: プログラマの思索」とかで、何かと話題のStruts1ですが、もろもろの事情で使わなければいけないことって多いですよね？ね！

で、仕方なく使わざるを得ないStrutsですが、ActionのexecuteメソッドがそのままだとJUnitなんかでUnitTest(できない|できても大変)で困ります。

そんな時は、Mockを使ってテストしましょう！今回はMockitoを使います。

こんなActionがあったとして。

package com.example.masaru.action;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;

public class TestAction extends Action {
	
	@Override
	public ActionForward execute(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		return mapping.findForward("success");
	}
}

Mockitoを使って、こんなテストコードを書きます。

package com.example.masaru.action;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.junit.Test;

public class TestActionTest {
	@Test
	public void testExecute() throws Exception {
		TestAction action = new TestAction();

		// Action.executeの引数をMockにする
		ActionMapping mapping = mock(ActionMapping.class);
		ActionForm form = mock(ActionForm.class);
		HttpServletRequest request = mock(HttpServletRequest.class);
		HttpServletResponse response = mock(HttpServletResponse.class);

		// mappingの挙動を擬装
		when(mapping.findForward("success")).thenReturn(
				new ActionForward("success", "/dest", false));

		// action.execute呼び出し
		ActionForward forward = action.execute(mapping, form, request, response);

		// mapping.findForwardが呼ばれたか検証
		verify(mapping).findForward("success");

		// 戻り値を検証
		assertThat(forward, is(notNullValue()));
		assertThat(forward.getName(), is("success"));
		assertThat(forward.getPath(), is("/dest"));
	}
}

こんな風にSessionをActionで使う場合は・・・

package com.example.masaru.action;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;

public class TestAction extends Action {
	
	@Override
	public ActionForward execute(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {

		HttpSession session = request.getSession();
		String hoge = (String)session.getAttribute("session_key");
		
		return mapping.findForward("success");
	}
}

テスト側でrequestのgetSessionメソッドを擬装します。

package com.example.masaru.action;

import static org.mockito.Mockito.*;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionMapping;
import org.junit.Test;

public class TestActionTest {
	@Test
	public void testExecute() throws Exception {
		TestAction action = new TestAction();

		// Action.executeの引数をMockにする
		ActionMapping mapping = mock(ActionMapping.class);
		ActionForm form = mock(ActionForm.class);
		HttpServletRequest request = mock(HttpServletRequest.class);
		HttpServletResponse response = mock(HttpServletResponse.class);

		// request、sessionの挙動を擬装
		HttpSession session = mock(HttpSession.class);
		when(session.getAttribute("session_key")).thenReturn("foo");
		
		when(request.getSession()).thenReturn(session);

		// action.execute呼び出し
		action.execute(mapping, form, request, response);

		// session関連処理が呼ばれたか検証
		verify(request).getSession();
		verify(session).getAttribute("session_key");
	}
}

他にも工夫次第で、いくらでも柔軟に対応できますよ♪

というわけで、皆さんもMockを使って、嫌われ者のStruts1でも快適TDDライフを謳歌してみてはいかがでしょうか？

ちなみに、当たり前ですがstruts-config.xmlやらvalidation.xmlやらの設定は読み込まれませんので、その辺はご注意くださいませ<(_ _)>

Mockを利用して内部で実行する処理に渡すパラメータを検証する～パラメータオブジェクト編～

まさる（高野将、TAKANO Sho） — Tue, 30 Nov 2010 05:06:00 GMT

Mockを利用して内部で実行する処理に渡すパラメータを検証するの続き。

前回はシンプルなString型のパラメータについての検証でした。しかし、実際に様々なプログラムを作っていくうえでは、パラメータオブジェクトで値をやり取りすることも多いはずです。

そんな時は、MockitoのdoAnswerメソッド、whenメソッドなどを使い、内部で実行される処理を偽装し、その内部で検証を行うことができます。

１．テスト対象クラス

package com.example.sample;

public class MyClass {
	// これをMockで置き換えてテストする
	private Delegatee delegatee;

	public MyClass(Delegatee delegatee) {
		super();
		this.delegatee = delegatee;
	}

	public void doSomething(String id, String name) {
	}
}

２．テストクラス

package com.example.sample;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.mockito.Matchers.*;
import static org.mockito.Mockito.*;

import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

public class MyClassTest {
	@Test
	public void testDoSomethingByMyParam() throws Exception {
		// Mock作成
		Delegatee delegatee = mock(Delegatee.class);
		
		// callメソッドの振る舞いを偽装
		// その内部でパラメータの妥当性を検査
		doAnswer(new Answer() {
			@Override
			public Object answer(InvocationOnMock invocation) throws Throwable {
				// callメソッドのパラメータを取得
				MyParam param = (MyParam)invocation.getArguments()[0];
				
				assertThat(param.getId(), is("001"));
				assertThat(param.getName(), is("hoge"));

				return null;
			}
		}).when(delegatee).call((MyParam)anyObject());
		
		MyClass myClass = new MyClass(delegatee);
		myClass.doSomething("001", "hoge");

		// callメソッドが呼び出されたか検証
		verify(delegatee).call((MyParam)anyObject());
	}
}

３．テスト結果

初回はテストに失敗します。

Delegatee.callメソッドを呼び出していないので、テストに失敗していることが読み取れます。

では、まずはnullを渡して呼び出すようにしてテストを実行してみましょう。

	public void doSomething(String id, String name) {
		delegatee.call(null);
	}

今度は偽装したDelegatee.callメソッドの内部でNullPointerExceptionが発生していることがわかります。

次は空のMyParamオブジェクトを渡すように修正してテストを実行してみます。

	public void doSomething(String id, String name) {
		delegatee.call(new MyParam());
	}

ようやく、渡されたパラメータの値のAssertionErrorとなりました。

最後に、MyClass.doSomethingメソッドのパラメータをもとに、MyParamオブジェクトを作成してやるように修正して、テストを実行してみます。

	public void doSomething(String id, String name) {
		MyParam param = new MyParam();
		param.setId(id);
		param.setName(name);
		delegatee.call(param);
	}

これで無事にテストにパスしました。

もしかしたらもうちょっと簡単な方法があるかもしれませんが、ここ最近よく使っている手法を紹介しました。

他にも便利なMockの使い方があったら、ぜひコメント欄で教えてください。

Mockを利用して内部で実行する処理に渡すパラメータを検証する

まさる（高野将、TAKANO Sho） — Thu, 25 Nov 2010 05:29:00 GMT

最近仕事ではJava一色なのですが、TDDを実践する機会に恵まれました。というわけで、Eclipse+JUnit+Quick JUnit+Mockitoを使ってゴリゴリプログラミングしています。

（Quick JUnitとMockitoについては、「単体テストを“神速”化するQuick JUnitとMockito - ＠IT」をご覧ください。）

そんな中で発見したMockの使い方の一つを紹介します。それは、「テスト対象クラスが、内部で呼び出している処理に渡すパラメータを検証する」方法です。

１．テスト対象クラス

package com.example.sample;

public class MyClass {
	// これをMockで置き換えてテストする
	private Delegatee delegatee;

	public MyClass(Delegatee delegatee) {
		super();
		this.delegatee = delegatee;
	}

	public void doSomething(String arg) {
		delegatee.call(arg+"1");
	}
}

doSomethingメソッドの内部で、delegatee.callメソッドを呼び出すという簡単なクラスです。

（Delegateeクラスは割愛）

２．テストクラス

package com.example.sample;

import static org.mockito.Matchers.*;
import static org.mockito.Mockito.*;

import org.junit.Test;

public class MyClassTest {
	@Test
	public void testDoSomething() throws Exception {
		// Mock作成
		Delegatee delegatee = mock(Delegatee.class);

		MyClass myClass = new MyClass(delegatee);
		myClass.doSomething("foo");

		// callメソッドがパラメータ"foo1"で呼び出されたか検証
		verify(delegatee).call(eq("foo1"));
	}
}

テストでは、DelegateeクラスのMockを作成し、MyClass.doSomethingメソッドでDelegatee.callメソッドに渡された引数を検証します。

３．テスト結果

テストに成功すると以下のようになります。

仮にMyClass.doSomethingメソッドに欠陥があり、テストに失敗すると、次のようになります。

ちゃんと「パラメータが違うよ！」って怒ってくれます。

今回はJava+Mockitoでしたが、.NET+Moqとかでも同じことができるはずです（よね？）

今後しばらくはこういうネタを投下していこうかと思います。