models-interactions/model-actors/actor.cds/src/test/java/org/onap/policy/controlloop/actor/cds/GrpcOperationTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2020 Bell Canada. All rights reserved.
   4  * Modifications Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  * ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.policy.controlloop.actor.cds;
  21
  22 import static org.assertj.core.api.Assertions.assertThat;
  23 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertNotNull;
  26 import static org.junit.Assert.assertTrue;
  27 import static org.mockito.ArgumentMatchers.any;
  28 import static org.mockito.Mockito.mock;
  29 import static org.mockito.Mockito.when;
  30
  31 import java.util.Collections;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.UUID;
  36 import java.util.concurrent.CompletableFuture;
  37 import java.util.concurrent.CountDownLatch;
  38 import java.util.concurrent.Executor;
  39 import org.junit.AfterClass;
  40 import org.junit.Before;
  41 import org.junit.BeforeClass;
  42 import org.junit.Test;
  43 import org.mockito.Mock;
  44 import org.mockito.MockitoAnnotations;
  45 import org.onap.aai.domain.yang.GenericVnf;
  46 import org.onap.aai.domain.yang.ServiceInstance;
  47 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
  48 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceOutput;
  49 import org.onap.policy.cds.client.CdsProcessorGrpcClient;
  50 import org.onap.policy.cds.properties.CdsServerProperties;
  51 import org.onap.policy.common.utils.coder.Coder;
  52 import org.onap.policy.common.utils.coder.CoderException;
  53 import org.onap.policy.common.utils.coder.StandardCoder;
  54 import org.onap.policy.common.utils.coder.StandardCoderObject;
  55 import org.onap.policy.common.utils.time.PseudoExecutor;
  56 import org.onap.policy.controlloop.actor.cds.constants.CdsActorConstants;
  57 import org.onap.policy.controlloop.actorserviceprovider.ActorService;
  58 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  59 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  60 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
  61 import org.onap.policy.controlloop.actorserviceprovider.TargetType;
  62 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  63 import org.onap.policy.simulators.CdsSimulator;
  64 import org.onap.policy.simulators.Util;
  65
  66 public class GrpcOperationTest {
  67     private static final String MY_VNF = "my-vnf";
  68     private static final String MY_SVC_ID = "my-service-instance-id";
  69     private static final String RESOURCE_ID = "my-resource-id";
  70     private static final String CDS_BLUEPRINT_NAME = "vfw-cds";
  71     private static final String CDS_BLUEPRINT_VERSION = "1.0.0";
  72     private static final UUID REQUEST_ID = UUID.randomUUID();
  73     private static final Coder coder = new StandardCoder();
  74
  75     protected static final Executor blockingExecutor = command -> {
  76         Thread thread = new Thread(command);
  77         thread.setDaemon(true);
  78         thread.start();
  79     };
  80
  81     private static CdsSimulator sim;
  82
  83     @Mock
  84     private CdsProcessorGrpcClient cdsClient;
  85     private CdsServerProperties cdsProps;
  86     private PseudoExecutor executor;
  87     private Map<String, String> targetEntityIds;
  88     private ControlLoopOperationParams params;
  89     private GrpcConfig config;
  90     private GrpcOperation operation;
  91
  92     @BeforeClass
  93     public static void setUpBeforeClass() throws Exception {
  94         sim = Util.buildCdsSim();
  95     }
  96
  97     @AfterClass
  98     public static void tearDownAfterClass() {
  99         sim.stop();
 100     }
 101
 102     /**
 103      * Sets up the fields.
 104      */
 105     @Before
 106     public void setUp() throws Exception {
 107         MockitoAnnotations.initMocks(this);
 108
 109         // Setup the CDS properties
 110         cdsProps = new CdsServerProperties();
 111         cdsProps.setHost("10.10.10.10");
 112         cdsProps.setPort(2000);
 113         cdsProps.setUsername("testUser");
 114         cdsProps.setPassword("testPassword");
 115         cdsProps.setTimeout(1);
 116
 117         // Setup cdsClient
 118         when(cdsClient.sendRequest(any(ExecutionServiceInput.class))).thenReturn(mock(CountDownLatch.class));
 119
 120         // Setup executor
 121         executor = new PseudoExecutor();
 122
 123         targetEntityIds = new HashMap<>();
 124         targetEntityIds.put(ControlLoopOperationParams.PARAMS_ENTITY_RESOURCEID, RESOURCE_ID);
 125
 126         params = ControlLoopOperationParams.builder().actor(CdsActorConstants.CDS_ACTOR).operation(GrpcOperation.NAME)
 127                         .requestId(REQUEST_ID).actorService(new ActorService())
 128                         .build();
 129     }
 130
 131     /**
 132      * Tests "success" case with simulator.
 133      */
 134     @Test
 135     public void testSuccess() throws Exception {
 136         Map<String, Object> payload = Map.of("artifact_name", "my_artifact", "artifact_version", "1.0");
 137
 138         params = ControlLoopOperationParams.builder().actor(CdsActorConstants.CDS_ACTOR).operation("subscribe")
 139                         .requestId(REQUEST_ID).actorService(new ActorService())
 140                         .retry(0).timeoutSec(5).executor(blockingExecutor).payload(payload)
 141                         .build();
 142
 143         cdsProps.setHost("localhost");
 144         cdsProps.setPort(sim.getPort());
 145         cdsProps.setTimeout(3);
 146
 147         GrpcConfig config = new GrpcConfig(blockingExecutor, cdsProps);
 148
 149         operation = new GrpcOperation(params, config);
 150
 151         // set the properties
 152         operation.setProperty(OperationProperties.OPT_CDS_GRPC_AAI_PROPERTIES, Collections.emptyMap());
 153
 154         OperationOutcome outcome = operation.start().get();
 155         assertEquals(OperationResult.SUCCESS, outcome.getResult());
 156         assertTrue(outcome.getResponse() instanceof ExecutionServiceOutput);
 157     }
 158
 159     @Test
 160     public void testGetPropertyNames() {
 161
 162         /*
 163          * check VNF case
 164          */
 165         operation = new GrpcOperation(params, config);
 166
 167         // @formatter:off
 168         assertThat(operation.getPropertyNames()).isEqualTo(
 169                         List.of(
 170                             OperationProperties.AAI_RESOURCE_VNF,
 171                             OperationProperties.AAI_SERVICE,
 172                             OperationProperties.EVENT_ADDITIONAL_PARAMS,
 173                             OperationProperties.OPT_CDS_GRPC_AAI_PROPERTIES));
 174         // @formatter:on
 175
 176         /*
 177          * check PNF case
 178          */
 179         params = params.toBuilder().targetType(TargetType.PNF).build();
 180         operation = new GrpcOperation(params, config);
 181
 182         // @formatter:off
 183         assertThat(operation.getPropertyNames()).isEqualTo(
 184                         List.of(
 185                             OperationProperties.AAI_PNF,
 186                             OperationProperties.EVENT_ADDITIONAL_PARAMS,
 187                             OperationProperties.OPT_CDS_GRPC_AAI_PROPERTIES));
 188         // @formatter:on
 189     }
 190
 191     @Test
 192     public void testGetServiceInstanceId() {
 193         operation = new GrpcOperation(params, config);
 194         loadVnfData();
 195         assertEquals(MY_SVC_ID, operation.getServiceInstanceId());
 196     }
 197
 198     @Test
 199     public void testGetVnfId() {
 200         operation = new GrpcOperation(params, config);
 201         loadVnfData();
 202         assertEquals(MY_VNF, operation.getVnfId());
 203     }
 204
 205     @Test
 206     public void testStartOperationAsync() throws Exception {
 207         verifyOperation(TargetType.VNF, this::loadVnfData);
 208     }
 209
 210     /**
 211      * Tests startOperationAsync() when the target type is PNF.
 212      */
 213     @Test
 214     public void testStartOperationAsyncPnf() throws Exception {
 215         verifyOperation(TargetType.PNF, this::loadPnfData);
 216     }
 217
 218     @Test
 219     public void testStartOperationAsyncError() throws Exception {
 220         operation = new GrpcOperation(params, config);
 221         assertThatIllegalArgumentException()
 222                         .isThrownBy(() -> operation.startOperationAsync(1, params.makeOutcome(null)));
 223     }
 224
 225     private void verifyOperation(TargetType targetType, Runnable loader) {
 226
 227         Map<String, Object> payloadMap = Map.of(CdsActorConstants.KEY_CBA_NAME, CDS_BLUEPRINT_NAME,
 228                         CdsActorConstants.KEY_CBA_VERSION, CDS_BLUEPRINT_VERSION, "data",
 229                         "{\"mapInfo\":{\"key\":\"val\"},\"arrayInfo\":[\"one\",\"two\"],\"paramInfo\":\"val\"}");
 230
 231         ControlLoopOperationParams params = ControlLoopOperationParams.builder().actor(CdsActorConstants.CDS_ACTOR)
 232                         .operation(GrpcOperation.NAME).requestId(REQUEST_ID).actorService(new ActorService())
 233                         .targetType(targetType).payload(payloadMap).build();
 234
 235         GrpcConfig config = new GrpcConfig(executor, cdsProps);
 236         operation = new GrpcOperation(params, config);
 237         assertEquals(1000, operation.getTimeoutMs(null));
 238         assertEquals(1000, operation.getTimeoutMs(0));
 239         assertEquals(2000, operation.getTimeoutMs(2));
 240         operation.generateSubRequestId(1);
 241
 242         loader.run();
 243         CompletableFuture<OperationOutcome> future3 = operation.startOperationAsync(1, params.makeOutcome(null));
 244         assertNotNull(future3);
 245     }
 246
 247     private void loadPnfData() {
 248         try {
 249             String json = "{'dataA': 'valueA', 'dataB': 'valueB'}".replace('\'', '"');
 250             StandardCoderObject sco = coder.decode(json, StandardCoderObject.class);
 251
 252             operation.setProperty(OperationProperties.AAI_PNF, sco);
 253
 254         } catch (CoderException e) {
 255             throw new IllegalArgumentException("cannot decode PNF json", e);
 256         }
 257     }
 258
 259     private void loadVnfData() {
 260         GenericVnf genvnf = new GenericVnf();
 261         genvnf.setVnfId(MY_VNF);
 262         operation.setProperty(OperationProperties.AAI_RESOURCE_VNF, genvnf);
 263
 264         ServiceInstance serviceInstance = new ServiceInstance();
 265         serviceInstance.setServiceInstanceId(MY_SVC_ID);
 266         operation.setProperty(OperationProperties.AAI_SERVICE, serviceInstance);
 267     }
 268 }