major changes in fabric8 discovery client (CAN ONLY GO IN THE NEXT MAJOR RELEASE)

.github/workflows/composites/build-integration-tests-project/action.yaml

@@ -3,6 +3,7 @@ description: build integration tests project without tests
 runs:
   using: "composite"
   steps:
+
     - name: build integration tests project without tests
       shell: bash
       run: |

spring-cloud-kubernetes-client-discovery/src/test/java/org/springframework/cloud/kubernetes/client/discovery/KubernetesDiscoveryClientUtilsTests.java

@@ -68,7 +68,7 @@ void testEmptyServiceLabelsFromProperties(CapturedOutput output) {
 	void testEmptyServiceLabelsFromService(CapturedOutput output) {
 		Map<String, String> propertiesLabels = Map.of("key", "value");
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60L,
-				true, "", Set.of(), propertiesLabels, "", null, 0, false);
+				true, "", Set.of(), propertiesLabels, "", null, 0, false, false);
 		V1Service service = new V1ServiceBuilder().withMetadata(new V1ObjectMeta().name("my-service")).build();
 
 		boolean result = matchesServiceLabels(service, properties);
@@ -89,7 +89,7 @@ void testOne(CapturedOutput output) {
 		Map<String, String> propertiesLabels = Map.of("a", "b");
 		Map<String, String> serviceLabels = Map.of("a", "b");
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60L,
-				true, "", Set.of(), propertiesLabels, "", null, 0, false);
+				true, "", Set.of(), propertiesLabels, "", null, 0, false, false);
 		V1Service service = new V1ServiceBuilder()
 			.withMetadata(new V1ObjectMeta().labels(serviceLabels).name("my-service"))
 			.build();
@@ -113,7 +113,7 @@ void testTwo(CapturedOutput output) {
 		Map<String, String> propertiesLabels = ordered(Map.of("a", "b", "c", "d"));
 		Map<String, String> serviceLabels = Map.of("a", "b");
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60L,
-				true, "", Set.of(), propertiesLabels, "", null, 0, false);
+				true, "", Set.of(), propertiesLabels, "", null, 0, false, false);
 		V1Service service = new V1ServiceBuilder()
 			.withMetadata(new V1ObjectMeta().labels(serviceLabels).name("my-service"))
 			.build();
@@ -137,7 +137,7 @@ void testThree(CapturedOutput output) {
 		Map<String, String> propertiesLabels = ordered(Map.of("a", "b", "c", "d"));
 		Map<String, String> serviceLabels = ordered(Map.of("a", "b", "c", "d"));
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60L,
-				true, "", Set.of(), propertiesLabels, "", null, 0, false);
+				true, "", Set.of(), propertiesLabels, "", null, 0, false, false);
 		V1Service service = new V1ServiceBuilder()
 			.withMetadata(new V1ObjectMeta().labels(serviceLabels).name("my-service"))
 			.build();
@@ -161,7 +161,7 @@ void testFour(CapturedOutput output) {
 		Map<String, String> propertiesLabels = Map.of("a", "b");
 		Map<String, String> serviceLabels = ordered(Map.of("a", "b", "c", "d"));
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60L,
-				true, "", Set.of(), propertiesLabels, "", null, 0, false);
+				true, "", Set.of(), propertiesLabels, "", null, 0, false, false);
 		V1Service service = new V1ServiceBuilder()
 			.withMetadata(new V1ObjectMeta().labels(serviceLabels).name("my-service"))
 			.build();

spring-cloud-kubernetes-client-discovery/src/test/java/org/springframework/cloud/kubernetes/client/discovery/KubernetesInformerDiscoveryClientTests.java

@@ -687,7 +687,7 @@ private static V1Endpoints endpointsMultiplePortsWithoutSupportedPortNames() {
 
 	private static KubernetesDiscoveryProperties properties(boolean allNamespaces, Map<String, String> labels) {
 		return new KubernetesDiscoveryProperties(false, allNamespaces, Set.of(), true, 60, false, null, Set.of(),
-				labels, null, KubernetesDiscoveryProperties.Metadata.DEFAULT, 0, true);
+				labels, null, KubernetesDiscoveryProperties.Metadata.DEFAULT, 0, true, false);
 	}
 
 }

spring-cloud-kubernetes-client-discovery/src/test/java/org/springframework/cloud/kubernetes/client/discovery/catalog/KubernetesClientCatalogWatchEndpointSlicesSupportTests.java

