[bs-167] Fixed YamlProcessor to not create a key for an array

[Fixes #51968679] YamlPropertiesFactoryBean creates unbindable keys
(the toString() of the whole map for instance)
This commit is contained in:
Dave Syer 2013-07-11 09:50:07 +01:00
parent fcb786ed91
commit 15ba11f302
6 changed files with 93 additions and 21 deletions

View File

@ -148,8 +148,7 @@ public class YamlProcessor {
} }
this.logger.info("Loaded " + count + " document" + (count > 1 ? "s" : "") this.logger.info("Loaded " + count + " document" + (count > 1 ? "s" : "")
+ " from YAML resource: " + resource); + " from YAML resource: " + resource);
} } catch (IOException ex) {
catch (IOException ex) {
handleProcessError(resource, ex); handleProcessError(resource, ex);
} }
return count > 0; return count > 0;
@ -177,8 +176,7 @@ public class YamlProcessor {
if (this.documentMatchers.isEmpty()) { if (this.documentMatchers.isEmpty()) {
this.logger.debug("Merging document (no matchers set)" + map); this.logger.debug("Merging document (no matchers set)" + map);
callback.process(properties, map); callback.process(properties, map);
} } else {
else {
boolean valueFound = false; boolean valueFound = false;
MatchStatus result = MatchStatus.ABSTAIN; MatchStatus result = MatchStatus.ABSTAIN;
for (DocumentMatcher matcher : this.documentMatchers) { for (DocumentMatcher matcher : this.documentMatchers) {
@ -196,8 +194,7 @@ public class YamlProcessor {
if (result == MatchStatus.ABSTAIN && this.matchDefault) { if (result == MatchStatus.ABSTAIN && this.matchDefault) {
this.logger.debug("Matched document with default matcher: " + map); this.logger.debug("Matched document with default matcher: " + map);
callback.process(properties, map); callback.process(properties, map);
} } else if (!valueFound) {
else if (!valueFound) {
this.logger.debug("Unmatched document"); this.logger.debug("Unmatched document");
return false; return false;
} }
@ -212,34 +209,28 @@ public class YamlProcessor {
if (StringUtils.hasText(path)) { if (StringUtils.hasText(path)) {
if (key.startsWith("[")) { if (key.startsWith("[")) {
key = path + key; key = path + key;
} } else {
else {
key = path + "." + key; key = path + "." + key;
} }
} }
Object value = entry.getValue(); Object value = entry.getValue();
if (value instanceof String) { if (value instanceof String) {
properties.put(key, value); properties.put(key, value);
} } else if (value instanceof Map) {
else if (value instanceof Map) {
// Need a compound key // Need a compound key
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
Map<String, Object> map = (Map<String, Object>) value; Map<String, Object> map = (Map<String, Object>) value;
assignProperties(properties, map, key); assignProperties(properties, map, key);
} } else if (value instanceof Collection) {
else if (value instanceof Collection) {
// Need a compound key // Need a compound key
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
Collection<Object> collection = (Collection<Object>) value; Collection<Object> collection = (Collection<Object>) value;
properties.put(key,
StringUtils.collectionToCommaDelimitedString(collection));
int count = 0; int count = 0;
for (Object object : collection) { for (Object object : collection) {
assignProperties(properties, assignProperties(properties,
Collections.singletonMap("[" + (count++) + "]", object), key); Collections.singletonMap("[" + (count++) + "]", object), key);
} }
} } else {
else {
properties.put(key, value == null ? "" : value); properties.put(key, value == null ? "" : value);
} }
} }

View File

@ -0,0 +1,65 @@
/*
* Copyright 2012-2013 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
*
* http://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 org.springframework.bootstrap.config;
import java.util.Map;
import java.util.Properties;
import org.junit.Test;
import org.springframework.bootstrap.config.YamlProcessor.MatchCallback;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.Resource;
import static org.junit.Assert.assertEquals;
/**
* @author Dave Syer
*
*/
public class YamlProcessorTests {
private YamlProcessor processor = new YamlProcessor();
@Test
public void arrayConvertedToIndexedBeanReference() {
this.processor.setResources(new Resource[] { new ByteArrayResource(
"foo: bar\nbar: [1,2,3]".getBytes()) });
this.processor.process(new MatchCallback() {
@Override
public void process(Properties properties, Map<String, Object> map) {
assertEquals(1, properties.get("bar[0]"));
assertEquals(2, properties.get("bar[1]"));
assertEquals(3, properties.get("bar[2]"));
assertEquals(4, properties.size());
}
});
}
@Test
public void mapConvertedToIndexedBeanReference() {
this.processor.setResources(new Resource[] { new ByteArrayResource(
"foo: bar\nbar:\n spam: bucket".getBytes()) });
this.processor.process(new MatchCallback() {
@Override
public void process(Properties properties, Map<String, Object> map) {
// System.err.println(properties);
assertEquals("bucket", properties.get("bar.spam"));
assertEquals(2, properties.size());
}
});
}
}

View File

@ -22,7 +22,6 @@ import java.util.Properties;
import org.junit.Ignore; import org.junit.Ignore;
import org.junit.Test; import org.junit.Test;
import org.springframework.bootstrap.config.YamlPropertiesFactoryBean;
import org.springframework.bootstrap.config.YamlProcessor.DocumentMatcher; import org.springframework.bootstrap.config.YamlProcessor.DocumentMatcher;
import org.springframework.bootstrap.config.YamlProcessor.MatchStatus; import org.springframework.bootstrap.config.YamlProcessor.MatchStatus;
import org.springframework.bootstrap.config.YamlProcessor.ResolutionMethod; import org.springframework.bootstrap.config.YamlProcessor.ResolutionMethod;
@ -185,7 +184,6 @@ public class YamlPropertiesFactoryBeanTests {
Properties properties = factory.getObject(); Properties properties = factory.getObject();
assertEquals("bar", properties.get("foo[0]")); assertEquals("bar", properties.get("foo[0]"));
assertEquals("baz", properties.get("foo[1]")); assertEquals("baz", properties.get("foo[1]"));
assertEquals("bar,baz", properties.get("foo"));
} }
@Test @Test
@ -200,7 +198,6 @@ public class YamlPropertiesFactoryBeanTests {
assertEquals("baz", properties.get("foo[1]")); assertEquals("baz", properties.get("foo[1]"));
assertEquals("two", properties.get("foo[2].one")); assertEquals("two", properties.get("foo[2].one"));
assertEquals("four", properties.get("foo[2].three")); assertEquals("four", properties.get("foo[2].three"));
assertEquals("{bar={spam=crap}},baz,{one=two, three=four}", properties.get("foo"));
} }
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

View File

@ -20,12 +20,12 @@ import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.junit.Test; import org.junit.Test;
import org.springframework.bootstrap.context.initializer.ConfigFileApplicationContextInitializer;
import org.springframework.context.support.StaticApplicationContext; import org.springframework.context.support.StaticApplicationContext;
import org.springframework.core.env.MapPropertySource; import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.SimpleCommandLinePropertySource; import org.springframework.core.env.SimpleCommandLinePropertySource;
import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.nullValue;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
/** /**
@ -54,6 +54,9 @@ public class ConfigFileApplicationContextInitializerTests {
this.initializer.initialize(this.context); this.initializer.initialize(this.context);
String property = this.context.getEnvironment().getProperty("my.property"); String property = this.context.getEnvironment().getProperty("my.property");
assertThat(property, equalTo("fromyamlfile")); assertThat(property, equalTo("fromyamlfile"));
assertThat(this.context.getEnvironment().getProperty("my.array[0]"), equalTo("1"));
assertThat(this.context.getEnvironment().getProperty("my.array"),
nullValue(String.class));
} }
@Test @Test

View File

@ -16,7 +16,9 @@
package org.springframework.bootstrap.context.properties; package org.springframework.bootstrap.context.properties;
import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.List;
import javax.annotation.PostConstruct; import javax.annotation.PostConstruct;
@ -62,6 +64,14 @@ public class EnableConfigurationPropertiesTests {
assertEquals(3, this.context.getBean(TestProperties.class).getArray().length); assertEquals(3, this.context.getBean(TestProperties.class).getArray().length);
} }
@Test
public void testCollectionPropertiesBindingFromYamlArray() {
this.context.register(TestConfiguration.class);
TestUtils.addEnviroment(this.context, "name:foo", "list[0]:1", "list[1]:2");
this.context.refresh();
assertEquals(2, this.context.getBean(TestProperties.class).getList().size());
}
@Test @Test
public void testPropertiesBindingWithoutAnnotation() { public void testPropertiesBindingWithoutAnnotation() {
this.context.register(MoreConfiguration.class); this.context.register(MoreConfiguration.class);
@ -100,7 +110,7 @@ public class EnableConfigurationPropertiesTests {
// Maybe we could relax the condition that causes this exception but Spring makes it // Maybe we could relax the condition that causes this exception but Spring makes it
// difficult because it is impossible for DefaultConfiguration to override a bean // difficult because it is impossible for DefaultConfiguration to override a bean
// definition created with a direct regsistration (as opposed to a @Bean) // definition created with a direct registration (as opposed to a @Bean)
@Test(expected = BeanCreationException.class) @Test(expected = BeanCreationException.class)
public void testPropertiesBindingWithDefaults() { public void testPropertiesBindingWithDefaults() {
this.context.register(TestConfiguration.class, DefaultConfiguration.class); this.context.register(TestConfiguration.class, DefaultConfiguration.class);
@ -201,6 +211,7 @@ public class EnableConfigurationPropertiesTests {
protected static class TestProperties { protected static class TestProperties {
private String name; private String name;
private int[] array; private int[] array;
private List<Integer> list = new ArrayList<Integer>();
public String getName() { public String getName() {
return this.name; return this.name;
@ -217,6 +228,10 @@ public class EnableConfigurationPropertiesTests {
public int[] getArray() { public int[] getArray() {
return this.array; return this.array;
} }
public List<Integer> getList() {
return this.list;
}
} }
protected static class MoreProperties { protected static class MoreProperties {

View File

@ -1,3 +1,4 @@
--- ---
my: my:
property: fromyamlfile property: fromyamlfile
array: [1,2,3]