Remove job autowiring in JobLauncherTestUtils

Before this commit, registering the JobLauncherTestUtils
as a bean in the test context (either manually or via
`@SpringBatchTest`) was failing when multiple jobs are
defined in the test context.

This commit removes the autowiring of the job under test
in JobLauncherTestUtils.

Resolves #1237

Author: fmbenhassine

spring-batch-docs/src/main/asciidoc/testing.adoc

@@ -22,20 +22,15 @@ approach.
 For the unit test to run a batch job, the framework must load the job's
 `ApplicationContext`. Two annotations are used to trigger this behavior:
 
-* `@RunWith(SpringJUnit4ClassRunner.class)` indicates that the class should use Spring's
+* `@SpringJUnitConfig` indicates that the class should use Spring's
 JUnit facilities
-* `@ContextConfiguration(...)` indicates which resources to configure the
-`ApplicationContext` with.
+* `@SpringBatchTest` injects Spring Batch test utilities (such as the
+`JobLauncherTestUtils` and `JobRepositoryTestUtils`) in the test context
 
-Starting from v4.1, it is also possible to inject Spring Batch test utilities
-(such as the `JobLauncherTestUtils` and `JobRepositoryTestUtils`) in the test context
-by using the `@SpringBatchTest` annotation.
-
-NOTE: Note that `JobLauncherTestUtils` requires a `Job` bean and that
-`JobRepositoryTestUtils` requires a `DataSource` bean. Since `@SpringBatchTest`
-registers a `JobLauncherTestUtils` and a `JobRepositoryTestUtils` in the test
+NOTE: Note that `JobRepositoryTestUtils` requires a `DataSource` bean. Since
+`@SpringBatchTest` registers a `JobRepositoryTestUtils` in the test
 context, it is expected that the test context contains a single autowire candidate
