Implement a simple nullaway wrapper plugin

baseline-null-away/README.md

@@ -0,0 +1 @@
+This module acts as a thin shim around NullAway, allowing us to manage the NullAway dependency via baseline.

baseline-null-away/baseline-class-uniqueness.lock

@@ -0,0 +1,10 @@
+# Danger! Multiple jars contain identically named classes. This may cause different behaviour depending on classpath ordering.
+# Run ./gradlew checkClassUniqueness --write-locks to update this file
+
+## runtimeClasspath
+[org.checkerframework:checker-qual, org.checkerframework:dataflow-nullaway]
+  - org.checkerframework.dataflow.qual.Deterministic
+  - org.checkerframework.dataflow.qual.Pure
+  - org.checkerframework.dataflow.qual.Pure$Kind
+  - org.checkerframework.dataflow.qual.SideEffectFree
+  - org.checkerframework.dataflow.qual.TerminatesExecution

baseline-null-away/build.gradle

@@ -0,0 +1,7 @@
+apply plugin: 'java-library'
+apply plugin: 'com.palantir.external-publish-jar'
+
+dependencies {
+    runtimeOnly 'com.uber.nullaway:nullaway'
+    runtimeOnly 'org.checkerframework:dataflow-nullaway'
+}

changelog/@unreleased/pr-2382.v2.yml

@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Implement a simple nullaway wrapper plugin `com.palantir.baseline-null-away`
+  links:
+  - https://github.com/palantir/gradle-baseline/pull/2382

gradle-baseline-java/build.gradle

