そういえばdjUnitのダウンロード手順をまとめてなかったので今更ながらメモしておきます。
EclipseでJUnitやDjUnitを実行すると「junit java.lang.OutOfMemoryError: Java heap space」とメモリエラーが表示された場合は「デフォルトのVM引数」を設定する事でこの事象を回避する事が出来るのでその設定方法をご紹介します。
|
1 |
-Xms=1024m -Xmx=1024m -XX:PermSize=128m -XX:MaxPermSize=128m -XX:NewSize=320m -XX:MaxNewSize=320m -XX:SurvivorRatio=2 -XX:TargetSurvivorRatio=80 |
djUnitではメソッドが呼び出された際、強制的に特定のExceptionを発生させる事も可能です。強制的にExceptionを発生させる場合には「addReturnValue」を使用します。
1点注意しておきたいのは「addReturnValue」を使用してExceptionを発生させた時はjunitで「@Test(expected = RuntimeException.class)」の様にアノテーションでは確認出来ないのでTry～catchで確認する必要があります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
/** * <p>[概 要] URLエンコード処理</p> * <p>[詳 細] </p> * <p>[備 考] </p> * @param str 文字列 * @param enc - 文字コード * @return URLエンコード後の文字列 */ public static String urlEncode(String str, String enc){ String urlEncode = ""; StringBuffer result = new StringBuffer(); try { urlEncode = URLEncoder.encode(str, enc); } catch (UnsupportedEncodingException e) { throw new RuntimeException(e.toString()); } // 半角スペースは「%20」へ置換する for(char c : urlEncode.toCharArray()) { switch (c) { case '+' : result.append("%20"); break; default : result.append(c); break; } } return result.toString(); } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
@Test public void testUrlEncode_exception() { // 準備 String str = "/&<>\"\' abc123"; String enc = "utf-8"; // 「URLEncoder.encode()」を実行した際、UnsupportedEncodingExceptionを発生させます。 addReturnValue(URLEncoder.class, "encode", new UnsupportedEncodingException("MESSAGE001")); try { // 実行 UtilSample1.urlEncode(str, enc); fail("この行は、実行されないはず"); } catch (Throwable t) { assertTrue(t instanceof RuntimeException); assertEquals("java.io.UnsupportedEncodingException: MESSAGE001", t.getMessage()); } } |
ちょっとdjUnitで「addReturnValue」を使用しても全く効いてない？という事象に少しハマっていたので原因についてメモしておきます。
addReturnValueが効かない原因として上げられるのが概ね以下の3つになるかと思います。1と2については少し見なおせばすぐ発見出来そうですが、今回ハマった原因が3でした。。。
では「指定したメソッドが複数回実行されている」というのはどういう事かというとについて説明します。
根本的な話として以下の2つのコードは全く同じ意味という事を理解しておく必要があります。
|
1 2 |
addReturnValue(UtilClass1.class, "getStr", expected1); setReturnValueAt(UtilClass1.class, "getStr", 0, expected1); |
これだけで気づく方はハッと思うかもしれませんが、ここで重要なのはaddReturnValueでは「1回目に実行」されたメソッドのみしかaddReturnValueで指定した値が返ってこないという事です。つまり「setReturnValueAt」で1回目を指定した場合と同様の動きしかしてくれないのです。
今回私がハマったのは指定したメソッドが想定した箇所よりも手前で事前に実行されていた為、想定したいたメソッドは2回目の実行になっていたために2回目の方にはaddReturnValueが効いていなかったという事象でした。
addReturnValueをしてクラス名やメソッド名は正しいのにどうも効いていないように見える時は一度「getCallCount」でメソッドの実行回数を調査して見ると良いかもしれません。
djUnitではメソッドが呼び出されている事の確認は「assertCalled」を使用する事で確認出来ましたが、逆にメソッドを呼び出されていない事の確認では「assertNotCalled」を使用する事で確認出来ます。
|
1 2 3 4 5 6 7 8 9 |
/** * <p>[概 要] メソッド呼出サンプル確認用</p> * <p>[詳 細] </p> * <p>[備 考] </p> */ public static void sample1(){ String strEscape = htmlEscape("sample1-1"); String strEncode = urlEncode("sample1-2", "sample1-3"); } |
|
1 2 3 4 5 6 7 8 |
@Test public void testSample1_2() { // 実行 UtilSample1.sample1(); // 検証 assertNotCalled(UtilSample1.class, "getDiffDays"); } |
djUnitではassertCalledを使用する事でメソッドが呼び出された事が確認出来ます。
|
1 2 3 4 5 6 7 8 9 |
/** * <p>[概 要] メソッド呼出サンプル確認用</p> * <p>[詳 細] </p> * <p>[備 考] </p> */ public static void sample1(){ String strEscape = htmlEscape("sample1-1"); String strEncode = urlEncode("sample1-2", "sample1-3"); } |
|
1 2 3 4 5 6 7 8 9 |
@Test public void testSample1() { // 実行 UtilSample1.sample1(); // 検証 assertCalled(UtilSample1.class, "htmlEscape"); assertCalled(UtilSample1.class, "urlEncode"); } |
以下の様に「getCallCount」を使用する事でメソッドが何回呼び出されたかを確認する事も出来ます。
|
1 2 |
int countHtmlEscape = getCallCount(UtilSample1.class, "htmlEscape"); assertEquals(10, countHtmlEscape); |
djUnitでテストする際に、一部のメソッドは特に実行する必要はないけどそのメソッドの処理はスルーさせたいケースがたまに発生します。こういう場合にはdjUnitのaddReturnValue機能を活用する事でそのメソッドの処理を無効化する事が出来ます。
通常addReturnValueはメソッドの戻り値を好みの値に変更する際に使用しますが、戻り値なし（void）のメソッドの時には通常使用しません。それでも戻り値なしのメソッドをaddReturnValueで指定するとそのメソッドが実行されずメソッドの処理を無効化する事が出来ます。
ただし、この方法は戻り値なし（void）のメソッドにしか活用出来ませんのでご注意下さい。
|
1 2 3 4 5 6 7 8 9 |
/** * <p>[概 要] メソッド無効化サンプル確認用</p> * <p>[詳 細] </p> * <p>[備 考] </p> * @param String 文字列 */ public static void sample1(String str){ System.out.println(str); } |
|
1 2 3 4 5 6 7 8 |
@Test public void testSample1() { // 準備：メソッドの無効化 addReturnValue(UtilSample1.class, "sample1"); // 実行 UtilSample1.sample1("sample1メソッドが実行されました"); } |
djUnitでメソッドの返却値を好みのものに変更する場合は「addReturnValue」メソッドを使用しますが、
同一メソッドを複数回使用していてそれぞれ別々の戻り値に変更したい場合には「setReturnValueAt」メソッドを使用します。
|
1 2 3 4 5 6 7 8 9 10 11 |
public class UtilClass1{ /** * <p>[概 要] サンプルメソッド</p> * <p>[詳 細] </p> * <p>[備 考] </p> * @return 文字列 */ public static String getStr(){ return "hoge"; } } |
|
1 2 3 4 5 6 7 8 9 10 11 |
public class DriverClass1{ /** * <p>[概 要] ドライバーメソッド</p> * <p>[詳 細] </p> * <p>[備 考] </p> */ public static void driverMethod1(){ System.out.println(UtilClass1.getStr()); System.out.println(UtilClass1.getStr()); } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
import jp.co.dgic.testing.framework.DJUnitTestCase; import org.junit.Test; public class UtilClassDjUnitTest extends DJUnitTestCase { @Test public void testGetStr2() { // 準備：getStrメソッドの返却値を1回目と2回目で別々の戻り値に変更します。 String expected1 = "test1"; String expected2 = "test2"; setReturnValueAt(UtilClass1.class, "getStr", 0, expected1); setReturnValueAt(UtilClass1.class, "getStr", 1, expected2); // 実行 DriverClass1.driverMethod1(); } } |
|
1 2 |
test1 test2 |
djUnitを使用する上での最大の利点と言っても良いのがVirtual Mock Objects（仮想モックオブジェクト）が使用出来る事です。
このVirtual Mock Objectsを使用すると作成したクラスでUtilクラスなどのメソッドを使用している場合、使用しているメソッドの戻り値を自由に変更する事が可能となります。
djUnitでメソッドの返却値を好みのものに変更する場合は「addReturnValue」メソッドを使用します。
「addReturnValue」メソッドの使用タイミングとしては、作成したクラスで使用している共通クラスのメソッドなどが未完成の場合でスタブが必要になるケースなどが考えられます。
|
1 2 3 4 5 6 7 8 9 10 11 |
public class UtilClass1{ /** * <p>[概 要] サンプルメソッド</p> * <p>[詳 細] </p> * <p>[備 考] </p> * @return 文字列 */ public static String getStr(){ return "hoge"; } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
import jp.co.dgic.testing.framework.DJUnitTestCase; import org.junit.Test; public class UtilClassDjUnitTest extends DJUnitTestCase { @Test public void testGetStr() { // 準備：getStrメソッドの返却値を好みのものに変更します。 String expected = "test"; addReturnValue(UtilClass1.class, "getStr", expected); // 実行 String result = UtilClass1.getStr(); // 検証 assertEquals("文字列が一致していません。", expected, result); } } |
javaではUtilクラスなどのコンストラクタは無駄なインスタンス化を抑制するためにコンストラクタの修飾子をprivateにする事がよくあります。ただdjUnitで試験する場合にはコンストラクタを呼び出したくても修飾子がprivateになっていてはインスタンス化が出来ずに呼び出せないのでカバレッジを100%に出来ません。そういう場合にプライベートコンストラクタをテストする方法についてメモしておきます。
|
1 2 3 4 5 6 7 8 9 10 11 |
public class UtilSample1{ /** * <p>[概 要] コンストラクタ</p> * <p>[詳 細] </p> * <p>[備 考] </p> */ private UtilSample1() { // 処理なし } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
import static org.hamcrest.CoreMatchers.*; import static org.junit.Assert.*; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; import org.junit.Test; public class UtilSample1Test { @Test public void testConstructor() { try { // 準備 Class<?> utilSample1 = Class.forName("UtilSample1"); Constructor<?>[] constructor = utilSample1.getDeclaredConstructors(); constructor[0].setAccessible(true); // 実行 Object object = constructor[0].newInstance(); // 検証 assertNotNull("オブジェクトがありません。",object); assertThat(object, instanceOf(UtilSample1.class)); } catch (ClassNotFoundException e) { // 指定されたクラスが存在しない場合 fail(e.getMessage()); } catch (IllegalArgumentException e) { // 不正な引数、または不適切な引数をメソッドに渡した場合 fail(e.getMessage()); } catch (InstantiationException e) { // インスタンスを生成できない場合 fail(e.getMessage()); } catch (IllegalAccessException e) { // 配列以外のインスタンス作成、フィールドの設定または取得、メソッドの呼び出しを試みた場合 fail(e.getMessage()); } catch (InvocationTargetException e) { // 呼び出されるメソッドまたはコンストラクタがスローする例外をラップする、チェック済み例外 fail(e.getMessage()); } } } |
