单元测试

与其他应用程序样式一样，对作为批处理作业一部分编写的任何代码进行单元测试非常重要。Spring 核心文档非常详细地介绍了如何使用 Spring 进行单元和集成测试，因此此处不再赘述。但是，重要的是考虑如何对批处理作业进行“端到端”测试，本章将介绍此内容。spring-batch-test 项目包含有助于这种端到端测试方法的类。

创建单元测试类

要让单元测试运行批处理作业，框架必须加载作业的 ApplicationContext。使用两个注解来触发此行为

  • @SpringJUnitConfig 表示该类应使用 Spring 的 JUnit 工具

  • @SpringBatchTest 在测试上下文中注入 Spring Batch 测试实用程序（例如 JobLauncherTestUtils 和 JobRepositoryTestUtils）

如果测试上下文包含单个 Job Bean 定义，则此 Bean 将在 JobLauncherTestUtils 中自动装配。否则，应在 JobLauncherTestUtils 上手动设置要测试的作业。

  • Java

  • XML

以下 Java 示例显示了正在使用的注解

使用 Java 配置
@SpringBatchTest
@SpringJUnitConfig(SkipSampleConfiguration.class)
public class SkipSampleFunctionalTests { ... }

以下 XML 示例显示了正在使用的注解

使用 XML 配置
@SpringBatchTest
@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                    "/jobs/skipSampleJob.xml" })
public class SkipSampleFunctionalTests { ... }

批处理作业的端到端测试

“端到端”测试可定义为测试批处理作业从头到尾的完整运行。这允许进行设置测试条件、执行作业和验证最终结果的测试。

考虑一个从数据库读取并写入平面文件的批处理作业示例。测试方法首先使用测试数据设置数据库。它清除 CUSTOMER 表，然后插入 10 条新记录。然后，测试使用 launchJob() 方法启动 Job。launchJob() 方法由 JobLauncherTestUtils 类提供。JobLauncherTestUtils 类还提供 launchJob(JobParameters) 方法，该方法允许测试提供特定参数。launchJob() 方法返回 JobExecution 对象，该对象可用于断言有关 Job 运行的特定信息。在以下情况下，测试验证 Job 以 COMPLETED 状态结束。

  • Java

  • XML

以下列表显示了 Java 配置样式中使用 JUnit 5 的示例

基于 Java 的配置
@SpringBatchTest
@SpringJUnitConfig(SkipSampleConfiguration.class)
public class SkipSampleFunctionalTests {

    @Autowired
    private JobLauncherTestUtils jobLauncherTestUtils;

    private JdbcTemplate jdbcTemplate;

    @Autowired
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Test
    public void testJob(@Autowired Job job) throws Exception {
        this.jobLauncherTestUtils.setJob(job);
        this.jdbcTemplate.update("delete from CUSTOMER");
        for (int i = 1; i <= 10; i++) {
            this.jdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
                                      i, "customer" + i);
        }

        JobExecution jobExecution = jobLauncherTestUtils.launchJob();


        Assert.assertEquals("COMPLETED", jobExecution.getExitStatus().getExitCode());
    }
}

以下列表显示了 XML 配置样式中使用 JUnit 5 的示例

基于 XML 的配置
@SpringBatchTest
@SpringJUnitConfig(locations = { "/simple-job-launcher-context.xml",
                                    "/jobs/skipSampleJob.xml" })
public class SkipSampleFunctionalTests {

    @Autowired
    private JobLauncherTestUtils jobLauncherTestUtils;

    private JdbcTemplate jdbcTemplate;

    @Autowired
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Test
    public void testJob(@Autowired Job job) throws Exception {
        this.jobLauncherTestUtils.setJob(job);
        this.jdbcTemplate.update("delete from CUSTOMER");
        for (int i = 1; i <= 10; i++) {
            this.jdbcTemplate.update("insert into CUSTOMER values (?, 0, ?, 100000)",
                                      i, "customer" + i);
        }

        JobExecution jobExecution = jobLauncherTestUtils.launchJob();


        Assert.assertEquals("COMPLETED", jobExecution.getExitStatus().getExitCode());
    }
}

测试各个步骤

对于复杂的批处理作业，端到端测试方法中的测试用例可能变得难以管理。在这些情况下，拥有测试用例来单独测试各个步骤可能更有用。JobLauncherTestUtils 类包含一个名为 launchStep 的方法，该方法采用步骤名称并仅运行该特定 Step。这种方法允许进行更有针对性的测试，让测试仅为该步骤设置数据并直接验证其结果。以下示例显示如何使用 launchStep 方法按名称加载 Step

JobExecution jobExecution = jobLauncherTestUtils.launchStep("loadFileStep");

测试按步骤划分的组件

通常，在运行时为步骤配置的组件使用步骤范围和延迟绑定来注入步骤或作业执行的上下文。这些组件很难作为独立组件进行测试，除非你有办法设置上下文，就像它们在步骤执行中一样。这是 Spring Batch 中两个组件的目标：StepScopeTestExecutionListener 和 StepScopeTestUtils。

监听器在类级别声明，其工作是为每个测试方法创建一个步骤执行上下文，如下例所示

@SpringJUnitConfig
@TestExecutionListeners( { DependencyInjectionTestExecutionListener.class,
    StepScopeTestExecutionListener.class })
public class StepScopeTestExecutionListenerIntegrationTests {

    // This component is defined step-scoped, so it cannot be injected unless
    // a step is active...
    @Autowired
    private ItemReader<String> reader;

