Skip to content

Commit

Permalink
Migrates service-registry tests to JUnit5 (#391)
Browse files Browse the repository at this point in the history
  • Loading branch information
kvmw authored Dec 21, 2023
1 parent b76b6c1 commit 3cb0846
Show file tree
Hide file tree
Showing 10 changed files with 272 additions and 310 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ public void setEnvironment(Environment environment) {
super.setEnvironment(environment);
// set some defaults from the environment, but allow the defaults to use
// relaxed binding
String springAppName = getSpringApplicationName();
String eurekaInstanceAppname = getEurekaInstanceAppnameProperty();
var springAppName = getSpringApplicationName();
var eurekaInstanceAppname = getEurekaInstanceAppnameProperty();
if (StringUtils.hasText(eurekaInstanceAppname)) {
// default to eureka.instance.appname if defined
setVirtualHostName(eurekaInstanceAppname);
setSecureVirtualHostName(eurekaInstanceAppname);
}
else if (StringUtils.hasText(springAppName)) {
// default to a hostname-sanitized spring application name
String sanitizedAppName = sanitizeHostname(springAppName);
var sanitizedAppName = sanitizeHostname(springAppName);
if (!springAppName.equals(sanitizedAppName)) {
LOGGER.warning("Spring application name '" + springAppName
+ "' was sanitized to produce eureka.instance.appname '" + sanitizedAppName + "'");
Expand All @@ -58,7 +58,6 @@ else if (StringUtils.hasText(springAppName)) {
}

private String getSpringApplicationName() {

return Binder.get(getEnvironment()).bind("spring.application.name", String.class).orElse(null);
}

Expand All @@ -71,12 +70,12 @@ private String sanitizeHostname(String hostname) {
if (hostname == null) {
return null;
}
return hostname.replaceAll("[^0-9a-zA-Z\\-\\.]", "-");
return hostname.replaceAll("[^0-9a-zA-Z\\-.]", "-");
}

@Override
public void afterPropertiesSet() {
String messageSuffix = "' is set to a different value than eureka.instance.appname '" + getAppname()
var messageSuffix = "' is set to a different value than eureka.instance.appname '" + getAppname()
+ "', and is disallowed in Spring Cloud Services. Try only setting eureka.instance.appname."
+ " Please refer to our documentation and reach out to us if you think you require different values.";
if (StringUtils.hasText(getVirtualHostName()) && !getVirtualHostName().equalsIgnoreCase(getAppname())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
*/
package io.pivotal.spring.cloud.service.registry;

import java.util.Map;

import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.loadbalancer.LoadBalancerRequestTransformer;
import org.springframework.http.HttpHeaders;
Expand Down Expand Up @@ -47,22 +45,23 @@ public HttpRequest transformRequest(HttpRequest request, ServiceInstance instanc
return request;
}

Map<String, String> metadata = instance.getMetadata();
if (metadata.containsKey(CF_APP_GUID) && metadata.containsKey(CF_INSTANCE_INDEX)) {
final String headerValue = String.format("%s:%s", metadata.get(CF_APP_GUID),
metadata.get(CF_INSTANCE_INDEX));
// request.getHeaders might be immutable, so return a wrapper
return new HttpRequestWrapper(request) {
@Override
public HttpHeaders getHeaders() {
HttpHeaders headers = new HttpHeaders();
headers.putAll(super.getHeaders());
headers.add(SURGICAL_ROUTING_HEADER, headerValue);
return headers;
}
};
var metadata = instance.getMetadata();
if (!metadata.containsKey(CF_APP_GUID) || !metadata.containsKey(CF_INSTANCE_INDEX)) {
return request;
}
return request;

final var headerValue = String.format("%s:%s", metadata.get(CF_APP_GUID), metadata.get(CF_INSTANCE_INDEX));

// request.getHeaders might be immutable, so return a wrapper
return new HttpRequestWrapper(request) {
@Override
public HttpHeaders getHeaders() {
var headers = new HttpHeaders();
headers.putAll(super.getHeaders());
headers.add(SURGICAL_ROUTING_HEADER, headerValue);
return headers;
}
};
}

}

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@
*/
package io.pivotal.spring.cloud.service.registry;

import org.junit.Test;

import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
import org.springframework.security.oauth2.client.registration.ClientRegistration;
Expand Down Expand Up @@ -53,9 +52,10 @@ public void authorizationInterceptorIsConfigured() {

contextRunner.withPropertyValues(pairs).run(context -> {
assertThat(context).hasSingleBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);
var supplier = context.getBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);

var supplier = context.getBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);
var clientRegistration = getAuthInterceptorConfiguration(supplier);

assertThat(clientRegistration.getClientId()).isEqualTo("::id::");
assertThat(clientRegistration.getClientSecret()).isEqualTo("::secret::");
assertThat(clientRegistration.getProviderDetails().getTokenUri()).isEqualTo("::uri::");
Expand All @@ -70,9 +70,10 @@ public void optionalScopePropertyIsSupported() {
var scope = "eureka.client.oauth2.scope=profile,email";
contextRunner.withPropertyValues(pairs).withPropertyValues(scope).run(context -> {
assertThat(context).hasSingleBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);
var supplier = context.getBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);

var supplier = context.getBean(EurekaClientOAuth2HttpRequestFactorySupplier.class);
var clientRegistration = getAuthInterceptorConfiguration(supplier);

assertThat(clientRegistration.getClientId()).isEqualTo("::client id::");
assertThat(clientRegistration.getClientSecret()).isEqualTo("::client secret::");
assertThat(clientRegistration.getProviderDetails().getTokenUri()).isEqualTo("::token uri::");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/*
* Copyright 2019 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 io.pivotal.spring.cloud.service.registry;

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean;

import static org.assertj.core.api.Assertions.assertThat;

/**
* @author Roy Clarkson
* @author Will Tran
*/
public class EurekaInstanceAutoConfigurationIntegrationTest {

@Nested
@SpringBootTest(classes = TestApplication.class,
properties = { "vcap.application.uris[0]=www.route.local", "port=54321", "cf.instance.internal.ip=1.2.3.4",
"vcap.application.instance_id=instance-id", "spring.application.name=app-name_",
"spring.cloud.services.registrationMethod=direct",
"eureka.client.serviceUrl.defaultZone=https://eureka-123.east.my-cf.com/eureka" })
class DirectRegistrationTest {

@Autowired
private EurekaInstanceConfigBean config;

@Test
public void eurekaConfigBean() {
assertThat(config.getInstanceId()).isEqualTo("1.2.3.4:instance-id");
assertThat(config.getAppname()).isEqualTo("app-name-");
assertThat(config.getVirtualHostName()).isEqualTo("app-name-");
assertThat(config.getSecureVirtualHostName()).isEqualTo("app-name-");
assertThat(config.getHostname()).isEqualTo("1.2.3.4");
assertThat(config.getNonSecurePort()).isEqualTo(54321);
assertThat(config.getMetadataMap().get("zone")).isEqualTo("east.my-cf.com");
assertThat(config.getSecurePortEnabled()).isFalse();
}

}

@Nested
@SpringBootTest(classes = TestApplication.class,
properties = { "vcap.application.uris[0]=www.route.local", "cf.instance.ip=1.2.3.4",
"vcap.application.instance_id=instance-id", "spring.application.name=app-name_",
"spring.cloud.services.registrationMethod=route",
"eureka.client.serviceUrl.defaultZone=https://eureka-123.west.my-cf.com/eureka/" })
class RouteRegistrationTest {

@Autowired
private EurekaInstanceConfigBean config;

@Test
public void eurekaConfigBean() {
assertThat(config.getInstanceId()).isEqualTo("www.route.local:instance-id");
assertThat(config.getAppname()).isEqualTo("app-name-");
assertThat(config.getVirtualHostName()).isEqualTo("app-name-");
assertThat(config.getSecureVirtualHostName()).isEqualTo("app-name-");
assertThat(config.getHostname()).isEqualTo("www.route.local");
assertThat(config.getNonSecurePort()).isEqualTo(80);
assertThat(config.getSecurePort()).isEqualTo(443);
assertThat(config.getMetadataMap().get("zone")).isEqualTo("west.my-cf.com");
assertThat(config.getSecurePortEnabled()).isTrue();
}

}

}
Loading

0 comments on commit 3cb0846

Please sign in to comment.