Initial OpenECOMP policy/drools-pdp commit

Change-Id: I0072ccab6f40ed32da39667f9f8523b6d6dad2e2
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

2 files changed, 230 insertions, 0 deletions

diff --git a/policy-utils/src/test/java/org/openecomp/policy/drools/utils/PropertyUtilTest.java b/policy-utils/src/test/java/org/openecomp/policy/drools/utils/PropertyUtilTest.java
new file mode 100644
index 00000000..55091718
--- /dev/null
+++ b/policy-utils/src/test/java/org/openecomp/policy/drools/utils/PropertyUtilTest.java
@@ -0,0 +1,204 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * policy-utils
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.policy.drools.utils;
+
+import static org.junit.Assert.*;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Properties;
+import java.util.Set;
+import java.util.TreeSet;
+import java.util.UUID;
+
+import org.apache.log4j.Logger;
+
+import org.openecomp.policy.common.logging.eelf.PolicyLogger;
+
+public class PropertyUtilTest
+{
+ // private static final Logger PolicyLogger =
+//	Logger.getLogger(PropertyUtilTest.class.getName());
+
+  private static File directory = null;
+
+  /**
+   * Test Setup -- Create a directory for temporary files
+   */
+  @BeforeClass
+	static public void setup()
+  {
+	PolicyLogger.info("setup: creating a temporary directory");
+
+	// create a directory for temporary files
+	directory = new File(UUID.randomUUID().toString());
+	directory.mkdir();
+  }
+
+  /**
+   * Test Cleanup -- Remove temporary files
+   */
+  @AfterClass
+	static public void teardown()
+  {
+	PolicyLogger.info("teardown: remove the temporary directory");
+
+	// the assumption is that we only have one level of temporary files
+	for (File file : directory.listFiles())
+	  {
+		file.delete();
+	  }
+	directory.delete();
+  }
+
+  /**
+   * Utility method to write a properties file
+   *
+   * @param name the file name, relative to the temporary directory
+   * @param the properties to store in the file
+   * @return a File instance associated with the newly-created file
+   * @throws IOException if the file can't be created for some reason
+   */
+  File createFile(String name, Properties p) throws IOException
+  {
+	File file = new File(directory, name);
+	FileOutputStream fos = new FileOutputStream(file);
+	try
+	  {
+		p.store(fos, "Property file '" + name + "'");
+	  }
+	finally
+	  {
+		fos.close();
+	  }
+	return(file);
+  }
+
+  /**
+   * Create a 'PropertyUtil.Listener' subclass, which receives property
+   * file updates. It stores the latest values in an array, and notifies
+   * any thread waiting on this array.
+   *
+   * @param returns this is an array of length 2 -- the first entry will
+   *	contain the 'properties' value, and the second will contain
+   *	'changedKeys'. It is also used to signal any waiting thread
+   *	using 'returns.notifyAll()'.
+   */
+  PropertyUtil.Listener createListenerThread(final Object[] returns)
+  {
+	return(new PropertyUtil.Listener()
+	  {
+		public void propertiesChanged
+		  (Properties properties, Set<String> changedKeys)
+		{
+		  // When a notification is received, store the values in the
+		  // 'returns' array, and signal using the same array.
+		  PolicyLogger.info("Listener invoked: properties=" + properties
+					  + ", changedKeys=" + changedKeys);
+		  returns[0] = properties;
+		  returns[1] = changedKeys;
+		  synchronized(returns)
+			{
+			  returns.notifyAll();
+			}
+		}
+	  });
+  }
+
+  /**
+   * Test the basic properties file interface.
+   */
+  @Test
+	public void testGetProperties() throws Exception
+  {
+	PolicyLogger.info("testGetProperties: test the basic properties file interface");
+
+	// copy system properties
+	PolicyLogger.info("Copy system properties to a file");
+	Properties prop1 = System.getProperties();
+	File file1 = createFile("createAndReadPropertyFile-1", prop1);
+
+	// read in properties, and compare
+	PolicyLogger.info("Read in properties from new file");
+	Properties prop2 = PropertyUtil.getProperties(file1);
+
+	// they should match
+	assertEquals(prop1, prop2);
+  }
+
+  /**
+   * This tests the 'PropertyUtil.Listener' interface.
+   */
+  @Test
+	public void testListenerInterface() throws Exception
+  {
+	PolicyLogger.info("testListenerInterface: test receipt of dynamic updates");
+
+	// create initial property file
+	Properties prop1 = new Properties();
+	prop1.setProperty("p1", "p1 value");
+	prop1.setProperty("p2", "p2 value");
+	prop1.setProperty("p3", "p3 value");
+	PolicyLogger.info("Create initial properties file: " + prop1);
+	File file1 = createFile("createAndReadPropertyFile-2", prop1);
+
+	// create a listener for the notification interface
+	Object[] returns = new Object[2];
+	PropertyUtil.Listener listener = createListenerThread(returns);
+
+	// read it in, and do a comparison
+	Properties prop2 = PropertyUtil.getProperties(file1, listener);
+	PolicyLogger.info("Read in properties: " + prop2);
+	assertEquals(prop1, prop2);
+	assertEquals(prop2.getProperty("p1"), "p1 value");
+	assertEquals(prop2.getProperty("p2"), "p2 value");
+	assertEquals(prop2.getProperty("p3"), "p3 value");
+
+	// make some changes, and update the file (p3 is left unchanged)
+	prop2.remove("p1");		// remove one property
+	prop2.setProperty("p2", "new p2 value");	// change one property
+	prop2.setProperty("p4", "p4 value");		// add a new property
+	PolicyLogger.info("Modified properties: " + prop2);
+
+	// now, update the file, and wait for notification
+	synchronized(returns)
+	  {
+		createFile("createAndReadPropertyFile-2", prop2);
+
+		// wait up to 60 seconds, although we should receive notification
+		// in 10 seconds or less (if things are working)
+		returns.wait(60000L);
+	  }
+
+	// verify we have the updates
+	assertEquals(prop2, returns[0]);
+
+	// verify that we have the expected set of keys
+	assertEquals(new TreeSet(Arrays.asList(new String[]{"p1", "p2", "p4"})),
+				 returns[1]);
+  }
+}
diff --git a/policy-utils/src/test/resources/log4j.properties b/policy-utils/src/test/resources/log4j.properties
new file mode 100644
index 00000000..0063f104
--- /dev/null
+++ b/policy-utils/src/test/resources/log4j.properties
@@ -0,0 +1,26 @@
+###
+# ============LICENSE_START=======================================================
+# policy-utils
+# ================================================================================
+# Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# 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.
+# ============LICENSE_END=========================================================
+###
+
+log4j.rootLogger=INFO, out
+
+# CONSOLE appender not used by default
+log4j.appender.out=org.apache.log4j.ConsoleAppender
+log4j.appender.out.layout=org.apache.log4j.PatternLayout
+log4j.appender.out.layout.ConversionPattern=%d %-5p %-30.30c{1} %4L - %m%n