    public StepExecution getStepExecution() {
        StepExecution execution = MetaDataInstanceFactory.createStepExecution();
        execution.getExecutionContext().putString("input.data", "foo,bar,spam");
        return execution;
    }

    @Test
    public void testReader() {
        // The reader is initialized and bound to the input data
        assertNotNull(reader.read());
    }

}

有两个 TestExecutionListeners。一个是常规的 Spring Test 框架，它处理从配置的应用程序上下文中进行依赖项注入以注入读取器。另一个是 Spring Batch StepScopeTestExecutionListener。它的工作原理是查找测试用例中用于 StepExecution 的工厂方法，并将其用作测试方法的上下文，就像该执行在运行时在 Step 中处于活动状态一样。工厂方法通过其签名检测（它必须返回 StepExecution）。如果未提供工厂方法，则会创建一个默认 StepExecution。

从 v4.1 开始，如果测试类使用 @SpringBatchTest 注释，则 StepScopeTestExecutionListener 和 JobScopeTestExecutionListener 将作为测试执行监听器导入。前面的测试示例可以配置如下

@SpringBatchTest
@SpringJUnitConfig
public class StepScopeTestExecutionListenerIntegrationTests {

    // This component is defined step-scoped, so it cannot be injected unless
    // a step is active...
    @Autowired
    private ItemReader<String> reader;

    public StepExecution getStepExecution() {
        StepExecution execution = MetaDataInstanceFactory.createStepExecution();
        execution.getExecutionContext().putString("input.data", "foo,bar,spam");
        return execution;
    }

    @Test
    public void testReader() {
        // The reader is initialized and bound to the input data
        assertNotNull(reader.read());
    }

}

如果你希望步骤范围的持续时间为测试方法的执行，则监听器方法很方便。对于更灵活但更具侵入性的方法，你可以使用 StepScopeTestUtils。以下示例计算上一个示例中显示的读取器中可用的项目数

int count = StepScopeTestUtils.doInStepScope(stepExecution,
    new Callable<Integer>() {
      public Integer call() throws Exception {

        int count = 0;

        while (reader.read() != null) {
           count++;
        }
        return count;
    }
});

验证输出文件

当批处理作业写入数据库时，可以轻松查询数据库以验证输出是否符合预期。但是，如果批处理作业写入文件，则同样重要的是验证输出。Spring Batch 提供了一个名为 AssertFile 的类，以方便验证输出文件。名为 assertFileEquals 的方法采用两个 File 对象（或两个 Resource 对象），并逐行断言这两个文件具有相同的内容。因此，可以创建一个包含预期输出的文件，并将其与实际结果进行比较，如下例所示

private static final String EXPECTED_FILE = "src/main/resources/data/input.txt";
private static final String OUTPUT_FILE = "target/test-outputs/output.txt";

AssertFile.assertFileEquals(new FileSystemResource(EXPECTED_FILE),
                            new FileSystemResource(OUTPUT_FILE));

模拟域对象

为 Spring Batch 组件编写单元和集成测试时遇到的另一个常见问题是如何模拟域对象。一个很好的例子是 StepExecutionListener，如下面的代码片段所示

public class NoWorkFoundStepExecutionListener extends StepExecutionListenerSupport {

    public ExitStatus afterStep(StepExecution stepExecution) {
        if (stepExecution.getReadCount() == 0) {
            return ExitStatus.FAILED;
        }
        return null;
    }
}

该框架提供了前面的监听器示例，并检查 StepExecution 是否为空读取计数，从而表示没有完成任何工作。虽然这个示例相当简单，但它有助于说明在尝试对实现需要 Spring Batch 域对象的接口的类进行单元测试时可能遇到的问题类型。考虑一下前面示例中监听器的以下单元测试

private NoWorkFoundStepExecutionListener tested = new NoWorkFoundStepExecutionListener();

@Test
public void noWork() {
    StepExecution stepExecution = new StepExecution("NoProcessingStep",
                new JobExecution(new JobInstance(1L, new JobParameters(),
                                 "NoProcessingJob")));

    stepExecution.setExitStatus(ExitStatus.COMPLETED);
    stepExecution.setReadCount(0);

    ExitStatus exitStatus = tested.afterStep(stepExecution);
    assertEquals(ExitStatus.FAILED.getExitCode(), exitStatus.getExitCode());
}

由于 Spring Batch 领域模型遵循良好的面向对象原则，StepExecution 需要 JobExecution，而 JobExecution 需要 JobInstance 和 JobParameters，才能创建有效的 StepExecution。虽然这在可靠的领域模型中很好，但确实会使为单元测试创建存根对象变得冗长。为了解决此问题，Spring Batch 测试模块包含用于创建领域对象的工厂：MetaDataInstanceFactory。给定此工厂，可以更新单元测试以使其更简洁，如下例所示

private NoWorkFoundStepExecutionListener tested = new NoWorkFoundStepExecutionListener();

@Test
public void testAfterStep() {
    StepExecution stepExecution = MetaDataInstanceFactory.createStepExecution();

    stepExecution.setExitStatus(ExitStatus.COMPLETED);
    stepExecution.setReadCount(0);

    ExitStatus exitStatus = tested.afterStep(stepExecution);
    assertEquals(ExitStatus.FAILED.getExitCode(), exitStatus.getExitCode());
}

用于创建简单 StepExecution 的上述方法只是工厂中可用的一个便利方法。您可以在其 Javadoc 中找到完整的方法列表。