Add new project to lint our Gradle build scripts, repository-wide.

Quintin Willison · Quintin Willison · commit 401adc6343f6 · 2020-10-21T11:14:57.000+01:00
This commit also fixes violations found with this initial ruleset, formatting, enabled.
diff --git a/android/build.gradle b/android/build.gradle
@@ -58,7 +58,7 @@ android {
         main {
             java {
                 srcDirs = ['src/main/java', '../lib/src/main/java']
-           }
+            }
         }
         androidTest {
             java {
diff --git a/android/maven.gradle b/android/maven.gradle
@@ -11,21 +11,21 @@ def mavenPassword = hasProperty('ossrhPassword') ? ossrhPassword : ''
  * Task which signs and uploads the Android artifacts to Nexus OSSRH.
  */
 uploadArchives {
-	signing {
-		sign configurations.archives
-	}
+    signing {
+        sign configurations.archives
+    }
     repositories.mavenDeployer {
         logger.lifecycle('OSSRH auth with username: ' + mavenUser)
 
-		beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
+        beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
 
-		repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
+        repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
             authentication(userName: mavenUser, password: mavenPassword)
-		}
+        }
 
-		snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
+        snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
             authentication(userName: mavenUser, password: mavenPassword)
-		}
+        }
         pom.groupId = groupId
         pom.artifactId = artifactId
         pom.version = version
