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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2021, 2023 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.controlloop.eventmanager;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Deque;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.atomic.AtomicReference;
import org.drools.core.WorkingMemory;
import org.drools.core.common.InternalFactHandle;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardYamlCoder;
import org.onap.policy.common.utils.io.Serializer;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.controlloop.ControlLoopException;
import org.onap.policy.controlloop.actorserviceprovider.ActorService;
import org.onap.policy.controlloop.actorserviceprovider.Operation;
import org.onap.policy.controlloop.actorserviceprovider.OperationFinalResult;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.Operator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
import org.onap.policy.drools.core.lock.LockCallback;
import org.onap.policy.drools.core.lock.LockImpl;
import org.onap.policy.drools.core.lock.LockState;
import org.onap.policy.drools.system.PolicyEngine;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
@RunWith(MockitoJUnitRunner.class)
public class ClEventManagerWithStepsTest {
private static final UUID REQ_ID = UUID.randomUUID();
private static final String CL_NAME = "my-closed-loop-name";
private static final String POLICY_NAME = "my-policy-name";
private static final String POLICY_SCOPE = "my-scope";
private static final String POLICY_VERSION = "1.2.3";
private static final String SIMPLE_ACTOR = "First";
private static final String SIMPLE_OPERATION = "OperationA";
private static final String MY_TARGET = "my-target";
private static final String EVENT_MGR_MULTI_YAML =
"../eventmanager/src/test/resources/eventManager/event-mgr-multi.yaml";
private static final String EVENT_MGR_SIMPLE_YAML =
"../eventmanager/src/test/resources/eventManager/event-mgr-simple.yaml";
private static final Coder yamlCoder = new StandardYamlCoder();
private static final String OUTCOME_MSG = "my outcome message";
private static final String MY_SINK = "my-topic-sink";
@Mock
private PolicyEngine engineMgr;
@Mock
private WorkingMemory workMem;
@Mock
private InternalFactHandle factHandle;
@Mock
private Operator policyOperator;
@Mock
private Operation policyOperation;
@Mock
private Actor policyActor;
@Mock
private ExecutorService executor;
@Mock
private EventManagerServices services;
@Mock
private ActorService actors;
@Mock
private MyStep stepa;
@Mock
private MyStep stepb;
private List<LockImpl> locks;
private ToscaPolicy tosca;
private ControlLoopParams params;
private ClEventManagerWithSteps<MyStep> mgr;
/**
* Sets up.
*/
@Before
public void setUp() throws ControlLoopException, CoderException {
when(services.getActorService()).thenReturn(actors);
when(workMem.getFactHandle(any())).thenReturn(factHandle);
params = new ControlLoopParams();
params.setClosedLoopControlName(CL_NAME);
params.setPolicyName(POLICY_NAME);
params.setPolicyScope(POLICY_SCOPE);
params.setPolicyVersion(POLICY_VERSION);
loadPolicy(EVENT_MGR_SIMPLE_YAML);
locks = new ArrayList<>();
mgr = new MyManager(services, params, REQ_ID, workMem);
}
@Test
public void testConstructor() {
assertEquals(POLICY_NAME, mgr.getPolicyName());
// invalid
assertThatThrownBy(() -> new MyManager(services, params, null, workMem))
.isInstanceOf(ControlLoopException.class);
}
@Test
public void testDestroy_testGetSteps() {
// add some steps to the queue
mgr.getSteps().add(stepa);
mgr.getSteps().add(stepb);
mgr.destroy();
verify(stepa).cancel();
verify(stepb).cancel();
// if superclass destroy() was invoked, then freeLock() should have been submitted
// to the executor
verify(executor).execute(any());
}
@Test
public void testOnStart() throws ControlLoopException {
OperationOutcome outcome = makeOutcome();
mgr.start();
mgr.onStart(outcome);
assertSame(outcome, mgr.getOutcomes().poll());
assertThat(mgr.getOutcomes()).isEmpty();
verify(workMem).update(factHandle, mgr);
}
@Test
public void testOnComplete() throws ControlLoopException {
OperationOutcome outcome = makeCompletedOutcome();
mgr.start();
mgr.onComplete(outcome);
assertSame(outcome, mgr.getOutcomes().poll());
assertThat(mgr.getOutcomes()).isEmpty();
verify(workMem).update(factHandle, mgr);
}
@Test
public void testToString() {
assertNotNull(mgr.toString());
}
@Test
public void testStart() throws ControlLoopException {
// start it
mgr.start();
// cannot re-start
assertThatCode(() -> mgr.start()).isInstanceOf(IllegalStateException.class)
.hasMessage("manager already started");
}
/**
* Tests start() when the manager is not in working memory.
*/
@Test
public void testStartNotInWorkingMemory() throws ControlLoopException {
when(workMem.getFactHandle(any())).thenReturn(null);
assertThatCode(() -> mgr.start()).isInstanceOf(IllegalStateException.class)
.hasMessage("manager is not in working memory");
}
/**
* Tests start() when the manager is not active.
*/
@Test
public void testStartInactive() throws Exception {
// make an inactive manager by deserializing it
RealManager mgr2 = Serializer.roundTrip(new RealManager(services, params, REQ_ID, workMem));
mgr = mgr2;
// cannot re-start
assertThatCode(() -> mgr.start()).isInstanceOf(IllegalStateException.class)
.hasMessage("manager is no longer active");
}
@Test
public void testAbort() {
mgr.abort(ClEventManagerWithSteps.State.DONE, OperationFinalResult.FINAL_FAILURE_GUARD, "some message");
assertEquals(ClEventManagerWithSteps.State.DONE, mgr.getState());
assertEquals(OperationFinalResult.FINAL_FAILURE_GUARD, mgr.getFinalResult());
assertEquals("some message", mgr.getFinalMessage());
// try null state
assertThatThrownBy(() -> mgr.abort(null, OperationFinalResult.FINAL_FAILURE_GUARD, ""))
.isInstanceOf(NullPointerException.class).hasMessageContaining("finalState");
}
@Test
public void testLoadNextPolicy() throws Exception {
loadPolicy(EVENT_MGR_MULTI_YAML);
mgr = new MyManager(services, params, REQ_ID, workMem);
// start and load step for first policy
mgr.start();
assertEquals("OperationA", mgr.getSteps().poll().getOperationName());
assertNull(mgr.getFinalResult());
// indicate success and load next policy
mgr.loadNextPolicy(OperationResult.SUCCESS);
assertEquals("OperationB", mgr.getSteps().poll().getOperationName());
assertNull(mgr.getFinalResult());
// indicate failure - should go to final failure
mgr.loadNextPolicy(OperationResult.FAILURE);
assertEquals(OperationFinalResult.FINAL_FAILURE, mgr.getFinalResult());
}
@Test
public void testLoadPolicy() throws ControlLoopException {
// start() will invoke loadPolicy()
mgr.start();
assertNull(mgr.getFinalResult());
MyStep step = mgr.getSteps().peek();
assertNotNull(step);
assertEquals("First", step.getActorName());
assertEquals("OperationA", step.getOperationName());
ControlLoopOperationParams params2 = step.getParams();
assertSame(actors, params2.getActorService());
assertSame(REQ_ID, params2.getRequestId());
assertSame(ForkJoinPool.commonPool(), params2.getExecutor());
assertNotNull(params2.getTargetType());
assertNotNull(params2.getTargetEntityIds());
assertEquals(Integer.valueOf(300), params2.getTimeoutSec());
assertEquals(Integer.valueOf(0), params2.getRetry());
assertThat(params2.getPayload()).isEmpty();
assertNotNull(params2.getStartCallback());
assertNotNull(params2.getCompleteCallback());
}
@Test
public void testLoadPreprocessorSteps() {
stepa = new MyStep(mgr, ControlLoopOperationParams.builder().build()) {
@Override
protected Operation buildOperation() {
return policyOperation;
}
};
Deque<MyStep> steps = mgr.getSteps();
steps.add(stepa);
steps.add(stepb);
mgr.loadPreprocessorSteps();
// no additional steps should have been loaded
assertThat(steps).hasSize(2);
assertSame(stepa, steps.poll());
assertSame(stepb, steps.poll());
assertThat(steps).isEmpty();
assertNotNull(stepa.getOperation());
assertNull(stepb.getOperation());
}
/**
* Tests loadPreprocessorSteps() when there are too many steps in the queue.
*/
@Test
public void testLoadPreprocessorStepsTooManySteps() {
stepa = new MyStep(mgr, ControlLoopOperationParams.builder().build()) {
@Override
protected Operation buildOperation() {
return policyOperation;
}
};
Deque<MyStep> steps = mgr.getSteps();
// load up a bunch of steps
for (int nsteps = 0; nsteps < ClEventManagerWithSteps.MAX_STEPS; ++nsteps) {
steps.add(stepa);
}
// should fail
assertThatIllegalStateException().isThrownBy(() -> mgr.loadPreprocessorSteps()).withMessage("too many steps");
// add another step, should still fail
steps.add(stepa);
assertThatIllegalStateException().isThrownBy(() -> mgr.loadPreprocessorSteps()).withMessage("too many steps");
// remove two steps - should now succeed
steps.remove();
steps.remove();
int nsteps = steps.size();
mgr.loadPreprocessorSteps();
assertEquals(nsteps, steps.size());
}
@Test
public void testExecuteStep() {
// no steps to execute
assertFalse(mgr.executeStep());
// add a step to the queue
mgr.getSteps().add(stepa);
// step returns false
when(stepa.start(anyLong())).thenReturn(false);
assertFalse(mgr.executeStep());
// step returns true
when(stepa.start(anyLong())).thenReturn(true);
assertTrue(mgr.executeStep());
}
@Test
public void testNextStep() {
mgr.getSteps().add(stepa);
mgr.nextStep();
assertThat(mgr.getSteps()).isEmpty();
}
@Test
public void testDeliver() {
mgr.deliver(MY_SINK, null, "null notification", "null rule");
verify(engineMgr, never()).deliver(any(), any());
mgr.deliver(MY_SINK, "publishA", "A notification", "A rule");
verify(engineMgr).deliver(MY_SINK, "publishA");
// cause deliver() to throw an exception
when(engineMgr.deliver(any(), any())).thenThrow(new IllegalStateException("expected exception"));
assertThatCode(() -> mgr.deliver(MY_SINK, "publishB", "B notification", "B rule")).doesNotThrowAnyException();
}
private void loadPolicy(String fileName) throws CoderException {
ToscaServiceTemplate template =
yamlCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
tosca = template.getToscaTopologyTemplate().getPolicies().get(0).values().iterator().next();
params.setToscaPolicy(tosca);
}
private OperationOutcome makeCompletedOutcome() {
OperationOutcome outcome = makeOutcome();
outcome.setEnd(outcome.getStart());
return outcome;
}
private OperationOutcome makeOutcome() {
OperationOutcome outcome = new OperationOutcome();
outcome.setActor(SIMPLE_ACTOR);
outcome.setOperation(SIMPLE_OPERATION);
outcome.setMessage(OUTCOME_MSG);
outcome.setResult(OperationResult.SUCCESS);
outcome.setStart(Instant.now());
outcome.setTarget(MY_TARGET);
return outcome;
}
private class MyManager extends ClEventManagerWithSteps<MyStep> {
private static final long serialVersionUID = 1L;
public MyManager(EventManagerServices services, ControlLoopParams params, UUID requestId, WorkingMemory workMem)
throws ControlLoopException {
super(services, params, requestId, workMem);
}
@Override
protected ExecutorService getBlockingExecutor() {
return executor;
}
@Override
protected void makeLock(String targetEntity, String requestId, int holdSec, LockCallback callback) {
LockImpl lock = new LockImpl(LockState.ACTIVE, targetEntity, requestId, holdSec, callback);
locks.add(lock);
callback.lockAvailable(lock);
}
@Override
protected PolicyEngine getPolicyEngineManager() {
return engineMgr;
}
@Override
protected void loadPolicyStep(ControlLoopOperationParams params) {
getSteps().add(new MyStep(this, params));
}
}
private static class RealManager extends ClEventManagerWithSteps<MyStep> {
private static final long serialVersionUID = 1L;
public RealManager(EventManagerServices services, ControlLoopParams params, UUID requestId,
WorkingMemory workMem) throws ControlLoopException {
super(services, params, requestId, workMem);
}
@Override
protected void loadPolicyStep(ControlLoopOperationParams params) {
getSteps().add(new MyStep(this, params));
}
}
private static class MyStep extends Step {
public MyStep(StepContext stepContext, ControlLoopOperationParams params) {
super(params, new AtomicReference<>());
}
}
}
|