backport 825 (#830)

* backport 825 * backport 825 : fix tests * backport 825 : fix checkstyle
2021-07-13 13:57:31 -04:00
parent b380f463a5
commit 231fc9f70c
6 changed files with 163 additions and 46 deletions
--- a/spring-cloud-kubernetes-client-autoconfig/pom.xml
+++ b/spring-cloud-kubernetes-client-autoconfig/pom.xml
@@ -48,6 +48,11 @@
 			<artifactId>spring-boot-starter-web</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-webflux</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.mockito</groupId>
 			<artifactId>mockito-inline</artifactId>
--- a/spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientActuatorConfiguration.java
+++ b/spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientActuatorConfiguration.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2013-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.kubernetes.client;
+
+import io.kubernetes.client.openapi.models.V1Pod;
+
+import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
+import org.springframework.boot.actuate.autoconfigure.info.ConditionalOnEnabledInfoContributor;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.cloud.kubernetes.commons.ConditionalOnKubernetesEnabled;
+import org.springframework.cloud.kubernetes.commons.PodUtils;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author wind57
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(HealthIndicator.class)
+@ConditionalOnKubernetesEnabled
+public class KubernetesClientActuatorConfiguration {
+
+	@Bean
+	@ConditionalOnEnabledHealthIndicator("kubernetes")
+	public KubernetesClientHealthIndicator kubernetesHealthIndicator(PodUtils<V1Pod> podUtils) {
+		return new KubernetesClientHealthIndicator(podUtils);
+	}
+
+	@Bean
+	@ConditionalOnEnabledInfoContributor("kubernetes")
+	public KubernetesClientInfoContributor kubernetesInfoContributor(PodUtils<V1Pod> podUtils) {
+		return new KubernetesClientInfoContributor(podUtils);
+	}
+
+}
--- a/spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientAutoConfiguration.java
+++ b/spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientAutoConfiguration.java
@@ -18,18 +18,12 @@ package org.springframework.cloud.kubernetes.client;

 import io.kubernetes.client.openapi.ApiClient;
 import io.kubernetes.client.openapi.apis.CoreV1Api;
-import io.kubernetes.client.openapi.models.V1Pod;

-import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
-import org.springframework.boot.actuate.autoconfigure.info.ConditionalOnEnabledInfoContributor;
-import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.cloud.kubernetes.commons.ConditionalOnKubernetesEnabled;
 import org.springframework.cloud.kubernetes.commons.KubernetesCommonsAutoConfiguration;
 import org.springframework.cloud.kubernetes.commons.KubernetesNamespaceProvider;
-import org.springframework.cloud.kubernetes.commons.PodUtils;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
@@ -71,22 +65,4 @@ public class KubernetesClientAutoConfiguration {
 		return new KubernetesClientPodUtils(client, kubernetesNamespaceProvider.getNamespace());
 	}

-	@Configuration(proxyBeanMethods = false)
-	@ConditionalOnClass(HealthIndicator.class)
-	protected static class KubernetesActuatorConfiguration {
-
-		@Bean
-		@ConditionalOnEnabledHealthIndicator("kubernetes")
-		public KubernetesClientHealthIndicator kubernetesHealthIndicator(PodUtils<V1Pod> podUtils) {
-			return new KubernetesClientHealthIndicator(podUtils);
-		}
-
-		@Bean
-		@ConditionalOnEnabledInfoContributor("kubernetes")
-		public KubernetesClientInfoContributor kubernetesInfoContributor(PodUtils<V1Pod> podUtils) {
-			return new KubernetesClientInfoContributor(podUtils);
-		}
-
-	}
-
 }
--- a/spring-cloud-kubernetes-client-autoconfig/src/main/resources/META-INF/spring.factories
+++ b/spring-cloud-kubernetes-client-autoconfig/src/main/resources/META-INF/spring.factories
@@ -1,5 +1,6 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.springframework.cloud.kubernetes.client.KubernetesClientAutoConfiguration
+org.springframework.cloud.kubernetes.client.KubernetesClientAutoConfiguration,\
+org.springframework.cloud.kubernetes.client.KubernetesClientActuatorConfiguration


 org.springframework.boot.env.EnvironmentPostProcessor=\
