6dbe17ee2cf58f44888a63ddff93ffe0e21c2d39
[policy/drools-applications.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * demo
4  * ================================================================================
5  * Copyright (C) 2017-2019 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 import org.junit.AfterClass;
36 import org.junit.BeforeClass;
37 import org.junit.Test;
38 import org.kie.api.runtime.KieSession;
39 import org.kie.api.runtime.rule.FactHandle;
40 import org.onap.policy.appclcm.LcmRequest;
41 import org.onap.policy.appclcm.LcmRequestWrapper;
42 import org.onap.policy.appclcm.LcmResponse;
43 import org.onap.policy.appclcm.LcmResponseWrapper;
44 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
45 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
46 import org.onap.policy.common.endpoints.event.comm.TopicListener;
47 import org.onap.policy.common.endpoints.event.comm.TopicSink;
48 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
49 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
50 import org.onap.policy.controlloop.ControlLoopEventStatus;
51 import org.onap.policy.controlloop.ControlLoopNotificationType;
52 import org.onap.policy.controlloop.VirtualControlLoopEvent;
53 import org.onap.policy.controlloop.VirtualControlLoopNotification;
54 import org.onap.policy.controlloop.policy.ControlLoopPolicy;
55 import org.onap.policy.drools.protocol.coders.EventProtocolCoder;
56 import org.onap.policy.drools.protocol.coders.EventProtocolParams;
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 SupportUtil.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         SupportUtil.setAaiProps();
79         SupportUtil.setGuardProps();
80         SupportUtil.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 = TopicEndpointManager.getManager().addTopicSinks(noopSinkProperties);
100
101         EventProtocolCoder.manager.addEncoder(EventProtocolParams.builder()
102                 .groupId("junit.groupId")
103                 .artifactId("junit.artifactId")
104                 .topic("POLICY-CL-MGT")
105                 .eventClass("org.onap.policy.controlloop.VirtualControlLoopNotification")
106                 .protocolFilter(new JsonProtocolFilter())
107                 .modelClassLoaderHash(1111));
108         EventProtocolCoder.manager.addEncoder(EventProtocolParams.builder()
109                 .groupId("junit.groupId")
110                 .artifactId("junit.artifactId")
111                 .topic("APPC-LCM-READ")
112                 .eventClass("org.onap.policy.appclcm.LcmRequestWrapper")
113                 .protocolFilter(new JsonProtocolFilter())
114                 .modelClassLoaderHash(1111));
115         try {
116             SupportUtil.buildAaiSim();
117             SupportUtil.buildGuardSim();
118         } catch (Exception e) {
119             fail(e.getMessage());
120         }
121
122         /*
123          * Start the kie session
124          */
125         try {
126             kieSession = startSession(
127                     "../archetype-cl-amsterdam/src/main/resources/archetype-resources"
128                     + "/src/main/resources/__closedLoopControlName__.drl",
129                     "src/test/resources/yaml/policy_ControlLoop_vCPE.yaml",
130                     "service=ServiceDemo;resource=Res1Demo;type=operational", "CL_vCPE",
131                     "org.onap.closed_loop.ServiceDemo:VNFS:1.0.0");
132         } catch (IOException e) {
133             e.printStackTrace();
134             logger.debug("Could not create kieSession");
135             fail("Could not create kieSession");
136         }
137     }
138
139     /**
140      * Tear down simulator.
141      */
142     @AfterClass
143     public static void tearDownSimulator() {
144         /*
145          * Gracefully shut down the kie session
146          */
147         kieSession.dispose();
148
149         PolicyEngine.manager.stop();
150         HttpServletServerFactoryInstance.getServerFactory().destroy();
151         PolicyController.factory.shutdown();
152         TopicEndpointManager.getManager().shutdown();
153     }
154
155     /**
156      * This test case tests the scenario where 3 events occur and 2 of the requests refer to the
157      * same target entity while the 3rd is for another entity. The expected result is that the event
158      * with the duplicate target entity will have a final success result for one of the events, and
159      * a rejected message for the one that was unable to obtain the lock. The event that is
160      * referring to a different target entity should be able to obtain a lock since it is a
161      * different target. After processing of all events there should only be the params object left
162      * in memory.
163      */
164     @Test
165     public void targetLockedTest() {
166
167         /*
168          * Allows the PolicyEngine to callback to this object to notify that there is an event ready
169          * to be pulled from the queue
170          */
171         for (TopicSink sink : noopTopics) {
172             assertTrue(sink.start());
173             sink.register(this);
174         }
175
176         /*
177          * Create a unique requestId
178          */
179         requestId = UUID.randomUUID();
180
181         /*
182          * This will be a unique request for another target entity
183          */
184         requestId2 = UUID.randomUUID();
185
186         /*
187          * This will be a request duplicating the target entity of the first request
188          */
189         requestId3 = UUID.randomUUID();
190
191         /*
192          * Simulate an onset event the policy engine will receive from DCAE to kick off processing
193          * through the rules
194          */
195         sendEvent(pair.first, requestId, ControlLoopEventStatus.ONSET, "vnf01");
196
197         /*
198          * Send a second event requesting an action for a different target entity
199          */
200         sendEvent(pair.first, requestId2, ControlLoopEventStatus.ONSET, "vnf02");
201
202         /*
203          * Send a second event for a different target to ensure there are no problems with obtaining
204          * a lock for a different
205          */
206         kieSession.fireUntilHalt();
207
208         // allow object clean-up
209         kieSession.fireAllRules();
210
211         /*
212          * The only fact in memory should be Params
213          */
214         assertEquals(1, kieSession.getFactCount());
215
216         /*
217          * Print what's left in memory
218          */
219         dumpFacts(kieSession);
220
221     }
222
223     /**
224      * This method will start a kie session and instantiate the Policy Engine.
225      *
226      * @param droolsTemplate the DRL rules file
227      * @param yamlFile the yaml file containing the policies
228      * @param policyScope scope for policy
229      * @param policyName name of the policy
230      * @param policyVersion version of the policy
231      * @return the kieSession to be used to insert facts
232      * @throws IOException throws IO exception
233      */
234     private static KieSession startSession(String droolsTemplate, String yamlFile, String policyScope,
235             String policyName, String policyVersion) throws IOException {
236
237         /*
238          * Load policies from yaml
239          */
240         pair = SupportUtil.loadYaml(yamlFile);
241         assertNotNull(pair);
242         assertNotNull(pair.first);
243         assertNotNull(pair.first.getControlLoop());
244         assertNotNull(pair.first.getControlLoop().getControlLoopName());
245         assertTrue(pair.first.getControlLoop().getControlLoopName().length() > 0);
246
247         /*
248          * Construct a kie session
249          */
250         final KieSession kieSession = SupportUtil.buildContainer(droolsTemplate,
251                 pair.first.getControlLoop().getControlLoopName(),
252                 policyScope, policyName, policyVersion, URLEncoder.encode(pair.second, "UTF-8"));
253
254         /*
255          * Retrieve the Policy Engine
256          */
257
258         logger.debug("============");
259         logger.debug(URLEncoder.encode(pair.second, "UTF-8"));
260         logger.debug("============");
261
262         return kieSession;
263     }
264
265     /*
266      * (non-Javadoc)
267      *
268      * @see org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.String)
269      */
270     @Override
271     public void onTopicEvent(CommInfrastructure commType, String topic, String event) {
272         /*
273          * Pull the object that was sent out to DMAAP and make sure it is a ControlLoopNoticiation
274          * of type active
275          */
276         Object obj = null;
277         if ("POLICY-CL-MGT".equals(topic)) {
278             obj = org.onap.policy.controlloop.util.Serialization.gsonJunit.fromJson(event,
279                     org.onap.policy.controlloop.VirtualControlLoopNotification.class);
280         } else if ("APPC-LCM-READ".equals(topic)) {
281             obj = org.onap.policy.appclcm.util.Serialization.gsonJunit.fromJson(event,
282                     org.onap.policy.appclcm.LcmRequestWrapper.class);
283         }
284         assertNotNull(obj);
285         if (obj instanceof VirtualControlLoopNotification) {
286             VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj;
287             String policyName = notification.getPolicyName();
288             if (policyName.endsWith("EVENT")) {
289                 logger.debug("Rule Fired: " + notification.getPolicyName());
290                 assertTrue(ControlLoopNotificationType.ACTIVE.equals(notification.getNotification()));
291             } else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
292                 logger.debug("Rule Fired: " + notification.getPolicyName());
293                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
294                 assertNotNull(notification.getMessage());
295                 assertTrue(notification.getMessage().startsWith("Sending guard query"));
296             } else if (policyName.endsWith("GUARD.RESPONSE")) {
297                 logger.debug("Rule Fired: " + notification.getPolicyName());
298                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
299                 assertNotNull(notification.getMessage());
300                 assertTrue(notification.getMessage().toLowerCase().endsWith("permit"));
301             } else if (policyName.endsWith("GUARD_PERMITTED")) {
302                 logger.debug("Rule Fired: " + notification.getPolicyName());
303                 assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.getNotification()));
304                 assertNotNull(notification.getMessage());
305                 assertTrue(notification.getMessage().startsWith("actor=APPC"));
306             } else if (policyName.endsWith("OPERATION.TIMEOUT")) {
307                 logger.debug("Rule Fired: " + notification.getPolicyName());
308                 kieSession.halt();
309                 logger.debug("The operation timed out");
310                 fail("Operation Timed Out");
311             } else if (policyName.endsWith("APPC.LCM.RESPONSE")) {
312                 logger.debug("Rule Fired: " + notification.getPolicyName());
313                 assertTrue(ControlLoopNotificationType.OPERATION_SUCCESS.equals(notification.getNotification()));
314                 assertNotNull(notification.getMessage());
315                 assertTrue(notification.getMessage().startsWith("actor=APPC"));
316                 if (requestId.equals(notification.getRequestId())) {
317                     sendEvent(pair.first, requestId, ControlLoopEventStatus.ABATED, "vnf01");
318                 } else if (requestId2.equals(notification.getRequestId())) {
319                     sendEvent(pair.first, requestId2, ControlLoopEventStatus.ABATED, "vnf02");
320                 }
321             } else if (policyName.endsWith("EVENT.MANAGER")) {
322                 logger.debug("Rule Fired: " + notification.getPolicyName());
323                 if (requestId3.equals(notification.getRequestId())) {
324                     /*
325                      * The event with the duplicate target should be rejected
326                      */
327                     assertTrue(ControlLoopNotificationType.REJECTED.equals(notification.getNotification()));
328                 } else {
329                     assertTrue(ControlLoopNotificationType.FINAL_SUCCESS.equals(notification.getNotification()));
330                 }
331                 if (++eventCount == 3) {
332                     kieSession.halt();
333                 }
334             } else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
335                 logger.debug("Rule Fired: " + notification.getPolicyName());
336                 kieSession.halt();
337                 logger.debug("The control loop timed out");
338                 fail("Control Loop Timed Out");
339             }
340         } else if (obj instanceof LcmRequestWrapper) {
341             /*
342              * The request should be of type LCMRequestWrapper and the subrequestid should be 1
343              */
344             LcmRequestWrapper dmaapRequest = (LcmRequestWrapper) obj;
345             LcmRequest appcRequest = dmaapRequest.getBody();
346             assertTrue(appcRequest.getCommonHeader().getSubRequestId().equals("1"));
347
348             logger.debug("\n============ APPC received the request!!! ===========\n");
349
350             /*
351              * Simulate a success response from APPC and insert the response into the working memory
352              */
353             LcmResponseWrapper dmaapResponse = new LcmResponseWrapper();
354             LcmResponse appcResponse = new LcmResponse(appcRequest);
355             appcResponse.getStatus().setCode(400);
356             appcResponse.getStatus().setMessage("AppC success");
357             dmaapResponse.setBody(appcResponse);
358
359             /*
360              * Interrupting with a different request for the same target entity to check if lock
361              * will be denied
362              */
363             if (requestId.equals(appcResponse.getCommonHeader().getRequestId())) {
364                 sendEvent(pair.first, requestId3, ControlLoopEventStatus.ONSET, "vnf01");
365             }
366             kieSession.insert(dmaapResponse);
367         }
368     }
369
370     /**
371      * This method is used to simulate event messages from DCAE that start the control loop (onset
372      * message) or end the control loop (abatement message).
373      *
374      * @param policy the controlLoopName comes from the policy
375      * @param requestId the requestId for this event
376      * @param status could be onset or abated
377      * @param target the target entity to take an action on
378      */
379     protected void sendEvent(ControlLoopPolicy policy, UUID requestId, ControlLoopEventStatus status, String target) {
380         VirtualControlLoopEvent event = new VirtualControlLoopEvent();
381         event.setClosedLoopControlName(policy.getControlLoop().getControlLoopName());
382         event.setRequestId(requestId);
383         event.setTarget("generic-vnf.vnf-id");
384         event.setClosedLoopAlarmStart(Instant.now());
385         event.setAai(new HashMap<>());
386         event.getAai().put("generic-vnf.vnf-id", target);
387         event.setClosedLoopEventStatus(status);
388         kieSession.insert(event);
389     }
390
391     /**
392      * This method will dump all the facts in the working memory.
393      *
394      * @param kieSession the session containing the facts
395      */
396     public void dumpFacts(KieSession kieSession) {
397         logger.debug("Fact Count: {}", kieSession.getFactCount());
398         for (FactHandle handle : kieSession.getFactHandles()) {
399             logger.debug("FACT: {}", handle);
400         }
401     }
402
403 }
404