Add CheckerFramework to GitHub Actions CI

CheckerFramework needs an annotated JDK, so it is not activated by default

Author: vlsi

.github/workflows/main.yml

@@ -129,3 +129,20 @@ jobs:
         with:
           job-id: jdk8
           arguments: --scan --no-parallel --no-daemon testSlow
+
+  linux-checkerframework:
+    name: 'CheckerFramework (JDK 11)'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 50
+      - name: 'Set up JDK 11'
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: 'Run CheckerFramework'
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: checkerframework-jdk11
+          arguments: --scan --no-parallel --no-daemon -PenableCheckerframework classes

bom/build.gradle.kts

@@ -46,6 +46,7 @@ dependencies {
         // In other words, marking dependency as "runtime" would avoid accidental
         // dependency on it during compilation
         apiv("com.beust:jcommander")
+        apiv("org.checkerframework:checker-qual", "checkerframework")
         apiv("com.datastax.cassandra:cassandra-driver-core")
         apiv("com.esri.geometry:esri-geometry-api")
         apiv("com.fasterxml.jackson.core:jackson-annotations", "jackson")

build.gradle.kts

@@ -33,6 +33,7 @@ plugins {
     // Verification
     checkstyle
     calcite.buildext
+    id("org.checkerframework") apply false
     id("com.github.autostyle")
     id("org.nosphere.apache.rat")
     id("com.github.spotbugs")
@@ -63,6 +64,7 @@ val enableSpotBugs = props.bool("spotbugs")
 val skipCheckstyle by props()
 val skipAutostyle by props()
 val skipJavadoc by props()
+val enableCheckerframework by props()
 val enableMavenLocal by props()
 val enableGradleMetadata by props()
 // Inherited from stage-vote-release-plugin: skipSign, useGpgCmd
@@ -506,6 +508,38 @@ allprojects {
             signaturesFiles = files("$rootDir/src/main/config/forbidden-apis/signatures.txt")
         }
 
+        if (enableCheckerframework) {
+            apply(plugin = "org.checkerframework")
+            dependencies {
+                "checkerFramework"("org.checkerframework:checker:${"checkerframework".v}")
+                // CheckerFramework annotations might be used in the code as follows:
+                // dependencies {
+                //     "compileOnly"("org.checkerframework:checker-qual")
+                //     "testCompileOnly"("org.checkerframework:checker-qual")
+                // }
+                if (JavaVersion.current() == JavaVersion.VERSION_1_8) {
+                    // only needed for JDK 8
+                    "checkerFrameworkAnnotatedJDK"("org.checkerframework:jdk8")
+                }
+            }
+            configure<org.checkerframework.gradle.plugin.CheckerFrameworkExtension> {
+                skipVersionCheck = true
+                // See https://checkerframework.org/manual/#introduction
+                checkers.add("org.checkerframework.checker.nullness.NullnessChecker")
+                // Below checkers take significant time and they do not provide much value :-/
+                // checkers.add("org.checkerframework.checker.optional.OptionalChecker")
+                // checkers.add("org.checkerframework.checker.regex.RegexChecker")
+                // https://checkerframework.org/manual/#creating-debugging-options-progress
+                // extraJavacArgs.add("-Afilenames")
+                // https://checkerframework.org/manual/#stub-using
+                extraJavacArgs.add("-Astubs=" +
+                        fileTree("$rootDir/src/main/config/checkerframework") {
+                            include("*.astub")
+                        }.asPath
+                )
+            }
+        }
+
         tasks {
             configureEach<Jar> {
                 manifest {
@@ -535,6 +569,9 @@ allprojects {
             configureEach<JavaCompile> {
                 options.encoding = "UTF-8"
                 options.compilerArgs.addAll(listOf("-Xlint:deprecation", "-Werror"))
+                if (enableCheckerframework) {
+                    options.forkOptions.memoryMaximumSize = "2g"
+                }
             }
             configureEach<Test> {
                 outputs.cacheIf("test results depend on the database configuration, so we souldn't cache it") {

gradle.properties

@@ -41,6 +41,7 @@ calcite.avatica.version=1.17.0
 # publishGradleMetadata=true
 
 # Plugins
+org.checkerframework.version=0.5.9
 com.github.autostyle.version=3.0
 com.github.johnrengelman.shadow.version=5.1.0
 com.github.spotbugs.version=2.0.0
@@ -71,6 +72,7 @@ bouncycastle.version=1.60
 cassandra-all.version=3.11.2
 cassandra-driver-core.version=3.6.0
 cassandra-unit.version=3.5.0.1
+checkerframework.version=3.6.0
 chinook-data-hsqldb.version=0.1
 commons-codec.version=1.12
 commons-dbcp2.version=2.6.0

settings.gradle.kts

@@ -19,6 +19,7 @@ pluginManagement {
         fun String.v() = extra["$this.version"].toString()
         fun PluginDependenciesSpec.idv(id: String, key: String = id) = id(id) version key.v()
 
+        idv("org.checkerframework")
         idv("com.github.autostyle")
         idv("com.github.johnrengelman.shadow")
         idv("com.github.spotbugs")