models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleDeleteTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.so;
  22
  23 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertFalse;
  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.mock;
  31 import static org.mockito.Mockito.never;
  32 import static org.mockito.Mockito.verify;
  33 import static org.mockito.Mockito.when;
  34
  35 import java.net.http.HttpHeaders;
  36 import java.net.http.HttpRequest;
  37 import java.net.http.HttpRequest.Builder;
  38 import java.net.http.HttpResponse;
  39 import java.net.http.HttpResponse.BodyHandlers;
  40 import java.nio.charset.StandardCharsets;
  41 import java.util.Base64;
  42 import java.util.Map;
  43 import java.util.concurrent.CompletableFuture;
  44 import java.util.concurrent.ForkJoinPool;
  45 import java.util.concurrent.TimeUnit;
  46 import java.util.concurrent.atomic.AtomicBoolean;
  47 import javax.ws.rs.client.InvocationCallback;
  48 import javax.ws.rs.core.MediaType;
  49 import javax.ws.rs.core.Response;
  50 import org.apache.commons.lang3.tuple.Pair;
  51 import org.junit.AfterClass;
  52 import org.junit.Before;
  53 import org.junit.BeforeClass;
  54 import org.junit.Test;
  55 import org.mockito.ArgumentCaptor;
  56 import org.mockito.Mock;
  57 import org.onap.aai.domain.yang.CloudRegion;
  58 import org.onap.aai.domain.yang.GenericVnf;
  59 import org.onap.aai.domain.yang.ModelVer;
  60 import org.onap.aai.domain.yang.ServiceInstance;
  61 import org.onap.aai.domain.yang.Tenant;
  62 import org.onap.policy.aai.AaiCqResponse;
  63 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  64 import org.onap.policy.common.utils.coder.CoderException;
  65 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  66 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  67 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  68 import org.onap.policy.controlloop.policy.PolicyResult;
  69 import org.onap.policy.so.SoRequest;
  70 import org.onap.policy.so.SoResponse;
  71
  72 public class VfModuleDeleteTest extends BasicSoOperation {
  73     private static final String EXPECTED_EXCEPTION = "expected exception";
  74     private static final String MODEL_NAME2 = "my-model-name-B";
  75     private static final String MODEL_VERS2 = "my-model-version-B";
  76     private static final String SVC_INSTANCE_ID = "my-service-instance-id";
  77     private static final String VNF_ID = "my-vnf-id";
  78
  79     @Mock
  80     private java.net.http.HttpClient javaClient;
  81     @Mock
  82     private HttpResponse<String> javaResp;
  83     @Mock
  84     private InvocationCallback<Response> callback;
  85
  86     private CompletableFuture<HttpResponse<String>> javaFuture;
  87     private VfModuleDelete oper;
  88
  89     public VfModuleDeleteTest() {
  90         super(DEFAULT_ACTOR, VfModuleDelete.NAME);
  91     }
  92
  93     @BeforeClass
  94     public static void setUpBeforeClass() throws Exception {
  95         initBeforeClass();
  96     }
  97
  98     @AfterClass
  99     public static void tearDownAfterClass() {
 100         destroyAfterClass();
 101     }
 102
 103     /**
 104      * Sets up.
 105      */
 106     @Before
 107     public void setUp() throws Exception {
 108         super.setUp();
 109
 110         initHostPort();
 111
 112         configureResponse(coder.encode(response));
 113
 114         oper = new MyOperation(params, config);
 115     }
 116
 117     /**
 118      * Tests "success" case with simulator.
 119      */
 120     @Test
 121     public void testSuccess() throws Exception {
 122         SoParams opParams = SoParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7")
 123                         .pathGet("orchestrationRequests/v5/").maxGets(2).build();
 124         config = new SoConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 125
 126         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build();
 127         oper = new VfModuleDelete(params, config);
 128
 129         outcome = oper.start().get();
 130         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 131         assertTrue(outcome.getResponse() instanceof SoResponse);
 132     }
 133
 134     @Test
 135     public void testConstructor() {
 136         assertEquals(DEFAULT_ACTOR, oper.getActorName());
 137         assertEquals(VfModuleDelete.NAME, oper.getName());
 138
 139         // verify that target validation is done
 140         params = params.toBuilder().target(null).build();
 141         assertThatIllegalArgumentException().isThrownBy(() -> new VfModuleDelete(params, config))
 142                         .withMessageContaining("Target information");
 143     }
 144
 145     @Test
 146     public void testStartPreprocessorAsync() throws Exception {
 147         // insert CQ data so it's there for the check
 148         context.setProperty(AaiCqResponse.CONTEXT_KEY, makeCqResponse());
 149
 150         AtomicBoolean guardStarted = new AtomicBoolean();
 151
 152         oper = new MyOperation(params, config) {
 153             @Override
 154             protected CompletableFuture<OperationOutcome> startGuardAsync() {
 155                 guardStarted.set(true);
 156                 return super.startGuardAsync();
 157             }
 158         };
 159
 160         CompletableFuture<OperationOutcome> future3 = oper.startPreprocessorAsync();
 161         assertNotNull(future3);
 162         assertTrue(guardStarted.get());
 163     }
 164
 165     @Test
 166     public void testStartGuardAsync() throws Exception {
 167         // remove CQ data so it's forced to query
 168         context.removeProperty(AaiCqResponse.CONTEXT_KEY);
 169
 170         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 171         assertTrue(executor.runAll(100));
 172         assertFalse(future2.isDone());
 173
 174         provideCqResponse(makeCqResponse());
 175         assertTrue(executor.runAll(100));
 176         assertTrue(future2.isDone());
 177         assertEquals(PolicyResult.SUCCESS, future2.get().getResult());
 178     }
 179
 180     @Test
 181     public void testMakeGuardPayload() {
 182         final int origCount = 30;
 183         oper.setVfCount(origCount);
 184
 185         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 186         assertTrue(executor.runAll(100));
 187         assertTrue(future2.isDone());
 188
 189         // get the payload from the request
 190         ArgumentCaptor<ControlLoopOperationParams> captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class);
 191         verify(guardOperator).buildOperation(captor.capture());
 192
 193         Map<String, Object> payload = captor.getValue().getPayload();
 194         assertNotNull(payload);
 195
 196         Integer newCount = (Integer) payload.get(VfModuleDelete.PAYLOAD_KEY_VF_COUNT);
 197         assertNotNull(newCount);
 198         assertEquals(origCount - 1, newCount.intValue());
 199     }
 200
 201     @Test
 202     public void testStartOperationAsync_testSuccessfulCompletion() throws Exception {
 203         final int origCount = 30;
 204         oper.setVfCount(origCount);
 205
 206         // use a real executor
 207         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 208
 209         oper = new MyOperation(params, config) {
 210             @Override
 211             public long getWaitMsGet() {
 212                 return 1;
 213             }
 214         };
 215
 216         CompletableFuture<OperationOutcome> future2 = oper.start();
 217
 218         outcome = future2.get(5, TimeUnit.SECONDS);
 219         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 220
 221         SoResponse resp = outcome.getResponse();
 222         assertNotNull(resp);
 223         assertEquals(REQ_ID.toString(), resp.getRequestReferences().getRequestId());
 224
 225         assertEquals(origCount - 1, oper.getVfCount());
 226     }
 227
 228     /**
 229      * Tests startOperationAsync() when "get" operations are required.
 230      */
 231     @Test
 232     public void testStartOperationAsyncWithGets() throws Exception {
 233
 234         // indicate that the response was incomplete
 235         configureResponse(coder.encode(response).replace("COMPLETE", "incomplete"));
 236
 237         when(rawResponse.getStatus()).thenReturn(500, 500, 500, 200, 200);
 238         when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse));
 239
 240         // use a real executor
 241         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 242
 243         oper = new MyOperation(params, config) {
 244             @Override
 245             public long getWaitMsGet() {
 246                 return 1;
 247             }
 248         };
 249
 250         CompletableFuture<OperationOutcome> future2 = oper.start();
 251
 252         outcome = future2.get(5, TimeUnit.SECONDS);
 253         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 254     }
 255
 256     @Test
 257     public void testMakeRequest() throws CoderException {
 258         Pair<String, SoRequest> pair = oper.makeRequest();
 259
 260         assertEquals("/my-service-instance-id/vnfs/my-vnf-id/vfModules/null", pair.getLeft());
 261
 262         verifyRequest("VfModuleDelete.json", pair.getRight());
 263     }
 264
 265     @Test
 266     public void testDelete() throws Exception {
 267         SoRequest req = new SoRequest();
 268         req.setRequestId(REQ_ID);
 269
 270         Map<String, Object> headers = Map.of("key-A", "value-A");
 271
 272         String reqText = oper.prettyPrint(req);
 273
 274         final CompletableFuture<Response> delFuture =
 275                         oper.delete("my-uri", headers, MediaType.APPLICATION_JSON, reqText, callback);
 276
 277         ArgumentCaptor<HttpRequest> reqCaptor = ArgumentCaptor.forClass(HttpRequest.class);
 278         verify(javaClient).sendAsync(reqCaptor.capture(), any());
 279
 280         HttpRequest req2 = reqCaptor.getValue();
 281         assertEquals("http://my-host:6969/my-uri", req2.uri().toString());
 282         assertEquals("DELETE", req2.method());
 283
 284         HttpHeaders headers2 = req2.headers();
 285         assertEquals("value-A", headers2.firstValue("key-A").orElse("missing-key"));
 286         assertEquals(MediaType.APPLICATION_JSON, headers2.firstValue("Content-type").orElse("missing-key"));
 287
 288         assertTrue(delFuture.isDone());
 289         Response resp = delFuture.get();
 290
 291         verify(callback).completed(resp);
 292
 293         assertEquals(200, resp.getStatus());
 294
 295         SoResponse resp2 = resp.readEntity(SoResponse.class);
 296         assertEquals(SoOperation.COMPLETE, resp2.getRequest().getRequestStatus().getRequestState());
 297     }
 298
 299     /**
 300      * Tests delete() when an exception is thrown in the future.
 301      */
 302     @Test
 303     @SuppressWarnings("unchecked")
 304     public void testDeleteException() throws Exception {
 305         Throwable thrown = new IllegalStateException(EXPECTED_EXCEPTION);
 306
 307         // need a new future, with an exception
 308         javaFuture = CompletableFuture.failedFuture(thrown);
 309         when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture);
 310
 311         SoRequest req = new SoRequest();
 312         req.setRequestId(REQ_ID);
 313
 314         String reqText = oper.prettyPrint(req);
 315
 316         CompletableFuture<Response> delFuture =
 317                         oper.delete("/my-uri", Map.of(), MediaType.APPLICATION_JSON, reqText, callback);
 318
 319         assertTrue(delFuture.isCompletedExceptionally());
 320
 321         ArgumentCaptor<Throwable> thrownCaptor = ArgumentCaptor.forClass(Throwable.class);
 322         verify(callback).failed(thrownCaptor.capture());
 323         assertSame(thrown, thrownCaptor.getValue().getCause());
 324     }
 325
 326     /**
 327      * Tests addAuthHeader() when there is a username, but no password.
 328      */
 329     @Test
 330     public void testAddAuthHeader() {
 331         Builder builder = mock(Builder.class);
 332         when(client.getUserName()).thenReturn("the-user");
 333         when(client.getPassword()).thenReturn("the-password");
 334         oper.addAuthHeader(builder);
 335
 336         ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
 337         ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
 338
 339         verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
 340
 341         assertEquals("Authorization", keyCaptor.getValue());
 342
 343         String encoded = Base64.getEncoder().encodeToString("the-user:the-password".getBytes(StandardCharsets.UTF_8));
 344         assertEquals("Basic " + encoded, valueCaptor.getValue());
 345     }
 346
 347     /**
 348      * Tests addAuthHeader() when there is no username.
 349      */
 350     @Test
 351     public void testAddAuthHeaderNoUser() {
 352         Builder builder = mock(Builder.class);
 353         when(client.getPassword()).thenReturn("world");
 354         oper.addAuthHeader(builder);
 355         verify(builder, never()).header(any(), any());
 356
 357         // repeat with empty username
 358         when(client.getUserName()).thenReturn("");
 359         oper.addAuthHeader(builder);
 360         verify(builder, never()).header(any(), any());
 361     }
 362
 363     /**
 364      * Tests addAuthHeader() when there is a username, but no password.
 365      */
 366     @Test
 367     public void testAddAuthHeaderUserOnly() {
 368         Builder builder = mock(Builder.class);
 369         when(client.getUserName()).thenReturn("my-user");
 370         oper.addAuthHeader(builder);
 371
 372         ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
 373         ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
 374
 375         verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
 376
 377         assertEquals("Authorization", keyCaptor.getValue());
 378
 379         String encoded = Base64.getEncoder().encodeToString("my-user:".getBytes(StandardCharsets.UTF_8));
 380         assertEquals("Basic " + encoded, valueCaptor.getValue());
 381     }
 382
 383     @Test
 384     public void testMakeHttpClient() {
 385         // must use a real operation to invoke this method
 386         assertNotNull(new VfModuleDelete(params, config).makeHttpClient());
 387     }
 388
 389
 390     @Override
 391     protected void makeContext() {
 392         super.makeContext();
 393
 394         AaiCqResponse cq = mock(AaiCqResponse.class);
 395
 396         GenericVnf vnf = new GenericVnf();
 397         when(cq.getGenericVnfByVfModuleModelInvariantId(MODEL_INVAR_ID)).thenReturn(vnf);
 398         vnf.setVnfId(VNF_ID);
 399
 400         ServiceInstance instance = new ServiceInstance();
 401         when(cq.getServiceInstance()).thenReturn(instance);
 402         instance.setServiceInstanceId(SVC_INSTANCE_ID);
 403
 404         when(cq.getDefaultTenant()).thenReturn(new Tenant());
 405         when(cq.getDefaultCloudRegion()).thenReturn(new CloudRegion());
 406
 407         ModelVer modelVers = new ModelVer();
 408         when(cq.getModelVerByVersionId(any())).thenReturn(modelVers);
 409         modelVers.setModelName(MODEL_NAME2);
 410         modelVers.setModelVersion(MODEL_VERS2);
 411
 412         params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, cq);
 413     }
 414
 415     private void initHostPort() {
 416         when(client.getBaseUrl()).thenReturn("http://my-host:6969/");
 417     }
 418
 419     @SuppressWarnings("unchecked")
 420     private void configureResponse(String responseText) throws CoderException {
 421         // indicate that the response was completed
 422         when(javaResp.statusCode()).thenReturn(200);
 423         when(javaResp.body()).thenReturn(responseText);
 424
 425         javaFuture = CompletableFuture.completedFuture(javaResp);
 426         when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture);
 427     }
 428
 429     private class MyOperation extends VfModuleDelete {
 430
 431         public MyOperation(ControlLoopOperationParams params, HttpConfig config) {
 432             super(params, config);
 433         }
 434
 435         @Override
 436         protected java.net.http.HttpClient makeHttpClient() {
 437             return javaClient;
 438         }
 439     }
 440 }