models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleCreateTest.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.assertThat;
  24 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
  25 import static org.junit.Assert.assertEquals;
  26 import static org.junit.Assert.assertFalse;
  27 import static org.junit.Assert.assertNotNull;
  28 import static org.junit.Assert.assertNull;
  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.verify;
  33 import static org.mockito.Mockito.when;
  34
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.concurrent.CompletableFuture;
  38 import java.util.concurrent.ForkJoinPool;
  39 import java.util.concurrent.TimeUnit;
  40 import java.util.concurrent.atomic.AtomicBoolean;
  41 import org.apache.commons.lang3.tuple.Pair;
  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.onap.aai.domain.yang.CloudRegion;
  48 import org.onap.aai.domain.yang.GenericVnf;
  49 import org.onap.aai.domain.yang.ModelVer;
  50 import org.onap.aai.domain.yang.ServiceInstance;
  51 import org.onap.aai.domain.yang.Tenant;
  52 import org.onap.policy.aai.AaiCqResponse;
  53 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  54 import org.onap.policy.common.utils.coder.CoderException;
  55 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  56 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  57 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  58 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
  59 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams;
  60 import org.onap.policy.controlloop.policy.PolicyResult;
  61 import org.onap.policy.so.SoRequest;
  62 import org.onap.policy.so.SoResponse;
  63
  64 public class VfModuleCreateTest extends BasicSoOperation {
  65     private static final String MODEL_NAME2 = "my-model-name-B";
  66     private static final String MODEL_VERS2 = "my-model-version-B";
  67     private static final String SVC_INSTANCE_ID = "my-service-instance-id";
  68     private static final String VNF_ID = "my-vnf-id";
  69
  70     private VfModuleCreate oper;
  71
  72     public VfModuleCreateTest() {
  73         super(DEFAULT_ACTOR, VfModuleCreate.NAME);
  74     }
  75
  76     @BeforeClass
  77     public static void setUpBeforeClass() throws Exception {
  78         initBeforeClass();
  79     }
  80
  81     @AfterClass
  82     public static void tearDownAfterClass() {
  83         destroyAfterClass();
  84     }
  85
  86     @Before
  87     public void setUp() throws Exception {
  88         super.setUp();
  89         oper = new VfModuleCreate(params, config);
  90     }
  91
  92     /**
  93      * Tests "success" case with simulator.
  94      */
  95     @Test
  96     public void testSuccess() throws Exception {
  97         HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT)
  98                         .path("serviceInstantiation/v7/serviceInstances").pollPath("orchestrationRequests/v5/")
  99                         .maxPolls(2).build();
 100         config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 101
 102         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build();
 103
 104         oper = new VfModuleCreate(params, config);
 105
 106         outcome = oper.start().get();
 107         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 108         assertTrue(outcome.getResponse() instanceof SoResponse);
 109     }
 110
 111     /**
 112      * Tests "success" case with simulator, using properties instead of custom query data.
 113      */
 114     @Test
 115     public void testSuccessViaProperties() throws Exception {
 116         HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT)
 117                         .path("serviceInstantiation/v7/serviceInstances").pollPath("orchestrationRequests/v5/")
 118                         .maxPolls(2).build();
 119         config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 120
 121         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).preprocessed(true).build();
 122         params.getContext().removeProperty(AaiCqResponse.CONTEXT_KEY);
 123
 124         oper = new VfModuleCreate(params, config);
 125
 126         // set the properties
 127         ServiceInstance instance = new ServiceInstance();
 128         instance.setServiceInstanceId(SVC_INSTANCE_ID);
 129         oper.setProperty(OperationProperties.AAI_SERVICE, instance);
 130
 131         ModelVer modelVers = new ModelVer();
 132         modelVers.setModelName(MODEL_NAME2);
 133         modelVers.setModelVersion(MODEL_VERS2);
 134
 135         oper.setProperty(OperationProperties.AAI_SERVICE_MODEL, modelVers);
 136         oper.setProperty(OperationProperties.AAI_VNF_MODEL, modelVers);
 137
 138         GenericVnf vnf = new GenericVnf();
 139         vnf.setVnfId(VNF_ID);
 140         oper.setProperty(OperationProperties.AAI_VNF, vnf);
 141
 142         oper.setProperty(OperationProperties.AAI_DEFAULT_CLOUD_REGION, new CloudRegion());
 143         oper.setProperty(OperationProperties.AAI_DEFAULT_TENANT, new Tenant());
 144
 145         oper.setProperty(OperationProperties.DATA_VF_COUNT, VF_COUNT);
 146
 147         // run the operation
 148         outcome = oper.start().get();
 149         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 150         assertTrue(outcome.getResponse() instanceof SoResponse);
 151
 152         int count = oper.getProperty(OperationProperties.DATA_VF_COUNT);
 153         assertEquals(VF_COUNT + 1, count);
 154     }
 155
 156     @Test
 157     public void testConstructor() {
 158         assertEquals(DEFAULT_ACTOR, oper.getActorName());
 159         assertEquals(VfModuleCreate.NAME, oper.getName());
 160
 161         // verify that target validation is done
 162         params = params.toBuilder().target(null).build();
 163         assertThatIllegalArgumentException().isThrownBy(() -> new VfModuleCreate(params, config))
 164                         .withMessageContaining("Target information");
 165     }
 166
 167     @Test
 168     public void testGetPropertyNames() {
 169         // @formatter:off
 170         assertThat(oper.getPropertyNames()).isEqualTo(
 171                         List.of(
 172                             OperationProperties.AAI_SERVICE,
 173                             OperationProperties.AAI_SERVICE_MODEL,
 174                             OperationProperties.AAI_VNF,
 175                             OperationProperties.AAI_VNF_MODEL,
 176                             OperationProperties.AAI_DEFAULT_CLOUD_REGION,
 177                             OperationProperties.AAI_DEFAULT_TENANT,
 178                             OperationProperties.DATA_VF_COUNT));
 179         // @formatter:on
 180     }
 181
 182     @Test
 183     public void testStartPreprocessorAsync() throws Exception {
 184         // insert CQ data so it's there for the check
 185         context.setProperty(AaiCqResponse.CONTEXT_KEY, makeCqResponse());
 186
 187         AtomicBoolean guardStarted = new AtomicBoolean();
 188
 189         oper = new VfModuleCreate(params, config) {
 190             @Override
 191             protected CompletableFuture<OperationOutcome> startGuardAsync() {
 192                 guardStarted.set(true);
 193                 return super.startGuardAsync();
 194             }
 195         };
 196
 197         CompletableFuture<OperationOutcome> future3 = oper.startPreprocessorAsync();
 198         assertNotNull(future3);
 199         assertTrue(guardStarted.get());
 200     }
 201
 202     /**
 203      * Tests startPreprocessorAsync(), when preprocessing is disabled.
 204      */
 205     @Test
 206     public void testStartPreprocessorAsyncDisabled() {
 207         params = params.toBuilder().preprocessed(true).build();
 208         assertNull(new VfModuleCreate(params, config).startPreprocessorAsync());
 209     }
 210
 211     @Test
 212     public void testStartGuardAsync() throws Exception {
 213         // remove CQ data so it's forced to query
 214         context.removeProperty(AaiCqResponse.CONTEXT_KEY);
 215
 216         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 217         assertTrue(executor.runAll(100));
 218         assertFalse(future2.isDone());
 219
 220         provideCqResponse(makeCqResponse());
 221         assertTrue(executor.runAll(100));
 222         assertTrue(future2.isDone());
 223         assertEquals(PolicyResult.SUCCESS, future2.get().getResult());
 224     }
 225
 226     @Test
 227     public void testMakeGuardPayload() {
 228         final int origCount = 30;
 229         oper.setVfCount(origCount);
 230
 231         CompletableFuture<OperationOutcome> future2 = oper.startPreprocessorAsync();
 232         assertTrue(executor.runAll(100));
 233         assertTrue(future2.isDone());
 234
 235         // get the payload from the request
 236         ArgumentCaptor<ControlLoopOperationParams> captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class);
 237         verify(guardOperator).buildOperation(captor.capture());
 238
 239         Map<String, Object> payload = captor.getValue().getPayload();
 240         assertNotNull(payload);
 241
 242         Integer newCount = (Integer) payload.get(VfModuleCreate.PAYLOAD_KEY_VF_COUNT);
 243         assertNotNull(newCount);
 244         assertEquals(origCount + 1, newCount.intValue());
 245     }
 246
 247     @Test
 248     public void testStartOperationAsync_testSuccessfulCompletion() throws Exception {
 249         final int origCount = 30;
 250         oper.setVfCount(origCount);
 251
 252         when(client.post(any(), any(), any(), any())).thenAnswer(provideResponse(rawResponse));
 253
 254         // use a real executor
 255         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 256
 257         oper = new VfModuleCreate(params, config) {
 258             @Override
 259             protected long getPollWaitMs() {
 260                 return 1;
 261             }
 262         };
 263
 264         CompletableFuture<OperationOutcome> future2 = oper.start();
 265
 266         outcome = future2.get(5, TimeUnit.SECONDS);
 267         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 268
 269         SoResponse resp = outcome.getResponse();
 270         assertNotNull(resp);
 271         assertEquals(REQ_ID.toString(), resp.getRequestReferences().getRequestId());
 272
 273         assertEquals(origCount + 1, oper.getVfCount());
 274     }
 275
 276     /**
 277      * Tests startOperationAsync() when polling is required.
 278      */
 279     @Test
 280     public void testStartOperationAsyncWithPolling() throws Exception {
 281         when(rawResponse.getStatus()).thenReturn(500, 500, 500, 500, 200, 200);
 282
 283         when(client.post(any(), any(), any(), any())).thenAnswer(provideResponse(rawResponse));
 284         when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse));
 285
 286         // use a real executor
 287         params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
 288
 289         oper = new VfModuleCreate(params, config) {
 290             @Override
 291             public long getPollWaitMs() {
 292                 return 1;
 293             }
 294         };
 295
 296         CompletableFuture<OperationOutcome> future2 = oper.start();
 297
 298         outcome = future2.get(5, TimeUnit.SECONDS);
 299         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 300     }
 301
 302     @Test
 303     public void testMakeRequest() throws CoderException {
 304         Pair<String, SoRequest> pair = oper.makeRequest();
 305
 306         // @formatter:off
 307         assertEquals(
 308             "/my-service-instance-id/vnfs/my-vnf-id/vfModules/scaleOut",
 309             pair.getLeft());
 310         // @formatter:on
 311
 312         verifyRequest("vfModuleCreate.json", pair.getRight());
 313     }
 314
 315
 316     @Override
 317     protected void makeContext() {
 318         super.makeContext();
 319
 320         AaiCqResponse cq = mock(AaiCqResponse.class);
 321
 322         GenericVnf vnf = new GenericVnf();
 323         when(cq.getGenericVnfByVfModuleModelInvariantId(MODEL_INVAR_ID)).thenReturn(vnf);
 324         vnf.setVnfId(VNF_ID);
 325
 326         ServiceInstance instance = new ServiceInstance();
 327         when(cq.getServiceInstance()).thenReturn(instance);
 328         instance.setServiceInstanceId(SVC_INSTANCE_ID);
 329
 330         when(cq.getDefaultTenant()).thenReturn(new Tenant());
 331         when(cq.getDefaultCloudRegion()).thenReturn(new CloudRegion());
 332
 333         ModelVer modelVers = new ModelVer();
 334         when(cq.getModelVerByVersionId(any())).thenReturn(modelVers);
 335         modelVers.setModelName(MODEL_NAME2);
 336         modelVers.setModelVersion(MODEL_VERS2);
 337
 338         params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, cq);
 339     }
 340 }