Add nullability annotations to tests in module/spring-boot-jetty

mhalbritter · mhalbritter · commit c92617a0154b · 2025-10-06T13:07:57.000+02:00
See gh-47263
diff --git a/module/spring-boot-jetty/build.gradle b/module/spring-boot-jetty/build.gradle
@@ -48,6 +48,8 @@ dependencies {
 	testImplementation(testFixtures(project(":core:spring-boot-autoconfigure")))
 	testImplementation("org.apache.httpcomponents.client5:httpclient5")
 
+	testCompileOnly("com.google.code.findbugs:jsr305")
+
 	testRuntimeOnly("ch.qos.logback:logback-classic")
 	testRuntimeOnly("io.projectreactor:reactor-test")
 	testRuntimeOnly("io.projectreactor.netty:reactor-netty-http")
@@ -61,3 +63,6 @@ test {
 	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
 }
 
+tasks.named("compileTestJava") {
+	options.nullability.checking = "tests"
+}
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/SslServerCustomizerTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/SslServerCustomizerTests.java
@@ -96,7 +96,8 @@ void alpnConnectionFactoryHasNullDefaultProtocolToAllowNegotiationToHttp11() {
 	void configureSslWhenSslIsEnabledWithNoKeyStoreAndNotPkcs11ThrowsException() {
 		Ssl ssl = new Ssl();
 		assertThatIllegalStateException().isThrownBy(() -> {
-			SslServerCustomizer customizer = new SslServerCustomizer(null, null, null, WebServerSslBundle.get(ssl));
+			SslServerCustomizer customizer = new SslServerCustomizer(null, new InetSocketAddress(0), null,
+					WebServerSslBundle.get(ssl));
 			customizer.configureSsl(new SslContextFactory.Server(), ssl.getClientAuth());
 		}).withMessageContaining("SSL is enabled but no trust material is configured");
 	}
@@ -110,7 +111,8 @@ void configureSslWhenSslIsEnabledWithPkcs11AndKeyStoreThrowsException() {
 		ssl.setKeyStore("classpath:test.jks");
 		ssl.setKeyPassword("password");
 		assertThatIllegalStateException().isThrownBy(() -> {
-			SslServerCustomizer customizer = new SslServerCustomizer(null, null, null, WebServerSslBundle.get(ssl));
+			SslServerCustomizer customizer = new SslServerCustomizer(null, new InetSocketAddress(0), null,
+					WebServerSslBundle.get(ssl));
 			customizer.configureSsl(new SslContextFactory.Server(), ssl.getClientAuth());
 		}).withMessageContaining("must be empty or null for PKCS11 hardware key stores");
 	}
@@ -122,7 +124,8 @@ void customizeWhenSslIsEnabledWithPkcs11AndKeyStoreProvider() {
 		ssl.setKeyStoreProvider(MockPkcs11SecurityProvider.NAME);
 		ssl.setKeyStorePassword("1234");
 		assertThatNoException().isThrownBy(() -> {
-			SslServerCustomizer customizer = new SslServerCustomizer(null, null, null, WebServerSslBundle.get(ssl));
+			SslServerCustomizer customizer = new SslServerCustomizer(null, new InetSocketAddress(0), null,
+					WebServerSslBundle.get(ssl));
 			customizer.configureSsl(new SslContextFactory.Server(), ssl.getClientAuth());
 		});
 	}
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/JettyWebServerFactoryCustomizerTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/JettyWebServerFactoryCustomizerTests.java
@@ -378,7 +378,9 @@ private void startAndStopToMakeInternalsAvailable(JettyWebServer server) {
 	}
 
 	private BlockingQueue<?> getQueue(ThreadPool threadPool) {
-		return ReflectionTestUtils.invokeMethod(threadPool, "getQueue");
+		BlockingQueue<?> queue = ReflectionTestUtils.invokeMethod(threadPool, "getQueue");
+		assertThat(queue).isNotNull();
+		return queue;
 	}
 
 	private void bind(String... inlinedProperties) {
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/metrics/JettyMetricsAutoConfigurationTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/metrics/JettyMetricsAutoConfigurationTests.java
@@ -217,7 +217,7 @@ void doesNotAutoConfigureSslHandshakeMetricsWhenSslEnabledPropertySetToFalse() {
 	}
 
 	private ApplicationStartedEvent createApplicationStartedEvent(ConfigurableApplicationContext context) {
-		return new ApplicationStartedEvent(new SpringApplication(), null, context, null);
+		return new ApplicationStartedEvent(new SpringApplication(), new String[0], context, null);
 	}
 
 	@Configuration(proxyBeanMethods = false)
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/reactive/JettyReactiveWebServerAutoConfigurationTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/reactive/JettyReactiveWebServerAutoConfigurationTests.java
@@ -76,6 +76,7 @@ void webSocketServerContainerIsAvailableFromServletContext() {
 		this.serverRunner.run((context) -> {
 			WebServer webServer = ((ReactiveWebServerApplicationContext) context.getSourceApplicationContext())
 				.getWebServer();
+			assertThat(webServer).isNotNull();
 			ServletContextHandler servletContextHandler = (ServletContextHandler) ((StatisticsHandler) ((JettyWebServer) webServer)
 				.getServer()
 				.getHandler()).getHandler();
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/servlet/JettyServletWebServerAutoConfigurationTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/autoconfigure/servlet/JettyServletWebServerAutoConfigurationTests.java
@@ -19,6 +19,7 @@
 import java.util.Map;
 
 import jakarta.servlet.Filter;
+import jakarta.servlet.ServletContext;
 import org.eclipse.jetty.ee11.websocket.servlet.WebSocketUpgradeFilter;
 import org.eclipse.jetty.server.Server;
 import org.junit.jupiter.api.Test;
@@ -75,9 +76,11 @@ void jettyServerCustomizerRegisteredAsBeanAndViaFactoryIsOnlyCalledOnce() {
 
 	@Test
 	void jettyWebSocketUpgradeFilterIsAddedToServletContex() {
-		this.serverRunner.run((context) -> assertThat(
-				context.getServletContext().getFilterRegistration(WebSocketUpgradeFilter.class.getName()))
-			.isNotNull());
+		this.serverRunner.run((context) -> {
+			ServletContext servletContext = context.getServletContext();
+			assertThat(servletContext).isNotNull();
+			assertThat(servletContext.getFilterRegistration(WebSocketUpgradeFilter.class.getName())).isNotNull();
+		});
 	}
 
 	@Test
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/reactive/JettyReactiveWebServerFactoryTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/reactive/JettyReactiveWebServerFactoryTests.java
@@ -72,13 +72,15 @@ protected void noCompressionForUserAgent() {
 	}
 
 	@Test
+	@SuppressWarnings("NullAway") // Test null check
 	void setNullServerCustomizersShouldThrowException() {
 		JettyReactiveWebServerFactory factory = getFactory();
 		assertThatIllegalArgumentException().isThrownBy(() -> factory.setServerCustomizers(null))
 			.withMessageContaining("'customizers' must not be null");
 	}
 
 	@Test
+	@SuppressWarnings("NullAway") // Test null check
 	void addNullServerCustomizersShouldThrowException() {
 		JettyReactiveWebServerFactory factory = getFactory();
 		assertThatIllegalArgumentException()
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/servlet/JettyServletWebServerFactoryTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/servlet/JettyServletWebServerFactoryTests.java
@@ -58,6 +58,7 @@
 import org.eclipse.jetty.util.ssl.SslContextFactory;
 import org.eclipse.jetty.util.thread.QueuedThreadPool;
 import org.eclipse.jetty.util.thread.ThreadPool;
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.mockito.InOrder;
@@ -123,7 +124,7 @@ protected void addConnector(int port, ConfigurableServletWebServerFactory factor
 	}
 
 	@Override
-	protected JspServlet getJspServlet() throws Exception {
+	protected @Nullable JspServlet getJspServlet() throws Exception {
 		WebAppContext context = findWebAppContext((JettyWebServer) this.webServer);
 		ServletHolder holder = context.getServletHandler().getServlet("jsp");
 		if (holder == null) {
@@ -141,7 +142,7 @@ protected Map<String, String> getActualMimeMappings() {
 	}
 
 	@Override
-	protected Charset getCharset(Locale locale) {
+	protected @Nullable Charset getCharset(Locale locale) {
 		WebAppContext context = findWebAppContext((JettyWebServer) this.webServer);
 		String charsetName = context.getLocaleEncoding(locale);
 		return (charsetName != null) ? Charset.forName(charsetName) : null;
@@ -314,7 +315,11 @@ private SslContextFactory extractSslContextFactory(SslConnectionFactory connecti
 		catch (NoSuchMethodError ex) {
 			Method getSslContextFactory = ReflectionUtils.findMethod(connectionFactory.getClass(),
 					"getSslContextFactory");
-			return (SslContextFactory) ReflectionUtils.invokeMethod(getSslContextFactory, connectionFactory);
+			assertThat(getSslContextFactory).isNotNull();
+			SslContextFactory sslContextFactory = (SslContextFactory) ReflectionUtils.invokeMethod(getSslContextFactory,
+					connectionFactory);
+			assertThat(sslContextFactory).isNotNull();
+			return sslContextFactory;
 		}
 	}
 
@@ -528,6 +533,7 @@ public void contextDestroyed(ServletContextEvent event) {
 				// Jetty 10
 				Method addEventListener = ReflectionUtils.findMethod(context.getClass(), "addEventListener",
 						EventListener.class);
+				assertThat(addEventListener).isNotNull();
 				ReflectionUtils.invokeMethod(addEventListener, context, eventListener);
 			}
 		});
diff --git a/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/servlet/LoaderHidingResourceTests.java b/module/spring-boot-jetty/src/test/java/org/springframework/boot/jetty/servlet/LoaderHidingResourceTests.java
@@ -70,10 +70,14 @@ void resolveHidesLoaderResources(@TempDir File temp) throws IOException {
 		URI warUri = createExampleWar(temp);
 		Resource resource = new PathResourceFactory().newResource(warUri);
 		LoaderHidingResource loaderHidingResource = new LoaderHidingResource(resource, resource);
-		assertThat(loaderHidingResource.resolve("/assets/image.jpg").exists()).isTrue();
-		assertThat(loaderHidingResource.resolve("/assets/image.jpg")).isInstanceOf(LoaderHidingResource.class);
-		assertThat(loaderHidingResource.resolve("/assets/non-existent.jpg").exists()).isFalse();
-		assertThat(loaderHidingResource.resolve("/assets/non-existent.jpg")).isInstanceOf(LoaderHidingResource.class);
+		Resource image = loaderHidingResource.resolve("/assets/image.jpg");
+		assertThat(image).isNotNull();
+		assertThat(image.exists()).isTrue();
+		assertThat(image).isInstanceOf(LoaderHidingResource.class);
+		Resource doesntExist = loaderHidingResource.resolve("/assets/non-existent.jpg");
+		assertThat(doesntExist).isNotNull();
+		assertThat(doesntExist.exists()).isFalse();
+		assertThat(doesntExist).isInstanceOf(LoaderHidingResource.class);
 		assertThat(loaderHidingResource.resolve("/org/springframework/boot/Loader.class")).isNull();
 	}
 
diff --git a/module/spring-boot-web-server/src/testFixtures/java/org/springframework/boot/web/server/servlet/AbstractServletWebServerFactoryTests.java b/module/spring-boot-web-server/src/testFixtures/java/org/springframework/boot/web/server/servlet/AbstractServletWebServerFactoryTests.java
@@ -106,6 +106,7 @@
 import org.eclipse.jetty.client.ContentResponse;
 import org.eclipse.jetty.http2.client.HTTP2Client;
 import org.eclipse.jetty.http2.client.transport.HttpClientTransportOverHTTP2;
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assumptions;
 import org.junit.jupiter.api.Test;
@@ -1507,7 +1508,7 @@ protected void service(HttpServletRequest req, HttpServletResponse resp) throws
 
 	protected abstract Map<String, String> getActualMimeMappings();
 
-	protected abstract Charset getCharset(Locale locale);
+	protected abstract @Nullable Charset getCharset(Locale locale);
 
 	protected void addTestTxtFile(ConfigurableServletWebServerFactory factory) throws IOException {
 		FileCopyUtils.copy("test", new FileWriter(new File(this.tempDir, "test.txt")));
@@ -1588,7 +1589,7 @@ protected void assertForwardHeaderIsUsed(ServletWebServerFactory factory) throws
 
 	protected abstract ConfigurableServletWebServerFactory getFactory();
 
-	protected abstract org.apache.jasper.servlet.JspServlet getJspServlet() throws Exception;
+	protected abstract org.apache.jasper.servlet.@Nullable JspServlet getJspServlet() throws Exception;
 
 	protected ServletContextInitializer exampleServletRegistration() {
 		return new ServletRegistrationBean<>(new ExampleServlet(), "/hello");

Original file line number	Diff line number	Diff line change
`@@ -378,7 +378,9 @@ private void startAndStopToMakeInternalsAvailable(JettyWebServer server) {`
`378`	`378`	`}`
`379`	`379`
`380`	`380`	`private BlockingQueue<?> getQueue(ThreadPool threadPool) {`
`381`		`- return ReflectionTestUtils.invokeMethod(threadPool, "getQueue");`
	`381`	`+ BlockingQueue<?> queue = ReflectionTestUtils.invokeMethod(threadPool, "getQueue");`
	`382`	`+ assertThat(queue).isNotNull();`
	`383`	`+ return queue;`
`382`	`384`	`}`
`383`	`385`
`384`	`386`	`private void bind(String... inlinedProperties) {`
Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ void doesNotAutoConfigureSslHandshakeMetricsWhenSslEnabledPropertySetToFalse() {`
`217`	`217`	`}`
`218`	`218`
`219`	`219`	`private ApplicationStartedEvent createApplicationStartedEvent(ConfigurableApplicationContext context) {`
`220`		`- return new ApplicationStartedEvent(new SpringApplication(), null, context, null);`
	`220`	`+ return new ApplicationStartedEvent(new SpringApplication(), new String[0], context, null);`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`@Configuration(proxyBeanMethods = false)`
Original file line number	Diff line number	Diff line change
`@@ -72,13 +72,15 @@ protected void noCompressionForUserAgent() {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`@Test`
	`75`	`+ @SuppressWarnings("NullAway") // Test null check`
`75`	`76`	`void setNullServerCustomizersShouldThrowException() {`
`76`	`77`	`JettyReactiveWebServerFactory factory = getFactory();`
`77`	`78`	`assertThatIllegalArgumentException().isThrownBy(() -> factory.setServerCustomizers(null))`
`78`	`79`	`.withMessageContaining("'customizers' must not be null");`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`@Test`
	`83`	`+ @SuppressWarnings("NullAway") // Test null check`
`82`	`84`	`void addNullServerCustomizersShouldThrowException() {`
`83`	`85`	`JettyReactiveWebServerFactory factory = getFactory();`
`84`	`86`	`assertThatIllegalArgumentException()`