fabric8

Signed-off-by: wind57 <[email protected]>

Author: wind57

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

@@ -18,6 +18,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
@@ -72,13 +73,21 @@ else if (!context.properties().namespaces().isEmpty()) {
 			endpointSlices = endpointSlices(context, namespace, client);
 		}
 
+		return state(endpointSlices);
+	}
+
+	/**
+	 * This one is visible for testing, especially since fabric8 mock client will save
+	 * null subsets as empty lists, thus blocking some unit test.
+	 */
+	List<EndpointNameAndNamespace> state(List<EndpointSlice> endpointSlices) {
 		Stream<ObjectReference> references = endpointSlices.stream()
 			.map(EndpointSlice::getEndpoints)
+			.filter(Objects::nonNull)
 			.flatMap(List::stream)
 			.map(Endpoint::getTargetRef);
 
 		return Fabric8CatalogWatchContext.state(references);
-
 	}
 
 	private List<EndpointSlice> endpointSlices(Fabric8CatalogWatchContext context, String namespace,

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

@@ -44,16 +44,23 @@ public List<EndpointNameAndNamespace> apply(Fabric8CatalogWatchContext context)
 		List<Endpoints> endpoints = endpoints(context.properties(), context.kubernetesClient(),
 				context.namespaceProvider(), "catalog-watcher", null, ALWAYS_TRUE);
 
-		/**
-		 * <pre>
-		 *   - An "Endpoints" holds a List of EndpointSubset.
-		 *   - A single EndpointSubset holds a List of EndpointAddress
-		 *
-		 *   - (The union of all EndpointSubsets is the Set of all Endpoints)
-		 *   - Set of Endpoints is the cartesian product of :
-		 *     EndpointSubset::getAddresses and EndpointSubset::getPorts (each is a List)
-		 * </pre>
-		 */
+		return state(endpoints);
+	}
+
+	/**
+	 * This one is visible for testing, especially since fabric8 mock client will save
+	 * null subsets as empty lists, thus blocking some unit test.
+	 *
+	 * <pre>
+	 *   - An "Endpoints" holds a List of EndpointSubset.
+	 *   - A single EndpointSubset holds a List of EndpointAddress
+	 *
+	 *   - (The union of all EndpointSubsets is the Set of all Endpoints)
+	 *   - Set of Endpoints is the cartesian product of :
+	 *     EndpointSubset::getAddresses and EndpointSubset::getPorts (each is a List)
+	 * </pre>
+	 */
+	List<EndpointNameAndNamespace> state(List<Endpoints> endpoints) {
 		Stream<ObjectReference> references = endpoints.stream()
 			.map(Endpoints::getSubsets)
 			.filter(Objects::nonNull)

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8EndpointSliceV1CatalogWatchTests.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2013-2025 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.List;
+import java.util.Map;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.fabric8.kubernetes.api.model.discovery.v1.Endpoint;
+import io.fabric8.kubernetes.api.model.discovery.v1.EndpointSlice;
+import io.fabric8.kubernetes.api.model.discovery.v1.EndpointSliceBuilder;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author wind57
+ */
+class Fabric8EndpointSliceV1CatalogWatchTests {
+
+	private final Fabric8EndpointSliceV1CatalogWatch catalogWatch = new Fabric8EndpointSliceV1CatalogWatch();
+
+	@Test
+	void stateEndpointsWithoutSubsets() {
+
+		List<Endpoint> endpoints = null;
+
+		EndpointSlice slice = new EndpointSliceBuilder()
+			.withMetadata(new ObjectMetaBuilder().withNamespace("default")
+				.withName("slice-no-endpoints")
+				.withLabels(Map.of())
+				.build())
+			.withEndpoints(endpoints)
+			.build();
+
+		// even if Endpoints are missing, we do not fail
+		assertThat(catalogWatch.state(List.of(slice))).isEmpty();
+	}
+
+}

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8EndpointsAndEndpointSlicesTests.java

@@ -235,6 +235,16 @@ void afterEach() {
 	 */
 	abstract void testTwoNamespacesOutOfThree();
 
+	/**
+	 * <pre>
+	 *      - in the old API (plain Endpoints), tests that subsets are missing
+	 *        and we do not fail.
+	 *      - in the new API (EndpointSlices), tests that Endpoints are missing
+	 *        and we do not fail.
+	 * </pre>
+	 */
+	abstract void testWithoutSubsetsOrEndpoints();
+
 	KubernetesCatalogWatch createWatcherInAllNamespacesWithLabels(Map<String, String> labels, Set<String> namespaces,
 			boolean endpointSlices) {
 
@@ -309,6 +319,20 @@ void endpoints(String namespace, Map<String, String> labels, String podName) {
 		mockClient().endpoints().inNamespace(namespace).resource(endpoints).create();
 	}
 
+	void endpointsWithoutSubsets(String namespace, Map<String, String> labels, String podName) {
+
+		// though we set it to null here, the mock client when creating it
+		// will set it to an empty list. I will keep it like this, may be client changes
+		// in the future and we have the case still covered by a test
+		List<EndpointSubset> endpointSubsets = null;
+
+		Endpoints endpoints = new EndpointsBuilder()
+			.withMetadata(new ObjectMetaBuilder().withLabels(labels).withName("endpoints-" + podName).build())
+			.withSubsets(endpointSubsets)
+			.build();
+		mockClient().endpoints().inNamespace(namespace).resource(endpoints).create();
+	}
+
 	void service(String namespace, Map<String, String> labels, String podName) {
 
 		Service service = new ServiceBuilder()
@@ -335,6 +359,22 @@ static void endpointSlice(String namespace, Map<String, String> labels, String p
 
 	}
 
+	static void endpointSliceWithoutEndpoints(String namespace, Map<String, String> labels, String podName) {
+
+		List<Endpoint> endpoints = null;
+
+		EndpointSlice slice = new EndpointSliceBuilder()
+			.withMetadata(new ObjectMetaBuilder().withNamespace(namespace)
+				.withName("slice-" + podName)
+				.withLabels(labels)
+				.build())
+			.withEndpoints(endpoints)
+			.build();
+
+		mockClient().discovery().v1().endpointSlices().inNamespace(namespace).resource(slice).create();
+
+	}
+
 	static void invokeAndAssert(KubernetesCatalogWatch watch, List<EndpointNameAndNamespace> state) {
 		watch.catalogServicesWatch();
 

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8EndpointsCatalogWatchTests.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2013-2025 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.List;
+import java.util.Map;
+
+import io.fabric8.kubernetes.api.model.EndpointSubset;
+import io.fabric8.kubernetes.api.model.Endpoints;
+import io.fabric8.kubernetes.api.model.EndpointsBuilder;
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.cloud.kubernetes.commons.discovery.EndpointNameAndNamespace;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author wind57
+ */
+class Fabric8EndpointsCatalogWatchTests {
+
+	private final Fabric8EndpointsCatalogWatch catalogWatch = new Fabric8EndpointsCatalogWatch();
+
+	@Test
+	void stateEndpointsWithoutSubsets() {
+
+		// though we set it to null here, the mock client when creating it
+		// will set it to an empty list. I will keep it like this, may be client changes
+		// in the future and we have the case still covered by a test
+		List<EndpointSubset> endpointSubsets = null;
+
+		Endpoints endpoints = new EndpointsBuilder()
+			.withMetadata(new ObjectMetaBuilder().withLabels(Map.of()).withName("endpoints-no-subsets").build())
+			.withSubsets(endpointSubsets)
+			.build();
+
+		// we do not fail, even if Subsets are not present
+		List<EndpointNameAndNamespace> result = catalogWatch.state(List.of(endpoints));
+		assertThat(result).isEmpty();
+	}
+
+}

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8KubernetesCatalogWatchEndpointSlicesTests.java

@@ -178,6 +178,18 @@ void testTwoNamespacesOutOfThree() {
 						new EndpointNameAndNamespace("podF", "namespaceB")));
 	}
 
+	@Test
+	@Override
+	void testWithoutSubsetsOrEndpoints() {
+		KubernetesCatalogWatch watch = createWatcherInSpecificNamespacesWithLabels(Set.of("namespaceA"),
+				Map.of("color", "blue"), ENDPOINT_SLICES);
+
+		endpointSliceWithoutEndpoints("namespaceA", Map.of("color", "blue"), "podA");
+
+		// we do not fail here, even if Endpoints are not present.
+		invokeAndAssert(watch, List.of());
+	}
+
 	// work-around for : https://github.com/fabric8io/kubernetes-client/issues/4649
 	static KubernetesClient endpointSlicesMockClient() {
 		return mockClient;

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/Fabric8KubernetesCatalogWatchEndpointsTests.java

@@ -235,6 +235,17 @@ void testTwoNamespacesOutOfThree() {
 						new EndpointNameAndNamespace("podF", "namespaceB")));
 	}
 
+	@Test
+	@Override
+	void testWithoutSubsetsOrEndpoints() {
+		KubernetesCatalogWatch watch = createWatcherInSpecificNamespacesWithLabels(Set.of("namespaceA"),
+				Map.of("color", "blue"), ENDPOINT_SLICES);
+
+		endpointsWithoutSubsets("namespaceA", Map.of("color", "blue"), "podA");
+		// we do not fail here, even if Subsets are not present
+		invokeAndAssert(watch, List.of());
+	}
+
 	// work-around for : https://github.com/fabric8io/kubernetes-client/issues/4649
 	static KubernetesClient endpointsMockClient() {
 		return mockClient;