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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 Bell Canada. All rights reserved.
   4  * Modifications Copyright (C) 2020 Nordix Foundation.
   5  * Modifications 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.cds;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.junit.Assert.assertFalse;
  25 import static org.junit.Assert.assertNotNull;
  26 import static org.junit.Assert.assertSame;
  27 import static org.junit.Assert.assertTrue;
  28 import static org.mockito.ArgumentMatchers.any;
  29 import static org.mockito.ArgumentMatchers.anyLong;
  30 import static org.mockito.Mockito.doThrow;
  31 import static org.mockito.Mockito.mock;
  32 import static org.mockito.Mockito.verify;
  33 import static org.mockito.Mockito.when;
  34
  35 import com.google.common.collect.ImmutableMap;
  36 import com.google.protobuf.Struct;
  37 import java.util.HashMap;
  38 import java.util.Map;
  39 import java.util.Optional;
  40 import java.util.UUID;
  41 import java.util.concurrent.CountDownLatch;
  42 import java.util.concurrent.TimeUnit;
  43 import org.junit.Before;
  44 import org.junit.Test;
  45 import org.mockito.Mock;
  46 import org.mockito.MockitoAnnotations;
  47 import org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers;
  48 import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader;
  49 import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType;
  50 import org.onap.ccsdk.cds.controllerblueprints.common.api.Status;
  51 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
  52 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceOutput;
  53 import org.onap.policy.cds.CdsResponse;
  54 import org.onap.policy.cds.client.CdsProcessorGrpcClient;
  55 import org.onap.policy.cds.properties.CdsServerProperties;
  56 import org.onap.policy.controlloop.ControlLoopOperation;
  57 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  58 import org.onap.policy.controlloop.actor.cds.CdsActor.CdsActorServiceManager;
  59 import org.onap.policy.controlloop.actor.cds.constants.CdsActorConstants;
  60 import org.onap.policy.controlloop.actor.test.BasicActor;
  61 import org.onap.policy.controlloop.actorserviceprovider.Operator;
  62 import org.onap.policy.controlloop.policy.Policy;
  63
  64 public class CdsActorTest extends BasicActor {
  65
  66     private static final String CDS_BLUEPRINT_NAME = "vfw-cds";
  67     private static final String CDS_BLUEPRINT_VERSION = "1.0.0";
  68     private static final UUID REQUEST_ID = UUID.randomUUID();
  69     private static final String SUBREQUEST_ID = "123456";
  70     private static final String CDS_RECIPE = "test-cds-recipe";
  71
  72     @Mock
  73     private CdsProcessorGrpcClient cdsClient;
  74     private CdsActor cdsActor;
  75     private Policy policy;
  76     private CdsServerProperties cdsProps;
  77     private Map<String, String> aaiParams;
  78     private VirtualControlLoopEvent onset;
  79     private ControlLoopOperation operation;
  80
  81     /**
  82      * Test setup.
  83      */
  84     @Before
  85     public void setup() {
  86         MockitoAnnotations.initMocks(this);
  87
  88         // Setup policy
  89         policy = new Policy();
  90         Map<String, String> payloadMap = new HashMap<String, String>() {
  91             private static final long serialVersionUID = 1L;
  92
  93             {
  94                 put(CdsActorConstants.KEY_CBA_NAME, CDS_BLUEPRINT_NAME);
  95                 put(CdsActorConstants.KEY_CBA_VERSION, CDS_BLUEPRINT_VERSION);
  96                 put("data", "{\"mapInfo\":{\"key\":\"val\"},\"arrayInfo\":[\"one\",\"two\"],\"paramInfo\":\"val\"}");
  97             }
  98         };
  99         policy.setPayload(payloadMap);
 100         policy.setRecipe(CDS_RECIPE);
 101
 102         // Setup the CDS properties
 103         cdsProps = new CdsServerProperties();
 104         cdsProps.setHost("10.10.10.10");
 105         cdsProps.setPort(2000);
 106         cdsProps.setUsername("testUser");
 107         cdsProps.setPassword("testPassword");
 108         cdsProps.setTimeout(1);
 109
 110         // Setup aaiParams
 111         aaiParams = ImmutableMap.of("service-instance-id", "1234", "generic-vnf-id", "5678");
 112
 113         // Setup cdsClient
 114         when(cdsClient.sendRequest(any(ExecutionServiceInput.class))).thenReturn(mock(CountDownLatch.class));
 115
 116         // Setup the cdsActor
 117         cdsActor = new CdsActor();
 118
 119         // Setup onset event
 120         onset = new VirtualControlLoopEvent();
 121         onset.setRequestId(REQUEST_ID);
 122
 123         // Setup controlloop operation object
 124         operation = new ControlLoopOperation();
 125         operation.setSubRequestId(SUBREQUEST_ID);
 126     }
 127
 128     @Test
 129     public void testActor() {
 130         assertEquals(CdsActorConstants.CDS_ACTOR, cdsActor.actor());
 131     }
 132
 133     @Test
 134     public void testActorService() {
 135         // verify that it all plugs into the ActorService
 136         verifyActorService(CdsActorConstants.CDS_ACTOR, "service.yaml");
 137     }
 138
 139     @Test
 140     public void testGetOperator() {
 141         CdsActor sp = new CdsActor();
 142
 143         // should always return the same operator regardless of the name
 144         Operator oper = sp.getOperator("unknown");
 145         assertNotNull(oper);
 146         assertSame(oper, sp.getOperator("another"));
 147     }
 148
 149     @Test
 150     public void testConstructRequestWhenMissingCdsParamsInPolicyPayload() {
 151         policy.setPayload(new HashMap<>());
 152         Optional<ExecutionServiceInput> cdsRequestOpt = cdsActor.constructRequest(onset, operation, policy, aaiParams);
 153
 154         assertFalse(cdsRequestOpt.isPresent());
 155     }
 156
 157     @Test
 158     public void testConstructRequest() {
 159         Optional<ExecutionServiceInput> cdsRequestOpt = cdsActor.constructRequest(onset, operation, policy, aaiParams);
 160
 161         assertTrue(cdsRequestOpt.isPresent());
 162         final ExecutionServiceInput cdsRequest = cdsRequestOpt.get();
 163
 164         assertTrue(cdsRequest.hasCommonHeader());
 165         CommonHeader commonHeader = cdsRequest.getCommonHeader();
 166         assertEquals(commonHeader.getRequestId(), REQUEST_ID.toString());
 167         assertEquals(SUBREQUEST_ID, commonHeader.getSubRequestId());
 168
 169         assertTrue(cdsRequest.hasPayload());
 170         Struct cdsPayload = cdsRequest.getPayload();
 171         assertTrue(cdsPayload.containsFields(CDS_RECIPE + "-request"));
 172
 173         assertTrue(cdsRequest.hasActionIdentifiers());
 174         ActionIdentifiers actionIdentifiers = cdsRequest.getActionIdentifiers();
 175         assertEquals(CDS_RECIPE, actionIdentifiers.getActionName());
 176         assertEquals(CDS_BLUEPRINT_NAME, actionIdentifiers.getBlueprintName());
 177         assertEquals(CDS_BLUEPRINT_VERSION, actionIdentifiers.getBlueprintVersion());
 178     }
 179
 180     @Test
 181     public void testRecipePayloads() {
 182         assertEquals(0, cdsActor.recipePayloads("").size());
 183     }
 184
 185     @Test
 186     public void testRecipes() {
 187         assertEquals(0, cdsActor.recipes().size());
 188     }
 189
 190     @Test
 191     public void testRecipeTargets() {
 192         assertEquals(0, cdsActor.recipeTargets("").size());
 193     }
 194
 195     @Test
 196     public void testSendRequestToCdsSuccess() {
 197         sendRequestToCds();
 198         verify(cdsClient).sendRequest(any(ExecutionServiceInput.class));
 199     }
 200
 201     @Test
 202     public void testSendRequestToCdsLatchInterrupted() throws InterruptedException {
 203         // Reset cdsClient
 204         CountDownLatch countDownLatch = mock(CountDownLatch.class);
 205         doThrow(new InterruptedException("Test latch interrupted failure")).when(countDownLatch).await(anyLong(),
 206             any(TimeUnit.class));
 207         when(cdsClient.sendRequest(any(ExecutionServiceInput.class))).thenReturn(countDownLatch);
 208
 209         CdsActor.CdsActorServiceManager cdsActorSvcMgr = cdsActor.new CdsActorServiceManager();
 210         CdsResponse response =
 211             cdsActorSvcMgr.sendRequestToCds(cdsClient, cdsProps, ExecutionServiceInput.newBuilder().build());
 212         assertTrue(Thread.interrupted());
 213         assertNotNull(response);
 214         assertEquals(CdsActorConstants.INTERRUPTED, response.getStatus());
 215     }
 216
 217     @Test
 218     public void testSendRequestToCdsLatchTimedOut() {
 219         CdsActor.CdsActorServiceManager cdsActorSvcMgr = cdsActor.new CdsActorServiceManager();
 220         CdsResponse response =
 221             cdsActorSvcMgr.sendRequestToCds(cdsClient, cdsProps, ExecutionServiceInput.newBuilder().build());
 222         assertNotNull(response);
 223         assertEquals(CdsActorConstants.TIMED_OUT, response.getStatus());
 224     }
 225
 226     @Test
 227     public void testOnMessage() throws InterruptedException {
 228         ExecutionServiceOutput message = ExecutionServiceOutput.newBuilder()
 229             .setStatus(Status.newBuilder().setEventType(EventType.EVENT_COMPONENT_FAILURE).build()).build();
 230
 231         // Test "no timeout" scenarios
 232         CountDownLatch latch = mock(CountDownLatch.class);
 233         when(latch.await(anyLong(), any(TimeUnit.class))).thenReturn(true);
 234         when(cdsClient.sendRequest(any(ExecutionServiceInput.class))).thenReturn(latch);
 235
 236         CdsActorServiceManager cdsActorSvcMgr = sendRequestToCds();
 237
 238         // #1: Failure test
 239         cdsActorSvcMgr.onMessage(message);
 240         assertEquals(CdsActorConstants.FAILED, cdsActorSvcMgr.getCdsStatus());
 241
 242         // #2: Success test
 243         cdsActorSvcMgr = sendRequestToCds();
 244         message = ExecutionServiceOutput.newBuilder()
 245             .setStatus(Status.newBuilder().setEventType(EventType.EVENT_COMPONENT_EXECUTED).build()).build();
 246         cdsActorSvcMgr.onMessage(message);
 247         assertEquals(CdsActorConstants.SUCCESS, cdsActorSvcMgr.getCdsStatus());
 248
 249         // #3: Processing test
 250         cdsActorSvcMgr = sendRequestToCds();
 251         message = ExecutionServiceOutput.newBuilder()
 252             .setStatus(Status.newBuilder().setEventType(EventType.EVENT_COMPONENT_PROCESSING).build()).build();
 253         cdsActorSvcMgr.onMessage(message);
 254         assertEquals(CdsActorConstants.PROCESSING, cdsActorSvcMgr.getCdsStatus());
 255     }
 256
 257     private CdsActorServiceManager sendRequestToCds() {
 258         CdsActorServiceManager cdsActorSvcMgr = cdsActor.new CdsActorServiceManager();
 259         cdsActorSvcMgr.sendRequestToCds(cdsClient, cdsProps, ExecutionServiceInput.newBuilder().build());
 260         return cdsActorSvcMgr;
 261     }
 262 }