Added changes for vDNS Use Case

-Renamed remaining MSO classes and packages to SO and modified drl
accordingly
-Connected SO Interface to SO Simulator
-Added vDNS Control Loop junit
-Modified SOActorServiceProvider to reflect AAI class changes (POLICY-103)

Issue-ID: POLICY-102

Change-Id: Iea5d3f096c4ccfedde68e79d7593d66331127aaf
Signed-off-by: Hockla, Ali (ah999m) <ah999m@att.com>

5 files changed, 330 insertions, 34 deletions

diff --git a/controlloop/templates/template.demo/pom.xml b/controlloop/templates/template.demo/pom.xml
index e08174004..d3d3ef0ab 100644
--- a/controlloop/templates/template.demo/pom.xml
+++ b/controlloop/templates/template.demo/pom.xml
@@ -73,7 +73,7 @@
 		</dependency>
 		<dependency>
 			<groupId>org.onap.policy.drools-applications</groupId>
-			<artifactId>mso</artifactId>
+			<artifactId>so</artifactId>
 			<version>${project.version}</version>
 			<scope>provided</scope>
 		</dependency>
@@ -175,7 +175,7 @@
 		</dependency>
 		<dependency>
 			<groupId>org.onap.policy.drools-applications</groupId>
-			<artifactId>actor.mso</artifactId>
+			<artifactId>actor.so</artifactId>
 			<version>${project.version}</version>
 			<scope>provided</scope>
 		</dependency>
diff --git a/controlloop/templates/template.demo/src/main/resources/ControlLoop_Template_xacml_guard.drl b/controlloop/templates/template.demo/src/main/resources/ControlLoop_Template_xacml_guard.drl
index f832ea5e2..82899f08b 100644
--- a/controlloop/templates/template.demo/src/main/resources/ControlLoop_Template_xacml_guard.drl
+++ b/controlloop/templates/template.demo/src/main/resources/ControlLoop_Template_xacml_guard.drl
@@ -39,18 +39,18 @@ import org.onap.policy.appclcm.LCMResponse;
 import org.onap.policy.appclcm.LCMCommonHeader;
 import org.onap.policy.vfc.VFCRequest;
 import org.onap.policy.vfc.VFCManager;
-import org.onap.policy.mso.SOManager;
-import org.onap.policy.mso.SORequest;
-import org.onap.policy.mso.SORequestStatus;
-import org.onap.policy.mso.SORequestDetails;
-import org.onap.policy.mso.SOModelInfo;
-import org.onap.policy.mso.SOCloudConfiguration;
-import org.onap.policy.mso.SORequestInfo;
-import org.onap.policy.mso.SORequestParameters;
-import org.onap.policy.mso.SORelatedInstanceListElement;
-import org.onap.policy.mso.SORelatedInstance;
-import org.onap.policy.mso.SOResponse;
-import org.onap.policy.controlloop.actor.mso.MSOActorServiceProvider;
+import org.onap.policy.so.SOManager;
+import org.onap.policy.so.SORequest;
+import org.onap.policy.so.SORequestStatus;
+import org.onap.policy.so.SORequestDetails;
+import org.onap.policy.so.SOModelInfo;
+import org.onap.policy.so.SOCloudConfiguration;
+import org.onap.policy.so.SORequestInfo;
+import org.onap.policy.so.SORequestParameters;
+import org.onap.policy.so.SORelatedInstanceListElement;
+import org.onap.policy.so.SORelatedInstance;
+import org.onap.policy.so.SOResponse;
+import org.onap.policy.controlloop.actor.so.SOActorServiceProvider;
 import org.onap.policy.guard.PolicyGuard;
 import org.onap.policy.guard.PolicyGuard.LockResult;
 import org.onap.policy.guard.TargetLock;
@@ -517,7 +517,7 @@ rule "${policyName}.EVENT.MANAGER.OPERATION.LOCKED.GUARD_PERMITTED"
 					
 					if(request instanceof SORequest) {
 						// Call SO. The response will be inserted into memory once it's received 
-						MSOActorServiceProvider.sendRequest(drools.getWorkingMemory(), request);						
+						SOActorServiceProvider.sendRequest(drools.getWorkingMemory(), request);						
 					}
 					break;
 				case "VFC":
@@ -926,10 +926,8 @@ rule "${policyName}.SO.RESPONSE"
 		$operation : ControlLoopOperationManager( onset.closedLoopControlName == $event.closedLoopControlName, onset.requestID == $event.requestID )
 		$opTimer : OperationTimer( closedLoopControlName == $event.closedLoopControlName, requestID == $event.requestID.toString() )
         $lock : TargetLock (requestID == $event.requestID)
