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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * demo
   4  * ================================================================================
   5  * Copyright (C) 2017 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.controlloop.ControlLoopEventStatus;
  42 import org.onap.policy.controlloop.ControlLoopNotificationType;
  43 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  44 import org.onap.policy.controlloop.VirtualControlLoopNotification;
  45 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
  46 import org.onap.policy.drools.event.comm.TopicEndpoint;
  47 import org.onap.policy.drools.event.comm.TopicListener;
  48 import org.onap.policy.drools.event.comm.TopicSink;
  49 import org.onap.policy.drools.event.comm.Topic.CommInfrastructure;
  50 import org.onap.policy.drools.http.server.HttpServletServer;
  51 import org.onap.policy.drools.properties.PolicyProperties;
  52 import org.onap.policy.drools.protocol.coders.EventProtocolCoder;
  53 import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
  54 import org.onap.policy.drools.system.PolicyEngine;
  55 import org.onap.policy.so.SORequest;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 public class VDNSControlLoopTest implements TopicListener {
  60
  61     private static final Logger logger = LoggerFactory.getLogger(VDNSControlLoopTest.class);
  62
  63     private static List<? extends TopicSink> noopTopics;
  64
  65     private static KieSession kieSession;
  66     private static Util.Pair<ControlLoopPolicy, String> pair;
  67     private UUID requestID;
  68
  69     static {
  70         /* Set environment properties */
  71         Util.setAAIProps();
  72         Util.setSOProps();
  73         Util.setGuardProps();
  74         Util.setPUProp();
  75     }
  76
  77         @BeforeClass
  78         public static void setUpSimulator() {
  79                 PolicyEngine.manager.configure(new Properties());
  80         assertTrue(PolicyEngine.manager.start());
  81         Properties noopSinkProperties = new Properties();
  82         noopSinkProperties.put(PolicyProperties.PROPERTY_NOOP_SINK_TOPICS, "POLICY-CL-MGT");
  83         noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events", "org.onap.policy.controlloop.VirtualControlLoopNotification");
  84         noopSinkProperties.put("noop.sink.topics.POLICY-CL-MGT.events.custom.gson", "org.onap.policy.controlloop.util.Serialization,gsonPretty");
  85         noopTopics = TopicEndpoint.manager.addTopicSinks(noopSinkProperties);
  86
  87         EventProtocolCoder.manager.addEncoder("junit.groupId", "junit.artifactId", "POLICY-CL-MGT", "org.onap.policy.controlloop.VirtualControlLoopNotification", new JsonProtocolFilter(), null, null, 1111);
  88
  89                 try {
  90                         Util.buildAaiSim();
  91                         Util.buildSoSim();
  92                         Util.buildGuardSim();
  93                 } catch (Exception e) {
  94                         fail(e.getMessage());
  95                 }
  96
  97         /*
  98          * Start the kie session
  99          */
 100         try {
 101             kieSession = startSession("../archetype-cl-amsterdam/src/main/resources/archetype-resources/src/main/resources/__closedLoopControlName__.drl",
 102                         "src/test/resources/yaml/policy_ControlLoop_SO-test.yaml",
 103                         "type=operational",
 104                         "CL_vDNS",
 105                         "v2.0");
 106         } catch (IOException e) {
 107             e.printStackTrace();
 108             logger.debug("Could not create kieSession");
 109             fail("Could not create kieSession");
 110         }
 111         }
 112
 113         @AfterClass
 114         public static void tearDownSimulator() {
 115
 116         /*
 117          * Gracefully shut down the kie session
 118          */
 119         kieSession.dispose();
 120
 121                 HttpServletServer.factory.destroy();
 122                 PolicyEngine.manager.shutdown();
 123                 TopicEndpoint.manager.shutdown();
 124             PolicyEngine.manager.stop();
 125         }
 126
 127     @Test
 128     public void successTest() {
 129
 130         /*
 131          * Allows the PolicyEngine to callback to this object to
 132          * notify that there is an event ready to be pulled
 133          * from the queue
 134          */
 135         for (TopicSink sink : noopTopics) {
 136             assertTrue(sink.start());
 137             sink.register(this);
 138         }
 139
 140         /*
 141          * Create a unique requestId
 142          */
 143         requestID = UUID.randomUUID();
 144
 145         /*
 146          * Simulate an onset event the policy engine will
 147          * receive from DCAE to kick off processing through
 148          * the rules
 149          */
 150         sendEvent(pair.a, requestID, ControlLoopEventStatus.ONSET);
 151
 152         kieSession.fireUntilHalt();
 153
 154         /*
 155          * The only fact in memory should be Params
 156          */
 157         assertEquals(1, kieSession.getFactCount());
 158
 159         /*
 160          * Print what's left in memory
 161          */
 162         dumpFacts(kieSession);
 163     }
 164
 165     @Test
 166     public void namedQueryFailTest() {
 167
 168         /*
 169          * Allows the PolicyEngine to callback to this object to
 170          * notify that there is an event ready to be pulled
 171          * from the queue
 172          */
 173         for (TopicSink sink : noopTopics) {
 174             assertTrue(sink.start());
 175             sink.register(this);
 176         }
 177
 178         /*
 179          * Create a unique requestId
 180          */
 181         requestID = UUID.randomUUID();
 182
 183         /*
 184          * Simulate an onset event the policy engine will
 185          * receive from DCAE to kick off processing through
 186          * the rules
 187          */
 188         sendEvent(pair.a, requestID, ControlLoopEventStatus.ONSET, "error");
 189
 190         kieSession.fireUntilHalt();
 191
 192         /*
 193          * The only fact in memory should be Params
 194          */
 195         assertEquals(1, kieSession.getFactCount());
 196
 197         /*
 198          * Print what's left in memory
 199          */
 200         dumpFacts(kieSession);
 201     }
 202
 203     @Test
 204     public void aaiGetFailTest() {
 205
 206         /*
 207          * Allows the PolicyEngine to callback to this object to
 208          * notify that there is an event ready to be pulled
 209          * from the queue
 210          */
 211         for (TopicSink sink : noopTopics) {
 212             assertTrue(sink.start());
 213             sink.register(this);
 214         }
 215
 216         /*
 217          * Create a unique requestId
 218          */
 219         requestID = UUID.randomUUID();
 220
 221         /*
 222          * Simulate an onset event the policy engine will
 223          * receive from DCAE to kick off processing through
 224          * the rules
 225          */
 226         sendEvent(pair.a, requestID, ControlLoopEventStatus.ONSET, "getFail");
 227
 228         try {
 229                 kieSession.fireUntilHalt();
 230         }
 231         catch (Exception e) {
 232                 e.printStackTrace();
 233                 logger.warn(e.toString());
 234                 fail(e.getMessage());
 235         }
 236
 237
 238         /*
 239          * The only fact in memory should be Params
 240          */
 241         assertEquals(1, kieSession.getFactCount());
 242
 243         /*
 244          * Print what's left in memory
 245          */
 246         dumpFacts(kieSession);
 247     }
 248
 249     /**
 250      * This method will start a kie session and instantiate
 251      * the Policy Engine.
 252      *
 253      * @param droolsTemplate
 254      *          the DRL rules file
 255      * @param yamlFile
 256      *          the yaml file containing the policies
 257      * @param policyScope
 258      *          scope for policy
 259      * @param policyName
 260      *          name of the policy
 261      * @param policyVersion
 262      *          version of the policy
 263      * @return the kieSession to be used to insert facts
 264      * @throws IOException
 265      */
 266     private static KieSession startSession(String droolsTemplate,
 267             String yamlFile,
 268             String policyScope,
 269             String policyName,
 270             String policyVersion) throws IOException {
 271
 272         /*
 273          * Load policies from yaml
 274          */
 275         pair = Util.loadYaml(yamlFile);
 276         assertNotNull(pair);
 277         assertNotNull(pair.a);
 278         assertNotNull(pair.a.getControlLoop());
 279         assertNotNull(pair.a.getControlLoop().getControlLoopName());
 280         assertTrue(pair.a.getControlLoop().getControlLoopName().length() > 0);
 281
 282         /*
 283          * Construct a kie session
 284          */
 285         final KieSession kieSession = Util.buildContainer(droolsTemplate,
 286                 pair.a.getControlLoop().getControlLoopName(),
 287                 policyScope,
 288                 policyName,
 289                 policyVersion,
 290                 URLEncoder.encode(pair.b, "UTF-8"));
 291
 292         /*
 293          * Retrieve the Policy Engine
 294          */
 295
 296         logger.debug("============");
 297         logger.debug(URLEncoder.encode(pair.b, "UTF-8"));
 298         logger.debug("============");
 299
 300         return kieSession;
 301     }
 302
 303     /*
 304      * (non-Javadoc)
 305      * @see org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.String)
 306      */
 307     public void onTopicEvent(CommInfrastructure commType, String topic, String event) {
 308         /*
 309          * Pull the object that was sent out to DMAAP and make
 310          * sure it is a ControlLoopNoticiation of type active
 311          */
 312         Object obj = null;
 313         if ("POLICY-CL-MGT".equals(topic)) {
 314                 obj = org.onap.policy.controlloop.util.Serialization.gsonJunit.fromJson(event, org.onap.policy.controlloop.VirtualControlLoopNotification.class);
 315         }
 316         assertNotNull(obj);
 317         if (obj instanceof VirtualControlLoopNotification) {
 318             VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj;
 319             String policyName = notification.policyName;
 320             if (policyName.endsWith("EVENT")) {
 321                 logger.debug("Rule Fired: " + notification.policyName);
 322                 if ("getFail".equals(notification.AAI.get("generic-vnf.vnf-id"))) {
 323                         assertEquals(ControlLoopNotificationType.REJECTED, notification.notification);
 324                         kieSession.halt();
 325                 }
 326                 else {
 327                     assertTrue(ControlLoopNotificationType.ACTIVE.equals(notification.notification));
 328                 }
 329             }
 330             else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
 331                 logger.debug("Rule Fired: " + notification.policyName);
 332                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
 333                 assertNotNull(notification.message);
 334                 assertTrue(notification.message.startsWith("Sending guard query"));
 335             }
 336             else if (policyName.endsWith("GUARD.RESPONSE")) {
 337                 logger.debug("Rule Fired: " + notification.policyName);
 338                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
 339                 assertNotNull(notification.message);
 340                 assertTrue(notification.message.toLowerCase().endsWith("permit"));
 341             }
 342             else if (policyName.endsWith("GUARD_PERMITTED")) {
 343                 logger.debug("Rule Fired: " + notification.policyName);
 344                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
 345                 assertNotNull(notification.message);
 346                 assertTrue(notification.message.startsWith("actor=SO"));
 347             }
 348             else if (policyName.endsWith("OPERATION.TIMEOUT")) {
 349                 logger.debug("Rule Fired: " + notification.policyName);
 350                 kieSession.halt();
 351                 logger.debug("The operation timed out");
 352                 fail("Operation Timed Out");
 353             }
 354             else if (policyName.endsWith("SO.RESPONSE")) {
 355                 logger.debug("Rule Fired: " + notification.policyName);
 356                 assertTrue(ControlLoopNotificationType.OPERATION_SUCCESS.equals(notification.notification));
 357                 assertNotNull(notification.message);
 358                 assertTrue(notification.message.startsWith("actor=SO"));
 359             }
 360             else if (policyName.endsWith("EVENT.MANAGER")) {
 361                 logger.debug("Rule Fired: " + notification.policyName);
 362                 if ("error".equals(notification.AAI.get("vserver.vserver-name"))) {
 363                         assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notification.notification);
 364                 }
 365                 else {
 366                         assertTrue(ControlLoopNotificationType.FINAL_SUCCESS.equals(notification.notification));
 367                 }
 368                 kieSession.halt();
 369             }
 370             else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
 371                 logger.debug("Rule Fired: " + notification.policyName);
 372                 kieSession.halt();
 373                 logger.debug("The control loop timed out");
 374                 fail("Control Loop Timed Out");
 375             }
 376         }
 377         else if (obj instanceof SORequest) {
 378             logger.debug("\n============ SO received the request!!! ===========\n");
 379         }
 380     }
 381
 382     /**
 383      * This method is used to simulate event messages from DCAE
 384      * that start the control loop (onset message) or end the
 385      * control loop (abatement message).
 386      *
 387      * @param policy the controlLoopName comes from the policy
 388      * @param requestID the requestId for this event
 389      * @param status could be onset or abated
 390      */
 391     protected void sendEvent(ControlLoopPolicy policy, UUID requestID, ControlLoopEventStatus status) {
 392         VirtualControlLoopEvent event = new VirtualControlLoopEvent();
 393         event.closedLoopControlName = policy.getControlLoop().getControlLoopName();
 394         event.requestID = requestID;
 395         event.target = "vserver.vserver-name";
 396         event.closedLoopAlarmStart = Instant.now();
 397         event.AAI = new HashMap<>();
 398         event.AAI.put("vserver.vserver-name", "dfw1lb01lb01");
 399         event.AAI.put("vserver.is-closed-loop-disabled", "false");
 400         event.closedLoopEventStatus = status;
 401         kieSession.insert(event);
 402     }
 403
 404     protected void sendEvent(ControlLoopPolicy policy, UUID requestID, ControlLoopEventStatus status, String vserverName) {
 405         VirtualControlLoopEvent event = new VirtualControlLoopEvent();
 406         event.closedLoopControlName = policy.getControlLoop().getControlLoopName();
 407         event.requestID = requestID;
 408         event.target = "vserver.vserver-name";
 409         event.closedLoopAlarmStart = Instant.now();
 410         event.AAI = new HashMap<>();
 411         event.AAI.put("vserver.vserver-name", vserverName);
 412         event.closedLoopEventStatus = status;
 413         kieSession.insert(event);
 414     }
 415
 416     /**
 417      * This method will dump all the facts in the working memory.
 418      *
 419      * @param kieSession the session containing the facts
 420      */
 421     public void dumpFacts(KieSession kieSession) {
 422         logger.debug("Fact Count: {}", kieSession.getFactCount());
 423         for (FactHandle handle : kieSession.getFactHandles()) {
 424             logger.debug("FACT: {}", handle);
 425         }
 426     }
 427 }