--- a/spring-cloud-kubernetes-client-autoconfig/src/test/java/org/springframework/cloud/kubernetes/client/KubernetesClientActuatorTests.java
+++ b/spring-cloud-kubernetes-client-autoconfig/src/test/java/org/springframework/cloud/kubernetes/client/KubernetesClientActuatorTests.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright 2013-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.kubernetes.client;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.actuate.health.ReactiveHealthContributorRegistry;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cloud.kubernetes.client.example.App;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+/**
+ * @author wind57
+ */
+public class KubernetesClientActuatorTests {
+
+	@Nested
+	@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = App.class, properties = {
+			"management.health.kubernetes.enabled=false", "management.endpoint.health.show-details=always",
+			"management.endpoint.health.show-components=always", "management.endpoints.web.exposure.include=health" })
+	public class DisabledHealthTest {
+
+		@Autowired
+		private ReactiveHealthContributorRegistry registry;
+
+		@Autowired
+		private WebTestClient webClient;
+
+		@Value("${local.server.port}")
+		private int port;
+
+		@Test
+		public void healthEndpointShouldContainKubernetes() {
+			this.webClient.get().uri("http://localhost:{port}/actuator/health", this.port)
+					.accept(MediaType.APPLICATION_JSON).exchange().expectStatus().isOk().expectBody(String.class)
+					.value(Matchers.not(Matchers.containsString("kubernetes")));
+
+			Assertions.assertNull(registry.getContributor("kubernetes"),
+					"reactive kubernetes contributor must NOT be present when 'management.health.kubernetes.enabled=false'");
+		}
+
+	}
+
+	@Nested
+	@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = App.class, properties = {
+			"management.health.kubernetes.enabled=true", "management.endpoint.health.show-details=always",
+			"management.endpoint.health.show-components=always", "management.endpoints.web.exposure.include=health" })
+	public class EnabledHealthTest {
+
+		@Autowired
+		private WebTestClient webClient;
+
+		@Autowired
+		private ReactiveHealthContributorRegistry registry;
+
+		@Value("${local.server.port}")
+		private int port;
+
+		@Test
+		public void healthEndpointShouldContainKubernetes() {
+			this.webClient.get().uri("http://localhost:{port}/actuator/health", this.port)
+					.accept(MediaType.APPLICATION_JSON).exchange().expectStatus().isOk().expectBody(String.class)
+					.value(Matchers.containsString("kubernetes"));
+
+			Assertions.assertNotNull(registry.getContributor("kubernetes"),
+					"reactive kubernetes contributor must be present when 'management.health.kubernetes.enabled=true'");
+		}
+
+	}
+
+}
--- a/spring-cloud-kubernetes-client-config/src/main/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientBootstrapConfiguration.java
+++ b/spring-cloud-kubernetes-client-config/src/main/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientBootstrapConfiguration.java
@@ -19,9 +19,10 @@ package org.springframework.cloud.kubernetes.client.config;
 import io.kubernetes.client.openapi.apis.CoreV1Api;

 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.cloud.kubernetes.client.KubernetesClientAutoConfiguration;
+import org.springframework.cloud.kubernetes.commons.ConditionalOnKubernetesConfigEnabled;
 import org.springframework.cloud.kubernetes.commons.ConditionalOnKubernetesEnabled;
+import org.springframework.cloud.kubernetes.commons.ConditionalOnKubernetesSecretsEnabled;
 import org.springframework.cloud.kubernetes.commons.KubernetesCommonsAutoConfiguration;
 import org.springframework.cloud.kubernetes.commons.KubernetesNamespaceProvider;
 import org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties;
@@ -37,29 +38,22 @@ import org.springframework.context.annotation.Import;
@Configuration(proxyBeanMethods = false)
@ConditionalOnKubernetesEnabled
@AutoConfigureAfter(KubernetesBootstrapConfiguration.class)
+@Import({ KubernetesCommonsAutoConfiguration.class, KubernetesClientAutoConfiguration.class })
 public class KubernetesClientBootstrapConfiguration {

-	@Configuration(proxyBeanMethods = false)
-	@Import({ KubernetesCommonsAutoConfiguration.class, KubernetesClientAutoConfiguration.class })
-	protected static class KubernetesPropertySourceConfiguration {
-
-		@Bean
-		@ConditionalOnProperty(name = "spring.cloud.kubernetes.config.enabled", matchIfMissing = true)
-		public KubernetesClientConfigMapPropertySourceLocator configMapPropertySourceLocator(
-				ConfigMapConfigProperties properties, CoreV1Api coreV1Api,
-				KubernetesNamespaceProvider kubernetesNamespaceProvider) {
-			return new KubernetesClientConfigMapPropertySourceLocator(coreV1Api, properties,
-					kubernetesNamespaceProvider);
-		}
-
-		@Bean
-		@ConditionalOnProperty(name = "spring.cloud.kubernetes.secrets.enabled", matchIfMissing = true)
-		public KubernetesClientSecretsPropertySourceLocator secretsPropertySourceLocator(
-				SecretsConfigProperties properties, CoreV1Api coreV1Api,
-				KubernetesNamespaceProvider kubernetesNamespaceProvider) {
-			return new KubernetesClientSecretsPropertySourceLocator(coreV1Api, kubernetesNamespaceProvider, properties);
-		}
+	@Bean
+	@ConditionalOnKubernetesConfigEnabled
+	public KubernetesClientConfigMapPropertySourceLocator configMapPropertySourceLocator(
+			ConfigMapConfigProperties properties, CoreV1Api coreV1Api,
+			KubernetesNamespaceProvider kubernetesNamespaceProvider) {
+		return new KubernetesClientConfigMapPropertySourceLocator(coreV1Api, properties, kubernetesNamespaceProvider);
+	}

+	@Bean
+	@ConditionalOnKubernetesSecretsEnabled
+	public KubernetesClientSecretsPropertySourceLocator secretsPropertySourceLocator(SecretsConfigProperties properties,
+			CoreV1Api coreV1Api, KubernetesNamespaceProvider kubernetesNamespaceProvider) {
+		return new KubernetesClientSecretsPropertySourceLocator(coreV1Api, kubernetesNamespaceProvider, properties);
 	}

 }