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.aai;
23 import static org.assertj.core.api.Assertions.assertThat;
24 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
25 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
26 import static org.junit.Assert.assertEquals;
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.verify;
33 import static org.mockito.Mockito.when;
35 import java.util.Arrays;
36 import java.util.List;
38 import java.util.TreeMap;
39 import java.util.concurrent.CompletableFuture;
40 import java.util.concurrent.ExecutionException;
41 import java.util.concurrent.TimeoutException;
42 import javax.ws.rs.client.InvocationCallback;
43 import org.junit.AfterClass;
44 import org.junit.Before;
45 import org.junit.BeforeClass;
46 import org.junit.Test;
47 import org.mockito.Mock;
48 import org.onap.policy.aai.AaiConstants;
49 import org.onap.policy.aai.AaiCqResponse;
50 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
51 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
52 import org.onap.policy.common.utils.coder.StandardCoder;
53 import org.onap.policy.common.utils.coder.StandardCoderObject;
54 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
55 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
56 import org.onap.policy.controlloop.actorserviceprovider.Util;
57 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
58 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
59 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
60 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
61 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
62 import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
63 import org.onap.policy.controlloop.policy.PolicyResult;
65 public class AaiCustomQueryOperationTest extends BasicAaiOperation {
66 private static final StandardCoder coder = new StandardCoder();
68 private static final String MY_LINK = "my-link";
69 private static final String MY_VSERVER = "my-vserver-name";
70 private static final String SIM_VSERVER = "OzVServer";
73 private Actor tenantActor;
75 private AaiCustomQueryOperation oper;
77 public AaiCustomQueryOperationTest() {
78 super(AaiConstants.ACTOR_NAME, AaiCustomQueryOperation.NAME);
82 public static void setUpBeforeClass() throws Exception {
87 public static void tearDownAfterClass() {
95 public void setUp() throws Exception {
98 params.getContext().getEnrichment().put(AaiCustomQueryOperation.VSERVER_VSERVER_NAME, MY_VSERVER);
100 MyTenantOperator tenantOperator = new MyTenantOperator();
102 when(service.getActor(AaiConstants.ACTOR_NAME)).thenReturn(tenantActor);
103 when(tenantActor.getOperator(AaiGetTenantOperation.NAME)).thenReturn(tenantOperator);
105 oper = new AaiCustomQueryOperation(params, config);
109 * Tests "success" case with simulator.
112 public void testSuccess() throws Exception {
113 HttpParams opParams = HttpParams.builder().clientName(MY_CLIENT).path("v16/query").build();
114 config = new HttpConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
116 params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).preprocessed(true).build();
117 oper = new AaiCustomQueryOperation(params, config);
118 oper.setProperty(OperationProperties.AAI_TARGET_ENTITY, SIM_VSERVER);
120 oper.setProperty(OperationProperties.AAI_VSERVER_LINK, MY_LINK);
122 outcome = oper.start().get();
123 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
125 assertNotNull(outcome.getResponse());
129 public void testConstructor() {
130 assertEquals(AaiConstants.ACTOR_NAME, oper.getActorName());
131 assertEquals(AaiCustomQueryOperation.NAME, oper.getName());
135 public void testGetVserver() {
136 assertEquals(MY_VSERVER, oper.getVserver());
138 // try without enrichment data
139 params.getContext().getEnrichment().remove(AaiCustomQueryOperation.VSERVER_VSERVER_NAME);
140 assertThatIllegalArgumentException().isThrownBy(() -> oper.getVserver())
141 .withMessage("missing " + AaiCustomQueryOperation.VSERVER_VSERVER_NAME + " in enrichment data");
145 public void testGetPropertyNames() {
146 assertThat(oper.getPropertyNames()).isEqualTo(List.of(OperationProperties.AAI_VSERVER_LINK));
150 public void testGenerateSubRequestId() {
151 oper.generateSubRequestId(3);
152 assertEquals("3", oper.getSubRequestId());
156 * Tests startPreprocessorAsync(), when preprocessing is disabled.
159 public void testStartPreprocessorAsyncDisabled() {
160 params = params.toBuilder().preprocessed(true).build();
161 assertNull(new AaiCustomQueryOperation(params, config).startPreprocessorAsync());
165 @SuppressWarnings("unchecked")
166 public void testStartOperationAsync_testStartPreprocessorAsync_testMakeRequest_testPostProcess() throws Exception {
167 // need two responses
168 when(rawResponse.readEntity(String.class)).thenReturn(makeTenantReply()).thenReturn(makeCqReply());
169 when(webAsync.get(any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse));
170 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
172 CompletableFuture<OperationOutcome> future2 = oper.start();
174 assertEquals(PolicyResult.SUCCESS, getResult(future2));
176 // tenant response should have been cached within the context
177 assertNotNull(context.getProperty(AaiGetTenantOperation.getKey(MY_VSERVER)));
179 // custom query response should have been cached within the context
180 AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
181 assertNotNull(cqData);
183 assertEquals("1", future2.get().getSubRequestId());
187 * Tests when preprocessor step is not needed.
190 @SuppressWarnings("unchecked")
191 public void testStartOperationAsync_testStartPreprocessorAsyncNotNeeded() throws Exception {
192 // pre-load the tenant data
193 final StandardCoderObject data = preloadTenantData();
195 // only need one response
196 when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
197 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
199 CompletableFuture<OperationOutcome> future2 = oper.start();
201 assertEquals(PolicyResult.SUCCESS, getResult(future2));
203 // should not have replaced tenant response
204 assertSame(data, context.getProperty(AaiGetTenantOperation.getKey(MY_VSERVER)));
206 // custom query response should have been cached within the context
207 AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
208 assertNotNull(cqData);
212 public void testMakeHeaders() {
213 verifyHeaders(oper.makeHeaders());
217 @SuppressWarnings("unchecked")
218 public void testMakeRequest_testGetVserverLink() throws Exception {
222 when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
223 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
226 executor.runAll(100);
228 verify(webAsync).put(requestCaptor.capture(), any(InvocationCallback.class));
230 String reqText = requestCaptor.getValue().getEntity();
231 Map<String, String> reqMap = coder.decode(reqText, Map.class);
233 // sort the request fields so they match the order in cq.json
234 Map<String, String> request = new TreeMap<>(reqMap);
236 verifyRequest("cq.json", request);
240 public void testGetVserverLinkViaProperty() throws Exception {
241 oper.setProperty(OperationProperties.AAI_VSERVER_LINK, MY_LINK);
242 assertEquals(MY_LINK, oper.getVserverLink());
246 public void testGetVserverLinkNoTenantData() throws Exception {
247 assertThatIllegalStateException().isThrownBy(() -> oper.getVserverLink())
248 .withMessage("cannot perform custom query - cannot determine resource-link");
252 public void testGetVserverLinkNoResourceLink() throws Exception {
253 // pre-load EMPTY tenant data
254 preloadTenantData(new StandardCoderObject());
256 assertThatIllegalArgumentException().isThrownBy(() -> oper.getVserverLink())
257 .withMessage("cannot perform custom query - no resource-link");
261 public void testSetOutcome() {
262 outcome = oper.setOutcome(params.makeOutcome(null), PolicyResult.SUCCESS, null, null);
263 assertNull(outcome.getResponse());
265 outcome = oper.setOutcome(params.makeOutcome(null), PolicyResult.SUCCESS, null, "{}");
266 assertTrue(outcome.getResponse() instanceof AaiCqResponse);
269 private String makeTenantReply() throws Exception {
270 Map<String, String> links = Map.of(AaiCustomQueryOperation.RESOURCE_LINK, MY_LINK);
271 List<Map<String, String>> data = Arrays.asList(links);
273 Map<String, Object> reply = Map.of(AaiCustomQueryOperation.RESULT_DATA, data);
274 return coder.encode(reply);
277 private String makeCqReply() {
281 private StandardCoderObject preloadTenantData() throws Exception {
282 StandardCoderObject data = coder.decode(makeTenantReply(), StandardCoderObject.class);
283 preloadTenantData(data);
287 private void preloadTenantData(StandardCoderObject data) {
288 context.setProperty(AaiGetTenantOperation.getKey(MY_VSERVER), data);
289 context.setProperty(AaiGetTenantOperation.getKey(SIM_VSERVER), data);
292 private PolicyResult getResult(CompletableFuture<OperationOutcome> future2)
293 throws InterruptedException, ExecutionException, TimeoutException {
295 executor.runAll(100);
296 assertTrue(future2.isDone());
298 return future2.get().getResult();
301 protected class MyTenantOperator extends HttpOperator {
302 public MyTenantOperator() {
303 super(AaiConstants.ACTOR_NAME, AaiGetTenantOperation.NAME);
305 HttpParams http = HttpParams.builder().clientName(MY_CLIENT).path(PATH).timeoutSec(1).build();
307 configure(Util.translateToMap(AaiGetTenantOperation.NAME, http));
312 public HttpOperation<?> buildOperation(ControlLoopOperationParams params) {
313 return new AaiGetTenantOperation(params, getCurrentConfig());
317 protected HttpClientFactory getClientFactory() {