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.actor.appclcm;
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.Mockito.mock;
32 import static org.mockito.Mockito.when;
34 import java.util.Arrays;
35 import java.util.List;
38 import java.util.concurrent.CompletableFuture;
39 import java.util.concurrent.atomic.AtomicBoolean;
40 import java.util.stream.Collectors;
41 import org.junit.After;
42 import org.junit.AfterClass;
43 import org.junit.Before;
44 import org.junit.BeforeClass;
45 import org.junit.Test;
46 import org.onap.policy.appclcm.AppcLcmBody;
47 import org.onap.policy.appclcm.AppcLcmCommonHeader;
48 import org.onap.policy.appclcm.AppcLcmDmaapWrapper;
49 import org.onap.policy.appclcm.AppcLcmOutput;
50 import org.onap.policy.appclcm.AppcLcmResponseStatus;
51 import org.onap.policy.common.endpoints.event.comm.TopicSink;
52 import org.onap.policy.common.endpoints.event.comm.TopicSource;
53 import org.onap.policy.common.utils.coder.Coder;
54 import org.onap.policy.common.utils.coder.CoderException;
55 import org.onap.policy.common.utils.coder.StandardCoder;
56 import org.onap.policy.controlloop.ControlLoopOperation;
57 import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation;
58 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
59 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
60 import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
61 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation.Status;
62 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
63 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams;
64 import org.onap.policy.controlloop.policy.PolicyResult;
65 import org.onap.policy.controlloop.policy.Target;
66 import org.onap.policy.simulators.AppcLcmTopicServer;
67 import org.onap.policy.simulators.TopicServer;
69 public class AppcLcmOperationTest extends BasicBidirectionalTopicOperation<AppcLcmDmaapWrapper> {
71 private static final String EXPECTED_EXCEPTION = "expected exception";
72 private static final String PAYLOAD_KEY1 = "key-A";
73 private static final String PAYLOAD_VALUE1 = "value-A";
74 private static final String MY_MESSAGE = "my-message";
75 protected static final String MY_VNF = "my-vnf";
76 protected static final String RESOURCE_ID = "my-resource";
77 private static final int SUCCESS_CODE = 400;
79 private AppcLcmDmaapWrapper response;
80 private AppcLcmOperation oper;
83 public static void setUpBeforeClass() throws Exception {
84 initBeforeClass(MY_SINK, MY_SOURCE);
88 public static void tearDownAfterClass() {
99 response = makeResponse();
101 oper = new AppcLcmOperation(params, config);
105 public void tearDown() {
106 super.tearDownBasic();
109 protected TopicServer<AppcLcmDmaapWrapper> makeServer(TopicSink sink, TopicSource source) {
110 return new AppcLcmTopicServer(sink, source);
114 * Tests "success" case with simulator.
117 public void testSuccess() throws Exception {
118 BidirectionalTopicParams opParams =
119 BidirectionalTopicParams.builder().sinkTopic(MY_SINK).sourceTopic(MY_SOURCE).build();
120 config = new BidirectionalTopicConfig(blockingExecutor, opParams, topicMgr, AppcLcmOperation.SELECTOR_KEYS);
122 params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build();
124 oper = new AppcLcmOperation(params, config) {
126 protected CompletableFuture<OperationOutcome> startGuardAsync() {
131 outcome = oper.start().get();
132 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
133 assertTrue(outcome.getResponse() instanceof AppcLcmDmaapWrapper);
137 public void testConstructor() {
138 assertEquals(DEFAULT_ACTOR, oper.getActorName());
139 assertEquals(DEFAULT_OPERATION, oper.getName());
143 public void testGetPropertyNames() {
144 assertThat(oper.getPropertyNames()).isEqualTo(List.of(OperationProperties.AAI_TARGET_ENTITY));
148 public void testStartPreprocessorAsync() throws Exception {
149 context = mock(ControlLoopEventContext.class);
150 when(context.getEvent()).thenReturn(event);
151 params = params.toBuilder().context(context).build();
153 AtomicBoolean guardStarted = new AtomicBoolean();
155 oper = new AppcLcmOperation(params, config) {
157 protected CompletableFuture<OperationOutcome> startGuardAsync() {
158 guardStarted.set(true);
159 return super.startGuardAsync();
163 CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
164 assertNotNull(future2);
165 assertFalse(future.isDone());
166 assertTrue(guardStarted.get());
168 assertTrue(executor.runAll(100));
169 assertTrue(future2.isDone());
170 outcome = future2.get();
171 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
175 public void testMakeRequest() {
176 oper.generateSubRequestId(2);
177 String subreq = oper.getSubRequestId();
178 assertNotNull(subreq);
180 AppcLcmDmaapWrapper request = oper.makeRequest(2);
181 assertEquals("DefaultOperation", request.getBody().getInput().getAction());
183 AppcLcmCommonHeader header = request.getBody().getInput().getCommonHeader();
184 assertNotNull(header);
185 assertEquals(params.getRequestId(), header.getRequestId());
187 assertEquals(subreq, header.getSubRequestId());
189 assertEquals("{vnf-id=my-target}", request.getBody().getInput().getActionIdentifiers().toString());
191 request = oper.makeRequest(2);
192 assertEquals(subreq, request.getBody().getInput().getCommonHeader().getSubRequestId());
196 public void testConvertPayload() {
197 // only builds a payload for ConfigModify
198 params = params.toBuilder().operation(AppcLcmConstants.OPERATION_CONFIG_MODIFY).build();
199 oper = new AppcLcmOperation(params, config);
201 oper.generateSubRequestId(2);
202 AppcLcmDmaapWrapper req = oper.makeRequest(2);
203 assertEquals("{\"key-A\":\"value-A\"}", req.getBody().getInput().getPayload());
206 oper = new AppcLcmOperation(params, config) {
208 protected Coder getCoder() {
209 return new StandardCoder() {
211 public String encode(Object object) throws CoderException {
212 throw new CoderException(EXPECTED_EXCEPTION);
218 oper.generateSubRequestId(2);
220 assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest(2))
221 .withMessage("Cannot convert payload");
225 public void testGetExpectedKeyValues() {
226 oper.generateSubRequestId(2);
227 AppcLcmDmaapWrapper request = oper.makeRequest(2);
228 assertEquals(Arrays.asList(request.getBody().getInput().getCommonHeader().getSubRequestId()),
229 oper.getExpectedKeyValues(50, request));
233 public void testDetmStatus() {
234 assertEquals(Status.SUCCESS, oper.detmStatus(null, response));
237 response.getBody().getOutput().getStatus().setCode(405);
238 assertEquals(Status.FAILURE, oper.detmStatus(null, response));
241 response.getBody().getOutput().getStatus().setCode(200);
242 assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus(null, response));
245 response.getBody().getOutput().getStatus().setCode(305);
246 assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus(null, response));
249 response.getBody().getOutput().getStatus().setCode(100);
250 assertEquals(Status.STILL_WAITING, oper.detmStatus(null, response));
253 response.getBody().getOutput().getStatus().setCode(-1);
254 assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus(null, response));
257 response.getBody().getOutput().setStatus(null);
258 assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus(null, response));
262 public void testSetOutcome() {
263 oper.setOutcome(outcome, PolicyResult.SUCCESS, response);
264 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
265 assertEquals(MY_MESSAGE, outcome.getMessage());
266 assertSame(response, outcome.getResponse());
269 oper.setOutcome(outcome, PolicyResult.FAILURE, response);
270 assertEquals(PolicyResult.FAILURE, outcome.getResult());
271 assertEquals(MY_MESSAGE, outcome.getMessage());
272 assertSame(response, outcome.getResponse());
275 response.getBody().getOutput().getStatus().setMessage(null);
276 oper.setOutcome(outcome, PolicyResult.SUCCESS, response);
277 assertEquals(ControlLoopOperation.SUCCESS_MSG, outcome.getMessage());
278 assertSame(response, outcome.getResponse());
281 response.getBody().getOutput().setStatus(null);
282 oper.setOutcome(outcome, PolicyResult.SUCCESS, response);
283 assertEquals(ControlLoopOperation.SUCCESS_MSG, outcome.getMessage());
284 assertSame(response, outcome.getResponse());
288 public void testGetStatus() {
289 assertNotNull(oper.getStatus(response));
292 response.getBody().getOutput().setStatus(null);
293 assertNull(oper.getStatus(response));
296 response.getBody().setOutput(null);
297 assertNull(oper.getStatus(response));
300 response.setBody(null);
301 assertNull(oper.getStatus(response));
304 assertNull(oper.getStatus(null));
308 public void testOperationSupportsPayload() {
309 // these should support a payload
310 Set<String> supported = Set.of(AppcLcmConstants.OPERATION_CONFIG_MODIFY);
312 for (String name : supported) {
313 params = params.toBuilder().operation(name).build();
314 oper = new AppcLcmOperation(params, config);
315 assertTrue(name, oper.operationSupportsPayload());
318 // these should NOT support a payload
319 Set<String> unsupported = AppcLcmConstants.OPERATION_NAMES.stream().filter(name -> !supported.contains(name))
320 .collect(Collectors.toSet());
322 for (String name : unsupported) {
323 params = params.toBuilder().operation(name).build();
324 oper = new AppcLcmOperation(params, config);
325 assertFalse(name, oper.operationSupportsPayload());
328 // pick an operation that would ordinarily support payloads
329 String sup = supported.iterator().next();
331 // verify that it still supports payload
332 params = params.toBuilder().operation(sup).build();
333 oper = new AppcLcmOperation(params, config);
334 assertTrue(oper.operationSupportsPayload());
336 // try with empty payload
337 params = params.toBuilder().payload(Map.of()).build();
338 oper = new AppcLcmOperation(params, config);
339 assertFalse(oper.operationSupportsPayload());
341 // try with null payload
342 params = params.toBuilder().payload(null).build();
343 oper = new AppcLcmOperation(params, config);
344 assertFalse(oper.operationSupportsPayload());
348 protected void makeContext() {
351 Target target = new Target();
352 target.setResourceID(RESOURCE_ID);
354 params = params.toBuilder().target(target).build();
358 protected Map<String, Object> makePayload() {
359 return Map.of(PAYLOAD_KEY1, PAYLOAD_VALUE1);
362 private AppcLcmDmaapWrapper makeResponse() {
363 AppcLcmDmaapWrapper response = new AppcLcmDmaapWrapper();
365 AppcLcmBody body = new AppcLcmBody();
366 response.setBody(body);
368 AppcLcmOutput output = new AppcLcmOutput();
369 body.setOutput(output);
371 AppcLcmResponseStatus status = new AppcLcmResponseStatus();
372 output.setStatus(status);
373 status.setMessage(MY_MESSAGE);
374 status.setCode(SUCCESS_CODE);