@Scope(“step”)のテストでエラー（No context holder available for step scope）

目次

• 1. 事象
• 2. エラー内容
• 3. 原因
• 4. 解決策
• 5. 参考

事象

@Scope(“step”)アノテーションが付与されているクラスに対してJunitによるSpringJUnit4ClassRunnerテストを作成し実行したところエラーが発生

エラー内容

テスト対象実装クラス
SharedServiceImpl

@Service
@Scope("step")
public class SharedServiceImpl implements SharedService {

    /**
     * Long型の数値をカンマ編集して返す
     * @param value 編集前数値
     * @return カンマ編集後文字列
     */
    @Override
    public String longToConma(long value) {

        NumberFormat conmaFormat = NumberFormat.getNumberInstance();

        return conmaFormat.format(value);
    }
}

テストクラス

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "classpath:META-INF/spring/shareService.xml" })
public class SharedService_longToconmaTest {

    @Inject
    SharedService target;

    /**
     * テスト本体
     */
    @Test
    public void test() {

        long testNum = 9999999999L;

        String actual = target.longToConma(testNum);

        assertThat(actual, is("9,999,999,999"));
    }

}

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'scopedTarget.sharedServiceImpl': Scope 'step' is not active for the current thread; consider defining a scoped proxy for this bean if you intend to refer to it from a singleton; nested exception is java.lang.IllegalStateException: No context holder available for step scope
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:355)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:197)
	at org.springframework.aop.target.SimpleBeanTargetSource.getTarget(SimpleBeanTargetSource.java:35)
	at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:192)
	at com.sun.proxy.$Proxy16.longToConma(Unknown Source)
	at itouoti.spring.batch.service.sharedService.SharedService_longToconmaTest.test(SharedService_longToconmaTest.java:29)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.springframework.test.context.junit4.statements.RunBeforeTestMethodCallbacks.evaluate(RunBeforeTestMethodCallbacks.java:75)
	at org.springframework.test.context.junit4.statements.RunAfterTestMethodCallbacks.evaluate(RunAfterTestMethodCallbacks.java:86)
	at org.springframework.test.context.junit4.statements.SpringRepeat.evaluate(SpringRepeat.java:84)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
	at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:252)
	at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:94)
	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at org.springframework.test.context.junit4.statements.RunBeforeTestClassCallbacks.evaluate(RunBeforeTestClassCallbacks.java:61)
	at org.springframework.test.context.junit4.statements.RunAfterTestClassCallbacks.evaluate(RunAfterTestClassCallbacks.java:70)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
	at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.run(SpringJUnit4ClassRunner.java:191)
	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)
Caused by: java.lang.IllegalStateException: No context holder available for step scope
	at org.springframework.batch.core.scope.StepScope.getContext(StepScope.java:167)
	at org.springframework.batch.core.scope.StepScope.get(StepScope.java:99)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:340)
	... 34 more

原因

@Scope(“step”)アノテーションが付与されているクラスに対してDI機能を利用したテストクラスを作成したため。

解決策

@TestExecutionListenersアノテーションで以下のクラスを設定することでエラーを回避できる。
・DependencyInjectionTestExecutionListener
・StepScopeTestExecutionListener

テストクラス

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "classpath:META-INF/spring/shareService.xml" })
@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class,
    StepScopeTestExecutionListener.class})
public class SharedService_longToconmaTest {

    @Inject
    SharedService target;

    /**
     * テスト本体
     */
    @Test
    public void test() {

        long testNum = 9999999999L;

        String actual = target.longToConma(testNum);

        assertThat(actual, is("9,999,999,999"));
    }

}

参考

JdbcCursorItemReader test fails on step scope
Spring batch scope issue while using spring boot