Add LexicographicalAnnotationAttributeListing

Author: Vincent Potucek

gradle/libs.versions.toml

@@ -32,7 +32,8 @@ 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.184" }
 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-contrib = { module = "tech.picnic.error-prone-support:error-prone-contrib", version = "0.25.0" }
+error-prone-core = { module = "com.google.errorprone:error_prone_core", version = "2.42.0" }
 fastcsv = { module = "de.siegmar:fastcsv", version = "4.1.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

@@ -9,49 +9,53 @@ 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")
+			// https://github.com/junit-team/junit-framework/pull/5039#discussion_r2414490581
 		}
 	}
 }
 
-nullaway {
-	onlyNullMarked = true
-}
-
 tasks.withType<JavaCompile>().configureEach {
 	options.errorprone {
 		val shouldDisableErrorProne = java.toolchain.implementation.orNull == JvmImplementation.J9
 		if (name == "compileJava" && !shouldDisableErrorProne) {
 			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",
-				"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",
+				"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.
+				"DoNotCallSuggester", // We don`t want to use ErrorProne's annotations.
+				"ImmutableEnumChecker", // We don`t want to use ErrorProne's annotations.
+				"InlineMeSuggester", // We don`t want to use ErrorProne's annotations.
+				"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 (https://error-prone.picnic.tech)
+				"ConstantNaming",
+				"DirectReturn", // https://github.com/junit-team/junit-framework/pull/5006#discussion_r2403984446
+				"FormatStringConcatenation",
+				"IdentityConversion",
+				"LexicographicalAnnotationListing",
+				"MissingTestCall",
+				"NestedOptionals",
+				"NonStaticImport",
+				"OptionalOrElseGet",
+				"PrimitiveComparison",
+				"StaticImport",
+				"TimeZoneUsage",
+			)
+			error(
+				"LexicographicalAnnotationAttributeListing",
+				"PackageLocation",
+				"RedundantStringConversion",
+				"RedundantStringEscape",
 			)
-			error("PackageLocation")
 		} else {
 			disableAllChecks = true
 		}
@@ -61,6 +65,7 @@ tasks.withType<JavaCompile>().configureEach {
 			} else {
 				enable()
 			}
+			onlyNullMarked = true
 			isJSpecifyMode = true
 			customContractAnnotations.add("org.junit.platform.commons.annotation.Contract")
 			checkContracts = true

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

@@ -89,7 +89,7 @@ public void invokeVoid(Method method, @Nullable Object target, ExtensionContext
 			ExtensionContext extensionContext, ExtensionRegistry extensionRegistry,
 			ReflectiveInterceptorCall<Method, T> interceptorCall) {
 
-		@SuppressWarnings({ "unchecked", "rawtypes" })
+		@SuppressWarnings({ "rawtypes", "unchecked" })
 		Optional<Object> optionalTarget = (target instanceof Optional optional ? optional
 				: Optional.ofNullable(target));
 		@Nullable

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

@@ -55,7 +55,7 @@ public List<Object> getArguments() {
 	}
 
 	@Override
-	@SuppressWarnings({ "unchecked", "NullAway" })
+	@SuppressWarnings({ "NullAway", "unchecked" })
 	public T proceed() {
 		var actualTarget = this.target.orElse(null);
 		return (T) MethodReflectionUtils.invoke(this.method, actualTarget, this.arguments);

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);
 			}

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

@@ -90,7 +90,7 @@ public String toString() {
 			// @formatter:on
 		}
 
-		@SuppressWarnings({ "OptionalAssignedToNull", "NullableOptional" })
+		@SuppressWarnings({ "NullableOptional", "OptionalAssignedToNull" })
 		private static @Nullable Object nullSafeGet(@Nullable Optional<?> optional) {
 			return optional != null ? optional.orElse(null) : null;
 		}

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

@@ -78,7 +78,7 @@ public void close() throws Exception {
 	@SuppressWarnings("try")
 	static class SingleThreadExecutorResource extends ExecutorResource {
 
-		@SuppressWarnings({ "unused", "ThreadPriorityCheck" })
+		@SuppressWarnings({ "ThreadPriorityCheck", "unused" })
 		SingleThreadExecutorResource() {
 			super(Executors.newSingleThreadScheduledExecutor(runnable -> {
 				Thread thread = new Thread(runnable, "junit-jupiter-timeout-watcher");

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/EnumArgumentsProvider.java

@@ -61,7 +61,7 @@ private <E extends Enum<E>> Set<? extends E> getEnumConstants(ParameterDeclarati
 		return EnumSet.range(from, to);
 	}
 
-	@SuppressWarnings({ "unchecked", "rawtypes" })
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	private <E extends Enum<E>> Class<E> determineEnumClass(ParameterDeclarations parameters, EnumSource enumSource) {
 		Class enumClass = enumSource.value();
 		if (enumClass.equals(NullEnum.class)) {

junit-jupiter-params/src/main/java/org/junit/jupiter/params/support/AnnotationConsumerInitializer.java

@@ -48,7 +48,7 @@ private AnnotationConsumerInitializer() {
 		/* no-op */
 	}
 
-	@SuppressWarnings({ "unchecked", "rawtypes" })
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	public static <T> T initialize(AnnotatedElement annotatedElement, T annotationConsumerInstance) {
 		if (annotationConsumerInstance instanceof AnnotationConsumer consumer) {
 			Class<? extends Annotation> annotationType = findConsumedAnnotationType(annotationConsumerInstance);

junit-platform-commons/src/main/java/org/junit/platform/commons/support/conversion/StringToEnumConverter.java

@@ -18,7 +18,7 @@ public boolean canConvertTo(Class<?> targetType) {
 	}
 
 	@Override
-	@SuppressWarnings({ "unchecked", "rawtypes" })
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	public Object convert(String source, Class targetType) throws Exception {
 		return Enum.valueOf(targetType, source);
 	}