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
|
/*-
* ============LICENSE_START=======================================================
* demo
* ================================================================================
* Copyright (C) 2017 Intel Corp. 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.controlloop.ControlLoopEventStatus;
import org.onap.policy.controlloop.ControlLoopNotificationType;
import org.onap.policy.controlloop.ControlLoopTargetType;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.VirtualControlLoopNotification;
import org.onap.policy.controlloop.policy.ControlLoopPolicy;
import org.onap.policy.drools.event.comm.TopicEndpoint;
import org.onap.policy.drools.event.comm.TopicListener;
import org.onap.policy.drools.event.comm.TopicSink;
import org.onap.policy.drools.event.comm.Topic.CommInfrastructure;
import org.onap.policy.drools.http.server.HttpServletServer;
import org.onap.policy.drools.properties.PolicyProperties;
import org.onap.policy.drools.protocol.coders.EventProtocolCoder;
import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
import org.onap.policy.drools.system.PolicyEngine;
import org.onap.policy.vfc.VFCRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class VFCControlLoopTest implements TopicListener {
private static final Logger logger = LoggerFactory.getLogger(VFCControlLoopTest.class);
private static List<? extends TopicSink> noopTopics;
private static KieSession kieSession;
private static Util.Pair<ControlLoopPolicy, String> pair;
private UUID requestID;
static {
/* Set environment properties */
Util.setAAIProps();
Util.setVFCProps();
Util.setGuardProps();
Util.setPUProp();
}
@BeforeClass
public static void setUpSimulator() {
PolicyEngine.manager.configure(new Properties());
assertTrue(PolicyEngine.manager.start());
Properties noopSinkProperties = new Properties();
noopSinkProperties.put(PolicyProperties.PROPERTY_NOOP_SINK_TOPICS, "POLICY-CL-MGT");
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("junit.groupId", "junit.artifactId", "POLICY-CL-MGT", "org.onap.policy.controlloop.VirtualControlLoopNotification", new JsonProtocolFilter(), null, null, 1111);
try {
Util.buildAaiSim();
Util.buildVfcSim();
Util.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_VFC.yaml",
"type=operational",
"CL_VoLTE",
"v2.0");
} catch (IOException e) {
e.printStackTrace();
logger.debug("Could not create kieSession");
fail("Could not create kieSession");
}
}
@AfterClass
public static void tearDownSimulator() {
/*
* Gracefully shut down the kie session
*/
kieSession.dispose();
HttpServletServer.factory.destroy();
PolicyEngine.manager.shutdown();
TopicEndpoint.manager.shutdown();
PolicyEngine.manager.stop();
}
@Test
public void successTest() throws IOException {
/*
* 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();
/*
* Simulate an onset event the policy engine will
* receive from DCAE to kick off processing through
* the rules
*/
sendEvent(pair.a, requestID, ControlLoopEventStatus.ONSET);
kieSession.fireUntilHalt();
/*
* 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
*/
private static KieSession startSession(String droolsTemplate,
String yamlFile,
String policyScope,
String policyName,
String policyVersion) throws IOException {
/*
* Load policies from yaml
*/
pair = Util.loadYaml(yamlFile);
assertNotNull(pair);
assertNotNull(pair.a);
assertNotNull(pair.a.getControlLoop());
assertNotNull(pair.a.getControlLoop().getControlLoopName());
assertTrue(pair.a.getControlLoop().getControlLoopName().length() > 0);
/*
* Construct a kie session
*/
final KieSession kieSession = Util.buildContainer(droolsTemplate,
pair.a.getControlLoop().getControlLoopName(),
policyScope,
policyName,
policyVersion,
URLEncoder.encode(pair.b, "UTF-8"));
/*
* Retrieve the Policy Engine
*/
logger.debug("============");
logger.debug(URLEncoder.encode(pair.b, "UTF-8"));
logger.debug("============");
return kieSession;
}
/*
* (non-Javadoc)
* @see org.onap.policy.drools.PolicyEngineListener#newEventNotification(java.lang.String)
*/
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);
}
assertNotNull(obj);
if (obj instanceof VirtualControlLoopNotification) {
VirtualControlLoopNotification notification = (VirtualControlLoopNotification) obj;
String policyName = notification.policyName;
if (policyName.endsWith("EVENT")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.ACTIVE.equals(notification.notification));
}
else if (policyName.endsWith("GUARD_NOT_YET_QUERIED")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
assertNotNull(notification.message);
assertTrue(notification.message.startsWith("Sending guard query"));
}
else if (policyName.endsWith("GUARD.RESPONSE")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
assertNotNull(notification.message);
assertTrue(notification.message.toLowerCase().endsWith("permit"));
}
else if (policyName.endsWith("GUARD_PERMITTED")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.OPERATION.equals(notification.notification));
assertNotNull(notification.message);
assertTrue(notification.message.startsWith("actor=VFC"));
}
else if (policyName.endsWith("OPERATION.TIMEOUT")) {
logger.debug("Rule Fired: " + notification.policyName);
kieSession.halt();
logger.debug("The operation timed out");
fail("Operation Timed Out");
}
else if (policyName.endsWith("VFC.RESPONSE")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.OPERATION_SUCCESS.equals(notification.notification));
assertNotNull(notification.message);
assertTrue(notification.message.startsWith("actor=VFC"));
}
else if (policyName.endsWith("EVENT.MANAGER")) {
logger.debug("Rule Fired: " + notification.policyName);
assertTrue(ControlLoopNotificationType.FINAL_SUCCESS.equals(notification.notification));
kieSession.halt();
}
else if (policyName.endsWith("EVENT.MANAGER.TIMEOUT")) {
logger.debug("Rule Fired: " + notification.policyName);
kieSession.halt();
logger.debug("The control loop timed out");
fail("Control Loop Timed Out");
}
}
else if (obj instanceof VFCRequest) {
logger.debug("\n============ VFC received the request!!! ===========\n");
}
}
/**
* 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
*/
protected void sendEvent(ControlLoopPolicy policy, UUID requestID, ControlLoopEventStatus status) {
VirtualControlLoopEvent event = new VirtualControlLoopEvent();
event.closedLoopControlName = policy.getControlLoop().getControlLoopName();
event.requestID = UUID.randomUUID();
event.closedLoopEventClient = "tca.instance00009";
event.target_type = ControlLoopTargetType.VM;
event.target = "VM_NAME";
event.from = "DCAE";
event.closedLoopAlarmStart = Instant.now();
event.AAI = new HashMap<String, String>();
event.AAI.put("vserver.vserver-name", "vserver-name-16102016-aai3255-data-11-1");
event.AAI.put("vserver.vserver-id", "vserver-id-16102016-aai3255-data-11-1");
event.AAI.put("generic-vnf.vnf-id", "vnf-id-16102016-aai3255-data-11-1");
event.AAI.put("service-instance.service-instance-id", "service-instance-id-16102016-aai3255-data-11-1");
event.AAI.put("vserver.is-closed-loop-disabled", "false");
event.closedLoopEventStatus = ControlLoopEventStatus.ONSET;
kieSession.insert(event);
}
public static void dumpFacts(KieSession kieSession) {
logger.debug("Fact Count: " + kieSession.getFactCount());
for (FactHandle handle : kieSession.getFactHandles()) {
logger.debug("FACT: " + handle);
}
}
}
|
