Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add support for property file encoding in @TestPropertySource

Browse Source 
Prior to this commit, property files configured (or inferred) via
@TestPropertySource were read using the default encoding of the JVM.

This commit introduces an `encoding` attribute in @TestPropertySource
which allows developers to specify an explicit encoding for test
property files.

Closes gh-30982
This commit is contained in:
Sam Brannen
2023-08-05 13:44:15 +03:00
parent 59b78cc513
commit faf3c7831f
6 changed files with 96 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-test/src/main/java/org/springframework/test/context/MergedContextConfiguration.java
View File

@@ -395,6 +395,7 @@ public class MergedContextConfiguration implements Serializable {
* {@code PropertySources}.
* @since 6.1
* @see TestPropertySource#locations
* @see TestPropertySource#encoding
* @see TestPropertySource#factory
*/
public List<PropertySourceDescriptor> getPropertySourceDescriptors() {

9
spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java
View File

@@ -145,6 +145,7 @@ public @interface TestPropertySource {
* @see #inheritLocations
* @see #value
* @see #properties
* @see #encoding
* @see #factory
* @see org.springframework.core.env.PropertySource
*/
@@ -280,6 +281,14 @@ public @interface TestPropertySource {
*/
boolean inheritProperties() default true;
/**
* Specify the character encoding for the given {@linkplain #locations resources}
* &mdash; for example, "UTF-8".
* <p>If not specified, the default character encoding of the JVM will be used.
* @since 6.1
*/
String encoding() default "";
/**
* Specify a custom {@link PropertySourceFactory}, if any.
* <p>By default, a factory for standard resource files will be used which

4
spring-test/src/main/java/org/springframework/test/context/support/MergedTestPropertySources.java
View File

@@ -70,7 +70,9 @@ class MergedTestPropertySources {
/**
* Get the descriptors for resource locations of properties files.
* @see TestPropertySource#locations()
* @see TestPropertySource#locations
* @see TestPropertySource#encoding
* @see TestPropertySource#factory
*/
List<PropertySourceDescriptor> getPropertySourceDescriptors() {
return this.descriptors;

16
spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceAttributes.java
View File

@@ -126,22 +126,28 @@ class TestPropertySourceAttributes {
TestContextResourceUtils.convertToClasspathResourcePaths(declaringClass, true, locations);
Class<? extends PropertySourceFactory> factoryClass =
(Class<? extends PropertySourceFactory>) mergedAnnotation.getClass("factory");
String encoding = mergedAnnotation.getString("encoding");
if (encoding.isBlank()) {
encoding = null; // default encoding will be inferred
}
PropertySourceDescriptor descriptor = new PropertySourceDescriptor(
Arrays.asList(convertedLocations), false, null, factoryClass, null);
addPropertiesAndLocations(List.of(descriptor), properties, declaringClass, false);
List.of(convertedLocations), false, null, factoryClass, encoding);
addPropertiesAndLocations(List.of(descriptor), properties, declaringClass, encoding, false);
}
private void mergePropertiesAndLocationsFrom(TestPropertySourceAttributes attributes) {
addPropertiesAndLocations(attributes.getPropertySourceDescriptors(), attributes.getProperties(),
attributes.getDeclaringClass(), true);
attributes.getDeclaringClass(), null, true);
}
private void addPropertiesAndLocations(List<PropertySourceDescriptor> descriptors, String[] properties,
Class<?> declaringClass, boolean prepend) {
Class<?> declaringClass, String encoding, boolean prepend) {
if (hasNoLocations(descriptors) && ObjectUtils.isEmpty(properties)) {
String defaultPropertiesFile = detectDefaultPropertiesFile(declaringClass);
addAll(prepend, this.descriptors, List.of(new PropertySourceDescriptor(defaultPropertiesFile)));
PropertySourceDescriptor descriptor = new PropertySourceDescriptor(
List.of(defaultPropertiesFile), false, null, null, encoding);
addAll(prepend, this.descriptors, List.of(descriptor));
}
else {
addAll(prepend, this.descriptors, descriptors);