Use Gradle 4.6's built-in support for the JUnit Platform

Gradle 4.6 provides built-in support for the JUnit Platform within the
standard `test` task.

This commit configures a custom `testJUnitJupiter` test task for
executing JUnit Jupiter tests directly on the JUnit Platform instead of
indirectly on JUnit 4 via @RunWith(JUnitPlatform.class).

This switch provides for better integration with Gradle's test reporting
and paves the way for a possible transition to the JUnit Platform in the
future.

Issue: SPR-16672

Author: sbrannen

spring-test/spring-test.gradle

@@ -103,22 +103,34 @@ task testNG(type: Test) {
 	reports.junitXml.destination = file("$buildDir/test-results")
 }
 
+task testJUnitJupiter(type: Test) {
+	description = 'Runs JUnit Jupiter tests.'
+	useJUnitPlatform {
+		includeEngines 'junit-jupiter'
+		excludeTags 'failing-test-case'
+	}
+	filter {
+		includeTestsMatching "org.springframework.test.context.junit.jupiter.*"
+	}
+	reports.junitXml.destination = file("$buildDir/test-results")
+	// Java Util Logging for the JUnit Platform.
+	// systemProperty('java.util.logging.manager', 'org.apache.logging.log4j.jul.LogManager')
+}
+
 test {
 	description = 'Runs JUnit tests.'
-	dependsOn testNG
+	dependsOn testJUnitJupiter, testNG
 	useJUnit()
 	scanForTestClasses = false
-	include(['**/*Tests.class', '**/*Test.class', '**/SpringJUnitJupiterTestSuite.class'])
-	exclude(['**/testng/**/*.*'])
-	// Java Util Logging for JUnit 5.
-	// systemProperty('java.util.logging.manager', 'org.apache.logging.log4j.jul.LogManager')
+	include(['**/*Tests.class', '**/*Test.class'])
+	exclude(['**/testng/**/*.*', '**/jupiter/**/*.*'])
 	reports.junitXml.destination = file("$buildDir/test-results")
 }
 
 task aggregateTestReports(type: TestReport) {
 	description = 'Aggregates JUnit and TestNG test reports.'
 	destinationDir = test.reports.html.destination
-	reportOn test, testNG
+	reportOn test, testJUnitJupiter, testNG
 }
 
 check.dependsOn aggregateTestReports

spring-test/src/test/java/org/springframework/test/context/junit/SpringJUnitJupiterTestSuite.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -17,7 +17,7 @@
 package org.springframework.test.context.junit;
 
 import org.junit.platform.runner.JUnitPlatform;
-import org.junit.platform.suite.api.IncludeClassNamePatterns;
+import org.junit.platform.suite.api.ExcludeTags;
 import org.junit.platform.suite.api.IncludeEngines;
 import org.junit.platform.suite.api.SelectPackages;
 import org.junit.platform.suite.api.UseTechnicalNames;
@@ -48,7 +48,7 @@
 @RunWith(JUnitPlatform.class)
 @IncludeEngines("junit-jupiter")
 @SelectPackages("org.springframework.test.context.junit.jupiter")
-@IncludeClassNamePatterns("^.*TestCase$")
+@ExcludeTags("failing-test-case")
 @UseTechnicalNames
 public class SpringJUnitJupiterTestSuite {
 }

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/ComposedSpringExtensionTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/ComposedSpringExtensionTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -45,11 +45,11 @@
  * @since 5.0
  * @see SpringExtension
  * @see SpringJUnitConfig
- * @see SpringExtensionTestCase
+ * @see SpringExtensionTests
  */
 @SpringJUnitConfig(TestConfig.class)
 @DisplayName("@SpringJUnitConfig Tests")
