build: add ErrorProne + NullAway

fprochazka · fprochazka · commit 7f6a22922800 · 2024-11-22T15:10:08.000+01:00
diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -10,4 +10,6 @@ repositories {
 dependencies {
     implementation("com.adarshr:gradle-test-logger-plugin:4.0.0")
     implementation("io.github.joselion:strict-null-check:3.5.0")
+    implementation("net.ltgt.gradle:gradle-errorprone-plugin:4.1.0")
+    implementation("net.ltgt.gradle:gradle-nullaway-plugin:2.1.0")
 }
diff --git a/buildSrc/src/main/kotlin/framefork.java.gradle.kts b/buildSrc/src/main/kotlin/framefork.java.gradle.kts
@@ -1,9 +1,13 @@
+import net.ltgt.gradle.errorprone.errorprone
+import net.ltgt.gradle.nullaway.nullaway
 
 plugins {
     `java-library`
     id("idea")
     id("com.adarshr.test-logger")
     id("io.github.joselion.strict-null-check")
+    id("net.ltgt.errorprone")
+    id("net.ltgt.nullaway")
 }
 
 repositories {
@@ -23,6 +27,17 @@ java {
 dependencies {
     api("org.jspecify:jspecify:1.0.0")
 
+    compileOnly("org.checkerframework:checker-qual:3.48.2")
+
+    errorprone("com.google.errorprone:error_prone_core:2.36.0")
+    errorprone("com.uber.nullaway:nullaway:0.12.1")
+
+    constraints {
+        errorprone("org.checkerframework:checker-qual:3.48.2")
+        errorprone("org.checkerframework:dataflow-errorprone:3.48.2")
+        errorprone("org.checkerframework:dataflow-nullaway:3.48.2")
+        errorprone("com.google.guava:guava:33.3.1-jre")
+    }
 }
 
 strictNullCheck {
@@ -53,9 +68,89 @@ tasks.withType<Test> {
     }
 }
 
+nullaway {
+    annotatedPackages.add("org.framefork")
+}
+
 tasks.withType<JavaCompile> {
     options.encoding = "UTF-8"
-    options.compilerArgs.addAll(listOf("-parameters"))
+    options.compilerArgs.add("-Xlint:all,-fallthrough,-processing,-serial,-classfile,-path,-this-escape")
+    options.compilerArgs.add("-parameters")
+    options.compilerArgs.add("-Werror") // treat warnings as errors
+
+    // useful when debugging lint errors:
+    // options.isVerbose = true
+    // options.isDebug = true
+
+    options.errorprone {
+        disableWarningsInGeneratedCode.set(true)
+        allDisabledChecksAsWarnings.set(true)
+        allErrorsAsWarnings.set(true)
+        disable("AndroidJdkLibsChecker")
+        disable("AnnotationPosition")
+        disable("AvoidObjectArrays")
+        disable("BooleanParameter")
+        disable("CanIgnoreReturnValueSuggester")
+        disable("CatchingUnchecked")
+        disable("ConstantPatternCompile")
+        disable("DefaultLocale")
+        disable("DeduplicateConstants")
+        disable("DistinctVarargsChecker")
+        disable("FieldCanBeFinal")
+        disable("ImmutableMemberCollection")
+        disable("InconsistentOverloads")
+        disable("InlineMeSuggester")
+        disable("InterfaceWithOnlyStatics")
+        disable("Interruption")
+        disable("InvalidBlockTag")
+        disable("Java7ApiChecker")
+        disable("Java8ApiChecker")
+        disable("MemberName")
+        disable("MethodCanBeStatic")
+        disable("MissingSummary")
+        disable("MockitoDoSetup")
+        disable("OptionalOfRedundantMethod")
+        disable("PreferredInterfaceType")
+        disable("ReturnMissingNullable")
+        disable("SameNameButDifferent")
+        disable("StatementSwitchToExpressionSwitch")
+        disable("StaticOrDefaultInterfaceMethod")
+        disable("StaticQualifiedUsingExpression")
+        disable("StringSplitter")
+        disable("SuppressWarningsWithoutExplanation")
+        disable("TooManyParameters")
+        disable("TraditionalSwitchExpression")
+        disable("TryFailRefactoring")
+        disable("TypeParameterNaming")
+        disable("UnnecessaryFinal")
+        disable("UnnecessaryStringBuilder")
+        disable("Var")
+        disable("WildcardImport")
+        disable("YodaCondition")
+    }
+
+    options.errorprone.nullaway {
+        warn()
+        treatGeneratedAsUnannotated.set(true)
+        acknowledgeRestrictiveAnnotations.set(true)
+        handleTestAssertionLibraries.set(true)
+        checkContracts.set(true)
+        knownInitializers.addAll(setOf(
+            "org.springframework.beans.factory.InitializingBean.afterPropertiesSet",
+        ))
+        customInitializerAnnotations.addAll(setOf(
+            "org.junit.jupiter.api.BeforeAll",
+            "org.junit.jupiter.api.BeforeEach",
+        ))
+        excludedFieldAnnotations.addAll(setOf(
+            "jakarta.persistence.PersistenceContext",
+            "org.springframework.beans.factory.annotation.Autowired",
+            "org.springframework.boot.test.mock.mockito.MockBean",
+            "org.mockito.Captor",
+            "org.springframework.beans.factory.annotation.Value",
+            "com.github.rvesse.airline.annotations.Option"
+        ))
+    }
 }
 
 tasks.withType<Javadoc> {
diff --git a/modules/typed-ids-hibernate-62/src/main/java/org/framefork/typedIds/uuid/hibernate/ObjectUuidTypesContributor.java b/modules/typed-ids-hibernate-62/src/main/java/org/framefork/typedIds/uuid/hibernate/ObjectUuidTypesContributor.java
@@ -24,6 +24,7 @@
 import java.util.Comparator;
 import java.util.List;
 
+@SuppressWarnings("rawtypes")
 @AutoService(TypeContributor.class)
 public class ObjectUuidTypesContributor implements TypeContributor
 {
@@ -36,11 +37,12 @@ public class ObjectUuidTypesContributor implements TypeContributor
     private static final boolean CLASS_INDEX_PRESENT;
 
     static {
-        boolean found = false;
+        boolean found;
         try {
             Class.forName("org.atteo.classindex.ClassIndex");
             found = true;
         } catch (ClassNotFoundException ignored) {
+            found = false;
         }
 
         CLASS_INDEX_PRESENT = found;
diff --git a/modules/typed-ids-hibernate-62/src/test/java/org/framefork/typedIds/uuid/hibernate/ArticleDefaultExplicitMapping.java b/modules/typed-ids-hibernate-62/src/test/java/org/framefork/typedIds/uuid/hibernate/ArticleDefaultExplicitMapping.java
@@ -29,6 +29,7 @@ public ArticleDefaultExplicitMapping(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleDefaultExplicitMapping()
     {
     }
diff --git a/modules/typed-ids-hibernate-63/src/main/java/org/framefork/typedIds/uuid/hibernate/ObjectUuidTypesContributor.java b/modules/typed-ids-hibernate-63/src/main/java/org/framefork/typedIds/uuid/hibernate/ObjectUuidTypesContributor.java
@@ -24,6 +24,7 @@
 import java.util.Comparator;
 import java.util.List;
 
+@SuppressWarnings("rawtypes")
 @AutoService(TypeContributor.class)
 public class ObjectUuidTypesContributor implements TypeContributor
 {
@@ -36,11 +37,12 @@ public class ObjectUuidTypesContributor implements TypeContributor
     private static final boolean CLASS_INDEX_PRESENT;
 
     static {
-        boolean found = false;
+        boolean found;
         try {
             Class.forName("org.atteo.classindex.ClassIndex");
             found = true;
         } catch (ClassNotFoundException ignored) {
+            found = false;
         }
 
         CLASS_INDEX_PRESENT = found;
diff --git a/modules/typed-ids-hibernate-63/src/test/java/org/framefork/typedIds/uuid/hibernate/ArticleDefaultExplicitMapping.java b/modules/typed-ids-hibernate-63/src/test/java/org/framefork/typedIds/uuid/hibernate/ArticleDefaultExplicitMapping.java
@@ -29,6 +29,7 @@ public ArticleDefaultExplicitMapping(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleDefaultExplicitMapping()
     {
     }
diff --git a/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/AbstractContainerDataSourceProvider.java b/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/AbstractContainerDataSourceProvider.java
@@ -4,6 +4,7 @@
 import org.testcontainers.containers.JdbcDatabaseContainer;
 
 import javax.sql.DataSource;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicReference;
 
 public abstract class AbstractContainerDataSourceProvider implements DataSourceProvider
@@ -21,7 +22,7 @@ public JdbcDatabaseContainer<?> getContainer()
             }
         }
 
-        return container.get();
+        return Objects.requireNonNull(container.get(), "database container must not be null");
     }
 
     private JdbcDatabaseContainer<?> initContainer()
diff --git a/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/MySQLDataSourceProvider.java b/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/MySQLDataSourceProvider.java
@@ -33,6 +33,7 @@ public String hibernateDialect()
         return MySQLDialect.class.getName();
     }
 
+    @Override
     protected DataSource newDataSource()
     {
         var dataSource = new MysqlDataSource();
diff --git a/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/PostgreSQLDataSourceProvider.java b/modules/typed-ids-testing/src/main/java/org/framefork/typedIds/hibernate/tests/PostgreSQLDataSourceProvider.java
@@ -33,6 +33,7 @@ public String hibernateDialect()
         return PostgreSQLDialect.class.getName();
     }
 
+    @Override
     protected DataSource newDataSource()
     {
         var dataSource = new PGSimpleDataSource();
diff --git a/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/ObjectUuid.java b/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/ObjectUuid.java
@@ -179,7 +179,7 @@ public String toString()
     @Override
     public boolean equals(@Nullable final Object o)
     {
-        if (!(o instanceof ObjectUuid)) {
+        if (!(o instanceof ObjectUuid<?>)) {
             return false;
         }
         if (!this.getClass().isInstance(o)) {
@@ -233,7 +233,7 @@ static UuidGenerator getGenerator(final Function<?, ?> constructor)
         {
             return GENERATORS.computeIfAbsent(
                 constructor,
-                c -> FACTORY.get().getGenerator(c)
+                c -> Objects.requireNonNull(FACTORY.get(), "generator factory must not be null").getGenerator(c)
             );
         }
 
diff --git a/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/json/jackson/ObjectUuidJacksonModule.java b/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/json/jackson/ObjectUuidJacksonModule.java
@@ -5,7 +5,7 @@
 import com.fasterxml.jackson.databind.module.SimpleDeserializers;
 import com.fasterxml.jackson.databind.module.SimpleSerializers;
 import com.google.auto.service.AutoService;
-import org.framefork.typedIds.uuid.ObjectUuid;
+import org.framefork.typedIds.uuid.ObjectUuidTypeUtils;
 
 @AutoService(Module.class)
 public class ObjectUuidJacksonModule extends Module
@@ -34,7 +34,7 @@ private static SimpleSerializers getSerializers()
     {
         var serializers = new SimpleSerializers();
 
-        serializers.addSerializer(ObjectUuid.class, new ObjectUuidSerializer());
+        serializers.addSerializer(ObjectUuidTypeUtils.getObjectUuidRawClass(), new ObjectUuidSerializer());
 
         return serializers;
     }
diff --git a/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/json/jackson/ObjectUuidSerializer.java b/modules/typed-ids/src/main/java/org/framefork/typedIds/uuid/json/jackson/ObjectUuidSerializer.java
@@ -7,13 +7,12 @@
 
 import java.io.IOException;
 
-@SuppressWarnings("rawtypes")
-public class ObjectUuidSerializer extends JsonSerializer<ObjectUuid>
+public class ObjectUuidSerializer extends JsonSerializer<ObjectUuid<?>>
 {
 
     @Override
     public void serialize(
-        final ObjectUuid uuid,
+        final ObjectUuid<?> uuid,
         final JsonGenerator jsonGenerator,
         final SerializerProvider serializerProvider
     ) throws
diff --git a/testing/testing-typed-ids-hibernate-62-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v63/ArticleTestingEntity.java b/testing/testing-typed-ids-hibernate-62-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v63/ArticleTestingEntity.java
@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleTestingEntity()
     {
     }
diff --git a/testing/testing-typed-ids-hibernate-63-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v63/ArticleTestingEntity.java b/testing/testing-typed-ids-hibernate-63-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v63/ArticleTestingEntity.java
@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleTestingEntity()
     {
     }
diff --git a/testing/testing-typed-ids-hibernate-64-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v64/ArticleTestingEntity.java b/testing/testing-typed-ids-hibernate-64-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v64/ArticleTestingEntity.java
@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleTestingEntity()
     {
     }
diff --git a/testing/testing-typed-ids-hibernate-65-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v65/ArticleTestingEntity.java b/testing/testing-typed-ids-hibernate-65-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v65/ArticleTestingEntity.java
@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleTestingEntity()
     {
     }
diff --git a/testing/testing-typed-ids-hibernate-66-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v66/ArticleTestingEntity.java b/testing/testing-typed-ids-hibernate-66-indexed/src/main/java/org/framefork/typedIds/uuid/hibernate/v66/ArticleTestingEntity.java
@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)
         this.title = title;
     }
 
+    @SuppressWarnings("NullAway")
     protected ArticleTestingEntity()
     {
     }

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,6 @@ repositories {`
`10`	`10`	`dependencies {`
`11`	`11`	`implementation("com.adarshr:gradle-test-logger-plugin:4.0.0")`
`12`	`12`	`implementation("io.github.joselion:strict-null-check:3.5.0")`
	`13`	`+ implementation("net.ltgt.gradle:gradle-errorprone-plugin:4.1.0")`
	`14`	`+ implementation("net.ltgt.gradle:gradle-nullaway-plugin:2.1.0")`
`13`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ public ArticleDefaultExplicitMapping(final String title)`
`29`	`29`	`this.title = title;`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ @SuppressWarnings("NullAway")`
`32`	`33`	`protected ArticleDefaultExplicitMapping()`
`33`	`34`	`{`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`import org.testcontainers.containers.JdbcDatabaseContainer;`
`5`	`5`
`6`	`6`	`import javax.sql.DataSource;`
	`7`	`+import java.util.Objects;`
`7`	`8`	`import java.util.concurrent.atomic.AtomicReference;`
`8`	`9`
`9`	`10`	`public abstract class AbstractContainerDataSourceProvider implements DataSourceProvider`
`@@ -21,7 +22,7 @@ public JdbcDatabaseContainer<?> getContainer()`
`21`	`22`	`}`
`22`	`23`	`}`
`23`	`24`
`24`		`- return container.get();`
	`25`	`+ return Objects.requireNonNull(container.get(), "database container must not be null");`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`private JdbcDatabaseContainer<?> initContainer()`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ public String hibernateDialect()`
`33`	`33`	`return MySQLDialect.class.getName();`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ @Override`
`36`	`37`	`protected DataSource newDataSource()`
`37`	`38`	`{`
`38`	`39`	`var dataSource = new MysqlDataSource();`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public String toString()`
`179`	`179`	`@Override`
`180`	`180`	`public boolean equals(@Nullable final Object o)`
`181`	`181`	`{`
`182`		`- if (!(o instanceof ObjectUuid)) {`
	`182`	`+ if (!(o instanceof ObjectUuid<?>)) {`
`183`	`183`	`return false;`
`184`	`184`	`}`
`185`	`185`	`if (!this.getClass().isInstance(o)) {`
`@@ -233,7 +233,7 @@ static UuidGenerator getGenerator(final Function<?, ?> constructor)`
`233`	`233`	`{`
`234`	`234`	`return GENERATORS.computeIfAbsent(`
`235`	`235`	`constructor,`
`236`		`- c -> FACTORY.get().getGenerator(c)`
	`236`	`+ c -> Objects.requireNonNull(FACTORY.get(), "generator factory must not be null").getGenerator(c)`
`237`	`237`	`);`
`238`	`238`	`}`
`239`	`239`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`import com.fasterxml.jackson.databind.module.SimpleDeserializers;`
`6`	`6`	`import com.fasterxml.jackson.databind.module.SimpleSerializers;`
`7`	`7`	`import com.google.auto.service.AutoService;`
`8`		`-import org.framefork.typedIds.uuid.ObjectUuid;`
	`8`	`+import org.framefork.typedIds.uuid.ObjectUuidTypeUtils;`
`9`	`9`
`10`	`10`	`@AutoService(Module.class)`
`11`	`11`	`public class ObjectUuidJacksonModule extends Module`
`@@ -34,7 +34,7 @@ private static SimpleSerializers getSerializers()`
`34`	`34`	`{`
`35`	`35`	`var serializers = new SimpleSerializers();`
`36`	`36`
`37`		`- serializers.addSerializer(ObjectUuid.class, new ObjectUuidSerializer());`
	`37`	`+ serializers.addSerializer(ObjectUuidTypeUtils.getObjectUuidRawClass(), new ObjectUuidSerializer());`
`38`	`38`
`39`	`39`	`return serializers;`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ public ArticleTestingEntity(final String title)`
`27`	`27`	`this.title = title;`
`28`	`28`	`}`
`29`	`29`
	`30`	`+ @SuppressWarnings("NullAway")`
`30`	`31`	`protected ArticleTestingEntity()`
`31`	`32`	`{`
`32`	`33`	`}`