gerrit.onap Code Review - policy/drools-applications.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * demo
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.template.demo;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.junit.Assert.assertNotNull;
  25 import static org.junit.Assert.assertTrue;
  26 import static org.junit.Assert.fail;
  27
  28 import java.io.IOException;
  29 import java.net.URLEncoder;
  30 import java.time.Instant;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Properties;
  34 import java.util.UUID;
  35
  36 import org.junit.AfterClass;
  37 import org.junit.BeforeClass;
  38 import org.junit.Test;
  39 import org.kie.api.runtime.KieSession;
  40 import org.kie.api.runtime.rule.FactHandle;
  41 import org.onap.policy.appclcm.LcmRequest;
  42 import org.onap.policy.appclcm.LcmRequestWrapper;
  43 import org.onap.policy.appclcm.LcmResponse;
  44 import org.onap.policy.appclcm.LcmResponseWrapper;
  45 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  46 import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
  47 import org.onap.policy.common.endpoints.event.comm.TopicListener;
  48 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  49 import org.onap.policy.common.endpoints.http.server.HttpServletServer;
  50 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
  51 import org.onap.policy.controlloop.ControlLoopEventStatus;
  52 import org.onap.policy.controlloop.ControlLoopNotificationType;
  53 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  54 import org.onap.policy.controlloop.VirtualControlLoopNotification;
  55 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
  56 import org.onap.policy.drools.protocol.coders.EventProtocolCoder;
  57 import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
  58 import org.onap.policy.drools.system.PolicyController;
  59 import org.onap.policy.drools.system.PolicyEngine;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62
  63 public class ControlLoopFailureTest implements TopicListener {
  64
  65     private static final Logger logger = LoggerFactory.getLogger(ControlLoopFailureTest.class);
  66
  67     private static List<? extends TopicSink> noopTopics;
  68
  69     private static KieSession kieSession;
  70     private static Util.Pair<ControlLoopPolicy, String> pair;
  71     private UUID requestId;
  72     private UUID requestId2;
  73     private UUID requestId3;
  74     private int eventCount;
  75
  76     static {
  77         /* Set environment properties */
  78         Util.setAaiProps();
  79         Util.setGuardProps();
  80         Util.setPuProp();
  81     }
  82
  83     /**
  84      * Setup simulator.
  85      */
  86     @BeforeClass
  87     public static void setUpSimulator() {
  88         PolicyEngine.manager.configure(new Properties());
  89         assertTrue(PolicyEngine.manager.start());
  90         Properties noopSinkProperties = new Properties();
  91         noopSinkProperties.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS, "APPC-LCM-READ,POLICY-CL-MGT");
  92         noopSinkProperties.put("noop.sink.topics.APPC-LCM-READ.events", "org.onap.policy.appclcm.LcmRequestWrapper");
  93         noopSinkProperties.put("noop.sink.topics.APPC-LCM-READ.events.custom.gson",
  94                 "org.onap.policy.appclcm.util.Serialization,gson");
  95         noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events",
  96                 "org.onap.policy.controlloop.VirtualControlLoopNotification");
  97         noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events.custom.gson",
  98                 "org.onap.policy.controlloop.util.Serialization,gsonPretty");
  99         noopTopics = TopicEndpoint.manager.addTopicSinks(noopSinkProperties);
 100
 101         EventProtocolCoder.manager.addEncoder("junit.groupId", "junit.artifactId", "POLICY-CL-MGT",
 102                 "org.onap.policy.controlloop.VirtualControlLoopNotification", new JsonProtocolFilter(), null, null,
 103                 1111);
 104         EventProtocolCoder.manager.addEncoder("junit.groupId", "junit.artifactId", "APPC-LCM-READ",
 105                 "org.onap.policy.appclcm.LcmRequestWrapper", new JsonProtocolFilter(), null, null, 1111);
 106         try {
 107             Util.buildAaiSim();
 108             Util.buildGuardSim();
 109         } catch (Exception e) {
 110             fail(e.getMessage());
 111         }
 112
 113         /*
 114          * Start the kie session
 115          */
 116         try {
 117             kieSession = startSession(
 118                     "../archetype-cl-amsterdam/src/main/resources/archetype-resources"
 119                     + "/src/main/resources/__closedLoopControlName__.drl",
 120                     "src/test/resources/yaml/policy_ControlLoop_vCPE.yaml",
 121                     "service=ServiceDemo;resource=Res1Demo;type=operational", "CL_vCPE",
 122                     "org.onap.closed_loop.ServiceDemo:VNFS:1.0.0");
 123         } catch (IOException e) {
 124             e.printStackTrace();
 125             logger.debug("Could not create kieSession");
 126             fail("Could not create kieSession");
 127         }
 128     }
 129
 130     /**
 131      * Tear down simulator.
 132      */
 133     @AfterClass
 134     public static void tearDownSimulator() {
 135         /*
 136          * Gracefully shut down the kie session
 137          */
 138         kieSession.dispose();
 139
 140         PolicyEngine.manager.stop();
 141         HttpServletServer.factory.destroy();
 142         PolicyController.factory.shutdown();
 143         TopicEndpoint.manager.shutdown();
 144     }
 145
 146     /**
 147      * This test case tests the scenario where 3 events occur and 2 of the requests refer to the
 148      * same target entity while the 3rd is for another entity. The expected result is that the event
 149      * with the duplicate target entity will have a final success result for one of the events, and
 150      * a rejected message for the one that was unable to obtain the lock. The event that is
 151      * referring to a different target entity should be able to obtain a lock since it is a
 152      * different target. After processing of all events there should only be the params object left
 153      * in memory.
 154      */
 155     @Test
 156     public void targetLockedTest() {
 157
 158         /*
 159          * Allows the PolicyEngine to callback to this object to notify that there is an event ready
 160          * to be pulled from the queue
 161          */
 162         for (TopicSink sink : noopTopics) {
 163             assertTrue(sink.start());
 164             sink.register(this);
 165         }
 166
 167         /*
 168          * Create a unique requestId
 169          */
 170         requestId = UUID.randomUUID();
 171
 172         /*
 173          * This will be a unique request for another target entity
 174          */
 175         requestId2 = UUID.randomUUID();
 176
 177         /*
 178          * This will be a request duplicating the target entity of the first request
 179          */
 180         requestId3 = UUID.randomUUID();
 181
 182         /*
 183          * Simulate an onset event the policy engine will receive from DCAE to kick off processing
 184          * through the rules
 185          */
 186         sendEvent(pair.first, requestId, ControlLoopEventStatus.ONSET, "vnf01");
 187
 188         /*
 189          * Send a second event requesting an action for a different target entity
 190          */
 191         sendEvent(pair.first, requestId2, ControlLoopEventStatus.ONSET, "vnf02");
 192
 193         /*
 194          * Send a second event for a different target to ensure there are no problems with obtaining
 195          * a lock for a different
 196          */
 197         kieSession.fireUntilHalt();
 198
 199         /*
 200          * The only fact in memory should be Params
 201          */
 202         assertEquals(1, kieSession.getFactCount());
 203
 204         /*
 205          * Print what's left in memory
 206          */
 207         dumpFacts(kieSession);
 208
 209     }
 210
 211     /**
 212      * This method will start a kie session and instantiate the Policy Engine.
 213      *
 214      * @param droolsTemplate the DRL rules file
 215      * @param yamlFile the yaml file containing the policies
 216      * @param policyScope scope for policy
 217      * @param policyName name of the policy
 218      * @param policyVersion version of the policy
 219      * @return the kieSession to be used to insert facts
 220      * @throws IOException throws IO exception
 221      */
 222     private static KieSession startSession(String droolsTemplate, String yamlFile, String policyScope,
 223             String policyName, String policyVersion) throws IOException {
 224
 225         /*
 226          * Load policies from yaml
 227          */
 228         pair = Util.loadYaml(yamlFile);
 229         assertNotNull(pair);
 230         assertNotNull(pair.first);
 231         assertNotNull(pair.first.getControlLoop());
 232         assertNotNull(pair.first.getControlLoop().getControlLoopName());
 233         assertTrue(pair.first.getControlLoop().getControlLoopName().length() > 0);
 234
 235         /*
 236          * Construct a kie session
 237          */
 238         final KieSession kieSession = Util.buildContainer(droolsTemplate,
 239                 pair.first.getControlLoop().getControlLoopName(),
 240                 policyScope, policyName, policyVersion, URLEncoder.encode(pair.second, "UTF-8"));
 241
 242         /*
 243          * Retrieve the Policy Engine
 244          */
 245
 246         logger.debug("============");
 247         logger.debug(URLEncoder.encode(pair.second, "UTF-8"));
 248         logger.debug("============");
 249
 250         return kieSession;
 251     }
 252
 253     /*
 254      * (non-Javadoc)
 255      *
 256      * @see org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.String)
 257      */
 258     @Override
 259     public void onTopicEvent(CommInfrastructure commType, String topic, String event) {
 260         /*
 261          * Pull the object that was sent out to DMAAP and make sure it is a ControlLoopNoticiation
 262          * of type active
 263          */
 264         Object obj = null;
 265         if ("POLICY-CL-MGT".equals(topic)) {
 266             obj = org.onap.policy.controlloop.util.Serialization.gsonJunit.fromJson(event,
 267                     org.onap.policy.controlloop.VirtualControlLoopNotification.class);
 268         } else if ("APPC-LCM-READ".equals(topic)) {
 269             obj = org.onap.policy.appclcm.util.Serialization.gsonJunit.fromJson(event,
 270                     org.onap.policy.appclcm.LcmRequestWrapper.class);
 271         }
 272         assertNotNull(obj);
 273         if (obj instanceof VirtualControlLoopNotification) {
 274             VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj;
 275             String policyName = notification.getPolicyName();
 276             if (policyName.endsWith("EVENT")) {
 277                 logger.debug("Rule Fired: " + notification.getPolicyName());
 278                 assertTrue(ControlLoopNotificationType.ACTIVE.equals(notification.getNotification()));
 279             } else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
 280                 logger.debug("Rule Fired: " + notification.getPolicyName());
 281                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
 282                 assertNotNull(notification.getMessage());
 283                 assertTrue(notification.getMessage().startsWith("Sending guard query"));
 284             } else if (policyName.endsWith("GUARD.RESPONSE")) {
 285                 logger.debug("Rule Fired: " + notification.getPolicyName());
 286                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
 287                 assertNotNull(notification.getMessage());
 288                 assertTrue(notification.getMessage().toLowerCase().endsWith("permit"));
 289             } else if (policyName.endsWith("GUARD_PERMITTED")) {
 290                 logger.debug("Rule Fired: " + notification.getPolicyName());
 291                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
 292                 assertNotNull(notification.getMessage());
 293                 assertTrue(notification.getMessage().startsWith("actor=APPC"));
 294             } else if (policyName.endsWith("OPERATION.TIMEOUT")) {
 295                 logger.debug("Rule Fired: " + notification.getPolicyName());
 296                 kieSession.halt();
 297                 logger.debug("The operation timed out");
 298                 fail("Operation Timed Out");
 299             } else if (policyName.endsWith("APPC.LCM.RESPONSE")) {
 300                 logger.debug("Rule Fired: " + notification.getPolicyName());
 301                 assertTrue(ControlLoopNotificationType.OPERATION_SUCCESS.equals(notification.getNotification()));
 302                 assertNotNull(notification.getMessage());
 303                 assertTrue(notification.getMessage().startsWith("actor=APPC"));
 304                 if (requestId.equals(notification.getRequestId())) {
 305                     sendEvent(pair.first, requestId, ControlLoopEventStatus.ABATED, "vnf01");
 306                 } else if (requestId2.equals(notification.getRequestId())) {
 307                     sendEvent(pair.first, requestId2, ControlLoopEventStatus.ABATED, "vnf02");
 308                 }
 309             } else if (policyName.endsWith("EVENT.MANAGER")) {
 310                 logger.debug("Rule Fired: " + notification.getPolicyName());
 311                 if (requestId3.equals(notification.getRequestId())) {
 312                     /*
 313                      * The event with the duplicate target should be rejected
 314                      */
 315                     assertTrue(ControlLoopNotificationType.REJECTED.equals(notification.getNotification()));
 316                 } else {
 317                     assertTrue(ControlLoopNotificationType.FINAL_SUCCESS.equals(notification.getNotification()));
 318                 }
 319                 if (++eventCount == 3) {
 320                     kieSession.halt();
 321                 }
 322             } else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
 323                 logger.debug("Rule Fired: " + notification.getPolicyName());
 324                 kieSession.halt();
 325                 logger.debug("The control loop timed out");
 326                 fail("Control Loop Timed Out");
 327             }
 328         } else if (obj instanceof LcmRequestWrapper) {
 329             /*
 330              * The request should be of type LCMRequestWrapper and the subrequestid should be 1
 331              */
 332             LcmRequestWrapper dmaapRequest = (LcmRequestWrapper) obj;
 333             LcmRequest appcRequest = dmaapRequest.getBody();
 334             assertTrue(appcRequest.getCommonHeader().getSubRequestId().equals("1"));
 335
 336             logger.debug("\n============ APPC received the request!!! ===========\n");
 337
 338             /*
 339              * Simulate a success response from APPC and insert the response into the working memory
 340              */
 341             LcmResponseWrapper dmaapResponse = new LcmResponseWrapper();
 342             LcmResponse appcResponse = new LcmResponse(appcRequest);
 343             appcResponse.getStatus().setCode(400);
 344             appcResponse.getStatus().setMessage("AppC success");
 345             dmaapResponse.setBody(appcResponse);
 346
 347             /*
 348              * Interrupting with a different request for the same target entity to check if lock
 349              * will be denied
 350              */
 351             if (requestId.equals(appcResponse.getCommonHeader().getRequestId())) {
 352                 sendEvent(pair.first, requestId3, ControlLoopEventStatus.ONSET, "vnf01");
 353             }
 354             kieSession.insert(dmaapResponse);
 355         }
 356     }
 357
 358     /**
 359      * This method is used to simulate event messages from DCAE that start the control loop (onset
 360      * message) or end the control loop (abatement message).
 361      *
 362      * @param policy the controlLoopName comes from the policy
 363      * @param requestID the requestId for this event
 364      * @param status could be onset or abated
 365      * @param target the target entity to take an action on
 366      */
 367     protected void sendEvent(ControlLoopPolicy policy, UUID requestId, ControlLoopEventStatus status, String target) {
 368         VirtualControlLoopEvent event = new VirtualControlLoopEvent();
 369         event.setClosedLoopControlName(policy.getControlLoop().getControlLoopName());
 370         event.setRequestId(requestId);
 371         event.setTarget("generic-vnf.vnf-id");
 372         event.setClosedLoopAlarmStart(Instant.now());
 373         event.setAai(new HashMap<>());
 374         event.getAai().put("generic-vnf.vnf-id", target);
 375         event.setClosedLoopEventStatus(status);
 376         kieSession.insert(event);
 377     }
 378
 379     /**
 380      * This method will dump all the facts in the working memory.
 381      *
 382      * @param kieSession the session containing the facts
 383      */
 384     public void dumpFacts(KieSession kieSession) {
 385         logger.debug("Fact Count: {}", kieSession.getFactCount());
 386         for (FactHandle handle : kieSession.getFactHandles()) {
 387             logger.debug("FACT: {}", handle);
 388         }
 389     }
 390
 391 }
 392