From 678cb7825ba89e3a1737518314abf5ea3c64307b Mon Sep 17 00:00:00 2001 From: lucasward Date: Fri, 25 Jan 2008 14:50:12 +0000 Subject: [PATCH] CommandLineJobRunner was somehow deleted in the last revision, readding it. --- .../support/CommandLineJobRunner.java | 263 ++++++++++++++++++ .../support/CommandLineJobRunnerTests.java | 154 ++++++++++ 2 files changed, 417 insertions(+) create mode 100644 spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java create mode 100644 spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunnerTests.java 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 new file mode 100644 index 000000000..a0cdde6ea --- /dev/null +++ b/spring-batch-execution/src/main/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunner.java @@ -0,0 +1,263 @@ +/* + * Copyright 2006-2008 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 java.util.Properties; + +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.JobExecution; +import org.springframework.batch.core.domain.JobLocator; +import org.springframework.batch.core.domain.JobParameters; +import org.springframework.batch.core.executor.ExitCodeExceptionClassifier; +import org.springframework.batch.core.runtime.JobParametersFactory; +import org.springframework.batch.execution.launch.JobLauncher; +import org.springframework.batch.execution.step.simple.SimpleExitCodeExceptionClassifier; +import org.springframework.beans.factory.BeanDefinitionStoreException; +import org.springframework.beans.factory.config.AutowireCapableBeanFactory; +import org.springframework.context.ApplicationContext; +import org.springframework.context.support.ClassPathXmlApplicationContext; +import org.springframework.util.StringUtils; + +/** + *

+ * 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 load the job as well 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} and {@link JobLocator}. 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. + *

+ * + *

+ * The arguments to this class are roughly as follows: + *

+ * + * + * java jobPath jobName jobLauncherPath jobParameters... + * + * + *

+ *

+ *

+ * + *

+ * The combined application context must only contain one instance of a + * {@link JobLauncher}. The job parameters passed in to the command line will + * be converted to {@link Properties} by assuming that each individual element + * is one parameter that is separated by an equals sign. For example, + * "vendor.id=290232". Below is an example arguments list: " + * + *

+ * + * java org.springframework.batch.execution.bootstrap.support.CommandLineJobRunner testJob.xml + * testJob standard-job-launcher.xml schedule.date=2008/01/24 vendor.id=3902483920 + *

+ * + *

Once arguments have been successfully parsed, autowiring will be used to set + * various dependencies. The {@JobLauncher} for example, will be loaded this way. If + * none is contained in the bean factory (it searches by type) then a + * {@link BeanDefinitionStoreException} will be thrown. The same exception will also + * be thrown if there is more than one present. Assuming the JobLauncher has been + * set correctly, the jobName argument will be used to obtain an actual {@link Job}. + * If a {@link JobLocator} has been set, then it will be used, if not the beanFactory + * will be asked, using the jobName as the bean id.

+ * + * @author Dave Syer + * @author Lucas Ward + * @since 1.0 + */ +public class CommandLineJobRunner { + + protected static final Log logger = LogFactory + .getLog(CommandLineJobRunner.class); + + private ExitCodeMapper exitCodeMapper = new SimpleJvmExitCodeMapper(); + + private ExitCodeExceptionClassifier exceptionClassifier = new SimpleExitCodeExceptionClassifier(); + + private JobLauncher launcher; + + private JobLocator jobLocator; + + private SystemExiter systemExiter = new JvmSystemExiter(); + + private JobParametersFactory jobParametersFactory = new DefaultJobParametersFactory(); + + /** + * 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; + } + + /** + * Delegate to the exiter to (possibly) exit the VM gracefully. + * + * @param status + */ + public void exit(int status) { + systemExiter.exit(status); + } + + public void setJobLocator(JobLocator jobLocator) { + this.jobLocator = jobLocator; + } + + /* + * Start a job by obtaining a combined classpath using the job launcher and + * job paths. If a JobLocator has been set, then use it to obtain an actual + * job, if not ask the context for it. + */ + int start(String jobPath, String jobLauncherPath, String jobName, + String[] parameters) { + + try { + ApplicationContext context = new ClassPathXmlApplicationContext( + new String[] { jobPath, jobLauncherPath }); + context.getAutowireCapableBeanFactory().autowireBeanProperties( + this, AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE, false); + + Job job; + if (jobLocator != null) { + job = jobLocator.getJob(jobName); + } else { + job = (Job) context.getBean(jobName); + } + + JobParameters jobParameters = jobParametersFactory + .getJobParameters(StringUtils + .splitArrayElementsIntoProperties(parameters, "=")); + + JobExecution jobExecution = launcher.run(job, jobParameters); + return exitCodeMapper.getExitCode(jobExecution.getExitStatus() + .getExitCode()); + } catch (Throwable e) { + logger.error("Job Terminated in error:", e); + return exitCodeMapper.getExitCode(exceptionClassifier + .classifyForExitCode(e).getExitCode()); + } + } + + /** + * Launch a batch job using a {@link CommandLineJobRunner}. 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 + *

+ *

    + *
  • jobPath: the xml application context containing a + * {@link Job} + *
  • jobName: the bean id of the job. + *
  • jobLauncherPath: the xml application context containing a + * {@link JobLauncher} + *
  • jobParameters: 0 to many parameters that will be used to + * launch a job. + *
+ *

+ */ + public static void main(String[] args) { + + CommandLineJobRunner command = new CommandLineJobRunner(); + + if (args.length < 3) { + logger + .error("At least 3 arguments are required: JobPath, JobName, and ExecutionPath."); + command.exit(1); + } + + String jobPath = args[0]; + String jobName = args[1]; + String jobLauncherPath = args[2]; + String[] parameters = new String[args.length - 3]; + System.arraycopy(args, 2, parameters, 0, args.length - 3); + + int result = command.start(jobPath, jobLauncherPath, jobName, + parameters); + command.exit(result); + } + +} diff --git a/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunnerTests.java b/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunnerTests.java new file mode 100644 index 000000000..63df8eb3c --- /dev/null +++ b/spring-batch-execution/src/test/java/org/springframework/batch/execution/bootstrap/support/CommandLineJobRunnerTests.java @@ -0,0 +1,154 @@ +/* + * Copyright 2006-2008 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.JobParameters; +import org.springframework.batch.core.executor.ExitCodeExceptionClassifier; +import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException; +import org.springframework.batch.execution.launch.JobLauncher; +import org.springframework.batch.repeat.ExitStatus; + +/** + * @author Lucas Ward + * + */ +public class CommandLineJobRunnerTests extends TestCase { + + private static final String JOB = "org/springframework/batch/execution/bootstrap/support/job.xml"; + private static final String TEST_BATCH_ENVIRONMENT = "org/springframework/batch/execution/bootstrap/support/test-environment.xml"; + private static final String JOB_NAME = "test-job"; + + private String jobPath = JOB; + private String environmentPath = TEST_BATCH_ENVIRONMENT; + private String jobName = JOB_NAME; + private String jobKey = "job.Key=myKey"; + private String scheduleDate = "schedule.Date=01/23/2008"; + private String vendorId = "vendor.id=33243243"; + + private String[] args = new String[]{jobPath, jobName, environmentPath, jobKey, scheduleDate, vendorId}; + + private JobExecution jobExecution; + + /* (non-Javadoc) + * @see junit.framework.TestCase#setUp() + */ + protected void setUp() throws Exception { + super.setUp(); + + jobExecution = new JobExecution(null, new Long(1)); + ExitStatus exitStatus = ExitStatus.FINISHED; + jobExecution.setExitStatus(exitStatus); + } + + public void testMain(){ + + StubJobLauncher.jobExecution = jobExecution; + + CommandLineJobRunner.main(args); + + assertEquals(0, StubSystemExiter.getStatus()); + } + + public void testJobAlreadyRunning(){ + + StubJobLauncher.throwExecutionRunningException = true; + + CommandLineJobRunner.main(args); + + assertTrue(StubExceptionClassifier.exception instanceof JobExecutionAlreadyRunningException); + } + + //can't test because it will cause the system to exit. +// public void testInvalidArgs(){ +// +// String[] args = new String[]{jobPath, jobName}; +// CommandLineJobRunner.main(args); +// } + + public void testWithNoParameters(){ + + String[] args = new String[]{jobPath, jobName, environmentPath}; + CommandLineJobRunner.main(args); + assertEquals(new JobParameters(), StubJobLauncher.jobParameters); + } + + protected void tearDown() throws Exception { + super.tearDown(); + + StubJobLauncher.tearDown(); + } + + public static class StubSystemExiter implements SystemExiter { + + public static int status; + + public void exit(int status) { + StubSystemExiter.status = status; + } + + public static int getStatus() { + return status; + } + } + + public static class StubJobLauncher implements JobLauncher{ + + public static JobExecution jobExecution; + public static boolean throwExecutionRunningException = false; + public static JobParameters jobParameters; + + public JobExecution run(Job job, JobParameters jobParameters) + throws JobExecutionAlreadyRunningException { + + StubJobLauncher.jobParameters = jobParameters; + + if(throwExecutionRunningException){ + throw new JobExecutionAlreadyRunningException(""); + } + + return jobExecution; + } + + public static void tearDown(){ + jobExecution = null; + throwExecutionRunningException = false; + jobParameters = null; + } + } + + public static class StubExceptionClassifier implements ExitCodeExceptionClassifier{ + + public static Throwable exception; + + public Object classify(Throwable throwable) { + return null; + } + + public Object getDefault() { + return null; + } + + public ExitStatus classifyForExitCode(Throwable throwable) { + exception = throwable; + return ExitStatus.FAILED; + } + + } +}