-class ComposedSpringExtensionTestCase {
+class ComposedSpringExtensionTests {
 
 	@Autowired
 	Person dilbert;

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/DisabledIfConditionTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/DisabledIfConditionTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -40,17 +40,17 @@
 
 /**
  * Tests for {@link DisabledIfCondition} that verify actual condition evaluation
- * results and exception handling; whereas, {@link DisabledIfTestCase} only tests
+ * results and exception handling; whereas, {@link DisabledIfTests} only tests
  * the <em>happy paths</em>.
  *
  * <p>To run these tests in an IDE that does not have built-in support for the JUnit
  * Platform, simply run {@link SpringJUnitJupiterTestSuite} as a JUnit 4 test.
  *
  * @author Sam Brannen
  * @since 5.0
- * @see DisabledIfTestCase
+ * @see DisabledIfTests
  */
-class DisabledIfConditionTestCase {
+class DisabledIfConditionTests {
 
 	private final DisabledIfCondition condition = new DisabledIfCondition();
 

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/DisabledIfTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/DisabledIfTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -37,16 +37,16 @@
  * @author Tadaya Tsuyukubo
  * @author Sam Brannen
  * @since 5.0
- * @see DisabledIfConditionTestCase
+ * @see DisabledIfConditionTests
  * @see DisabledIf
  * @see SpringExtension
  */
-class DisabledIfTestCase {
+class DisabledIfTests {
 
 	@SpringJUnitConfig(Config.class)
 	@TestPropertySource(properties = "foo = true")
 	@Nested
-	class DisabledIfOnMethodTestCase {
+	class DisabledIfOnMethodTests {
 
 		@Test
 		@DisabledIf("true")
@@ -131,7 +131,7 @@ void disabledIfWithSpelStringTrueBean() {
 	@SpringJUnitConfig(Config.class)
 	@Nested
 	@DisabledIf("true")
-	class DisabledIfOnClassTestCase {
+	class DisabledIfOnClassTests {
 
 		@Test
 		void foo() {

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledIfTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledIfTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -38,16 +38,16 @@
  * @author Tadaya Tsuyukubo
  * @author Sam Brannen
  * @since 5.0
- * @see EnabledIfConditionTestCase
+ * @see EnabledIfConditionTests
  * @see EnabledIf
  * @see SpringExtension
  */
-class EnabledIfTestCase {
+class EnabledIfTests {
 
 	@SpringJUnitConfig(Config.class)
 	@TestPropertySource(properties = "foo = false")
 	@Nested
-	class EnabledIfOnMethodTestCase {
+	class EnabledIfOnMethodTests {
 
 		@Test
 		@EnabledIf("false")
@@ -133,7 +133,7 @@ void enabledIfWithSpelStringFalseBean() {
 	@SpringJUnitConfig(Config.class)
 	@Nested
 	@EnabledIf("false")
-	class EnabledIfOnClassTestCase {
+	class EnabledIfOnClassTests {
 
 		@Test
 		void foo() {

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/FailingBeforeAndAfterMethodsSpringExtensionTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/FailingBeforeAndAfterMethodsSpringExtensionTests.java

@@ -71,20 +71,20 @@
  * @author Sam Brannen
  * @since 5.0
  */
-class FailingBeforeAndAfterMethodsSpringExtensionTestCase {
+class FailingBeforeAndAfterMethodsSpringExtensionTests {
 
 	private static Stream<Class<?>> testClasses() {
 		// @formatter:off
 		return Stream.of(
-				AlwaysFailingBeforeTestClassTestKase.class,
-				AlwaysFailingAfterTestClassTestKase.class,
-				AlwaysFailingPrepareTestInstanceTestKase.class,
-				AlwaysFailingBeforeTestMethodTestKase.class,
-				AlwaysFailingBeforeTestExecutionTestKase.class,
-				AlwaysFailingAfterTestExecutionTestKase.class,
-				AlwaysFailingAfterTestMethodTestKase.class,
-				FailingBeforeTransactionTestKase.class,
-				FailingAfterTransactionTestKase.class);
+				AlwaysFailingBeforeTestClassTestCase.class,
+				AlwaysFailingAfterTestClassTestCase.class,
+				AlwaysFailingPrepareTestInstanceTestCase.class,
+				AlwaysFailingBeforeTestMethodTestCase.class,
+				AlwaysFailingBeforeTestExecutionTestCase.class,
+				AlwaysFailingAfterTestExecutionTestCase.class,
+				AlwaysFailingAfterTestMethodTestCase.class,
+				FailingBeforeTransactionTestCase.class,
+				FailingAfterTransactionTestCase.class);
 		// @formatter:on
 	}
 
@@ -131,16 +131,16 @@ private void runTestAndAssertCounters(Class<?> testClass) {
 	}
 
 	private int getExpectedStartedCount(Class<?> testClass) {
-		return (testClass == AlwaysFailingBeforeTestClassTestKase.class ? 0 : 1);
+		return (testClass == AlwaysFailingBeforeTestClassTestCase.class ? 0 : 1);
 	}
 
 	private int getExpectedSucceededCount(Class<?> testClass) {
-		return (testClass == AlwaysFailingAfterTestClassTestKase.class ? 1 : 0);
+		return (testClass == AlwaysFailingAfterTestClassTestCase.class ? 1 : 0);
 	}
 
 	private int getExpectedFailedCount(Class<?> testClass) {
-		if (testClass == AlwaysFailingBeforeTestClassTestKase.class
-				|| testClass == AlwaysFailingAfterTestClassTestKase.class) {
+		if (testClass == AlwaysFailingBeforeTestClassTestCase.class
+				|| testClass == AlwaysFailingAfterTestClassTestCase.class) {
 			return 0;
 		}
 		return 1;
@@ -205,6 +205,7 @@ public void afterTestExecution(TestContext testContext) {
 		}
 	}
 
+	@FailingTestCase
 	@ExtendWith(SpringExtension.class)
 	private static abstract class BaseTestCase {
 
@@ -214,44 +215,37 @@ void testNothing() {
 	}
 
 	@TestExecutionListeners(AlwaysFailingBeforeTestClassTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingBeforeTestClassTestKase extends BaseTestCase {
+	static class AlwaysFailingBeforeTestClassTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingAfterTestClassTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingAfterTestClassTestKase extends BaseTestCase {
+	static class AlwaysFailingAfterTestClassTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingPrepareTestInstanceTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingPrepareTestInstanceTestKase extends BaseTestCase {
+	static class AlwaysFailingPrepareTestInstanceTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingBeforeTestMethodTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingBeforeTestMethodTestKase extends BaseTestCase {
+	static class AlwaysFailingBeforeTestMethodTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingBeforeTestExecutionTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingBeforeTestExecutionTestKase extends BaseTestCase {
+	static class AlwaysFailingBeforeTestExecutionTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingAfterTestExecutionTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingAfterTestExecutionTestKase extends BaseTestCase {
+	static class AlwaysFailingAfterTestExecutionTestCase extends BaseTestCase {
 	}
 
 	@TestExecutionListeners(AlwaysFailingAfterTestMethodTestExecutionListener.class)
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class AlwaysFailingAfterTestMethodTestKase extends BaseTestCase {
+	static class AlwaysFailingAfterTestMethodTestCase extends BaseTestCase {
 	}
 
+	@FailingTestCase
 	@SpringJUnitConfig(DatabaseConfig.class)
 	@Transactional
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class FailingBeforeTransactionTestKase {
+	static class FailingBeforeTransactionTestCase {
 
 		@Test
 		void testNothing() {
@@ -263,10 +257,10 @@ void beforeTransaction() {
 		}
 	}
 
+	@FailingTestCase
 	@SpringJUnitConfig(DatabaseConfig.class)
 	@Transactional
-	// TestKase with a "K" so that it's not picked up by the suite or build
-	static class FailingAfterTransactionTestKase {
+	static class FailingAfterTransactionTestCase {
 
 		@Test
 		void testNothing() {

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/FailingTestCase.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2002-2018 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.test.context.junit.jupiter;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.junit.jupiter.api.Tag;
+
+/**
+ * Custom annotation for tagging "fake" test cases which are supposed to fail
+ * but are only intended to be used internally by "real" passing tests.
+ *
+ * @author Sam Brannen
+ * @since 5.1
+ */
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Tag("failing-test-case")
+public @interface FailingTestCase {
+}

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/RegisterExtensionSpringExtensionTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/RegisterExtensionSpringExtensionTests.java

@@ -49,13 +49,13 @@
  *
  * @author Sam Brannen
  * @since 5.1
- * @see SpringExtensionTestCase
+ * @see SpringExtensionTests
  * @see SpringExtension
  * @see RegisterExtension
  */
 @ContextConfiguration(classes = TestConfig.class)
 @TestPropertySource(properties = "enigma = 42")
-class RegisterExtensionSpringExtensionTestCase {
+class RegisterExtensionSpringExtensionTests {
 
 	@RegisterExtension
 	static final SpringExtension springExtension = new SpringExtension();

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/SpringExtensionParameterizedTestCase.java renamed to spring-test/src/test/java/org/springframework/test/context/junit/jupiter/SpringExtensionParameterizedTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -45,7 +45,7 @@
  * @see ParameterizedTest
  */
 @SpringJUnitConfig(TestConfig.class)
-class SpringExtensionParameterizedTestCase {
+class SpringExtensionParameterizedTests {
 
 	@ParameterizedTest
 	@ValueSource(strings = { "Dilbert", "Wally" })