Resolve nullability issues surfaced by NullAway's JSpecify mode

Author: marcphilipp

documentation/src/test/java/example/FirstCustomEngine.java

@@ -48,6 +48,9 @@ public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId
 		return new EngineDescriptor(uniqueId, "First Custom Test Engine");
 	}
 
+	//end::user_guide[]
+	@SuppressWarnings("NullAway")
+	//tag::user_guide[]
 	@Override
 	public void execute(ExecutionRequest request) {
 		request.getEngineExecutionListener()

documentation/src/test/java/example/ParameterizedLifecycleDemo.java

@@ -55,7 +55,7 @@ static void beforeInvocation(TextFile textFile, @TempDir Path tempDir) throws Ex
 		}
 
 		//end::user_guide[]
-		@SuppressWarnings({ "DataFlowIssue", "NullAway" })
+		@SuppressWarnings("DataFlowIssue")
 		//tag::user_guide[]
 		@AfterParameterizedClassInvocation
 		static void afterInvocation(TextFile textFile) throws Exception {
@@ -66,7 +66,7 @@ static void afterInvocation(TextFile textFile) throws Exception {
 		}
 
 		//end::user_guide[]
-		@SuppressWarnings({ "DataFlowIssue", "NullAway" })
+		@SuppressWarnings("DataFlowIssue")
 		//tag::user_guide[]
 		@Test
 		void test() {

documentation/src/test/java/example/SecondCustomEngine.java

@@ -48,6 +48,9 @@ public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId
 		return new EngineDescriptor(uniqueId, "Second Custom Test Engine");
 	}
 
+	//end::user_guide[]
+	@SuppressWarnings("NullAway")
+	//tag::user_guide[]
 	@Override
 	public void execute(ExecutionRequest request) {
 		request.getEngineExecutionListener()

documentation/src/test/java/example/interceptor/SwingEdtInterceptor.java

@@ -23,6 +23,9 @@
 // tag::user_guide[]
 public class SwingEdtInterceptor implements InvocationInterceptor {
 
+	//end::user_guide[]
+	@SuppressWarnings("NullAway")
+	//tag::user_guide[]
 	@Override
 	public void interceptTestMethod(Invocation<Void> invocation,
 			ReflectiveInvocationContext<Method> invocationContext,

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

@@ -36,17 +36,15 @@ static void assertTimeout(Duration timeout, Executable executable) {
 		assertTimeout(timeout, executable, (String) null);
 	}
 
-	@SuppressWarnings("NullAway")
 	static void assertTimeout(Duration timeout, Executable executable, @Nullable String message) {
-		assertTimeout(timeout, () -> {
+		AssertTimeout.<@Nullable Object> assertTimeout(timeout, () -> {
 			executable.execute();
 			return null;
 		}, message);
 	}
 
-	@SuppressWarnings("NullAway")
 	static void assertTimeout(Duration timeout, Executable executable, Supplier<@Nullable String> messageSupplier) {
-		assertTimeout(timeout, () -> {
+		AssertTimeout.<@Nullable Object> assertTimeout(timeout, () -> {
 			executable.execute();
 			return null;
 		}, messageSupplier);

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

@@ -614,9 +614,9 @@ default <V> V getOrDefault(Object key, Class<V> requiredType, V defaultValue) {
 		 * @see CloseableResource
 		 * @see AutoCloseable
 		 */
-		@SuppressWarnings({ "DataFlowIssue", "NullAway" })
 		@API(status = STABLE, since = "5.1")
-		default <V> V getOrComputeIfAbsent(Class<V> type) {
+		@SuppressWarnings("NullAway")
+		default <V> @Nullable V getOrComputeIfAbsent(Class<V> type) {
 			return getOrComputeIfAbsent(type, ReflectionSupport::newInstance, type);
 		}
 
@@ -650,7 +650,7 @@ default <V> V getOrComputeIfAbsent(Class<V> type) {
 		 * @see CloseableResource
 		 * @see AutoCloseable
 		 */
-		<K, V> @Nullable Object getOrComputeIfAbsent(K key, Function<K, @Nullable V> defaultCreator);
+		<K, V extends @Nullable Object> @Nullable Object getOrComputeIfAbsent(K key, Function<K, V> defaultCreator);
 
 		/**
 		 * Get the value of the specified required type that is stored under the
@@ -681,7 +681,8 @@ default <V> V getOrComputeIfAbsent(Class<V> type) {
 		 * @see CloseableResource
 		 * @see AutoCloseable
 		 */
-		<K, V> @Nullable V getOrComputeIfAbsent(K key, Function<K, @Nullable V> defaultCreator, Class<V> requiredType);
+		<K, V extends @Nullable Object> @Nullable V getOrComputeIfAbsent(K key, Function<K, V> defaultCreator,
+				Class<V> requiredType);
 
 		/**
 		 * Store a {@code value} for later retrieval under the supplied {@code key}.

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

@@ -61,7 +61,6 @@
 import org.junit.jupiter.engine.execution.DefaultTestInstances;
 import org.junit.jupiter.engine.execution.ExtensionContextSupplier;
 import org.junit.jupiter.engine.execution.InterceptingExecutableInvoker;
-import org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.ReflectiveInterceptorCall;
 import org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall;
 import org.junit.jupiter.engine.execution.JupiterEngineExecutionContext;
 import org.junit.jupiter.engine.execution.TestInstancesProvider;
@@ -448,8 +447,8 @@ private void invokeBeforeAllMethods(JupiterEngineExecutionContext context) {
 		for (Method method : requireLifecycleMethods().beforeAll) {
 			throwableCollector.execute(() -> {
 				try {
-					executableInvoker.invoke(method, testInstance, extensionContext, registry,
-						ReflectiveInterceptorCall.ofVoidMethod(InvocationInterceptor::interceptBeforeAllMethod));
+					executableInvoker.invokeVoid(method, testInstance, extensionContext, registry,
+						InvocationInterceptor::interceptBeforeAllMethod);
 				}
 				catch (Throwable throwable) {
 					invokeBeforeAllMethodExecutionExceptionHandlers(registry, extensionContext, throwable);
@@ -476,8 +475,8 @@ private void invokeAfterAllMethods(JupiterEngineExecutionContext context) {
 
 		requireLifecycleMethods().afterAll.forEach(method -> throwableCollector.execute(() -> {
 			try {
-				executableInvoker.invoke(method, testInstance, extensionContext, registry,
-					ReflectiveInterceptorCall.ofVoidMethod(InvocationInterceptor::interceptAfterAllMethod));
+				executableInvoker.invokeVoid(method, testInstance, extensionContext, registry,
+					InvocationInterceptor::interceptAfterAllMethod);
 			}
 			catch (Throwable throwable) {
 				invokeAfterAllMethodExecutionExceptionHandlers(registry, extensionContext, throwable);
@@ -549,8 +548,7 @@ private void invokeMethodInExtensionContext(Method method, ExtensionContext cont
 		Object target = testInstances.findInstance(getTestClass()).orElseThrow(
 			() -> new JUnitException("Failed to find instance for method: " + method.toGenericString()));
 
-		executableInvoker.invoke(method, target, context, registry,
-			ReflectiveInterceptorCall.ofVoidMethod(interceptorCall));
+		executableInvoker.invokeVoid(method, target, context, registry, interceptorCall);
 	}
 
 	private LifecycleMethods requireLifecycleMethods() {

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

@@ -65,14 +65,14 @@ public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext conte
 			requiredDynamicTest().getExecutable());
 		ExtensionContext extensionContext = context.getExtensionContext();
 		ExtensionRegistry extensionRegistry = context.getExtensionRegistry();
-		interceptorChain.invoke(toInvocation(), extensionRegistry, InterceptorCall.ofVoid(
-			(interceptor, wrappedInvocation) -> interceptor.interceptDynamicTest(wrappedInvocation,
-				dynamicTestInvocationContext, extensionContext)));
+		interceptorChain.<@Nullable Void> invoke(toInvocation(), extensionRegistry, InterceptorCall.ofVoid((
+				InvocationInterceptor interceptor,
+				InvocationInterceptor.Invocation<@Nullable Void> wrappedInvocation) -> interceptor.interceptDynamicTest(
+					wrappedInvocation, dynamicTestInvocationContext, extensionContext)));
 		return context;
 	}
 
-	@SuppressWarnings("NullAway")
-	private InvocationInterceptor.Invocation<Void> toInvocation() {
+	private InvocationInterceptor.Invocation<@Nullable Void> toInvocation() {
 		return () -> {
 			requiredDynamicTest().getExecutable().execute();
 			return null;

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

@@ -139,6 +139,7 @@ static void registerExtensionsFromInstanceFields(ExtensionRegistrar registrar, C
 	/**
 	 * @since 5.11
 	 */
+	@SuppressWarnings("NullAway")
 	private static Extension readAndValidateExtensionFromField(Field field, @Nullable Object instance,
 			List<Class<? extends Extension>> declarativeExtensionTypes) {
 		Object value = tryToReadFieldValue(field, instance) //

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

@@ -59,7 +59,6 @@ public class TestFactoryTestDescriptor extends TestMethodTestDescriptor implemen
 	public static final String DYNAMIC_CONTAINER_SEGMENT_TYPE = "dynamic-container";
 	public static final String DYNAMIC_TEST_SEGMENT_TYPE = "dynamic-test";
 
-	@SuppressWarnings("NullAway")
 	private static final ReflectiveInterceptorCall<Method, @Nullable Object> interceptorCall = InvocationInterceptor::interceptTestFactoryMethod;
 	private static final InterceptingExecutableInvoker executableInvoker = new InterceptingExecutableInvoker();
 
@@ -112,8 +111,8 @@ protected void invokeTestMethod(JupiterEngineExecutionContext context, DynamicTe
 
 		context.getThrowableCollector().execute(() -> {
 			Object instance = extensionContext.getRequiredTestInstance();
-			Object testFactoryMethodResult = executableInvoker.invoke(getTestMethod(), instance, extensionContext,
-				context.getExtensionRegistry(), interceptorCall);
+			Object testFactoryMethodResult = executableInvoker.<@Nullable Object> invoke(getTestMethod(), instance,
+				extensionContext, context.getExtensionRegistry(), interceptorCall);
 			TestSource defaultTestSource = getSource().orElseThrow(
 				() -> new JUnitException("Illegal state: TestSource must be present"));
 			try (Stream<DynamicNode> dynamicNodeStream = toDynamicNodeStream(testFactoryMethodResult)) {