在Spring Tests上禁用@EnableScheduling

Question

当我运行我的单元测试时,它会调用我的计划任务.我想防止这种行为,这是由我@EnableScheduling在主应用程序配置上的事实引起的.

如何在单元测试中禁用此功能？

我遇到过这个问题/答案,建议设置个人资料？

不确定我会怎么做？或者如果它有点矫枉过正？我正在考虑为我的单元测试使用单独的AppConfiguration,但是当我这样做时,感觉就像是重复代码两次？

@Configuration
@EnableJpaRepositories(AppConfiguration.DAO_PACKAGE)
@EnableTransactionManagement
@EnableScheduling
@ComponentScan({AppConfiguration.SERVICE_PACKAGE,
                AppConfiguration.DAO_PACKAGE,
                AppConfiguration.CLIENT_PACKAGE,
                AppConfiguration.SCHEDULE_PACKAGE})
public class AppConfiguration {

    static final    String MAIN_PACKAGE             = "com.etc.app-name";
    static final    String DAO_PACKAGE              = "com.etc.app-name.dao";
    private static  final  String ENTITIES_PACKAGE  = "com.etc.app-name.entity";
    static final    String SERVICE_PACKAGE          = "com.etc.app-name.service";
    static final    String CLIENT_PACKAGE           = "com.etc.app-name.client";
    static final    String SCHEDULE_PACKAGE         = "com.etc.app-name.scheduling";


    @Bean
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(){
       // stripped code for question readability
    }

    // more app config code below etc

}

单元测试示例.

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes={AppConfiguration.class})
@Transactional
@TransactionConfiguration(defaultRollback = true)
@WebAppConfiguration
public class ExampleDaoTest {

    @Autowired
    ExampleDao exampleDao;

    @Test
    public void testExampleDao() {
        List<Example> items = exampleDao.findAll();
        Assert.assertTrue(items.size()>0);
    }
}

Answer 1

如果您不想使用配置文件,则可以添加将启用/禁用应用程序调度的标志

在你的AppConfiguration添加中

  @ConditionalOnProperty(
     value = "app.scheduling.enable", havingValue = "true", matchIfMissing = true
  )
  @Configuration
  @EnableScheduling
  public static class SchedulingConfiguration {
  }

并在您的测试中添加此注释以禁用调度

@TestPropertySource(properties = "app.scheduling.enable=false")

Answer 2

使用 Spring Boot 和 cron 表达式，您可以启用或禁用调度。例如，您可以定义一个测试 application.yml 并设置

scheduler:
  cron-expr: '-'

另请参阅使用 '-' 禁用调度。在您的调度程序类中，您可以传递表达式。

@Scheduled(cron = "${scheduler.cron-expr}")

Answer 3

另一种方法是取消注册调度事件的bean后处理器.这可以通过简单地将以下类放在测试的类路径上来完成:

public class UnregisterScheduledProcessor implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(final ConfigurableListableBeanFactory beanFactory) throws BeansException {
        for (String beanName : beanFactory.getBeanNamesForType(ScheduledAnnotationBeanPostProcessor.class)) {
            ((DefaultListableBeanFactory)beanFactory).removeBeanDefinition(beanName);
        }
    }
}

虽然这很简单并且似乎可以完成这项工作,但要注意我没有对此进行过多测试或检查从注册表中删除已定义的bean或确保PostProcessors的排序不会成为问题的可能影响......

Answer 4

使用@MockBean.

@RunWith(SpringRunner.class)
@SpringBootTest
@MockBean(MyScheduledClass.class)
public class MyTest {

这最终将取代活动的预定作业或创建一个模拟作业。

从文档

模拟可以通过类型或通过 {@link #name() bean name} 注册。任何在上下文中定义的相同类型的现有单个 bean 都将被模拟替换，如果没有定义现有 bean，将添加一个新 bean。

Answer 5

我只是通过可配置的延迟时间参数化了我的@Scheduled注释:

@Scheduled(fixedRateString = "${timing.updateData}", initialDelayString = "${timing.initialDelay}")

在我的测试application.yaml中:

timing:
    updateData: 60000
    initialDelay: 10000000000

主要的应用程序.yaml:

timing:
    updateData: 60000
    initialDelay: 1

它并没有关闭它,而是造成如此长的延迟,测试将在它运行之前完成.不是最优雅的解决方案,但绝对是我发现的最简单的解决方案之一.

Answer 6

发现添加了

app.scheduling.enable=false

在测试 application.properties 中

@ConditionalOnProperty(value = "app.scheduling.enable", havingValue = "true", matchIfMissing = true)
@EnableScheduling

像Marko Vranjkovic 的答案一样调度配置类注释适用于所有测试，而无需对每个测试进行注释！