Skip to content

Commit b2899ae

Browse files
johnychojohnycho
committed
Support resolving file content to Base64 via {file} prefix
1 parent c5ce931 commit b2899ae

4 files changed

Lines changed: 214 additions & 0 deletions

File tree

‎spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/FileResolvingEnvironmentRepositoryConfiguration.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package org.springframework.cloud.config.server.config;
2+
3+
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
4+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
5+
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
6+
import org.springframework.cloud.config.server.environment.EnvironmentRepository;
7+
import org.springframework.cloud.config.server.environment.FileResolvingEnvironmentRepository;
8+
import org.springframework.context.annotation.Bean;
9+
import org.springframework.context.annotation.Configuration;
10+
import org.springframework.context.annotation.Primary;
11+
12+
/**
13+
* Autoconfiguration for {@link FileResolvingEnvironmentRepository}.
14+
* Wraps the existing EnvironmentRepository to support file content resolution.
15+
*
16+
* @author Johny Cho
17+
*/
18+
@Configuration(proxyBeanMethods = false)
19+
@AutoConfigureAfter(EnvironmentRepositoryConfiguration.class)
20+
public class FileResolvingEnvironmentRepositoryConfiguration {
21+
22+
@Bean
23+
@Primary
24+
@ConditionalOnBean(EnvironmentRepository.class)
25+
@ConditionalOnProperty(value = "spring.cloud.config.server.file-resolving.enabled", matchIfMissing = true)
26+
public FileResolvingEnvironmentRepository fileResolvingEnvironmentRepository(EnvironmentRepository environmentRepository) {
27+
return new FileResolvingEnvironmentRepository(environmentRepository);
28+
}
29+
30+
}

‎spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/FileResolvingEnvironmentRepository.java‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
package org.springframework.cloud.config.server.environment;
2+
3+
import java.io.File;
4+
import java.io.IOException;
5+
import java.util.Base64;
6+
import java.util.LinkedHashMap;
7+
import java.util.List;
8+
import java.util.Map;
9+
import java.util.Objects;
10+
import org.apache.commons.logging.Log;
11+
import org.apache.commons.logging.LogFactory;
12+
import org.springframework.cloud.config.environment.Environment;
13+
import org.springframework.cloud.config.environment.PropertySource;
14+
import org.springframework.util.FileCopyUtils;
15+
import org.springframework.util.ResourceUtils;
16+
17+
/**
18+
* @author Johny Cho
19+
*/
20+
public class FileResolvingEnvironmentRepository implements EnvironmentRepository {
21+
22+
private static final Log log = LogFactory.getLog(FileResolvingEnvironmentRepository.class);
23+
private final EnvironmentRepository delegate;
24+
private static final String PREFIX = "{file}";
25+
26+
public FileResolvingEnvironmentRepository(EnvironmentRepository delegate) {
27+
this.delegate = delegate;
28+
}
29+
30+
@Override
31+
public Environment findOne(String application, String profile, String label) {
32+
Environment env = this.delegate.findOne(application, profile, label);
33+
34+
if (Objects.isNull(env)) {
35+
return null;
36+
}
37+
38+
List<PropertySource> sources = env.getPropertySources();
39+
40+
for (int i = 0; i < sources.size(); i++) {
41+
PropertySource source = sources.get(i);
42+
Map<?, ?> originalMap = source.getSource();
43+
44+
Map<Object, Object> modifiedMap = new LinkedHashMap<>(originalMap);
45+
boolean modified = false;
46+
47+
for (Map.Entry<?, ?> entry : originalMap.entrySet()) {
48+
Object value = entry.getValue();
49+
50+
if (value instanceof String str && str.startsWith(PREFIX)) {
51+
String filePath = str.substring(PREFIX.length());
52+
try {
53+
String base64Content = readFileToBase64(filePath);
54+
modifiedMap.put(entry.getKey(), base64Content);
55+
modified = true;
56+
} catch (IOException e) {
57+
log.warn(String.format("Failed to resolve file content for property '%s'. path: %s", entry.getKey(), filePath), e);
58+
}
59+
}
60+
}
61+
62+
if (modified) {
63+
PropertySource newSource = new PropertySource(source.getName(), modifiedMap);
64+
sources.set(i, newSource);
65+
}
66+
}
67+
68+
return env;
69+
}
70+
71+
private String readFileToBase64(String filePath) throws IOException {
72+
File file = ResourceUtils.getFile(filePath);
73+
byte[] fileContent = FileCopyUtils.copyToByteArray(file);
74+
return Base64.getEncoder().encodeToString(fileContent);
75+
}
76+
}

‎spring-cloud-config-server/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ org.springframework.cloud.config.server.config.RsaEncryptionAutoConfiguration
44
org.springframework.cloud.config.server.config.DefaultTextEncryptionAutoConfiguration
55
org.springframework.cloud.config.server.config.EncryptionAutoConfiguration
66
org.springframework.cloud.config.server.config.VaultEncryptionAutoConfiguration
7+
org.springframework.cloud.config.server.config.FileResolvingEnvironmentRepositoryConfiguration

