Add Control Loop Coordination policy.

Refactor code to support multiple pip engines.
Add pip engine for outcome.
Modify LegacyGuardTranslator to use coordination translator's
convertPolicy function when processing coordination guard.
This version of convertPolicy intentionally uses string
replacement on template-like xacml coordination guard to
enable future support for API-based creation of new coordination
guard types.
Bug fixes and code cleanup.

* Unused imports, sonar problems.
* Consolidation of getAttribute method
* Only use TypedQuery for Pips

Issue-ID: POLICY-1471
Change-Id: I4e9365b7f23bee96cf438dad44feda97c65f6ecc
Signed-off-by: Joshua Reich <jreich@research.att.com>
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

4 files changed, 223 insertions, 41 deletions

diff --git a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapOperationsHistoryPipEngineTest.java b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/operationshistory/CountRecentOperationsPipTest.java
index 97b034f8..10b9d899 100644
--- a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/OnapOperationsHistoryPipEngineTest.java
+++ b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/operationshistory/CountRecentOperationsPipTest.java
@@ -16,7 +16,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.policy.pdp.xacml.application.common;
+package org.onap.policy.pdp.xacml.application.common.operationshistory;
 
 import static org.junit.Assert.assertEquals;
 
@@ -24,6 +24,7 @@ import java.io.FileInputStream;
 import java.lang.reflect.Method;
 import java.sql.Date;
 import java.time.Instant;
+
 import java.util.Properties;
 import java.util.UUID;
 
