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.assertThatCode;
24 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
25 import static org.junit.Assert.assertEquals;
26 import static org.junit.Assert.assertNotNull;
27 import static org.junit.Assert.assertSame;
28 import static org.junit.Assert.assertTrue;
29 import static org.mockito.ArgumentMatchers.any;
30 import static org.mockito.Mockito.verify;
31 import static org.mockito.Mockito.when;
33 import java.util.Arrays;
34 import java.util.List;
36 import java.util.TreeMap;
37 import java.util.concurrent.CompletableFuture;
38 import java.util.concurrent.ExecutionException;
39 import java.util.concurrent.TimeoutException;
40 import javax.ws.rs.client.Entity;
41 import javax.ws.rs.client.InvocationCallback;
42 import org.junit.AfterClass;
43 import org.junit.Before;
44 import org.junit.BeforeClass;
45 import org.junit.Test;
46 import org.mockito.ArgumentCaptor;
47 import org.mockito.Captor;
48 import org.mockito.Mock;
49 import org.onap.policy.aai.AaiConstants;
50 import org.onap.policy.aai.AaiCqResponse;
51 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
52 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
53 import org.onap.policy.common.utils.coder.StandardCoder;
54 import org.onap.policy.common.utils.coder.StandardCoderObject;
55 import org.onap.policy.controlloop.actorserviceprovider.Operation;
56 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
57 import org.onap.policy.controlloop.actorserviceprovider.Util;
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<Map<String, String>> {
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 ArgumentCaptor<Entity<Map<String, String>>> entityCaptor;
76 private Actor tenantActor;
78 private AaiCustomQueryOperation oper;
80 public AaiCustomQueryOperationTest() {
81 super(AaiConstants.ACTOR_NAME, AaiCustomQueryOperation.NAME);
85 public static void setUpBeforeClass() throws Exception {
90 public static void tearDownAfterClass() {
98 public void setUp() throws Exception {
101 params.getContext().getEnrichment().put(AaiCustomQueryOperation.VSERVER_VSERVER_NAME, MY_VSERVER);
103 MyTenantOperator tenantOperator = new MyTenantOperator();
105 when(service.getActor(AaiConstants.ACTOR_NAME)).thenReturn(tenantActor);
106 when(tenantActor.getOperator(AaiGetOperation.TENANT)).thenReturn(tenantOperator);
108 oper = new AaiCustomQueryOperation(params, config);
112 * Tests "success" case with simulator.
115 public void testSuccess() throws Exception {
116 HttpParams opParams = HttpParams.builder().clientName(MY_CLIENT).path("v16/query").build();
117 config = new HttpConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
121 params = params.toBuilder().targetEntity(SIM_VSERVER).retry(0).timeoutSec(5).executor(blockingExecutor).build();
122 oper = new AaiCustomQueryOperation(params, config);
124 outcome = oper.start().get();
125 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
129 public void testConstructor() {
130 assertEquals(AaiConstants.ACTOR_NAME, oper.getActorName());
131 assertEquals(AaiCustomQueryOperation.NAME, oper.getName());
132 assertEquals(MY_VSERVER, oper.getVserver());
134 // verify that it works with an empty target entity
135 params = params.toBuilder().targetEntity("").build();
136 assertThatCode(() -> new AaiCustomQueryOperation(params, config)).doesNotThrowAnyException();
138 // try without enrichment data
139 params.getContext().getEnrichment().remove(AaiCustomQueryOperation.VSERVER_VSERVER_NAME);
140 assertThatIllegalArgumentException().isThrownBy(() -> new AaiCustomQueryOperation(params, config))
141 .withMessage("missing " + AaiCustomQueryOperation.VSERVER_VSERVER_NAME + " in enrichment data");
145 @SuppressWarnings("unchecked")
146 public void testStartOperationAsync_testStartPreprocessorAsync_testMakeRequest_testPostProcess() throws Exception {
147 // need two responses
148 when(rawResponse.readEntity(String.class)).thenReturn(makeTenantReply()).thenReturn(makeCqReply());
149 when(webAsync.get(any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse));
150 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
152 CompletableFuture<OperationOutcome> future2 = oper.start();
154 assertEquals(PolicyResult.SUCCESS, getResult(future2));
156 // tenant response should have been cached within the context
157 assertNotNull(context.getProperty(AaiGetOperation.getTenantKey(MY_VSERVER)));
159 // custom query response should have been cached within the context
160 AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
161 assertNotNull(cqData);
163 assertEquals("1", future2.get().getSubRequestId());
167 * Tests when preprocessor step is not needed.
170 @SuppressWarnings("unchecked")
171 public void testStartOperationAsync_testStartPreprocessorAsyncNotNeeded() throws Exception {
172 // pre-load the tenant data
173 final StandardCoderObject data = preloadTenantData();
175 // only need one response
176 when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
177 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
179 CompletableFuture<OperationOutcome> future2 = oper.start();
181 assertEquals(PolicyResult.SUCCESS, getResult(future2));
183 // should not have replaced tenant response
184 assertSame(data, context.getProperty(AaiGetOperation.getTenantKey(MY_VSERVER)));
186 // custom query response should have been cached within the context
187 AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
188 assertNotNull(cqData);
192 public void testMakeHeaders() {
193 verifyHeaders(oper.makeHeaders());
197 @SuppressWarnings("unchecked")
198 public void testMakeRequest() throws Exception {
202 when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
203 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
206 executor.runAll(100);
208 verify(webAsync).put(entityCaptor.capture(), any(InvocationCallback.class));
210 // sort the request fields so they match the order in cq.json
211 Map<String, String> request = new TreeMap<>(entityCaptor.getValue().getEntity());
213 verifyRequest("cq.json", request);
217 @SuppressWarnings("unchecked")
218 public void testMakeRequestNoResourceLink() throws Exception {
219 // pre-load EMPTY tenant data
220 preloadTenantData(new StandardCoderObject());
222 when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
223 when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
225 CompletableFuture<OperationOutcome> future2 = oper.start();
227 assertEquals(PolicyResult.FAILURE_EXCEPTION, getResult(future2));
230 private String makeTenantReply() throws Exception {
231 Map<String, String> links = Map.of(AaiCustomQueryOperation.RESOURCE_LINK, MY_LINK);
232 List<Map<String, String>> data = Arrays.asList(links);
234 Map<String, Object> reply = Map.of(AaiCustomQueryOperation.RESULT_DATA, data);
235 return coder.encode(reply);
238 private String makeCqReply() {
242 private StandardCoderObject preloadTenantData() throws Exception {
243 StandardCoderObject data = coder.decode(makeTenantReply(), StandardCoderObject.class);
244 preloadTenantData(data);
248 private void preloadTenantData(StandardCoderObject data) {
249 context.setProperty(AaiGetOperation.getTenantKey(MY_VSERVER), data);
250 context.setProperty(AaiGetOperation.getTenantKey(SIM_VSERVER), data);
253 private PolicyResult getResult(CompletableFuture<OperationOutcome> future2)
254 throws InterruptedException, ExecutionException, TimeoutException {
256 executor.runAll(100);
257 assertTrue(future2.isDone());
259 return future2.get().getResult();
262 protected class MyTenantOperator extends HttpOperator {
263 public MyTenantOperator() {
264 super(AaiConstants.ACTOR_NAME, AaiGetOperation.TENANT);
266 HttpParams http = HttpParams.builder().clientName(MY_CLIENT).path(PATH).timeoutSec(1).build();
268 configure(Util.translateToMap(AaiGetOperation.TENANT, http));
273 public Operation buildOperation(ControlLoopOperationParams params) {
274 return new AaiGetOperation(params, getCurrentConfig());
278 protected HttpClientFactory getClientFactory() {