Introduce @PropertySource

Allows a convenient mechanism for contributing a PropertySource to the
enclosing Spring Environment. See @PropertySource Javadoc for
complete details and PropertySourceAnnotationTests for examples.

Issue: SPR-8314

org.springframework.context/src/test/java/org/springframework/context/annotation/PropertySourceAnnotationTests.java

@@ -0,0 +1,125 @@
+/*
+ * Copyright 2002-2011 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.context.annotation;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Iterator;
+
+import javax.inject.Inject;
+
+import org.junit.Test;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.MutablePropertySources;
+
+import test.beans.TestBean;
+
+/**
+ * Tests the processing of @PropertySource annotations on @Configuration classes.
+ *
+ * @author Chris Beams
+ * @since 3.1
+ */
+public class PropertySourceAnnotationTests {
+
+	@Test
+	public void withExplicitName() {
+		AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+		ctx.register(ConfigWithExplicitName.class);
+		ctx.refresh();
+		assertTrue("property source p1 was not added",
+				ctx.getEnvironment().getPropertySources().contains("p1"));
+		assertThat(ctx.getBean(TestBean.class).getName(), equalTo("p1TestBean"));
+
+		// assert that the property source was added last to the set of sources
+		String name;
+		MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
+		Iterator<org.springframework.core.env.PropertySource<?>> iterator = sources.iterator();
+		do {
+			name = iterator.next().getName();
+		}
+		while(iterator.hasNext());
+
+		assertThat(name, is("p1"));
+	}
+
+	@Test
+	public void withImplicitName() {
+		AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+		ctx.register(ConfigWithImplicitName.class);
+		ctx.refresh();
+		assertTrue("property source p1 was not added",
+				ctx.getEnvironment().getPropertySources().contains("class path resource [org/springframework/context/annotation/p1.properties]"));
+		assertThat(ctx.getBean(TestBean.class).getName(), equalTo("p1TestBean"));
+	}
+
+	/**
+	 * Tests the LIFO behavior of @PropertySource annotaitons.
+	 * The last one registered should 'win'.
+	 */
+	@Test
+	public void orderingIsLifo() {
+		{
+			AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+			ctx.register(ConfigWithImplicitName.class, P2Config.class);
+			ctx.refresh();
+			// p2 should 'win' as it was registered last
+			assertThat(ctx.getBean(TestBean.class).getName(), equalTo("p2TestBean"));
+		}
+
+		{
+			AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+			ctx.register(P2Config.class, ConfigWithImplicitName.class);
+			ctx.refresh();
+			// p1 should 'win' as it was registered last
+			assertThat(ctx.getBean(TestBean.class).getName(), equalTo("p1TestBean"));
+		}
+	}
+
+
+	@Configuration
+	@PropertySource(name="p1", value="classpath:org/springframework/context/annotation/p1.properties")
+	static class ConfigWithExplicitName {
+		@Inject Environment env;
+
+		@Bean
+		public TestBean testBean() {
+			return new TestBean(env.getProperty("testbean.name"));
+		}
+	}
+
+
+	@Configuration
+	@PropertySource("classpath:org/springframework/context/annotation/p1.properties")
+	static class ConfigWithImplicitName {
+		@Inject Environment env;
+
+		@Bean
+		public TestBean testBean() {
+			return new TestBean(env.getProperty("testbean.name"));
+		}
+	}
+
+
+	@Configuration
+	@PropertySource("classpath:org/springframework/context/annotation/p2.properties")
+	static class P2Config {
+	}
+}

org.springframework.context/src/test/java/org/springframework/context/annotation/p1.properties

@@ -0,0 +1 @@
+testbean.name=p1TestBean

org.springframework.context/src/test/java/org/springframework/context/annotation/p2.properties

@@ -0,0 +1 @@
+testbean.name=p2TestBean