Added the instance id to the KubernetesServiceInstance (spring-cloud#279)

* Added the instance id to the `KubernetesServiceInstance`

* Added integration test to verify that the instanceId is not empty

* Fixed wrong import order

* Fixed wrong service name in IT

* Changed assertions since we want to verify the list of service instances

* Updated assertion to validate a collection instead of an array

* Use URI.create() instead of try-catch

Author: TYsewyn

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

@@ -149,9 +149,13 @@ public List<ServiceInstance> getInstances(String serviceId) {
 
 				List<EndpointAddress> addresses = s.getAddresses();
 				for (EndpointAddress endpointAddress : addresses) {
+					String instanceId = null;
+					if (endpointAddress.getTargetRef() != null) {
+						instanceId = endpointAddress.getTargetRef().getUid();
+					}
 					final EndpointPort endpointPort = s.getPorts().stream().findFirst()
 							.orElseThrow(IllegalStateException::new);
-					instances.add(new KubernetesServiceInstance(serviceId,
+					instances.add(new KubernetesServiceInstance(instanceId, serviceId,
 							endpointAddress, endpointPort, endpointMetadata,
 							this.isServicePortSecureResolver
 									.resolve(new DefaultIsServicePortSecureResolver.Input(

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

@@ -17,7 +17,6 @@
 package org.springframework.cloud.kubernetes.discovery;
 
 import java.net.URI;
-import java.net.URISyntaxException;
 import java.util.Map;
 
 import io.fabric8.kubernetes.api.model.EndpointAddress;
@@ -38,6 +37,8 @@ public class KubernetesServiceInstance implements ServiceInstance {
 
 	private static final String COLN = ":";
 
+	private final String instanceId;
+
 	private final String serviceId;
 
 	private final EndpointAddress endpointAddress;
@@ -48,15 +49,36 @@ public class KubernetesServiceInstance implements ServiceInstance {
 
 	private final Map<String, String> metadata;
 
+	/**
+	 * @param serviceId the id of the service.
+	 * @param endpointAddress the address where the service instance can be found.
+	 * @param endpointPort the port on which the service is running.
+	 * @param metadata a map containing metadata.
+	 * @param secure indicates whether or not the connection needs to be secure.
+	 * @deprecated - use other constructor
+	 */
+	@Deprecated
 	public KubernetesServiceInstance(String serviceId, EndpointAddress endpointAddress,
 			EndpointPort endpointPort, Map<String, String> metadata, Boolean secure) {
+		this(null, serviceId, endpointAddress, endpointPort, metadata, secure);
+	}
+
+	public KubernetesServiceInstance(String instanceId, String serviceId,
+			EndpointAddress endpointAddress, EndpointPort endpointPort,
+			Map<String, String> metadata, Boolean secure) {
+		this.instanceId = instanceId;
 		this.serviceId = serviceId;
 		this.endpointAddress = endpointAddress;
 		this.endpointPort = endpointPort;
 		this.metadata = metadata;
 		this.secure = secure;
 	}
 
+	@Override
+	public String getInstanceId() {
+		return this.instanceId;
+	}
+
 	@Override
 	public String getServiceId() {
 		return this.serviceId;
@@ -80,25 +102,17 @@ public boolean isSecure() {
 	@Override
 	public URI getUri() {
 		StringBuilder sb = new StringBuilder();
-
-		if (isSecure()) {
-			sb.append(HTTPS_PREFIX);
-		}
-		else {
-			sb.append(HTTP_PREFIX);
-		}
-
-		sb.append(getHost()).append(COLN).append(getPort());
-		try {
-			return new URI(sb.toString());
-		}
-		catch (URISyntaxException e) {
-			throw new RuntimeException(e);
-		}
+		sb.append(getScheme()).append(getHost()).append(COLN).append(getPort());
+		return URI.create(sb.toString());
 	}
 
 	public Map<String, String> getMetadata() {
 		return this.metadata;
 	}
 
+	@Override
+	public String getScheme() {
+		return isSecure() ? HTTPS_PREFIX : HTTP_PREFIX;
+	}
+
 }

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

@@ -60,7 +60,8 @@ public void getInstancesShouldBeAbleToHandleEndpointsSingleAddress() {
 				.andReturn(200,
 						new EndpointsBuilder().withNewMetadata().withName("endpoint")
 								.endMetadata().addNewSubset().addNewAddress()
-								.withIp("ip1").endAddress().addNewPort("http", 80, "TCP")
+								.withIp("ip1").withNewTargetRef().withUid("uid").endTargetRef().endAddress()
+								.addNewPort("http", 80, "TCP")
 								.endSubset().build())
 				.once();
 
@@ -81,7 +82,8 @@ public void getInstancesShouldBeAbleToHandleEndpointsSingleAddress() {
 		final List<ServiceInstance> instances = discoveryClient.getInstances("endpoint");
 
 		assertThat(instances).hasSize(1)
-				.filteredOn(s -> s.getHost().equals("ip1") && !s.isSecure()).hasSize(1);
+				.filteredOn(s -> s.getHost().equals("ip1") && !s.isSecure()).hasSize(1)
+				.filteredOn(s -> s.getInstanceId().equals("uid")).hasSize(1);
 	}
 
 	@Test

spring-cloud-kubernetes-integration-tests/discovery/discovery-client/src/main/java/org/springframework/cloud/kubernetes/it/DiscoveryClientApplication.java

@@ -21,8 +21,10 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.ServiceInstance;
 import org.springframework.cloud.client.discovery.DiscoveryClient;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
 
 @SpringBootApplication
@@ -41,4 +43,9 @@ public List<String> services() {
 		return this.discoveryClient.getServices();
 	}
 
+	@GetMapping("/services/{service}/instances")
+	public List<ServiceInstance> instances(@PathVariable("service") String service) {
+		return this.discoveryClient.getInstances(service);
+	}
+
 }

spring-cloud-kubernetes-integration-tests/discovery/tests/src/test/java/org/springframework/cloud/kubernetes/it/ServicesIT.java

@@ -23,6 +23,8 @@
 import org.junit.runner.RunWith;
 
 import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.hasItems;
+import static org.hamcrest.Matchers.hasSize;
 
 @RequiresKubernetes
 @RunWith(Arquillian.class)
@@ -44,4 +46,12 @@ protected boolean evalSubstringOf(String s) {
 				});
 	}
 
+	@Test
+	public void testInstancesEndpoint() {
+		given().baseUri(String.format("http://%s:%d", HOST, PORT))
+				.get("services/discovery-service-a/instances").then().statusCode(200)
+				.body("instanceId", hasSize(1))
+				.body("serviceId", hasItems("discovery-service-a"));
+	}
+
 }