Junit＋PowerMockでPrivateメソッドをモック化したい

Question

前提・実現したいこと

どなたか、解決策をご教示いただけますでしょうか。

Javaにて、JUnit＋PowerMockでテストを行っております。

privateメソッド（下ソース：SampleProp#getPropValue）をMock化しようとしたところ、
SamplePropTest#test001 メソッドの
.　PowerMockito.when(mock, "getPropValue", anyObject(), eq("AAA")).thenReturn("AAAValue");
の場所で、以下のエラーが発生してしまいました。

もう1つ引数なしのメソッド「duplicateCheck」をモック化しているのですが、
こちらはwhenの時点でメソッド内に入らないのですが、
「getPropValue」は when～の時点でメソッド内に入ってしまいます。

引数の書き方に問題があるのでしょうか？

お手数をおかけいたしますが、よろしくお願いいたします。

.

発生している問題・エラーメッセージ

java.lang.NullPointerException
	at sample.SampleProp.getPropValue(SampleProp.java:45)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:606)
	at sample.SamplePropTest.test001(SamplePropTest.java:44)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:606)
	at org.junit.internal.runners.TestMethod.invoke(TestMethod.java:68)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.runTestMethod(PowerMockJUnit44RunnerDelegateImpl.java:316)
	at org.junit.internal.runners.MethodRoadie$2.run(MethodRoadie.java:89)
	at org.junit.internal.runners.MethodRoadie.runBeforesThenTestThenAfters(MethodRoadie.java:97)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.executeTest(PowerMockJUnit44RunnerDelegateImpl.java:300)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.executeTestInSuper(PowerMockJUnit47RunnerDelegateImpl.java:131)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.access$100(PowerMockJUnit47RunnerDelegateImpl.java:59)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner$TestExecutorStatement.evaluate(PowerMockJUnit47RunnerDelegateImpl.java:147)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.evaluateStatement(PowerMockJUnit47RunnerDelegateImpl.java:107)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit47RunnerDelegateImpl$PowerMockJUnit47MethodRunner.executeTest(PowerMockJUnit47RunnerDelegateImpl.java:82)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$PowerMockJUnit44MethodRunner.runBeforesThenTestThenAfters(PowerMockJUnit44RunnerDelegateImpl.java:288)
	at org.junit.internal.runners.MethodRoadie.runTest(MethodRoadie.java:87)
	at org.junit.internal.runners.MethodRoadie.run(MethodRoadie.java:50)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.invokeTestMethod(PowerMockJUnit44RunnerDelegateImpl.java:208)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.runMethods(PowerMockJUnit44RunnerDelegateImpl.java:147)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl$1.run(PowerMockJUnit44RunnerDelegateImpl.java:121)
	at org.junit.internal.runners.ClassRoadie.runUnprotected(ClassRoadie.java:34)
	at org.junit.internal.runners.ClassRoadie.runProtected(ClassRoadie.java:44)
	at org.powermock.modules.junit4.internal.impl.PowerMockJUnit44RunnerDelegateImpl.run(PowerMockJUnit44RunnerDelegateImpl.java:123)
	at org.powermock.modules.junit4.common.internal.impl.JUnit4TestSuiteChunkerImpl.run(JUnit4TestSuiteChunkerImpl.java:121)
	at org.powermock.modules.junit4.common.internal.impl.AbstractCommonPowerMockRunner.run(AbstractCommonPowerMockRunner.java:53)
	at org.powermock.modules.junit4.PowerMockRunner.run(PowerMockRunner.java:59)
	at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:86)
	at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:459)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:678)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:382)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:192)

該当のソースコード

package sample;

import java.io.FileInputStream;
import java.util.Properties;

/**
 * テスト対象クラス.
 *
 * @author miyako
 */
public class SampleProp {

	private static SampleProp __instance = new SampleProp();

	private SampleProp(){
	}

	public static synchronized SampleProp getInstance() {
		return __instance;
	}

	public synchronized void load()	throws Exception {

		Properties prop = new Properties();
		FileInputStream fis = null;

		try {
			this.duplicateCheck();

			fis = new FileInputStream("aaa.properties");
			prop.load(fis);

			String item = this.getPropValue(prop, "myid");

		}
		finally {
			if (fis != null) {
				try {
					fis.close();
				} catch (Exception e) {}
			}
		}
	}

