Retain probe defaults when configuring other properties on probe health groups

Closes gh-40268

Signed-off-by: htjworld <116538001+htjworld@users.noreply.github.com>

Author: htjworld

module/spring-boot-health/src/main/java/org/springframework/boot/health/autoconfigure/actuate/endpoint/AvailabilityProbesAutoConfiguration.java

@@ -23,6 +23,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.availability.ApplicationAvailability;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.health.application.LivenessStateHealthIndicator;
 import org.springframework.boot.health.application.ReadinessStateHealthIndicator;
 import org.springframework.boot.health.autoconfigure.application.AvailabilityHealthContributorAutoConfiguration;
@@ -40,6 +41,7 @@
 		ApplicationAvailabilityAutoConfiguration.class })
 @ConditionalOnClass(name = "org.springframework.boot.actuate.endpoint.annotation.Endpoint")
 @ConditionalOnBooleanProperty(name = "management.endpoint.health.probes.enabled", matchIfMissing = true)
+@EnableConfigurationProperties(HealthEndpointProperties.class)
 public final class AvailabilityProbesAutoConfiguration {
 
 	@Bean
@@ -56,8 +58,8 @@ ReadinessStateHealthIndicator readinessStateHealthIndicator(ApplicationAvailabil
 
 	@Bean
 	AvailabilityProbesHealthEndpointGroupsPostProcessor availabilityProbesHealthEndpointGroupsPostProcessor(
-			Environment environment) {
-		return new AvailabilityProbesHealthEndpointGroupsPostProcessor(environment);
+			Environment environment, HealthEndpointProperties properties) {
+		return new AvailabilityProbesHealthEndpointGroupsPostProcessor(environment, properties);
 	}
 
 }

module/spring-boot-health/src/main/java/org/springframework/boot/health/autoconfigure/actuate/endpoint/AvailabilityProbesHealthEndpointGroups.java

@@ -42,22 +42,27 @@
  * @author Phillip Webb
  * @author Brian Clozel
  * @author Madhura Bhave
+ * @author htjworld
  */
 class AvailabilityProbesHealthEndpointGroups implements HealthEndpointGroups, AdditionalPathsMapper {
 
+	private static final String LIVENESS = "liveness";
+
+	private static final String READINESS = "readiness";
+
 	private final HealthEndpointGroups groups;
 
+	private final HealthEndpointProperties properties;
+
 	private final Map<String, HealthEndpointGroup> probeGroups;
 
 	private final Set<String> names;
 
-	private static final String LIVENESS = "liveness";
-
-	private static final String READINESS = "readiness";
-
-	AvailabilityProbesHealthEndpointGroups(HealthEndpointGroups groups, boolean addAdditionalPaths) {
+	AvailabilityProbesHealthEndpointGroups(HealthEndpointGroups groups, boolean addAdditionalPaths,
+			HealthEndpointProperties properties) {
 		Assert.notNull(groups, "'groups' must not be null");
 		this.groups = groups;
+		this.properties = properties;
 		this.probeGroups = createProbeGroups(addAdditionalPaths);
 		Set<String> names = new LinkedHashSet<>(groups.getNames());
 		names.addAll(this.probeGroups.keySet());
@@ -75,19 +80,34 @@ private HealthEndpointGroup getOrCreateProbeGroup(boolean addAdditionalPath, Str
 			String members) {
 		HealthEndpointGroup group = this.groups.get(name);
 		if (group != null) {
-			return determineAdditionalPathForExistingGroup(addAdditionalPath, path, group);
+			if (hasExplicitMembership(name)) {
+				return determineAdditionalPathForExistingGroup(addAdditionalPath, path, group);
+			}
+			return retainProbeDefaultsForExistingGroup(addAdditionalPath, path, group, members);
 		}
 		AdditionalHealthEndpointPath additionalPath = (!addAdditionalPath) ? null
 				: AdditionalHealthEndpointPath.of(WebServerNamespace.SERVER, path);
 		return new AvailabilityProbesHealthEndpointGroup(additionalPath, members);
 	}
 
+	private boolean hasExplicitMembership(String name) {
+		HealthEndpointProperties.Group group = this.properties.getGroup().get(name);
+		return group != null && (group.getInclude() != null || group.getExclude() != null);
+	}
+
+	private HealthEndpointGroup retainProbeDefaultsForExistingGroup(boolean addAdditionalPath, String path,
+			HealthEndpointGroup group, String members) {
+		AdditionalHealthEndpointPath additionalPath = (addAdditionalPath && group.getAdditionalPath() == null)
+				? AdditionalHealthEndpointPath.of(WebServerNamespace.SERVER, path) : null;
+		return new DelegatingAvailabilityProbesHealthEndpointGroup(group, additionalPath, Set.of(members));
+	}
+
 	private HealthEndpointGroup determineAdditionalPathForExistingGroup(boolean addAdditionalPath, String path,
 			HealthEndpointGroup group) {
 		if (addAdditionalPath && group.getAdditionalPath() == null) {
 			AdditionalHealthEndpointPath additionalPath = AdditionalHealthEndpointPath.of(WebServerNamespace.SERVER,
 					path);
-			return new DelegatingAvailabilityProbesHealthEndpointGroup(group, additionalPath);
+			return new DelegatingAvailabilityProbesHealthEndpointGroup(group, additionalPath, null);
 		}
 		return group;
 	}

module/spring-boot-health/src/main/java/org/springframework/boot/health/autoconfigure/actuate/endpoint/AvailabilityProbesHealthEndpointGroupsPostProcessor.java

@@ -28,20 +28,24 @@
  *
  * @author Phillip Webb
  * @author Madhura Bhave
+ * @author htjworld
  */
 @Order(Ordered.LOWEST_PRECEDENCE)
 class AvailabilityProbesHealthEndpointGroupsPostProcessor implements HealthEndpointGroupsPostProcessor {
 
 	private final boolean addAdditionalPaths;
 
-	AvailabilityProbesHealthEndpointGroupsPostProcessor(Environment environment) {
+	private final HealthEndpointProperties properties;
+
+	AvailabilityProbesHealthEndpointGroupsPostProcessor(Environment environment, HealthEndpointProperties properties) {
 		this.addAdditionalPaths = "true"
 			.equalsIgnoreCase(environment.getProperty("management.endpoint.health.probes.add-additional-paths"));
+		this.properties = properties;
 	}
 
 	@Override
 	public HealthEndpointGroups postProcessHealthEndpointGroups(HealthEndpointGroups groups) {
-		return new AvailabilityProbesHealthEndpointGroups(groups, this.addAdditionalPaths);
+		return new AvailabilityProbesHealthEndpointGroups(groups, this.addAdditionalPaths, this.properties);
 	}
 
 }

module/spring-boot-health/src/main/java/org/springframework/boot/health/autoconfigure/actuate/endpoint/DelegatingAvailabilityProbesHealthEndpointGroup.java

@@ -16,6 +16,10 @@
 
 package org.springframework.boot.health.autoconfigure.actuate.endpoint;
 
+import java.util.Set;
+
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.actuate.endpoint.SecurityContext;
 import org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath;
 import org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup;
@@ -28,23 +32,27 @@
  * existing group.
  *
  * @author Madhura Bhave
+ * @author htjworld
  */
 class DelegatingAvailabilityProbesHealthEndpointGroup implements HealthEndpointGroup {
 
 	private final HealthEndpointGroup delegate;
 
-	private final AdditionalHealthEndpointPath additionalPath;
+	private final @Nullable AdditionalHealthEndpointPath additionalPath;
+
+	private final @Nullable Set<String> members;
 
 	DelegatingAvailabilityProbesHealthEndpointGroup(HealthEndpointGroup delegate,
-			AdditionalHealthEndpointPath additionalPath) {
+			@Nullable AdditionalHealthEndpointPath additionalPath, @Nullable Set<String> members) {
 		Assert.notNull(delegate, "'delegate' must not be null");
 		this.delegate = delegate;
 		this.additionalPath = additionalPath;
+		this.members = members;
 	}
 
 	@Override
 	public boolean isMember(String name) {
-		return this.delegate.isMember(name);
+		return (this.members != null) ? this.members.contains(name) : this.delegate.isMember(name);
 	}
 
 	@Override
@@ -68,8 +76,8 @@ public HttpCodeStatusMapper getHttpCodeStatusMapper() {
 	}
 
 	@Override
-	public AdditionalHealthEndpointPath getAdditionalPath() {
-		return this.additionalPath;
+	public @Nullable AdditionalHealthEndpointPath getAdditionalPath() {
+		return (this.additionalPath != null) ? this.additionalPath : this.delegate.getAdditionalPath();
 	}
 
 }

module/spring-boot-health/src/test/java/org/springframework/boot/health/autoconfigure/actuate/endpoint/AvailabilityProbesHealthEndpointGroupsPostProcessorTests.java

@@ -43,7 +43,7 @@
 class AvailabilityProbesHealthEndpointGroupsPostProcessorTests {
 
 	private final AvailabilityProbesHealthEndpointGroupsPostProcessor postProcessor = new AvailabilityProbesHealthEndpointGroupsPostProcessor(
-			new MockEnvironment());
+			new MockEnvironment(), new HealthEndpointProperties());
 
 	@Test
 	void postProcessHealthEndpointGroupsWhenGroupsAlreadyContainedReturnsOriginal() {
@@ -102,7 +102,7 @@ void postProcessHealthEndpointGroupsWhenGroupsAlreadyContainedAndAdditionalPathP
 		MockEnvironment environment = new MockEnvironment();
 		environment.setProperty("management.endpoint.health.probes.add-additional-paths", "true");
 		AvailabilityProbesHealthEndpointGroupsPostProcessor postProcessor = new AvailabilityProbesHealthEndpointGroupsPostProcessor(
-				environment);
+				environment, new HealthEndpointProperties());
 		HealthEndpointGroups postProcessed = postProcessor.postProcessHealthEndpointGroups(groups);
 		HealthEndpointGroup liveness = postProcessed.get("liveness");
 		assertThat(liveness).isNotNull();
@@ -120,7 +120,7 @@ void delegatesAdditionalPathMappingToOriginalBean() {
 			.willReturn(List.of("/one", "/two", "/three"));
 		MockEnvironment environment = new MockEnvironment();
 		AvailabilityProbesHealthEndpointGroupsPostProcessor postProcessor = new AvailabilityProbesHealthEndpointGroupsPostProcessor(
-				environment);
+				environment, new HealthEndpointProperties());
 		HealthEndpointGroups postProcessed = postProcessor.postProcessHealthEndpointGroups(groups);
 		assertThat(postProcessed).isInstanceOf(AdditionalPathsMapper.class);
 		AdditionalPathsMapper additionalPathsMapper = (AdditionalPathsMapper) postProcessed;
@@ -137,7 +137,7 @@ void whenAddAdditionalPathsIsTrueThenIncludesOwnAdditionalPathsInGetAdditionalPa
 		MockEnvironment environment = new MockEnvironment();
 		environment.setProperty("management.endpoint.health.probes.add-additional-paths", "true");
 		AvailabilityProbesHealthEndpointGroupsPostProcessor postProcessor = new AvailabilityProbesHealthEndpointGroupsPostProcessor(
-				environment);
+				environment, new HealthEndpointProperties());
 		HealthEndpointGroups postProcessed = postProcessor.postProcessHealthEndpointGroups(groups);
 		assertThat(postProcessed).isInstanceOf(AdditionalPathsMapper.class);
 		AdditionalPathsMapper additionalPathsMapper = (AdditionalPathsMapper) postProcessed;
@@ -149,7 +149,7 @@ private HealthEndpointGroups getPostProcessed(String value) {
 		MockEnvironment environment = new MockEnvironment();
 		environment.setProperty("management.endpoint.health.probes.add-additional-paths", value);
 		AvailabilityProbesHealthEndpointGroupsPostProcessor postProcessor = new AvailabilityProbesHealthEndpointGroupsPostProcessor(
-				environment);
+				environment, new HealthEndpointProperties());
 		HealthEndpointGroups groups = mock(HealthEndpointGroups.class);
 		return postProcessor.postProcessHealthEndpointGroups(groups);
 	}