summaryrefslogtreecommitdiffstats
path: root/controlloop/templates/template.demo/src
diff options
context:
space:
mode:
authorSaravanan A <saravanan.a75@wipro.com>2019-04-05 20:45:44 +0530
committerPamela Dragosh <pdragosh@research.att.com>2019-04-08 17:27:35 -0400
commit776b69ebd28440f84a890b1d4170af77ca5974ff (patch)
tree849f41dc83e8a794bd875d08f122ffef3e6e3dc1 /controlloop/templates/template.demo/src
parente55d256a9eeb411bb485919eb4c1d449cbae5d46 (diff)
Code changes done for OOF SON use case
Added a new control loop for SON ANR changes Introducing control loop response flow using DCAE_CL_RSP topic Change-Id: I81d0e92ce2f5c489596ad70d7b523cab0d8436ce Issue-ID: POLICY-1463 Signed-off-by: Saravanan A <saravanan.a75@wipro.com> Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'controlloop/templates/template.demo/src')
-rw-r--r--controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VsonhControlLoopTest.java443
-rw-r--r--controlloop/templates/template.demo/src/test/resources/yaml/policy_ControlLoop_vSONH.yaml38
2 files changed, 481 insertions, 0 deletions
diff --git a/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VsonhControlLoopTest.java b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VsonhControlLoopTest.java
new file mode 100644
index 000000000..871755db9
--- /dev/null
+++ b/controlloop/templates/template.demo/src/test/java/org/onap/policy/template/demo/VsonhControlLoopTest.java
@@ -0,0 +1,443 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * demo
+ * ================================================================================
+ * Copyright (C) 2019 Wipro Limited 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.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.List;
+import java.util.Properties;
+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.common.endpoints.event.comm.Topic.CommInfrastructure;
+import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
+import org.onap.policy.common.endpoints.event.comm.TopicListener;
+import org.onap.policy.common.endpoints.event.comm.TopicSink;
+import org.onap.policy.common.endpoints.http.server.HttpServletServer;
+import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
+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.drools.protocol.coders.EventProtocolCoder;
+import org.onap.policy.drools.protocol.coders.EventProtocolParams;
+import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
+import org.onap.policy.drools.system.PolicyController;
+import org.onap.policy.drools.system.PolicyEngine;
+import org.onap.policy.drools.utils.logging.LoggerUtil;
+import org.onap.policy.sdnr.PciRequest;
+import org.onap.policy.sdnr.PciRequestWrapper;
+import org.onap.policy.sdnr.PciResponse;
+import org.onap.policy.sdnr.PciResponseWrapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class VsonhControlLoopTest implements TopicListener {
+
+ private static final Logger logger = LoggerFactory.getLogger(VsonhControlLoopTest.class);
+
+ private static List<? extends TopicSink> noopTopics;
+
+ private static KieSession kieSession;
+ private static SupportUtil.Pair<ControlLoopPolicy, String> pair;
+ private UUID requestId;
+
+ static {
+ /* Set environment properties */
+ SupportUtil.setAaiProps();
+ SupportUtil.setGuardProps();
+ SupportUtil.setPuProp();
+ LoggerUtil.setLevel(LoggerUtil.ROOT_LOGGER, "DEBUG");
+ }
+
+ /**
+ * Setup the simulator.
+ */
+ @BeforeClass
+ public static void setUpSimulator() {
+ PolicyEngine.manager.configure(new Properties());
+ assertTrue(PolicyEngine.manager.start());
+ Properties noopSinkProperties = new Properties();
+ noopSinkProperties.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS, "SDNR-CL,POLICY-CL-MGT");
+ noopSinkProperties.put("noop.sink.topics.SDNR-CL.events", "org.onap.policy.sdnr.PciRequestWrapper");
+ noopSinkProperties.put("noop.sink.topics.SDNR-CL.events.custom.gson",
+ "org.onap.policy.sdnr.util.Serialization,gson");
+ noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events",
+ "org.onap.policy.controlloop.VirtualControlLoopNotification");
+ noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events.custom.gson",
+ "org.onap.policy.controlloop.util.Serialization,gsonPretty");
+ noopTopics = TopicEndpoint.manager.addTopicSinks(noopSinkProperties);
+
+ EventProtocolCoder.manager.addEncoder(EventProtocolParams.builder()
+ .groupId("junit.groupId")
+ .artifactId("junit.artifactId")
+ .topic("POLICY-CL-MGT")
+ .eventClass("org.onap.policy.controlloop.VirtualControlLoopNotification")
+ .protocolFilter(new JsonProtocolFilter())
+ .modelClassLoaderHash(1111));
+ EventProtocolCoder.manager.addEncoder(EventProtocolParams.builder()
+ .groupId("junit.groupId")
+ .artifactId("junit.artifactId")
+ .topic("SDNR-CL")
+ .eventClass("org.onap.policy.sdnr.PciRequestWrapper")
+ .protocolFilter(new JsonProtocolFilter())
+ .modelClassLoaderHash(1111));
+ try {
+ SupportUtil.buildAaiSim();
+ SupportUtil.buildGuardSim();
+ } catch (Exception e) {
+ fail(e.getMessage());
+ }
+ /*
+ * Start the kie session
+ */
+ try {
+ kieSession = startSession(
+ "../archetype-cl-amsterdam/src/main/resources/archetype-resources"
+ + "/src/main/resources/__closedLoopControlName__.drl",
+ "src/test/resources/yaml/policy_ControlLoop_vSONH.yaml", "type=operational", "CL_vSONH", "v4.0.0");
+ } catch (IOException e) {
+ e.printStackTrace();
+ logger.debug("Could not create kieSession");
+ fail("Could not create kieSession");
+ }
+ }
+
+ /**
+ * Tear down the simulator.
+ */
+ @AfterClass
+ public static void tearDownSimulator() {
+ /*
+ * Gracefully shut down the kie session
+ */
+ kieSession.dispose();
+
+ PolicyEngine.manager.stop();
+ HttpServletServer.factory.destroy();
+ PolicyController.factory.shutdown();
+ TopicEndpoint.manager.shutdown();
+ }
+
+ @Test
+ public void successTest() {
+
+ /*
+ * Allows the PolicyEngine to callback to this object to notify that there is an
+ * event ready to be pulled from the queue
+ */
+ for (TopicSink sink : noopTopics) {
+ assertTrue(sink.start());
+ sink.register(this);
+ }
+
+ /*
+ * Create a unique requestId
+ */
+ requestId = UUID.randomUUID();
+
+ /*
+ * Simulate an onset event the policy engine will receive from DCAE to kick off
+ * processing through the rules
+ */
+ sendEvent(pair.first, requestId, ControlLoopEventStatus.ONSET, true);
+
+ kieSession.fireUntilHalt();
+
+ // allow object clean-up
+ kieSession.fireAllRules();
+
+ /*
+ * The only fact in memory should be Params
+ */
+ assertEquals(1, kieSession.getFactCount());
+
+ /*
+ * Print what's left in memory
+ */
+ dumpFacts(kieSession);
+
+ }
+
+ @Test
+ public void aaiGetFailTest() {
+
+ /*
+ * Allows the PolicyEngine to callback to this object to notify that there is an
+ * event ready to be pulled from the queue
+ */
+ for (TopicSink sink : noopTopics) {
+ assertTrue(sink.start());
+ sink.register(this);
+ }
+
+ /*
+ * Create a unique requestId
+ */
+ requestId = UUID.randomUUID();
+
+ /*
+ * Simulate an onset event the policy engine will receive from DCAE to kick off
+ * processing through the rules
+ */
+ sendEvent(pair.first, requestId, ControlLoopEventStatus.ONSET, false);
+
+ kieSession.fireUntilHalt();
+
+ // allow object clean-up
+ kieSession.fireAllRules();
+
+ /*
+ * The only fact in memory should be Params
+ */
+ assertEquals(1, kieSession.getFactCount());
+
+ /*
+ * Print what's left in memory
+ */
+ dumpFacts(kieSession);
+
+ }
+
+ /**
+ * 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
+ * IO exception
+ */
+ private static KieSession startSession(String droolsTemplate, String yamlFile, String policyScope,
+ String policyName, String policyVersion) throws IOException {
+
+ /*
+ * Load policies from yaml
+ */
+ pair = SupportUtil.loadYaml(yamlFile);
+ assertNotNull(pair);
+ assertNotNull(pair.first);
+ assertNotNull(pair.first.getControlLoop());
+ assertNotNull(pair.first.getControlLoop().getControlLoopName());
+ assertTrue(pair.first.getControlLoop().getControlLoopName().length() > 0);
+
+ /*
+ * Construct a kie session
+ */
+ final KieSession kieSession = SupportUtil.buildContainer(droolsTemplate,
+ pair.first.getControlLoop().getControlLoopName(), policyScope, policyName, policyVersion,
+ URLEncoder.encode(pair.second, "UTF-8"));
+
+ /*
+ * Retrieve the Policy Engine
+ */
+
+ logger.debug("======controlloop======");
+ logger.debug(((ControlLoopPolicy) pair.first).toString());
+ logger.debug("======policies======");
+ logger.debug(URLEncoder.encode(pair.second, "UTF-8"));
+ logger.debug("============");
+
+ return kieSession;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.
+ * String)
+ */
+ @Override
+ public void onTopicEvent(CommInfrastructure commType, String topic, String event) {
+ logger.debug("\n============ onTopicEvent!!! ===========\n");
+ logger.debug("topic: {}, event: {}", topic, event);
+ /*
+ * Pull the object that was sent out to DMAAP and make sure it is a
+ * ControlLoopNoticiation of type active
+ */
+ Object obj = null;
+ if ("POLICY-CL-MGT".equals(topic)) {
+ obj = org.onap.policy.controlloop.util.Serialization.gsonJunit.fromJson(event,
+ org.onap.policy.controlloop.VirtualControlLoopNotification.class);
+ } else if ("SDNR-CL".equals(topic)) {
+ obj = org.onap.policy.sdnr.util.Serialization.gsonJunit.fromJson(event,
+ org.onap.policy.sdnr.PciRequestWrapper.class);
+ }
+ assertNotNull(obj);
+ if (obj instanceof VirtualControlLoopNotification) {
+ VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj;
+ String policyName = notification.getPolicyName();
+ logger.debug("Rule Fired: {}", policyName);
+ if (policyName.endsWith("EVENT")) {
+ assertEquals(ControlLoopNotificationType.ACTIVE, notification.getNotification());
+ } else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
+ assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
+ assertNotNull(notification.getMessage());
+ assertTrue(notification.getMessage().startsWith("Sending guard query"));
+ } else if (policyName.endsWith("GUARD.RESPONSE")) {
+ assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
+ assertNotNull(notification.getMessage());
+ assertTrue(notification.getMessage().toLowerCase().endsWith("permit"));
+ } else if (policyName.endsWith("GUARD_PERMITTED")) {
+ assertEquals(ControlLoopNotificationType.OPERATION, notification.getNotification());
+ assertNotNull(notification.getMessage());
+ assertTrue(notification.getMessage().startsWith("actor=SDNR"));
+ } else if (policyName.endsWith("OPERATION.TIMEOUT")) {
+ kieSession.halt();
+ logger.debug("The operation timed out");
+ fail("Operation Timed Out");
+ } else if (policyName.endsWith("SDNR.RESPONSE")) {
+ assertEquals(ControlLoopNotificationType.OPERATION_SUCCESS, notification.getNotification());
+ assertNotNull(notification.getMessage());
+ assertTrue(notification.getMessage().startsWith("actor=SDNR"));
+ } else if (policyName.endsWith("EVENT.MANAGER")) {
+ if ("getFail".equals(notification.getAai().get("generic-vnf.vnf-id"))) {
+ assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notification.getNotification());
+ kieSession.halt();
+ } else {
+ assertEquals(ControlLoopNotificationType.FINAL_SUCCESS, notification.getNotification());
+ kieSession.halt();
+ }
+ } else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
+ kieSession.halt();
+ logger.debug("The control loop timed out");
+ fail("Control Loop Timed Out");
+ }
+ } else if (obj instanceof PciRequestWrapper) {
+ /*
+ * The request should be of type PciRequestWrapper and the subrequestid should
+ * be 1
+ */
+ PciRequestWrapper dmaapRequest = (PciRequestWrapper) obj;
+ PciRequest pciRequest = dmaapRequest.getBody();
+ assertEquals("1", pciRequest.getCommonHeader().getSubRequestId());
+
+ logger.debug("\n============ SDNR received the request!!! ===========\n");
+ logger.debug("\n============ dmaapRequest ===========\n {} ", dmaapRequest);
+ logger.debug("\n============ pciRequest ===========\n {}", pciRequest);
+
+ /*
+ * Simulate a success response from SDNR and insert the response into the
+ * working memory
+ */
+ PciResponse pciResponse = new PciResponse(pciRequest);
+ pciResponse.getStatus().setCode(200);
+ pciResponse.getStatus().setValue("SUCCESS");
+ StringBuilder sb = new StringBuilder();
+ sb.append("{ \"Configurations\":[ { \"Status\": { \"Code\": 200, \"Value\":"
+ + " \"SUCCESS\" }, \"data\":{ \"FAPService\":{ \"alias\":"
+ + "\"Network1\", \"CellConfig\":{ \"LTE\":{ \"RAN\":{ \"Common\":"
+ + "{ \"CellIdentity\":\"1\" }, \"NeighborListInUse\" : "
+ + "{ \"LTECellNumberOfEntries\" : \"1\" , \"LTECell\" : "
+ + "[ { \"PLMNID\" :\"plmnid1\", \"CID\":\"Chn0001\", \"PhyCellID\":"
+ + "\"3\", \"PNFName\":\"ncserver01\", \"Blacklisted\":\"false\" "
+ + "} ] } } } } } } } ] }");
+
+ pciResponse.setPayload(sb.toString());
+ PciResponseWrapper dmaapResponse = new PciResponseWrapper();
+ dmaapResponse.setBody(pciResponse);
+ dmaapResponse.setType("response");
+ logger.debug("\n============ SDNR sending response!!! ===========\n");
+ logger.debug("\n============ dmaapResponse ===========\n {}", dmaapResponse);
+ logger.debug("\n============ pciResponse ===========\n {}", pciResponse);
+ kieSession.insert(dmaapResponse);
+ }
+ }
+
+ /**
+ * 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 status
+ * could be onset
+ */
+ protected void sendEvent(ControlLoopPolicy policy, UUID requestId, ControlLoopEventStatus status,
+ boolean isEnriched) {
+ VirtualControlLoopEvent event = new VirtualControlLoopEvent();
+ event.setClosedLoopControlName(policy.getControlLoop().getControlLoopName());
+ event.setRequestId(requestId);
+ event.setTarget("generic-vnf.vnf-id");
+ event.setTargetType(ControlLoopTargetType.VNF);
+ event.setClosedLoopAlarmStart(Instant.now());
+ event.setAai(new HashMap<>());
+ if (isEnriched) {
+ event.getAai().put("generic-vnf.is-closed-loop-disabled", "false");
+ event.getAai().put("generic-vnf.prov-status", "ACTIVE");
+ event.getAai().put("generic-vnf.vnf-id", "notused");
+ } else {
+ event.getAai().put("generic-vnf.vnf-id", "getFail");
+ }
+ event.setClosedLoopEventStatus(status);
+ StringBuilder sb = new StringBuilder();
+ sb.append("{ \"Configurations\":[ { \"data\":{ \"FAPService\":"
+ + " { \"alias\":\"Cell1\", \"CellConfig\":{ \"LTE\":{ \"RAN\":{ \"Common\":"
+ + "{ \"CellIdentity\":\"1\" }, \"NeighborListInUse\" : "
+ + "{ \"LTECellNumberOfEntries\" : \"1\" , \"LTECell\" : "
+ + "[ { \"PLMNID\" :\"plmnid1\", \"CID\":\"Chn0001\", \"PhyCellID\":"
+ + "\"3\", \"PNFName\":\"ncserver01\", \"Blacklisted\":\"false\" "
+ + "} ] } } } } } } } ] }");
+
+ event.setPayload(sb.toString());
+ logger.debug("\n============ Policy receiving ONSET event !!! ===========\n");
+ logger.debug("\n============ event ===========\n {}", event);
+ 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);
+ }
+ }
+
+}
diff --git a/controlloop/templates/template.demo/src/test/resources/yaml/policy_ControlLoop_vSONH.yaml b/controlloop/templates/template.demo/src/test/resources/yaml/policy_ControlLoop_vSONH.yaml
new file mode 100644
index 000000000..4cdf8ff40
--- /dev/null
+++ b/controlloop/templates/template.demo/src/test/resources/yaml/policy_ControlLoop_vSONH.yaml
@@ -0,0 +1,38 @@
+# Copyright 2019 Wipro Limited 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.
+controlLoop:
+ version: 3.0.0
+ controlLoopName: ControlLoop-vSONH-7d4baf04-8875-4d1f-946d-06b874048b61
+ trigger_policy: unique-policy-id-456-modifyconfig
+ timeout: 1200
+ abatement: false
+
+policies:
+ - id: unique-policy-id-456-modifyconfig
+ name: modify ANR config
+ description:
+ actor: SDNR
+ recipe: ModifyConfigANR
+ target:
+ # These fields are not used
+ resourceID: Eace933104d443b496b8.nodes.heat.vpg
+ type: VNF
+ retry: 0
+ timeout: 300
+ success: final_success
+ failure: final_failure
+ failure_timeout: final_failure_timeout
+ failure_retries: final_failure_retries
+ failure_exception: final_failure_exception
+ failure_guard: final_failure_guard