Cleanup PIP/Database-related code.

Ensure database schema/naming consistent across repos.
Ensure PIP implementation consistent across repos.
Cleanup unused imports and made sure licenses are ok.

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

4 files changed, 394 insertions, 0 deletions

diff --git a/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/CountRecentOperationsPipTest.java b/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/CountRecentOperationsPipTest.java
new file mode 100644
index 000000000..e3cb17fd5
--- /dev/null
+++ b/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/CountRecentOperationsPipTest.java
@@ -0,0 +1,160 @@
+/*-
+ * ============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.database.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 javax.persistence.Query;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CountRecentOperationsPipTest {
+    private static final Logger LOGGER = LoggerFactory.getLogger(CountRecentOperationsPipTest.class);
+    private static CountRecentOperationsPip 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 CountRecentOperationsPip();
+        //
+        // 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 = CountRecentOperationsPip.ISSUER_NAME + ".persistenceunit";
+        LOGGER.info("persistenceunit {}", persistenceUnit);
+        em = Persistence.createEntityManagerFactory(properties.getProperty(persistenceUnit), properties)
+                .createEntityManager();
+        //
+        //
+        //
+        LOGGER.info("Configured own entity manager", em.toString());
+    }
+
+    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.setStarttime(Date.from(Instant.now().minusMillis(20000)));
+        newEntry.setEndtime(Date.from(Instant.now()));
+        newEntry.setRequestId(UUID.randomUUID().toString());
+        return newEntry;
+    }
+
+    @Test
+    public void testGetCountFromDb() throws Exception {
+        //
+        // Use reflection to run getCountFromDB
+        //
+        Method method = CountRecentOperationsPip.class.getDeclaredMethod("doDatabaseQuery",
+                                                                            String.class,
+                                                                            String.class,
+                                                                            String.class,
+                                                                            int.class,
+                                                                            String.class);
+        method.setAccessible(true);
+        //
+        // create entry
+        //
+        Dbao newEntry = createEntry("cl-foobar-1", "vnf-1", "SUCCESS");
+        //
+        // Test pipEngine
+        //
+        int count = (int) 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());
+        //
+        // Test pipEngine
+        //
+        count = (int) 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/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/GetOperationOutcomePipTest.java b/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/GetOperationOutcomePipTest.java
new file mode 100644
index 000000000..7e7258c5f
--- /dev/null
+++ b/controlloop/common/database/src/test/java/org/onap/policy/database/operationshistory/GetOperationOutcomePipTest.java
@@ -0,0 +1,154 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2018-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.database.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/controlloop/common/database/src/test/resources/META-INF/persistence.xml b/controlloop/common/database/src/test/resources/META-INF/persistence.xml
new file mode 100644
index 000000000..0c49d94e2
--- /dev/null
+++ b/controlloop/common/database/src/test/resources/META-INF/persistence.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ============LICENSE_START=======================================================
+  ONAP
+  ================================================================================
+  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=========================================================
+  -->
+
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence persistence_1_0.xsd" version="1.0">
+
+    <persistence-unit name="PipEngineTest" transaction-type="RESOURCE_LOCAL">
+        <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
+
+        <class>org.onap.policy.database.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" />
+            <property name="javax.persistence.jdbc.password" value="P01icY" />
+            <property name="javax.persistence.schema-generation.database.action" value="drop-and-create"/>
+            <property name="javax.persistence.schema-generation.create-source" value="metadata"/>
+        </properties>
+    </persistence-unit>
+
+</persistence>
diff --git a/controlloop/common/database/src/test/resources/test.properties b/controlloop/common/database/src/test/resources/test.properties
new file mode 100644
index 000000000..fb3d3ce53
--- /dev/null
+++ b/controlloop/common/database/src/test/resources/test.properties
@@ -0,0 +1,38 @@
+#
+# Properties that the embedded PDP engine uses to configure and load
+#
+# Standard API Factories
+#
+xacml.dataTypeFactory=com.att.research.xacml.std.StdDataTypeFactory
+xacml.pdpEngineFactory=com.att.research.xacmlatt.pdp.ATTPDPEngineFactory
+xacml.pepEngineFactory=com.att.research.xacml.std.pep.StdEngineFactory
+xacml.pipFinderFactory=com.att.research.xacml.std.pip.StdPIPFinderFactory
+xacml.traceEngineFactory=com.att.research.xacml.std.trace.LoggingTraceEngineFactory
+#
+# AT&T PDP Implementation Factories
+#
+xacml.att.evaluationContextFactory=com.att.research.xacmlatt.pdp.std.StdEvaluationContextFactory
+xacml.att.combiningAlgorithmFactory=com.att.research.xacmlatt.pdp.std.StdCombiningAlgorithmFactory
+xacml.att.functionDefinitionFactory=com.att.research.xacmlatt.pdp.std.StdFunctionDefinitionFactory
+#
+# ONAP PDP Implementation Factories
+#
+xacml.att.policyFinderFactory=org.onap.policy.pdp.xacml.application.common.OnapPolicyFinderFactory
+
+#
+#
+#
+xacml.rootPolicies=rootstart
+rootstart.file=src/test/resources/root.xml
+
+xacml.referencedPolicies=refstart1,refstart2,refstart3,refstart4
+refstart1.file=src/test/resources/ref1.xml
+refstart2.file=src/test/resources/ref2.xml
+refstart3.file=src/test/resources/ref3.xml
+refstart4.file=src/test/resources/ref4.xml
+
+#
+# Database persistence for PIP
+#
+count-recent-operations.persistenceunit=PipEngineTest
+get-operation-outcome.persistenceunit=PipEngineTest