Merge pull request #21 from BorderTech/fix-qa

Fix qa

Author: jonathanaustin

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

@@ -160,8 +160,7 @@ public static void notifyListeners() {
 		// If we get here, then there is at least one listener who wants to be notified when a refresh occurs. The first
 		// step in this notification process is to create the PropertyChangeEvent object that will be sent to each of
 		// the registered PropertyChangeListeners.
-		//
-		// PropertyChangeEvent event = new PropertyChangeEvent(this, "propertiesRefresh", null, null);
+		// <code>PropertyChangeEvent event = new PropertyChangeEvent(this, "propertiesRefresh", null, null);</code>
 		//
 		// Finally, iterate through the complete set of PropertyChangeListeners and notify them that a change has
 		// occurred.

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

@@ -14,9 +14,11 @@
 import java.nio.charset.StandardCharsets;
 import java.security.CodeSource;
 import java.security.ProtectionDomain;
+import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.Deque;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -26,7 +28,6 @@
 import java.util.Objects;
 import java.util.Properties;
 import java.util.Set;
-import java.util.Stack;
 import java.util.StringTokenizer;
 import java.util.TreeSet;
 import org.apache.commons.configuration.Configuration;
@@ -141,7 +142,7 @@ public class DefaultConfiguration implements Configuration {
 	/**
 	 * The resource being loaded. This is used for the relative form of resource loading.
 	 */
-	private final Stack<String> resources = new Stack<>();
+	private final Deque<String> resources = new ArrayDeque<>();
 
 	/**
 	 * A generic object that allows us to synchronized refreshes. Required so that gets and refreshes are threadsafe

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

@@ -15,7 +15,7 @@ public class Touchfile {
 	/**
 	 * The touch file.
 	 */
-	private final File touchfile;
+	private final File file;
 
 	/**
 	 * Check interval in milli seconds.
@@ -41,10 +41,10 @@ public Touchfile(final String filename, final long checkInterval) {
 			throw new IllegalArgumentException("A touch filename must be provided.");
 		}
 		this.filename = filename;
-		this.touchfile = new File(filename);
+		this.file = new File(filename);
 		this.checkInterval = checkInterval < 0 ? 0 : checkInterval;
 		this.lastChecked = System.currentTimeMillis();
-		this.lastModified = touchfile.lastModified();
+		this.lastModified = file.lastModified();
 	}
 
 	/**
@@ -61,7 +61,7 @@ public boolean hasChanged() {
 		lastChecked = now;
 
 		// Has the file changed?
-		long modified = touchfile.lastModified();
+		long modified = file.lastModified();
 		if (lastModified == modified) {
 			// No Change
 			return false;

src/test/java/com/github/bordertech/config/DefaultConfigurationDumpTest.java

@@ -0,0 +1,58 @@
+package com.github.bordertech.config;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * DefaultConfigurationDumpTest - JUnit tests for {@link DefaultConfiguration}.
+ */
+public class DefaultConfigurationDumpTest {
+
+	private PrintStream original;
+	private ByteArrayOutputStream systemErr;
+
+	private static final String LOG_START = "Properties loaded start";
+	private static final String LOG_END = "Properties loaded end";
+	private static final String LOG_PARAM = "simple.param1";
+
+	@Before
+	public void redirectSystemOutStream() {
+		original = System.err;
+		systemErr = new ByteArrayOutputStream();
+		System.setErr(new PrintStream(systemErr));
+	}
+
+	@After
+	public void restoreSystemOutStream() {
+		System.setErr(original);
+	}
+
+	@Test
+	public void dumpParametersEnabled() {
+		DefaultConfiguration config = new DefaultConfiguration(
+				"com/github/bordertech/config/DefaultConfigurationTestDumpEnabled.properties");
+		// Check dump enabled
+		Assert.assertTrue(config.getBoolean(DefaultConfiguration.DUMP));
+		String log = systemErr.toString();
+		Assert.assertTrue("Output should contain dump start load", log.contains(LOG_START));
+		Assert.assertTrue("Output should contain dump start end", log.contains(LOG_END));
+		Assert.assertTrue("Output should contain property", log.contains(LOG_PARAM));
+	}
+
+	@Test
+	public void dumpParametersDisabled() {
+		DefaultConfiguration config = new DefaultConfiguration(
+				"com/github/bordertech/config/DefaultConfigurationTestDumpDisabled.properties");
+		// Check dump disabled
+		Assert.assertFalse(config.getBoolean(DefaultConfiguration.DUMP));
+		String log = systemErr.toString();
+		Assert.assertFalse("Output should not contain dump start load", log.contains(LOG_START));
+		Assert.assertFalse("Output should not contain dump start end", log.contains(LOG_END));
+		Assert.assertFalse("Output should not contain property", log.contains(LOG_PARAM));
+	}
+
+}

src/test/java/com/github/bordertech/config/DefaultConfigurationTest.java

@@ -347,6 +347,17 @@ public void testGetProperties() {
 		assertPropertyEquals("key3", "value3", props);
 	}
 
+	@Test
+	public void testRefresh() {
+		String orig = "simplePropertyValue";
+		String newValue = "newvalue";
+		assertPropertyEquals(STRING_PROPERTY_KEY, orig);
+		config.setProperty(STRING_PROPERTY_KEY, newValue);
+		assertPropertyEquals(STRING_PROPERTY_KEY, newValue);
+		config.refresh();
+		assertPropertyEquals(STRING_PROPERTY_KEY, orig);
+	}
+
 	/**
 	 * Asserts that the configuration contains the given key/value.
 	 *

src/test/resources/com/github/bordertech/config/DefaultConfigurationTestDumpDisabled.properties

@@ -0,0 +1,15 @@
+############################################################################
+# This property file is for the DefaultConfiguration_Test jUnit test
+# It must not be included or be included by property file that is not
+# directly related to the test.
+############################################################################
+
+# -------------------------------------------------------------------------------------------------
+# Simple property tests
+# -------------------------------------------------------------------------------------------------
+simple.param1=A
+simple.param2=B
+simple.param3=C
+
+## Do not dump parameters
+bordertech.config.parameters.dump.console=false

src/test/resources/com/github/bordertech/config/DefaultConfigurationTestDumpEnabled.properties

@@ -0,0 +1,15 @@
+############################################################################
+# This property file is for the DefaultConfiguration_Test jUnit test
+# It must not be included or be included by property file that is not
+# directly related to the test.
+############################################################################
+
+# -------------------------------------------------------------------------------------------------
+# Simple property tests
+# -------------------------------------------------------------------------------------------------
+simple.param1=A
+simple.param2=B
+simple.param3=C
+
+## Dump parameters
+bordertech.config.parameters.dump.console=true