‎spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/FileResolvingEnvironmentRepositoryTests.java‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
package org.springframework.cloud.config.server.environment;
2+
3+
import java.io.File;
4+
import java.io.IOException;
5+
import java.nio.charset.StandardCharsets;
6+
import java.nio.file.Files;
7+
import java.util.Base64;
8+
import java.util.Collections;
9+
import java.util.HashMap;
10+
import java.util.Map;
11+
12+
import org.junit.jupiter.api.Test;
13+
import org.junit.jupiter.api.io.TempDir;
14+
15+
import org.springframework.cloud.config.environment.Environment;
16+
import org.springframework.cloud.config.environment.PropertySource;
17+
18+
import static org.assertj.core.api.Assertions.assertThat;
19+
import static org.mockito.ArgumentMatchers.any;
20+
import static org.mockito.ArgumentMatchers.anyString;
21+
import static org.mockito.BDDMockito.given;
22+
import static org.mockito.Mockito.mock;
23+
24+
/**
25+
* Tests for {@link FileResolvingEnvironmentRepository}.
26+
*/
27+
class FileResolvingEnvironmentRepositoryTests {
28+
29+
@TempDir
30+
File tempDir;
31+
32+
@Test
33+
void findOneShouldResolveFileContentToBase64() throws Exception {
34+
File secretFile = new File(tempDir, "secret.txt");
35+
String content = "hello-spring-cloud";
36+
Files.writeString(secretFile.toPath(), content);
37+
38+
EnvironmentRepository delegate = mock(EnvironmentRepository.class);
39+
Environment originalEnv = new Environment("app", "dev");
40+
41+
Map<String, Object> sourceMap = new HashMap<>();
42+
sourceMap.put("my.secret", "{file}" + secretFile.getAbsolutePath());
43+
sourceMap.put("my.normal", "just-string");
44+
45+
PropertySource propertySource = new PropertySource("test-source", sourceMap);
46+
originalEnv.add(propertySource);
47+
48+
given(delegate.findOne(anyString(), anyString(), any())).willReturn(originalEnv);
49+
50+
FileResolvingEnvironmentRepository repository = new FileResolvingEnvironmentRepository(delegate);
51+
52+
Environment resultEnv = repository.findOne("app", "dev", null);
53+
54+
assertThat(resultEnv).isNotNull();
55+
PropertySource resultSource = resultEnv.getPropertySources().get(0);
56+
Map<?, ?> resultMap = resultSource.getSource();
57+
58+
String expectedBase64 = Base64.getEncoder().encodeToString(content.getBytes(StandardCharsets.UTF_8));
59+
assertThat(String.valueOf(resultMap.get("my.secret"))).isEqualTo(expectedBase64);
60+
61+
assertThat(String.valueOf(resultMap.get("my.normal"))).isEqualTo("just-string");
62+
}
63+
64+
@Test
65+
void findOneShouldHandleNonExistentFile() {
66+
EnvironmentRepository delegate = mock(EnvironmentRepository.class);
67+
Environment originalEnv = new Environment("app", "dev");
68+
69+
Map<String, Object> sourceMap = new HashMap<>();
70+
String badPath = "{file}/path/to/non/existent/file.txt";
71+
sourceMap.put("my.bad.secret", badPath);
72+
73+
originalEnv.add(new PropertySource("test-source", sourceMap));
74+
given(delegate.findOne(anyString(), anyString(), any())).willReturn(originalEnv);
75+
76+
FileResolvingEnvironmentRepository repository = new FileResolvingEnvironmentRepository(delegate);
77+
Environment resultEnv = repository.findOne("app", "dev", null);
78+
79+
PropertySource resultSource = resultEnv.getPropertySources().get(0);
80+
Map<?, ?> resultMap = resultSource.getSource();
81+
82+
assertThat(String.valueOf(resultMap.get("my.bad.secret"))).isEqualTo(badPath);
83+
}
84+
85+
@Test
86+
void findOneShouldHandleUnmodifiableMapSafely() throws IOException {
87+
File secretFile = new File(tempDir, "secret.txt");
88+
Files.write(secretFile.toPath(), "content".getBytes());
89+
90+
EnvironmentRepository delegate = mock(EnvironmentRepository.class);
91+
Environment originalEnv = new Environment("app", "dev");
92+
93+
Map<String, Object> sourceMap = Collections.singletonMap("my.secret", "{file}" + secretFile.getAbsolutePath());
94+
95+
originalEnv.add(new PropertySource("immutable-source", sourceMap));
96+
given(delegate.findOne(anyString(), anyString(), any())).willReturn(originalEnv);
97+
98+
FileResolvingEnvironmentRepository repository = new FileResolvingEnvironmentRepository(delegate);
99+
100+
Environment resultEnv = repository.findOne("app", "dev", null);
101+
102+
assertThat(resultEnv).isNotNull();
103+
Map<?, ?> resultMap = resultEnv.getPropertySources().get(0).getSource();
104+
105+
assertThat(String.valueOf(resultMap.get("my.secret"))).isNotEqualTo("{file}" + secretFile.getAbsolutePath());
106+
}
107+
}

0 commit comments

Comments
 (0)