-for a `Job` and a `DataSource` (either a single bean definition or one that is
+for a `DataSource` (either a single bean definition or one that is
 annotated with `org.springframework.context.annotation.Primary`).
 
 [role="javaContent"]
@@ -45,8 +40,7 @@ The following Java example shows the annotations in use:
 [source, java, role="javaContent"]
 ----
 @SpringBatchTest
-@RunWith(SpringRunner.class)
-@ContextConfiguration(classes=SkipSampleConfiguration.class)
+@SpringJUnitConfig(SkipSampleConfiguration.class)
 public class SkipSampleFunctionalTests { ... }
 ----
 
@@ -57,8 +51,7 @@ The following XML example shows the annotations in use:
 [source, java, role="xmlContent"]
 ----
 @SpringBatchTest
-@RunWith(SpringRunner.class)
-@ContextConfiguration(locations = { "/simple-job-launcher-context.xml",
+@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                     "/jobs/skipSampleJob.xml" })
 public class SkipSampleFunctionalTests { ... }
 ----
@@ -81,14 +74,13 @@ about the `Job` run. In the following case, the test verifies that the `Job` end
 a status of `COMPLETED`.
 
 [role="xmlContent"]
-The following listing shows the example in XML:
+The following listing shows an example with JUnit 5 in XML configuration style:
 
 .XML Based Configuration
 [source, java, role="xmlContent"]
 ----
 @SpringBatchTest
-@RunWith(SpringRunner.class)
-@ContextConfiguration(locations = { "/simple-job-launcher-context.xml",
+@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                     "/jobs/skipSampleJob.xml" })
 public class SkipSampleFunctionalTests {
 
@@ -103,7 +95,8 @@ public class SkipSampleFunctionalTests {
     }
 
     @Test
-    public void testJob() throws Exception {
+    public void testJob(@Autowired Job job) throws Exception {
+        this.jobLauncherTestUtils.setJob(job);
         simpleJdbcTemplate.update("delete from CUSTOMER");
         for (int i = 1; i <= 10; i++) {
             simpleJdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
@@ -119,14 +112,13 @@ public class SkipSampleFunctionalTests {
 ----
 
 [role="javaContent"]
-The following listing shows the example in Java:
+The following listing shows an example with JUnit 5 in Java configuration style:
 
 .Java Based Configuration
 [source, java, role="javaContent"]
 ----
 @SpringBatchTest
-@RunWith(SpringRunner.class)
-@ContextConfiguration(classes=SkipSampleConfiguration.class)
+@SpringJUnitConfig(SkipSampleConfiguration.class)
 public class SkipSampleFunctionalTests {
 
     @Autowired
@@ -140,7 +132,8 @@ public class SkipSampleFunctionalTests {
     }
 
     @Test
-    public void testJob() throws Exception {
+    public void testJob(@Autowired Job job) throws Exception {
+        this.jobLauncherTestUtils.setJob(job);
         simpleJdbcTemplate.update("delete from CUSTOMER");
         for (int i = 1; i <= 10; i++) {
             simpleJdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
@@ -186,10 +179,9 @@ context for each test method, as the following example shows:
 
 [source, java]
 ----
-@ContextConfiguration
+@SpringJUnitConfig
 @TestExecutionListeners( { DependencyInjectionTestExecutionListener.class,
     StepScopeTestExecutionListener.class })
-@RunWith(SpringRunner.class)
 public class StepScopeTestExecutionListenerIntegrationTests {
 
     // This component is defined step-scoped, so it cannot be injected unless
@@ -228,8 +220,7 @@ example can be configured as follows:
 [source, java]
 ----
 @SpringBatchTest
-@RunWith(SpringRunner.class)
-@ContextConfiguration
+@SpringJUnitConfig
 public class StepScopeTestExecutionListenerIntegrationTests {
 
     // This component is defined step-scoped, so it cannot be injected unless

spring-batch-samples/src/test/java/org/springframework/batch/sample/AMQPJobFunctionalTests.java

@@ -18,6 +18,8 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.explore.JobExplorer;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -48,12 +50,15 @@ class AMQPJobFunctionalTests {
 	private JobExplorer jobExplorer;
 
 	@Test
-	void testLaunchJob() throws Exception {
-
-		jobLauncherTestUtils.launchJob();
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		// given
+		this.jobLauncherTestUtils.setJob(job);
+		this.jobLauncherTestUtils.launchJob();
 
+		// when
 		int count = jobExplorer.getJobInstances("amqp-example-job", 0, 1).size();
 
+		// then
 		assertTrue(count > 0);
 
 	}

spring-batch-samples/src/test/java/org/springframework/batch/sample/BeanWrapperMapperSampleJobFunctionalTests.java

@@ -17,6 +17,8 @@
 package org.springframework.batch.sample;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
@@ -29,10 +31,15 @@ class BeanWrapperMapperSampleJobFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJobLaunch() throws Exception {
+	void testJobLaunch(@Autowired Job job) throws Exception {
+		// given
+		this.jobLauncherTestUtils.setJob(job);
 
-		jobLauncherTestUtils.launchJob();
+		// when
+		this.jobLauncherTestUtils.launchJob();
 
+		// then
+		// FIXME no assertions?
 	}
 
 }

spring-batch-samples/src/test/java/org/springframework/batch/sample/CompositeItemWriterSampleFunctionalTests.java

@@ -27,6 +27,7 @@
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.Test;
 
+import org.springframework.batch.core.Job;
 import org.springframework.batch.sample.domain.trade.Trade;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -60,7 +61,8 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testJobLaunch() throws Exception {
+	void testJobLaunch(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		JdbcTestUtils.deleteFromTables(jdbcTemplate, "TRADE");
 		int before = JdbcTestUtils.countRowsInTable(jdbcTemplate, "TRADE");
 

spring-batch-samples/src/test/java/org/springframework/batch/sample/CustomerFilterJobFunctionalTests.java

@@ -30,6 +30,8 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -80,7 +82,8 @@ void tearDown() {
 	}
 
 	@Test
-	void testFilterJob() throws Exception {
+	void testFilterJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		JobExecution jobExecution = jobLauncherTestUtils.launchJob();
 
 		customers = Arrays.asList(new Customer("customer1", (credits.get("customer1"))),

spring-batch-samples/src/test/java/org/springframework/batch/sample/DatabaseShutdownFunctionalTests.java

@@ -25,6 +25,7 @@
 import org.apache.commons.logging.LogFactory;
 import org.junit.jupiter.api.Test;
 import org.springframework.batch.core.BatchStatus;
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.batch.test.JobLauncherTestUtils;
@@ -53,8 +54,8 @@ class DatabaseShutdownFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testLaunchJob() throws Exception {
-
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		JobExecution jobExecution = jobLauncherTestUtils.launchJob();
 
 		Thread.sleep(1000);

spring-batch-samples/src/test/java/org/springframework/batch/sample/DelegatingJobFunctionalTests.java

@@ -19,6 +19,8 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.sample.domain.person.PersonService;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,8 +37,8 @@ class DelegatingJobFunctionalTests {
 	private PersonService personService;
 
 	@Test
-	void testLaunchJob() throws Exception {
-
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		jobLauncherTestUtils.launchJob();
 
 		assertTrue(personService.getReturnedCount() > 0);

spring-batch-samples/src/test/java/org/springframework/batch/sample/FootballJobFunctionalTests.java

@@ -20,6 +20,8 @@
 import javax.sql.DataSource;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -41,7 +43,8 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testLaunchJob() throws Exception {
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		JdbcTestUtils.deleteFromTables(jdbcTemplate, "PLAYERS", "GAMES", "PLAYER_SUMMARY");
 
 		jobLauncherTestUtils.launchJob();

spring-batch-samples/src/test/java/org/springframework/batch/sample/GracefulShutdownFunctionalTests.java

@@ -24,6 +24,7 @@
 import org.apache.commons.logging.LogFactory;
 import org.junit.jupiter.api.Test;
 import org.springframework.batch.core.BatchStatus;
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.core.JobParameters;
 import org.springframework.batch.core.JobParametersBuilder;
@@ -54,8 +55,8 @@ class GracefulShutdownFunctionalTests {
 	private JobOperator jobOperator;
 
 	@Test
-	void testLaunchJob() throws Exception {
-
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		final JobParameters jobParameters = new JobParametersBuilder().addLong("timestamp", System.currentTimeMillis())
 				.toJobParameters();
 

spring-batch-samples/src/test/java/org/springframework/batch/sample/GroovyJobFunctionalTests.java

@@ -25,6 +25,8 @@
 import org.apache.commons.io.FileUtils;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
@@ -41,7 +43,8 @@ void removeOldData() throws IOException {
 	}
 
 	@Test
-	void testLaunchJob() throws Exception {
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		assertFalse(new File("target/groovyJob/output/files.zip").exists());
 		jobLauncherTestUtils.launchJob();
 		assertTrue(new File("target/groovyJob/output/files.zip").exists());

spring-batch-samples/src/test/java/org/springframework/batch/sample/HeaderFooterSampleFunctionalTests.java

@@ -21,6 +21,8 @@
 import java.io.FileReader;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
@@ -43,8 +45,9 @@ class HeaderFooterSampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJob() throws Exception {
-		jobLauncherTestUtils.launchJob();
+	void testJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
+		this.jobLauncherTestUtils.launchJob();
 
 		BufferedReader inputReader = new BufferedReader(new FileReader(input.getFile()));
 		BufferedReader outputReader = new BufferedReader(new FileReader(output.getFile()));

spring-batch-samples/src/test/java/org/springframework/batch/sample/HibernateFailureJobFunctionalTests.java

@@ -28,6 +28,7 @@
 
 import org.junit.jupiter.api.Test;
 
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.JobParameters;
 import org.springframework.batch.core.JobParametersBuilder;
 import org.springframework.batch.sample.domain.trade.internal.CustomerCreditIncreaseProcessor;
@@ -89,7 +90,8 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testLaunchJob() throws Exception {
+	void testLaunchJob(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		validatePreConditions();
 
 		JobParameters params = new JobParametersBuilder().addString("key", "failureJob").toJobParameters();

spring-batch-samples/src/test/java/org/springframework/batch/sample/LoopFlowSampleFunctionalTests.java

@@ -18,6 +18,8 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.Job;
 import org.springframework.batch.sample.domain.trade.internal.ItemTrackingTradeItemWriter;
 import org.springframework.batch.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -40,8 +42,9 @@ class LoopFlowSampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJobLaunch() throws Exception {
-		jobLauncherTestUtils.launchJob();
+	void testJobLaunch(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
+		this.jobLauncherTestUtils.launchJob();
 		// items processed = items read + 2 exceptions
 		assertEquals(10, itemWriter.getItems().size());
 	}

spring-batch-samples/src/test/java/org/springframework/batch/sample/MailJobFunctionalTests.java

@@ -26,6 +26,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.batch.core.ExitStatus;
+import org.springframework.batch.core.Job;
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.sample.domain.mail.internal.TestMailErrorHandler;
 import org.springframework.batch.sample.domain.mail.internal.TestMailSender;
@@ -93,7 +94,8 @@ void after() {
 	}
 
 	@Test
-	void testSkip() throws Exception {
+	void testSkip(@Autowired Job job) throws Exception {
+		this.jobLauncherTestUtils.setJob(job);
 		this.createUsers(new Object[][] { USER1, USER2_SKIP, USER3, USER4_SKIP, USER5, USER6, USER7, USER8 });
 
 		JobExecution jobExecution = jobLauncherTestUtils.launchJob();