Add error-prone.picnic.tech featuring StaticImport

Author: Vincent Potucek

gradle/libs.versions.toml

@@ -32,7 +32,9 @@ bndlib = { module = "biz.aQute.bnd:biz.aQute.bndlib", version.ref = "bnd" }
 checkstyle = { module = "com.puppycrawl.tools:checkstyle", version.ref = "checkstyle" }
 classgraph = { module = "io.github.classgraph:classgraph", version = "4.8.181" }
 commons-io = { module = "commons-io:commons-io", version = "2.20.0" }
-errorProne-core = { module = "com.google.errorprone:error_prone_core", version = "2.42.0" }
+error-prone-core = { module = "com.google.errorprone:error_prone_core", version = "2.42.0" }
+error-prone-contrib = { module = "tech.picnic.error-prone-support:error-prone-contrib", version = "0.25.0" }
+refaster-runner = { module = "tech.picnic.error-prone-support:refaster-runner", version = "0.25.0" }
 fastcsv = { module = "de.siegmar:fastcsv", version = "4.0.0" }
 groovy = { module = "org.apache.groovy:groovy", version = "5.0.1" }
 groovy2-bom = { module = "org.codehaus.groovy:groovy-bom", version = "2.5.23" }

gradle/plugins/common/src/main/kotlin/junitbuild.java-nullability-conventions.gradle.kts

@@ -1,6 +1,7 @@
 import junitbuild.extensions.dependencyFromLibs
 import net.ltgt.gradle.errorprone.errorprone
 import net.ltgt.gradle.nullaway.nullaway
