SpringCloud/spring-cloud-consul
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

If consul token is not set, default to CONSUL_TOKEN env var

Browse Source 
This matches the behaviour of ConsulPropertySourceLocator which depends on ConsulConfigProperties that uses `@Value` which is not recognized in ConfigData.

Fixes gh-738
This commit is contained in:
spencergibb
2023-03-08 15:53:46 -05:00
parent 3868846d13
commit 5e0346c91e
3 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pom.xml
View File

@@ -26,7 +26,7 @@
<spring-cloud-deployer.version>1.0.3.RELEASE</spring-cloud-deployer.version>
<spring-cloud-openfeign.version>3.1.7-SNAPSHOT</spring-cloud-openfeign.version>
<spring-cloud-stream.version>3.2.8-SNAPSHOT</spring-cloud-stream.version>
<testcontainers.version>1.15.1</testcontainers.version>
<testcontainers.version>1.17.6</testcontainers.version>
</properties>
<scm>

7
spring-cloud-consul-config/src/main/java/org/springframework/cloud/consul/config/ConsulConfigDataLocationResolver.java
View File

@@ -212,9 +212,14 @@ public class ConsulConfigDataLocationResolver implements ConfigDataLocationResol
.bind(ConsulConfigProperties.PREFIX, Bindable.of(ConsulConfigProperties.class), bindHandler)
.orElseGet(ConsulConfigProperties::new);
if (StringUtils.isEmpty(properties.getName())) {
if (!StringUtils.hasText(properties.getName())) {
properties.setName(binder.bind("spring.application.name", String.class).orElse("application"));
}
if (!StringUtils.hasText(properties.getAclToken())) {
properties.setAclToken(binder.bind("spring.cloud.consul.token", String.class)
.orElse(binder.bind("consul.token", String.class).orElse(null)));
}
return properties;
}

25
spring-cloud-consul-config/src/test/java/org/springframework/cloud/consul/config/ConsulConfigDataLocationResolverTests.java
View File

@@ -22,6 +22,8 @@ import java.util.stream.Collectors;
import org.apache.commons.logging.LogFactory;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.springframework.boot.BootstrapRegistry.InstanceSupplier;
import org.springframework.boot.DefaultBootstrapContext;
@@ -30,6 +32,7 @@ import org.springframework.boot.context.config.ConfigDataLocationResolverContext
import org.springframework.boot.context.config.Profiles;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.cloud.consul.ConsulProperties;
import org.springframework.core.env.SystemEnvironmentPropertySource;
import org.springframework.mock.env.MockEnvironment;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;
@@ -81,6 +84,28 @@ public class ConsulConfigDataLocationResolverTests {
assertThat(properties.getPort()).isEqualTo(8502);
}
@ParameterizedTest
@ValueSource(strings = { "consul.token", "CONSUL_TOKEN", "spring.cloud.consul.token", "SPRING_CLOUD_CONSUL_TOKEN",
"spring.cloud.consul.config.acl-token" })
public void testLoadConfigProperties(String property) {
MockEnvironment mockEnvironment = new MockEnvironment();
String tokenValue = "mytoken";
if (property.contains("_")) {
SystemEnvironmentPropertySource envPS = new SystemEnvironmentPropertySource("mocksysenv",
Collections.singletonMap(property, tokenValue));
mockEnvironment.getPropertySources().addLast(envPS);
}
else {
mockEnvironment.setProperty(property, tokenValue);
}
Binder binder = Binder.get(mockEnvironment);
ConfigDataLocationResolverContext resolverContext = mock(ConfigDataLocationResolverContext.class);
when(resolverContext.getBinder()).thenReturn(binder);
when(resolverContext.getBootstrapContext()).thenReturn(new DefaultBootstrapContext());
ConsulConfigProperties properties = createResolver().loadConfigProperties(resolverContext);
assertThat(properties.getAclToken()).isEqualTo(tokenValue);
}
private List<String> toContexts(List<ConsulConfigDataResource> locations) {
return locations.stream().map(ConsulConfigDataResource::getContext).collect(Collectors.toList());
}