SpringCloud/spring-cloud-kubernetes
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix 1583 (#1584)

Browse Source 
Fixes #1583
This commit is contained in:
erabii
2024-03-08 23:42:48 +02:00
committed by GitHub
parent c82315afd1
commit 70bc54e019
19 changed files with 369 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientAutoConfiguration.java
View File

@@ -73,7 +73,7 @@ public class KubernetesClientAutoConfiguration {
@ConditionalOnMissingBean
public KubernetesClientPodUtils kubernetesPodUtils(CoreV1Api client,
KubernetesNamespaceProvider kubernetesNamespaceProvider) {
return new KubernetesClientPodUtils(client, kubernetesNamespaceProvider.getNamespace());
return new KubernetesClientPodUtils(client, kubernetesNamespaceProvider.getNamespace(), true);
}
}

2
spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientHealthIndicator.java
View File

@@ -41,7 +41,7 @@ public class KubernetesClientHealthIndicator extends AbstractKubernetesHealthInd
@Override
protected Map<String, Object> getDetails() {
V1Pod current = this.utils.currentPod().get();
V1Pod current = utils.currentPod().get();
if (current != null) {
Map<String, Object> details = CollectionUtils.newHashMap(8);
details.put(INSIDE, true);

2
spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientInfoContributor.java
View File

@@ -41,7 +41,7 @@ public class KubernetesClientInfoContributor extends AbstractKubernetesInfoContr
@Override
public Map<String, Object> getDetails() {
V1Pod current = this.utils.currentPod().get();
V1Pod current = utils.currentPod().get();
if (current != null) {
Map<String, Object> details = CollectionUtils.newHashMap(7);
details.put(INSIDE, true);

23
spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/KubernetesClientPodUtils.java
View File

@@ -58,6 +58,9 @@ public class KubernetesClientPodUtils implements PodUtils<V1Pod> {
private final String serviceHost;
private final boolean failFast;
@Deprecated(forRemoval = true)
public KubernetesClientPodUtils(CoreV1Api client, String namespace) {
if (client == null) {
throw new IllegalArgumentException("Must provide an instance of KubernetesClient");
@@ -68,6 +71,22 @@ public class KubernetesClientPodUtils implements PodUtils<V1Pod> {
this.serviceHost = EnvReader.getEnv(KUBERNETES_SERVICE_HOST);
this.current = LazilyInstantiate.using(this::internalGetPod);
this.namespace = namespace;
this.failFast = false;
}
// mainly needed for the health and info contributors, so that they report DOWN
// correctly
public KubernetesClientPodUtils(CoreV1Api client, String namespace, boolean failFast) {
if (client == null) {
throw new IllegalArgumentException("Must provide an instance of KubernetesClient");
}
this.client = client;
this.hostName = EnvReader.getEnv(HOSTNAME);
this.serviceHost = EnvReader.getEnv(KUBERNETES_SERVICE_HOST);
this.current = LazilyInstantiate.using(this::internalGetPod);
this.namespace = namespace;
this.failFast = failFast;
}
@Override
@@ -84,10 +103,14 @@ public class KubernetesClientPodUtils implements PodUtils<V1Pod> {
try {
if (isServiceHostEnvVarPresent() && isHostNameEnvVarPresent() && isServiceAccountFound()) {
LOG.debug("reading pod in namespace : " + namespace);
// The hostname of your pod is typically also its name.
return client.readNamespacedPod(hostName, namespace, null);
}
}
catch (Throwable t) {
if (failFast) {
throw new RuntimeException(t);
}
if (t instanceof ApiException apiException) {
LOG.warn("error reading pod, with error : " + apiException.getResponseBody());
}

3
spring-cloud-kubernetes-client-autoconfig/src/main/java/org/springframework/cloud/kubernetes/client/profile/KubernetesClientProfileEnvironmentPostProcessor.java
View File

@@ -33,7 +33,8 @@ public class KubernetesClientProfileEnvironmentPostProcessor extends AbstractKub
@Override
protected boolean isInsideKubernetes(Environment environment) {
CoreV1Api api = new CoreV1Api();
KubernetesClientPodUtils utils = new KubernetesClientPodUtils(api, environment.getProperty(NAMESPACE_PROPERTY));
KubernetesClientPodUtils utils = new KubernetesClientPodUtils(api, environment.getProperty(NAMESPACE_PROPERTY),
false);
return environment.containsProperty(ENV_SERVICE_HOST) || utils.isInsideKubernetes();
}

114
spring-cloud-kubernetes-client-autoconfig/src/test/java/org/springframework/cloud/kubernetes/client/ActuatorEnabledFailFastExceptionTest.java Normal file
View File

@@ -0,0 +1,114 @@
/*
* Copyright 2013-2024 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 java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.apis.CoreV1Api;
import io.kubernetes.client.util.Config;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.Status;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.cloud.kubernetes.client.example.App;
import org.springframework.cloud.kubernetes.commons.EnvReader;
import org.springframework.context.annotation.Bean;
/**
* @author wind57
*/
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
classes = { App.class, ActuatorEnabledFailFastExceptionTest.ActuatorConfig.class },
properties = { "management.endpoint.health.show-details=always",
"management.endpoint.health.show-components=always", "management.endpoints.web.exposure.include=health",
"spring.main.cloud-platform=KUBERNETES" })
class ActuatorEnabledFailFastExceptionTest {
private static final boolean FAIL_FAST = true;
private static MockedStatic<EnvReader> envReaderMockedStatic;
private static MockedStatic<Paths> pathsMockedStatic;
private static final CoreV1Api coreV1Api = Mockito.mock(CoreV1Api.class);
@Autowired
private KubernetesClientHealthIndicator healthIndicator;
@AfterEach
void afterEach() {
envReaderMockedStatic.close();
pathsMockedStatic.close();
}
@Test
void test() throws ApiException {
Health health = healthIndicator.getHealth(true);
Assertions.assertEquals(health.getStatus(), Status.DOWN);
Mockito.verify(coreV1Api).readNamespacedPod("host", "my-namespace", null);
}
private static void mocks() {
envReaderMockedStatic = Mockito.mockStatic(EnvReader.class);
pathsMockedStatic = Mockito.mockStatic(Paths.class);
envReaderMockedStatic.when(() -> EnvReader.getEnv(KubernetesClientPodUtils.KUBERNETES_SERVICE_HOST))
.thenReturn("k8s-host");
envReaderMockedStatic.when(() -> EnvReader.getEnv(KubernetesClientPodUtils.HOSTNAME)).thenReturn("host");
Path serviceAccountTokenPath = Mockito.mock(Path.class);
File serviceAccountTokenFile = Mockito.mock(File.class);
Mockito.when(serviceAccountTokenPath.toFile()).thenReturn(serviceAccountTokenFile);
Mockito.when(serviceAccountTokenFile.exists()).thenReturn(true);
pathsMockedStatic.when(() -> Paths.get(Config.SERVICEACCOUNT_TOKEN_PATH)).thenReturn(serviceAccountTokenPath);
Path serviceAccountCAPath = Mockito.mock(Path.class);
File serviceAccountCAFile = Mockito.mock(File.class);
Mockito.when(serviceAccountCAPath.toFile()).thenReturn(serviceAccountCAFile);
Mockito.when(serviceAccountCAFile.exists()).thenReturn(true);
pathsMockedStatic.when(() -> Paths.get(Config.SERVICEACCOUNT_CA_PATH)).thenReturn(serviceAccountCAPath);
}
@TestConfiguration
static class ActuatorConfig {
// will be created "instead" of
// KubernetesClientAutoConfiguration::kubernetesPodUtils
@Bean
KubernetesClientPodUtils kubernetesPodUtils() throws ApiException {
mocks();
Mockito.when(coreV1Api.readNamespacedPod("host", "my-namespace", null))
.thenThrow(new RuntimeException("just because"));
return new KubernetesClientPodUtils(coreV1Api, "my-namespace", FAIL_FAST);
}
}
}

117
spring-cloud-kubernetes-client-autoconfig/src/test/java/org/springframework/cloud/kubernetes/client/ActuatorEnabledNoFailFastExceptionTest.java Normal file
View File

@@ -0,0 +1,117 @@
/*
* Copyright 2013-2024 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 java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.apis.CoreV1Api;
import io.kubernetes.client.util.Config;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.Status;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.cloud.kubernetes.client.example.App;
import org.springframework.cloud.kubernetes.commons.EnvReader;
import org.springframework.context.annotation.Bean;
/**
* @author wind57
*/
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
classes = { App.class, ActuatorEnabledNoFailFastExceptionTest.ActuatorConfig.class },
properties = { "management.endpoint.health.show-details=always",
"management.endpoint.health.show-components=always", "management.endpoints.web.exposure.include=health",
"spring.main.cloud-platform=KUBERNETES" })
class ActuatorEnabledNoFailFastExceptionTest {
private static final boolean FAIL_FAST = false;
private static MockedStatic<EnvReader> envReaderMockedStatic;
private static MockedStatic<Paths> pathsMockedStatic;
private static final CoreV1Api coreV1Api = Mockito.mock(CoreV1Api.class);
@Autowired
private KubernetesClientHealthIndicator healthIndicator;
@AfterEach
void afterEach() {
envReaderMockedStatic.close();
pathsMockedStatic.close();
}
// without a fail-fast, we would not fail and actuator would return "UP"
// This is not a real case we have, it just makes sure
@Test
void test() throws ApiException {
Health health = healthIndicator.getHealth(true);
Assertions.assertEquals(health.getStatus(), Status.UP);
Mockito.verify(coreV1Api).readNamespacedPod("host", "my-namespace", null);
}
private static void mocks() {
envReaderMockedStatic = Mockito.mockStatic(EnvReader.class);
pathsMockedStatic = Mockito.mockStatic(Paths.class);
envReaderMockedStatic.when(() -> EnvReader.getEnv(KubernetesClientPodUtils.KUBERNETES_SERVICE_HOST))
.thenReturn("k8s-host");
envReaderMockedStatic.when(() -> EnvReader.getEnv(KubernetesClientPodUtils.HOSTNAME)).thenReturn("host");
Path serviceAccountTokenPath = Mockito.mock(Path.class);
File serviceAccountTokenFile = Mockito.mock(File.class);
Mockito.when(serviceAccountTokenPath.toFile()).thenReturn(serviceAccountTokenFile);
Mockito.when(serviceAccountTokenFile.exists()).thenReturn(true);
pathsMockedStatic.when(() -> Paths.get(Config.SERVICEACCOUNT_TOKEN_PATH)).thenReturn(serviceAccountTokenPath);
Path serviceAccountCAPath = Mockito.mock(Path.class);
File serviceAccountCAFile = Mockito.mock(File.class);
Mockito.when(serviceAccountCAPath.toFile()).thenReturn(serviceAccountCAFile);
Mockito.when(serviceAccountCAFile.exists()).thenReturn(true);
pathsMockedStatic.when(() -> Paths.get(Config.SERVICEACCOUNT_CA_PATH)).thenReturn(serviceAccountCAPath);
}
@TestConfiguration
static class ActuatorConfig {
// will be created "instead" of
// KubernetesClientAutoConfiguration::kubernetesPodUtils
@Bean
KubernetesClientPodUtils kubernetesPodUtils() throws ApiException {
mocks();
Mockito.when(coreV1Api.readNamespacedPod("host", "my-namespace", null))
.thenThrow(new RuntimeException("just because"));
return new KubernetesClientPodUtils(coreV1Api, "my-namespace", FAIL_FAST);
}
}
}

30
spring-cloud-kubernetes-client-autoconfig/src/test/java/org/springframework/cloud/kubernetes/client/KubernetesClientPodUtilsTests.java
View File

@@ -39,7 +39,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy;
/**
* @author wind57
*/
public class KubernetesClientPodUtilsTests {
class KubernetesClientPodUtilsTests {
private static final String KUBERNETES_SERVICE_HOST = KubernetesClientPodUtils.KUBERNETES_SERVICE_HOST;
@@ -70,73 +70,73 @@ public class KubernetesClientPodUtilsTests {
private MockedStatic<Paths> paths;
@BeforeEach
public void before() {
void before() {
envReader = Mockito.mockStatic(EnvReader.class);
paths = Mockito.mockStatic(Paths.class);
}
@AfterEach
public void after() {
void after() {
envReader.close();
paths.close();
}
@Test
public void constructorThrowsIllegalArgumentExceptionWhenKubeClientIsNull() {
assertThatThrownBy(() -> new KubernetesClientPodUtils(null, "namespace"))
void constructorThrowsIllegalArgumentExceptionWhenKubeClientIsNull() {
assertThatThrownBy(() -> new KubernetesClientPodUtils(null, "namespace", false))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("Must provide an instance of KubernetesClient");
}
@Test
public void serviceHostNotPresent() {
void serviceHostNotPresent() {
mockHost(null);
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace");
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace", false);
Supplier<V1Pod> sup = util.currentPod();
assertSupplierAndClient(sup, util);
}
@Test
public void hostNameNotPresent() {
void hostNameNotPresent() {
mockHost(HOST);
mockHostname(null);
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace");
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace", false);
Supplier<V1Pod> sup = util.currentPod();
assertSupplierAndClient(sup, util);
}
@Test
public void serviceAccountPathNotPresent() {
void serviceAccountPathNotPresent() {
mockTokenPath(false);
mockHostname(HOST);
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace");
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace", false);
Supplier<V1Pod> sup = util.currentPod();
assertSupplierAndClient(sup, util);
}
@Test
public void serviceAccountCertPathNotPresent() {
void serviceAccountCertPathNotPresent() {
mockTokenPath(true);
mockCertPath(false);
mockHostname(HOST);
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace");
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace", false);
Supplier<V1Pod> sup = util.currentPod();
assertSupplierAndClient(sup, util);
}
@Test
public void allPresent() throws ApiException {
void allPresent() throws ApiException {
mockTokenPath(true);
mockCertPath(true);
mockHost(HOST);
mockHostname(POD_HOSTNAME);
mockPodResult();
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace");
KubernetesClientPodUtils util = new KubernetesClientPodUtils(client, "namespace", false);
Supplier<V1Pod> sup = util.currentPod();
assertThat(sup.get()).isNotNull();
assertThat(util.isInsideKubernetes()).isTrue();