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
|
/*-
* ============LICENSE_START=======================================================
* demo
* ================================================================================
* Copyright (C) 2018-2019 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.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.time.Instant;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.UUID;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.kie.api.runtime.KieSession;
import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
import org.onap.policy.controlloop.ControlLoopEventStatus;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager;
import org.onap.policy.controlloop.policy.ControlLoopPolicy;
import org.onap.policy.drools.protocol.coders.EventProtocolCoderConstants;
import org.onap.policy.drools.protocol.coders.EventProtocolParams;
import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
import org.onap.policy.drools.system.PolicyControllerConstants;
import org.onap.policy.drools.system.PolicyEngineConstants;
import org.onap.policy.drools.utils.logging.LoggerUtil;
import org.onap.policy.template.demo.SupportUtil.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Verifies that event objects are cleaned up when rules are updated. This loads
* <b>two</b> copies of the rule set into a single policy to ensure that the two copies
* interact appropriately with each other's event objects.
*/
public class ControlLoopEventCleanupTest {
private static final Logger logger = LoggerFactory.getLogger(ControlLoopEventCleanupTest.class);
/**
* Number of objects per control loop, including the Params object.
*/
private static int CL_OBJECTS = 7;
private static final String YAML = "src/test/resources/yaml/policy_ControlLoop_EventCleanup-test.yaml";
/**
* YAML to be used when the first rule set is updated.
*/
private static final String YAML2 = "src/test/resources/yaml/policy_ControlLoop_EventCleanup-test2.yaml";
private static final String POLICY_VERSION = "v2.0";
private static final String POLICY_NAME = "CL_CleanupTest";
private static final String POLICY_SCOPE = "type=operational";
private static final String CONTROL_LOOP_NAME = "ControlLoop-Event-Cleanup-Test";
private static final String DROOLS_TEMPLATE = "../archetype-cl-amsterdam/src/main/resources/archetype-resources/"
+ "src/main/resources/__closedLoopControlName__.drl";
// values specific to the second copy of the rules
private static final String YAML_B = "src/test/resources/yaml/policy_ControlLoop_EventCleanup-test-B.yaml";
private static final String POLICY_NAME_B = "CL_CleanupTest_B";
private static final String CONTROL_LOOP_NAME_B = "ControlLoop-Event-Cleanup-Test-B";
private static final String GUARD_DISABLED = "guard.disabled";
private static String saveGuardFlag;
private static KieSession kieSession;
private static SupportUtil.RuleSpec[] specifications;
/**
* Setup the simulator.
*/
@BeforeClass
public static void setUpSimulator() {
LoggerUtil.setLevel(LoggerUtil.ROOT_LOGGER, "INFO");
saveGuardFlag = PolicyEngineConstants.getManager().getEnvironmentProperty(GUARD_DISABLED);
PolicyEngineConstants.getManager().getEnvironment().setProperty(GUARD_DISABLED, "true");
SupportUtil.setAaiProps();
PolicyEngineConstants.getManager().configure(new Properties());
assertTrue(PolicyEngineConstants.getManager().start());
Properties noopSinkProperties = new Properties();
noopSinkProperties.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS, "APPC-CL,POLICY-CL-MGT");
noopSinkProperties.put("noop.sink.topics.APPC-CL.events", "org.onap.policy.appc.Response");
noopSinkProperties.put("noop.sink.topics.APPC-CL.events.custom.gson",
"org.onap.policy.appc.util.Serialization,gsonPretty");
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");
final List<TopicSink> noopTopics = TopicEndpointManager.getManager().addTopicSinks(noopSinkProperties);
EventProtocolCoderConstants.getManager().addEncoder(EventProtocolParams.builder()
.groupId("junit.groupId")
.artifactId("junit.artifactId")
.topic("POLICY-CL-MGT")
.eventClass("org.onap.policy.controlloop.VirtualControlLoopNotification")
.protocolFilter(new JsonProtocolFilter())
.modelClassLoaderHash(1111));
EventProtocolCoderConstants.getManager().addEncoder(EventProtocolParams.builder()
.groupId("junit.groupId")
.artifactId("junit.artifactId")
.topic("APPC-CL")
.eventClass("org.onap.policy.appc.Request")
.protocolFilter(new JsonProtocolFilter())
.modelClassLoaderHash(1111));
try {
SupportUtil.buildAaiSim();
} catch (Exception e) {
logger.error("Could not create simulator", e);
fail("Could not create simulator");
}
for (TopicSink sink : noopTopics) {
assertTrue(sink.start());
}
try {
specifications = new SupportUtil.RuleSpec[2];
specifications[0] = new SupportUtil.RuleSpec(DROOLS_TEMPLATE, CONTROL_LOOP_NAME, POLICY_SCOPE, POLICY_NAME,
POLICY_VERSION, loadYaml(YAML));
specifications[1] = new SupportUtil.RuleSpec(DROOLS_TEMPLATE, CONTROL_LOOP_NAME_B, POLICY_SCOPE,
POLICY_NAME_B, POLICY_VERSION, loadYaml(YAML_B));
kieSession = SupportUtil.buildContainer(POLICY_VERSION, specifications);
} catch (IOException e) {
logger.error("Could not create kieSession", e);
fail("Could not create kieSession");
}
}
/**
* Tear down.
*/
@AfterClass
public static void tearDown() {
kieSession.dispose();
PolicyEngineConstants.getManager().stop();
HttpServletServerFactoryInstance.getServerFactory().destroy();
PolicyControllerConstants.getFactory().shutdown();
TopicEndpointManager.getManager().shutdown();
if (saveGuardFlag == null) {
PolicyEngineConstants.getManager().getEnvironment().remove(GUARD_DISABLED);
} else {
PolicyEngineConstants.getManager().getEnvironment().setProperty(GUARD_DISABLED, saveGuardFlag);
}
}
@Ignore
@Test
public void test() throws IOException {
/*
* Let rules create Params objects.
*/
kieSession.fireAllRules();
injectEvent(CONTROL_LOOP_NAME);
injectEvent(CONTROL_LOOP_NAME_B);
kieSession.fireAllRules();
List<Object> facts = getSessionObjects();
// should have events for both control loops
assertEquals(2 * CL_OBJECTS, facts.size());
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME));
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME_B));
logger.info("UPDATING VERSION TO v3.0");
updatePolicy(YAML2, "v3.0");
/*
* Let rules update Params objects. The Params for the first set of rules should
* now be deleted and replaced with a new one, while the Params for the second set
* should be unchanged.
*/
kieSession.fireAllRules();
facts = getSessionObjects();
// should only have event for second control loop + 1 Params for first control loop
assertEquals(CL_OBJECTS + 1, facts.size());
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME_B));
// add event for first control loop again
injectEvent(CONTROL_LOOP_NAME);
kieSession.fireAllRules();
logger.info("UPDATING VERSION TO v4.0");
updatePolicy(YAML, "v4.0");
/*
* Let rules update Params objects. The Params for the first set of rules should
* now be deleted and replaced with a new one, while the Params for the second set
* should be unchanged.
*/
kieSession.fireAllRules();
facts = getSessionObjects();
// should only have event for second control loop + 1 Params for first control loop
assertEquals(CL_OBJECTS + 1, facts.size());
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME_B));
// add event for first control loop again
injectEvent(CONTROL_LOOP_NAME);
kieSession.fireAllRules();
logger.info("UPDATING VERSION TO v4.0 (i.e., unchanged)");
updatePolicy(YAML, "v4.0");
/*
* Let rules update Params objects. As the version (and YAML) are unchanged for
* either rule set, both Params objects should be unchanged.
*/
kieSession.fireAllRules();
facts = getSessionObjects();
// should have events for both control loops
assertEquals(2 * CL_OBJECTS, facts.size());
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME));
assertTrue(hasEvent(facts, CONTROL_LOOP_NAME_B));
/*
* Now we'll delete the first rule set. That won't actually have any immediate
* effect, so then we'll update the second rule set, which should trigger a
* clean-up of both.
*/
SupportUtil.RuleSpec[] specs = new SupportUtil.RuleSpec[1];
specs[0] = specifications[1];
logger.info("UPDATING VERSION TO v5.0 - DELETED RULE SET");
SupportUtil.updateContainer("v5.0", specs);
specs[0] = new SupportUtil.RuleSpec(DROOLS_TEMPLATE, CONTROL_LOOP_NAME_B, POLICY_SCOPE, POLICY_NAME_B,
POLICY_VERSION, loadYaml(YAML));
logger.info("UPDATING VERSION TO v6.0 - UPDATED SECOND RULE SET");
SupportUtil.updateContainer("v6.0", specs);
kieSession.fireAllRules();
facts = getSessionObjects();
// only 1 Params should remain, for second rule set, but events should be gone
assertEquals(1, facts.size());
assertTrue(facts.stream().anyMatch(obj -> obj.toString().startsWith("Params( ")));
}
/**
* Updates the policy, changing the YAML associated with the first rule set.
*
* @param yamlFile name of the YAML file
* @param policyVersion policy version
* @throws IOException if an error occurs
*/
private static void updatePolicy(String yamlFile, String policyVersion) throws IOException {
specifications[0] = new SupportUtil.RuleSpec(DROOLS_TEMPLATE, CONTROL_LOOP_NAME, POLICY_SCOPE, POLICY_NAME,
policyVersion, loadYaml(yamlFile));
/*
* Update the policy within the container.
*/
SupportUtil.updateContainer(policyVersion, specifications);
}
/**
* Loads a YAML file and URL-encodes it.
*
* @param yamlFile name of the YAML file
* @return the contents of the specified file, URL-encoded
* @throws UnsupportedEncodingException if an error occurs
*/
private static String loadYaml(String yamlFile) throws UnsupportedEncodingException {
Pair<ControlLoopPolicy, String> 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);
return URLEncoder.encode(pair.second, "UTF-8");
}
/**
* Gets the session objects.
*
* @return the session objects
*/
private static List<Object> getSessionObjects() {
// sort the objects so we know the order
LinkedList<Object> lst = new LinkedList<>(kieSession.getObjects());
lst.sort((left, right) -> left.toString().compareTo(right.toString()));
lst.forEach(obj -> logger.info("obj={}", obj));
return lst;
}
/**
* Injects an ONSET event into the rule engine.
*
* @param controlLoopName the control loop name
*/
private void injectEvent(String controlLoopName) {
VirtualControlLoopEvent event = new VirtualControlLoopEvent();
event.setClosedLoopControlName(controlLoopName);
UUID reqid = UUID.randomUUID();
event.setRequestId(reqid);
event.setTarget("generic-vnf.vnf-id");
event.setClosedLoopAlarmStart(Instant.now());
event.setAai(new HashMap<>());
event.getAai().put("generic-vnf.vnf-id", "vnf-" + reqid.toString());
event.getAai().put(ControlLoopEventManager.GENERIC_VNF_IS_CLOSED_LOOP_DISABLED, "false");
event.setClosedLoopEventStatus(ControlLoopEventStatus.ONSET);
kieSession.insert(event);
}
/**
* Determines if the facts contain an event for the given control loop.
*
* @param facts session facts to be checked
* @param controlLoopName name of the control loop of interest
* @return {@code true} if the facts contain an event for the given control loop,
* {@code false} otherwise
*/
private boolean hasEvent(List<Object> facts, String controlLoopName) {
return (facts.stream().anyMatch(obj -> obj instanceof VirtualControlLoopEvent
&& controlLoopName.equals(((VirtualControlLoopEvent) obj).getClosedLoopControlName())));
}
}
|