Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

RESOLVED - issue BATCH-1411: Allow a Job to specify its required JobParameters

Browse Source
This commit is contained in:
dsyer
2009-11-11 20:49:31 +00:00
parent 74a992965b
commit 0dba72d2a6
19 changed files with 591 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/JobParserTests.java
View File

@@ -20,6 +20,7 @@ import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.junit.BeforeClass;
@@ -28,6 +29,7 @@ import org.springframework.aop.framework.Advised;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecutionListener;
import org.springframework.batch.core.job.AbstractJob;
import org.springframework.batch.core.job.DefaultJobParametersValidator;
import org.springframework.batch.core.listener.JobExecutionListenerSupport;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.repository.support.SimpleJobRepository;
@@ -182,6 +184,18 @@ public class JobParserTests {
}
}
@Test
public void testParametersValidator() {
ApplicationContext ctx = jobParserParentAttributeTestsCtx;
Job job = (Job) ctx.getBean("jobWithParametersValidator");
assertTrue(job instanceof AbstractJob);
Object validator = ReflectionTestUtils.getField(job, "jobParametersValidator");
assertTrue(validator instanceof DefaultJobParametersValidator);
@SuppressWarnings("unchecked")
Collection<String> keys = (Collection<String>) ReflectionTestUtils.getField(validator, "requiredKeys");
assertEquals(2, keys.size());
}
@Test
public void testListenerClearingJob() throws Exception {
assertEquals(0, getListeners("listenerClearingJob", jobParserParentAttributeTestsCtx).size());

43
spring-batch-core/src/test/java/org/springframework/batch/core/job/DefaultJobParametersValidatorTests.java Normal file
View File

@@ -0,0 +1,43 @@
package org.springframework.batch.core.job;
import org.junit.Test;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersBuilder;
import org.springframework.batch.core.JobParametersInvalidException;
public class DefaultJobParametersValidatorTests {
private DefaultJobParametersValidator validator = new DefaultJobParametersValidator();
@Test(expected = JobParametersInvalidException.class)
public void testValidateNull() throws Exception {
validator.validate(null);
}
@Test
public void testValidateRequiredValues() throws Exception {
validator.setRequiredKeys(new String[] { "name", "value" });
validator
.validate(new JobParametersBuilder().addString("name", "foo").addLong("value", 111L).toJobParameters());
}
@Test(expected = JobParametersInvalidException.class)
public void testValidateRequiredValuesMissing() throws Exception {
validator.setRequiredKeys(new String[] { "name", "value" });
validator.validate(new JobParameters());
}
@Test
public void testValidateOptionalValues() throws Exception {
validator.setOptionalKeys(new String[] { "name", "value" });
validator.validate(new JobParameters());
}
@Test(expected = IllegalStateException.class)
public void testOptionalValuesAlsoRequired() throws Exception {
validator.setOptionalKeys(new String[] { "name", "value" });
validator.setRequiredKeys(new String[] { "foo", "value" });
validator.afterPropertiesSet();
}
}

25
spring-batch-core/src/test/java/org/springframework/batch/core/job/AbstractJobTests.java → spring-batch-core/src/test/java/org/springframework/batch/core/job/ExtendedAbstractJobTests.java
View File

@@ -31,6 +31,7 @@ import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobExecutionException;
import org.springframework.batch.core.JobInterruptedException;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersInvalidException;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.repository.JobRepository;
@@ -42,7 +43,7 @@ import org.springframework.batch.support.transaction.ResourcelessTransactionMana
* @author Dave Syer
*
*/
public class AbstractJobTests {
public class ExtendedAbstractJobTests {
AbstractJob job = new StubJob("job");
@@ -109,6 +110,28 @@ public class AbstractJobTests {
assertTrue(e.getMessage().contains("JobRepository"));
}
}
@Test(expected=JobParametersInvalidException.class)
public void testValidatorWithNullParameters() throws Exception {
job.validate(null);
}
@Test
public void testValidatorWithNotNullParameters() throws Exception {
job.validate(new JobParameters());
// Should be free of side effects
}
@Test(expected=JobParametersInvalidException.class)
public void testSetValidator() throws Exception {
job.setJobParametersValidator(new DefaultJobParametersValidator() {
@Override
public void validate(JobParameters parameters) throws JobParametersInvalidException {
throw new JobParametersInvalidException("Expected");
}
});
job.validate(new JobParameters());
}
/**
* Runs the step and persists job execution context.

9
spring-batch-core/src/test/java/org/springframework/batch/core/job/JobSupport.java
View File

@@ -21,7 +21,9 @@ import java.util.List;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersIncrementer;
import org.springframework.batch.core.JobParametersInvalidException;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.UnexpectedJobExecutionException;
import org.springframework.beans.factory.BeanNameAware;
@@ -132,6 +134,13 @@ public class JobSupport implements BeanNameAware, Job {
public boolean isRestartable() {
return restartable;
}
/**
* @see Job#validate(JobParameters)
*/
public void validate(JobParameters parameters) throws JobParametersInvalidException {
}
/*
* (non-Javadoc)

6
spring-batch-core/src/test/java/org/springframework/batch/core/step/item/FaultTolerantExceptionClassesTests.java
View File

@@ -17,10 +17,7 @@ import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.job.SimpleJob;
import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException;
import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.repository.JobRestartException;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
@@ -308,8 +305,7 @@ public class FaultTolerantExceptionClassesTests implements ApplicationContextAwa
assertEquals("[1, 1, 1, 1]", tasklet.getCommitted().toString());
}
private StepExecution launchStep(String stepName) throws JobExecutionAlreadyRunningException, JobRestartException,
JobInstanceAlreadyCompleteException {
private StepExecution launchStep(String stepName) throws Exception {
SimpleJob job = new SimpleJob();
job.setName("job");
job.setJobRepository(jobRepository);

85
spring-batch-core/src/test/resources/org/springframework/batch/core/configuration/xml/JobParserParentAttributeTests-context.xml
View File

@@ -1,84 +1,117 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/batch" xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<beans:beans xmlns="http://www.springframework.org/schema/batch"
xmlns:beans="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/batch http://www.springframework.org/schema/batch/spring-batch-2.1.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<beans:import resource="common-context.xml" />
<job id="job1" parent="baseJob">
<step id="s1"><tasklet ref="dummyTasklet"/></step>
<step id="s1">
<tasklet ref="dummyTasklet" />
</step>
<listeners merge="true">
<listener>
<beans:bean class="org.springframework.batch.core.listener.JobExecutionListenerSupport"/>
<beans:bean
class="org.springframework.batch.core.listener.JobExecutionListenerSupport" />
</listener>
</listeners>
</job>
<job id="job2" parent="baseJob">
<step id="s2"><tasklet ref="dummyTasklet"/></step>
<step id="s2">
<tasklet ref="dummyTasklet" />
</step>
<listeners>
<listener>
<beans:bean class="org.springframework.batch.core.listener.JobExecutionListenerSupport"/>
<beans:bean
class="org.springframework.batch.core.listener.JobExecutionListenerSupport" />
</listener>
</listeners>
</job>
<job id="job3" parent="baseJob3">
<step id="s3"><tasklet ref="dummyTasklet"/></step>
<step id="s3">
<tasklet ref="dummyTasklet" />
</step>
<listeners merge="true">
<listener ref="listener1"/>
<listener ref="listener1" />
</listeners>
</job>
<job id="defaultRepoJob">
<step id="s4"><tasklet ref="dummyTasklet"/></step>
<step id="s4">
<tasklet ref="dummyTasklet" />
</step>
</job>
<job id="specifiedRepoJob" job-repository="dummyJobRepository">
<step id="s5"><tasklet ref="dummyTasklet"/></step>
<step id="s5">
<tasklet ref="dummyTasklet" />
</step>
</job>
<job id="inheritSpecifiedRepoJob" parent="baseSpecifiedRepoJob">
<step id="s6"><tasklet ref="dummyTasklet"/></step>
<step id="s6">
<tasklet ref="dummyTasklet" />
</step>
</job>
<job id="overrideInheritedRepoJob" parent="baseSpecifiedRepoJob" job-repository="jobRepository">
<step id="s7"><tasklet ref="dummyTasklet"/></step>
<job id="overrideInheritedRepoJob" parent="baseSpecifiedRepoJob"
job-repository="jobRepository">
<step id="s7">
<tasklet ref="dummyTasklet" />
</step>
</job>
<job id="baseSpecifiedRepoJob" abstract="true" job-repository="dummyJobRepository"/>
<job id="jobWithParametersValidator" parameters-validator="parametersValidator">
<step id="s8">
<tasklet ref="dummyTasklet" />
</step>
</job>
<beans:bean id="parametersValidator"
class="org.springframework.batch.core.job.DefaultJobParametersValidator">
<beans:property name="requiredKeys" value="name,value"/>
</beans:bean>
<job id="baseSpecifiedRepoJob" abstract="true" job-repository="dummyJobRepository" />
<job id="baseJob" abstract="true">
<listeners>
<listener>
<beans:bean class="org.springframework.batch.core.configuration.xml.DummyAnnotationJobExecutionListener"/>
<beans:bean
class="org.springframework.batch.core.configuration.xml.DummyAnnotationJobExecutionListener" />
</listener>
</listeners>
</job>
<job-listener id="listener1">
<beans:bean class="org.springframework.batch.core.configuration.xml.DummyAnnotationJobExecutionListener"/>
<beans:bean
class="org.springframework.batch.core.configuration.xml.DummyAnnotationJobExecutionListener" />
</job-listener>
<beans:bean id="baseJob3" abstract="true">
<beans:property name="jobExecutionListeners">
<beans:list>
<job-listener>
<beans:bean class="org.springframework.batch.core.listener.JobExecutionListenerSupport"/>
<beans:bean
class="org.springframework.batch.core.listener.JobExecutionListenerSupport" />
</job-listener>
</beans:list>
</beans:property>
</beans:bean>
<beans:bean id="dummyJobRepository" class="org.springframework.batch.core.configuration.xml.DummyJobRepository"/>
</beans:bean>
<beans:bean id="dummyJobRepository"
class="org.springframework.batch.core.configuration.xml.DummyJobRepository" />
<job id="listenerClearingJob" parent="baseJob">
<step id="listenerClearingJobStep"><tasklet ref="dummyTasklet"/></step>
<listeners/>
<step id="listenerClearingJobStep">
<tasklet ref="dummyTasklet" />
</step>
<listeners />
</job>
</beans:beans>