	private String getPropValue(Properties prop, String key)
	throws Exception {

		String ret = prop.getProperty(key);
		if (ret == null) {
			ret = "Not Key.";
		}
		if (ret.isEmpty()) {
			ret = "Not Value.";
		}

		return ret;
	}

	private void duplicateCheck() {
		// 重複チェック処理
	}
}

package sample;

import static org.mockito.Matchers.*;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;

import junit.framework.TestCase;

/**
 * テストクラス.
 *
 * @author miyako
 */
@RunWith(PowerMockRunner.class)
@PrepareForTest({SampleProp.class})
public class SamplePropTest extends TestCase{

	public SamplePropTest(String name) {
		super();
	}

    @Before
    public void setUp() throws Exception {

    }

    @After
    public void tearDown() throws Exception {

    }

    @Test
    public void test001() throws Exception{

    	SampleProp mock = PowerMockito.spy(SampleProp.getInstance());
    	PowerMockito.doNothing().when(mock, "duplicateCheck");

    	PowerMockito.when(mock, "getPropValue", anyObject(), eq("AAA")).thenReturn("AAAValue");

    	try {
        	//==============================
        	// テスト実施
        	//------------------------------
    		mock.load();

        	//==============================
        	// 結果確認
        	//------------------------------

    	}
    	// 予期せぬ例外
    	catch(Throwable e) {
    		e.printStackTrace();
    		fail(e.getMessage());
    	}
    	// 後処理
    	finally {
    	}

    }

}

補足情報（FW/ツールのバージョンなど）

・JRE：1.7.80
・JUnit：4.12
・PowerMock：1.6.6
・Mockito：1.10.19
・Eclipse：4.7

Answer 1

privateメソッドを呼ぶのにはリフレクションで呼ぶ必要があります。

  @Test
  public void privateメソッドはPowerMockitoでモックできる() throws Exception {
    SampleProp　mockInstance= PowerMockito.mock(SampleProp.class);
    PowerMockito.when(mockInstance, "getPropValue", anyObject(), eq("AAA"))).thenReturn("AAAValue");

    // privateメソッドにアクセスするためにリフレクションを使う
    Method method = TestTargetClass.class.getDeclaredMethod("getPropValue");
    method.setAccessible(true);

    assertThat((String) method.invoke(mockInstance), is("AAAValue"));
  }

以前書いた記事がありますので、ご参考にどうぞ

• MockitoとPowerMockの使い分け

Comments

[miya1145]

euledge様

お世話になります。質問投稿者「miya1145」です。
ご回答の程、ありがとうございました！

ご紹介いただきました「MockitoとPowerMockの使い分け」の方の、
「publicメソッドから呼ばれるサブのprivateメソッドをモックする場合」
を実現したく思っております。

上記を参考に、以下のようなコードを書いてみたのですが、
「.withArguments(anyObject(), eq("AAA")).thenReturn("mockValue");」
のところで、実際の「getPropValue」の中に入りこんでしまい、NullPointerExceptionになってしまいました・・・。

お忙しいとは思いますが、アドバイスの程いただければ幸いです。

@Test
public void publicメソッドから呼ばれるサブのprivateメソッドはspyでモックできる() throws Exception {

SampleProp mockInstance = PowerMockito.spy(SampleProp.getInstance());
PowerMockito.when(
mockInstance,
MemberMatcher.method(SampleProp.class, "getPropValue", Properties.class, String.class))
.withArguments(anyObject(), eq("AAA")).thenReturn("mockValue");

mockInstance.load();

}

[euledge]

https://github.com/euledge/mockito-sample に記事のソースコードを上げてあるので一度お試しください。 必要なライブラリとか設定なども見比べることができるかと思います。

[miya1145]

euledge様

投稿が遅くなりまして、申し訳ございません。
お世話になります。質問投稿者「miya1145」です。
ご回答の程、ありがとうございました！

実ソースを以下に変更して（前提がおかしかったです申し訳ございません・・・）、
　　　String item = this.getPropValue(prop, "AAA");

テストソースを以下に変更することで、期待の結果が得られました。
SampleProp mockInstance = PowerMockito.spy(SampleProp.getInstance());
　　　　・・・
PowerMockito.doReturn("AAAValue").when(mockInstance, "getPropValue", anyObject(), eq("AAA"));

euledge様のサイト等で、さらに精進していきたいと思います。
また質問が出てくると思いますが、その際には何卒よろしくお願いいたします。
ありがとうございました。