@@ -55,6 +55,7 @@ dependencies {
 
 tasks.test.dependsOn tasks.findByPath(':gradle-baseline-java-config:publishToMavenLocal')
 tasks.test.dependsOn tasks.findByPath(':baseline-error-prone:publishToMavenLocal')
+tasks.test.dependsOn tasks.findByPath(':baseline-null-away:publishToMavenLocal')
 tasks.test.dependsOn tasks.findByPath(':baseline-refaster-javac-plugin:publishToMavenLocal')
 tasks.test.dependsOn tasks.findByPath(':baseline-refaster-rules:publishToMavenLocal')
 tasks.test.dependsOn tasks.publishToMavenLocal

gradle-baseline-java/src/main/groovy/com/palantir/baseline/plugins/BaselineNullAway.java

@@ -0,0 +1,78 @@
+/*
+ * (c) Copyright 2022 Palantir Technologies Inc. All rights reserved.
+ *
+ * Licensed 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 com.palantir.baseline.plugins;
+
+import java.util.Optional;
+import net.ltgt.gradle.errorprone.ErrorProneOptions;
+import org.gradle.api.Action;
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.logging.Logger;
+import org.gradle.api.logging.Logging;
+import org.gradle.api.plugins.ExtensionAware;
+import org.gradle.api.tasks.compile.JavaCompile;
+
+public final class BaselineNullAway implements Plugin<Project> {
+
+    private static final Logger log = Logging.getLogger(BaselineNullAway.class);
+
+    // This nullaway dependency in our plugin allows dependency upgrades on the baseline
+    // project to ensure nullaway remains up to date for all consumers.
+    private static final String NULLAWAY_VERSION = "0.10.1";
+
+    @Override
+    public void apply(Project project) {
+        project.getPluginManager().withPlugin("com.palantir.baseline-error-prone", _unused0 -> {
+            project.getPluginManager().withPlugin("java", _unused1 -> {
+                applyToProject(project);
+            });
+        });
+    }
+
+    private void applyToProject(Project project) {
+        String version = Optional.ofNullable(BaselineNullAway.class.getPackage().getImplementationVersion())
+                .orElseGet(() -> {
+                    log.warn("BaselineNullAway is using 'latest.release' - "
+                            + "beware this compromises build reproducibility");
+                    return "latest.release";
+                });
+        project.getDependencies().add("errorprone", "com.palantir.baseline:baseline-null-away:" + version);
+        configureErrorProneOptions(project, new Action<ErrorProneOptions>() {
+            @Override
+            public void execute(ErrorProneOptions options) {
+                options.option("NullAway:AnnotatedPackages", "com.palantir");
+                options.option("NullAway:CheckOptionalEmptiness", "true");
+            }
+        });
+    }
+
+    private static void configureErrorProneOptions(Project proj, Action<ErrorProneOptions> action) {
+        proj.afterEvaluate(new Action<Project>() {
+            @Override
+            public void execute(Project project) {
+                project.getTasks().withType(JavaCompile.class).configureEach(new Action<JavaCompile>() {
+                    @Override
+                    public void execute(JavaCompile javaCompile) {
+                        ((ExtensionAware) javaCompile.getOptions())
+                                .getExtensions()
+                                .configure(ErrorProneOptions.class, action);
+                    }
+                });
+            }
+        });
+    }
+}

gradle-baseline-java/src/main/resources/META-INF/gradle-plugins/com.palantir.baseline-null-away.properties

@@ -0,0 +1,16 @@
+#
+# Copyright 2022 Palantir Technologies, Inc. All rights reserved.
+#
+# Licensed 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.
+#
+implementation-class=com.palantir.baseline.plugins.BaselineNullAway

gradle-baseline-java/src/test/groovy/com/palantir/baseline/BaselineNullAwayIntegrationTest.groovy

@@ -0,0 +1,88 @@
+/*
+ * (c) Copyright 2022 Palantir Technologies Inc. All rights reserved.
+ *
+ * Licensed 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 com.palantir.baseline
+
+
+import org.gradle.testkit.runner.BuildResult
+import org.gradle.testkit.runner.TaskOutcome
+import spock.lang.Unroll
+
+class BaselineNullAwayIntegrationTest extends AbstractPluginTest {
+
+    def standardBuildFile = '''
+        plugins {
+            id 'java'
+            id 'com.palantir.baseline-error-prone'
+            id 'com.palantir.baseline-null-away'
+            id 'com.palantir.baseline-java-versions'
+        }
+        repositories {
+            mavenLocal()
+            mavenCentral()
+        }
+        javaVersions {
+            libraryTarget = 17
+        }
+        tasks.withType(JavaCompile).configureEach {
+            options.compilerArgs += ['-Werror']
+        }
+    '''.stripIndent()
+
+    def validJavaFile = '''
+        package com.palantir.test;
+        public class Test { void test() {} }
+        '''.stripIndent()
+
+    def invalidJavaFile = '''
+        package com.palantir.test;
+        public class Test {
+            int test(Throwable throwable) {
+                // uh-oh, getMessage may be null!
+                return throwable.getMessage().hashCode();
+            }
+        }
+        '''.stripIndent()
+
+    def 'Can apply plugin'() {
+        when:
+        buildFile << standardBuildFile
+
+        then:
+        with('compileJava', '--info').build()
+    }
+
+    def 'compileJava fails when null-away finds errors'() {
+        when:
+        buildFile << standardBuildFile
+        file('src/main/java/com/palantir/test/Test.java') << invalidJavaFile
+
+        then:
+        BuildResult result = with('compileJava').buildAndFail()
+        result.task(":compileJava").outcome == TaskOutcome.FAILED
+        result.output.contains("[NullAway] dereferenced expression throwable.getMessage() is @Nullable")
+    }
+
+    def 'compileJava succeeds when null-away finds no errors'() {
+        when:
+        buildFile << standardBuildFile
+        file('src/main/java/com/palantir/test/Test.java') << validJavaFile
+
+        then:
+        BuildResult result = with('compileJava').build()
+        result.task(":compileJava").outcome == TaskOutcome.SUCCESS
+    }
+}

settings.gradle

@@ -1,6 +1,7 @@
 rootProject.name = "gradle-baseline"
 
 include "baseline-error-prone"
+include "baseline-null-away"
 include "baseline-refaster-javac-plugin"
 include "baseline-refaster-rules"
 include "baseline-refaster-testing"

versions.lock

@@ -23,7 +23,7 @@ com.google.errorprone:error_prone_test_helpers:2.15.0 (1 constraints: 3a053e3b)
 com.google.errorprone:error_prone_type_annotations:2.15.0 (1 constraints: 251151c9)
 com.google.googlejavaformat:google-java-format:1.13.0 (1 constraints: 8b149d75)
 com.google.guava:failureaccess:1.0.1 (1 constraints: 140ae1b4)
-com.google.guava:guava:31.1-jre (13 constraints: 3cdc2b02)
+com.google.guava:guava:31.1-jre (14 constraints: d6e9749b)
 com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava (1 constraints: bd17c918)
 com.google.inject:guice:4.2.2 (1 constraints: e40b61f3)
 com.google.j2objc:j2objc-annotations:1.3 (1 constraints: b809eda0)
@@ -40,6 +40,7 @@ com.palantir.javaformat:palantir-java-format-spi:1.1.0 (1 constraints: 711560be)
 com.palantir.safe-logging:preconditions:3.0.0 (6 constraints: 76574831)
 com.palantir.safe-logging:safe-logging:3.0.0 (8 constraints: 8777131f)
 com.palantir.tritium:tritium-registry:0.50.0 (1 constraints: 3705333b)
+com.uber.nullaway:nullaway:0.10.1 (1 constraints: 3405243b)
 commons-io:commons-io:2.11.0 (2 constraints: 1426005d)
 commons-lang:commons-lang:2.6 (1 constraints: ac04232c)
 io.dropwizard.metrics:metrics-core:4.1.1 (1 constraints: 901088a5)
@@ -70,6 +71,7 @@ org.apache.maven.shared:maven-shared-utils:3.3.4 (1 constraints: e60b61f3)
 org.assertj:assertj-core:3.23.1 (3 constraints: e42af49e)
 org.checkerframework:checker-qual:3.23.0 (3 constraints: 08256088)
 org.checkerframework:dataflow-errorprone:3.23.0 (4 constraints: fa3d685c)
+org.checkerframework:dataflow-nullaway:3.25.0 (2 constraints: 6911b8f1)
 org.codehaus.groovy:groovy:3.0.10 (3 constraints: e32879d6)
 org.codehaus.groovy:groovy-xml:3.0.10 (1 constraints: 791161da)
 org.codehaus.plexus:plexus-cipher:2.0 (1 constraints: 641174c7)

versions.props

@@ -15,6 +15,8 @@ com.googlecode.java-diff-utils:diffutils = 1.3.0
 com.puppycrawl.tools:checkstyle = 10.3.2
 org.checkerframework:* = 3.23.0
 com.palantir.gradle.utils:* = 0.1.0
+com.uber.nullaway:nullaway = 0.10.1
+org.checkerframework:dataflow-nullaway = 3.25.0
 
 # test deps
 com.fasterxml.jackson.*:* = 2.13.3