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

See gh-47263

Author: mhalbritter

module/spring-boot-health/build.gradle

@@ -37,5 +37,11 @@ dependencies {
 testImplementation("io.projectreactor:reactor-test")
 testImplementation("tools.jackson.core:jackson-databind")
 
+testCompileOnly("com.google.code.findbugs:jsr305")
+
 testRuntimeOnly("ch.qos.logback:logback-classic")
 }
+
+tasks.named("compileTestJava") {
+options.nullability.checking = "tests"
+}

module/spring-boot-health/src/test/java/org/springframework/boot/health/autoconfigure/contributor/AbstractCompositeHealthContributorConfigurationTests.java

@@ -21,6 +21,7 @@
 import java.util.Map;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@@ -41,7 +42,7 @@
  */
 abstract class AbstractCompositeHealthContributorConfigurationTests<C, I extends C> {
 
-private final Class<?> indicatorType;
+private final @Nullable Class<?> indicatorType;
 
 AbstractCompositeHealthContributorConfigurationTests() {
 ResolvableType type = ResolvableType.forClass(AbstractCompositeHealthContributorConfigurationTests.class,

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/CompositeReactiveHealthContributorTests.java

@@ -39,11 +39,16 @@ void asHealthContributorReturnsAdaptedContributor() {
 .fromMap(reactiveContributors);
 CompositeHealthContributor adapted = contributor.asHealthContributor();
 HealthIndicator byName = (HealthIndicator) adapted.getContributor("test");
-assertThat(byName.health(true).getDetails()).containsEntry("spring", "boot");
+assertThat(byName).isNotNull();
+Health health = byName.health(true);
+assertThat(health).isNotNull();
+assertThat(health.getDetails()).containsEntry("spring", "boot");
 HealthContributors.Entry entry = adapted.iterator().next();
 assertThat(entry.name()).isEqualTo("test");
 HealthIndicator byEntry = (HealthIndicator) entry.contributor();
-assertThat(byEntry.health(true).getDetails()).containsEntry("spring", "boot");
+health = byEntry.health(true);
+assertThat(health).isNotNull();
+assertThat(health.getDetails()).containsEntry("spring", "boot");
 }
 
 @Test

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/HealthContributorsAdapterTests.java

@@ -42,6 +42,7 @@ void iteratorWhenDelegateContainsHealthIndicatorAdaptsDelegate() {
 assertThat(adapted.name()).isEqualTo("test");
 assertThat(adapted.contributor()).isInstanceOf(ReactiveHealthIndicator.class);
 Health health = ((ReactiveHealthIndicator) adapted.contributor()).health(true).block();
+assertThat(health).isNotNull();
 assertThat(health.getStatus()).isEqualTo(Status.UP);
 assertThat(health.getDetails()).containsEntry("spring", "boot");
 }
@@ -61,7 +62,9 @@ void iteratorWhenDelegateContainsCompositeHealthContributorAdaptsDelegate() {
 assertThat(adapted.contributor()).isInstanceOf(CompositeReactiveHealthContributor.class);
 ReactiveHealthContributor nested = ((CompositeReactiveHealthContributor) adapted.contributor())
 .getContributor("test1");
+assertThat(nested).isNotNull();
 Health health = ((ReactiveHealthIndicator) nested).health(true).block();
+assertThat(health).isNotNull();
 assertThat(health.getStatus()).isEqualTo(Status.UP);
 assertThat(health.getDetails()).containsEntry("spring", "boot");
 }
@@ -73,7 +76,9 @@ void getContributorAdaptsDelegate() {
 .fromMap(Collections.singletonMap("test", indicator));
 HealthContributorsAdapter adapter = createAdapter(delegate);
 ReactiveHealthContributor adapted = adapter.getContributor("test");
+assertThat(adapted).isNotNull();
 Health health = ((ReactiveHealthIndicator) adapted).health(true).block();
+assertThat(health).isNotNull();
 assertThat(health.getStatus()).isEqualTo(Status.UP);
 assertThat(health.getDetails()).containsEntry("spring", "boot");
 }

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/HealthContributorsTests.java

@@ -18,6 +18,7 @@
 
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.boot.health.contributor.HealthContributors.Entry;
@@ -45,7 +46,7 @@ public Stream<Entry> stream() {
 }
 
 @Override
-public HealthContributor getContributor(String name) {
+public @Nullable HealthContributor getContributor(String name) {
 return null;
 }
 
@@ -60,6 +61,7 @@ void createEntryWhenNameIsEmptyThrowsException() {
 }
 
 @Test
+@SuppressWarnings("NullAway") // Test null check
 void createEntryWhenContributorIsNullThrowsException() {
 assertThatIllegalArgumentException().isThrownBy(() -> new Entry("test", null))
 .withMessage("'contributor' must not be null");

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/HealthIndicatorTests.java

@@ -32,13 +32,15 @@ class HealthIndicatorTests {
 @Test
 void getHealthWhenIncludeDetailsIsTrueReturnsHealthWithDetails() {
 Health health = this.indicator.health(true);
+assertThat(health).isNotNull();
 assertThat(health.getStatus()).isEqualTo(Status.UP);
 assertThat(health.getDetails()).containsEntry("spring", "boot");
 }
 
 @Test
 void getHealthWhenIncludeDetailsIsFalseReturnsHealthWithoutDetails() {
 Health health = this.indicator.health(false);
+assertThat(health).isNotNull();
 assertThat(health.getStatus()).isEqualTo(Status.UP);
 assertThat(health.getDetails()).isEmpty();
 }

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/HealthTests.java

@@ -38,6 +38,7 @@
 class HealthTests {
 
 @Test
+@SuppressWarnings("NullAway") // Test null check
 void statusMustNotBeNull() {
 assertThatIllegalArgumentException().isThrownBy(() -> new Health.Builder(null, null))
 .withMessageContaining("'status' must not be null");

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/MapCompositeHealthContributorTests.java

@@ -20,8 +20,12 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.health.contributor.HealthContributors.Entry;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link MapCompositeHealthContributor}.
  *
@@ -31,8 +35,9 @@ class MapCompositeHealthContributorTests
 extends MapCompositeTests<CompositeHealthContributor, HealthContributor, Entry> {
 
 @Override
+@SuppressWarnings("NullAway") // Test null check
 protected CompositeHealthContributor create(Map<String, String> map,
-Function<String, HealthContributor> valueAdapter) {
+@Nullable Function<String, HealthContributor> valueAdapter) {
 return new MapCompositeHealthContributor<>(map, valueAdapter);
 }
 
@@ -42,7 +47,7 @@ protected Stream<Entry> stream(CompositeHealthContributor composite) {
 }
 
 @Override
-protected HealthContributor getContributor(CompositeHealthContributor composite, String name) {
+protected @Nullable HealthContributor getContributor(CompositeHealthContributor composite, String name) {
 return composite.getContributor(name);
 }
 
@@ -52,8 +57,10 @@ protected HealthContributor createContributor(String data) {
 }
 
 @Override
-protected String getData(HealthContributor contributor) {
-return (String) ((HealthIndicator) contributor).health().getDetails().get("data");
+protected @Nullable String getData(HealthContributor contributor) {
+Health health = ((HealthIndicator) contributor).health();
+assertThat(health).isNotNull();
+return (String) health.getDetails().get("data");
 }
 
 @Override

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/MapCompositeReactiveHealthContributorTests.java

@@ -20,10 +20,13 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
 import reactor.core.publisher.Mono;
 
 import org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link MapCompositeReactiveHealthContributor}.
  *
@@ -33,8 +36,9 @@ class MapCompositeReactiveHealthContributorTests
 extends MapCompositeTests<CompositeReactiveHealthContributor, ReactiveHealthContributor, Entry> {
 
 @Override
+@SuppressWarnings("NullAway") // Test null check
 protected CompositeReactiveHealthContributor create(Map<String, String> map,
-Function<String, ReactiveHealthContributor> valueAdapter) {
+@Nullable Function<String, ReactiveHealthContributor> valueAdapter) {
 return new MapCompositeReactiveHealthContributor<>(map, valueAdapter);
 }
 
@@ -44,7 +48,8 @@ protected Stream<Entry> stream(CompositeReactiveHealthContributor composite) {
 }
 
 @Override
-protected ReactiveHealthContributor getContributor(CompositeReactiveHealthContributor composite, String name) {
+protected @Nullable ReactiveHealthContributor getContributor(CompositeReactiveHealthContributor composite,
+String name) {
 return composite.getContributor(name);
 }
 
@@ -54,8 +59,10 @@ protected ReactiveHealthContributor createContributor(String data) {
 }
 
 @Override
-protected String getData(ReactiveHealthContributor contributor) {
-return (String) ((ReactiveHealthIndicator) contributor).health().block().getDetails().get("data");
+protected @Nullable String getData(ReactiveHealthContributor contributor) {
+Health health = ((ReactiveHealthIndicator) contributor).health().block();
+assertThat(health).isNotNull();
+return (String) health.getDetails().get("data");
 }
 
 @Override

module/spring-boot-health/src/test/java/org/springframework/boot/health/contributor/MapCompositeTests.java

@@ -24,6 +24,7 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -41,12 +42,14 @@
 abstract class MapCompositeTests<T, C, E> {
 
 @Test
+@SuppressWarnings("NullAway") // Test null check
 void createWhenMapIsNullThrowsException() {
 assertThatIllegalArgumentException().isThrownBy(() -> createWithData(null, Function.identity()))
 .withMessage("'map' must not be null");
 }
 
 @Test
+@SuppressWarnings("NullAway") // Test null check
 void createWhenValueAdapterIsNullThrowsException() {
 assertThatIllegalArgumentException().isThrownBy(() -> createWithData(Collections.emptyMap(), null))
 .withMessage("'valueAdapter' must not be null");
@@ -133,19 +136,21 @@ private T createWithData(Map<String, String> map, Function<String, String> dataA
 return create(map, (dataAdapter != null) ? (key) -> createContributor(dataAdapter.apply(key)) : null);
 }
 
-private String getContributorData(T composite, String name) {
-return getData(getContributor(composite, name));
+private @Nullable String getContributorData(T composite, String name) {
+C contributor = getContributor(composite, name);
+assertThat(contributor).isNotNull();
+return getData(contributor);
 }
 
-protected abstract T create(Map<String, String> map, Function<String, C> valueAdapter);
+protected abstract T create(Map<String, String> map, @Nullable Function<String, C> valueAdapter);
 
 protected abstract Stream<E> stream(T composite);
 
-protected abstract C getContributor(T composite, String name);
+protected abstract @Nullable C getContributor(T composite, String name);
 
 protected abstract C createContributor(String data);
 
-protected abstract String getData(C contributor);
+protected abstract @Nullable String getData(C contributor);
 
 protected abstract String getName(E entry);