[CALCITE-4199] Add CheckerFramework to GitHub Actions CI

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

Author: vlsi

.github/workflows/main.yml

@@ -147,6 +147,23 @@ jobs:
           job-id: errprone
           arguments: --scan --no-parallel --no-daemon -PenableErrorprone classes
 
+  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
+
   linux-slow:
     # Run slow tests when the commit is on master or it is requested explicitly by adding an
     # appropriate label in the PR
@@ -166,6 +183,7 @@ jobs:
         with:
           job-id: jdk8
           arguments: --scan --no-parallel --no-daemon testSlow
+
   linux-druid:
     if: github.event.action != 'labeled'
     name: 'Linux (JDK 8) Druid Tests'

bom/build.gradle.kts

@@ -53,12 +53,14 @@ dependencies {
         // dependency on it during compilation
         apiv("com.alibaba.database:innodb-java-reader")
         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-databind")
         apiv("com.github.kstyrc:embedded-redis")
         apiv("com.github.stephenc.jcip:jcip-annotations")
-        apiv("com.google.code.findbugs:jsr305", "findbugs.jsr305")
+        apiv("com.google.errorprone:error_prone_annotations", "errorprone")
+        apiv("com.google.errorprone:error_prone_type_annotations", "errorprone")
         apiv("com.google.guava:guava")
         apiv("com.google.protobuf:protobuf-java", "protobuf")
         apiv("com.google.uzaygezen:uzaygezen-core", "uzaygezen")

build.gradle.kts

@@ -37,6 +37,7 @@ plugins {
     // Verification
     checkstyle
     calcite.buildext
+    id("org.checkerframework") apply false
     id("com.github.autostyle")
     id("org.nosphere.apache.rat")
     id("com.github.spotbugs")
@@ -65,6 +66,7 @@ val lastEditYear by extra(lastEditYear())
 
 // Do not enable spotbugs by default. Execute it only when -Pspotbugs is present
 val enableSpotBugs = props.bool("spotbugs")
+val enableCheckerframework by props()
 val enableErrorprone by props()
 val skipCheckstyle by props()
 val skipAutostyle by props()
@@ -454,6 +456,8 @@ allprojects {
                         replace("junit5: Assert.fail", "org.junit.Assert.fail", "org.junit.jupiter.api.Assertions.fail")
                     }
                     replaceRegex("side by side comments", "(\n\\s*+[*]*+/\n)(/[/*])", "\$1\n\$2")
+                    replaceRegex("jsr305 nullable -> checkerframework", "javax\\.annotation\\.Nullable", "org.checkerframework.checker.nullness.qual.Nullable")
+                    replaceRegex("jsr305 nonnull -> checkerframework", "javax\\.annotation\\.Nonnull", "org.checkerframework.checker.nullness.qual.NonNull")
                     importOrder(
                         "org.apache.calcite.",
                         "org.apache.",
@@ -552,6 +556,43 @@ allprojects {
                 }
             }
         }
+        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")
+                extraJavacArgs.addAll(listOf("-Xmaxerrs", "10000"))
+                // Consider Java assert statements for nullness and other checks
+                extraJavacArgs.add("-AassumeAssertionsAreEnabled")
+                // https://checkerframework.org/manual/#stub-using
+                extraJavacArgs.add("-Astubs=" +
+                        fileTree("$rootDir/src/main/config/checkerframework") {
+                            include("**/*.astub")
+                        }.asPath
+                )
+                if (project.path == ":core") {
+                    extraJavacArgs.add("-AskipDefs=^org\\.apache\\.calcite\\.sql\\.parser\\.impl\\.")
+                }
+            }
+        }
 
         tasks {
             configureEach<Jar> {
@@ -585,6 +626,9 @@ allprojects {
                 if (werror) {
                     options.compilerArgs.add("-Werror")
                 }
+                if (enableCheckerframework) {
+                    options.forkOptions.memoryMaximumSize = "2g"
+                }
             }
             configureEach<Test> {
                 outputs.cacheIf("test results depend on the database configuration, so we souldn't cache it") {

core/build.gradle.kts

@@ -47,7 +47,7 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
     implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")
-    implementation("com.google.code.findbugs:jsr305"/* optional*/)
+    implementation("com.google.errorprone:error_prone_annotations")
     implementation("com.google.guava:guava")
     implementation("com.google.uzaygezen:uzaygezen-core")
     implementation("com.jayway.jsonpath:json-path")
@@ -56,6 +56,7 @@ dependencies {
     implementation("net.hydromatic:aggdesigner-algorithm")
     implementation("org.apache.commons:commons-dbcp2")
     implementation("org.apache.commons:commons-lang3")
+    implementation("org.checkerframework:checker-qual")
     implementation("commons-io:commons-io")
     implementation("org.codehaus.janino:commons-compiler")
     implementation("org.codehaus.janino:janino")

druid/build.gradle.kts

@@ -20,11 +20,11 @@ dependencies {
 
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
-    implementation("com.google.code.findbugs:jsr305")
     implementation("com.google.guava:guava")
     implementation("joda-time:joda-time")
     implementation("org.apache.calcite.avatica:avatica-core")
     implementation("org.apache.commons:commons-lang3")
+    implementation("org.checkerframework:checker-qual")
     implementation("org.slf4j:slf4j-api")
 
     testImplementation(project(":core", "testClasses"))

elasticsearch/build.gradle.kts

@@ -28,11 +28,11 @@ dependencies {
 
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
-    implementation("com.google.code.findbugs:jsr305")
     implementation("com.google.guava:guava")
     implementation("org.apache.calcite.avatica:avatica-core")
     implementation("org.apache.httpcomponents:httpclient")
     implementation("org.apache.httpcomponents:httpcore")
+    implementation("org.checkerframework:checker-qual")
     implementation("org.elasticsearch.client:elasticsearch-rest-client")
     implementation("org.slf4j:slf4j-api")
 

gradle.properties

@@ -42,6 +42,7 @@ calcite.avatica.version=1.17.0
 # publishGradleMetadata=true
 
 # Plugins
+org.checkerframework.version=0.5.10
 com.github.autostyle.version=3.0
 com.github.johnrengelman.shadow.version=5.1.0
 com.github.spotbugs.version=2.0.0
@@ -60,6 +61,7 @@ org.owasp.dependencycheck.version=5.2.2
 # docker-maven-plugin.version=1.2.0
 
 # Tools
+checkerframework.version=3.7.0
 checkstyle.version=8.28
 spotbugs.version=3.1.11
 errorprone.version=2.4.0
@@ -82,8 +84,8 @@ commons-lang3.version=3.8
 dropwizard-metrics.version=4.0.5
 elasticsearch.version=7.0.1
 embedded-redis.version=0.6
+errorprone.version=2.4.0
 esri-geometry-api.version=2.2.0
-findbugs.jsr305.version=3.0.1
 foodmart-data-hsqldb.version=0.3
 foodmart-data-json.version=0.4
 foodmart-queries.version=0.4.1

linq4j/build.gradle.kts

@@ -19,4 +19,5 @@ dependencies {
 
     implementation("com.google.guava:guava")
     implementation("org.apache.calcite.avatica:avatica-core")
+    implementation("org.checkerframework:checker-qual")
 }

piglet/build.gradle.kts

@@ -23,11 +23,11 @@ dependencies {
     api(project(":core"))
     api(project(":linq4j"))
 
-    implementation("com.google.code.findbugs:jsr305")
     implementation("com.google.guava:guava")
     implementation("org.apache.calcite.avatica:avatica-core")
     implementation("org.apache.hadoop:hadoop-common")
     implementation("org.apache.pig:pig::h2")
+    implementation("org.checkerframework:checker-qual")
     implementation("org.slf4j:slf4j-api")
 
     testImplementation(project(":core", "testClasses"))

redis/build.gradle.kts

@@ -21,7 +21,6 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
     implementation("com.github.kstyrc:embedded-redis")
-    implementation("com.google.code.findbugs:jsr305")
     implementation("com.google.guava:guava")
     implementation("joda-time:joda-time")
     implementation("org.apache.calcite.avatica:avatica-core")

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")

src/main/config/checkerframework/Collection.astub

@@ -0,0 +1,25 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.util;
+
+import java.util.function.Supplier;
+import org.checkerframework.checker.nullness.qual.*;
+
+interface Collection<E> {
+  boolean contains(@Nullable Object o);
+  boolean remove(@Nullable Object o);
+}

src/main/config/checkerframework/Constructor.astub

@@ -0,0 +1,23 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.lang.reflect;
+
+import org.checkerframework.checker.nullness.qual.*;
+
+class Constructor<T> {
+  public @NonNull T newInstance(@Nullable Object... initargs);
+}

src/main/config/checkerframework/Field.astub

@@ -0,0 +1,24 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.lang.reflect;
+
+import org.checkerframework.checker.nullness.qual.*;
+
+class Field {
+  @Nullable Object get(@Nullable Object obj);
+  int getInt(@Nullable Object obj);
+}

src/main/config/checkerframework/InvocationHandler.astub

@@ -0,0 +1,23 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.lang.reflect;
+
+import org.checkerframework.checker.nullness.qual.*;
+
+interface InvocationHandler {
+    @Nullable Object invoke(Object proxy, Method method, @Nullable Object[] args);
+}

src/main/config/checkerframework/List.astub

@@ -0,0 +1,27 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.util;
+
+import java.util.function.Supplier;
+import org.checkerframework.checker.nullness.qual.*;
+
+interface List<E> {
+  boolean contains(@Nullable Object o);
+  boolean remove(@Nullable Object o);
+  int indexOf(@Nullable Object o);
+  int lastIndexOf(@Nullable Object o);
+}

src/main/config/checkerframework/Map.astub

@@ -0,0 +1,29 @@
+/*
+ * 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
+ *
+ * http://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.
+ */
+package java.util;
+
+import java.util.function.Supplier;
+import org.checkerframework.checker.nullness.qual.*;
+
+interface Map<K, V> {
+  boolean containsKey(@Nullable Object o);
+  boolean containsValue(@Nullable Object value);
+  boolean remove(@Nullable Object key, @Nullable Object value);
+  @Nullable V remove(@Nullable Object o);
+  @Nullable V get(@Nullable Object key);
+  V getOrDefault(@Nullable Object key, V defaultValue);
+}