@@ -88,7 +88,7 @@ public void afterEach() {
 	void testEndpointSlicesEnabledButNotSupported() {
 		boolean useEndpointSlices = true;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60,
-				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices);
+				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices, false);
 
 		V1APIResourceList list = new V1APIResourceListBuilder().addToResources(new V1APIResource()).build();
 		stubFor(get("/apis/discovery.k8s.io/v1")
@@ -110,7 +110,7 @@ void testEndpointSlicesEnabledButNotSupported() {
 	void testEndpointSlicesEnabledButNotSupportedViaApiVersions() {
 		boolean useEndpointSlices = true;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60,
-				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices);
+				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices, false);
 
 		V1APIResourceList list = new V1APIResourceListBuilder()
 			.addToResources(new V1APIResourceBuilder().withName("not-the-one").build())
@@ -131,7 +131,7 @@ void testEndpointSlicesEnabledButNotSupportedViaApiVersions() {
 	void testEndpointsSupport() {
 		boolean useEndpointSlices = false;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60,
-				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices);
+				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices, false);
 		KubernetesCatalogWatch watch = new KubernetesCatalogWatch(null, apiClient, properties, NAMESPACE_PROVIDER);
 
 		Assertions.assertEquals(KubernetesEndpointsCatalogWatch.class, watch.stateGenerator().getClass());
@@ -145,7 +145,7 @@ void testEndpointsSupport() {
 	void testEndpointSlicesSupport() {
 		boolean useEndpointSlices = true;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60,
-				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices);
+				false, "", Set.of(), Map.of(), "", null, 0, useEndpointSlices, false);
 
 		V1APIResourceList list = new V1APIResourceListBuilder()
 			.addToResources(new V1APIResourceBuilder().withName("endpointslices").withKind(ENDPOINT_SLICE).build())

spring-cloud-kubernetes-client-discovery/src/test/java/org/springframework/cloud/kubernetes/client/discovery/catalog/KubernetesEndpointsAndEndpointSlicesTests.java

@@ -109,7 +109,7 @@ KubernetesCatalogWatch createWatcherInAllNamespacesWithLabels(Map<String, String
 
 		boolean allNamespaces = true;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, allNamespaces, namespaces,
-				true, 60, false, "", Set.of(), labels, "", null, 0, endpointSlices);
+				true, 60, false, "", Set.of(), labels, "", null, 0, endpointSlices, false);
 		KubernetesCatalogWatch watch = new KubernetesCatalogWatch(coreV1Api, apiClient, properties, NAMESPACE_PROVIDER);
 
 		if (endpointSlices) {
@@ -128,7 +128,7 @@ KubernetesCatalogWatch createWatcherInSpecificNamespacesWithLabels(Set<String> n
 
 		boolean allNamespaces = false;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, allNamespaces, namespaces,
-				true, 60, false, "", Set.of(), labels, "", null, 0, false);
+				true, 60, false, "", Set.of(), labels, "", null, 0, false, false);
 		KubernetesCatalogWatch watch = new KubernetesCatalogWatch(coreV1Api, apiClient, properties, NAMESPACE_PROVIDER);
 
 		if (endpointSlices) {
@@ -149,7 +149,7 @@ KubernetesCatalogWatch createWatcherInSpecificNamespaceWithLabels(String namespa
 
 		boolean allNamespaces = false;
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, allNamespaces, Set.of(),
-				true, 60, false, "", Set.of(), labels, "", null, 0, endpointSlices);
+				true, 60, false, "", Set.of(), labels, "", null, 0, endpointSlices, false);
 		KubernetesCatalogWatch watch = new KubernetesCatalogWatch(coreV1Api, apiClient, properties, NAMESPACE_PROVIDER);
 
 		if (endpointSlices) {

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesExternalNameServiceInstance.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2019-2023 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.commons.discovery;
+
+import java.net.URI;
+import java.util.Map;
+
+import org.springframework.cloud.client.ServiceInstance;
+
+/**
+ * Type of {@link org.springframework.cloud.client.ServiceInstance} when
+ * "spec.type=ExternalName".
+ *
+ * @author wind57
+ */
+public record KubernetesExternalNameServiceInstance(String serviceId, String host, String instanceId,
+		Map<String, String> metadata) implements ServiceInstance {
+
+	@Override
+	public String getServiceId() {
+		return serviceId;
+	}
+
+	@Override
+	public String getHost() {
+		return host;
+	}
+
+	@Override
+	public int getPort() {
+		return -1;
+	}
+
+	@Override
+	public boolean isSecure() {
+		return false;
+	}
+
+	@Override
+	public URI getUri() {
+		return URI.create(host);
+	}
+
+	@Override
+	public Map<String, String> getMetadata() {
+		return metadata;
+	}
+
+	public String getInstanceId() {
+		return instanceId;
+	}
+
+	public String type() {
+		return "ExternalName";
+	}
+
+}

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/ServicePortSecureResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2022 the original author or authors.
+ * Copyright 2013-2023 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.

spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesExternalNameServiceInstanceTests.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2013-2023 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.commons.discovery;
+
+import java.util.Map;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+/**
+ * @author wind57
+ */
+class KubernetesExternalNameServiceInstanceTests {
+
+	@Test
+	void testFields() {
+		KubernetesExternalNameServiceInstance instance = new KubernetesExternalNameServiceInstance("123", "spring.io",
+				"456", Map.of("a", "b"));
+		Assertions.assertEquals(instance.getInstanceId(), "456");
+		Assertions.assertEquals(instance.getServiceId(), "123");
+		Assertions.assertEquals(instance.getHost(), "spring.io");
+		Assertions.assertEquals(instance.getPort(), -1);
+		Assertions.assertEquals(instance.getMetadata(), Map.of("a", "b"));
+		Assertions.assertNull(instance.getScheme());
+		Assertions.assertEquals(instance.getUri().toASCIIString(), "spring.io");
+		Assertions.assertEquals(instance.type(), "ExternalName");
+	}
+
+}

spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/discovery/ServicePortSecureResolverTest.java

@@ -56,7 +56,7 @@ class ServicePortSecureResolverTest {
 	void testPortNumbersOnly() {
 		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of(), true, 60,
 				false, null, Set.of(443, 8443, 12345), Map.of(), null, KubernetesDiscoveryProperties.Metadata.DEFAULT,
-				0, true);
+				0, true, false);
 
 		ServicePortSecureResolver secureResolver = new ServicePortSecureResolver(properties);
 

spring-cloud-kubernetes-fabric8-discovery/src/main/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8CatalogWatchContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2023 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.

spring-cloud-kubernetes-fabric8-discovery/src/main/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8ConfigServerBootstrapper.java

@@ -61,8 +61,8 @@ public void initialize(BootstrapRegistry registry) {
 			if (!getDiscoveryEnabled(context)) {
 				return (id) -> Collections.emptyList();
 			}
-			if (context.isRegistered(KubernetesDiscoveryClient.class)) {
-				KubernetesDiscoveryClient client = context.get(KubernetesDiscoveryClient.class);
+			if (context.isRegistered(Fabric8KubernetesDiscoveryClient.class)) {
+				Fabric8KubernetesDiscoveryClient client = context.get(Fabric8KubernetesDiscoveryClient.class);
 				return client::getInstances;
 			}
 			else {
@@ -72,12 +72,11 @@ public void initialize(BootstrapRegistry registry) {
 					.kubernetesClientConfig(context.get(KubernetesClientProperties.class));
 				KubernetesClient kubernetesClient = fabric8AutoConfiguration.kubernetesClient(config);
 				KubernetesDiscoveryProperties discoveryProperties = context.get(KubernetesDiscoveryProperties.class);
-				KubernetesDiscoveryClient discoveryClient = new KubernetesDiscoveryClient(kubernetesClient,
-						discoveryProperties,
-						KubernetesClientServicesFunctionProvider.servicesFunction(discoveryProperties,
-								new KubernetesNamespaceProvider(propertyResolver
-									.get(KubernetesNamespaceProvider.NAMESPACE_PROPERTY, String.class, null))),
-						null, new ServicePortSecureResolver(discoveryProperties));
+				Fabric8KubernetesDiscoveryClient discoveryClient = new Fabric8KubernetesDiscoveryClient(
+						kubernetesClient, discoveryProperties, new ServicePortSecureResolver(discoveryProperties),
+						new KubernetesNamespaceProvider(propertyResolver
+							.get(KubernetesNamespaceProvider.NAMESPACE_PROPERTY, String.class, null)),
+						new Fabric8DiscoveryClientPredicateAutoConfiguration().predicate(discoveryProperties));
 				return discoveryClient::getInstances;
 			}
 		});

spring-cloud-kubernetes-fabric8-discovery/src/main/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8DiscoveryClientPredicateAutoConfiguration.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2023 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.fabric8.discovery;
+
+import java.util.Optional;
+import java.util.function.Predicate;
+
+import io.fabric8.kubernetes.api.model.Service;
+
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnCloudPlatform;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.cloud.CloudPlatform;
+import org.springframework.cloud.client.ConditionalOnDiscoveryEnabled;
+import org.springframework.cloud.kubernetes.commons.discovery.ConditionalOnBlockingOrReactiveDiscoveryEnabled;
+import org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryProperties;
+import org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryPropertiesAutoConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.expression.Expression;
+import org.springframework.expression.spel.standard.SpelExpressionParser;
+import org.springframework.expression.spel.support.SimpleEvaluationContext;
+
+/**
+ * @author wind57
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnDiscoveryEnabled
+@ConditionalOnBlockingOrReactiveDiscoveryEnabled
+@ConditionalOnCloudPlatform(CloudPlatform.KUBERNETES)
+@AutoConfigureAfter(KubernetesDiscoveryPropertiesAutoConfiguration.class)
+class Fabric8DiscoveryClientPredicateAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean
+	Predicate<Service> predicate(KubernetesDiscoveryProperties properties) {
+		SpelExpressionParser parser = new SpelExpressionParser();
+		SimpleEvaluationContext evaluationContext = SimpleEvaluationContext.forReadOnlyDataBinding()
+			.withInstanceMethods()
+			.build();
+
+		String spelExpression = properties.filter();
+		Predicate<Service> predicate;
+		if (spelExpression == null || spelExpression.isEmpty()) {
+			predicate = service -> true;
+		}
+		else {
+			Expression filterExpr = parser.parseExpression(spelExpression);
+			predicate = service -> {
+				Boolean include = filterExpr.getValue(evaluationContext, service, Boolean.class);
+				return Optional.ofNullable(include).orElse(false);
+			};
+		}
+		return predicate;
+	}
+
+}