Add getJobInstance method in JobExplorer/JobRepository

Resolves #3930

Author: parikshitdutta

spring-batch-core/src/main/java/org/springframework/batch/core/explore/JobExplorer.java

@@ -20,6 +20,7 @@
 
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.core.JobInstance;
+import org.springframework.batch.core.JobParameters;
 import org.springframework.batch.core.StepExecution;
 import org.springframework.batch.core.launch.NoSuchJobException;
 import org.springframework.batch.item.ExecutionContext;
@@ -34,6 +35,7 @@
  * @author Michael Minella
  * @author Will Schipp
  * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
  * @since 2.0
  */
 public interface JobExplorer {
@@ -92,6 +94,16 @@ default JobInstance getLastJobInstance(String jobName) {
 	@Nullable
 	JobInstance getJobInstance(@Nullable Long instanceId);
 
+	/**
+	 * @param jobName {@link String} name for the jobInstance.
+	 * @param jobParameters {@link JobParameters} parameters for the jobInstance.
+	 * @return the {@link JobInstance} with this name and parameters, or null
+	 *
+	 * @since 5.0
+	 */
+	@Nullable
+	JobInstance getJobInstance(String jobName, JobParameters jobParameters);
+
 	/**
 	 * Retrieve job executions by their job instance. The corresponding step executions
 	 * may not be fully hydrated (for example, their execution context may be missing),

spring-batch-core/src/main/java/org/springframework/batch/core/explore/support/SimpleJobExplorer.java

@@ -18,6 +18,7 @@
 
 import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.core.JobInstance;
+import org.springframework.batch.core.JobParameters;
 import org.springframework.batch.core.StepExecution;
 import org.springframework.batch.core.explore.JobExplorer;
 import org.springframework.batch.core.launch.NoSuchJobException;
@@ -38,6 +39,8 @@
  * @author Michael Minella
  * @author Will Schipp
  * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
+ *
  * @see JobExplorer
  * @see JobInstanceDao
  * @see JobExecutionDao
@@ -185,6 +188,19 @@ public JobInstance getJobInstance(@Nullable Long instanceId) {
 		return jobInstanceDao.getJobInstance(instanceId);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 *
+	 * @see
+	 * org.springframework.batch.core.explore.JobExplorer#getJobInstance(java
+	 * .lang.String, org.springframework.batch.core.JobParameters)
+	 */
+	@Nullable
+	@Override
+	public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+		return jobInstanceDao.getJobInstance(jobName, jobParameters);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 *

spring-batch-core/src/main/java/org/springframework/batch/core/repository/JobRepository.java

@@ -46,6 +46,7 @@
  * @author David Turanski
  * @author Michael Minella
  * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
  */
 public interface JobRepository {
 
@@ -186,6 +187,16 @@ JobExecution createJobExecution(String jobName, JobParameters jobParameters)
 	 */
 	void updateExecutionContext(JobExecution jobExecution);
 
+	/**
+	 * @param jobName {@link String} the name of the jobInstance
+	 * @param jobParameters {@link JobParameters} parameters identifying the {@link JobInstance}
+	 * @return the {@link JobInstance} with name and parameters, or null
+	 *
+	 * @since 5.0
+	 */
+	@Nullable
+	JobInstance getJobInstance(String jobName, JobParameters jobParameters);
+
 	/**
 	 * @param jobInstance {@link JobInstance} instance containing the step executions.
 	 * @param stepName the name of the step execution that might have run.

spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/SimpleJobRepository.java

@@ -53,6 +53,8 @@
  * @author David Turanski
  * @author Mahmoud Ben Hassine
  * @author Baris Cubukcuoglu
+ * @author Parikshit Dutta
+ *
  * @see JobRepository
  * @see JobInstanceDao
  * @see JobExecutionDao
@@ -244,6 +246,11 @@ public void updateExecutionContext(JobExecution jobExecution) {
 		ecDao.updateExecutionContext(jobExecution);
 	}
 
+	@Override
+	public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+		return jobInstanceDao.getJobInstance(jobName, jobParameters);
+	}
+
 	@Override
 	@Nullable
 	public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) {

spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/DummyJobRepository.java

@@ -32,6 +32,8 @@
  * @author Dan Garrette
  * @author David Turanski
  * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
+ *
  * @since 2.0.1
  */
 public class DummyJobRepository implements JobRepository, BeanNameAware {
@@ -57,6 +59,12 @@ public JobExecution createJobExecution(String jobName, JobParameters jobParamete
 		return null;
 	}
 
+	@Nullable
+	@Override
+	public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+		return null;
+	}
+
 	@Nullable
 	@Override
 	public JobExecution getLastJobExecution(String jobName, JobParameters jobParameters) {

spring-batch-core/src/test/java/org/springframework/batch/core/explore/support/SimpleJobExplorerTests.java

@@ -19,6 +19,10 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -44,7 +48,7 @@
  * @author Will Schipp
  * @author Michael Minella
  * @author Mahmoud Ben Hassine
- *
+ * @author Parikshit Dutta
  */
 class SimpleJobExplorerTests {
 
@@ -150,6 +154,14 @@ void testGetJobInstance() {
 		jobExplorer.getJobInstance(111L);
 	}
 
+	@Test
+	public void testGetJobInstanceWithNameAndParameters() throws Exception {
+		when(jobInstanceDao.getJobInstance("job", new JobParameters())).thenReturn(jobInstance);
+		JobInstance jobInstance = jobExplorer.getJobInstance("job", new JobParameters());
+		verify(jobInstanceDao).getJobInstance(anyString(), any(JobParameters.class));
+		assertEquals(jobInstance, jobInstance);
+	}
+
 	@Test
 	void testGetLastJobInstances() {
 		jobInstanceDao.getJobInstances("foo", 0, 1);

spring-batch-core/src/test/java/org/springframework/batch/core/launch/support/CommandLineJobRunnerTests.java

@@ -55,7 +55,7 @@
 /**
  * @author Lucas Ward
  * @author Mahmoud Ben Hassine
- *
+ * @author Parikshit Dutta
  */
 class CommandLineJobRunnerTests {
 
@@ -515,6 +515,12 @@ public JobInstance getJobInstance(@Nullable Long instanceId) {
 			throw new UnsupportedOperationException();
 		}
 
+		@Nullable
+		@Override
+		public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+			throw new UnsupportedOperationException();
+		}
+
 		@Nullable
 		@Override
 		public JobInstance getLastJobInstance(String jobName) {

spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/SimpleJobRepositoryTests.java

@@ -21,6 +21,8 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -60,6 +62,7 @@
  * @author Dimitrios Liapis
  * @author Baris Cubukcuoglu
  * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
  *
  */
 class SimpleJobRepositoryTests {
@@ -329,4 +332,12 @@ public void testUpgradeStopping() {
 		assertEquals(BatchStatus.STOPPED, jobExecution.getStatus());
 	}
 
+
+	@Test
+	public void testGetJobInstanceWithNameAndParameters() throws Exception {
+		when(jobInstanceDao.getJobInstance("job", new JobParameters())).thenReturn(jobInstance);
+		JobInstance jobInstance = jobRepository.getJobInstance("job", new JobParameters());
+		verify(jobInstanceDao).getJobInstance(anyString(), any(JobParameters.class));
+		assertEquals(jobInstance, jobInstance);
+	}
 }

spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java

@@ -28,7 +28,7 @@
  * @author Dave Syer
  * @author David Turanski
  * @author Mahmoud Ben Hassine
- *
+ * @author Parikshit Dutta
  */
 public class JobRepositorySupport implements JobRepository {
 
@@ -66,6 +66,12 @@ public void update(JobExecution jobExecution) {
 	public void update(JobInstance job) {
 	}
 
+	@Nullable
+	@Override
+	public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+		return null;
+	}
+
 	@Nullable
 	@Override
 	public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) {

spring-batch-core/src/test/java/org/springframework/batch/core/step/item/TaskletStepExceptionTests.java

@@ -62,7 +62,7 @@
  * @author Dave Syer
  * @author David Turanski
  * @author Mahmoud Ben Hassine
- *
+ * @author Parikshit Dutta
  */
 class TaskletStepExceptionTests {
 
@@ -520,6 +520,12 @@ public JobExecution createJobExecution(String jobName, JobParameters jobParamete
 			return null;
 		}
 
+		@Nullable
+		@Override
+		public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+			return null;
+		}
+
 		@Nullable
 		@Override
 		public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) {

spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java

@@ -30,7 +30,7 @@
 /**
  * @author Dave Syer
  * @author Mahmoud Ben Hassine
- *
+ * @author Parikshit Dutta
  */
 public class JobRepositorySupport implements JobRepository {
 
@@ -48,6 +48,14 @@ public JobExecution createJobExecution(String jobName, JobParameters jobParamete
 
 	/*
 	 * (non-Javadoc)
+	 * @see org.springframework.batch.core.repository.JobRepository#getJobInstance(java.lang.String,
+	 * org.springframework.batch.core.JobParameters)
+	 */
+	public JobInstance getJobInstance(String jobName, JobParameters jobParameters) {
+		return null;
+	}
+
+	/* (non-Javadoc)
 	 *
 	 * @see
 	 * org.springframework.batch.core.repository.JobRepository#getLastStepExecution(org.