Merge pull request #878 from ascopes/task/GH-564-nullaway

Implement nullability analysis, fix errorprone and nullability issues

Author: ascopes

.github/dependabot.yml

@@ -13,11 +13,6 @@ updates:
       - ci
   - package-ecosystem: maven
     directory: /
-    groups:
-      # Group all Maven updates into a single PR.
-      maven:
-        patterns:
-          - "*"
     open-pull-requests-limit: 99
     rebase-strategy: auto
     schedule:

.mvn/jvm.config

@@ -1,2 +1,15 @@
--XX:+TieredCompilation
+-Xshare:auto
 -XX:TieredStopAtLevel=1
+-XX:+CrashOnOutOfMemoryError
+-XX:+TieredCompilation
+-XX:+UseParallelGC
+--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED

java-compiler-testing/pom.xml

@@ -115,7 +115,8 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <configuration>
-          <compilerArgs>
+          <annotationProcessorPaths combine.children="append"/>
+          <compilerArgs combine.children="append">
             <!--
               Disable warnings about modules. We cannot do much about some of these due to how Maven
               works with modules with Surefire.
@@ -214,5 +215,69 @@
         </pluginManagement>
       </build>
     </profile>
+
+    <profile>
+      <!-- ErrorProne only works with Java 21 and newer. If we're on Java 17, we cannot
+           enable it within the compiler. This is somewhat unfortunate but should be okay
+           as a workaround for now since we build on multiple JDKs on GitHub. -->
+      <id>errorprone</id>
+      <activation>
+        <jdk>[21,)</jdk>
+      </activation>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+
+            <configuration>
+              <annotationProcessorPaths>
+                <annotationProcessorPath>
+                  <groupId>com.google.errorprone</groupId>
+                  <artifactId>error_prone_core</artifactId>
+                  <version>${errorprone.version}</version>
+                </annotationProcessorPath>
+                <annotationProcessorPath>
+                  <!-- Override what Maven is pulling in. This is fine during compilation as our
+                       code doesn't use Guava at all. This is needed for ErrorProne to not crash
+                       on startup. -->
+                  <groupId>com.google.guava</groupId>
+                  <artifactId>guava</artifactId>
+                  <version>[33,)</version>
+                </annotationProcessorPath>
+                <annotationProcessorPath>
+                  <groupId>com.uber.nullaway</groupId>
+                  <artifactId>nullaway</artifactId>
+                  <version>${nullaway.version}</version>
+                </annotationProcessorPath>
+              </annotationProcessorPaths>
+
+              <compilerArgs>
+                <!--
+                  Disable warnings about modules. We cannot do much about some of these due to how Maven
+                  works with modules with Surefire.
+                -->
+                <arg>-Xlint:-module</arg>
+                <!-- ErrorProne configuration -->
+                <compilerArg>--should-stop=ifError=FLOW</compilerArg>
+                <compilerArg>
+                  -Xplugin:ErrorProne
+                  -XepDisableWarningsInGeneratedCode
+                  -XepExcludedPaths:.*/target/generated.*?/.*
+                  -XepOpt:NullAway:AnnotatedPackages=io.github.ascopes.jct
+                  <!-- See https://github.com/uber/NullAway/issues/1319 -->
+                  -XepOpt:NullAway:ExcludedFieldAnnotations=org.junit.jupiter.*,org.mockito.*
+                  -XepOpt:NullAway:KnownInitializers=io.github.ascopes.jct.annotations.Initializer,io.github.ascopes.jct.junit.Managed
+                </compilerArg>
+                <!-- Needed for ErrorProne to be able to run -->
+                <compilerArg>-XDaddTypeAnnotationsToSymbol=true</compilerArg>
+                <compilerArg>-XDcompilePolicy=simple</compilerArg>
+              </compilerArgs>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 </project>

java-compiler-testing/src/it/google-error-prone/pom.xml

@@ -49,8 +49,6 @@
       <!-- Workaround for https://youtrack.jetbrains.com/issue/IDEA-317391 -->
       -DmvnArgLinePropagated=true
     </argLine>