@@ -37,9 +38,9 @@ import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class OnapOperationsHistoryPipEngineTest {
-    private static final Logger LOGGER = LoggerFactory.getLogger(OnapOperationsHistoryPipEngineTest.class);
-    private static OnapOperationsHistoryPipEngine pipEngine;
+public class CountRecentOperationsPipTest {
+    private static final Logger LOGGER = LoggerFactory.getLogger(CountRecentOperationsPipTest.class);
+    private static CountRecentOperationsPip pipEngine;
 
     private static EntityManager em;
 
@@ -50,12 +51,12 @@ public class OnapOperationsHistoryPipEngineTest {
      * @throws Exception connectivity issues
      */
     @BeforeClass
-    public static void setUp() throws Exception {
+    public static void setup() throws Exception {
         LOGGER.info("Setting up PIP Testing");
         //
         // Create instance
         //
-        pipEngine = new OnapOperationsHistoryPipEngine();
+        pipEngine = new CountRecentOperationsPip();
         //
         // Load our test properties to use
         //
@@ -68,10 +69,13 @@ public class OnapOperationsHistoryPipEngineTest {
         //
         pipEngine.configure("issuer", properties);
         LOGGER.info("PIP configured now creating our entity manager");
+        LOGGER.info("properties {}", properties);
         //
         // Connect to in-mem db
         //
-        em = Persistence.createEntityManagerFactory(properties.getProperty("historydb.persistenceunit"), properties)
+        String persistenceUnit = CountRecentOperationsPip.ISSUER_NAME + ".persistenceunit";
+        LOGGER.info("persistenceunit {}", persistenceUnit);
+        em = Persistence.createEntityManagerFactory(properties.getProperty(persistenceUnit), properties)
                 .createEntityManager();
         //
         //
@@ -79,57 +83,78 @@ public class OnapOperationsHistoryPipEngineTest {
         LOGGER.info("Configured own entity manager", em.toString());
     }
 
-    /**
-     * Close the entity manager.
-     */
-    @AfterClass
-    public static void tearDown() {
-        if (em != null) {
-            em.close();
-        }
-    }
-
-    @Test
-    public void testGetCountFromDb() throws Exception {
-
-        // Add an entry
-        OnapOperationsHistoryDbao newEntry = new OnapOperationsHistoryDbao();
+    private Dbao createEntry(String cl, String target, String outcome) {
+        //
+        // Create entry
+        //
+        Dbao newEntry = new Dbao();
+        newEntry.setClosedLoopName(cl);
+        newEntry.setTarget(target);
+        newEntry.setOutcome(outcome);
         newEntry.setActor("Controller");
         newEntry.setOperation("operationA");
-        newEntry.setClName("cl-foobar-1");
-        newEntry.setOutcome("SUCCESS");
         newEntry.setStarttime(Date.from(Instant.now().minusMillis(20000)));
         newEntry.setEndtime(Date.from(Instant.now()));
         newEntry.setRequestId(UUID.randomUUID().toString());
-        newEntry.setTarget("vnf-1");
+        return newEntry;
+    }
 
+    @Test
+    public void testGetCountFromDb() throws Exception {
+        //
         // Use reflection to run getCountFromDB
-        Method method = OnapOperationsHistoryPipEngine.class.getDeclaredMethod("doDatabaseQuery",
+        //
+        Method method = CountRecentOperationsPip.class.getDeclaredMethod("doDatabaseQuery",
                                                                             String.class,
                                                                             String.class,
                                                                             String.class,
                                                                             int.class,
                                                                             String.class);
         method.setAccessible(true);
-        int count = (int) method.invoke(pipEngine, newEntry.getActor(), newEntry.getOperation(), newEntry.getTarget(),
+        //
+        // create entry
+        //
+        Dbao newEntry = createEntry("cl-foobar-1", "vnf-1", "SUCCESS");
+        //
+        // Test pipEngine
+        //
+        long count = (long) method.invoke(pipEngine, newEntry.getActor(), newEntry.getOperation(), newEntry.getTarget(),
                 1, "HOUR");
-
+        //
         // No entries yet
+        //
         assertEquals(0, count);
-
-
+        //
+        // Add entry
+        //
         em.getTransaction().begin();
         em.persist(newEntry);
         em.getTransaction().commit();
-
+        //
+        // Directly check ground truth
+        //
         Query queryCount = em.createNativeQuery("select count(*) as numops from operationshistory")
                 .setParameter(1, 1);
         LOGGER.info("{} entries", queryCount.getSingleResult());
-
-        count = (int) method.invoke(pipEngine, newEntry.getActor(), newEntry.getOperation(), newEntry.getTarget(),
+        //
+        // Test pipEngine
+        //
+        count = (long) method.invoke(pipEngine, newEntry.getActor(), newEntry.getOperation(), newEntry.getTarget(),
                 1, "HOUR");
+        //
         // Should count 1 entry now
+        //
         assertEquals(1, count);
     }
 
+    /**
+     * Close the entity manager.
+     */
+    @AfterClass
+    public static void cleanup() {
+        if (em != null) {
+            em.close();
+        }
+    }
+
 }
diff --git a/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/operationshistory/GetOperationOutcomePipTest.java b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/operationshistory/GetOperationOutcomePipTest.java
new file mode 100644
index 00000000..037f49a4
--- /dev/null
+++ b/applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/operationshistory/GetOperationOutcomePipTest.java
@@ -0,0 +1,156 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2019 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.onap.policy.pdp.xacml.application.common.operationshistory;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.FileInputStream;
+import java.lang.reflect.Method;
+import java.sql.Date;
+import java.time.Instant;
+import java.util.Properties;
+import java.util.UUID;
+
+import javax.persistence.EntityManager;
+import javax.persistence.Persistence;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class GetOperationOutcomePipTest {
+    private static final Logger LOGGER = LoggerFactory.getLogger(GetOperationOutcomePipTest.class);
+    private static GetOperationOutcomePip pipEngine;
+
+    private static EntityManager em;
+
+    /**
+     * Create an instance of our engine and also the persistence
+     * factory.
+     *
+     * @throws Exception connectivity issues
+     */
+    @BeforeClass
+    public static void setup() throws Exception {
+        LOGGER.info("Setting up PIP Testing");
+        //
+        // Create instance
+        //
+        pipEngine = new GetOperationOutcomePip();
+        //
+        // Load our test properties to use
+        //
+        Properties properties = new Properties();
+        try (FileInputStream is = new FileInputStream("src/test/resources/test.properties")) {
+            properties.load(is);
+        }
+        //
+        // Configure it using properties
+        //
+        pipEngine.configure("issuer", properties);
+        LOGGER.info("PIP configured now creating our entity manager");
+        LOGGER.info("properties {}", properties);
+        //
+        // Connect to in-mem db
+        //
+        String persistenceUnit = GetOperationOutcomePip.ISSUER_NAME + ".persistenceunit";
+        LOGGER.info("persistenceunit {}", persistenceUnit);
+        em = Persistence.createEntityManagerFactory(properties.getProperty(persistenceUnit), properties)
+            .createEntityManager();
+        //
+        //
+        //
+        LOGGER.info("Configured own entity manager", em.toString());
+    }
+
+    private void insertEntry(String cl, String target, String outcome) {
+        //
+        // Create entry
+        //
+        Dbao newEntry = new Dbao();
+        newEntry.setClosedLoopName(cl);
+        newEntry.setTarget(target);
+        newEntry.setOutcome(outcome);
+        newEntry.setActor("Controller");
+        newEntry.setOperation("operationA");
+        newEntry.setStarttime(Date.from(Instant.now().minusMillis(20000)));
+        newEntry.setEndtime(Date.from(Instant.now()));
+        newEntry.setRequestId(UUID.randomUUID().toString());
+        //
+        // Add entry
+        //
+        em.getTransaction().begin();
+        em.persist(newEntry);
+        em.getTransaction().commit();
+    }
+
+
+    @Test
+    public void testGetOutcomeFromDb() throws Exception {
+        //
+        // Use reflection to run getCountFromDB
+        //
+        Method method = GetOperationOutcomePip.class.getDeclaredMethod("doDatabaseQuery",
+                                                                       String.class,
+                                                                       String.class);
+        method.setAccessible(true);
+        //
+        // Insert entry
+        //
+        insertEntry("testcl1", "testtarget1", "1");
+        //
+        // Test pipEngine
+        //
+        String outcome = (String) method.invoke(pipEngine, "testcl1", "testtarget1");
+        //
+        // outcome should be "1"
+        //
+        assertEquals("1", outcome);
+        //
+        // Insert more entries
+        //
+        insertEntry("testcl1", "testtarget1", "2");
+        insertEntry("testcl2", "testtarget2", "3");
+        insertEntry("testcl1", "testtarget2", "4");
+        //
+        // Test pipEngine
+        //
+        outcome = (String) method.invoke(pipEngine, "testcl1", "testtarget1");
+        assertEquals("2", outcome);
+
+        outcome = (String) method.invoke(pipEngine, "testcl2", "testtarget2");
+        assertEquals("3", outcome);
+
+        outcome = (String) method.invoke(pipEngine, "testcl1", "testtarget2");
+        assertEquals("4", outcome);
+    }
+
+    /**
+     * Close the entity manager.
+     */
+    @AfterClass
+    public static void cleanup() {
+        if (em != null) {
+            em.close();
+        }
+    }
+
+}
diff --git a/applications/common/src/test/resources/META-INF/persistence.xml b/applications/common/src/test/resources/META-INF/persistence.xml
index 09c76c56..65ecc624 100644
--- a/applications/common/src/test/resources/META-INF/persistence.xml
+++ b/applications/common/src/test/resources/META-INF/persistence.xml
@@ -8,9 +8,9 @@
   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.
@@ -23,12 +23,13 @@
 
     <persistence-unit name="PipEngineTest" transaction-type="RESOURCE_LOCAL">
         <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
-        
-        <class>org.onap.policy.pdp.xacml.application.common.OnapOperationsHistoryDbao</class>
-        
+
+        <class>org.onap.policy.pdp.xacml.application.common.operationshistory.Dbao</class>
+
         <properties>
             <property name="eclipselink.ddl-generation" value="create-tables" />
             <property name="eclipselink.logging.level" value="FINE" />
+	    <property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect"/>
             <property name="javax.persistence.jdbc.driver" value="org.h2.Driver" />
             <property name="javax.persistence.jdbc.url" value="jdbc:h2:mem:testdb;DATABASE_TO_UPPER=FALSE" />
             <property name="javax.persistence.jdbc.user" value="policy" />
@@ -39,4 +40,3 @@
     </persistence-unit>
 
 </persistence>
-  
\ No newline at end of file
diff --git a/applications/common/src/test/resources/test.properties b/applications/common/src/test/resources/test.properties
index f326dc2a..fb3d3ce5 100644
--- a/applications/common/src/test/resources/test.properties
+++ b/applications/common/src/test/resources/test.properties
@@ -20,7 +20,7 @@ xacml.att.functionDefinitionFactory=com.att.research.xacmlatt.pdp.std.StdFunctio
 xacml.att.policyFinderFactory=org.onap.policy.pdp.xacml.application.common.OnapPolicyFinderFactory
 
 #
-# 
+#
 #
 xacml.rootPolicies=rootstart
 rootstart.file=src/test/resources/root.xml
@@ -34,4 +34,5 @@ refstart4.file=src/test/resources/ref4.xml
 #
 # Database persistence for PIP
 #
-historydb.persistenceunit=PipEngineTest
+count-recent-operations.persistenceunit=PipEngineTest
+get-operation-outcome.persistenceunit=PipEngineTest