Add profile option to annotation

Author: ericdallo

gradle.properties

@@ -1 +1 @@
-version=1.0.3
+version=1.0.4-SNAPSHOT

src/main/java/com/spring/loader/S3PropertiesLocation.java

@@ -7,17 +7,18 @@
 import java.lang.annotation.Target;
 
 import org.springframework.context.annotation.Import;
+import org.springframework.core.annotation.AliasFor;
 
 /**
  * Allow the auto configuration of the {@link S3PropertyPlaceholderConfigurer} bean.
  * 
  * @author Eric Dallo
  * @since 1.0.3
- * @see S3PropertiesLocationConfiguration
+ * @see S3PropertiesLocationRegistrar
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-@Import({S3ResourseLoaderConfiguration.class, S3PropertiesLocationConfiguration.class})
+@Import({S3ResourseLoaderConfiguration.class, S3PropertiesLocationRegistrar.class})
 @Documented
 public @interface S3PropertiesLocation {
 
@@ -26,6 +27,16 @@
 	 * 
 	 * @return the path of aws s3 properties, e.g. my-bucket/my-folder/app.properties  
 	 */
-	String[] value();
+	@AliasFor("path")
+	String[] value() default {};
 
+	@AliasFor("value")
+	String[] path() default {};
+	
+	/**
+	 * The profiles to load the properties in aws s3.
+	 * 
+	 * @return the profile name e.g. "prod"
+	 */
+	String[] profiles() default {};
 }

src/main/java/com/spring/loader/S3PropertiesLocationConfiguration.java renamed to src/main/java/com/spring/loader/S3PropertiesLocationRegistrar.java

@@ -1,12 +1,15 @@
 package com.spring.loader;
 
-import org.springframework.beans.MutablePropertyValues;
+import static java.lang.Character.toLowerCase;
+
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.RuntimeBeanReference;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.annotation.AnnotationAttributes;
+import org.springframework.core.env.Environment;
 import org.springframework.core.type.AnnotationMetadata;
 
 /**
@@ -18,22 +21,33 @@
  * @see S3PropertiesLocation
  * @see S3PropertyPlaceholderConfigurer
  */
-class S3PropertiesLocationConfiguration implements ImportBeanDefinitionRegistrar {
+class S3PropertiesLocationRegistrar implements EnvironmentAware, ImportBeanDefinitionRegistrar {
 
+	private Environment environment;
+
 	@Override
 	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
-		BeanDefinition bd = new RootBeanDefinition(S3PropertyPlaceholderConfigurer.class);
-		
 		AnnotationAttributes attributes = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(S3PropertiesLocation.class.getName()));
-		String[] locations = attributes.getStringArray("value");
+		String[] profiles = attributes.getStringArray("profiles");
 
-		MutablePropertyValues properties = bd.getPropertyValues();
+		if (profiles.length > 0 && !environment.acceptsProfiles(profiles)) {
+			return;
+		}
 
-		properties.addPropertyValue("s3ResourceLoader", new RuntimeBeanReference("s3ResourceLoader")); 
+		String[] locations = attributes.getStringArray("value");
 
-		properties.add("s3Locations", locations);
+		BeanDefinition bd = new RootBeanDefinition(S3PropertyPlaceholderConfigurer.class);
+		
+		bd.getPropertyValues().addPropertyValue("s3ResourceLoader", new RuntimeBeanReference("s3ResourceLoader")); 
+		bd.getPropertyValues().add("s3Locations", locations);
 
-		registry.registerBeanDefinition("s3PropertyPlaceholderConfigurer", bd);
+		String beanName = S3PropertyPlaceholderConfigurer.class.getSimpleName();
+		registry.registerBeanDefinition(toLowerCase(beanName.charAt(0)) + beanName.substring(1), bd);
+	}
+
+	@Override
+	public void setEnvironment(Environment environment) {
+		this.environment = environment;
 	}
 
 }

src/main/java/com/spring/loader/S3ResourceLoader.java

@@ -8,6 +8,7 @@
 import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.model.S3Object;
 import com.spring.loader.exception.InvalidS3LocationException;
+import com.spring.loader.exception.S3ResourceException;
 
 /**
  * Get {@link Resource} for the given aws s3 location.

src/main/java/com/spring/loader/exception/InvalidS3LocationException.java

@@ -1,7 +1,5 @@
 package com.spring.loader.exception;
 
-import com.spring.loader.S3ResourceException;
-
 public class InvalidS3LocationException extends S3ResourceException {
 	private static final long serialVersionUID = 2057112790586228669L;
 

src/main/java/com/spring/loader/S3ResourceException.java renamed to src/main/java/com/spring/loader/exception/S3ResourceException.java

@@ -1,4 +1,4 @@
-package com.spring.loader;
+package com.spring.loader.exception;
 
 public class S3ResourceException extends RuntimeException {
 	private static final long serialVersionUID = 8310280589629514933L;

src/test/java/com/spring/loader/S3PropertiesLocationRegistrarTest.java

@@ -0,0 +1,82 @@
+package com.spring.loader;
+
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.runners.MockitoJUnitRunner;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.core.env.Environment;
+import org.springframework.core.type.AnnotationMetadata;
+
+@RunWith(MockitoJUnitRunner.class)
+public class S3PropertiesLocationRegistrarTest {
+
+	private S3PropertiesLocationRegistrar subject;
+
+	private Map<String, Object> attributes;
+
+	@Mock
+	private Environment environment;
+	@Mock
+	private AnnotationMetadata importingClassMetadata;
+	@Mock
+	private BeanDefinitionRegistry registry;
+
+	@Before
+	public void setup() {
+		subject = new S3PropertiesLocationRegistrar();
+		subject.setEnvironment(environment);
+
+		attributes = new HashMap<>();
+		attributes.put("path", new String[] { "my-bucket/my.properties" });
+		attributes.put("value", new String[] { "my-bucket/my.properties" });
+
+		when(importingClassMetadata.getAnnotationAttributes(S3PropertiesLocation.class.getName())).thenReturn(attributes);
+	}
+
+	@Test
+	public void shouldLoadPropertiesWhenThereisNoProfiles() {
+		attributes.put("profiles", new String[] {});
+
+		subject.registerBeanDefinitions(importingClassMetadata, registry);
+
+		verify(registry).registerBeanDefinition(Mockito.anyString(), Mockito.any(BeanDefinition.class));
+	}
+
+	@Test
+	public void shouldLoadPropertiesWhenThereisProfilesActive() {
+		String[] profiles = new String[] { "prod" };
+
+		attributes.put("profiles", profiles);
+
+		when(environment.acceptsProfiles(profiles)).thenReturn(true);
+
+		subject.registerBeanDefinitions(importingClassMetadata, registry);
+
+		verify(registry).registerBeanDefinition(Mockito.anyString(), Mockito.any(BeanDefinition.class));
+	}
+
+	@Test
+	public void shouldNotLoadPropertiesWhenThereisNoProfilesActive() {
+		String[] profiles = new String[] { "prod" };
+
+		attributes.put("profiles", profiles);
+
+		when(environment.acceptsProfiles(profiles)).thenReturn(false);
+
+		subject.registerBeanDefinitions(importingClassMetadata, registry);
+
+		verify(registry, never()).registerBeanDefinition(Mockito.anyString(), Mockito.any(BeanDefinition.class));
+	}
+
+}