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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2023 Nordix Foundation.
* ================================================================================
* 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.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
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.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;
import org.onap.policy.controlloop.ophistory.OperationHistoryDataManagerStub;
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.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
class ControlLoopEventManagerTest {
private static final UUID REQ_ID = UUID.randomUUID();
private static final String EXPECTED_EXCEPTION = "expected exception";
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 LOCK1 = "my-lock-A";
private static final String LOCK2 = "my-lock-B";
private static final Coder yamlCoder = new StandardYamlCoder();
private static final String MY_KEY = "def";
private final ExecutorService executor = mock(ExecutorService.class);
private final EventManagerServices services = mock(EventManagerServices.class);
private final OperationHistoryDataManager dataMgr = mock(OperationHistoryDataManager.class);
private long preCreateTimeMs;
private List<LockImpl> locks;
private ToscaPolicy tosca;
private ControlLoopParams params;
private ControlLoopEventManager mgr;
/**
* Sets up.
*/
@BeforeEach
public void setUp() throws ControlLoopException, CoderException {
when(services.getDataManager()).thenReturn(dataMgr);
params = new ControlLoopParams();
params.setClosedLoopControlName(CL_NAME);
params.setPolicyName(POLICY_NAME);
params.setPolicyScope(POLICY_SCOPE);
params.setPolicyVersion(POLICY_VERSION);
loadPolicy("eventManager/event-mgr-simple.yaml");
locks = new ArrayList<>();
preCreateTimeMs = System.currentTimeMillis();
MyManager.executor = executor;
MyManager.locks = locks;
mgr = new MyManager(services, params, REQ_ID);
}
@Test
void testConstructor() {
assertEquals(POLICY_NAME, mgr.getPolicyName());
assertTrue(mgr.isActive());
assertEquals(CL_NAME, mgr.getClosedLoopControlName());
assertSame(REQ_ID, mgr.getRequestId());
assertEquals(POLICY_NAME, mgr.getPolicyName());
assertEquals(POLICY_VERSION, mgr.getPolicyVersion());
assertNotNull(mgr.getProcessor());
assertThat(mgr.getEndTimeMs()).isGreaterThanOrEqualTo(preCreateTimeMs);
}
@Test
void testGetCreateCount() throws ControlLoopException {
long original = ControlLoopEventManager.getCreateCount();
new MyManager(services, params, REQ_ID);
assertEquals(original + 1, ControlLoopEventManager.getCreateCount());
new MyManager(services, params, REQ_ID);
assertEquals(original + 2, ControlLoopEventManager.getCreateCount());
}
@Test
void testIsActive() throws Exception {
mgr = new ControlLoopEventManager(services, params, REQ_ID);
assertTrue(mgr.isActive());
var mgr2 = Serializer.roundTrip(mgr);
assertFalse(mgr2.isActive());
}
@Test
void testDestroy() throws IOException {
mgr.requestLock(LOCK1);
mgr.requestLock(LOCK2);
mgr.requestLock(LOCK1);
// ensure destroy() doesn't throw an exception if the object is deserialized
var mgr2 = Serializer.roundTrip(mgr);
assertThatCode(() -> mgr2.destroy()).doesNotThrowAnyException();
// locks should not have been freed
for (var lock : locks) {
assertFalse(lock.isUnavailable());
}
mgr.destroy();
runExecutor();
for (var lock : locks) {
assertTrue(lock.isUnavailable());
}
}
@Test
void testDetmControlLoopTimeoutMs() throws Exception {
long timeMs = 1200 * 1000L;
long end = mgr.getEndTimeMs();
assertThat(end).isGreaterThanOrEqualTo(preCreateTimeMs + timeMs).isLessThan(preCreateTimeMs + timeMs + 5000);
}
@Test
void testRequestLock() {
final var future1 = mgr.requestLock(LOCK1);
assertTrue(mgr.getOutcomes().isEmpty());
final var future2 = mgr.requestLock(LOCK2);
assertTrue(mgr.getOutcomes().isEmpty());
assertSame(future1, mgr.requestLock(LOCK1));
assertTrue(mgr.getOutcomes().isEmpty());
assertEquals(2, locks.size());
assertTrue(future1.isDone());
assertTrue(future2.isDone());
// indicate that the first lock failed
locks.get(0).notifyUnavailable();
verifyLock(OperationResult.FAILURE, ActorConstants.LOCK_OPERATION);
assertTrue(mgr.getOutcomes().isEmpty());
}
@Test
void testReleaseLock() {
mgr.requestLock(LOCK1);
mgr.requestLock(LOCK2);
// release one lock
final var future = mgr.releaseLock(LOCK1);
// asynchronous, thus should not have executed yet
assertThat(future.isDone()).isFalse();
// asynchronous, thus everything should still be locked
for (var lock : locks) {
assertThat(lock.isUnavailable()).isFalse();
}
runExecutor();
verifyLock(OperationResult.SUCCESS, ActorConstants.UNLOCK_OPERATION);
assertThat(mgr.getOutcomes()).isEmpty();
// first lock should have been released, thus no longer available to the manager
assertThat(locks.get(0).isUnavailable()).isTrue();
// second should still be locked
assertThat(locks.get(1).isUnavailable()).isFalse();
}
/**
* Tests releaseLock() when there is no lock.
*/
@Test
void testReleaseLockNotLocked() {
final var future = mgr.releaseLock(LOCK1);
// lock didn't exist, so the request should already be complete
assertThat(future.isDone()).isTrue();
verifyLock(OperationResult.SUCCESS, ActorConstants.UNLOCK_OPERATION);
assertThat(mgr.getOutcomes()).isEmpty();
}
/**
* Tests releaseLock() when lock.free() throws an exception.
*/
@Test
void testReleaseLockException() throws ControlLoopException {
mgr = new MyManager(services, params, REQ_ID) {
private static final long serialVersionUID = 1L;
@Override
protected void makeLock(String targetEntity, String requestId, int holdSec, LockCallback callback) {
var lock = new LockImpl(LockState.ACTIVE, targetEntity, requestId, holdSec, callback) {
private static final long serialVersionUID = 1L;
@Override
public boolean free() {
throw new RuntimeException(EXPECTED_EXCEPTION);
}
};
locks.add(lock);
callback.lockAvailable(lock);
}
};
mgr.requestLock(LOCK1);
// release the lock
final var future = mgr.releaseLock(LOCK1);
// asynchronous, thus should not have executed yet
assertThat(future.isDone()).isFalse();
runExecutor();
verifyLock(OperationResult.FAILURE_EXCEPTION, ActorConstants.UNLOCK_OPERATION);
assertThat(mgr.getOutcomes()).isEmpty();
}
private void verifyLock(OperationResult result, String lockOperation) {
var outcome = mgr.getOutcomes().poll();
assertNotNull(outcome);
assertEquals(ActorConstants.LOCK_ACTOR, outcome.getActor());
assertEquals(lockOperation, outcome.getOperation());
assertNotNull(outcome.getEnd());
assertTrue(outcome.isFinalOutcome());
assertEquals(result, outcome.getResult());
}
@Test
void testOnStart() {
var outcome1 = new OperationOutcome();
var outcome2 = new OperationOutcome();
mgr.onStart(outcome1);
mgr.onStart(outcome2);
assertSame(outcome1, mgr.getOutcomes().poll());
assertSame(outcome2, mgr.getOutcomes().poll());
assertTrue(mgr.getOutcomes().isEmpty());
}
@Test
void testOnComplete() {
var outcome1 = new OperationOutcome();
var outcome2 = new OperationOutcome();
mgr.onComplete(outcome1);
mgr.onComplete(outcome2);
assertSame(outcome1, mgr.getOutcomes().poll());
assertSame(outcome2, mgr.getOutcomes().poll());
assertTrue(mgr.getOutcomes().isEmpty());
}
@Test
void testContains_testGetProperty_testSetProperty_testRemoveProperty() {
mgr.setProperty("abc", "a string");
mgr.setProperty(MY_KEY, 100);
assertTrue(mgr.contains(MY_KEY));
assertFalse(mgr.contains("ghi"));
var strValue = mgr.getProperty("abc");
assertEquals("a string", strValue);
int intValue = mgr.getProperty(MY_KEY);
assertEquals(100, intValue);
mgr.removeProperty(MY_KEY);
assertFalse(mgr.contains(MY_KEY));
}
/**
* Tests getDataManager() when not disabled.
*/
@Test
void testGetDataManagerNotDisabled() throws ControlLoopException {
assertThat(mgr.getDataManager()).isSameAs(dataMgr);
}
/**
* Tests getDataManager() when guard.disabled=true.
*/
@Test
void testGetDataManagerDisabled() throws ControlLoopException {
mgr = new MyManager(services, params, REQ_ID) {
private static final long serialVersionUID = 1L;
@Override
protected String getEnvironmentProperty(String propName) {
return ("guard.disabled".equals(propName) ? "true" : null);
}
};
assertThat(mgr.getDataManager()).isInstanceOf(OperationHistoryDataManagerStub.class);
}
@Test
void testToString() {
assertNotNull(mgr.toString());
}
private void loadPolicy(String fileName) throws CoderException {
var template = yamlCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
tosca = template.getToscaTopologyTemplate().getPolicies().get(0).values().iterator().next();
params.setToscaPolicy(tosca);
}
private void runExecutor() {
var runCaptor = ArgumentCaptor.forClass(Runnable.class);
verify(executor).execute(runCaptor.capture());
runCaptor.getValue().run();
}
private static class MyManager extends ControlLoopEventManager {
private static final long serialVersionUID = 1L;
private static ExecutorService executor;
private static List<LockImpl> locks;
public MyManager(EventManagerServices services, ControlLoopParams params, UUID requestId)
throws ControlLoopException {
super(services, params, requestId);
}
@Override
protected ExecutorService getBlockingExecutor() {
return executor;
}
@Override
protected void makeLock(String targetEntity, String requestId, int holdSec, LockCallback callback) {
var lock = new LockImpl(LockState.ACTIVE, targetEntity, requestId, holdSec, callback);
locks.add(lock);
callback.lockAvailable(lock);
}
}
}
|