From 032096d699751ab2d0f5715e037fcb9306625ef2 Mon Sep 17 00:00:00 2001
From: Phillip Webb <pwebb@pivotal.io>
Date: Wed, 13 Jun 2018 11:02:02 -0700
Subject: [PATCH] Add checkstyle to build

Add checkstyle to the build to enforce Spring Framework coding
conventions. Rule suppressions are used for several classes where
relaxing the rules makes more sense than fixing them.

Issue: SPR-16968
---
 build.gradle                               |   9 +-
 src/checkstyle/checkstyle-suppressions.xml |  78 +++++++++++
 src/checkstyle/checkstyle.xml              | 156 +++++++++++++++++++++
 3 files changed, 242 insertions(+), 1 deletion(-)
 create mode 100644 src/checkstyle/checkstyle-suppressions.xml
 create mode 100644 src/checkstyle/checkstyle.xml

diff --git a/build.gradle b/build.gradle
index 92c206ab97..7d99c9b71d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -64,6 +64,7 @@ configure(allprojects) { project ->
 	apply plugin: "test-source-set-dependencies"
 	apply plugin: "io.spring.dependency-management"
 	apply from: "${gradleScriptDir}/ide.gradle"
+	apply plugin: "checkstyle"
 
 	dependencyManagement {
 		resolutionStrategy {
@@ -75,6 +76,11 @@ configure(allprojects) { project ->
 		}
 	}
 
+	checkstyle {
+		toolVersion = "8.10.1"
+		configDir = rootProject.file("src/checkstyle")
+	}
+
 	apply plugin: "kotlin"
 	compileKotlin {
 		kotlinOptions {
@@ -163,9 +169,10 @@ configure(allprojects) { project ->
 		testRuntime("org.apache.logging.log4j:log4j-core:${log4jVersion}")
 		testRuntime("org.apache.logging.log4j:log4j-slf4j-impl:${log4jVersion}")
 		testRuntime("org.apache.logging.log4j:log4j-jul:${log4jVersion}")
-        // JSR-305 only used for non-required meta-annotations
+		// JSR-305 only used for non-required meta-annotations
 		compileOnly("com.google.code.findbugs:jsr305:3.0.2")
 		testCompileOnly("com.google.code.findbugs:jsr305:3.0.2")
+		checkstyle("io.spring.javaformat:spring-javaformat-checkstyle:0.0.5")
 	}
 
 	ext.javadocLinks = [
diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml
new file mode 100644
index 0000000000..963710de13
--- /dev/null
+++ b/src/checkstyle/checkstyle-suppressions.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+<suppressions>
+
+	<!-- global -->
+	<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks=".*" />
+	<suppress files="ValueConstants" checks="InterfaceIsType" />
+
+	<!-- spring-beans -->
+	<suppress files="TypeMismatchException" checks="MutableException"/>
+	<suppress files="BeanCreationException" checks="MutableException"/>
+	<suppress files="BeanDefinitionParserDelegate" checks="JavadocVariable" />
+	<suppress files="DefaultBeanDefinitionDocumentReader" checks="JavadocVariable" />
+	<suppress files="BeanComponentDefinition" checks="EqualsHashCode" />
+	<suppress files="GenericBeanDefinition" checks="EqualsHashCode" />
+	<suppress files="RootBeanDefinition" checks="EqualsHashCode" />
+
+	<!-- spring-core -->
+	<suppress files="[\\/]src[\\/]main[\\/]java[\\/]org[\\/]springframework[\\/]asm[\\/]" checks=".*" />
+	<suppress files="[\\/]src[\\/]main[\\/]java[\\/]org[\\/]springframework[\\/]cglib[\\/]" checks=".*" />
+	<suppress files="SocketUtils" checks="HideUtilityClassConstructor" />
+	<suppress files="ResolvableType" checks="FinalClass" />
+
+	<!-- spring-expression -->
+	<suppress files="ExpressionException" checks="MutableException" />
+	<suppress files="SpelMessage" checks="JavadocVariable|JavadocStyle" />
+
+	<!-- spring-jcl -->
+	<suppress files="[\\/]src[\\/]main[\\/]java[\\/]org[\\/]apache[\\/]commons[\\/]logging[\\/]" checks="Header|SpringNoThis" />
+
+	<!-- spring-jdbc -->
+	<suppress files="ResultSetWrappingSqlRowSet" checks="JavadocStyle" />
+
+	<!-- spring-jms -->
+	<suppress files="JmsHeaderMapper" checks="InterfaceIsType" />
+	<suppress files="JmsHeaders" checks="InterfaceIsType" />
+	<suppress files="AbstractJmsListenerContainerFactory" checks="JavadocStyle" />
+	<suppress files="DefaultJmsListenerContainerFactory" checks="JavadocStyle" />
+	<suppress files="DefaultJcaListenerContainerFactory" checks="JavadocStyle" />
+
+	<!-- spring-messaging -->
+	<suppress files="SimpMessageHeaderAccessor" checks="JavadocVariable" />
+	<suppress files="SimpMessageType" checks="JavadocVariable" />
+	<suppress files="StompCommand" checks="JavadocVariable" />
+	<suppress files="StompHeaderAccessor" checks="JavadocVariable" />
+	<suppress files="StompHeaders" checks="JavadocVariable" />
+
+	<!-- spring-orm -->
+	<suppress files="jpa[\\/]vendor[\\/]Database" checks="JavadocVariable|JavadocStyle"/>
+
+	<!-- spring-tx -->
+	<suppress files="TransactionSystemException" checks="MutableException" />
+	<suppress files="TransactionTemplate" checks="EqualsHashCode" />
+
+	<!-- spring-test -->
+	<suppress files="org[\\/]springframework[\\/]test[\\/]context[\\/]jdbc[\\/]MergedSqlConfig" checks="JavadocStyle" />
+
+	<!-- spring-web -->
+	<suppress files="SpringHandlerInstantiator" checks="JavadocStyle" />
+	<suppress files="org[\\/]springframework[\\/]http[\\/]HttpMethod" checks="JavadocVariable|JavadocStyle" />
+	<suppress files="org[\\/]springframework[\\/]http[\\/]HttpStatus" checks="JavadocVariable|JavadocStyle" />
+	<suppress files="org[\\/]springframework[\\/]web[\\/]bind[\\/]annotation[\\/]CrossOrigin" checks="JavadocStyle" />
+	<suppress files="org[\\/]springframework[\\/]web[\\/]bind[\\/]annotation[\\/]RequestMethod" checks="JavadocVariable" />
+	<suppress files="PatternParseException" checks="JavadocVariable" />
+	<suppress files="web[\\/]reactive[\\/]socket[\\/]CloseStatus" checks="JavadocStyle" />
+
+	<!-- spring-webmvc -->
+	<suppress files="org[\\/]springframework[\\/]web[\\/]servlet[\\/]tags[\\/]form[\\/].*Tag" checks="JavadocVariable" />
+
+	<!-- spring-websocket -->
+	<suppress files="web[\\/]socket[\\/]CloseStatus" checks="JavadocStyle" />
+	<suppress files="web[\\/]socket[\\/]WebSocketHttpHeaders" checks="JavadocVariable" />
+	<suppress files="sockjs[\\/]frame[\\/]SockJsFrameType" checks="JavadocVariable" />
+	<suppress files="sockjs[\\/]transport[\\/]TransportType" checks="JavadocVariable" />
+
+</suppressions>
diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml
new file mode 100644
index 0000000000..d69c423368
--- /dev/null
+++ b/src/checkstyle/checkstyle.xml
@@ -0,0 +1,156 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+<module name="com.puppycrawl.tools.checkstyle.Checker">
+	<!-- Supressions -->
+	<module name="SuppressionFilter">
+		<property name="file" value="${config_loc}/checkstyle-suppressions.xml"/>
+	</module>
+
+	<!-- Root Checks -->
+	<module name="io.spring.javaformat.checkstyle.check.SpringHeaderCheck">
+		<property name="fileExtensions" value="java" />
+		<property name="headerType" value="apache2"/>
+		<property name="headerCopyrightPattern" value="20\d\d-20\d\d"/>
+		<property name="packageInfoHeaderType" value="none"/>
+	</module>
+	<module name="com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck">
+		<property name="lineSeparator" value="lf"/>
+	</module>
+
+	<!-- TreeWalker Checks -->
+	<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
+		<!-- Annotations -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck">
+			<property name="elementStyle" value="compact" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck">
+			<property name="allowSamelineSingleParameterlessAnnotation"
+				value="false" />
+		</module>
+
+		<!-- Block Checks -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck">
+			<property name="option" value="text" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck">
+			<property name="option" value="alone" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck" />
+
+		<!-- Class Design -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck" />
+
+		<!-- Coding -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck">
+			<property name="max" value="3" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck">
+			<property name="max" value="5" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck">
+			<property name="max" value="3" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck" />
+
+		<module name="io.spring.javaformat.checkstyle.filter.RequiresOuterThisFilter" />
+		<module name="io.spring.javaformat.checkstyle.filter.IdentCheckFilter">
+			<property name="names" value="logger" />
+			<module
+				name="com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck">
+				<property name="checkMethods" value="false" />
+				<property name="validateOnlyOverlapping" value="false" />
+			</module>
+		</module>
+		<module name="io.spring.javaformat.checkstyle.check.SpringNoThisCheck">
+			<property name="names" value="logger" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck" />
+
+		<!-- Imports -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck">
+			<property name="processJavadoc" value="true" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck">
+			<property name="groups" value="/javax?/,/[^org\.springframework]/,org.springframework" />
+			<property name="ordered" value="true" />
+			<property name="separated" value="true" />
+			<property name="option" value="bottom" />
+			<property name="sortStaticImportsAlphabetically" value="true" />
+		</module>
+
+		<!-- Javadoc Comments -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck">
+			<property name="scope" value="package"/>
+			<property name="authorFormat" value=".+\s.+"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck">
+			<property name="allowMissingParamTags" value="true"/>
+			<property name="allowMissingThrowsTags" value="true"/>
+			<property name="allowMissingReturnTag" value="true"/>
+			<property name="allowMissingJavadoc" value="true"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck">
+			<property name="scope" value="public"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck">
+			<property name="checkEmptyJavadoc" value="true"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck">
+			<property name="offset" value="0"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck">
+			<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF"/>
+    		<property name="tagOrder" value="@author, @since, @param, @see, @version, @serial, @deprecated"/>
+		</module>
+ 		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck">
+			<property name="target" value="METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+    		<property name="tagOrder" value="@param, @return, @throws, @since, @deprecated, @see"/>
+		</module>
+
+		<!-- Miscellaneous -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck">
+			<property name="tokens" value="BLOCK_COMMENT_BEGIN"/>
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.UpperEllCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck" />
+		<module name="com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck" />
+
+		<!-- Regexp -->
+		<module name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck">
+			<property name="format" value="^\t* +\t*\S" />
+			<property name="message"
+				value="Line has leading space characters; indentation should be performed with tabs only." />
+			<property name="ignoreComments" value="true" />
+		</module>
+		<module name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck">
+			<property name="format" value="[ \t]+$" />
+			<property name="illegalPattern" value="true" />
+			<property name="message" value="Trailing whitespace" />
+		</module>
+
+		<!-- Spring Conventions -->
+		<module name="io.spring.javaformat.checkstyle.check.SpringLambdaCheck">
+			<property name="singleArgumentParentheses" value="false" />
+		</module>
+		<module name="io.spring.javaformat.checkstyle.check.SpringCatchCheck" />
+		<module name="io.spring.javaformat.checkstyle.check.SpringJavadocCheck" />
+ 	</module>
+</module>
-- 
GitLab