From a5fdbfedafcc41180ea52abdd18bd6d9f8440d02 Mon Sep 17 00:00:00 2001
From: lucasward <lucasward@2e8e966d-6415-0410-94b9-dc4e65435d03>
Date: Fri, 7 Nov 2008 20:46:41 +0000
Subject: [PATCH] BATCH-676: Added sample jobs for non sequential execution and
 decisions

---
 spring-batch-test/pom.xml                     |  13 +--
 .../batch/test/AbstractFlowJobTests.java      | 104 ++++++++++++++++++
 2 files changed, 106 insertions(+), 11 deletions(-)
 create mode 100644 spring-batch-test/src/main/java/org/springframework/batch/test/AbstractFlowJobTests.java

diff --git a/spring-batch-test/pom.xml b/spring-batch-test/pom.xml
index d8cf3917a..33fc195a2 100755
--- a/spring-batch-test/pom.xml
+++ b/spring-batch-test/pom.xml
@@ -7,19 +7,10 @@
 		<relativePath>..</relativePath>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
-	<artifactId>spring-batch-test</artifactId>
-	<name>Core</name>
+	<artifactId>org.springframework.batch.test</artifactId>
+	<name>Test</name>
 	<version>2.0.0.CI-SNAPSHOT</version>
 	<description>Domain for batch job testing</description>
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>com.springsource.bundlor</groupId>
-				<artifactId>com.springsource.bundlor.maven
-				</artifactId>
-			</plugin>
-		</plugins>
-	</build>
 	<profiles>
 		<profile>
 			<id>clover</id>
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/AbstractFlowJobTests.java b/spring-batch-test/src/main/java/org/springframework/batch/test/AbstractFlowJobTests.java
new file mode 100644
index 000000000..dd48ad6dc
--- /dev/null
+++ b/spring-batch-test/src/main/java/org/springframework/batch/test/AbstractFlowJobTests.java
@@ -0,0 +1,104 @@
+package org.springframework.batch.test;
+
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.batch.core.JobExecution;
+import org.springframework.batch.core.JobParameter;
+import org.springframework.batch.core.JobParameters;
+import org.springframework.batch.core.job.flow.FlowJob;
+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.factory.annotation.Autowired;
+
+/**
+ * Base class for testing batch jobs using the SimpleJob implementation. It
+ * provides methods for launching a Job, or individual Steps within a Job on
+ * their own, allowing for end to end testing of individual steps, without
+ * having to run every step in the job. Any test classes inheriting from this
+ * class should make sure they are part of an ApplicationContext, which is
+ * generally expected to be done as part of the Spring test framework.
+ * Furthermore, the ApplicationContext in which it is a part of is expected to
+ * have one {@link JobLauncher}, {@link JobRepository}, and a single Job
+ * implementation. It should be noted that using any of the methods that don't
+ * conain {@link JobParameters} in their signature, will result in one being
+ * created with the current system time as a parameter.
+ * 
+ * @author Lucas Ward
+ * @author Dan Garrette
+ * @since 2.0
+ */
+public abstract class AbstractFlowJobTests {
+
+	/** Logger */
+	protected final Log logger = LogFactory.getLog(getClass());
+
+	private JobLauncher launcher;
+	private FlowJob job;
+
+	@Autowired
+	public void setLauncher(JobLauncher bootstrap) {
+		this.launcher = bootstrap;
+	}
+
+	@Autowired
+	public void setJob(FlowJob job) {
+		this.job = job;
+	}
+
+	public FlowJob getJob() {
+		return job;
+	}
+
+	/**
+	 * Public getter for the launcher.
+	 * 
+	 * @return the launcher
+	 */
+	protected JobLauncher getLauncher() {
+		return launcher;
+	}
+
+	/**
+	 * Launch the entire job, including all steps, in order.
+	 * 
+	 * @return JobExecution, so that the test may validate the exit status
+	 */
+	public JobExecution launchJob() {
+		return this.launchJob(this.makeUniqueJobParameters());
+	}
+
+	/**
+	 * Launch the entire job, including all steps, in order.
+	 * 
+	 * @param jobParameters
+	 * @return JobExecution, so that the test may validate the exit status
+	 */
+	public JobExecution launchJob(JobParameters jobParameters) {
+		try {
+			return getLauncher().run(this.job, jobParameters);
+		} catch (JobExecutionAlreadyRunningException e) {
+			throw new RuntimeException(e);
+		} catch (JobRestartException e) {
+			throw new RuntimeException(e);
+		} catch (JobInstanceAlreadyCompleteException e) {
+			throw new RuntimeException(e);
+		}
+	}
+
+	/**
+	 * @return a new JobParameters object containing only a parameter for the
+	 *         current timestamp, to ensure that the job instance will be unique
+	 */
+	private JobParameters makeUniqueJobParameters() {
+		Map<String, JobParameter> parameters = new HashMap<String, JobParameter>();
+		parameters.put("timestamp", new JobParameter(new Date().getTime()));
+		return new JobParameters(parameters);
+	}
+}