Compare commits

...

3 Commits

Author SHA1 Message Date
Olga Maciaszek-Sharma e2a1b819c6 Adjust after review. 2 years ago
Olga Maciaszek-Sharma 1122e66246 Merge remote-tracking branch 'origin/main' into allow-overriding-getScheme 2 years ago
Olga Maciaszek-Sharma 739997d596 Allow overriding getScheme on DefaultServiceInstance. 2 years ago
  1. 48
      spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java
  2. 6
      spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryProperties.java
  3. 11
      spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientPropertiesMappingTests.java
  4. 13
      spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientTests.java
  5. 2
      spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/core/HealthCheckServiceInstanceListSupplierTests.java

48
spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2020 the original author or authors. * Copyright 2012-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -18,6 +18,7 @@ package org.springframework.cloud.client;
import java.net.URI; import java.net.URI;
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Objects; import java.util.Objects;
@ -28,15 +29,20 @@ import java.util.Objects;
* @author Tim Ysewyn * @author Tim Ysewyn
* @author Charu Covindane * @author Charu Covindane
* @author Neil Powell * @author Neil Powell
* @author Olga Maciaszek-Sharma
*/ */
public class DefaultServiceInstance implements ServiceInstance { public class DefaultServiceInstance implements ServiceInstance {
private final List<String> secureSchemes = List.of("https", "wss");
private String instanceId; private String instanceId;
private String serviceId; private String serviceId;
private String host; private String host;
private String scheme;
private int port; private int port;
private boolean secure; private boolean secure;
@ -45,6 +51,7 @@ public class DefaultServiceInstance implements ServiceInstance {
private URI uri; private URI uri;
/** /**
* @param instanceId the id of the instance. * @param instanceId the id of the instance.
* @param serviceId the id of the service. * @param serviceId the id of the service.
@ -55,12 +62,27 @@ public class DefaultServiceInstance implements ServiceInstance {
*/ */
public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure, public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure,
Map<String, String> metadata) { Map<String, String> metadata) {
this(instanceId, serviceId, host, port, secure, metadata, secure ? "https" : "http");
}
/**
* @param instanceId the id of the instance.
* @param serviceId the id of the service.
* @param host the host where the service instance can be found.
* @param port the port on which the service is running.
* @param secure indicates whether or not the connection needs to be secure.
* @param metadata a map containing metadata.
* @param scheme the protocol used to connect to the service instance.
*/
public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure,
Map<String, String> metadata, String scheme) {
this.instanceId = instanceId; this.instanceId = instanceId;
this.serviceId = serviceId; this.serviceId = serviceId;
this.host = host; this.host = host;
this.port = port; this.port = port;
this.secure = secure; this.secure = secure;
this.metadata = metadata; this.metadata = metadata;
this.scheme = scheme;
} }
/** /**
@ -77,6 +99,19 @@ public class DefaultServiceInstance implements ServiceInstance {
public DefaultServiceInstance() { public DefaultServiceInstance() {
} }
/**
* @param instanceId the id of the instance.
* @param serviceId the id of the service.
* @param host the host where the service instance can be found.
* @param port the port on which the service is running.
* @param secure indicates whether or not the connection needs to be secure.
* @param scheme the protocol used to connect to the service instance.
*/
public DefaultServiceInstance(String instanceId, String serviceId, String host, int port, boolean secure,
String scheme) {
this(instanceId, serviceId, host, port, secure, new LinkedHashMap<>(), scheme);
}
/** /**
* Creates a URI from the given ServiceInstance's host:port. * Creates a URI from the given ServiceInstance's host:port.
* @param instance the ServiceInstance. * @param instance the ServiceInstance.
@ -84,7 +119,7 @@ public class DefaultServiceInstance implements ServiceInstance {
* if port not set. * if port not set.
*/ */
public static URI getUri(ServiceInstance instance) { public static URI getUri(ServiceInstance instance) {
String scheme = (instance.isSecure()) ? "https" : "http"; String scheme = instance.getScheme();
int port = instance.getPort(); int port = instance.getPort();
if (port <= 0) { if (port <= 0) {
port = (instance.isSecure()) ? 443 : 80; port = (instance.isSecure()) ? 443 : 80;
@ -148,8 +183,8 @@ public class DefaultServiceInstance implements ServiceInstance {
this.uri = uri; this.uri = uri;
this.host = this.uri.getHost(); this.host = this.uri.getHost();
this.port = this.uri.getPort(); this.port = this.uri.getPort();
String scheme = this.uri.getScheme(); scheme = this.uri.getScheme();
if ("https".equals(scheme)) { if (secureSchemes.contains(scheme)) {
this.secure = true; this.secure = true;
} }
} }
@ -179,4 +214,9 @@ public class DefaultServiceInstance implements ServiceInstance {
return Objects.hash(instanceId, serviceId, host, port, secure, metadata); return Objects.hash(instanceId, serviceId, host, port, secure, metadata);
} }
@Override
public String getScheme() {
return scheme;
}
} }

