Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add SpringJUnit5 checkstyle rule

Browse Source 
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.
This commit is contained in:
Phillip Webb
2019-08-17 08:29:58 -07:00
parent 0db2f8fbcf
commit f8a93ee4a7
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/checkstyle/checkstyle-suppressions.xml
View File

@@ -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" />

1
src/checkstyle/checkstyle.xml
View File

@@ -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>