Enable NullAway in junit-jupiter-migrationsupport

Author: marcphilipp

junit-jupiter-migrationsupport/junit-jupiter-migrationsupport.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
 	id("junitbuild.java-library-conventions")
+	id("junitbuild.java-nullability-conventions")
 	id("junitbuild.junit4-compatibility")
 }
 
@@ -11,6 +12,7 @@ dependencies {
 	api(projects.junitJupiterApi)
 
 	compileOnlyApi(libs.apiguardian)
+	compileOnly(libs.jspecify)
 
 	osgiVerification(projects.junitJupiterEngine)
 	osgiVerification(projects.junitPlatformLauncher)
@@ -23,10 +25,12 @@ tasks {
 	jar {
 		bundle {
 			val importAPIGuardian: String by extra
+			val importJSpecify: String by extra
 			bnd("""
 				# Import JUnit4 packages with a version
 				Import-Package: \
 					$importAPIGuardian,\
+					$importJSpecify,\
 					org.junit;version="[${libs.versions.junit4Min.get()},5)",\
 					org.junit.platform.commons.logging;status=INTERNAL,\
 					org.junit.rules;version="[${libs.versions.junit4Min.get()},5)",\

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/conditions/IgnoreCondition.java

@@ -16,6 +16,7 @@
 import java.lang.reflect.AnnotatedElement;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.Ignore;
 import org.junit.jupiter.api.extension.ConditionEvaluationResult;
 import org.junit.jupiter.api.extension.ExecutionCondition;
@@ -53,7 +54,7 @@ public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext con
 				.orElse(ENABLED);
 	}
 
-	private ConditionEvaluationResult toResult(AnnotatedElement element, Ignore annotation) {
+	private ConditionEvaluationResult toResult(@Nullable AnnotatedElement element, Ignore annotation) {
 		String value = annotation.value();
 		String reason = StringUtils.isNotBlank(value) ? value : element + " is disabled via @org.junit.Ignore";
 		return ConditionEvaluationResult.disabled(reason);

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/conditions/package-info.java

@@ -4,4 +4,7 @@
  * Jupiter.
  */
 
+@NullMarked
 package org.junit.jupiter.migrationsupport.conditions;
+
+import org.jspecify.annotations.NullMarked;

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/package-info.java

@@ -2,4 +2,7 @@
  * Support for migrating from JUnit 4 to JUnit Jupiter.
  */
 
+@NullMarked
 package org.junit.jupiter.migrationsupport;
+
+import org.jspecify.annotations.NullMarked;

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/ExpectedExceptionSupport.java

@@ -57,8 +57,8 @@ public void handleTestExecutionException(ExtensionContext context, Throwable thr
 
 	@Override
 	public void afterEach(ExtensionContext context) throws Exception {
-		boolean handled = getStore(context).getOrComputeIfAbsent(EXCEPTION_WAS_HANDLED, key -> FALSE, Boolean.class);
-		if (!handled) {
+		Boolean handled = getStore(context).getOrComputeIfAbsent(EXCEPTION_WAS_HANDLED, key -> FALSE, Boolean.class);
+		if (handled != null && !handled) {
 			this.support.afterEach(context);
 		}
 	}

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/TestRuleSupport.java

@@ -11,6 +11,7 @@
 package org.junit.jupiter.migrationsupport.rules;
 
 import static java.util.Collections.unmodifiableList;
+import static java.util.Objects.requireNonNull;
 import static org.junit.platform.commons.support.AnnotationSupport.findPublicAnnotatedFields;
 import static org.junit.platform.commons.support.AnnotationSupport.isAnnotated;
 import static org.junit.platform.commons.support.HierarchyTraversalMode.TOP_DOWN;
@@ -146,8 +147,8 @@ private List<TestRuleAnnotatedMember> getRuleAnnotatedMembers(ExtensionContext c
 		Object testInstance = context.getRequiredTestInstance();
 		Namespace namespace = Namespace.create(TestRuleSupport.class, context.getRequiredTestClass());
 		// @formatter:off
-		return new ArrayList<>(context.getStore(namespace)
-				.getOrComputeIfAbsent("rule-annotated-members", key -> findRuleAnnotatedMembers(testInstance), List.class));
+		return new ArrayList<TestRuleAnnotatedMember>(requireNonNull(context.getStore(namespace)
+				.getOrComputeIfAbsent("rule-annotated-members", key -> findRuleAnnotatedMembers(testInstance), List.class)));
 		// @formatter:on
 	}
 

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/adapter/AbstractTestRuleAdapter.java

@@ -17,6 +17,7 @@
 import java.lang.reflect.Method;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.migrationsupport.rules.member.TestRuleAnnotatedMember;
 import org.junit.platform.commons.JUnitException;
 import org.junit.platform.commons.util.ClassUtils;
@@ -37,10 +38,12 @@ public AbstractTestRuleAdapter(TestRuleAnnotatedMember annotatedMember, Class<?
 			() -> adapteeClass + " is not assignable from " + this.target.getClass());
 	}
 
+	@Nullable
 	protected Object executeMethod(String name) {
 		return executeMethod(name, new Class<?>[0]);
 	}
 
+	@Nullable
 	protected Object executeMethod(String methodName, Class<?>[] parameterTypes, Object... arguments) {
 		Method method = findMethod(this.target.getClass(), methodName, parameterTypes).orElseThrow(
 			() -> new JUnitException("Failed to find method %s(%s) in class %s".formatted(methodName,

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/adapter/package-info.java

@@ -2,4 +2,7 @@
  * Simple wrappers for JUnit 4 rules to overcome visibility limitations of the JUnit 4 implementations.
  */
 
+@NullMarked
 package org.junit.jupiter.migrationsupport.rules.adapter;
+
+import org.jspecify.annotations.NullMarked;

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/member/AbstractTestRuleAnnotatedMember.java

@@ -10,6 +10,8 @@
 
 package org.junit.jupiter.migrationsupport.rules.member;
 
+import org.jspecify.annotations.Nullable;
+import org.junit.platform.commons.util.Preconditions;
 import org.junit.rules.TestRule;
 
 /**
@@ -19,8 +21,8 @@ abstract class AbstractTestRuleAnnotatedMember implements TestRuleAnnotatedMembe
 
 	private final TestRule testRule;
 
-	AbstractTestRuleAnnotatedMember(TestRule testRule) {
-		this.testRule = testRule;
+	AbstractTestRuleAnnotatedMember(@Nullable TestRule testRule) {
+		this.testRule = Preconditions.notNull(testRule, "TestRule must not be null");
 	}
 
 	@Override

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/member/package-info.java

@@ -2,4 +2,7 @@
  * Abstractions for members which can be targets of JUnit 4 rule annotations.
  */
 
+@NullMarked
 package org.junit.jupiter.migrationsupport.rules.member;
+
+import org.jspecify.annotations.NullMarked;