2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controlloop.actorserviceprovider.parameters;
23 import static org.assertj.core.api.Assertions.assertThat;
24 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
25 import static org.junit.Assert.assertEquals;
26 import static org.junit.Assert.assertFalse;
27 import static org.junit.Assert.assertNotNull;
28 import static org.junit.Assert.assertNull;
29 import static org.junit.Assert.assertSame;
30 import static org.junit.Assert.assertTrue;
31 import static org.mockito.ArgumentMatchers.any;
32 import static org.mockito.Mockito.doAnswer;
33 import static org.mockito.Mockito.never;
34 import static org.mockito.Mockito.times;
35 import static org.mockito.Mockito.verify;
36 import static org.mockito.Mockito.when;
39 import java.util.TreeMap;
40 import java.util.UUID;
41 import java.util.concurrent.CompletableFuture;
42 import java.util.concurrent.Executor;
43 import java.util.concurrent.ForkJoinPool;
44 import java.util.concurrent.atomic.AtomicInteger;
45 import java.util.function.Consumer;
46 import java.util.function.Function;
47 import org.junit.Before;
48 import org.junit.Test;
49 import org.mockito.Mock;
50 import org.mockito.MockitoAnnotations;
51 import org.onap.policy.common.parameters.BeanValidationResult;
52 import org.onap.policy.controlloop.VirtualControlLoopEvent;
53 import org.onap.policy.controlloop.actorserviceprovider.ActorService;
54 import org.onap.policy.controlloop.actorserviceprovider.Operation;
55 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
56 import org.onap.policy.controlloop.actorserviceprovider.Operator;
57 import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
58 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams.ControlLoopOperationParamsBuilder;
59 import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
60 import org.onap.policy.controlloop.policy.Target;
62 public class ControlLoopOperationParamsTest {
63 private static final String EXPECTED_EXCEPTION = "expected exception";
64 private static final String ACTOR = "my-actor";
65 private static final String OPERATION = "my-operation";
66 private static final Target TARGET = new Target();
67 private static final String TARGET_ENTITY = "my-target";
68 private static final Integer RETRY = 3;
69 private static final Integer TIMEOUT = 100;
70 private static final UUID REQ_ID = UUID.randomUUID();
76 private ActorService actorService;
79 private Consumer<OperationOutcome> completer;
82 private ControlLoopEventContext context;
85 private VirtualControlLoopEvent event;
88 private Executor executor;
91 private CompletableFuture<OperationOutcome> operFuture;
94 private Operator operator;
97 private Operation operation;
100 private Consumer<OperationOutcome> starter;
102 private Map<String, Object> payload;
104 private ControlLoopOperationParams params;
105 private OperationOutcome outcome;
109 * Initializes mocks and sets {@link #params} to a fully-loaded set of parameters.
112 public void setUp() {
113 MockitoAnnotations.initMocks(this);
115 when(actorService.getActor(ACTOR)).thenReturn(actor);
116 when(actor.getOperator(OPERATION)).thenReturn(operator);
117 when(operator.buildOperation(any())).thenReturn(operation);
118 when(operation.start()).thenReturn(operFuture);
120 when(event.getRequestId()).thenReturn(REQ_ID);
122 when(context.getEvent()).thenReturn(event);
124 payload = new TreeMap<>();
126 params = ControlLoopOperationParams.builder().actorService(actorService).completeCallback(completer)
127 .context(context).executor(executor).actor(ACTOR).operation(OPERATION).payload(payload)
128 .retry(RETRY).target(TARGET).targetEntity(TARGET_ENTITY).timeoutSec(TIMEOUT)
129 .startCallback(starter).preprocessed(true).build();
131 outcome = params.makeOutcome();
135 public void testStart() {
136 assertSame(operFuture, params.start());
138 assertThatIllegalArgumentException().isThrownBy(() -> params.toBuilder().context(null).build().start());
142 public void testBuild() {
143 assertSame(operation, params.build());
145 assertThatIllegalArgumentException().isThrownBy(() -> params.toBuilder().context(null).build().build());
149 public void testGetRequestId() {
150 assertSame(REQ_ID, params.getRequestId());
152 // try with null context
153 assertNull(params.toBuilder().context(null).build().getRequestId());
155 // try with null event
156 when(context.getEvent()).thenReturn(null);
157 assertNull(params.getRequestId());
161 public void testMakeOutcome() {
162 assertEquals(ACTOR, outcome.getActor());
163 assertEquals(OPERATION, outcome.getOperation());
164 checkRemainingFields("with actor");
167 protected void checkRemainingFields(String testName) {
168 assertEquals(testName, TARGET_ENTITY, outcome.getTarget());
169 assertNull(testName, outcome.getStart());
170 assertNull(testName, outcome.getEnd());
171 assertNull(testName, outcome.getSubRequestId());
172 assertNotNull(testName, outcome.getResult());
173 assertNull(testName, outcome.getMessage());
177 public void testCallbackStarted() {
178 params.callbackStarted(outcome);
179 verify(starter).accept(outcome);
181 // modify starter to throw an exception
182 AtomicInteger count = new AtomicInteger();
184 count.incrementAndGet();
185 throw new IllegalStateException(EXPECTED_EXCEPTION);
186 }).when(starter).accept(outcome);
188 params.callbackStarted(outcome);
189 verify(starter, times(2)).accept(outcome);
190 assertEquals(1, count.get());
192 // repeat with no start-callback - no additional calls expected
193 params.toBuilder().startCallback(null).build().callbackStarted(outcome);
194 verify(starter, times(2)).accept(outcome);
195 assertEquals(1, count.get());
197 // should not call complete-callback
198 verify(completer, never()).accept(any());
202 public void testCallbackCompleted() {
203 params.callbackCompleted(outcome);
204 verify(completer).accept(outcome);
206 // modify completer to throw an exception
207 AtomicInteger count = new AtomicInteger();
209 count.incrementAndGet();
210 throw new IllegalStateException(EXPECTED_EXCEPTION);
211 }).when(completer).accept(outcome);
213 params.callbackCompleted(outcome);
214 verify(completer, times(2)).accept(outcome);
215 assertEquals(1, count.get());
217 // repeat with no complete-callback - no additional calls expected
218 params.toBuilder().completeCallback(null).build().callbackCompleted(outcome);
219 verify(completer, times(2)).accept(outcome);
220 assertEquals(1, count.get());
222 // should not call start-callback
223 verify(starter, never()).accept(any());
227 public void testValidateFields() {
228 testValidate("actor", "null", bldr -> bldr.actor(null));
229 testValidate("actorService", "null", bldr -> bldr.actorService(null));
230 testValidate("context", "null", bldr -> bldr.context(null));
231 testValidate("executor", "null", bldr -> bldr.executor(null));
232 testValidate("operation", "null", bldr -> bldr.operation(null));
233 testValidate("target", "null", bldr -> bldr.targetEntity(null));
236 assertTrue(params.toBuilder().build().validate().isValid());
239 assertTrue(params.toBuilder().payload(null).retry(null).target(null).timeoutSec(null).startCallback(null)
240 .completeCallback(null).build().validate().isValid());
242 // test with minimal fields
243 assertTrue(ControlLoopOperationParams.builder().actorService(actorService).context(context).actor(ACTOR)
244 .operation(OPERATION).targetEntity(TARGET_ENTITY).build().validate().isValid());
247 private void testValidate(String fieldName, String expected,
248 Function<ControlLoopOperationParamsBuilder, ControlLoopOperationParamsBuilder> makeInvalid) {
250 // original params should be valid
251 BeanValidationResult result = params.validate();
252 assertTrue(fieldName, result.isValid());
254 // make invalid params
255 result = makeInvalid.apply(params.toBuilder()).build().validate();
256 assertFalse(fieldName, result.isValid());
257 assertThat(result.getResult()).contains(fieldName).contains(expected);
261 public void testBuilder_testToBuilder() {
262 assertEquals(params, params.toBuilder().build());
266 public void testGetActor() {
267 assertSame(ACTOR, params.getActor());
271 public void testGetActorService() {
272 assertSame(actorService, params.getActorService());
276 public void testGetContext() {
277 assertSame(context, params.getContext());
281 public void testGetExecutor() {
282 assertSame(executor, params.getExecutor());
284 // should use default when unspecified
285 assertSame(ForkJoinPool.commonPool(), ControlLoopOperationParams.builder().build().getExecutor());
289 public void testGetOperation() {
290 assertSame(OPERATION, params.getOperation());
294 public void testGetPayload() {
295 assertSame(payload, params.getPayload());
297 // should be null when unspecified
298 assertNull(ControlLoopOperationParams.builder().build().getPayload());
303 assertTrue(params.isPreprocessed());
305 // should be false when unspecified
306 assertFalse(ControlLoopOperationParams.builder().build().isPreprocessed());
310 public void testGetRetry() {
311 assertSame(RETRY, params.getRetry());
313 // should be null when unspecified
314 assertNull(ControlLoopOperationParams.builder().build().getRetry());
318 public void testTarget() {
319 assertSame(TARGET, params.getTarget());
321 // should be null when unspecified
322 assertNull(ControlLoopOperationParams.builder().build().getTarget());
326 public void testGetTimeoutSec() {
327 assertSame(TIMEOUT, params.getTimeoutSec());
329 // should be 300 when unspecified
330 assertEquals(Integer.valueOf(300), ControlLoopOperationParams.builder().build().getTimeoutSec());
332 // null should be ok too
333 assertNull(ControlLoopOperationParams.builder().timeoutSec(null).build().getTimeoutSec());
337 public void testGetStartCallback() {
338 assertSame(starter, params.getStartCallback());
342 public void testGetCompleteCallback() {
343 assertSame(completer, params.getCompleteCallback());
347 public void testGetTargetEntity() {
348 assertEquals(TARGET_ENTITY, params.getTargetEntity());