Improve @SpringBatchTest to autowire the job under test in JobLauncherTestUtils if it is unique

Issue #4218

Author: hpoettker

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

@@ -17,7 +17,6 @@
 
 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;
@@ -50,9 +49,8 @@ class AMQPJobFunctionalTests {
 	private JobExplorer jobExplorer;
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
+	void testLaunchJob() throws Exception {
 		// given
-		this.jobLauncherTestUtils.setJob(job);
 		this.jobLauncherTestUtils.launchJob();
 
 		// when

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

@@ -18,7 +18,6 @@
 
 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;
@@ -31,10 +30,7 @@ class BeanWrapperMapperSampleJobFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJobLaunch(@Autowired Job job) throws Exception {
-		// given
-		this.jobLauncherTestUtils.setJob(job);
-
+	void testJobLaunch() throws Exception {
 		// when
 		this.jobLauncherTestUtils.launchJob();
 

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

@@ -28,7 +28,6 @@
 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;
@@ -62,8 +61,7 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testJobLaunch(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testJobLaunch() throws Exception {
 		JdbcTestUtils.deleteFromTables(jdbcTemplate, "TRADE");
 		int before = JdbcTestUtils.countRowsInTable(jdbcTemplate, "TRADE");
 

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

@@ -29,7 +29,6 @@
 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;
@@ -82,8 +81,7 @@ void tearDown() {
 	}
 
 	@Test
-	void testFilterJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testFilterJob() throws Exception {
 		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

@@ -21,7 +21,6 @@
 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;
@@ -57,8 +56,7 @@ class DatabaseShutdownFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		JobExecution jobExecution = jobLauncherTestUtils.launchJob();
 
 		Thread.sleep(1000);

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

@@ -17,7 +17,6 @@
 
 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;
@@ -37,8 +36,7 @@ class DelegatingJobFunctionalTests {
 	private PersonService personService;
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		jobLauncherTestUtils.launchJob();
 
 		assertTrue(personService.getReturnedCount() > 0);

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

@@ -19,7 +19,6 @@
 
 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;
@@ -43,8 +42,7 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		JdbcTestUtils.deleteFromTables(jdbcTemplate, "PLAYERS", "GAMES", "PLAYER_SUMMARY");
 
 		jobLauncherTestUtils.launchJob();

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

@@ -21,7 +21,6 @@
 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;
@@ -58,8 +57,7 @@ class GracefulShutdownFunctionalTests {
 	private JobOperator jobOperator;
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		final JobParameters jobParameters = new JobParametersBuilder().addLong("timestamp", System.currentTimeMillis())
 				.toJobParameters();
 

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

@@ -23,7 +23,6 @@
 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;
@@ -43,8 +42,7 @@ void removeOldData() throws IOException {
 	}
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		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

@@ -20,7 +20,6 @@
 
 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;
@@ -45,8 +44,7 @@ class HeaderFooterSampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testJob() throws Exception {
 		this.jobLauncherTestUtils.launchJob();
 
 		BufferedReader inputReader = new BufferedReader(new FileReader(input.getFile()));

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

@@ -25,7 +25,6 @@
 
 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;
@@ -92,8 +91,7 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		validatePreConditions();
 
 		JobParameters params = new JobParametersBuilder().addString("key", "failureJob").toJobParameters();

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

@@ -17,7 +17,6 @@
 
 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;
@@ -45,8 +44,7 @@ class LoopFlowSampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJobLaunch(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testJobLaunch() throws Exception {
 		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

@@ -25,7 +25,6 @@
 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;
@@ -96,8 +95,7 @@ void after() {
 	}
 
 	@Test
-	void testSkip(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testSkip() throws Exception {
 		this.createUsers(new Object[][] { USER1, USER2_SKIP, USER3, USER4_SKIP, USER5, USER6, USER7, USER8 });
 
 		JobExecution jobExecution = jobLauncherTestUtils.launchJob();

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

@@ -19,7 +19,6 @@
 import org.apache.commons.io.IOUtils;
 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.core.io.FileSystemResource;
@@ -44,8 +43,7 @@ class MultilineJobFunctionalTests {
 	private final Resource output = new FileSystemResource("target/test-outputs/20070122.testStream.multilineStep.txt");
 
 	@Test
-	void testJobLaunch(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testJobLaunch() throws Exception {
 		this.jobLauncherTestUtils.launchJob();
 		assertEquals(EXPECTED_RESULT, StringUtils.replace(IOUtils.toString(output.getInputStream(), "UTF-8"),
 				System.getProperty("line.separator"), ""));

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

@@ -22,7 +22,6 @@
 import org.junit.jupiter.api.Assertions;
 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.core.io.ClassPathResource;
@@ -41,8 +40,7 @@ class MultilineOrderJobFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testJobLaunch(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testJobLaunch() throws Exception {
 		this.jobLauncherTestUtils.launchJob();
 		Path expectedFile = new ClassPathResource(EXPECTED).getFile().toPath();
 		Path actualFile = new FileSystemResource(ACTUAL).getFile().toPath();

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

@@ -21,7 +21,6 @@
 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.test.JobLauncherTestUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -46,8 +45,7 @@ public void setDataSource(DataSource dataSource) {
 	}
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		int before = JdbcTestUtils.countRowsInTable(jdbcTemplate, "BATCH_STAGING");
 		JobExecution execution = jobLauncherTestUtils.launchJob();
 		int after = JdbcTestUtils.countRowsInTable(jdbcTemplate, "BATCH_STAGING");

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

@@ -24,7 +24,6 @@
 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.item.ExecutionContext;
 import org.springframework.batch.item.ItemReader;
@@ -64,8 +63,7 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
 	 * Check the resulting credits correspond to inputs increased by fixed amount.
 	 */
 	@Test
-	void testUpdateCredit(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testUpdateCredit() throws Exception {
 		assertTrue(applicationContext.containsBeanDefinition("outputTestReader"),
 				"Define a prototype bean called 'outputTestReader' to check the output");
 

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

@@ -24,7 +24,6 @@
 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.item.ExecutionContext;
 import org.springframework.batch.item.ItemReader;
@@ -64,8 +63,7 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
 	 * Check the resulting credits correspond to inputs increased by fixed amount.
 	 */
 	@Test
-	void testUpdateCredit(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testUpdateCredit() throws Exception {
 		assertTrue(applicationContext.containsBeanDefinition("outputTestReader"),
 				"Define a prototype bean called 'outputTestReader' to check the output");
 

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

@@ -16,15 +16,13 @@
 
 package org.springframework.batch.sample;
 
-import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
 import org.junit.jupiter.api.Assertions;
 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.item.Chunk;
@@ -54,8 +52,7 @@ class RestartFileSampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void runTest(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void runTest() throws Exception {
 		JobParameters jobParameters = jobLauncherTestUtils.getUniqueJobParameters();
 
 		JobExecution je1 = jobLauncherTestUtils.launchJob(jobParameters);

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

@@ -21,7 +21,6 @@
 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.converter.DefaultJobParametersConverter;
 import org.springframework.batch.support.PropertiesConverter;
@@ -70,8 +69,7 @@ void onTearDown() {
 	 * @throws Exception
 	 */
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		int before = JdbcTestUtils.countRowsInTable(jdbcTemplate, "TRADE");
 
 		JobExecution jobExecution = runJobForRestartTest();

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

@@ -17,7 +17,6 @@
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.batch.core.Job;
 import org.springframework.batch.sample.domain.trade.internal.GeneratingTradeItemReader;
 import org.springframework.batch.sample.support.RetrySampleItemWriter;
 import org.springframework.batch.test.JobLauncherTestUtils;
@@ -48,8 +47,7 @@ class RetrySampleFunctionalTests {
 	private JobLauncherTestUtils jobLauncherTestUtils;
 
 	@Test
-	void testLaunchJob(@Autowired Job job) throws Exception {
-		this.jobLauncherTestUtils.setJob(job);
+	void testLaunchJob() throws Exception {
 		this.jobLauncherTestUtils.launchJob();
 		// items processed = items read + 2 exceptions
 		assertEquals(itemGenerator.getLimit() + 2, itemProcessor.getCounter());