/*- * ============LICENSE_START======================================================= * demo * ================================================================================ * Copyright (C) 2017-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.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.appclcm.LcmRequest; import org.onap.policy.appclcm.LcmRequestWrapper; import org.onap.policy.appclcm.LcmResponse; import org.onap.policy.appclcm.LcmResponseWrapper; 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.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.slf4j.Logger; import org.slf4j.LoggerFactory; public class ControlLoopFailureTest implements TopicListener { private static final Logger logger = LoggerFactory.getLogger(ControlLoopFailureTest.class); private static List noopTopics; private static KieSession kieSession; private static SupportUtil.Pair pair; private UUID requestId; private UUID requestId2; private UUID requestId3; private int eventCount; static { /* Set environment properties */ SupportUtil.setAaiProps(); SupportUtil.setGuardProps(); SupportUtil.setPuProp(); } /** * Setup 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, "APPC-LCM-READ,POLICY-CL-MGT"); noopSinkProperties.put("noop.sink.topics.APPC-LCM-READ.events", "org.onap.policy.appclcm.LcmRequestWrapper"); noopSinkProperties.put("noop.sink.topics.APPC-LCM-READ.events.custom.gson", "org.onap.policy.appclcm.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("APPC-LCM-READ") .eventClass("org.onap.policy.appclcm.LcmRequestWrapper") .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_vCPE.yaml", "service=ServiceDemo;resource=Res1Demo;type=operational", "CL_vCPE", "org.onap.closed_loop.ServiceDemo:VNFS:1.0.0"); } catch (IOException e) { e.printStackTrace(); logger.debug("Could not create kieSession"); fail("Could not create kieSession"); } } /** * Tear down 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(); } /** * This test case tests the scenario where 3 events occur and 2 of the requests refer to the * same target entity while the 3rd is for another entity. The expected result is that the event * with the duplicate target entity will have a final success result for one of the events, and * a rejected message for the one that was unable to obtain the lock. The event that is * referring to a different target entity should be able to obtain a lock since it is a * different target. After processing of all events there should only be the params object left * in memory. */ @Test public void targetLockedTest() { /* * 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(); /* * This will be a unique request for another target entity */ requestId2 = UUID.randomUUID(); /* * This will be a request duplicating the target entity of the first request */ requestId3 = 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, "vnf01"); /* * Send a second event requesting an action for a different target entity */ sendEvent(pair.first, requestId2, ControlLoopEventStatus.ONSET, "vnf02"); /* * Send a second event for a different target to ensure there are no problems with obtaining * a lock for a different */ 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 throws 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("============"); 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) { /* * 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 ("APPC-LCM-READ".equals(topic)) { obj = org.onap.policy.appclcm.util.Serialization.gsonJunit.fromJson(event, org.onap.policy.appclcm.LcmRequestWrapper.class); } assertNotNull(obj); if (obj instanceof VirtualControlLoopNotification) { VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj; String policyName = notification.getPolicyName(); if (policyName.endsWith("EVENT")) { logger.debug("Rule Fired: " + notification.getPolicyName()); assertTrue(ControlLoopNotificationType.ACTIVE.equals(notification.getNotification())); } else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) { logger.debug("Rule Fired: " + notification.getPolicyName()); assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification())); assertNotNull(notification.getMessage()); assertTrue(notification.getMessage().startsWith("Sending guard query")); } else if (policyName.endsWith("GUARD.RESPONSE")) { logger.debug("Rule Fired: " + notification.getPolicyName()); assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification())); assertNotNull(notification.getMessage()); assertTrue(notification.getMessage().toLowerCase().endsWith("permit")); } else if (policyName.endsWith("GUARD_PERMITTED")) { logger.debug("Rule Fired: " + notification.getPolicyName()); assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification())); assertNotNull(notification.getMessage()); assertTrue(notification.getMessage().startsWith("actor=APPC")); } else if (policyName.endsWith("OPERATION.TIMEOUT")) { logger.debug("Rule Fired: " + notification.getPolicyName()); kieSession.halt(); logger.debug("The operation timed out"); fail("Operation Timed Out"); } else if (policyName.endsWith("APPC.LCM.RESPONSE")) { logger.debug("Rule Fired: " + notification.getPolicyName()); assertTrue(ControlLoopNotificationType.OPERATION_SUCCESS.equals(notification.getNotification())); assertNotNull(notification.getMessage()); assertTrue(notification.getMessage().startsWith("actor=APPC")); if (requestId.equals(notification.getRequestId())) { sendEvent(pair.first, requestId, ControlLoopEventStatus.ABATED, "vnf01"); } else if (requestId2.equals(notification.getRequestId())) { sendEvent(pair.first, requestId2, ControlLoopEventStatus.ABATED, "vnf02"); } } else if (policyName.endsWith("EVENT.MANAGER")) { logger.debug("Rule Fired: " + notification.getPolicyName()); if (requestId3.equals(notification.getRequestId())) { /* * The event with the duplicate target should be rejected */ assertTrue(ControlLoopNotificationType.REJECTED.equals(notification.getNotification())); } else { assertTrue(ControlLoopNotificationType.FINAL_SUCCESS.equals(notification.getNotification())); } if (++eventCount == 3) { kieSession.halt(); } } else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) { logger.debug("Rule Fired: " + notification.getPolicyName()); kieSession.halt(); logger.debug("The control loop timed out"); fail("Control Loop Timed Out"); } } else if (obj instanceof LcmRequestWrapper) { /* * The request should be of type LCMRequestWrapper and the subrequestid should be 1 */ LcmRequestWrapper dmaapRequest = (LcmRequestWrapper) obj; LcmRequest appcRequest = dmaapRequest.getBody(); assertTrue(appcRequest.getCommonHeader().getSubRequestId().equals("1")); logger.debug("\n============ APPC received the request!!! ===========\n"); /* * Simulate a success response from APPC and insert the response into the working memory */ LcmResponseWrapper dmaapResponse = new LcmResponseWrapper(); LcmResponse appcResponse = new LcmResponse(appcRequest); appcResponse.getStatus().setCode(400); appcResponse.getStatus().setMessage("AppC success"); dmaapResponse.setBody(appcResponse); /* * Interrupting with a different request for the same target entity to check if lock * will be denied */ if (requestId.equals(appcResponse.getCommonHeader().getRequestId())) { sendEvent(pair.first, requestId3, ControlLoopEventStatus.ONSET, "vnf01"); } kieSession.insert(dmaapResponse); } } /** * This method is used to simulate event messages from DCAE that start the control loop (onset * message) or end the control loop (abatement message). * * @param policy the controlLoopName comes from the policy * @param requestId the requestId for this event * @param status could be onset or abated * @param target the target entity to take an action on */ protected void sendEvent(ControlLoopPolicy policy, UUID requestId, ControlLoopEventStatus status, String target) { VirtualControlLoopEvent event = new VirtualControlLoopEvent(); event.setClosedLoopControlName(policy.getControlLoop().getControlLoopName()); event.setRequestId(requestId); event.setTarget("generic-vnf.vnf-id"); event.setClosedLoopAlarmStart(Instant.now()); event.setAai(new HashMap<>()); event.getAai().put("generic-vnf.vnf-id", target); event.setClosedLoopEventStatus(status); 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); } } }