Polish "Add Quartz Scheduler support"

Closes gh-4299

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/JobStoreType.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2012-2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.quartz;
+
+/**
+ * Define the supported Quartz {@code JobStore}.
+ *
+ * @author Stephane Nicoll
+ * @since 2.0.0
+ */
+public enum JobStoreType {
+
+	/**
+	 * Store jobs in memory.
+	 */
+	MEMORY,
+
+	/**
+	 * Store jobs in the database.
+	 */
+	JDBC
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/QuartzAutoConfiguration.java

@@ -28,21 +28,18 @@ import org.quartz.JobDetail;
 import org.quartz.Scheduler;
 import org.quartz.Trigger;
 
-import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.scheduling.quartz.SchedulerFactoryBean;
 import org.springframework.transaction.PlatformTransactionManager;
@@ -51,6 +48,7 @@ import org.springframework.transaction.PlatformTransactionManager;
  * {@link EnableAutoConfiguration Auto-configuration} for Quartz Scheduler.
  *
  * @author Vedran Pavic
+ * @author Stephane Nicoll
  * @since 2.0.0
  */
 @Configuration
@@ -59,7 +57,7 @@ import org.springframework.transaction.PlatformTransactionManager;
 @EnableConfigurationProperties(QuartzProperties.class)
 @AutoConfigureAfter({ DataSourceAutoConfiguration.class,
 		HibernateJpaAutoConfiguration.class })
-public class QuartzAutoConfiguration implements ApplicationContextAware {
+public class QuartzAutoConfiguration {
 
 	private final QuartzProperties properties;
 
@@ -73,23 +71,25 @@ public class QuartzAutoConfiguration implements ApplicationContextAware {
 
 	private final Trigger[] triggers;
 
-	private ApplicationContext applicationContext;
+	private final ApplicationContext applicationContext;
 
 	public QuartzAutoConfiguration(QuartzProperties properties,
 			ObjectProvider<List<SchedulerFactoryBeanCustomizer>> customizers,
 			ObjectProvider<Executor> taskExecutor, ObjectProvider<JobDetail[]> jobDetails,
 			ObjectProvider<Map<String, Calendar>> calendars,
-			ObjectProvider<Trigger[]> triggers) {
+			ObjectProvider<Trigger[]> triggers,
+			ApplicationContext applicationContext) {
 		this.properties = properties;
 		this.customizers = customizers.getIfAvailable();
 		this.taskExecutor = taskExecutor.getIfAvailable();
 		this.jobDetails = jobDetails.getIfAvailable();
 		this.calendars = calendars.getIfAvailable();
 		this.triggers = triggers.getIfAvailable();
+		this.applicationContext = applicationContext;
 	}
 
 	@Bean
-	@ConditionalOnBean(DataSource.class)
+	@ConditionalOnSingleCandidate(DataSource.class)
 	@ConditionalOnMissingBean
 	public QuartzDatabaseInitializer quartzDatabaseInitializer(DataSource dataSource,
 			ResourceLoader resourceLoader) {
@@ -98,7 +98,7 @@ public class QuartzAutoConfiguration implements ApplicationContextAware {
 
 	@Bean
 	@ConditionalOnMissingBean
-	public SchedulerFactoryBean schedulerFactoryBean() {
+	public SchedulerFactoryBean quartzScheduler() {
 		SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
 		schedulerFactoryBean.setJobFactory(new AutowireCapableBeanJobFactory(
 				this.applicationContext.getAutowireCapableBeanFactory()));
@@ -122,12 +122,6 @@ public class QuartzAutoConfiguration implements ApplicationContextAware {
 		return schedulerFactoryBean;
 	}
 
-	@Override
-	public void setApplicationContext(ApplicationContext applicationContext)
-			throws BeansException {
-		this.applicationContext = applicationContext;
-	}
-
 	private Properties asProperties(Map<String, String> source) {
 		Properties properties = new Properties();
 		properties.putAll(source);
@@ -136,7 +130,6 @@ public class QuartzAutoConfiguration implements ApplicationContextAware {
 
 	private void customize(SchedulerFactoryBean schedulerFactoryBean) {
 		if (this.customizers != null) {
-			AnnotationAwareOrderComparator.sort(this.customizers);
 			for (SchedulerFactoryBeanCustomizer customizer : this.customizers) {
 				customizer.customize(schedulerFactoryBean);
 			}
@@ -144,15 +137,22 @@ public class QuartzAutoConfiguration implements ApplicationContextAware {
 	}
 
 	@Configuration
-	@ConditionalOnBean(DataSource.class)
-	protected static class QuartzSchedulerDataSourceConfiguration {
+	@ConditionalOnSingleCandidate(DataSource.class)
+	protected static class JdbcStoreTypeConfiguration {
 
 		@Bean
-		public SchedulerFactoryBeanCustomizer dataSourceCustomizer(DataSource dataSource,
-				PlatformTransactionManager transactionManager) {
+		public SchedulerFactoryBeanCustomizer dataSourceCustomizer(
+				QuartzProperties properties, DataSource dataSource,
+				ObjectProvider<PlatformTransactionManager> transactionManager) {
 			return schedulerFactoryBean -> {
-				schedulerFactoryBean.setDataSource(dataSource);
-				schedulerFactoryBean.setTransactionManager(transactionManager);
+				if (properties.getJobStoreType() == JobStoreType.JDBC) {
+					schedulerFactoryBean.setDataSource(dataSource);
+					PlatformTransactionManager txManager =
+							transactionManager.getIfUnique();
+					if (txManager != null) {
+						schedulerFactoryBean.setTransactionManager(txManager);
+					}
+				}
 			};
 		}
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/QuartzDatabaseInitializer.java

@@ -41,12 +41,12 @@ public class QuartzDatabaseInitializer extends AbstractDatabaseInitializer {
 
 	@Override
 	protected boolean isEnabled() {
-		return this.properties.getInitializer().isEnabled();
+		return this.properties.getJdbc().isInitializeSchema();
 	}
 
 	@Override
 	protected String getSchemaLocation() {
-		return this.properties.getSchema();
+		return this.properties.getJdbc().getSchema();
 	}
 
 	@Override

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/QuartzProperties.java

@@ -25,60 +25,69 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
  * Configuration properties for the Quartz Scheduler integration.
  *
  * @author Vedran Pavic
+ * @author Stephane Nicoll
  * @since 2.0.0
  */
 @ConfigurationProperties("spring.quartz")
 public class QuartzProperties {
 
-	private static final String DEFAULT_SCHEMA_LOCATION = "classpath:org/quartz/impl/"
-			+ "jdbcjobstore/tables_@@platform@@.sql";
-
-	private final Initializer initializer = new Initializer();
+	/**
+	 * Quartz job store type.
+	 */
+	private JobStoreType jobStoreType = JobStoreType.MEMORY;
 
 	/**
 	 * Additional Quartz Scheduler properties.
 	 */
-	private Map<String, String> properties = new HashMap<>();
+	private final Map<String, String> properties = new HashMap<>();
 
-	/**
-	 * Path to the SQL file to use to initialize the database schema.
-	 */
-	private String schema = DEFAULT_SCHEMA_LOCATION;
+	private final Jdbc jdbc = new Jdbc();
 
-	public Initializer getInitializer() {
-		return this.initializer;
+	public JobStoreType getJobStoreType() {
+		return this.jobStoreType;
+	}
+
+	public void setJobStoreType(JobStoreType jobStoreType) {
+		this.jobStoreType = jobStoreType;
 	}
 
 	public Map<String, String> getProperties() {
 		return this.properties;
 	}
 
-	public void setProperties(Map<String, String> properties) {
-		this.properties = properties;
+	public Jdbc getJdbc() {
+		return this.jdbc;
 	}
 
-	public String getSchema() {
-		return this.schema;
-	}
+	public static class Jdbc {
 
-	public void setSchema(String schema) {
-		this.schema = schema;
-	}
-
-	public class Initializer {
+		private static final String DEFAULT_SCHEMA_LOCATION = "classpath:org/quartz/impl/"
+				+ "jdbcjobstore/tables_@@platform@@.sql";
 
 		/**
-		 * Create the required Quartz Scheduler tables on startup if necessary. Enabled
-		 * automatically if the schema is configured.
+		 * Path to the SQL file to use to initialize the database schema.
 		 */
-		private boolean enabled = true;
+		private String schema = DEFAULT_SCHEMA_LOCATION;
 
-		public boolean isEnabled() {
-			return this.enabled && QuartzProperties.this.getSchema() != null;
+		/**
+		 * Create the required Quartz Scheduler tables on startup.
+		 */
+		private boolean initializeSchema;
+
+		public String getSchema() {
+			return this.schema;
 		}
 
-		public void setEnabled(boolean enabled) {
-			this.enabled = enabled;
+		public void setSchema(String schema) {
+			this.schema = schema;
+		}
+
+		public boolean isInitializeSchema() {
+			return this.initializeSchema;
+		}
+
+		public void setInitializeSchema(boolean initializeSchema) {
+			this.initializeSchema = initializeSchema;
 		}
 
 	}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/SchedulerFactoryBeanCustomizer.java

@@ -28,6 +28,10 @@ import org.springframework.scheduling.quartz.SchedulerFactoryBean;
  */
 public interface SchedulerFactoryBeanCustomizer {
 
+	/**
+	 * Customize the {@link SchedulerFactoryBean}.
+	 * @param schedulerFactoryBean the scheduler to customize
+	 */
 	void customize(SchedulerFactoryBean schedulerFactoryBean);
 
 }

spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -357,6 +357,10 @@
     "name": "spring.mvc.locale-resolver",
     "defaultValue": "accept-header"
   },
+  {
+    "name": "spring.quartz.job-store-type",
+    "defaultValue": "memory"
+  },
   {
     "name": "spring.rabbitmq.cache.connection.mode",
     "defaultValue": "channel"

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/quartz/QuartzAutoConfigurationTests.java

@@ -19,6 +19,8 @@ package org.springframework.boot.autoconfigure.quartz;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 
+import javax.sql.DataSource;
+
 import org.junit.After;
 import org.junit.Rule;
 import org.junit.Test;
@@ -30,6 +32,7 @@ import org.quartz.JobExecutionContext;
 import org.quartz.JobExecutionException;
 import org.quartz.JobKey;
 import org.quartz.Scheduler;
+import org.quartz.SchedulerException;
 import org.quartz.SimpleScheduleBuilder;
 import org.quartz.Trigger;
 import org.quartz.TriggerBuilder;
@@ -43,13 +46,16 @@ import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerA
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
 import org.springframework.boot.test.rule.OutputCapture;
 import org.springframework.boot.test.util.TestPropertyValues;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
+import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.scheduling.quartz.LocalDataSourceJobStore;
 import org.springframework.scheduling.quartz.LocalTaskExecutorThreadPool;
 import org.springframework.scheduling.quartz.QuartzJobBean;
+import org.springframework.util.ObjectUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hamcrest.CoreMatchers.containsString;
@@ -58,6 +64,7 @@ import static org.hamcrest.CoreMatchers.containsString;
  * Tests for {@link QuartzAutoConfiguration}.
  *
  * @author Vedran Pavic
+ * @author Stephane Nicoll
  */
 public class QuartzAutoConfigurationTests {
 
@@ -67,7 +74,7 @@ public class QuartzAutoConfigurationTests {
 	@Rule
 	public OutputCapture output = new OutputCapture();
 
-	private AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
+	private ConfigurableApplicationContext context;
 
 	@After
 	public void closeContext() {
@@ -77,89 +84,123 @@ public class QuartzAutoConfigurationTests {
 	}
 
 	@Test
-	public void withDatabase() throws Exception {
-		registerAndRefresh(EmbeddedDataSourceConfiguration.class,
-				DataSourceTransactionManagerAutoConfiguration.class,
-				QuartzAutoConfiguration.class);
+	public void withNoDataSource() throws Exception {
+		load();
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
-		assertThat(scheduler).isNotNull();
-		assertThat(scheduler.getMetaData().getJobStoreClass())
-				.isAssignableFrom(LocalDataSourceJobStore.class);
-	}
-
-	@Test
-	public void withNoDatabase() throws Exception {
-		registerAndRefresh(QuartzAutoConfiguration.class);
-		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
-		assertThat(scheduler).isNotNull();
 		assertThat(scheduler.getMetaData().getJobStoreClass())
 				.isAssignableFrom(RAMJobStore.class);
 	}
 
 	@Test
-	public void withTaskExecutor() throws Exception {
-		registerAndRefresh(QuartzAutoConfiguration.class,
-				QuartzExecutorConfiguration.class);
+	public void withDataSourceUseMemoryByDefault() throws Exception {
+		load(new Class<?>[] { EmbeddedDataSourceConfiguration.class,
+				DataSourceTransactionManagerAutoConfiguration.class });
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
+		assertThat(scheduler.getMetaData().getJobStoreClass())
+				.isAssignableFrom(RAMJobStore.class);
+	}
 
-		assertThat(scheduler).isNotNull();
+	@Test
+	public void withDataSource() throws Exception {
+		load(new Class<?>[] { QuartzJobsConfiguration.class,
+						EmbeddedDataSourceConfiguration.class,
+						DataSourceTransactionManagerAutoConfiguration.class },
+				"spring.quartz.job-store-type=jdbc",
+				"spring.quartz.jdbc.initialize-schema=true");
+		testWithDataSource();
+	}
+
+	@Test
+	public void withDataSourceNoTransactionManager() throws Exception {
+		load(new Class<?>[] { QuartzJobsConfiguration.class,
+						EmbeddedDataSourceConfiguration.class },
+				"spring.quartz.job-store-type=jdbc",
+				"spring.quartz.jdbc.initialize-schema=true");
+		testWithDataSource();
+	}
+
+	private void testWithDataSource() throws SchedulerException {
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
+		Scheduler scheduler = this.context.getBean(Scheduler.class);
+		assertThat(scheduler.getMetaData().getJobStoreClass())
+				.isAssignableFrom(LocalDataSourceJobStore.class);
+		JdbcTemplate jdbcTemplate = new JdbcTemplate(
+				this.context.getBean(DataSource.class));
+		assertThat(jdbcTemplate.queryForObject("SELECT COUNT(*) FROM QRTZ_JOB_DETAILS",
+				Integer.class)).isEqualTo(2);
+		assertThat(jdbcTemplate.queryForObject("SELECT COUNT(*) FROM QRTZ_SIMPLE_TRIGGERS",
+				Integer.class)).isEqualTo(0);
+	}
+
+	@Test
+	public void withTaskExecutor() throws Exception {
+		load(QuartzExecutorConfiguration.class);
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
+		Scheduler scheduler = this.context.getBean(Scheduler.class);
 		assertThat(scheduler.getMetaData().getThreadPoolClass())
 				.isEqualTo(LocalTaskExecutorThreadPool.class);
 	}
 
 	@Test
 	public void withConfiguredJobAndTrigger() throws Exception {
-		TestPropertyValues.of("test-name=withConfiguredJobAndTrigger")
-				.applyTo(this.context);
-		registerAndRefresh(QuartzAutoConfiguration.class, QuartzJobConfiguration.class);
+		load(QuartzFullConfiguration.class, "test-name=withConfiguredJobAndTrigger");
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
 		assertThat(scheduler.getJobDetail(JobKey.jobKey("fooJob"))).isNotNull();
 		assertThat(scheduler.getTrigger(TriggerKey.triggerKey("fooTrigger"))).isNotNull();
 		Thread.sleep(1000L);
 		this.output.expect(containsString("withConfiguredJobAndTrigger"));
+		this.output.expect(containsString("jobDataValue"));
 	}
 
 	@Test
 	public void withConfiguredCalendars() throws Exception {
-		registerAndRefresh(QuartzAutoConfiguration.class,
-				QuartzCalendarsConfiguration.class);
+		load(QuartzCalendarsConfiguration.class);
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
 		assertThat(scheduler.getCalendar("weekly")).isNotNull();
 		assertThat(scheduler.getCalendar("monthly")).isNotNull();
 	}
 
 	@Test
 	public void withQuartzProperties() throws Exception {
-		TestPropertyValues
-				.of("spring.quartz.properties.org.quartz.scheduler.instanceId=FOO")
-				.applyTo(this.context);
-		registerAndRefresh(QuartzAutoConfiguration.class);
+		load("spring.quartz.properties.org.quartz.scheduler.instanceId=FOO");
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
-		assertThat(scheduler).isNotNull();
 		assertThat(scheduler.getSchedulerInstanceId()).isEqualTo("FOO");
 	}
 
 	@Test
 	public void withCustomizer() throws Exception {
-		registerAndRefresh(QuartzAutoConfiguration.class, QuartzCustomConfig.class);
+		load(QuartzCustomConfig.class);
+		assertThat(this.context.getBeansOfType(Scheduler.class)).hasSize(1);
 		Scheduler scheduler = this.context.getBean(Scheduler.class);
-
-		assertThat(scheduler).isNotNull();
 		assertThat(scheduler.getSchedulerName()).isEqualTo("fooScheduler");
 	}
 
-	private void registerAndRefresh(Class<?>... annotatedClasses) {
-		this.context.register(annotatedClasses);
-		this.context.refresh();
+	private void load(String... environment) {
+		load(new Class<?>[0], environment);
+	}
+
+	private void load(Class<?> config, String... environment) {
+		load(new Class<?>[] { config }, environment);
+	}
+
+	private void load(Class<?>[] configs, String... environment) {
+		AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+		TestPropertyValues.of(environment).applyTo(ctx);
+		if (!ObjectUtils.isEmpty(configs)) {
+			ctx.register(configs);
+		}
+		ctx.register(QuartzAutoConfiguration.class);
+		ctx.refresh();
+		this.context = ctx;
 	}
 
 	@Configuration
-	protected static class QuartzJobConfiguration {
+	protected static class QuartzJobsConfiguration {
 
 		@Bean
 		public JobDetail fooJob() {
@@ -167,6 +208,24 @@ public class QuartzAutoConfigurationTests {
 					.storeDurably().build();
 		}
 
+		@Bean
+		public JobDetail barJob() {
+			return JobBuilder.newJob().ofType(FooJob.class).withIdentity("barJob")
+					.storeDurably().build();
+		}
+
+	}
+
+	@Configuration
+	protected static class QuartzFullConfiguration {
+
+		@Bean
+		public JobDetail fooJob() {
+			return JobBuilder.newJob().ofType(FooJob.class).withIdentity("fooJob")
+					.usingJobData("jobDataKey", "jobDataValue")
+					.storeDurably().build();
+		}
+
 		@Bean
 		public Trigger fooTrigger() {
 			SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
@@ -219,10 +278,17 @@ public class QuartzAutoConfigurationTests {
 		@Autowired
 		private Environment env;
 
+		private String jobDataKey;
+
 		@Override
 		protected void executeInternal(JobExecutionContext context)
 				throws JobExecutionException {
-			System.out.println(this.env.getProperty("test-name", "unknown"));
+			System.out.println(this.env.getProperty("test-name", "unknown") + " - "
+					+ this.jobDataKey);
+		}
+
+		public void setJobDataKey(String jobDataKey) {
+			this.jobDataKey = jobDataKey;
 		}
 
 	}