@@ -36,16 +36,16 @@ uploadArchives {
             description 'An Android Realtime and REST client library for [Ably.io](https://www.ably.io), the realtime messaging service.'
             packaging 'aar'
             inceptionYear '2015'
-			url 'https://www.github.com/ably/ably-java'
-			developers {
-				developer {
-					name 'Paddy Byers'
-					email 'paddy@ably.io'
-					url 'https://github.com/paddybyers'
-					id 'paddybyers'
-				}
-			}
-			scm {
+            url 'https://www.github.com/ably/ably-java'
+            developers {
+                developer {
+                    name 'Paddy Byers'
+                    email 'paddy@ably.io'
+                    url 'https://github.com/paddybyers'
+                    id 'paddybyers'
+                }
+            }
+            scm {
                 url 'scm:git:https://github.com/ably/ably-java'
                 connection 'scm:git:https://github.com/ably/ably-java'
                 developerConnection 'scm:git:git@github.com:ably/ably-java'
@@ -67,24 +67,24 @@ uploadArchives {
             }
         }
 
-        pom.whenConfigured {
-            p -> p.dependencies = p.dependencies.findAll {
-                // Exclude dependency on lib subproject.
+        pom.whenConfigured { p ->
+            p.dependencies = p.dependencies.findAll {
+                    // Exclude dependency on lib subproject.
                 dep -> dep.artifactId != "lib"
             }.findAll {
-                // Exclude Google services since we don't want to impose a particular
-                // version on users. Ideally we would specify a version range,
-                // but the Google services Gradle plugin doesn't seem to
-                // support that.
-                // TODO: Make sure this works when installing from Maven!
+                    // Exclude Google services since we don't want to impose a particular
+                    // version on users. Ideally we would specify a version range,
+                    // but the Google services Gradle plugin doesn't seem to
+                    // support that.
+                    // TODO: Make sure this works when installing from Maven!
                 dep -> dep.artifactId != 'play-services-gcm' && dep.artifactId != 'firebase-messaging'
             }
         }
 
-		// Export to local Maven cache
+        // Export to local Maven cache
         // COMMENT OUT THIS LINE AND THE ONE BELOW IN ORDER TO RELEASE TO SONATYPE NEXUS STAGING
         // TODO https://github.com/ably/ably-java/issues/566
-		repository(url: repositories.mavenLocal().url)
+        repository(url: repositories.mavenLocal().url)
 
         // Export files to local storage
         // COMMENT OUT THIS LINE AND THE ONE ABOVE IN ORDER TO RELEASE TO SONATYPE NEXUS STAGING
@@ -112,25 +112,25 @@ tasks.whenTaskAdded { task ->
 }
 
 task sourcesJar(type: Jar) {
-     classifier = 'sources'
-     from android.sourceSets.main.java.srcDirs
+    classifier = 'sources'
+    from android.sourceSets.main.java.srcDirs
 }
 
 task javadoc(type: Javadoc) {
-     source = android.sourceSets.main.java.srcDirs
-     classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
-     failOnError false
+    source = android.sourceSets.main.java.srcDirs
+    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
+    failOnError false
 }
 
 afterEvaluate {
-     javadoc.classpath += files(android.libraryVariants.collect { variant ->
-         variant.javaCompile.classpath.files
-     })
+    javadoc.classpath += files(android.libraryVariants.collect { variant ->
+        variant.javaCompile.classpath.files
+    })
 }
 
 task javadocJar(type: Jar, dependsOn: javadoc) {
-     classifier = 'javadoc'
-     from javadoc.destinationDir
+    classifier = 'javadoc'
+    from javadoc.destinationDir
 }
 
 artifacts {
diff --git a/build.gradle b/build.gradle
@@ -1,14 +1,14 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 plugins {
-  id 'io.codearte.nexus-staging' version '0.21.1'
+    id 'io.codearte.nexus-staging' version '0.21.1'
 }
 
 repositories {
-  google()
-  mavenCentral()
+    google()
+    mavenCentral()
 }
 
 nexusStaging {
-	packageGroup = "io.ably"
+    packageGroup = "io.ably"
 }
diff --git a/common.gradle b/common.gradle
@@ -1,13 +1,13 @@
 repositories {
-  jcenter()
-  mavenCentral()
+    jcenter()
+    mavenCentral()
 }
 
 group = 'io.ably'
 version = '1.2.2'
 description = """Ably java client library"""
 
 tasks.withType(Javadoc) {
-  // To prevent javadoc warnings with Java 8
-  options.addStringOption('Xdoclint:none', '-quiet')
+    // To prevent javadoc warnings with Java 8
+    options.addStringOption('Xdoclint:none', '-quiet')
 }
diff --git a/dependencies.gradle b/dependencies.gradle
@@ -1,16 +1,16 @@
 // These dependencies have to be in lib/build.gradle for compilation _and_
 // in java/build.gradle and android/build.gradle for maven.
 dependencies {
-  implementation 'org.msgpack:msgpack-core:0.8.11'
-  implementation 'org.java-websocket:Java-WebSocket:1.4.0'
-  implementation 'com.google.code.gson:gson:2.8.6'
-  implementation 'com.davidehrmann.vcdiff:vcdiff-core:0.1.1'
-  testImplementation 'org.hamcrest:hamcrest-all:1.3'
-  testImplementation 'junit:junit:4.12'
-  testImplementation 'org.nanohttpd:nanohttpd:2.3.0'
-  testImplementation 'org.nanohttpd:nanohttpd-nanolets:2.3.0'
-  testImplementation 'org.nanohttpd:nanohttpd-websocket:2.3.0'
-  testImplementation 'org.mockito:mockito-core:1.10.19'
-  testImplementation 'net.jodah:concurrentunit:0.4.2'
-  testImplementation 'org.slf4j:slf4j-simple:1.7.30'
+    implementation 'org.msgpack:msgpack-core:0.8.11'
+    implementation 'org.java-websocket:Java-WebSocket:1.4.0'
+    implementation 'com.google.code.gson:gson:2.8.6'
+    implementation 'com.davidehrmann.vcdiff:vcdiff-core:0.1.1'
+    testImplementation 'org.hamcrest:hamcrest-all:1.3'
+    testImplementation 'junit:junit:4.12'
+    testImplementation 'org.nanohttpd:nanohttpd:2.3.0'
+    testImplementation 'org.nanohttpd:nanohttpd-nanolets:2.3.0'
+    testImplementation 'org.nanohttpd:nanohttpd-websocket:2.3.0'
+    testImplementation 'org.mockito:mockito-core:1.10.19'
+    testImplementation 'net.jodah:concurrentunit:0.4.2'
+    testImplementation 'org.slf4j:slf4j-simple:1.7.30'
 }
diff --git a/gradle-lint/build.gradle b/gradle-lint/build.gradle
@@ -0,0 +1,86 @@
+plugins {
+    id 'codenarc'
+
+    // This project needs the groovy plugin so that it will recognise groovy source sets,
+    // which is a requirement of using the codenarc plugin.
+    id 'groovy'
+}
+
+repositories {
+    jcenter()
+}
+
+sourceSets {
+    // delegate: https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/SourceSetContainer.html
+    // a.k.a. NamedDomainObjectContainer<SourceSet>
+    // TODO: find canonical reference for how the named domain object container translates to Groovy Gradle DSL
+    // and document that here for future reference.
+    // But, basically, gradleScripts is a name we've made up for this source set. User-defined, if you will.
+
+    /**
+     * Ably-defined name for the source set that encapsulates all Gradle build script files in this repository.
+     * The CodeNarc plugin creates an implicit task called codenarcGradleScripts, based on this name, however
+     * that tasks doesn't pick up the .gradle files. Presumably it filters to process only files with a .groovy
+     * extension. This is why we are invoking CodeNarc by extending the CodeNarc task - see checkWithCodenarc.
+     */
+    gradleScripts {
+        // groovy is a method added by the groovy plugin
+        groovy {
+            // delegate: https://docs.gradle.org/current/dsl/org.gradle.api.file.SourceDirectorySet.html
+            // srcDir "${project.rootProject.files('.')}"
+            srcDir '..'
+            include '**/*.gradle'
+            exclude '**/bin/**'
+        }
+    }
+}
+
+// https://docs.gradle.org/current/dsl/org.gradle.api.plugins.quality.CodeNarcExtension.html
+// We could move configFile to the configuration phase of our runCodenarc task and that works ok.
+// However, reportFormat is not understood there and the reports block that is documented for that block's
+// delegate doesn't seem to have an obvious way to generate output to the console.
+// For this reason the decision has been made to configure the overall nature for CodeNarc in this block,
+// while the specification of which files it lints is made in our ablyCodenarc task.
+codenarc {
+    configFile = file('src/main/groovy/build-script-rules.groovy')
+    reportFormat 'console'
+}
+
+dependencies {
+    // To use the groovy plugin we have to tell it where to get Groovy from.
+    // As this project is checking build scripts used by Gradle projects in this repository,
+    // including this project, the local Groovy instance is exactly what we need.
+    implementation localGroovy()
+}
+
+/**
+ * This task is informational, here to help with debugging issues with our use of codenarc.
+ */
+tasks.register('listBuildScriptsCheckedWithCodenarc') {
+    group = 'Ably'
+    description = 'Lists the build script files which will be checked by the checkWithCodenarc task.'
+
+    doLast {
+        sourceSets.each { sourceSet ->
+            println("$sourceSet:")
+            boolean noSourceFound = true
+            sourceSet.allSource.each { file ->
+                println("\t$file")
+                noSourceFound = false
+            }
+            if (noSourceFound) {
+                println('\tNo source files captured by this source set.')
+            }
+        }
+    }
+}
+
+tasks.register('checkWithCodenarc', CodeNarc) { cn ->
+    // delegate: https://docs.gradle.org/current/dsl/org.gradle.api.plugins.quality.CodeNarc.html
+    group = 'Ably'
+    description = 'Checks the build script files in this repository using CodeNarc.'
+
+    sourceSets.each { sourceSet ->
+        cn.source sourceSet.allSource
+    }
+}
diff --git a/gradle-lint/src/main/groovy/build-script-rules.groovy b/gradle-lint/src/main/groovy/build-script-rules.groovy
@@ -0,0 +1,9 @@
+ruleset {
+    ruleset('rulesets/formatting.xml') {
+        // This rule requires a space before the colon, which is unnecessary and less human-readable - especially in our JSON-rich world.
+        exclude 'SpaceAroundMapEntryColon'
+
+        // Arbitrary, ending up forcing developers to contort code unecessarily - especially for string definitions.
+        exclude 'LineLength'
+    }
+}
diff --git a/java/maven.gradle b/java/maven.gradle
@@ -20,7 +20,7 @@ uploadArchives {
 
         beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
 
-	    repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
+        repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
             authentication(userName: mavenUser, password: mavenPassword)
         }
 
@@ -38,15 +38,15 @@ uploadArchives {
             description 'A Java Realtime and REST client library for [Ably.io](https://www.ably.io), the realtime messaging service.'
             packaging 'jar'
             inceptionYear '2015'
-			url 'https://www.github.com/ably/ably-java'
-			developers {
-				developer {
-					name 'Paddy Byers'
-					email 'paddy@ably.io'
-					url 'https://github.com/paddybyers'
-					id 'paddybyers'
-				}
-			}
+            url 'https://www.github.com/ably/ably-java'
+            developers {
+                developer {
+                    name 'Paddy Byers'
+                    email 'paddy@ably.io'
+                    url 'https://github.com/paddybyers'
+                    id 'paddybyers'
+                }
+            }
             scm {
                 url 'scm:git:https://github.com/ably/ably-java'
                 connection 'scm:git:https://github.com/ably/ably-java'
@@ -70,8 +70,8 @@ uploadArchives {
         }
 
         // Exclude test dependencies
-        pom.whenConfigured {
-            p -> p.dependencies = p.dependencies.findAll {
+        pom.whenConfigured { p ->
+            p.dependencies = p.dependencies.findAll {
                 dep -> dep.scope == 'runtime'
             }
         }
@@ -99,13 +99,13 @@ task assembleRelease {
 }
 
 task sourcesJar(type: Jar) {
-     classifier = 'sources'
-     from sourceSets.main.allSource
+    classifier = 'sources'
+    from sourceSets.main.allSource
 }
 
 task javadocJar(type: Jar, dependsOn: javadoc) {
-     classifier = 'javadoc'
-     from javadoc.destinationDir
+    classifier = 'javadoc'
+    from javadoc.destinationDir
 }
 
 artifacts {
diff --git a/settings.gradle b/settings.gradle
@@ -1,6 +1,8 @@
 rootProject.name = 'ably-java'
 include 'java'
 
-if(System.getenv('ANDROID_HOME')) {
-  include 'android'
+if (System.getenv('ANDROID_HOME')) {
+    include 'android'
 }
+
+include 'gradle-lint'

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ android {`
`58`	`58`	`main {`
`59`	`59`	`java {`
`60`	`60`	`srcDirs = ['src/main/java', '../lib/src/main/java']`
`61`		`- }`
	`61`	`+ }`
`62`	`62`	`}`
`63`	`63`	`androidTest {`
`64`	`64`	`java {`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`	`1`	`// Top-level build file where you can add configuration options common to all sub-projects/modules.`
`2`	`2`
`3`	`3`	`plugins {`
`4`		`- id 'io.codearte.nexus-staging' version '0.21.1'`
	`4`	`+ id 'io.codearte.nexus-staging' version '0.21.1'`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`repositories {`
`8`		`- google()`
`9`		`- mavenCentral()`
	`8`	`+ google()`
	`9`	`+ mavenCentral()`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`nexusStaging {`
`13`		`- packageGroup = "io.ably"`
	`13`	`+ packageGroup = "io.ably"`
`14`	`14`	`}`