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

Use path to key property in SpringVaultEnvironmentRepository. Fixes #2072 (#2073)

Browse Source
This commit is contained in:
Ryan Baxter
2022-03-30 12:14:05 -04:00
parent 9cfa39377e
commit 97421f0bf8
2 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/vault/SpringVaultEnvironmentRepository.java
View File

@@ -25,6 +25,7 @@ import org.springframework.beans.factory.ObjectProvider;
import org.springframework.cloud.config.server.environment.AbstractVaultEnvironmentRepository;
import org.springframework.cloud.config.server.environment.EnvironmentWatch;
import org.springframework.cloud.config.server.environment.VaultEnvironmentProperties;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.vault.core.VaultKeyValueOperations;
import org.springframework.vault.support.VaultResponse;
@@ -39,15 +40,20 @@ public class SpringVaultEnvironmentRepository extends AbstractVaultEnvironmentRe
private final ObjectMapper objectMapper;
private String path = "";
public SpringVaultEnvironmentRepository(ObjectProvider<HttpServletRequest> request, EnvironmentWatch watch,
VaultEnvironmentProperties properties, VaultKeyValueOperations keyValueTemplate) {
super(request, watch, properties);
this.keyValueTemplate = keyValueTemplate;
if (properties.getKvVersion() == 2 && StringUtils.hasText(properties.getPathToKey())) {
path = "data/" + properties.getPathToKey() + "/";
}
this.objectMapper = new ObjectMapper();
}
protected String read(String key) {
VaultResponse response = this.keyValueTemplate.get(key);
VaultResponse response = this.keyValueTemplate.get(this.path + key);
if (response != null) {
try {
return objectMapper.writeValueAsString(response.getData());

29
spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/vault/SpringVaultEnvironmentRepositoryTests.java
View File

@@ -27,6 +27,7 @@ import org.springframework.beans.factory.ObjectProvider;
import org.springframework.cloud.config.environment.Environment;
import org.springframework.cloud.config.server.environment.EnvironmentWatch;
import org.springframework.cloud.config.server.environment.VaultEnvironmentProperties;
import org.springframework.util.StringUtils;
import org.springframework.vault.core.VaultKeyValueOperations;
import org.springframework.vault.support.VaultResponse;
@@ -48,12 +49,32 @@ public class SpringVaultEnvironmentRepositoryTests {
@Test
public void testFindOneNoDefaultKey() {
VaultKeyValueOperations keyValueTemplate = mock(VaultKeyValueOperations.class);
when(keyValueTemplate.get("myapp")).thenReturn(withVaultResponse("foo", "bar"));
when(keyValueTemplate.get("application")).thenReturn(withVaultResponse("def-foo", "def-bar"));
defaultKeyTest("", 2);
}
@Test
public void testPathKey() {
defaultKeyTest("mypath", 2);
}
@Test
public void testPathKeyNotUsedWithVersionOne() {
defaultKeyTest("mypath", 1);
}
private void defaultKeyTest(String myPathKey, int version) {
String path = "";
if (StringUtils.hasText(myPathKey) && version == 2) {
path = "data/" + myPathKey + "/";
}
VaultKeyValueOperations keyValueTemplate = mock(VaultKeyValueOperations.class);
when(keyValueTemplate.get(path + "myapp")).thenReturn(withVaultResponse("foo", "bar"));
when(keyValueTemplate.get(path + "application")).thenReturn(withVaultResponse("def-foo", "def-bar"));
VaultEnvironmentProperties properties = new VaultEnvironmentProperties();
properties.setPathToKey(myPathKey);
properties.setKvVersion(version);
SpringVaultEnvironmentRepository repo = new SpringVaultEnvironmentRepository(mockHttpRequest(),
new EnvironmentWatch.Default(), new VaultEnvironmentProperties(), keyValueTemplate);
new EnvironmentWatch.Default(), properties, keyValueTemplate);
Environment e = repo.findOne("myapp", null, null);
assertThat(e.getName()).as("Name should be the same as the application argument").isEqualTo("myapp");