2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
6 * Modifications Copyright (C) 2020 Wipro Limited.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.controlloop.actor.so;
24 import static org.assertj.core.api.Assertions.assertThat;
25 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
26 import static org.junit.Assert.assertEquals;
27 import static org.junit.Assert.assertNotNull;
28 import static org.junit.Assert.assertSame;
29 import static org.junit.Assert.assertTrue;
30 import static org.mockito.ArgumentMatchers.any;
31 import static org.mockito.Mockito.mock;
32 import static org.mockito.Mockito.never;
33 import static org.mockito.Mockito.verify;
34 import static org.mockito.Mockito.when;
36 import java.net.http.HttpHeaders;
37 import java.net.http.HttpRequest;
38 import java.net.http.HttpRequest.Builder;
39 import java.net.http.HttpResponse;
40 import java.net.http.HttpResponse.BodyHandlers;
41 import java.nio.charset.StandardCharsets;
42 import java.util.Base64;
43 import java.util.List;
45 import java.util.concurrent.CompletableFuture;
46 import java.util.concurrent.ForkJoinPool;
47 import java.util.concurrent.TimeUnit;
48 import javax.ws.rs.client.InvocationCallback;
49 import javax.ws.rs.core.MediaType;
50 import javax.ws.rs.core.Response;
51 import org.apache.commons.lang3.tuple.Pair;
52 import org.junit.AfterClass;
53 import org.junit.Before;
54 import org.junit.BeforeClass;
55 import org.junit.Test;
56 import org.mockito.ArgumentCaptor;
57 import org.mockito.Mock;
58 import org.onap.aai.domain.yang.CloudRegion;
59 import org.onap.aai.domain.yang.GenericVnf;
60 import org.onap.aai.domain.yang.ServiceInstance;
61 import org.onap.aai.domain.yang.Tenant;
62 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
63 import org.onap.policy.common.utils.coder.CoderException;
64 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
65 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
66 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
67 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
68 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
69 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams;
70 import org.onap.policy.so.SoRequest;
71 import org.onap.policy.so.SoResponse;
73 public class VfModuleDeleteTest extends BasicSoOperation {
74 private static final String EXPECTED_EXCEPTION = "expected exception";
75 private static final String SVC_INSTANCE_ID = "my-service-instance-id";
76 private static final String VNF_ID = "my-vnf-id";
79 private java.net.http.HttpClient javaClient;
81 private HttpResponse<String> javaResp;
83 private InvocationCallback<Response> callback;
85 private CompletableFuture<HttpResponse<String>> javaFuture;
86 private VfModuleDelete oper;
88 public VfModuleDeleteTest() {
89 super(DEFAULT_ACTOR, VfModuleDelete.NAME);
93 public static void setUpBeforeClass() throws Exception {
98 public static void tearDownAfterClass() {
107 public void setUp() throws Exception {
112 configureResponse(coder.encode(response));
114 oper = new MyOperation(params, config);
120 * Tests "success" case with simulator.
123 public void testSuccess() throws Exception {
124 HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7")
125 .pollPath("orchestrationRequests/v5/").maxPolls(2).build();
126 config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
128 params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).preprocessed(true).build();
130 oper = new VfModuleDelete(params, config);
135 outcome = oper.start().get();
136 assertEquals(OperationResult.SUCCESS, outcome.getResult());
137 assertTrue(outcome.getResponse() instanceof SoResponse);
139 int count = oper.getProperty(OperationProperties.DATA_VF_COUNT);
140 assertEquals(VF_COUNT - 1, count);
144 public void testConstructor() {
145 assertEquals(DEFAULT_ACTOR, oper.getActorName());
146 assertEquals(VfModuleDelete.NAME, oper.getName());
147 assertTrue(oper.isUsePolling());
149 // verify that target validation is done
150 params = params.toBuilder().targetType(null).build();
151 assertThatIllegalArgumentException().isThrownBy(() -> new MyOperation(params, config))
152 .withMessageContaining("Target information");
156 public void testGetPropertyNames() {
158 assertThat(oper.getPropertyNames()).isEqualTo(
160 OperationProperties.AAI_SERVICE,
161 OperationProperties.AAI_VNF,
162 OperationProperties.AAI_DEFAULT_CLOUD_REGION,
163 OperationProperties.AAI_DEFAULT_TENANT,
164 OperationProperties.DATA_VF_COUNT));
169 public void testStartOperationAsync_testSuccessfulCompletion() throws Exception {
170 // use a real executor
171 params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
173 oper = new MyOperation(params, config) {
175 public long getPollWaitMs() {
182 final int origCount = 30;
183 oper.setVfCount(origCount);
185 CompletableFuture<OperationOutcome> future2 = oper.start();
187 outcome = future2.get(5, TimeUnit.SECONDS);
188 assertEquals(OperationResult.SUCCESS, outcome.getResult());
190 SoResponse resp = outcome.getResponse();
192 assertEquals(REQ_ID.toString(), resp.getRequestReferences().getRequestId());
194 assertEquals(origCount - 1, oper.getVfCount());
198 * Tests startOperationAsync() when polling is required.
201 public void testStartOperationAsyncWithPolling() throws Exception {
203 // indicate that the response was incomplete
204 configureResponse(coder.encode(response).replace("COMPLETE", "incomplete"));
206 when(rawResponse.getStatus()).thenReturn(500, 500, 500, 200, 200);
207 when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse));
209 // use a real executor
210 params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
212 oper = new MyOperation(params, config) {
214 public long getPollWaitMs() {
221 CompletableFuture<OperationOutcome> future2 = oper.start();
223 outcome = future2.get(5, TimeUnit.SECONDS);
224 assertEquals(OperationResult.SUCCESS, outcome.getResult());
228 public void testMakeRequest() throws CoderException {
229 Pair<String, SoRequest> pair = oper.makeRequest();
231 assertEquals("/my-service-instance-id/vnfs/my-vnf-id/vfModules/null", pair.getLeft());
233 verifyRequest("VfModuleDelete.json", pair.getRight());
237 public void testDelete() throws Exception {
238 SoRequest req = new SoRequest();
239 req.setRequestId(REQ_ID);
241 Map<String, Object> headers = Map.of("key-A", "value-A");
243 String reqText = oper.prettyPrint(req);
245 final CompletableFuture<Response> delFuture =
246 oper.delete("my-uri", headers, MediaType.APPLICATION_JSON, reqText, callback);
248 ArgumentCaptor<HttpRequest> reqCaptor = ArgumentCaptor.forClass(HttpRequest.class);
249 verify(javaClient).sendAsync(reqCaptor.capture(), any());
251 HttpRequest req2 = reqCaptor.getValue();
252 assertEquals("http://my-host:6969/my-uri", req2.uri().toString());
253 assertEquals("DELETE", req2.method());
255 HttpHeaders headers2 = req2.headers();
256 assertEquals("value-A", headers2.firstValue("key-A").orElse("missing-key"));
257 assertEquals(MediaType.APPLICATION_JSON, headers2.firstValue("Content-type").orElse("missing-key"));
259 assertTrue(delFuture.isDone());
260 Response resp = delFuture.get();
262 verify(callback).completed(resp);
264 assertEquals(200, resp.getStatus());
266 SoResponse resp2 = resp.readEntity(SoResponse.class);
267 assertEquals(SoOperation.COMPLETE, resp2.getRequest().getRequestStatus().getRequestState());
271 * Tests delete() when an exception is thrown in the future.
274 @SuppressWarnings("unchecked")
275 public void testDeleteException() throws Exception {
276 Throwable thrown = new IllegalStateException(EXPECTED_EXCEPTION);
278 // need a new future, with an exception
279 javaFuture = CompletableFuture.failedFuture(thrown);
280 when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture);
282 SoRequest req = new SoRequest();
283 req.setRequestId(REQ_ID);
285 String reqText = oper.prettyPrint(req);
287 CompletableFuture<Response> delFuture =
288 oper.delete("/my-uri", Map.of(), MediaType.APPLICATION_JSON, reqText, callback);
290 assertTrue(delFuture.isCompletedExceptionally());
292 ArgumentCaptor<Throwable> thrownCaptor = ArgumentCaptor.forClass(Throwable.class);
293 verify(callback).failed(thrownCaptor.capture());
294 assertSame(thrown, thrownCaptor.getValue().getCause());
298 * Tests addAuthHeader() when there is a username, but no password.
301 public void testAddAuthHeader() {
302 Builder builder = mock(Builder.class);
303 when(client.getUserName()).thenReturn("the-user");
304 when(client.getPassword()).thenReturn("the-password");
305 oper.addAuthHeader(builder);
307 ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
308 ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
310 verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
312 assertEquals("Authorization", keyCaptor.getValue());
314 String encoded = Base64.getEncoder().encodeToString("the-user:the-password".getBytes(StandardCharsets.UTF_8));
315 assertEquals("Basic " + encoded, valueCaptor.getValue());
319 * Tests addAuthHeader() when there is no username.
322 public void testAddAuthHeaderNoUser() {
323 Builder builder = mock(Builder.class);
324 when(client.getPassword()).thenReturn("world");
325 oper.addAuthHeader(builder);
326 verify(builder, never()).header(any(), any());
328 // repeat with empty username
329 when(client.getUserName()).thenReturn("");
330 oper.addAuthHeader(builder);
331 verify(builder, never()).header(any(), any());
335 * Tests addAuthHeader() when there is a username, but no password.
338 public void testAddAuthHeaderUserOnly() {
339 Builder builder = mock(Builder.class);
340 when(client.getUserName()).thenReturn("my-user");
341 oper.addAuthHeader(builder);
343 ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
344 ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
346 verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
348 assertEquals("Authorization", keyCaptor.getValue());
350 String encoded = Base64.getEncoder().encodeToString("my-user:".getBytes(StandardCharsets.UTF_8));
351 assertEquals("Basic " + encoded, valueCaptor.getValue());
355 public void testMakeHttpClient() {
356 // must use a real operation to invoke this method
357 assertNotNull(new MyOperation(params, config).makeHttpClient());
360 private void initHostPort() {
361 when(client.getBaseUrl()).thenReturn("http://my-host:6969/");
364 @SuppressWarnings("unchecked")
365 private void configureResponse(String responseText) throws CoderException {
366 // indicate that the response was completed
367 when(javaResp.statusCode()).thenReturn(200);
368 when(javaResp.body()).thenReturn(responseText);
370 javaFuture = CompletableFuture.completedFuture(javaResp);
371 when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture);
374 private class MyOperation extends VfModuleDelete {
376 public MyOperation(ControlLoopOperationParams params, HttpPollingConfig config) {
377 super(params, config);
381 protected java.net.http.HttpClient makeHttpClient() {
386 private void loadProperties() {
387 // set the properties
388 ServiceInstance instance = new ServiceInstance();
389 instance.setServiceInstanceId(SVC_INSTANCE_ID);
390 oper.setProperty(OperationProperties.AAI_SERVICE, instance);
392 GenericVnf vnf = new GenericVnf();
393 vnf.setVnfId(VNF_ID);
394 oper.setProperty(OperationProperties.AAI_VNF, vnf);
396 oper.setProperty(OperationProperties.AAI_DEFAULT_CLOUD_REGION, new CloudRegion());
397 oper.setProperty(OperationProperties.AAI_DEFAULT_TENANT, new Tenant());
399 oper.setProperty(OperationProperties.DATA_VF_COUNT, VF_COUNT);