-		$request : SORequest( requestId == $event.requestID.toString() )
-		$response : SOResponse( request.requestId == $event.requestID.toString() )	
-	then
-		
+		$response : SOResponse( requestReferences.requestId.toString() == $event.requestID.toString() )	
+	then				
 		//
     	// Logging		
 		Logger.info("------------------------------------------------------------------------------------------------");
@@ -941,7 +939,6 @@ rule "${policyName}.SO.RESPONSE"
 		Logger.metrics($opTimer);
 		Logger.metrics($lock);
 		Logger.metrics($response);
-		
 		// Get the result of the operation
 		//
 		PolicyResult policyResult = $operation.onResponse($response);
diff --git a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/TestSO.java b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/TestSO.java
index b277b669e..16ad7a8b0 100644
--- a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/TestSO.java
+++ b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/TestSO.java
@@ -38,7 +38,6 @@ import java.util.regex.Pattern;
 
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
-import org.junit.Ignore;
 import org.junit.Test;
 import org.kie.api.KieServices;
 import org.kie.api.builder.KieBuilder;
@@ -58,7 +57,7 @@ import org.onap.policy.controlloop.impl.ControlLoopLoggerStdOutImpl;
 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
 import org.onap.policy.drools.http.server.HttpServletServer;
 import org.onap.policy.drools.impl.PolicyEngineJUnitImpl;
