diff --git a/spring-batch-execution/.springBeans b/spring-batch-execution/.springBeans index 347d9c4a7..ed5c2cdbc 100644 --- a/spring-batch-execution/.springBeans +++ b/spring-batch-execution/.springBeans @@ -1,47 +1,45 @@ - - - 1 - - - - - - src/test/resources/simple-container-definition.xml - src/test/resources/job-configuration.xml - src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml - src/test/resources/org/springframework/batch/execution/repository/dao/sql-dao-test.xml - src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment.xml - src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-no-launcher.xml - src/test/resources/org/springframework/batch/execution/configuration/test-context.xml - src/test/resources/org/springframework/batch/execution/scope/scope-tests.xml - src/test/resources/beanRefContext.xml - - - - - true - false - - src/test/resources/job-configuration.xml - src/test/resources/simple-container-definition.xml - - - - - true - false - - src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml - src/test/resources/org/springframework/batch/execution/repository/dao/sql-dao-test.xml - - - - - true - false - - src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml - - - - + + + 1 + + + + + + src/test/resources/simple-container-definition.xml + src/test/resources/job-configuration.xml + src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml + src/test/resources/org/springframework/batch/execution/repository/dao/sql-dao-test.xml + src/test/resources/org/springframework/batch/execution/configuration/test-context.xml + src/test/resources/org/springframework/batch/execution/scope/scope-tests.xml + src/test/resources/beanRefContext.xml + + + + + true + false + + src/test/resources/job-configuration.xml + src/test/resources/simple-container-definition.xml + + + + + true + false + + src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml + src/test/resources/org/springframework/batch/execution/repository/dao/sql-dao-test.xml + + + + + true + false + + src/test/resources/org/springframework/batch/execution/repository/dao/data-source-context.xml + + + + diff --git a/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java b/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java index a0cdde6ea..c18797af1 100644 --- a/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java +++ b/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java @@ -244,8 +244,7 @@ public class CommandLineJobRunner { CommandLineJobRunner command = new CommandLineJobRunner(); if (args.length < 3) { - logger - .error("At least 3 arguments are required: JobPath, JobName, and ExecutionPath."); + logger.error("At least 3 arguments are required: JobPath, JobName, and JobLauncherPath."); command.exit(1); } diff --git a/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunner.java b/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunner.java deleted file mode 100644 index 6f111eb84..000000000 --- a/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunner.java +++ /dev/null @@ -1,286 +0,0 @@ -/* - * Copyright 2006-2007 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.execution.bootstrap.support; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.batch.core.domain.Job; -import org.springframework.batch.core.domain.JobParameters; -import org.springframework.batch.core.domain.JobLocator; -import org.springframework.batch.core.domain.NoSuchJobException; -import org.springframework.batch.core.executor.ExitCodeExceptionClassifier; -import org.springframework.batch.execution.launch.JobLauncher; -import org.springframework.batch.execution.step.simple.SimpleExitCodeExceptionClassifier; -import org.springframework.batch.repeat.ExitStatus; -import org.springframework.beans.factory.access.BeanFactoryLocator; -import org.springframework.beans.factory.access.SingletonBeanFactoryLocator; -import org.springframework.beans.factory.config.AutowireCapableBeanFactory; -import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.context.access.ContextSingletonBeanFactoryLocator; -import org.springframework.context.support.ClassPathXmlApplicationContext; -import org.springframework.util.Assert; - -/** - *

- * Basic launcher for starting jobs from the command line. In general, it is - * assumed that this launcher will primarily be used to start a job via a script - * from an Enterprise Scheduler. Therefore, exit codes are mapped to integers so - * that schedulers can use the returned values to determine the next course of - * action. The returned values can also be useful to operations teams in - * determining what should happen upon failure. For example, a returned code of - * 5 might mean that some resource wasn't available and the job should be - * restarted. However, a code of 10 might mean that something critical has - * happened and the issue should be escalated. - *

- * - *

- * With any launch of a batch job within Spring Batch, a Spring context - * containing the Job and the 'Execution Environment' has to be created. This - * command line launcher can be used to load that context from a single - * location. It can also be used to first load the execution environment context - * via a {@link ContextSingletonBeanFactoryLocator}. This will then be used as - * the parent to the Job context. All dependencies of the launcher will then be - * satisfied by autowiring by type from the combined application context. - * Default values are provided for all fields except the {@link JobLauncher}. - * Therefore, if autowiring fails to set it (it should be noted that dependency - * checking is disabled because most of the fields have default values and thus - * don't require dependencies to be fulfilled via autowiring) then an exception - * will be thrown. It should also be noted that even if an exception is thrown - * by this class, it will be mapped to an integer and returned. - *

- * - *

- * Notice a property is available to set the {@link SystemExiter}. This class - * is used to exit from the main method, rather than calling System.exit() - * directly. This is because unit testing a class the calls System.exit() is - * impossible without kicking off the test within a new Jvm, which it is - * possible to do, however it is a complex solution, much more so than - * strategizing the exiter. - *

- * - *

- * VM Arguments vs. Program arguments: Because all of the arguments to the main - * method are optional, System properties (VM arguments) are used (@see - * {@link #main(String[])}). - * - * @author Dave Syer - * @author Lucas Ward - * @since 2.1 - */ -public class SimpleCommandLineJobRunner { - - protected static final Log logger = LogFactory.getLog(SimpleCommandLineJobRunner.class); - - /** - * The default path to the job configuration. - */ - public static final String DEFAULT_JOB_CONFIGURATION_PATH = "job-configuration.xml"; - - public static final String JOB_CONFIGURATION_PATH_KEY = "job.configuration.path"; - - public static final String JOB_NAME_KEY = "job.name"; - - public static final String BATCH_EXECUTION_ENVIRONMENT_KEY = "batch.execution.environment.key"; - - public static final String BEAN_REF_CONTEXT_KEY = "bean.ref.context"; - - private BeanFactoryLocator beanFactoryLocator; - - private ExitCodeMapper exitCodeMapper = new SimpleJvmExitCodeMapper(); - - private ExitCodeExceptionClassifier exceptionClassifier = new SimpleExitCodeExceptionClassifier(); - - private JobLauncher launcher; - private JobLocator jobLocator; - - private SystemExiter systemExiter = new JvmSystemExiter(); - - private String defaultJobName; - - public SimpleCommandLineJobRunner(String beanRefContextPath) { - if (beanRefContextPath == null) { - return; - } - beanFactoryLocator = ContextSingletonBeanFactoryLocator.getInstance(beanRefContextPath); - } - - /** - * Setter for the name of the {@link Job} that this launcher will run. - * - * @param jobName the job name to set - */ - public void setDefaultJobName(String defaultJobName) { - this.defaultJobName = defaultJobName; - } - - /** - * Injection setter for the {@link JobLauncher}. - * - * @param launcher the launcher to set - */ - public void setLauncher(JobLauncher launcher) { - this.launcher = launcher; - } - - /** - * Injection setter for the {@link ExitCodeExceptionClassifier} - * - * @param exceptionClassifier - */ - public void setExceptionClassifier(ExitCodeExceptionClassifier exceptionClassifier) { - this.exceptionClassifier = exceptionClassifier; - } - - /** - * Injection setter for the {@link JvmExitCodeMapper}. - * - * @param exitCodeMapper the exitCodeMapper to set - */ - public void setExitCodeMapper(ExitCodeMapper exitCodeMapper) { - this.exitCodeMapper = exitCodeMapper; - } - - /** - * Injection setter for the {@link SystemExiter}. - * - * @param systemExitor - */ - public void setSystemExiter(SystemExiter systemExitor) { - this.systemExiter = systemExitor; - } - - public void setJobLocator(JobLocator jobLocator) { - this.jobLocator = jobLocator; - } - - /** - * Delegate to the exiter to (possibly) exit the VM gracefully. - * - * @param status - */ - public void exit(int status) { - systemExiter.exit(status); - } - - /** - * @param path the path to a Spring context configuration for this job - * @param jobName the name of the job execution to use - * @parm parentKey the key to be loaded by - * ContextSingletonBeanFactoryLocator and used as the parent context. - * @throws NoSuchJobException - * @throws IllegalStateException if JobLauncher is not autowired by the - * ApplicationContext - */ - int start(String path, String jobName, String parentKey) { - - ExitStatus status = ExitStatus.FAILED; - ClassPathXmlApplicationContext context = null; - - try { - ConfigurableApplicationContext parent = null; - - if (beanFactoryLocator != null) { - parent = (ConfigurableApplicationContext) beanFactoryLocator.useBeanFactory(parentKey).getFactory(); - - parent.getAutowireCapableBeanFactory().autowireBeanProperties(this, - AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE, false); - } - - if (!path.endsWith(".xml")) { - path = path + ".xml"; - } - - context = new ClassPathXmlApplicationContext(new String[] { path }, parent); - - context.getAutowireCapableBeanFactory().autowireBeanProperties(this, - AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE, false); - - Assert.state(launcher != null, "JobLauncher must be provided in the parent ApplicationContext" - + ", check the context to ensure a JobLauncher is declared"); - - if (jobName == null) { - String[] names = context.getBeanNamesForType(Job.class); - if (names.length == 1) { - Job job = (Job) context.getBean(names[0]); - jobName = job.getName(); - } - } - - if (jobName == null) { - jobName = defaultJobName; - } - - status = launcher.run(jobLocator.getJob(jobName), new JobParameters()).getExitStatus(); - } - catch (NoSuchJobException e) { - logger.fatal("Could not locate JobConfiguration \"" + jobName + "\"", e); - status = new ExitStatus(false, ExitCodeMapper.NO_SUCH_JOB); - } - catch (Throwable t) { - logger.fatal(t); - status = exceptionClassifier.classifyForExitCode(t); - } - finally { - if (context != null) { - try { - context.stop(); - } - finally { - context.close(); - } - } - } - return exitCodeMapper.getExitCode(status.getExitCode()); - } - - /** - * Launch a batch job using a {@link SimpleCommandLineJobRunner}. Creates a - * new Spring context for the job execution, and uses a common parent for - * all such contexts. No exception are thrown from this method, rather - * exceptions are logged and an integer returned through the exit status in - * a {@link JvmSystemExiter} (which can be overridden by defining one in the - * Spring context). - * - * @param args - *

- */ - public static void main(String[] args) { - - String path = System.getProperty(JOB_CONFIGURATION_PATH_KEY, DEFAULT_JOB_CONFIGURATION_PATH); - String name = System.getProperty(JOB_NAME_KEY); - String beanRefContextPath = System.getProperty(BEAN_REF_CONTEXT_KEY); - String parentKey = System.getProperty(BATCH_EXECUTION_ENVIRONMENT_KEY); - - Assert.state(!(beanRefContextPath == null && parentKey != null), "If you specify the " - + BATCH_EXECUTION_ENVIRONMENT_KEY + " you must also specify a path for the " + BEAN_REF_CONTEXT_KEY); - - SimpleCommandLineJobRunner command = new SimpleCommandLineJobRunner(beanRefContextPath); - int result = command.start(path, name, parentKey); - command.exit(result); - } - -} diff --git a/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunnerTests.java b/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunnerTests.java deleted file mode 100644 index c8943cf0a..000000000 --- a/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/SimpleCommandLineJobRunnerTests.java +++ /dev/null @@ -1,230 +0,0 @@ -/* - * Copyright 2006-2007 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.execution.bootstrap.support; - -import junit.framework.TestCase; - -import org.springframework.batch.core.domain.Job; -import org.springframework.batch.core.domain.JobExecution; -import org.springframework.batch.core.domain.JobInstance; -import org.springframework.batch.core.domain.JobParameters; -import org.springframework.batch.repeat.ExitStatus; -import org.springframework.beans.factory.access.BeanFactoryLocator; -import org.springframework.beans.factory.config.AutowireCapableBeanFactory; -import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.context.access.ContextSingletonBeanFactoryLocator; -import org.springframework.context.support.ClassPathXmlApplicationContext; -import org.springframework.util.ClassUtils; - -/** - * @author Dave Syer - * - */ -public class SimpleCommandLineJobRunnerTests extends TestCase { - - private static final String JOB_CONFIGURATION_PATH_KEY = SimpleCommandLineJobRunner.JOB_CONFIGURATION_PATH_KEY; - private static final String JOB_NAME_KEY = SimpleCommandLineJobRunner.JOB_NAME_KEY; - private static final String BATCH_EXECUTION_ENVIRONMENT_KEY = SimpleCommandLineJobRunner.BATCH_EXECUTION_ENVIRONMENT_KEY; - private static final String BEAN_REF_CONTEXT_KEY = SimpleCommandLineJobRunner.BEAN_REF_CONTEXT_KEY; - - private static final String TEST_BATCH_ENVIRONMENT_KEY = "testBatchEnvironment"; - private static final String TEST_BATCH_ENVIRONMENT_NO_LAUNCHER_KEY = "testBatchEnvironmentNoLauncher"; - private static final String TEST_JOB_CONFIGURATION_WITH_ENVIRONMENT = ClassUtils.addResourcePathToPackagePath(SimpleCommandLineJobRunnerTests.class, "test-batch-environment-with-job.xml"); - - BeanFactoryLocator beanFactoryLocator = ContextSingletonBeanFactoryLocator - .getInstance(); - - StubJobLauncher jobLauncher; - StubSystemExiter systemExiter; - - protected void setUp() throws Exception { - super.setUp(); - System.setProperty(BATCH_EXECUTION_ENVIRONMENT_KEY, - TEST_BATCH_ENVIRONMENT_KEY); - System.setProperty(BEAN_REF_CONTEXT_KEY, - "beanRefContext.xml"); - } - - protected void tearDown() throws Exception { - super.tearDown(); - System.clearProperty(JOB_CONFIGURATION_PATH_KEY); - System.clearProperty(JOB_NAME_KEY); - System.clearProperty(BATCH_EXECUTION_ENVIRONMENT_KEY); - System.clearProperty(BEAN_REF_CONTEXT_KEY); - } - - public void testParentWithNoLauncher() { - buildContext(TEST_BATCH_ENVIRONMENT_NO_LAUNCHER_KEY); - assertNotNull(systemExiter); - - System.setProperty(BATCH_EXECUTION_ENVIRONMENT_KEY, - TEST_BATCH_ENVIRONMENT_NO_LAUNCHER_KEY); - - SimpleCommandLineJobRunner.main(new String[0]); - - assertEquals(ExitCodeMapper.JVM_EXITCODE_GENERIC_ERROR, systemExiter - .getStatus()); - } - - /** - * Test method for - * {@link org.springframework.batch.execution.bootstrap.support.SimpleCommandLineJobRunner#main(java.lang.String[])}. - * - * @throws Exception - */ - public void testNoBeanRefContext() throws Exception { - // No error, so we assume it has worked! - System.clearProperty(BATCH_EXECUTION_ENVIRONMENT_KEY); - System.clearProperty(BEAN_REF_CONTEXT_KEY); - System.setProperty(JOB_CONFIGURATION_PATH_KEY, TEST_JOB_CONFIGURATION_WITH_ENVIRONMENT); - SimpleCommandLineJobRunner.main(new String[0]); - } - - /** - * Test method for - * {@link org.springframework.batch.execution.bootstrap.support.SimpleCommandLineJobRunner#main(java.lang.String[])}. - * - * @throws Exception - */ - public void testBeanRefContextButNoEnvironment() throws Exception { - // No error, so we assume it has worked! - System.clearProperty(BEAN_REF_CONTEXT_KEY); - System.setProperty(JOB_CONFIGURATION_PATH_KEY, TEST_JOB_CONFIGURATION_WITH_ENVIRONMENT); - try { - SimpleCommandLineJobRunner.main(new String[0]); - } catch (IllegalStateException e) { - // expected - String message = e.getMessage(); - assertTrue("Message should contain invalid property names:"+message, message.indexOf(SimpleCommandLineJobRunner.BATCH_EXECUTION_ENVIRONMENT_KEY)>=0); - assertTrue("Message should contain invalid property names:"+message, message.indexOf(SimpleCommandLineJobRunner.BEAN_REF_CONTEXT_KEY)>=0); - } - } - - /** - * Test method for - * {@link org.springframework.batch.execution.bootstrap.support.SimpleCommandLineJobRunner#main(java.lang.String[])}. - * - * @throws Exception - */ - public void testDefaultNameAndPath() throws Exception { - - buildContext(TEST_BATCH_ENVIRONMENT_KEY); - assertNotNull(jobLauncher); - assertNotNull(systemExiter); - - setReturnValue(ExitStatus.FINISHED); - - SimpleCommandLineJobRunner.main(new String[0]); - - assertEquals(ExitCodeMapper.JVM_EXITCODE_COMPLETED, systemExiter - .getStatus()); - assertEquals(jobLauncher.getLastRunCalled(), - StubJobLauncher.RUN_JOB_IDENTIFIER); - } - - /** - * Test method for - * {@link org.springframework.batch.execution.bootstrap.support.SimpleCommandLineJobRunner#main(java.lang.String[])}. - * - * @throws Exception - */ - public void testCustomJobName() { - -// buildContext(TEST_BATCH_ENVIRONMENT_KEY); -// assertNotNull(jobLauncher); -// assertNotNull(systemExiter); -// setReturnValue(ExitStatus.FINISHED); -// -// System.setProperty(JOB_NAME_KEY, "foo"); -// SimpleCommandLineJobRunner.main(new String[0]); -// -// assertEquals(ExitCodeMapper.JVM_EXITCODE_COMPLETED, systemExiter -// .getStatus()); -// assertEquals(jobLauncher.getLastRunCalled(), -// StubJobLauncher.RUN_JOB_IDENTIFIER); - } - - private void setReturnValue(ExitStatus status) { - JobExecution execution = new JobExecution(new JobInstance(new Long(1), new JobParameters(), new Job("foo"))); - - execution.setExitStatus(status); - jobLauncher.setReturnValue(execution); - } - - /** - * Test method for - * {@link org.springframework.batch.execution.bootstrap.support.SimpleCommandLineJobRunner#main(java.lang.String[])}. - * - * @throws Exception - */ - public void testMainWithDefaultArguments() throws Exception { - // We can only test this without running the whole test in another jvm - // by using a special SystemExiter in the default configuration because - // otherwise it calls System.exit() by default. - SimpleCommandLineJobRunner.main(new String[0]); - } - - public void testInvalidJobConfig() { - // To test this without kicking off in a new jvm, we have to autowire - // the launcher (in BatchCommandLineLauncher.start) from the parent, - // *then* the child context. - buildContext("batchExecutionEnvironment"); - assertNotNull(systemExiter); - System.setProperty(JOB_CONFIGURATION_PATH_KEY, "foo"); - SimpleCommandLineJobRunner.main(new String[0]); - } - - private void buildContext(String key) { - ConfigurableApplicationContext context = (ClassPathXmlApplicationContext) beanFactoryLocator - .useBeanFactory(key).getFactory(); - context.getAutowireCapableBeanFactory().autowireBeanProperties(this, - AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE, false); - } - - public static class StubSystemExiter implements SystemExiter { - - private int status; - - public void exit(int status) { - this.status = status; - } - - public int getStatus() { - return status; - } - } - - /** - * Public setter for the {@link StubJobLauncher} property. - * - * @param jobLauncher - * the jobLauncher to set - */ - public void setJobLauncher(StubJobLauncher jobLauncher) { - this.jobLauncher = jobLauncher; - } - - /** - * Public setter for the {@link StubSystemExiter} property. - * - * @param systemExiter - * the systemExiter to set - */ - public void setSystemExiter(StubSystemExiter systemExiter) { - this.systemExiter = systemExiter; - } - -} diff --git a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-no-launcher.xml b/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-no-launcher.xml deleted file mode 100644 index 508fe5082..000000000 --- a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-no-launcher.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - diff --git a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-with-job.xml b/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-with-job.xml deleted file mode 100644 index a0373d85b..000000000 --- a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment-with-job.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment.xml b/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment.xml deleted file mode 100644 index 919f8ccea..000000000 --- a/spring-batch-execution/src/test/resources/org/springframework/batch/execution/bootstrap/support/test-batch-environment.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - diff --git a/spring-batch-execution/src/test/resources/simple-container-definition.xml b/spring-batch-execution/src/test/resources/simple-container-definition.xml index 80341cd28..6969e9e62 100644 --- a/spring-batch-execution/src/test/resources/simple-container-definition.xml +++ b/spring-batch-execution/src/test/resources/simple-container-definition.xml @@ -104,6 +104,6 @@ + class="org.springframework.batch.execution.bootstrap.support.CommandLineJobRunnerTests$StubSystemExiter" />