Merge pull request #4 from ericdallo/custom-property-source

[custom-property-source] - Change to use Spring PropertySource Bean

Author: ericdallo

README.md

@@ -32,15 +32,18 @@ There 2 ways to configure your application to load properties from s3:
 
 **Anotation**
 
-Add this annotation to any spring managed bean
+- Adding this annotation to any spring managed bean
 ```java
 @S3PropertiesLocation("my-bucket/my-folder/my-properties.properties")
 ```
-or using a specific profile to only load properties if the app is running with that profile
+- Using a specific profile to only load properties if the app is running with that profile
 ```java
 @S3PropertiesLocation(path = "my-bucket/my-folder/my-properties.properties", profiles = "production")
 ```
-
+- Load from a System env variable
+```java
+@S3PropertiesLocation(path = "${AWS_S3_LOCATION}", profiles = "production")
+```
 **Configuration**
 ```java
 @Bean
@@ -55,4 +58,4 @@ S3PropertyPlaceholderConfigurer s3PropertyPlaceholderConfigurer(AmazonS3 amazonS
 ## Requisites
 
 Official spring aws sdk lib.
-See: https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-aws
+See: https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-aws

build.gradle

@@ -67,6 +67,8 @@ dependencies {
     testCompile "junit:junit:4.12"
     testCompile "org.mockito:mockito-core:1.10.19"
     testCompile "org.assertj:assertj-core:1.0.0"
+    testCompile "org.powermock:powermock-api-mockito:1.6.6"
+    testCompile "org.powermock:powermock-module-junit4:1.6.6"
 }
 
 task sourcesJar(type: Jar) {

gradle.properties

@@ -1 +1 @@
-version=1.0.5-SNAPSHOT
+version=2.0-SNAPSHOT

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

@@ -7,32 +7,28 @@
 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.
+ * Allow the auto configuration of the {@link S3PropertySource} bean.
  * 
  * @author Eric Dallo
  * @since 1.0.3
  * @see S3PropertiesLocationRegistrar
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-@Import({S3ResourseLoaderConfiguration.class, S3PropertiesLocationRegistrar.class})
+@Import({ S3ResourseLoaderConfiguration.class, S3PropertiesLocationRegistrar.class })
 @Documented
 public @interface S3PropertiesLocation {
-	
+
 	/**
 	 * The location of the properties in aws s3.
 	 * 
-	 * @return the path of aws s3 properties, e.g. my-bucket/my-folder/app.properties  
+	 * @return the path of aws s3 properties                       e.g. "my-bucket/my-folder/app.properties" 
+	 *         or a enviroment system to the s3 path               e.g. "${MY_BUCKET_IN_AWS_S3}"
 	 */
-	@AliasFor("path")
-	String[] value() default {};
-	
-	@AliasFor("value")
-	String[] path() default {};
-	
+	String[] value();
+
 	/**
 	 * The profiles to load the properties in aws s3.
 	 * 

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

@@ -13,17 +13,27 @@
 import org.springframework.core.type.AnnotationMetadata;
 
 /**
- * Creates the {@link S3PropertyPlaceholderConfigurer} bean.
+ * Creates the {@link S3PropertySource} bean.
  * For use with the {@link S3PropertiesLocation} annotation. 
  * 
  * @author Eric Dallo
  * @since 1.0.3
  * @see S3PropertiesLocation
- * @see S3PropertyPlaceholderConfigurer
+ * @see S3PropertySource
  */
 class S3PropertiesLocationRegistrar implements EnvironmentAware, ImportBeanDefinitionRegistrar {
 
 	private Environment environment;
+	private SystemPropertyResolver resolver;
+
+	public S3PropertiesLocationRegistrar() {
+		resolver = new SystemPropertyResolver();
+	}
+
+	public S3PropertiesLocationRegistrar(Environment environment, SystemPropertyResolver resolver) {
+		this.environment = environment;
+		this.resolver = resolver;
+	}
 
 	@Override
 	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
@@ -36,12 +46,18 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, B
 
 		String[] locations = attributes.getStringArray("value");
 
-		BeanDefinition bd = new RootBeanDefinition(S3PropertyPlaceholderConfigurer.class);
+		String[] formattedLocations = new String[locations.length]; 
+
+		for (int i = 0; i < locations.length; i++) {
+			formattedLocations[i] = resolver.getFormattedValue(locations[i]);
+		}
+		
+		BeanDefinition bd = new RootBeanDefinition(S3PropertiesSourceConfigurer.class);
 
 		bd.getPropertyValues().addPropertyValue("s3ResourceLoader", new RuntimeBeanReference("s3ResourceLoader")); 
-		bd.getPropertyValues().add("s3Locations", locations);
+		bd.getPropertyValues().add("s3Locations", formattedLocations);
 
-		String beanName = S3PropertyPlaceholderConfigurer.class.getSimpleName();
+		String beanName = S3PropertiesSourceConfigurer.class.getSimpleName();
 		registry.registerBeanDefinition(toLowerCase(beanName.charAt(0)) + beanName.substring(1), bd);
 	}
 

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

@@ -0,0 +1,76 @@
+package com.spring.loader;
+
+import java.io.IOException;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.config.PropertiesFactoryBean;
+import org.springframework.context.EnvironmentAware;
+import org.springframework.core.Ordered;
+import org.springframework.core.PriorityOrdered;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.MutablePropertySources;
+
+/**
+ * Add a new {@link PropertySource} to spring property sources from a S3 bucket 
+ * For use with the {@link S3PropertiesLocation} annotation. 
+ * 
+ * @author Eric Dallo
+ * @since 2.0
+ * @see S3PropertiesLocation
+ * @see S3PropertySource
+ */
+class S3PropertiesSourceConfigurer implements EnvironmentAware, BeanFactoryPostProcessor, PriorityOrdered {
+
+	private static final Logger LOGGER = LoggerFactory.getLogger(S3PropertiesSourceConfigurer.class);
+	
+	private Environment environment;
+	private S3ResourceLoader s3ResourceLoader;
+	private String[] s3Locations;
+
+	public void setS3ResourceLoader(S3ResourceLoader s3ResourceLoader) {
+		this.s3ResourceLoader = s3ResourceLoader;
+	}
+	
+	public void setS3Locations(String[] s3Locations) {
+		this.s3Locations = s3Locations;
+	}
+	
+	@Override
+	public void setEnvironment(Environment environment) {
+		this.environment = environment;
+	}
+	
+	@Override
+	public int getOrder() {
+		return Ordered.HIGHEST_PRECEDENCE;
+	}
+	
+	@Override
+	public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
+		if (this.environment instanceof ConfigurableEnvironment) {
+			
+			PropertiesFactoryBean propertiesFactory = new PropertiesFactoryBean();
+			MutablePropertySources propertySources = ((ConfigurableEnvironment) this.environment).getPropertySources();
+			
+			for (String s3Location : s3Locations) {
+				
+				propertiesFactory.setLocation(s3ResourceLoader.getResource(s3Location));
+				try {
+					propertiesFactory.afterPropertiesSet();
+					propertySources.addFirst(new S3PropertySource(propertiesFactory.getObject()));
+				} catch (IOException e) {
+					LOGGER.error("Could not read properties from s3Location: " + s3Location, e);
+				}
+			}
+			
+		} else {
+			LOGGER.warn("Environment is not of type '{}' property source with instance data is not available", ConfigurableEnvironment.class.getName());
+		}
+	}
+
+}

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

@@ -0,0 +1,22 @@
+package com.spring.loader;
+
+import java.util.Properties;
+
+import org.springframework.core.env.PropertySource;
+
+class S3PropertySource extends PropertySource<Object> {
+	
+	private static final String S3_PROPERTY_SOURCE_NAME = "s3PropertySource";
+
+	private final Properties properties;
+
+	S3PropertySource (Properties properties) {
+		super(S3_PROPERTY_SOURCE_NAME);
+		this.properties = properties;
+	}
+
+	@Override
+	public Object getProperty(String name) {
+		return properties.get(name); 
+	}
+}

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

@@ -16,7 +16,7 @@
  * 
  * @author Eric Dallo
  * @since 1.0.0
- * @see S3PropertyPlaceholderConfigurer
+ * @see S3PropertySource
  */
 class S3ResourceLoader implements ResourceLoader {
 

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

@@ -0,0 +1,42 @@
+package com.spring.loader;
+
+import static java.lang.String.format;
+import static org.springframework.util.StringUtils.isEmpty;
+
+import com.spring.loader.exception.EnviromentPropertyNotFoundException;
+import com.spring.loader.exception.InvalidS3LocationException;
+
+/**
+ * Resolver for properties that will be retrieved from system environment. 
+ * 
+ * @author Eric Dallo
+ * @since 2.0
+ */
+public class SystemPropertyResolver {
+
+	private static final String SYSTEM_NOTATION_PREFIX = "${";
+	private static final String SYSTEM_NOTATION_SUFIX = "}";
+
+	public String getFormattedValue(String value) {
+		if (isEmpty(value)) {
+			throw new InvalidS3LocationException("The location cannot be empty or null");
+		}
+		if (value.startsWith(SYSTEM_NOTATION_PREFIX)) {
+			
+			if (value.endsWith(SYSTEM_NOTATION_SUFIX)) {
+				String rawProperty = value.substring(SYSTEM_NOTATION_PREFIX.length(), value.length() - SYSTEM_NOTATION_SUFIX.length());
+				String valueFromEnv = System.getenv(rawProperty);
+				
+				if (isEmpty(valueFromEnv)) {
+					throw new EnviromentPropertyNotFoundException(format("Enviroment variable %s not found in system", rawProperty));
+				}
+				
+				return valueFromEnv;
+			}
+			throw new InvalidS3LocationException("Syntax error for system property: " + value);
+		}
+		
+		return value;
+	}
+
+}

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

@@ -0,0 +1,10 @@
+package com.spring.loader.exception;
+
+public class EnviromentPropertyNotFoundException extends S3ResourceException {
+	private static final long serialVersionUID = -3434756303367606716L;
+
+	public EnviromentPropertyNotFoundException(String message) {
+		super(message);
+	}
+
+}