build: add support for checkstyle / spotless to grails-core

Author: jdaugherty

buildSrc/build.gradle

@@ -52,6 +52,8 @@ dependencies {
     implementation 'io.github.gradle-nexus:publish-plugin'
     implementation 'org.apache.grails:grails-docs-core'
     implementation 'org.apache.grails:grails-gradle-plugins'
+    implementation "com.diffplug.spotless:spotless-plugin-gradle:${gradleProperties.spotlessVersion}"
+    implementation "io.spring.nohttp:nohttp-gradle:${gradleProperties.nohttpGradleVersion}"
     implementation 'org.asciidoctor:asciidoctor-gradle-jvm'
     implementation 'org.springframework.boot:spring-boot-gradle-plugin'
     implementation 'org.nosphere.apache.rat:org.nosphere.apache.rat.gradle.plugin:0.8.1'

grails-forge/config/checkstyle/checkstyle.xml renamed to etc/config/checkstyle/checkstyle.xml

@@ -97,10 +97,10 @@
     <module name="SuppressWarningsFilter"/>
 
     <!-- See http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter -->
-    <module name="SuppressionFilter">
-        <property name="file" value="${config_loc}/suppressions.xml"/>
-        <property name="optional" value="false"/>
-    </module>
+<!--    <module name="SuppressionFilter">-->
+<!--        <property name="file" value="${config_loc}/suppressions.xml"/>-->
+<!--        <property name="optional" value="false"/>-->
+<!--    </module>-->
 
     <module name="TreeWalker">
 
@@ -114,6 +114,8 @@
             <property name="allowMissingReturnTag" value="true"/>
         </module>
         <module name="JavadocType">
+            <!-- https://github.com/checkstyle/checkstyle/issues/14581 -->
+            <property name="allowMissingParamTags" value="true"/>
         </module>
 
         <module name="JavadocStyle">

grails-forge/config/spotless.license.java renamed to etc/config/spotless/license.java

@@ -40,6 +40,8 @@ yakworksHibernateGroovyProxyVersion=1.1
 picocliVersion=4.7.6
 liquibaseHibernate5Version=4.27.0
 hibernate5Version=5.6.15.Final
+spotlessVersion=6.25.0
+nohttpGradleVersion=0.0.11
 
 githubSlug=apache/grails-core
 githubBranch=7.0.x

gradle.properties

@@ -0,0 +1,65 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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.
+ */
+
+apply plugin: 'checkstyle'
+apply plugin: 'com.diffplug.spotless'
+apply plugin: 'io.spring.nohttp' // enforce https everywhere
+
+spotless {
+    java {
+        licenseHeaderFile(rootProject.file("etc/config/spotless/license.java"))
+        target('src/main/java/**/*.java')
+    }
+    groovy {
+        licenseHeaderFile(rootProject.file("etc/config/spotless/license.java"))
+        target('src/main/groovy/**.groovy', 'src/main/groovy/**.java')
+    }
+    format 'javaMisc', {
+        target('src/main/**/package-info.java', 'src/main/**/module-info.java')
+        licenseHeaderFile(rootProject.file('etc/config/spotless/license.java'), '\\/\\*\\*')
+    }
+}
+
+checkstyle {
+    configFile = project.rootProject.file('etc/config/checkstyle/checkstyle.xml')
+
+    // Per submodule
+    maxErrors = 1
+    maxWarnings = 10
+
+    showViolations = true
+}
+
+nohttp {
+    source.exclude('src/test/**', 'build/**')
+}
+
+if (tasks.names.contains('checkstyleTest')) {
+    tasks.named('checkstyleTest').configure {
+        it.group = 'verification'
+        it.enabled = false
+    }
+}
+
+if (tasks.names.contains('checkstyleMain')) {
+    tasks.named('checkstyleMain').configure {
+        it.group = 'verification'
+        it.dependsOn('spotlessCheck')
+    }
+}

gradle/style-enforcement-config.gradle

@@ -22,10 +22,8 @@
 <!DOCTYPE suppressions PUBLIC
         "-//Puppy Crawl//DTD Suppressions 1.1//EN"
         "http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
-
 <suppressions>
-    <suppress checks="FileLength"
-              files="DefaultBeanContext.java|BeanDefinitionWriter.java|DefaultHttpClient.java"/>
-    <suppress files="[\\/]generated-src[\\/]|RockerSubs.java" checks="[a-zA-Z0-9]*"/>
-    <suppress checks="Nohttp" files="pom.xml" />
+<!--    <suppress checks="FileLength"-->
+<!--              files="DefaultBeanContext.java|BeanDefinitionWriter.java|DefaultHttpClient.java"/>-->
+<!--    <suppress files="[\\/]generated-src[\\/]|RockerSubs.java" checks="[a-zA-Z0-9]*"/>-->
 </suppressions>

grails-forge/config/checkstyle/suppressions.xml renamed to grails-forge/etc/checkstyle/suppressions.xml

@@ -43,8 +43,6 @@ micronautBuildVersion=1.1.5
 micronautDocsVersion=2.0.0
 micronautGradlePlugins=5.4.10
 micronautVersion=3.10.4
-nexusPublishVersion=1.3.0
-nohttpGradleVersion=0.0.11
 objenesisVersion=3.4
 picocliVersion=4.7.5
 postgresqlVersion=42.7.5
@@ -55,7 +53,6 @@ shadowVersion=8.3.6
 slf4jVersion=2.0.17
 snakeyamlVersion=2.4
 spockVersion=2.1-groovy-3.0
-spotlessVersion=6.25.0
 testRetryVersion=1.6.2
 typesafeConfigVersion=1.4.3
 

grails-forge/gradle.properties

@@ -23,21 +23,21 @@ apply plugin: 'io.spring.nohttp' // enforce https everywhere
 
 spotless {
     java {
-        licenseHeaderFile(rootProject.file("${rootDir}/config/spotless.license.java"))
+        licenseHeaderFile(rootProject.file("../etc/config/spotless/license.java"))
         target('src/main/java/**/*.java')
     }
     groovy {
-        licenseHeaderFile(rootProject.file("${rootDir}/config/spotless.license.java"))
+        licenseHeaderFile(rootProject.file("../etc/config/spotless/license.java"))
         target('src/main/groovy/**')
     }
     format 'javaMisc', {
         target('src/main/**/package-info.java', 'src/main/**/module-info.java')
-        licenseHeaderFile(rootProject.file('config/spotless.license.java'), '\\/\\*\\*')
+        licenseHeaderFile(rootProject.file('../etc/config/spotless/license.java'), '\\/\\*\\*')
     }
 }
 
 checkstyle {
-    configFile = project.rootProject.file('config/checkstyle/checkstyle.xml')
+    configFile = project.rootProject.file('etc/config/checkstyle/checkstyle.xml')
 
     // Per submodule
     maxErrors = 1