-
-    <error-prone.version>2.36.0</error-prone.version>
   </properties>
 
   <dependencies>
@@ -64,7 +62,7 @@
     <dependency>
       <groupId>com.google.errorprone</groupId>
       <artifactId>error_prone_core</artifactId>
-      <version>${error-prone.version}</version>
+      <version>${errorprone.version}</version>
       <scope>test</scope>
     </dependency>
 

java-compiler-testing/src/it/google-error-prone/selector.bsh

@@ -14,10 +14,9 @@
  * limitations under the License.
  */
 // Use bsh rather than groovy since groovy does not support arbitrary JVM bytecode versions.
-if (Runtime.version().toString().toLowerCase().contains("ea")) {
-  System.out.println("Error Prone does not support EA releases of the JDK.");
+if (Runtime.version().major() < 21) {
+  System.out.println("Micronaut does not support JVMs before Java 21");
   return false;
 } else {
-  System.out.println("Detected a GA release, proceeding");
   return true;
 }

java-compiler-testing/src/it/google-error-prone/src/test/java/io/github/ascopes/jct/acceptancetests/errorprone/ErrorProneTest.java

@@ -57,6 +57,7 @@ void happyPathsWorkAsExpected(JctCompiler compiler) {
     // When
     var compilation = compiler
         .addCompilerOptions(
+            "-XDaddTypeAnnotationsToSymbol=true",
             "-Xplugin:ErrorProne",
             "-XDcompilePolicy=simple",
             "--should-stop=ifError=FLOW"
@@ -79,6 +80,7 @@ void sadPathsFailAsExpected(JctCompiler compiler) {
     // When
     var compilation = compiler
         .addCompilerOptions(
+            "-XDaddTypeAnnotationsToSymbol=true",
             "-Xplugin:ErrorProne",
             "-XDcompilePolicy=simple",
             "--should-stop=ifError=FLOW"

java-compiler-testing/src/main/java/io/github/ascopes/jct/annotations/DeadCodeGenerated.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2022 Ashley Scopes
+ *
+ * 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 io.github.ascopes.jct.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a method as being known to have uncoverable code-paths by design.
+ *
+ * <p>The {@code Generated} suffix tells JaCoCo to ignore coverage for this method.
+ *
+ * @author Ashley Scopes
+ * @since 6.0.1
+ */
+@Retention(RetentionPolicy.CLASS)
+@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.TYPE})
+public @interface DeadCodeGenerated {
+}

java-compiler-testing/src/main/java/io/github/ascopes/jct/annotations/Initializer.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2022 Ashley Scopes
+ *
+ * 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 io.github.ascopes.jct.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks the annotation as being an initialiser annotation, which keeps NullAway happy.
+ *
+ * @author Ashley Scopes
+ * @since 6.0.1
+ */
+@Documented
+@Retention(RetentionPolicy.CLASS)
+@Target(ElementType.ANNOTATION_TYPE)
+public @interface Initializer {
+}

java-compiler-testing/src/main/java/io/github/ascopes/jct/annotations/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2022 Ashley Scopes
+ *
+ * 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.
+ */
+/**
+ * Annotations used for various metadata purposes.
+ */
+package io.github.ascopes.jct.annotations;

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/AbstractEnumAssert.java

@@ -36,12 +36,11 @@ public abstract class AbstractEnumAssert<A extends AbstractEnumAssert<A, E>, E e
     extends AbstractAssert<A, E> {
 
   /**
-   * Initialize this enum assertion.
+   * Initialise this enum assertion.
    *
    * @param value    the value to assert upon.
    * @param selfType the type of this assertion implementation.
    */
-  @SuppressWarnings("DataFlowIssue")
   protected AbstractEnumAssert(@Nullable E value, Class<?> selfType) {
     super(value, selfType);
   }
@@ -139,6 +138,6 @@ public final A isNoneOfElements(Collection<E> elements) {
   }
 
   private String description() {
-    return String.format("%s enum value <%s>", actual.getClass().getSimpleName(), actual);
+    return String.format("%s enum value <%s>", actual.getDeclaringClass().getSimpleName(), actual);
   }
 }