BATCH-2397: fix parameters handling in MethodInvokingTaskletAdapter
When a tasklet is declared with xml using the shortcut version, the MethodInvokingTaskletAdapter that is created automatically does not address passing parameters expected by Tasklet#execute (which is incorrect since the documentation of the schema attribute "method" says the bean should define a method with the same signature). This commit fixes parameters passing when using the shortcut version. Resolves BATCH-2397
This commit is contained in:
Mahmoud Ben Hassine
committed by
Michael Minella
Michael Minella
parent
0d9f4ce6f1
commit
79f3a67883
@@ -0,0 +1,258 @@
|
||||
/*
|
||||
* Copyright 2006-2018 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springframework.batch.core.step.tasklet;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.springframework.batch.core.ExitStatus;
|
||||
import org.springframework.batch.core.StepContribution;
|
||||
import org.springframework.batch.core.StepExecution;
|
||||
import org.springframework.batch.core.scope.context.ChunkContext;
|
||||
import org.springframework.batch.repeat.RepeatStatus;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* @author Mahmoud Ben Hassine
|
||||
*/
|
||||
public class MethodInvokingTaskletAdapterTest {
|
||||
|
||||
private StepContribution stepContribution;
|
||||
private ChunkContext chunkContext;
|
||||
private TestTasklet tasklet;
|
||||
private MethodInvokingTaskletAdapter adapter;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
stepContribution = new StepContribution(mock(StepExecution.class));
|
||||
chunkContext = mock(ChunkContext.class);
|
||||
tasklet = new TestTasklet();
|
||||
adapter = new MethodInvokingTaskletAdapter();
|
||||
adapter.setTargetObject(tasklet);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testExactlySameSignature() throws Exception {
|
||||
adapter.setTargetMethod("execute");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getStepContribution(), stepContribution);
|
||||
assertEquals(tasklet.getChunkContext(), chunkContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSameSignatureWithDifferentMethodName() throws Exception {
|
||||
adapter.setTargetMethod("execute1");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getStepContribution(), stepContribution);
|
||||
assertEquals(tasklet.getChunkContext(), chunkContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDifferentParametersOrder() throws Exception {
|
||||
adapter.setTargetMethod("execute2");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getStepContribution(), stepContribution);
|
||||
assertEquals(tasklet.getChunkContext(), chunkContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testArgumentSubsetWithOnlyChunkContext() throws Exception {
|
||||
adapter.setTargetMethod("execute3");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getChunkContext(), chunkContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testArgumentSubsetWithOnlyStepContribution() throws Exception {
|
||||
adapter.setTargetMethod("execute4");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getStepContribution(), stepContribution);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testArgumentSubsetWithoutArguments() throws Exception {
|
||||
adapter.setTargetMethod("execute5");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCompatibleReturnTypeWhenBoolean() throws Exception {
|
||||
adapter.setTargetMethod("execute6");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCompatibleReturnTypeWhenVoid() throws Exception {
|
||||
adapter.setTargetMethod("execute7");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testArgumentSubsetWithOnlyStepContributionAndCompatibleReturnTypeBoolean() throws Exception {
|
||||
adapter.setTargetMethod("execute8");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getStepContribution(), stepContribution);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testArgumentSubsetWithOnlyChunkContextAndCompatibleReturnTypeVoid() throws Exception {
|
||||
adapter.setTargetMethod("execute9");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(tasklet.getChunkContext(), chunkContext);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testIncorrectSignatureWithExtraParameter() throws Exception {
|
||||
adapter.setTargetMethod("execute10");
|
||||
adapter.execute(stepContribution, chunkContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testExitStatusReturnType() throws Exception {
|
||||
adapter.setTargetMethod("execute11");
|
||||
adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(new ExitStatus("DONE"), stepContribution.getExitStatus());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testNonExitStatusReturnType() throws Exception {
|
||||
adapter.setTargetMethod("execute12");
|
||||
RepeatStatus repeatStatus = adapter.execute(stepContribution, chunkContext);
|
||||
assertEquals(RepeatStatus.FINISHED, repeatStatus);
|
||||
assertEquals(ExitStatus.COMPLETED, stepContribution.getExitStatus());
|
||||
}
|
||||
|
||||
/*
|
||||
<xsd:attribute name="method" type="xsd:string" use="optional">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
If the tasklet is specified as a bean definition, then a method can be
|
||||
specified and a POJO will be adapted to the Tasklet interface.
|
||||
The method suggested should have the same arguments as Tasklet.execute
|
||||
(or a subset), and have a compatible return type (boolean, void or RepeatStatus).
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
*/
|
||||
public static class TestTasklet {
|
||||
|
||||
private StepContribution stepContribution;
|
||||
private ChunkContext chunkContext;
|
||||
|
||||
/* exactly same signature */
|
||||
public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* same signature, different method name */
|
||||
public RepeatStatus execute1(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* different parameters order */
|
||||
public RepeatStatus execute2(ChunkContext chunkContext, StepContribution stepContribution) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* subset of arguments: only chunk context */
|
||||
public RepeatStatus execute3(ChunkContext chunkContext) throws Exception {
|
||||
this.chunkContext = chunkContext;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* subset of arguments: only step contribution */
|
||||
public RepeatStatus execute4(StepContribution stepContribution) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* subset of arguments: no arguments */
|
||||
public RepeatStatus execute5() throws Exception {
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* compatible return type: boolean */
|
||||
public boolean execute6(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return true;
|
||||
}
|
||||
|
||||
/* compatible return type: void */
|
||||
public void execute7(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
}
|
||||
|
||||
/* subset of arguments (only step contribution) and compatible return type (boolean) */
|
||||
public boolean execute8(StepContribution stepContribution) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
return true;
|
||||
}
|
||||
|
||||
/* subset of arguments (only chunk context) and compatible return type (void) */
|
||||
public void execute9(ChunkContext chunkContext) throws Exception {
|
||||
this.chunkContext = chunkContext;
|
||||
}
|
||||
|
||||
/* Incorrect signature: extra parameter (ie a superset not a subset as specified) */
|
||||
public RepeatStatus execute10(StepContribution stepContribution, ChunkContext chunkContext, String string) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return RepeatStatus.FINISHED;
|
||||
}
|
||||
|
||||
/* ExitStatus return type : should be returned as is */
|
||||
public ExitStatus execute11(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return new ExitStatus("DONE");
|
||||
}
|
||||
|
||||
/* Non ExitStatus return type : should return ExitStatus.COMPLETED */
|
||||
public String execute12(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
|
||||
this.stepContribution = stepContribution;
|
||||
this.chunkContext = chunkContext;
|
||||
return "DONE";
|
||||
}
|
||||
|
||||
public StepContribution getStepContribution() {
|
||||
return stepContribution;
|
||||
}
|
||||
|
||||
public ChunkContext getChunkContext() {
|
||||
return chunkContext;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user