-import org.onap.policy.mso.util.Serialization;
+import org.onap.policy.so.util.Serialization;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -71,6 +70,7 @@ public class TestSO {
 	public static void setUpSimulator() {
 		try {
 			Util.buildAaiSim();
+			Util.buildSoSim();
 		} catch (InterruptedException e) {
 			fail(e.getMessage());
 		}
@@ -81,7 +81,6 @@ public class TestSO {
 		HttpServletServer.factory.destroy();
 	}
 	
-	@Ignore
 	@Test
 	public void testvDNS() throws IOException {
 		
@@ -192,7 +191,7 @@ public class TestSO {
 				// So no need to test it again here
 				//
 				try {
-					Thread.sleep(3000);
+					Thread.sleep(10000);
 				} catch (InterruptedException e) {
 				}
 				//
diff --git a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/Util.java b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/Util.java
index fb9f88f16..5a96e1667 100644
--- a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/Util.java
+++ b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/Util.java
@@ -35,8 +35,6 @@ import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import org.apache.commons.io.IOUtils;
-import org.yaml.snakeyaml.Yaml;
-import org.yaml.snakeyaml.constructor.Constructor;
 import org.kie.api.KieServices;
 import org.kie.api.builder.KieBuilder;
 import org.kie.api.builder.KieFileSystem;
@@ -53,18 +51,16 @@ import org.onap.policy.controlloop.policy.guard.ControlLoopGuard;
 import org.onap.policy.drools.http.server.HttpServletServer;
 import org.onap.policy.drools.impl.PolicyEngineJUnitImpl;
 import org.onap.policy.guard.PolicyGuardYamlToXacml;
-import org.onap.policy.simulators.AaiSimulatorJaxRs;
-import org.onap.policy.simulators.MsoSimulatorJaxRs;
-import org.onap.policy.simulators.VfcSimulatorJaxRs;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.Constructor;
 
 import com.att.research.xacml.api.pdp.PDPEngine;
 import com.att.research.xacml.api.pdp.PDPEngineFactory;
 import com.att.research.xacml.util.FactoryException;
 import com.att.research.xacml.util.XACMLProperties;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 public final class Util {
 
 	private static final Logger logger = LoggerFactory.getLogger(Util.class);
@@ -121,8 +117,8 @@ public final class Util {
 		return org.onap.policy.simulators.Util.buildAaiSim();
 	}
 	
-	public static HttpServletServer buildMsoSim() throws InterruptedException {
-		return org.onap.policy.simulators.Util.buildMsoSim();
+	public static HttpServletServer buildSoSim() throws InterruptedException {
+		return org.onap.policy.simulators.Util.buildSoSim();
 	}
 	
 	public static HttpServletServer buildVfcSim() throws InterruptedException {
diff --git a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VDNSControlLoopTest.java b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VDNSControlLoopTest.java
new file mode 100644
index 000000000..e107e2e7c
--- /dev/null
+++ b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VDNSControlLoopTest.java
@@ -0,0 +1,304 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * demo
+ * ================================================================================
+ * 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.onap.policy.template.demo;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+import java.net.URLEncoder;
+import java.time.Instant;
+import java.util.HashMap;
+import java.util.UUID;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.kie.api.runtime.KieSession;
+import org.kie.api.runtime.rule.FactHandle;
+import org.onap.policy.controlloop.ControlLoopEventStatus;
+import org.onap.policy.controlloop.ControlLoopNotificationType;
+import org.onap.policy.controlloop.ControlLoopTargetType;
+import org.onap.policy.controlloop.VirtualControlLoopEvent;
+import org.onap.policy.controlloop.VirtualControlLoopNotification;
+import org.onap.policy.controlloop.policy.ControlLoopPolicy;
+import org.onap.policy.controlloop.policy.TargetType;
+import org.onap.policy.drools.http.server.HttpServletServer;
+import org.onap.policy.drools.impl.PolicyEngineJUnitImpl;
+import org.onap.policy.guard.PolicyGuard;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class VDNSControlLoopTest {
+
+    private static final Logger logger = LoggerFactory.getLogger(VDNSControlLoopTest.class);
+    
+    private KieSession kieSession;
+    private Util.Pair<ControlLoopPolicy, String> pair;
+    private PolicyEngineJUnitImpl engine;     
+    
+	@BeforeClass
+	public static void setUpSimulator() {
+		try {
+			Util.buildAaiSim();
+			Util.buildSoSim();
+		} catch (InterruptedException e) {
+			fail(e.getMessage());
+		}
+	}
+
+	@AfterClass
+	public static void tearDownSimulator() {
+		HttpServletServer.factory.destroy();
+	}
+
+    @Test
+    public void successTest() {
+        
+        /*
+         * Start the kie session
+         */
+        try {
+            kieSession = startSession("src/main/resources/ControlLoop_Template_xacml_guard.drl", 
+                        "src/test/resources/yaml/policy_ControlLoop_SO-test.yaml",
+                        "type=operational", 
+                        "CL_vDNS", 
+                        "v2.0");
+        } catch (IOException e) {
+            e.printStackTrace();
+            logger.debug("Could not create kieSession");
+            fail("Could not create kieSession");
+        }
+        
+        /*
+         * Create a thread to continuously fire rules 
+         * until main thread calls halt
+         */      
+        new Thread( new Runnable() {
+            @Override
+            public void run() {
+                kieSession.fireUntilHalt();
+            }
+          } ).start();
+        
+        /*
+         * Create a unique requestId and a unique trigger source
+         */
+        UUID requestID = UUID.randomUUID();
+        String triggerSourceName = "foobartriggersource36";
+        
+        /*
+         * This will be the object returned from the PolicyEngine
+         */
+        Object obj = null;
+        
+        /* 
+         * Simulate an onset event the policy engine will 
+         * receive from DCAE to kick off processing through
+         * the rules
+         */
+        try {
+            sendOnset(pair.a, requestID, triggerSourceName);
+        } catch (InterruptedException e) {
+            e.printStackTrace();
+            logger.debug("Unable to send onset event");
+            fail("Unable to send onset event");
+        }
+        
+        /*
+         * Pull the object that was sent out and make
+         * sure it is a ControlLoopNoticiation of type active
+         */
+        obj = engine.subscribe("UEB", "POLICY-CL-MGT");
+        assertNotNull(obj);
+        assertTrue(obj instanceof VirtualControlLoopNotification);
+        assertTrue(((VirtualControlLoopNotification)obj).notification.equals(ControlLoopNotificationType.ACTIVE));
+        
+
+        /*
+         * Give the control loop time to acquire a lock
+         */
+        try {
+            Thread.sleep(4000);
+        } catch (InterruptedException e) {
+            e.printStackTrace();
+            logger.debug("An interrupt Exception was thrown");
+            fail("An interrupt Exception was thrown");
+        }
+
+      /*
+      * Give time to finish processing
+      */
+     try {
+         Thread.sleep(10000);
+     } catch (InterruptedException e) {
+         e.printStackTrace();
+         logger.debug("An interrupt Exception was thrown");
+         fail("An interrupt Exception was thrown");
+     }     
+
+	    /*
+	     * One final check to make sure the lock is released 
+	     */
+	    assertFalse(PolicyGuard.isLocked(TargetType.VNF, triggerSourceName, requestID));
+
+        /*
+         * This will stop the thread that is firing the rules
+         */
+        kieSession.halt();
+        
+        /*
+         * The only fact in memory should be Params
+         */
+        assertEquals(1, kieSession.getFactCount());
+        
+        /*
+         * Print what's left in memory
+         */
+        dumpFacts(kieSession);
+        
+        /*
+         * Gracefully shut down the kie session
+         */
+        kieSession.dispose();
+    }
+    
+    /**
+     * This method will start a kie session and instantiate 
+     * the Policy Engine.
+     * 
+     * @param droolsTemplate
+     *          the DRL rules file
+     * @param yamlFile
+     *          the yaml file containing the policies
+     * @param policyScope
+     *          scope for policy
+     * @param policyName
+     *          name of the policy
+     * @param policyVersion
+     *          version of the policy          
+     * @return the kieSession to be used to insert facts 
+     * @throws IOException
+     */
+    private KieSession startSession(String droolsTemplate, 
+            String yamlFile, 
+            String policyScope, 
+            String policyName, 
+            String policyVersion) throws IOException {
+        
+        /*
+         * Load policies from yaml
+         */
+        pair = Util.loadYaml(yamlFile);
+        assertNotNull(pair);
+        assertNotNull(pair.a);
+        assertNotNull(pair.a.getControlLoop());
+        assertNotNull(pair.a.getControlLoop().getControlLoopName());
+        assertTrue(pair.a.getControlLoop().getControlLoopName().length() > 0);
+        
+        /* 
+         * Construct a kie session
+         */
+        final KieSession kieSession = Util.buildContainer(droolsTemplate, 
+                pair.a.getControlLoop().getControlLoopName(), 
+                policyScope, 
+                policyName, 
+                policyVersion, 
+                URLEncoder.encode(pair.b, "UTF-8"));
+        
+        /*
+         * Retrieve the Policy Engine
+         */
+        engine = (PolicyEngineJUnitImpl) kieSession.getGlobal("Engine");
+        
+        logger.debug("============");
+        logger.debug(URLEncoder.encode(pair.b, "UTF-8"));
+        logger.debug("============");
+        
+        return kieSession;
+    }
+
+    /**
+     * This method is used to simulate event messages from DCAE
+     * that start the control loop (onset message).
+     * 
+     * @param policy the controlLoopName comes from the policy 
+     * @param requestID the requestId for this event
+     * @param triggerSourceName 
+     * @throws InterruptedException
+     */
+    protected void sendOnset(ControlLoopPolicy policy, UUID requestID, String triggerSourceName) throws InterruptedException {
+        VirtualControlLoopEvent event = new VirtualControlLoopEvent();
+        event.closedLoopControlName = policy.getControlLoop().getControlLoopName();
+        event.requestID = requestID;
+        event.target = "VNF_NAME";
+		event.target_type = ControlLoopTargetType.VNF;
+        event.closedLoopAlarmStart = Instant.now();
+        event.AAI = new HashMap<>();
+        event.AAI.put("cloud-region.identity-url", "foo");
+        event.AAI.put("vserver.selflink", "bar");
+        event.AAI.put("vserver.is-closed-loop-disabled", "false");
+        event.AAI.put("vserver.vserver-name", "vserver-name-16102016-aai3255-data-11-1");
+        event.closedLoopEventStatus = ControlLoopEventStatus.ONSET;
+        kieSession.insert(event);
+        Thread.sleep(2000);
+    }
+    
+    /**
+     * This method is used to simulate event messages from DCAE
+     * that end the control loop (abatement message).
+     * 
+     * @param policy the controlLoopName comes from the policy 
+     * @param requestID the requestId for this event
+     * @param triggerSourceName 
+     * @throws InterruptedException
+     */
+    protected void sendAbatement(ControlLoopPolicy policy, UUID requestID, String triggerSourceName) throws InterruptedException {
+        VirtualControlLoopEvent event = new VirtualControlLoopEvent();
+        event.closedLoopControlName = policy.getControlLoop().getControlLoopName();
+        event.requestID = requestID;
+        event.target = "generic-vnf.vnf-id";
+        event.closedLoopAlarmStart = Instant.now().minusSeconds(5);
+        event.closedLoopAlarmEnd = Instant.now();
+        event.AAI = new HashMap<>();
+        event.AAI.put("cloud-region.identity-url", "foo");
+        event.AAI.put("vserver.selflink", "bar");
+        event.AAI.put("vserver.is-closed-loop-disabled", "false");
+        event.AAI.put("generic-vnf.vnf-id", "testGenericVnfID");
+        event.closedLoopEventStatus = ControlLoopEventStatus.ABATED;
+        kieSession.insert(event);
+    }
+    
+    /**
+     * This method will dump all the facts in the working memory.
+     * 
+     * @param kieSession the session containing the facts
+     */
+    public void dumpFacts(KieSession kieSession) {
+        logger.debug("Fact Count: {}", kieSession.getFactCount());
+        for (FactHandle handle : kieSession.getFactHandles()) {
+            logger.debug("FACT: {}", handle);
+        }
+    }
+}