From f8a93ee4a76bf15796a46408f50d041341e9f1cc Mon Sep 17 00:00:00 2001
From: Phillip Webb <pwebb@pivotal.io>
Date: Sat, 17 Aug 2019 08:29:58 -0700
Subject: [PATCH] Add SpringJUnit5 checkstyle rule

Add `SpringJUnit5` checkstyle rule to ensure that JUnit 4 annotations
aren't accidentally used in new tests.

The "must not be public" rule has been suppressed since there are
quite a few tests that extend base tests from other packages.
---
 src/checkstyle/checkstyle-suppressions.xml | 3 +++
 src/checkstyle/checkstyle.xml              | 1 +
 2 files changed, 4 insertions(+)

diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml
index ff4a7efaeef..fc711cc2b96 100644
--- a/src/checkstyle/checkstyle-suppressions.xml
+++ b/src/checkstyle/checkstyle-suppressions.xml
@@ -4,6 +4,7 @@
 
 	<!-- global -->
 	<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="AnnotationLocation|AnnotationUseStyle|AtclauseOrder|AvoidNestedBlocks|FinalClass|HideUtilityClassConstructor|InnerTypeLast|JavadocStyle|JavadocType|JavadocVariable|LeftCurly|MultipleVariableDeclarations|NeedBraces|OneTopLevelClass|OuterTypeFilename|RequireThis|SpringCatch|SpringJavadoc|SpringNoThis" />
+	<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="SpringJUnit5" message="should not be public" />
 
 	<!-- spring-beans -->
 	<suppress files="TypeMismatchException" checks="MutableException"/>
@@ -70,6 +71,8 @@
 	<suppress files="HeaderAssertions" checks="IllegalImport" id="bannedHamcrestImports" />
 	<suppress files="StatusAssertions" checks="IllegalImport" id="bannedHamcrestImports" />
 	<suppress files="JsonPathResultMatchers" checks="IllegalImport" id="bannedHamcrestImports" />
+	<suppress files="src[\\/]test[\\/]java[\\/]org[\\/]springframework[\\/]test[\\/]context[\\/]junit4" checks="SpringJUnit5"/>
+	<suppress files="ContextHierarchyDirtiesContextTests|ClassLevelDirtiesContextTests|ContextConfigurationWithPropertiesExtendingPropertiesAndInheritedLoaderTests|ContextConfigurationWithPropertiesExtendingPropertiesTests|DirtiesContextInterfaceTests|.*WacTests|JUnit4SpringContextWebTests"  checks="SpringJUnit5"/>
 
 	<!-- spring-web -->
 	<suppress files="SpringHandlerInstantiator" checks="JavadocStyle" />
diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml
index be9d94bf6d2..872b30c06b9 100644
--- a/src/checkstyle/checkstyle.xml
+++ b/src/checkstyle/checkstyle.xml
@@ -211,5 +211,6 @@
 		</module>
 		<module name="io.spring.javaformat.checkstyle.check.SpringCatchCheck" />
 		<module name="io.spring.javaformat.checkstyle.check.SpringJavadocCheck" />
+		<module name="io.spring.javaformat.checkstyle.check.SpringJUnit5Check" />
  	</module>
 </module>