[config-server] Allow overriding of accept-empty property in health indicator (#3190)

Allow developer to set the property 'spring.cloud.config.server.health.accept-empty' to override the property 'spring.cloud.config.server.accept-empty'.

Signed-off-by: ilia1243 <8808144+ilia1243@users.noreply.github.com>

Author: ilia1243

docs/modules/ROOT/pages/server/health-indicator.adoc

@@ -25,6 +25,6 @@ You can disable the Health Indicator by setting `spring.cloud.config.server.heal
 
 Also, you can provide a custom `down` status of your own by setting property `spring.cloud.config.server.health.down-health-status` (valued to `"DOWN'` by default).
 
-NOTE: If `spring.cloud.config.server.accept-empty` is `false` and the health indicator check returns
-does not return any repository data the health indicator will return `DOWN` status.
-
+NOTE: If `spring.cloud.config.server.accept-empty` is `false` and the health indicator check
+does not return any repository data the health indicator will return `down` status.
+You can override this by setting `spring.cloud.config.server.health.accept-empty=true`.

spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/ConfigServerHealthIndicator.java

@@ -51,7 +51,7 @@ public class ConfigServerHealthIndicator extends AbstractHealthIndicator {
 
 	private String downHealthStatus = Status.DOWN.getCode();
 
-	private final boolean acceptEmpty;
+	private boolean acceptEmpty;
 
 	@Deprecated
 	public ConfigServerHealthIndicator(EnvironmentRepository environmentRepository) {
@@ -116,7 +116,7 @@ protected void doHealthCheck(Health.Builder builder) {
 			// If accept-empty is false and no repositories are found, meaning details is
 			// empty, then set status to DOWN
 			// If there are details but none of them have sources, then set status to DOWN
-			builder.down().withDetail("acceptEmpty", this.acceptEmpty);
+			builder.status(this.downHealthStatus).withDetail("acceptEmpty", this.acceptEmpty);
 		}
 		builder.withDetail("repositories", details);
 
@@ -138,6 +138,14 @@ public void setDownHealthStatus(String downHealthStatus) {
 		this.downHealthStatus = downHealthStatus;
 	}
 
+	public boolean isAcceptEmpty() {
+		return acceptEmpty;
+	}
+
+	public void setAcceptEmpty(boolean acceptEmpty) {
+		this.acceptEmpty = acceptEmpty;
+	}
+
 	/**
 	 * Repository properties.
 	 */

spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/config/ConfigServerHealthIndicatorTests.java

@@ -98,6 +98,16 @@ public void acceptEmptyFalseNoRepos() {
 		assertThat(this.indicator.health().getStatus()).as("wrong default status").isEqualTo(Status.DOWN);
 	}
 
+	@Test
+	public void acceptEmptyFalseNoReposCustomizedDownStatus() {
+		ConfigServerProperties configServerProperties = new ConfigServerProperties();
+		configServerProperties.setAcceptEmpty(false);
+		this.indicator = new ConfigServerHealthIndicator(this.repository, configServerProperties);
+		ReflectionTestUtils.setField(this.indicator, "downHealthStatus", "CUSTOM");
+		when(this.repository.findOne("myname", "myprofile", "mylabel", false)).thenReturn(this.environment);
+		assertThat(this.indicator.health().getStatus()).as("wrong exception status").isEqualTo(new Status(("CUSTOM")));
+	}
+
 	@Test
 	public void acceptEmptyFalseNoPropertySources() {
 		Repository repo = new Repository();

spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/config/EnvironmentRepositoryConfigurationTests.java

@@ -82,6 +82,20 @@ public void customGitCredentialsProvider() {
 			});
 	}
 
+	@Test
+	public void configServerActuatorConfigurationWithDefaultSettings() {
+		new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(
+				EnvironmentRepositoryConfigurationTests.EnableConfigurationPropertiesBeans.class,
+				EnvironmentRepositoryConfiguration.ConfigServerActuatorConfiguration.class,
+				ConfigServerProperties.class))
+			.run((context) -> {
+				ConfigServerHealthIndicator healthIndicator = context.getBean(ConfigServerHealthIndicator.class);
+				assertThat(ReflectionTestUtils.getField(healthIndicator, "downHealthStatus")).isEqualTo("DOWN");
+				assertThat(ReflectionTestUtils.getField(healthIndicator, "acceptEmpty")).isEqualTo(true);
+			});
+	}
+
 	@Test
 	public void configServerActuatorConfigurationWithCustomHealthStatus() {
 		new ApplicationContextRunner()
@@ -96,6 +110,37 @@ public void configServerActuatorConfigurationWithCustomHealthStatus() {
 			});
 	}
 
+	@Test
+	public void configServerActuatorConfigurationWithServerAcceptEmptyFalse() {
+		new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(
+				EnvironmentRepositoryConfigurationTests.EnableConfigurationPropertiesBeans.class,
+				EnvironmentRepositoryConfiguration.ConfigServerActuatorConfiguration.class,
+				ConfigServerProperties.class))
+			.withPropertyValues("spring.cloud.config.server.accept-empty=false")
+			.run((context) -> {
+				ConfigServerHealthIndicator healthIndicator = context.getBean(ConfigServerHealthIndicator.class);
+				assertThat(ReflectionTestUtils.getField(healthIndicator, "acceptEmpty")).isEqualTo(false);
+			});
+	}
+
+	@Test
+	public void configServerActuatorConfigurationWithOverriddenAcceptEmptyTrue() {
+		new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(
+				EnvironmentRepositoryConfigurationTests.EnableConfigurationPropertiesBeans.class,
+				EnvironmentRepositoryConfiguration.ConfigServerActuatorConfiguration.class,
+				ConfigServerProperties.class))
+			.withPropertyValues(
+				"spring.cloud.config.server.accept-empty=false",
+				"spring.cloud.config.server.health.accept-empty=true"
+			)
+			.run((context) -> {
+				ConfigServerHealthIndicator healthIndicator = context.getBean(ConfigServerHealthIndicator.class);
+				assertThat(ReflectionTestUtils.getField(healthIndicator, "acceptEmpty")).isEqualTo(true);
+			});
+	}
+
 	@TestConfiguration
 	public static class TestBeans {