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.Coder;
  65 import org.onap.policy.common.utils.coder.CoderException;
  66 import org.onap.policy.common.utils.coder.StandardCoder;
  67 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  68 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  69 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  70 import org.onap.policy.controlloop.policy.PolicyResult;
  71 import org.onap.policy.so.SoRequest;
  72 import org.onap.policy.so.SoResponse;
  73
  74 public class VfModuleDeleteTest extends BasicSoOperation {
  75     private static final String EXPECTED_EXCEPTION = "expected exception";
  76     private static final String MODEL_NAME2 = "my-model-name-B";
  77     private static final String MODEL_VERS2 = "my-model-version-B";
  78     private static final String SVC_INSTANCE_ID = "my-service-instance-id";
  79     private static final String VNF_ID = "my-vnf-id";
  80
  81     @Mock
  82     private java.net.http.HttpClient javaClient;
  83     @Mock
  84     private HttpResponse<String> javaResp;
  85     @Mock
  86     private InvocationCallback<Response> callback;
  87
  88     private CompletableFuture<HttpResponse<String>> javaFuture;
  89     private VfModuleDelete oper;
  90
  91     public VfModuleDeleteTest() {
  92         super(DEFAULT_ACTOR, VfModuleDelete.NAME);
  93     }
  94
  95     @BeforeClass
  96     public static void setUpBeforeClass() throws Exception {
  97         initBeforeClass();
  98     }
  99
 100     @AfterClass
 101     public static void tearDownAfterClass() {
 102         destroyAfterClass();
 103     }
 104
 105     /**
 106      * Sets up.
 107      */
 108     @Before
 109     public void setUp() throws Exception {
 110         super.setUp();
 111
 112         initHostPort();
 113
 114         configureResponse(coder.encode(response));
 115
 116         oper = new MyOperation(params, config);
 117     }
 118
 119     /**
 120      * Tests "success" case with simulator.
 121      */
 122     @Test
 123     public void testSuccess() throws Exception {
 124         SoParams opParams = SoParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7")
 125                         .pathGet("orchestrationRequests/v5/").maxGets(2).build();
 126         config = new SoConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 127
 128         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build();
 129         oper = new VfModuleDelete(params, config);
 130
 131         outcome = oper.start().get();
 132         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 133         assertTrue(outcome.getResponse() instanceof SoResponse);
 134     }
 135
 136     @Test
 137     public void testConstructor() {
 138         assertEquals(DEFAULT_ACTOR, oper.getActorName());
 139         assertEquals(VfModuleDelete.NAME, oper.getName());
 140
 141         // verify that target validation is done
 142         params = params.toBuilder().target(null).build();
 143         assertThatIllegalArgumentException().isThrownBy(() -> new VfModuleDelete(params, config))
 144                         .withMessageContaining("Target information");
 145     }
 146
 147     @Test
 148     public void testStartPreprocessorAsync() throws Exception {
 149         // insert CQ data so it's there for the check
 150         context.setProperty(AaiCqResponse.CONTEXT_KEY, makeCqResponse());
 151
 152         AtomicBoolean guardStarted = new AtomicBoolean();
 153
 154         oper = new MyOperation(params, config) {
 155             @Override
 156             protected CompletableFuture<OperationOutcome> startGuardAsync() {
 157                 guardStarted.set(true);
 158                 return super.startGuardAsync();
 159             }
 160         };
 161
 162         CompletableFuture<OperationOutcome> future3 = oper.startPreprocessorAsync();
 163         assertNotNull(future3);
 164         assertTrue(guardStarted.get());
 165     }
 166
 167     @Test
 168     public void testStartGuardAsync() throws Exception {
 169         // remove CQ data so it's forced to query
 170         context.removeProperty(AaiCqResponse.CONTEXT_KEY);
 171
 172         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 173         assertTrue(executor.runAll(100));
 174         assertFalse(future2.isDone());
 175
 176         provideCqResponse(makeCqResponse());
 177         assertTrue(executor.runAll(100));
 178         assertTrue(future2.isDone());
 179         assertEquals(PolicyResult.SUCCESS, future2.get().getResult());
 180     }
 181
 182     @Test
 183     public void testMakeGuardPayload() {
 184         final int origCount = 30;
 185         oper.setVfCount(origCount);
 186
 187         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 188         assertTrue(executor.runAll(100));
 189         assertTrue(future2.isDone());
 190
 191         // get the payload from the request
 192         ArgumentCaptor<ControlLoopOperationParams> captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class);
 193         verify(guardOperator).buildOperation(captor.capture());
 194
 195         Map<String, Object> payload = captor.getValue().getPayload();
 196         assertNotNull(payload);
 197
 198         Integer newCount = (Integer) payload.get(VfModuleDelete.PAYLOAD_KEY_VF_COUNT);
 199         assertNotNull(newCount);
 200         assertEquals(origCount - 1, newCount.intValue());
 201     }
 202
 203     @Test
 204     public void testStartOperationAsync_testSuccessfulCompletion() throws Exception {
 205         final int origCount = 30;
 206         oper.setVfCount(origCount);
 207
 208         // use a real executor
 209         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 210
 211         oper = new MyOperation(params, config) {
 212             @Override
 213             public long getWaitMsGet() {
 214                 return 1;
 215             }
 216         };
 217
 218         CompletableFuture<OperationOutcome> future2 = oper.start();
 219
 220         outcome = future2.get(5, TimeUnit.SECONDS);
 221         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 222
 223         SoResponse resp = outcome.getResponse();
 224         assertNotNull(resp);
 225         assertEquals(REQ_ID.toString(), resp.getRequestReferences().getRequestId());
 226
 227         assertEquals(origCount - 1, oper.getVfCount());
 228     }
 229
 230     /**
 231      * Tests startOperationAsync() when "get" operations are required.
 232      */
 233     @Test
 234     public void testStartOperationAsyncWithGets() throws Exception {
 235
 236         // indicate that the response was incomplete
 237         configureResponse(coder.encode(response).replace("COMPLETE", "incomplete"));
 238
 239         when(rawResponse.getStatus()).thenReturn(500, 500, 500, 200, 200);
 240         when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse));
 241
 242         // use a real executor
 243         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 244
 245         oper = new MyOperation(params, config) {
 246             @Override
 247             public long getWaitMsGet() {
 248                 return 1;
 249             }
 250         };
 251
 252         CompletableFuture<OperationOutcome> future2 = oper.start();
 253
 254         outcome = future2.get(5, TimeUnit.SECONDS);
 255         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 256     }
 257
 258     @Test
 259     public void testMakeRequest() throws CoderException {
 260         Pair<String, SoRequest> pair = oper.makeRequest();
 261
 262         assertEquals("/my-service-instance-id/vnfs/my-vnf-id/vfModules/null", pair.getLeft());
 263
 264         verifyRequest("VfModuleDelete.json", pair.getRight());
 265     }
 266
 267     @Test
 268     public void testDelete() throws Exception {
 269         SoRequest req = new SoRequest();
 270         req.setRequestId(REQ_ID);
 271
 272         Map<String, Object> headers = Map.of("key-A", "value-A");
 273
 274         final CompletableFuture<Response> delFuture =
 275                         oper.delete("my-uri", headers, MediaType.APPLICATION_JSON, req, 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         CompletableFuture<Response> delFuture =
 315                         oper.delete("/my-uri", Map.of(), MediaType.APPLICATION_JSON, req, callback);
 316
 317         assertTrue(delFuture.isCompletedExceptionally());
 318
 319         ArgumentCaptor<Throwable> thrownCaptor = ArgumentCaptor.forClass(Throwable.class);
 320         verify(callback).failed(thrownCaptor.capture());
 321         assertSame(thrown, thrownCaptor.getValue().getCause());
 322     }
 323
 324     @Test
 325     public void testEncodeBody() {
 326         // try when request is already a string
 327         assertEquals("hello", oper.encodeRequest("hello"));
 328
 329         // try with a real request
 330         SoRequest req = new SoRequest();
 331         req.setRequestId(REQ_ID);
 332         assertEquals("{\"requestId\":\"" + REQ_ID.toString() + "\"}", oper.encodeRequest(req));
 333
 334         // coder throws an exception
 335         oper = new MyOperation(params, config) {
 336             @Override
 337             protected Coder makeCoder() {
 338                 return new StandardCoder() {
 339                     @Override
 340                     public String encode(Object object) throws CoderException {
 341                         throw new CoderException(EXPECTED_EXCEPTION);
 342                     }
 343                 };
 344             }
 345         };
 346
 347         assertThatIllegalArgumentException().isThrownBy(() -> oper.encodeRequest(req))
 348                         .withMessage("cannot encode request");
 349     }
 350
 351     /**
 352      * Tests addAuthHeader() when there is a username, but no password.
 353      */
 354     @Test
 355     public void testAddAuthHeader() {
 356         Builder builder = mock(Builder.class);
 357         when(client.getUserName()).thenReturn("the-user");
 358         when(client.getPassword()).thenReturn("the-password");
 359         oper.addAuthHeader(builder);
 360
 361         ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
 362         ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
 363
 364         verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
 365
 366         assertEquals("Authorization", keyCaptor.getValue());
 367
 368         String encoded = Base64.getEncoder().encodeToString("the-user:the-password".getBytes(StandardCharsets.UTF_8));
 369         assertEquals("Basic " + encoded, valueCaptor.getValue());
 370     }
 371
 372     /**
 373      * Tests addAuthHeader() when there is no username.
 374      */
 375     @Test
 376     public void testAddAuthHeaderNoUser() {
 377         Builder builder = mock(Builder.class);
 378         when(client.getPassword()).thenReturn("world");
 379         oper.addAuthHeader(builder);
 380         verify(builder, never()).header(any(), any());
 381
 382         // repeat with empty username
 383         when(client.getUserName()).thenReturn("");
 384         oper.addAuthHeader(builder);
 385         verify(builder, never()).header(any(), any());
 386     }
 387
 388     /**
 389      * Tests addAuthHeader() when there is a username, but no password.
 390      */
 391     @Test
 392     public void testAddAuthHeaderUserOnly() {
 393         Builder builder = mock(Builder.class);
 394         when(client.getUserName()).thenReturn("my-user");
 395         oper.addAuthHeader(builder);
 396
 397         ArgumentCaptor<String> keyCaptor = ArgumentCaptor.forClass(String.class);
 398         ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
 399
 400         verify(builder).header(keyCaptor.capture(), valueCaptor.capture());
 401
 402         assertEquals("Authorization", keyCaptor.getValue());
 403
 404         String encoded = Base64.getEncoder().encodeToString("my-user:".getBytes(StandardCharsets.UTF_8));
 405         assertEquals("Basic " + encoded, valueCaptor.getValue());
 406     }
 407
 408     @Test
 409     public void testMakeHttpClient() {
 410         // must use a real operation to invoke this method
 411         assertNotNull(new VfModuleDelete(params, config).makeHttpClient());
 412     }
 413
 414
 415     @Override
 416     protected void makeContext() {
 417         super.makeContext();
 418
 419         AaiCqResponse cq = mock(AaiCqResponse.class);
 420
 421         GenericVnf vnf = new GenericVnf();
 422         when(cq.getGenericVnfByVfModuleModelInvariantId(MODEL_INVAR_ID)).thenReturn(vnf);
 423         vnf.setVnfId(VNF_ID);
 424
 425         ServiceInstance instance = new ServiceInstance();
 426         when(cq.getServiceInstance()).thenReturn(instance);
 427         instance.setServiceInstanceId(SVC_INSTANCE_ID);
 428
 429         when(cq.getDefaultTenant()).thenReturn(new Tenant());
 430         when(cq.getDefaultCloudRegion()).thenReturn(new CloudRegion());
 431
 432         ModelVer modelVers = new ModelVer();
 433         when(cq.getModelVerByVersionId(any())).thenReturn(modelVers);
 434         modelVers.setModelName(MODEL_NAME2);
 435         modelVers.setModelVersion(MODEL_VERS2);
 436
 437         params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, cq);
 438     }
 439
 440     private void initHostPort() {
 441         when(client.getBaseUrl()).thenReturn("http://my-host:6969/");
 442     }
 443
 444     @SuppressWarnings("unchecked")
 445     private void configureResponse(String responseText) throws CoderException {
 446         // indicate that the response was completed
 447         when(javaResp.statusCode()).thenReturn(200);
 448         when(javaResp.body()).thenReturn(responseText);
 449
 450         javaFuture = CompletableFuture.completedFuture(javaResp);
 451         when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture);
 452     }
 453
 454     private class MyOperation extends VfModuleDelete {
 455
 456         public MyOperation(ControlLoopOperationParams params, HttpConfig config) {
 457             super(params, config);
 458         }
 459
 460         @Override
 461         protected java.net.http.HttpClient makeHttpClient() {
 462             return javaClient;
 463         }
 464     }
 465 }