1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
/*-
* ============LICENSE_START=======================================================
* demo
* ================================================================================
* Copyright (C) 2017-2018 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<? extends TopicSink> noopTopics;
private static KieSession kieSession;
private static SupportUtil.Pair<ControlLoopPolicy, String> 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())
.customGsonCoder(null)
.customJacksonCoder(null)
.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())
.customGsonCoder(null)
.customJacksonCoder(null)
.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);
}
}
}
|