Merge pull request #39 from mccabd/feature/issue37-Refactor

Refactor with Unit Tests and increase coverage

Author: jonathanaustin

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Release in-progress
 
+## 1.0.7
+
+### API Changes
+* Introduction of profile property `bordertech.config.profile` to replace environment property.
+
+### Enhancements
+* Refactor of substitution code to use apache commons text
+* includes can define substitution variables e.g. `include=${previously.defined.property.key}/special-file.properties`
+* Increase in unit tests and code coverage. 
+
 ## 1.0.6
 
 ### API Changes

README.md

@@ -10,7 +10,6 @@
 [![Maven Central](https://img.shields.io/maven-central/v/com.github.bordertech.config/config.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.bordertech.config%22%20AND%20a:%22config%22)
 
 ## Content
-
 - [What is Config](#what-is-config)
 - [Why use Config](#why-use-config)
 - [Getting started](#getting-started)
@@ -29,7 +28,6 @@ The [features](#features) of the [Default Configuration](https://github.com/Bord
 Projects can easily override this default implementation via the [configuration](#configuration) settings.
 
 ## Getting started
-
 Add dependency:
 
 ``` xml
@@ -62,8 +60,7 @@ my.example=a-override-value
 ## Features
 
 ### Predefined property resources
-
-The default implementation looks for the following resources:
+The default implementation looks for the following resources either as a classpath resource or a URL:
 
  - `bordertech-defaults.properties` - framework defaults
  - `bordertech-app.properties` - application properties
@@ -76,29 +73,61 @@ The priority of the properties is in reverse order to the list of resources (i.e
 The resources loaded into the Configuration can be overridden via [configuration](#configuration) settings.
 
 ### Include resources
-
-Other property files can be included from the predefined property files:
+Other property files can be included from other predefined property files.
+If the "include" property is defined, it is treated as a (comma-separated) list of additional resources (classpath resource or a URL) 
+to load that are processed immediately within the current resource being loaded
 
 ``` java properties
-include=another.properties
+include=include_resource_1.properties[,include_resource_2.properties]
 ```
 
-### Environment Suffix
+### IncludeAfter resources
+Other property files can be included from the predefined property file after the current set has loaded.
+If this property is defined, it is treated as a (comma-separated) list of additional resources (classpath resource or a URL) 
+to load that are processed after the current (set of) resources have loaded.
+
+``` java properties
+includeAfter=include_resource_1.properties[,include_resource_2.properties]
+``` 
+
+### += Append values to predefined properties
+Config also allows for the ability to append values to properties already defined. 
+This is done using '+=' instead of '=' on a key-value pair. Suggested use case is you have a global default set and then
+you want to append application specific values to the default values for access within an application.
+ 
+ ``` java properties
+# Defined in default.properties
+already.defined.key+=value1
+
+#Defined in app.properties
+already.defined.key+=value2,value3
+``` 
+
+`Config.getInstance().get("already.defined.key")` returns `value1,value2,value3`
 
-It is possible to define properties to only take effect in a certain environment.
+### Profiles
+Profiles allow you to map properties to different profiles - for example, dev, test, prod or mock.
+We can activate these profiles in different environments to set(override) the properties we need. 
+The profile property is generally to be defined as either an OS environment variable or a JVM system property. 
+However, it can be set in a properties file which is useful in unit testing or testing on a local environment.
 
-When the runtime property `bordertech.config.environment` is set, it is used as the suffix for each property lookup:
+When a property with the key `bordertech.config.profile` is set, it is used as the suffix for each property lookup:
 
 ``` java properties
-## MOCK Environment
-bordertech.config.environment=MOCK
+## MOCK Environment set as an Environment or JVM System property only
+bordertech.config.profile=MOCK
 
 my.example.property.MOCK=mocking
 my.example.property.PROD=proding
 my.example.property=defaulting
 ```
 
-If no property exists with the current environment suffix then the default property (ie no suffix) value is used.
+The Environment Suffix `bordertech.config.environment` feature has been deprecated and will be removed in the next
+major release but is still honoured within the profile feature.
+
+The order of precedence:
+- `bordertech.config.profile` defined as a property anywhere
+- `bordertech.config.environment` defined as a property anywhere(Deprecated - to be removed next major release)
 
 ### Touchfile
 
@@ -174,7 +203,8 @@ The following methods in the `Config` class are useful for unit testing:
 
 ## Configuration
 
-The initial configuration of `Config` can be overridden by setting properties in a file `bordertech-config.properties`. The file name can be overriden via a System or Environment property `BT_CONFIG_FILE`.
+The initial configuration of `Config` can be overridden by setting properties in a file `bordertech-config.properties`. 
+The default `bordertech-config.properties` file name can also be overriden via a System or Environment property `BT_CONFIG_FILE`.
 
 The following options can be set:-
 
@@ -206,7 +236,14 @@ bordertech.config.resource.append=my-project.properties
 
 [ConfigurationLoader](https://github.com/BorderTech/java-config/blob/master/src/main/java/com/github/bordertech/config/ConfigurationLoader.java) is the [SPI](https://docs.oracle.com/javase/tutorial/sound/SPI-intro.html) interface for classes that can load a custom configuration.
 
-By default, the SPI lookup is enabled and if found, will be appended to the default implementation.
+By default, the SPI lookup is enabled and if found, it will create the custom configuration
+ 
+If the `bordertech.config.spi.append.default` is true the Default Configuration will also be appended to the configuration.
+
+### Best Practice
+
+When using java-config in a container and setting specific properties for that container instance, 
+this can be achieved by property file(s) placed in the container that can be referred to and included within the application at runtime. 
 
 ## Contributing
 

pom.xml

@@ -55,11 +55,31 @@
 			<artifactId>commons-lang3</artifactId>
 			<version>3.9</version>
 		</dependency>
+		<dependency>
+			<groupId>org.apache.commons</groupId>
+			<artifactId>commons-text</artifactId>
+			<version>1.8</version>
+		</dependency>
 		<!-- Junit -->
 		<dependency>
 			<groupId>org.junit.vintage</groupId>
 			<artifactId>junit-vintage-engine</artifactId>
 		</dependency>
+
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<version>4.0.3</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>commons-io</groupId>
+			<artifactId>commons-io</artifactId>
+			<version>2.6</version>
+			<scope>test</scope>
+		</dependency>
+
 	</dependencies>
 
 </project>

src/main/java/com/github/bordertech/config/Config.java

@@ -1,5 +1,10 @@
 package com.github.bordertech.config;
 
+import org.apache.commons.configuration.CompositeConfiguration;
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.MapConfiguration;
+import org.apache.commons.lang.StringUtils;
+
 import java.beans.PropertyChangeListener;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -8,10 +13,6 @@
 import java.util.List;
 import java.util.ServiceLoader;
 import java.util.Set;
-import org.apache.commons.configuration.CompositeConfiguration;
-import org.apache.commons.configuration.Configuration;
-import org.apache.commons.configuration.MapConfiguration;
-import org.apache.commons.lang.StringUtils;
 
 /**
  * The Config class is the central access point to the configuration mechanism, and is used to read or modify the
@@ -185,7 +186,7 @@ public static void addPropertyChangeListener(final PropertyChangeListener listen
 	 * Load the configuration.
 	 */
 	private static void loadConfiguration() {
-		Configuration config = checkSLIConfiguration();
+		Configuration config = checkSPIConfiguration();
 		if (config == null) {
 			config = getDefaultConfiguration();
 		}
@@ -221,10 +222,9 @@ private static long getTouchFileInterval() {
 	}
 
 	/**
-	 *
 	 * @return a SLI Configuration or null if none available
 	 */
-	private static Configuration checkSLIConfiguration() {
+	private static Configuration checkSPIConfiguration() {
 
 		if (!InitHelper.SPI_ENABLED) {
 			return null;