6
spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryProperties.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2020 the original author or authors. * Copyright 2012-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -87,4 +87,8 @@ public class SimpleDiscoveryProperties implements InitializingBean {
local = new DefaultServiceInstance(null, serviceId, host, port, false); local = new DefaultServiceInstance(null, serviceId, host, port, false);
} }
public void setInstance(String serviceId, String host, int port, String scheme) {
local = new DefaultServiceInstance(null, serviceId, host, port, false, scheme);
}
} }

11
spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientPropertiesMappingTests.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2020 the original author or authors. * Copyright 2012-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -32,6 +32,7 @@ import static org.assertj.core.api.BDDAssertions.then;
* Tests for mapping properties to instances in {@link SimpleDiscoveryClient}. * Tests for mapping properties to instances in {@link SimpleDiscoveryClient}.
* *
* @author Biju Kunjummen * @author Biju Kunjummen
* @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(properties = { "spring.application.name=service0", @SpringBootTest(properties = { "spring.application.name=service0",
@ -73,6 +74,14 @@ public class SimpleDiscoveryClientPropertiesMappingTests {
then(s1.getPort()).isEqualTo(8080); then(s1.getPort()).isEqualTo(8080);
then(s1.getUri()).isEqualTo(URI.create("http://s11:8080")); then(s1.getUri()).isEqualTo(URI.create("http://s11:8080"));
then(s1.isSecure()).isEqualTo(false); then(s1.isSecure()).isEqualTo(false);
then(s1.getScheme()).isEqualTo("http");
ServiceInstance s2 = this.discoveryClient.getInstances("service1").get(1);
then(s2.getHost()).isEqualTo("s12");
then(s2.getPort()).isEqualTo(8443);
then(s2.getUri()).isEqualTo(URI.create("https://s12:8443"));
then(s2.isSecure()).isEqualTo(true);
then(s2.getScheme()).isEqualTo("https");
} }
@Test @Test

13
spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientTests.java

@ -34,6 +34,7 @@ import static org.assertj.core.api.BDDAssertions.then;
* @author Biju Kunjummen * @author Biju Kunjummen
* @author Charu Covindane * @author Charu Covindane
* @author Neil Powell * @author Neil Powell
* @author Olga Maciaszek-Sharma
*/ */
public class SimpleDiscoveryClientTests { public class SimpleDiscoveryClientTests {
@ -47,7 +48,8 @@ public class SimpleDiscoveryClientTests {
DefaultServiceInstance service1Inst1 = new DefaultServiceInstance(null, null, "host1", 8080, false); DefaultServiceInstance service1Inst1 = new DefaultServiceInstance(null, null, "host1", 8080, false);
DefaultServiceInstance service1Inst2 = new DefaultServiceInstance(null, null, "host2", 0, true); DefaultServiceInstance service1Inst2 = new DefaultServiceInstance(null, null, "host2", 0, true);
DefaultServiceInstance service1Inst3 = new DefaultServiceInstance(null, null, "host3", 0, false); DefaultServiceInstance service1Inst3 = new DefaultServiceInstance(null, null, "host3", 0, false);
map.put("service1", Arrays.asList(service1Inst1, service1Inst2, service1Inst3)); DefaultServiceInstance service1Inst4 = new DefaultServiceInstance(null, null, "host4", 8443, true);
map.put("service1", Arrays.asList(service1Inst1, service1Inst2, service1Inst3, service1Inst4));
simpleDiscoveryProperties.setInstances(map); simpleDiscoveryProperties.setInstances(map);
simpleDiscoveryProperties.afterPropertiesSet(); simpleDiscoveryProperties.afterPropertiesSet();
this.simpleDiscoveryClient = new SimpleDiscoveryClient(simpleDiscoveryProperties); this.simpleDiscoveryClient = new SimpleDiscoveryClient(simpleDiscoveryProperties);
@ -56,7 +58,7 @@ public class SimpleDiscoveryClientTests {
@Test @Test
public void shouldBeAbleToRetrieveServiceDetailsByName() { public void shouldBeAbleToRetrieveServiceDetailsByName() {
List<ServiceInstance> instances = this.simpleDiscoveryClient.getInstances("service1"); List<ServiceInstance> instances = this.simpleDiscoveryClient.getInstances("service1");
then(instances.size()).isEqualTo(3); then(instances.size()).isEqualTo(4);
then(instances.get(0).getServiceId()).isEqualTo("service1"); then(instances.get(0).getServiceId()).isEqualTo("service1");
then(instances.get(0).getHost()).isEqualTo("host1"); then(instances.get(0).getHost()).isEqualTo("host1");
then(instances.get(0).getPort()).isEqualTo(8080); then(instances.get(0).getPort()).isEqualTo(8080);
@ -77,6 +79,13 @@ public class SimpleDiscoveryClientTests {
then(instances.get(2).getUri()).isEqualTo(URI.create("http://host3:80")); then(instances.get(2).getUri()).isEqualTo(URI.create("http://host3:80"));
then(instances.get(2).isSecure()).isEqualTo(false); then(instances.get(2).isSecure()).isEqualTo(false);
then(instances.get(2).getMetadata()).isNotNull(); then(instances.get(2).getMetadata()).isNotNull();
then(instances.get(3).getServiceId()).isEqualTo("service1");
then(instances.get(3).getHost()).isEqualTo("host4");
then(instances.get(3).getPort()).isEqualTo(8443);
then(instances.get(3).getUri()).isEqualTo(URI.create("https://host4:8443"));
then(instances.get(3).isSecure()).isEqualTo(true);
then(instances.get(3).getMetadata()).isNotNull();
} }
} }

2
spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/core/HealthCheckServiceInstanceListSupplierTests.java

@ -156,7 +156,7 @@ class HealthCheckServiceInstanceListSupplierTests {
String serviceId = "ignored-service"; String serviceId = "ignored-service";
properties.getHealthCheck().getPath().put("ignored-service", "/health"); properties.getHealthCheck().getPath().put("ignored-service", "/health");
ServiceInstance serviceInstance = new DefaultServiceInstance("ignored-service-1", serviceId, "127.0.0.1", port, ServiceInstance serviceInstance = new DefaultServiceInstance("ignored-service-1", serviceId, "127.0.0.1", port,
false); false, "http");
listSupplier = new HealthCheckServiceInstanceListSupplier( listSupplier = new HealthCheckServiceInstanceListSupplier(
ServiceInstanceListSuppliers.from(serviceId, serviceInstance), ServiceInstanceListSuppliers.from(serviceId, serviceInstance),
buildLoadBalancerClientFactory(serviceId, properties), healthCheckFunction(restTemplate)); buildLoadBalancerClientFactory(serviceId, properties), healthCheckFunction(restTemplate));

Loading…
Cancel
Save