- * A typical usage of this annotation is like: + * A typical usage of this annotation with JUnit 4 is like: * *
* @RunWith(SpringRunner.class) @@ -79,6 +82,40 @@ * } ** + * For JUnit 5, this annotation can be used without having to manually register the + * {@link SpringExtension} since {@code @SpringBatchTest} is meta-annotated with + * {@code @ExtendWith(SpringExtension.class)}: + * + *
+ * @SpringBatchTest
+ * @ContextConfiguration(classes = MyBatchJobConfiguration.class)
+ * public class MyBatchJobTests {
+ *
+ * @@Autowired
+ * private JobLauncherTestUtils jobLauncherTestUtils;
+ *
+ * @@Autowired
+ * private JobRepositoryTestUtils jobRepositoryTestUtils;
+ *
+ * @BeforeEach
+ * public void clearJobExecutions() {
+ * this.jobRepositoryTestUtils.removeJobExecutions();
+ * }
+ *
+ * @Test
+ * public void testMyJob() throws Exception {
+ * // given
+ * JobParameters jobParameters = this.jobLauncherTestUtils.getUniqueJobParameters();
+ *
+ * // when
+ * JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
+ *
+ * // then
+ * Assertions.assertEquals(ExitStatus.COMPLETED, jobExecution.getExitStatus());
+ * }
+ *
+ * }
+ *
* @author Mahmoud Ben Hassine
* @since 4.1
* @see JobLauncherTestUtils
@@ -94,5 +131,6 @@
listeners = {StepScopeTestExecutionListener.class, JobScopeTestExecutionListener.class},
mergeMode = TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS
)
+@ExtendWith(SpringExtension.class)
public @interface SpringBatchTest {
}
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestTests.java b/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit4Tests.java
similarity index 95%
rename from spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestTests.java
rename to spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit4Tests.java
index 302e66a7fa..57d0ef23ae 100644
--- a/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestTests.java
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit4Tests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2018 the original author or authors.
+ * Copyright 2018-2020 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.
@@ -46,14 +46,14 @@
import org.springframework.test.context.junit4.SpringRunner;
/**
- * Test cases for usage of {@link SpringBatchTest} annotation.
+ * Test cases for usage of {@link SpringBatchTest} annotation with JUnit 4.
*
* @author Mahmoud Ben Hassine
*/
@RunWith(SpringRunner.class)
@SpringBatchTest
-@ContextConfiguration(classes = SpringBatchTestTests.JobConfiguration.class)
-public class SpringBatchTestTests {
+@ContextConfiguration
+public class SpringBatchTestJUnit4Tests {
@Autowired
private JobLauncherTestUtils jobLauncherTestUtils;
diff --git a/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit5Tests.java b/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit5Tests.java
new file mode 100644
index 0000000000..8390d18e43
--- /dev/null
+++ b/spring-batch-test/src/test/java/org/springframework/batch/test/SpringBatchTestJUnit5Tests.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright 2020 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
+ *
+ * https://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.batch.test;
+
+import java.util.Arrays;
+
+import javax.sql.DataSource;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.ExitStatus;
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.JobExecution;
+import org.springframework.batch.core.JobParameters;
+import org.springframework.batch.core.StepExecution;
+import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
+import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
+import org.springframework.batch.core.configuration.annotation.JobScope;
+import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
+import org.springframework.batch.core.configuration.annotation.StepScope;
+import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.item.support.ListItemReader;
+import org.springframework.batch.repeat.RepeatStatus;
+import org.springframework.batch.test.context.SpringBatchTest;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * Test cases for usage of {@link SpringBatchTest} annotation with JUnit 5.
+ *
+ * @author Mahmoud Ben Hassine
+ */
+@SpringBatchTest
+@ContextConfiguration
+public class SpringBatchTestJUnit5Tests {
+
+ @Autowired
+ private JobLauncherTestUtils jobLauncherTestUtils;
+
+ @Autowired
+ private JobRepositoryTestUtils jobRepositoryTestUtils;
+
+ @Autowired
+ private ItemReader