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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.actor.aai;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
import javax.ws.rs.client.InvocationCallback;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.mockito.Mock;
import org.onap.policy.aai.AaiConstants;
import org.onap.policy.aai.AaiCqResponse;
import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
import org.onap.policy.controlloop.actorserviceprovider.Util;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
import org.onap.policy.controlloop.policy.PolicyResult;
public class AaiCustomQueryOperationTest extends BasicAaiOperation {
private static final StandardCoder coder = new StandardCoder();
private static final String MY_LINK = "my-link";
private static final String MY_VSERVER = "my-vserver-name";
private static final String SIM_VSERVER = "OzVServer";
@Mock
private Actor tenantActor;
private AaiCustomQueryOperation oper;
public AaiCustomQueryOperationTest() {
super(AaiConstants.ACTOR_NAME, AaiCustomQueryOperation.NAME);
}
@BeforeClass
public static void setUpBeforeClass() throws Exception {
initBeforeClass();
}
@AfterClass
public static void tearDownAfterClass() {
destroyAfterClass();
}
/**
* Sets up.
*/
@Before
public void setUp() throws Exception {
super.setUpBasic();
params.getContext().getEnrichment().put(AaiCustomQueryOperation.VSERVER_VSERVER_NAME, MY_VSERVER);
MyTenantOperator tenantOperator = new MyTenantOperator();
when(service.getActor(AaiConstants.ACTOR_NAME)).thenReturn(tenantActor);
when(tenantActor.getOperator(AaiGetTenantOperation.NAME)).thenReturn(tenantOperator);
oper = new AaiCustomQueryOperation(params, config);
}
/**
* Tests "success" case with simulator.
*/
@Test
public void testSuccess() throws Exception {
HttpParams opParams = HttpParams.builder().clientName(MY_CLIENT).path("v16/query").build();
config = new HttpConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).preprocessed(true).build();
oper = new AaiCustomQueryOperation(params, config);
oper.setProperty(OperationProperties.AAI_TARGET_ENTITY, SIM_VSERVER);
oper.setProperty(OperationProperties.AAI_VSERVER_LINK, MY_LINK);
outcome = oper.start().get();
assertEquals(PolicyResult.SUCCESS, outcome.getResult());
assertNotNull(outcome.getResponse());
}
@Test
public void testConstructor() {
assertEquals(AaiConstants.ACTOR_NAME, oper.getActorName());
assertEquals(AaiCustomQueryOperation.NAME, oper.getName());
}
@Test
public void testGetVserver() {
assertEquals(MY_VSERVER, oper.getVserver());
// try without enrichment data
params.getContext().getEnrichment().remove(AaiCustomQueryOperation.VSERVER_VSERVER_NAME);
assertThatIllegalArgumentException().isThrownBy(() -> oper.getVserver())
.withMessage("missing " + AaiCustomQueryOperation.VSERVER_VSERVER_NAME + " in enrichment data");
}
@Test
public void testGetPropertyNames() {
assertThat(oper.getPropertyNames()).isEqualTo(List.of(OperationProperties.AAI_VSERVER_LINK));
}
@Test
public void testGenerateSubRequestId() {
oper.generateSubRequestId(3);
assertEquals("3", oper.getSubRequestId());
}
/**
* Tests startPreprocessorAsync(), when preprocessing is disabled.
*/
@Test
public void testStartPreprocessorAsyncDisabled() {
params = params.toBuilder().preprocessed(true).build();
assertNull(new AaiCustomQueryOperation(params, config).startPreprocessorAsync());
}
@Test
@SuppressWarnings("unchecked")
public void testStartOperationAsync_testStartPreprocessorAsync_testMakeRequest_testPostProcess() throws Exception {
// need two responses
when(rawResponse.readEntity(String.class)).thenReturn(makeTenantReply()).thenReturn(makeCqReply());
when(webAsync.get(any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse));
when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
CompletableFuture<OperationOutcome> future2 = oper.start();
assertEquals(PolicyResult.SUCCESS, getResult(future2));
// tenant response should have been cached within the context
assertNotNull(context.getProperty(AaiGetTenantOperation.getKey(MY_VSERVER)));
// custom query response should have been cached within the context
AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
assertNotNull(cqData);
assertEquals("1", future2.get().getSubRequestId());
}
/**
* Tests when preprocessor step is not needed.
*/
@Test
@SuppressWarnings("unchecked")
public void testStartOperationAsync_testStartPreprocessorAsyncNotNeeded() throws Exception {
// pre-load the tenant data
final StandardCoderObject data = preloadTenantData();
// only need one response
when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
CompletableFuture<OperationOutcome> future2 = oper.start();
assertEquals(PolicyResult.SUCCESS, getResult(future2));
// should not have replaced tenant response
assertSame(data, context.getProperty(AaiGetTenantOperation.getKey(MY_VSERVER)));
// custom query response should have been cached within the context
AaiCqResponse cqData = context.getProperty(AaiCqResponse.CONTEXT_KEY);
assertNotNull(cqData);
}
@Test
public void testMakeHeaders() {
verifyHeaders(oper.makeHeaders());
}
@Test
@SuppressWarnings("unchecked")
public void testMakeRequest_testGetVserverLink() throws Exception {
// preload
preloadTenantData();
when(rawResponse.readEntity(String.class)).thenReturn(makeCqReply());
when(webAsync.put(any(), any(InvocationCallback.class))).thenAnswer(provideResponse(rawResponse, 1));
oper.start();
executor.runAll(100);
verify(webAsync).put(requestCaptor.capture(), any(InvocationCallback.class));
String reqText = requestCaptor.getValue().getEntity();
Map<String, String> reqMap = coder.decode(reqText, Map.class);
// sort the request fields so they match the order in cq.json
Map<String, String> request = new TreeMap<>(reqMap);
verifyRequest("cq.json", request);
}
@Test
public void testGetVserverLinkViaProperty() throws Exception {
oper.setProperty(OperationProperties.AAI_VSERVER_LINK, MY_LINK);
assertEquals(MY_LINK, oper.getVserverLink());
}
@Test
public void testGetVserverLinkNoTenantData() throws Exception {
assertThatIllegalStateException().isThrownBy(() -> oper.getVserverLink())
.withMessage("cannot perform custom query - cannot determine resource-link");
}
@Test
public void testGetVserverLinkNoResourceLink() throws Exception {
// pre-load EMPTY tenant data
preloadTenantData(new StandardCoderObject());
assertThatIllegalArgumentException().isThrownBy(() -> oper.getVserverLink())
.withMessage("cannot perform custom query - no resource-link");
}
@Test
public void testSetOutcome() {
outcome = oper.setOutcome(params.makeOutcome(null), PolicyResult.SUCCESS, null, null);
assertNull(outcome.getResponse());
outcome = oper.setOutcome(params.makeOutcome(null), PolicyResult.SUCCESS, null, "{}");
assertTrue(outcome.getResponse() instanceof AaiCqResponse);
}
private String makeTenantReply() throws Exception {
Map<String, String> links = Map.of(AaiCustomQueryOperation.RESOURCE_LINK, MY_LINK);
List<Map<String, String>> data = Arrays.asList(links);
Map<String, Object> reply = Map.of(AaiCustomQueryOperation.RESULT_DATA, data);
return coder.encode(reply);
}
private String makeCqReply() {
return "{}";
}
private StandardCoderObject preloadTenantData() throws Exception {
StandardCoderObject data = coder.decode(makeTenantReply(), StandardCoderObject.class);
preloadTenantData(data);
return data;
}
private void preloadTenantData(StandardCoderObject data) {
context.setProperty(AaiGetTenantOperation.getKey(MY_VSERVER), data);
context.setProperty(AaiGetTenantOperation.getKey(SIM_VSERVER), data);
}
private PolicyResult getResult(CompletableFuture<OperationOutcome> future2)
throws InterruptedException, ExecutionException, TimeoutException {
executor.runAll(100);
assertTrue(future2.isDone());
return future2.get().getResult();
}
protected class MyTenantOperator extends HttpOperator {
public MyTenantOperator() {
super(AaiConstants.ACTOR_NAME, AaiGetTenantOperation.NAME);
HttpParams http = HttpParams.builder().clientName(MY_CLIENT).path(PATH).timeoutSec(1).build();
configure(Util.translateToMap(AaiGetTenantOperation.NAME, http));
start();
}
@Override
public HttpOperation<?> buildOperation(ControlLoopOperationParams params) {
return new AaiGetTenantOperation(params, getCurrentConfig());
}
@Override
protected HttpClientFactory getClientFactory() {
return factory;
}
}
}
|