Class JobOperatorTestUtils

java.lang.Object
org.springframework.batch.test.JobLauncherTestUtils
org.springframework.batch.test.JobOperatorTestUtils
public class JobOperatorTestUtils extends JobLauncherTestUtils

Utility class for testing batch jobs. It provides methods for starting an entire AbstractJob, allowing for end-to-end testing of individual steps, without having to run every step in the job. Any test classes using this utility can set up an instance in the ApplicationContext as part of the Spring test framework. The test context must contain batch infrastructure beans (ie a JobRepository and a JobOperator) as well as the job under test. The job under test will be autowired into this utility.

This class also provides the ability to run Steps individually from a SimpleJob FlowJob. By starting Steps within a Job on their own, end-to-end testing of individual steps can be performed without having to run every step in the job.

It should be noted that using any of the methods that don't contain JobParameters in their signature, will result in one being created with a random number of type long as a parameter with the name batch.random. This will ensure restartability when no parameters are provided.

Since:
6.0
Author:
Mahmoud Ben Hassine

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_NAME
    Name of the single-step job surrounding steps when tested individually
    protected org.springframework.batch.core.launch.JobOperator
    jobOperator
     

    Fields inherited from class JobLauncherTestUtils

    job, jobLauncher, jobRepository, logger, secureRandom, stepRunner

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobOperatorTestUtils(org.springframework.batch.core.launch.JobOperator jobOperator, org.springframework.batch.core.repository.JobRepository jobRepository)
    Create a new instance of JobOperatorTestUtils with the provided job repository and job operator.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.batch.core.job.Job
    getJob()
    Get the job that can be operated by this utility.
    org.springframework.batch.core.launch.JobOperator
    getJobOperator()
    Get the job operator used by this utility.
    org.springframework.batch.core.repository.JobRepository
    getJobRepository()
    Get the job repository used by this utility.
    org.springframework.batch.core.job.parameters.JobParameters
    getUniqueJobParameters()
     
    org.springframework.batch.core.job.parameters.JobParametersBuilder
    getUniqueJobParametersBuilder()
     
    void
    setJob(org.springframework.batch.core.job.Job job)
    Set the job that can be operated by this utility.
    void
    setJobOperator(org.springframework.batch.core.launch.JobOperator jobOperator)
    Set the job operator to be used by this utility.
    void
    setJobRepository(org.springframework.batch.core.repository.JobRepository jobRepository)
    Set the job repository to be used by this utility.
    org.springframework.batch.core.job.JobExecution
    startJob()
    Start the entire job, including all steps, with a set of unique random job parameters.
    org.springframework.batch.core.job.JobExecution
    startJob(org.springframework.batch.core.job.parameters.JobParameters jobParameters)
    Start the entire job, including all steps, with the provided set of job parameters.
    org.springframework.batch.core.job.JobExecution
    startStep(String stepName)
    Start just the specified step in a surrounding single-step job of type SimpleJob named JOB_NAME.
    org.springframework.batch.core.job.JobExecution
    startStep(String stepName, org.springframework.batch.core.job.parameters.JobParameters jobParameters, org.springframework.batch.infrastructure.item.ExecutionContext jobExecutionContext)
    Extract the step from the injected job and start it in a surrounding single-step job of type SimpleJob named JOB_NAME.
    org.springframework.batch.core.job.JobExecution
    startStep(org.springframework.batch.core.step.Step step)
    Start just the specified step with a unique set of job parameters in a surrounding single-step job of type SimpleJob named StepRunner.JOB_NAME.
    org.springframework.batch.core.job.JobExecution
    startStep(org.springframework.batch.core.step.Step step, org.springframework.batch.core.job.parameters.JobParameters jobParameters, org.springframework.batch.infrastructure.item.ExecutionContext jobExecutionContext)
    Start just the specified step in a surrounding single-step job of type SimpleJob named StepRunner.JOB_NAME.

    Methods inherited from class JobLauncherTestUtils

    getJobLauncher, getStepRunner, launchJob, launchJob, launchStep, launchStep, launchStep, launchStep, setJobLauncher

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • JOB_NAME

      public static final String JOB_NAME
      Name of the single-step job surrounding steps when tested individually
      See Also:

    • jobOperator

      protected org.springframework.batch.core.launch.JobOperator jobOperator

  • Constructor Details

    • JobOperatorTestUtils

      public JobOperatorTestUtils(org.springframework.batch.core.launch.JobOperator jobOperator, org.springframework.batch.core.repository.JobRepository jobRepository)
      Create a new instance of JobOperatorTestUtils with the provided job repository and job operator.
      Parameters:
      jobOperator - to use to start jobs and steps
      jobRepository - to use to access job metadata

  • Method Details

    • setJob

      public void setJob(org.springframework.batch.core.job.Job job)
      Set the job that can be operated by this utility.
      Overrides:
      setJob in class JobLauncherTestUtils
      Parameters:
      job - the job to test

    • getJob

      public org.springframework.batch.core.job.Job getJob()
      Get the job that can be operated by this utility.
      Overrides:
      getJob in class JobLauncherTestUtils
      Returns:
      the job under test

    • setJobOperator

      public void setJobOperator(org.springframework.batch.core.launch.JobOperator jobOperator)
      Set the job operator to be used by this utility.
      Parameters:
      jobOperator - the job operator to use to start jobs and steps

    • getJobOperator

      public org.springframework.batch.core.launch.JobOperator getJobOperator()
      Get the job operator used by this utility.
      Returns:
      the job operator

    • setJobRepository

      public void setJobRepository(org.springframework.batch.core.repository.JobRepository jobRepository)
      Set the job repository to be used by this utility.
      Overrides:
      setJobRepository in class JobLauncherTestUtils
      Parameters:
      jobRepository - the job repository to use to access job metadata

    • getJobRepository

      public org.springframework.batch.core.repository.JobRepository getJobRepository()
      Get the job repository used by this utility.
      Overrides:
      getJobRepository in class JobLauncherTestUtils
      Returns:
      the job repository

    • startJob

      public org.springframework.batch.core.job.JobExecution startJob() throws Exception
      Start the entire job, including all steps, with a set of unique random job parameters.
      Returns:
      JobExecution, so that the test can validate the exit status
      Throws:
      Exception - thrown if error occurs launching the job.

    • startJob

      public org.springframework.batch.core.job.JobExecution startJob(org.springframework.batch.core.job.parameters.JobParameters jobParameters) throws Exception
      Start the entire job, including all steps, with the provided set of job parameters.
      Parameters:
      jobParameters - instance of JobParameters.
      Returns:
      JobExecution, so that the test can validate the exit status
      Throws:
      Exception - thrown if error occurs launching the job.

    • startStep

      public org.springframework.batch.core.job.JobExecution startStep(String stepName)
      Start just the specified step in a surrounding single-step job of type SimpleJob named JOB_NAME. A unique set of JobParameters will automatically be generated. An IllegalStateException is thrown if there is no Step with the given name.
      Parameters:
      stepName - The name of the step to launch
      Returns:
      JobExecution

    • startStep

      public org.springframework.batch.core.job.JobExecution startStep(String stepName, org.springframework.batch.core.job.parameters.JobParameters jobParameters, org.springframework.batch.infrastructure.item.ExecutionContext jobExecutionContext)
      Extract the step from the injected job and start it in a surrounding single-step job of type SimpleJob named JOB_NAME. An IllegalStateException is thrown if there is no Step with the given name.
      Parameters:
      stepName - The name of the step to start
      jobParameters - The JobParameters to use during the start
      jobExecutionContext - An ExecutionContext whose values will be loaded into the Job ExecutionContext before starting the step.
      Returns:
      JobExecution

    • startStep

      public org.springframework.batch.core.job.JobExecution startStep(org.springframework.batch.core.step.Step step)
      Start just the specified step with a unique set of job parameters in a surrounding single-step job of type SimpleJob named StepRunner.JOB_NAME. An IllegalStateException is thrown if there is no Step with the given name.
      Parameters:
      step - The step to start
      Returns:
      JobExecution

    • startStep

      public org.springframework.batch.core.job.JobExecution startStep(org.springframework.batch.core.step.Step step, org.springframework.batch.core.job.parameters.JobParameters jobParameters, org.springframework.batch.infrastructure.item.ExecutionContext jobExecutionContext)
      Start just the specified step in a surrounding single-step job of type SimpleJob named StepRunner.JOB_NAME. An IllegalStateException is thrown if there is no Step with the given name.
      Parameters:
      step - The step to start
      jobParameters - The JobParameters to use during the start
      jobExecutionContext - An ExecutionContext whose values will be loaded into the Job ExecutionContext before starting the step.
      Returns:
      JobExecution

    • getUniqueJobParameters

      public org.springframework.batch.core.job.parameters.JobParameters getUniqueJobParameters()
      Overrides:
      getUniqueJobParameters in class JobLauncherTestUtils
      Returns:
      a new JobParameters object containing only one parameter named batch.random with a random number of type long, to ensure that the job instance will be unique.

    • getUniqueJobParametersBuilder

      public org.springframework.batch.core.job.parameters.JobParametersBuilder getUniqueJobParametersBuilder()
      Overrides:
      getUniqueJobParametersBuilder in class JobLauncherTestUtils
      Returns:
      a new JobParametersBuilder object containing only one parameter named batch.random with a random number of type long, to ensure that the job instance will be unique.