OPEN - issue BATCH-1130: Ensure Ordered is respected by generated listeners
Fixed for Step listeners
This commit is contained in:
dsyer
@@ -30,6 +30,7 @@ import java.util.Map;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.springframework.aop.framework.ProxyFactory;
|
||||
import org.springframework.batch.core.ChunkListener;
|
||||
import org.springframework.batch.core.ExitStatus;
|
||||
import org.springframework.batch.core.ItemProcessListener;
|
||||
@@ -53,54 +54,60 @@ import org.springframework.batch.core.annotation.OnProcessError;
|
||||
import org.springframework.batch.core.annotation.OnReadError;
|
||||
import org.springframework.batch.core.annotation.OnWriteError;
|
||||
import org.springframework.batch.core.configuration.xml.AbstractTestComponent;
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* @author Lucas Ward
|
||||
*
|
||||
*
|
||||
*/
|
||||
public class StepListenerFactoryBeanTests {
|
||||
|
||||
private StepListenerFactoryBean factoryBean;
|
||||
|
||||
private TestListener testListener;
|
||||
private JobExecution jobExecution = new JobExecution(11L);
|
||||
|
||||
private JobExecution jobExecution = new JobExecution(11L);
|
||||
|
||||
private StepExecution stepExecution = new StepExecution("testStep", jobExecution);
|
||||
|
||||
|
||||
@Before
|
||||
public void setUp(){
|
||||
public void setUp() {
|
||||
factoryBean = new StepListenerFactoryBean();
|
||||
testListener = new TestListener();
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
public void testStepAndChunk() throws Exception{
|
||||
|
||||
public void testStepAndChunk() throws Exception {
|
||||
|
||||
factoryBean.setDelegate(testListener);
|
||||
Map<String, String> metaDataMap = new HashMap<String, String>();;
|
||||
Map<String, String> metaDataMap = new HashMap<String, String>();
|
||||
;
|
||||
metaDataMap.put(AFTER_STEP.getPropertyName(), "destroy");
|
||||
metaDataMap.put(AFTER_CHUNK.getPropertyName(), "afterChunk");
|
||||
factoryBean.setMetaDataMap(metaDataMap);
|
||||
Object item = new Object();
|
||||
List<Object> items = new ArrayList<Object>();
|
||||
items.add(item);
|
||||
StepListener listener = (StepListener) factoryBean.getObject();
|
||||
((StepExecutionListener)listener).beforeStep(stepExecution);
|
||||
((StepExecutionListener)listener).afterStep(stepExecution);
|
||||
((ChunkListener)listener).beforeChunk();
|
||||
((ChunkListener)listener).afterChunk();
|
||||
((ItemReadListener<Object>)listener).beforeRead();
|
||||
((ItemReadListener<Object>)listener).afterRead(item);
|
||||
((ItemReadListener)listener).onReadError(new Exception());
|
||||
((ItemProcessListener<Object, Object>)listener).beforeProcess(item);
|
||||
((ItemProcessListener<Object, Object>)listener).afterProcess(item, item);
|
||||
((ItemProcessListener<Object, Object>)listener).onProcessError(item, new Exception());
|
||||
((ItemWriteListener<Object>)listener).beforeWrite(items);
|
||||
((ItemWriteListener<Object>)listener).afterWrite(items);
|
||||
((ItemWriteListener<Object>)listener).onWriteError(new Exception(), items);
|
||||
((SkipListener<Object, Object>)listener).onSkipInRead(new Throwable());
|
||||
((SkipListener<Object, Object>)listener).onSkipInProcess(item, new Throwable());
|
||||
((SkipListener<Object, Object>)listener).onSkipInWrite(item, new Throwable());
|
||||
StepListener listener = (StepListener) factoryBean.getObject();
|
||||
((StepExecutionListener) listener).beforeStep(stepExecution);
|
||||
((StepExecutionListener) listener).afterStep(stepExecution);
|
||||
((ChunkListener) listener).beforeChunk();
|
||||
((ChunkListener) listener).afterChunk();
|
||||
((ItemReadListener<Object>) listener).beforeRead();
|
||||
((ItemReadListener<Object>) listener).afterRead(item);
|
||||
((ItemReadListener) listener).onReadError(new Exception());
|
||||
((ItemProcessListener<Object, Object>) listener).beforeProcess(item);
|
||||
((ItemProcessListener<Object, Object>) listener).afterProcess(item, item);
|
||||
((ItemProcessListener<Object, Object>) listener).onProcessError(item, new Exception());
|
||||
((ItemWriteListener<Object>) listener).beforeWrite(items);
|
||||
((ItemWriteListener<Object>) listener).afterWrite(items);
|
||||
((ItemWriteListener<Object>) listener).onWriteError(new Exception(), items);
|
||||
((SkipListener<Object, Object>) listener).onSkipInRead(new Throwable());
|
||||
((SkipListener<Object, Object>) listener).onSkipInProcess(item, new Throwable());
|
||||
((SkipListener<Object, Object>) listener).onSkipInWrite(item, new Throwable());
|
||||
assertTrue(testListener.beforeStepCalled);
|
||||
assertTrue(testListener.beforeChunkCalled);
|
||||
assertTrue(testListener.afterChunkCalled);
|
||||
@@ -117,58 +124,104 @@ public class StepListenerFactoryBeanTests {
|
||||
assertTrue(testListener.onSkipInProcessCalled);
|
||||
assertTrue(testListener.onSkipInWriteCalled);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testAllThreeTypes() throws Exception{
|
||||
//Test to make sure if someone has annotated a method, implemented the interface, and given a string
|
||||
//method name, that all three will be called
|
||||
public void testAllThreeTypes() throws Exception {
|
||||
// Test to make sure if someone has annotated a method, implemented the
|
||||
// interface, and given a string
|
||||
// method name, that all three will be called
|
||||
ThreeStepExecutionListener delegate = new ThreeStepExecutionListener();
|
||||
factoryBean.setDelegate(delegate);
|
||||
Map<String, String> metaDataMap = new HashMap<String, String>();;
|
||||
Map<String, String> metaDataMap = new HashMap<String, String>();
|
||||
;
|
||||
metaDataMap.put(AFTER_STEP.getPropertyName(), "destroy");
|
||||
factoryBean.setMetaDataMap(metaDataMap);
|
||||
StepListener listener = (StepListener) factoryBean.getObject();
|
||||
((StepExecutionListener)listener).afterStep(stepExecution);
|
||||
((StepExecutionListener) listener).afterStep(stepExecution);
|
||||
assertEquals(3, delegate.callcount);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testAnnotatingInterfaceResultsInOneCall() throws Exception{
|
||||
public void testAnnotatingInterfaceResultsInOneCall() throws Exception {
|
||||
MultipleAfterStep delegate = new MultipleAfterStep();
|
||||
factoryBean.setDelegate(delegate);
|
||||
Map<String, String> metaDataMap = new HashMap<String, String>();
|
||||
metaDataMap.put(AFTER_STEP.getPropertyName(), "afterStep");
|
||||
factoryBean.setMetaDataMap(metaDataMap);
|
||||
StepListener listener = (StepListener) factoryBean.getObject();
|
||||
((StepExecutionListener)listener).afterStep(stepExecution);
|
||||
((StepExecutionListener) listener).afterStep(stepExecution);
|
||||
assertEquals(1, delegate.callcount);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testVanillaInterface() throws Exception{
|
||||
public void testVanillaInterface() throws Exception {
|
||||
MultipleAfterStep delegate = new MultipleAfterStep();
|
||||
factoryBean.setDelegate(delegate);
|
||||
Object listener = factoryBean.getObject();
|
||||
assertTrue(listener instanceof StepExecutionListener);
|
||||
((StepExecutionListener)listener).beforeStep(stepExecution);
|
||||
((StepExecutionListener) listener).beforeStep(stepExecution);
|
||||
assertEquals(1, delegate.callcount);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testFactoryMethod() throws Exception{
|
||||
public void testVanillaInterfaceWithProxy() throws Exception {
|
||||
MultipleAfterStep delegate = new MultipleAfterStep();
|
||||
ProxyFactory factory = new ProxyFactory(delegate);
|
||||
factoryBean.setDelegate(factory.getProxy());
|
||||
Object listener = factoryBean.getObject();
|
||||
assertTrue(listener instanceof StepExecutionListener);
|
||||
((StepExecutionListener) listener).beforeStep(stepExecution);
|
||||
assertEquals(1, delegate.callcount);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFactoryMethod() throws Exception {
|
||||
MultipleAfterStep delegate = new MultipleAfterStep();
|
||||
Object listener = StepListenerFactoryBean.getListener(delegate);
|
||||
assertTrue(listener instanceof StepExecutionListener);
|
||||
assertFalse(listener instanceof ChunkListener);
|
||||
((StepExecutionListener)listener).beforeStep(stepExecution);
|
||||
((StepExecutionListener) listener).beforeStep(stepExecution);
|
||||
assertEquals(1, delegate.callcount);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testAnnotationsWithOrdered() throws Exception {
|
||||
Object delegate = new Ordered() {
|
||||
@SuppressWarnings("unused")
|
||||
@BeforeStep
|
||||
public void foo(StepExecution execution) {
|
||||
}
|
||||
|
||||
public int getOrder() {
|
||||
return 3;
|
||||
}
|
||||
};
|
||||
StepListener listener = StepListenerFactoryBean.getListener(delegate);
|
||||
assertTrue("Listener is not of correct type", listener instanceof Ordered);
|
||||
assertEquals(3, ((Ordered) listener).getOrder());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testProxiedAnnotationsFactoryMethod() throws Exception {
|
||||
Object delegate = new InitializingBean() {
|
||||
@SuppressWarnings("unused")
|
||||
@BeforeStep
|
||||
public void foo(StepExecution execution) {
|
||||
}
|
||||
|
||||
public void afterPropertiesSet() throws Exception {
|
||||
}
|
||||
};
|
||||
ProxyFactory factory = new ProxyFactory(delegate);
|
||||
assertTrue("Listener is not of correct type",
|
||||
StepListenerFactoryBean.getListener(factory.getProxy()) instanceof StepExecutionListener);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testInterfaceIsListener() throws Exception {
|
||||
assertTrue(StepListenerFactoryBean.isListener(new ThreeStepExecutionListener()));
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testAnnotationsIsListener() throws Exception {
|
||||
assertTrue(StepListenerFactoryBean.isListener(new Object() {
|
||||
@@ -178,20 +231,35 @@ public class StepListenerFactoryBeanTests {
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testProxiedAnnotationsIsListener() throws Exception {
|
||||
Object delegate = new InitializingBean() {
|
||||
@SuppressWarnings("unused")
|
||||
@BeforeStep
|
||||
public void foo(StepExecution execution) {
|
||||
}
|
||||
|
||||
public void afterPropertiesSet() throws Exception {
|
||||
}
|
||||
};
|
||||
ProxyFactory factory = new ProxyFactory(delegate);
|
||||
assertTrue(StepListenerFactoryBean.isListener(factory.getProxy()));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testMixedIsListener() throws Exception {
|
||||
assertTrue(StepListenerFactoryBean.isListener(new MultipleAfterStep()));
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testNonListener() throws Exception{
|
||||
public void testNonListener() throws Exception {
|
||||
Object delegate = new Object();
|
||||
factoryBean.setDelegate(delegate);
|
||||
StepListener listener = (StepListener) factoryBean.getObject();
|
||||
assertTrue(listener instanceof StepListener);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testEmptySignatureAnnotation() {
|
||||
AbstractTestComponent delegate = new AbstractTestComponent() {
|
||||
@@ -298,7 +366,7 @@ public class StepListenerFactoryBeanTests {
|
||||
private class MultipleAfterStep implements StepExecutionListener {
|
||||
|
||||
int callcount = 0;
|
||||
|
||||
|
||||
@AfterStep
|
||||
public ExitStatus afterStep(StepExecution stepExecution) {
|
||||
Assert.notNull(stepExecution);
|
||||
@@ -309,118 +377,132 @@ public class StepListenerFactoryBeanTests {
|
||||
public void beforeStep(StepExecution stepExecution) {
|
||||
callcount++;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
private class ThreeStepExecutionListener implements StepExecutionListener{
|
||||
|
||||
private class ThreeStepExecutionListener implements StepExecutionListener {
|
||||
|
||||
int callcount = 0;
|
||||
|
||||
|
||||
public ExitStatus afterStep(StepExecution stepExecution) {
|
||||
Assert.notNull(stepExecution);
|
||||
callcount++;
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
public void beforeStep(StepExecution stepExecution) {
|
||||
callcount++;
|
||||
}
|
||||
|
||||
public void destroy(){
|
||||
|
||||
public void destroy() {
|
||||
callcount++;
|
||||
}
|
||||
|
||||
|
||||
@AfterStep
|
||||
public void after(){
|
||||
public void after() {
|
||||
callcount++;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private class TestListener implements SkipListener<Object, Object>{
|
||||
|
||||
private class TestListener implements SkipListener<Object, Object> {
|
||||
|
||||
boolean beforeStepCalled = false;
|
||||
|
||||
boolean afterStepCalled = false;
|
||||
|
||||
boolean beforeChunkCalled = false;
|
||||
|
||||
boolean afterChunkCalled = false;
|
||||
|
||||
boolean beforeReadCalled = false;
|
||||
|
||||
boolean afterReadCalled = false;
|
||||
|
||||
boolean onReadErrorCalled = false;
|
||||
|
||||
boolean beforeProcessCalled = false;
|
||||
|
||||
boolean afterProcessCalled = false;
|
||||
|
||||
boolean onProcessErrorCalled = false;
|
||||
|
||||
boolean beforeWriteCalled = false;
|
||||
|
||||
boolean afterWriteCalled = false;
|
||||
|
||||
boolean onWriteErrorCalled = false;
|
||||
|
||||
boolean onSkipInReadCalled = false;
|
||||
|
||||
boolean onSkipInProcessCalled = false;
|
||||
|
||||
boolean onSkipInWriteCalled = false;
|
||||
|
||||
|
||||
@BeforeStep
|
||||
public void initStep(){
|
||||
public void initStep() {
|
||||
beforeStepCalled = true;
|
||||
}
|
||||
|
||||
public void destroy(){
|
||||
|
||||
public void destroy() {
|
||||
afterStepCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@BeforeChunk
|
||||
public void before(){
|
||||
public void before() {
|
||||
beforeChunkCalled = true;
|
||||
}
|
||||
|
||||
public void afterChunk(){
|
||||
|
||||
public void afterChunk() {
|
||||
afterChunkCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@BeforeRead
|
||||
public void beforeReadMethod(){
|
||||
public void beforeReadMethod() {
|
||||
beforeReadCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@AfterRead
|
||||
public void afterReadMethod(Object item){
|
||||
public void afterReadMethod(Object item) {
|
||||
Assert.notNull(item);
|
||||
afterReadCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@OnReadError
|
||||
public void onErrorInRead(){
|
||||
public void onErrorInRead() {
|
||||
onReadErrorCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@BeforeProcess
|
||||
public void beforeProcess(){
|
||||
public void beforeProcess() {
|
||||
beforeProcessCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@AfterProcess
|
||||
public void afterProcess(){
|
||||
public void afterProcess() {
|
||||
afterProcessCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@OnProcessError
|
||||
public void processError(){
|
||||
public void processError() {
|
||||
onProcessErrorCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@BeforeWrite
|
||||
public void beforeWrite(){
|
||||
public void beforeWrite() {
|
||||
beforeWriteCalled = true;
|
||||
}
|
||||
|
||||
|
||||
@AfterWrite
|
||||
public void afterWrite(){
|
||||
public void afterWrite() {
|
||||
afterWriteCalled = true;
|
||||
}
|
||||
|
||||
@OnWriteError
|
||||
public void writeError(){
|
||||
public void writeError() {
|
||||
onWriteErrorCalled = true;
|
||||
}
|
||||
|
||||
|
||||
public void onSkipInProcess(Object item, Throwable t) {
|
||||
onSkipInProcessCalled = true;
|
||||
}
|
||||
@@ -432,6 +514,6 @@ public class StepListenerFactoryBeanTests {
|
||||
public void onSkipInWrite(Object item, Throwable t) {
|
||||
onSkipInWriteCalled = true;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user