+import java.lang.System.getenv
 
 plugins {
 	`java-library`
@@ -9,16 +10,10 @@ plugins {
 }
 
 dependencies {
-	errorprone(dependencyFromLibs("errorProne-core"))
+	errorprone(dependencyFromLibs("error-prone-contrib"))
+	errorprone(dependencyFromLibs("error-prone-core"))
 	errorprone(dependencyFromLibs("nullaway"))
-	constraints {
-		errorprone("com.google.guava:guava") {
-			version {
-				require("33.4.8-jre")
-			}
-			because("Older versions use deprecated methods in sun.misc.Unsafe")
-		}
-	}
+	errorprone(dependencyFromLibs("refaster-runner"))
 }
 
 nullaway {
@@ -27,43 +22,49 @@ nullaway {
 
 tasks.withType<JavaCompile>().configureEach {
 	options.errorprone {
-		val shouldDisableErrorProne = java.toolchain.implementation.orNull == JvmImplementation.J9
-		if (name == "compileJava" && !shouldDisableErrorProne) {
+		disableWarningsInGeneratedCode = true
+		disableAllChecks = !(name == "compileJava" && java.toolchain.implementation.orNull != JvmImplementation.J9)
+		if (!disableAllChecks.get()) {
+			errorproneArgs.add("-XepOpt:Refaster:NamePattern=^(?!.*Rules\\$).*") // currently failing Refaster; might consider whitelist.
 			disable(
-
-				// This check is opinionated wrt. which method names it considers unsuitable for import which includes
-				// a few of our own methods in `ReflectionUtils` etc.
-				"BadImport",
-
-				// The findings of this check are subjective because a named constant can be more readable in many cases
-				"UnnecessaryLambda",
-
-				// Resolving findings for these checks requires ErrorProne's annotations which we don't want to use
-				"AnnotateFormatMethod",
+				"AnnotateFormatMethod", // We don`t want to use ErrorProne`s annotations.
+				"BadImport", // This check is opinionated wrt. which method names it considers unsuitable for import which includes a few of our own methods in `ReflectionUtils` etc.
+				"DirectReturn", // https://github.com/junit-team/junit-framework/pull/5006#discussion_r2403984446
 				"DoNotCallSuggester",
-				"InlineMeSuggester",
 				"ImmutableEnumChecker",
-
-				// Resolving findings for this check requires using Guava which we don't want to use
-				"StringSplitter",
-
-				// Produces a lot of findings that we consider to be false positives, for example for package-private
-				// classes and methods
-				"MissingSummary",
+				"InlineMeSuggester",
+				"MissingSummary", // Produces a lot of findings that we consider to be false positives, for example for package-private classes and methods.
+				"StringSplitter", // We don`t want to use Guava.
+				"UnnecessaryLambda", // The findings of this check are subjective because a named constant can be more readable in many cases.
+				// picnic
+				"ConstantNaming",
+				"FormatStringConcatenation",
+				"IdentityConversion",
+				"LexicographicalAnnotationAttributeListing",
+				"LexicographicalAnnotationListing",
+				"MissingTestCall",
+				"NestedOptionals",
+				"NonStaticImport",
+				"OptionalOrElseGet",
+				"PrimitiveComparison",
+				"TimeZoneUsage",
 			)
-			error("PackageLocation")
-		} else {
-			disableAllChecks = true
+			error(
+				"PackageLocation",
+				"StaticImport"
+			)
+			// fix & introduce new checks with:
+			// errorproneArgs.addAll("-XepPatchLocation:IN_PLACE","-XepPatchChecks:StaticImport")
 		}
 		nullaway {
-			if (shouldDisableErrorProne) {
+			if (disableAllChecks.get()) {
 				disable()
 			} else {
 				enable()
 			}
-			isJSpecifyMode = true
-			customContractAnnotations.add("org.junit.platform.commons.annotation.Contract")
 			checkContracts = true
+			customContractAnnotations.add("org.junit.platform.commons.annotation.Contract")
+			isJSpecifyMode = true
 			suppressionNameAliases.add("DataFlowIssue")
 		}
 	}

junit-jupiter-api/src/main/java/org/junit/jupiter/api/ClassOrderer.java

@@ -10,11 +10,12 @@
 
 package org.junit.jupiter.api;
 
+import static java.util.Collections.shuffle;
+import static java.util.Comparator.comparing;
 import static java.util.Comparator.comparingInt;
 import static org.apiguardian.api.API.Status.EXPERIMENTAL;
 import static org.apiguardian.api.API.Status.STABLE;
 
-import java.util.Collections;
 import java.util.Comparator;
 
 import org.apiguardian.api.API;
@@ -148,7 +149,7 @@ public void orderClasses(ClassOrdererContext context) {
 			context.getClassDescriptors().sort(comparator);
 		}
 
-		private static final Comparator<ClassDescriptor> comparator = Comparator.comparing(
+		private static final Comparator<ClassDescriptor> comparator = comparing(
 			descriptor -> descriptor.getTestClass().getName());
 	}
 
@@ -171,8 +172,7 @@ public void orderClasses(ClassOrdererContext context) {
 			context.getClassDescriptors().sort(comparator);
 		}
 
-		private static final Comparator<ClassDescriptor> comparator = Comparator.comparing(
-			ClassDescriptor::getDisplayName);
+		private static final Comparator<ClassDescriptor> comparator = comparing(ClassDescriptor::getDisplayName);
 	}
 
 	/**
@@ -265,7 +265,7 @@ public Random() {
 		 */
 		@Override
 		public void orderClasses(ClassOrdererContext context) {
-			Collections.shuffle(context.getClassDescriptors(),
+			shuffle(context.getClassDescriptors(),
 				new java.util.Random(RandomOrdererUtils.getSeed(context::getConfigurationParameter, logger)));
 		}
 	}

junit-jupiter-api/src/main/java/org/junit/jupiter/api/MethodOrderer.java

@@ -10,12 +10,13 @@
 
 package org.junit.jupiter.api;
 
+import static java.util.Collections.shuffle;
+import static java.util.Comparator.comparing;
 import static java.util.Comparator.comparingInt;
 import static org.apiguardian.api.API.Status.EXPERIMENTAL;
 import static org.apiguardian.api.API.Status.STABLE;
 
 import java.lang.reflect.Method;
-import java.util.Collections;
 import java.util.Comparator;
 import java.util.Optional;
 
@@ -214,8 +215,7 @@ public void orderMethods(MethodOrdererContext context) {
 			context.getMethodDescriptors().sort(comparator);
 		}
 
-		private static final Comparator<MethodDescriptor> comparator = Comparator.comparing(
-			MethodDescriptor::getDisplayName);
+		private static final Comparator<MethodDescriptor> comparator = comparing(MethodDescriptor::getDisplayName);
 	}
 
 	/**
@@ -308,7 +308,7 @@ public Random() {
 		 */
 		@Override
 		public void orderMethods(MethodOrdererContext context) {
-			Collections.shuffle(context.getMethodDescriptors(),
+			shuffle(context.getMethodDescriptors(),
 				new java.util.Random(RandomOrdererUtils.getSeed(context::getConfigurationParameter, logger)));
 		}
 

junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestInstancePreDestroyCallback.java

@@ -10,10 +10,10 @@
 
 package org.junit.jupiter.api.extension;
 
+import static java.util.Collections.reverse;
 import static org.apiguardian.api.API.Status.STABLE;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Consumer;
@@ -114,7 +114,7 @@ static void preDestroyTestInstances(ExtensionContext context, Consumer<Object> c
 			current.get().getTestInstances().map(TestInstances::getAllInstances).ifPresent(
 				destroyedInstances::removeAll);
 		}
-		Collections.reverse(destroyedInstances);
+		reverse(destroyedInstances);
 		destroyedInstances.forEach(callback);
 	}
 

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassBasedTestDescriptor.java

@@ -10,6 +10,7 @@
 
 package org.junit.jupiter.engine.descriptor;
 
+import static java.util.Collections.reverse;
 import static java.util.Objects.requireNonNull;
 import static java.util.stream.Collectors.joining;
 import static org.apiguardian.api.API.Status.INTERNAL;
@@ -30,7 +31,6 @@
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
@@ -516,7 +516,7 @@ private void registerAfterEachMethodAdapters(ExtensionRegistrar registrar) {
 		// synthesized AfterEachMethodAdapters are executed within TestMethodTestDescriptor,
 		// we have to reverse the afterEachMethods list to put them in top-down order before
 		// we register them as synthesized extensions.
-		Collections.reverse(afterEachMethods);
+		reverse(afterEachMethods);
 
 		registerMethodsAsExtensions(afterEachMethods, registrar, this::synthesizeAfterEachMethodAdapter);
 	}

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ExtensionUtils.java

@@ -10,6 +10,7 @@
 
 package org.junit.jupiter.engine.descriptor;
 
+import static java.util.Comparator.comparingInt;
 import static java.util.stream.Collectors.toList;
 import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;
 import static org.junit.platform.commons.support.AnnotationSupport.isAnnotated;
@@ -226,7 +227,7 @@ private static Stream<Class<? extends Extension>> streamDeclarativeExtensionType
 	 * @since 5.4
 	 */
 	private static final Comparator<Field> orderComparator = //
-		Comparator.comparingInt(ExtensionUtils::getOrder);
+		comparingInt(ExtensionUtils::getOrder);
 
 	/**
 	 * @since 5.4

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/JupiterTestDescriptor.java

@@ -11,6 +11,7 @@
 package org.junit.jupiter.engine.descriptor;
 
 import static java.util.Collections.emptySet;
+import static java.util.Collections.reverse;
 import static java.util.stream.Collectors.collectingAndThen;
 import static java.util.stream.Collectors.toCollection;
 import static java.util.stream.Collectors.toSet;
@@ -108,7 +109,7 @@ <E extends Extension> void invokeExecutionExceptionHandlers(Class<E> handlerType
 			Throwable throwable, ExceptionHandlerInvoker<E> handlerInvoker) {
 
 		List<E> extensions = registry.getExtensions(handlerType);
-		Collections.reverse(extensions);
+		reverse(extensions);
 		invokeExecutionExceptionHandlers(extensions, throwable, handlerInvoker);
 	}
 

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/DefaultTestInstances.java

@@ -10,10 +10,10 @@
 
 package org.junit.jupiter.engine.execution;
 
+import static java.util.Collections.unmodifiableList;
 import static org.apiguardian.api.API.Status.INTERNAL;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.ListIterator;
 import java.util.Optional;
@@ -32,7 +32,7 @@ public static DefaultTestInstances of(Object instance) {
 	public static DefaultTestInstances of(TestInstances testInstances, Object instance) {
 		List<Object> allInstances = new ArrayList<>(testInstances.getAllInstances());
 		allInstances.add(instance);
-		return new DefaultTestInstances(Collections.unmodifiableList(allInstances));
+		return new DefaultTestInstances(unmodifiableList(allInstances));
 	}
 
 	private final List<Object> instances;

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/PreInterruptThreadDumpPrinter.java

@@ -49,7 +49,7 @@ public void beforeThreadInterrupt(PreInterruptContext preInterruptContext, Exten
 					sb.append(NL);
 					// Use the same prefix as java.lang.Throwable.printStackTrace(PrintStreamOrWriter)
 					sb.append("\tat ");
-					sb.append(stackTraceElement.toString());
+					sb.append(stackTraceElement);
 				}
 				sb.append(NL);
 			}