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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * TestSOActorServiceProvider
   4  * ================================================================================
   5  * Copyright (C) 2018 Ericsson. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (C) 2018-2019 AT&T. All rights reserved.
   8  * Modifications Copyright (C) 2019 Nordix Foundation.
   9  * ================================================================================
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  *      http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.controlloop.actor.so;
  25
  26 import static org.junit.Assert.assertEquals;
  27 import static org.junit.Assert.assertNotNull;
  28 import static org.junit.Assert.assertNull;
  29 import static org.junit.Assert.fail;
  30
  31 import java.io.IOException;
  32 import java.nio.charset.StandardCharsets;
  33 import java.util.LinkedList;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.TreeMap;
  37 import java.util.UUID;
  38 import org.apache.commons.io.IOUtils;
  39 import org.eclipse.persistence.exceptions.JAXBException;
  40 import org.junit.Test;
  41 import org.onap.policy.aai.AaiCqResponse;
  42 import org.onap.policy.aai.AaiNqResponse;
  43 import org.onap.policy.aai.AaiNqResponseWrapper;
  44 import org.onap.policy.controlloop.ControlLoopOperation;
  45 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  46 import org.onap.policy.controlloop.policy.Policy;
  47 import org.onap.policy.controlloop.policy.Target;
  48 import org.onap.policy.so.SoOperationType;
  49 import org.onap.policy.so.SoRequest;
  50 import org.onap.policy.so.SoRequestParameters;
  51 import org.onap.policy.so.util.Serialization;
  52
  53 public class SoActorServiceProviderTest {
  54
  55     private static final String VF_MODULE_CREATE = "VF Module Create";
  56     private static final String VF_MODULE_DELETE = "VF Module Delete";
  57
  58     @Test
  59     public void testConstructRequest() throws Exception {
  60         VirtualControlLoopEvent onset = new VirtualControlLoopEvent();
  61         final ControlLoopOperation operation = new ControlLoopOperation();
  62         final AaiNqResponseWrapper aaiNqResp = loadAaiResponse(onset, "aai/AaiNqResponse-Full.json");
  63
  64         final UUID requestId = UUID.randomUUID();
  65         onset.setRequestId(requestId);
  66
  67         Policy policy = new Policy();
  68         policy.setActor("Dorothy");
  69         policy.setRecipe("GoToOz");
  70
  71         instantiateTarget(policy);
  72
  73         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp));
  74
  75         policy.setActor("SO");
  76         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp));
  77
  78         policy.setRecipe(VF_MODULE_CREATE);
  79
  80         // empty policy payload
  81         SoRequest request = new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp);
  82         assertNotNull(request);
  83
  84         assertEquals("my_module_3", request.getRequestDetails().getRequestInfo().getInstanceName());
  85         assertEquals("policy", request.getRequestDetails().getRequestInfo().getRequestorId());
  86         assertEquals("RegionOne", request.getRequestDetails().getCloudConfiguration().getLcpCloudRegionId());
  87
  88         // non-empty policy payload
  89         policy.setPayload(makePayload());
  90         request = new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp);
  91         assertNotNull(request);
  92         assertEquals(true, request.getRequestDetails().getRequestParameters().isUsePreload());
  93         assertEquals("avalue", request.getRequestDetails().getRequestParameters().getUserParams().get(0).get("akey"));
  94         assertEquals(1, request.getRequestDetails().getConfigurationParameters().size());
  95         assertEquals("cvalue", request.getRequestDetails().getConfigurationParameters().get(0).get("ckey"));
  96
  97         // payload with config, but no request params
  98         policy.setPayload(makePayload());
  99         policy.getPayload().remove(SoActorServiceProvider.REQ_PARAM_NM);
 100         request = new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp);
 101         assertNotNull(request);
 102         assertNull(request.getRequestDetails().getRequestParameters());
 103         assertNotNull(request.getRequestDetails().getConfigurationParameters());
 104
 105         // payload with request, but no config params
 106         policy.setPayload(makePayload());
 107         policy.getPayload().remove(SoActorServiceProvider.CONFIG_PARAM_NM);
 108         request = new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp);
 109         assertNotNull(request);
 110         assertNotNull(request.getRequestDetails().getRequestParameters());
 111         assertNull(request.getRequestDetails().getConfigurationParameters());
 112
 113         // null response
 114         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, null));
 115
 116         // response has no base VF module
 117         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy,
 118                 loadAaiResponse(onset, "aai/AaiNqResponse-NoBase.json")));
 119
 120         policy.setTarget(null);
 121
 122         // response has no non-base VF modules (other than the "dummy")
 123         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy,
 124                 loadAaiResponse(onset, "aai/AaiNqResponse-NoNonBase.json")));
 125
 126         instantiateTarget(policy);
 127         policy.setRecipe(VF_MODULE_DELETE);
 128         SoRequest deleteRequest = new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp);
 129         assertNotNull(deleteRequest);
 130         assertEquals(SoOperationType.DELETE_VF_MODULE, deleteRequest.getOperationType());
 131
 132         /*
 133          * NOTE: The remaining tests must be done in order
 134          */
 135
 136         policy.setRecipe(VF_MODULE_CREATE);
 137
 138         // null tenant
 139         aaiNqResp.getAaiNqResponse().getInventoryResponseItems().get(0).getItems().getInventoryResponseItems()
 140                 .remove(1);
 141         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp));
 142
 143         // null service item
 144         aaiNqResp.getAaiNqResponse().getInventoryResponseItems().get(0).getItems().getInventoryResponseItems().get(0)
 145                 .setItems(null);
 146         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp));
 147
 148         // null response
 149         aaiNqResp.setAaiNqResponse(null);
 150         assertNull(new SoActorServiceProvider().constructRequest(onset, operation, policy, aaiNqResp));
 151     }
 152
 153     private void instantiateTarget(Policy policy) {
 154
 155         Target target = new Target();
 156         target.setModelCustomizationId("3e2d67ad-3495-4732-82f6-b0b872791fff");
 157         target.setModelInvariantId("90b793b5-b8ae-4c36-b10b-4b6372859d3a");
 158         target.setModelName("SproutScalingVf..scaling_sprout..module-1");
 159         target.setModelVersion("1");
 160         target.setModelVersionId("2210154d-e61a-4d7f-8fb9-0face1aee3f8");
 161
 162         policy.setTarget(target);
 163     }
 164
 165     @Test
 166     public void testSendRequest() {
 167         try {
 168             SoActorServiceProvider.sendRequest(UUID.randomUUID().toString(), null, null, null, null, null);
 169         } catch (Exception e) {
 170             fail("Test should not throw an exception");
 171         }
 172     }
 173
 174     @Test
 175     public void testMethods() {
 176         SoActorServiceProvider sp = new SoActorServiceProvider();
 177
 178         assertEquals("SO", sp.actor());
 179         assertEquals(2, sp.recipes().size());
 180         assertEquals(VF_MODULE_CREATE, sp.recipes().get(0));
 181         assertEquals(VF_MODULE_DELETE, sp.recipes().get(1));
 182         assertEquals(0, sp.recipePayloads(VF_MODULE_CREATE).size());
 183         assertEquals(0, sp.recipeTargets("unknown recipe").size());
 184         assertEquals(1, sp.recipeTargets(VF_MODULE_CREATE).size());
 185     }
 186
 187     @Test
 188     public void testConstructRequestCq() throws Exception {
 189         VirtualControlLoopEvent onset = new VirtualControlLoopEvent();
 190         final ControlLoopOperation operation = new ControlLoopOperation();
 191         final AaiCqResponse aaiCqResp = loadAaiResponseCq("aai/AaiCqResponse.json");
 192         final AaiCqResponse aaiCqRespMissing = loadAaiResponseCq("aai/AaiCqResponseMissing.json");
 193         final UUID requestId = UUID.randomUUID();
 194         onset.setRequestId(requestId);
 195
 196         Policy policy = new Policy();
 197         policy.setActor("Dorothy");
 198         policy.setRecipe("GoToOz");
 199
 200         instantiateTarget(policy);
 201
 202         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp));
 203
 204         policy.setActor("SO");
 205         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp));
 206
 207         policy.setRecipe(VF_MODULE_CREATE);
 208
 209         // empty policy payload
 210         SoRequest request = new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp);
 211         assertNotNull(request);
 212
 213         assertEquals("TestVM-0201-2", request.getRequestDetails().getRequestInfo().getInstanceName());
 214         assertEquals("policy", request.getRequestDetails().getRequestInfo().getRequestorId());
 215         assertEquals("cr-16197-01-as988q", request.getRequestDetails().getCloudConfiguration().getLcpCloudRegionId());
 216
 217         // non-empty policy payload
 218         policy.setPayload(makePayload());
 219         request = new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp);
 220         assertNotNull(request);
 221         assertEquals(true, request.getRequestDetails().getRequestParameters().isUsePreload());
 222         assertEquals("avalue", request.getRequestDetails().getRequestParameters().getUserParams().get(0).get("akey"));
 223         assertEquals(1, request.getRequestDetails().getConfigurationParameters().size());
 224         assertEquals("cvalue", request.getRequestDetails().getConfigurationParameters().get(0).get("ckey"));
 225
 226         // payload with config, but no request params
 227         policy.setPayload(makePayload());
 228         policy.getPayload().remove(SoActorServiceProvider.REQ_PARAM_NM);
 229         request = new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp);
 230         assertNotNull(request);
 231         assertNull(request.getRequestDetails().getRequestParameters());
 232         assertNotNull(request.getRequestDetails().getConfigurationParameters());
 233
 234         // payload with request, but no config params
 235         policy.setPayload(makePayload());
 236         policy.getPayload().remove(SoActorServiceProvider.CONFIG_PARAM_NM);
 237         request = new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp);
 238         assertNotNull(request);
 239         assertNotNull(request.getRequestDetails().getRequestParameters());
 240         assertNull(request.getRequestDetails().getConfigurationParameters());
 241
 242         // null response
 243         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, null));
 244
 245
 246         policy.setTarget(null);
 247
 248         // response has no non-base VF modules (other than the "dummy")
 249         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy,
 250                 loadAaiResponseCq("aai/AaiCqResponse.json")));
 251
 252         instantiateTarget(policy);
 253         policy.setRecipe(VF_MODULE_DELETE);
 254         SoRequest deleteRequest = new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqResp);
 255         assertNotNull(deleteRequest);
 256         assertEquals(SoOperationType.DELETE_VF_MODULE, deleteRequest.getOperationType());
 257
 258         /*
 259          * NOTE: The remaining tests must be done in order
 260          */
 261
 262         policy.setRecipe(VF_MODULE_CREATE);
 263
 264         // null tenant
 265         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqRespMissing));
 266
 267         // null service item
 268         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, aaiCqRespMissing));
 269
 270         assertNull(new SoActorServiceProvider().constructRequestCq(onset, operation, policy, null));
 271     }
 272
 273     /**
 274      * Reads an AAI vserver named-query response from a file.
 275      *
 276      * @param fileName name of the file containing the JSON response
 277      * @return output from the AAI vserver named-query
 278      * @throws IOException if the file cannot be read
 279      * @throws JAXBException throws JAXBException
 280      */
 281     private AaiCqResponse loadAaiResponseCq(String fileName) throws IOException, JAXBException {
 282         String resp = IOUtils.toString(getClass().getResource(fileName), StandardCharsets.UTF_8);
 283         return new AaiCqResponse(resp);
 284     }
 285
 286
 287
 288     /**
 289      * Creates a policy payload containing request & configuration parameters.
 290      *
 291      * @return the payload
 292      */
 293     private Map<String, String> makePayload() {
 294         Map<String, String> payload = new TreeMap<>();
 295
 296         payload.put(SoActorServiceProvider.REQ_PARAM_NM, makeReqParams());
 297         payload.put(SoActorServiceProvider.CONFIG_PARAM_NM, makeConfigParams());
 298
 299         return payload;
 300     }
 301
 302     /**
 303      * Creates request parameters.
 304      *
 305      * @return request parameters, encoded as JSON
 306      */
 307     private String makeReqParams() {
 308         SoRequestParameters params = new SoRequestParameters();
 309
 310         params.setUsePreload(true);
 311
 312         Map<String, String> map = new TreeMap<>();
 313         map.put("akey", "avalue");
 314
 315         List<Map<String, String>> lst = new LinkedList<>();
 316         lst.add(map);
 317
 318         params.setUserParams(lst);
 319
 320         return Serialization.gsonPretty.toJson(params);
 321     }
 322
 323     /**
 324      * Creates configuration parameters.
 325      *
 326      * @return configuration parameters, encoded as JSON
 327      */
 328     private String makeConfigParams() {
 329         Map<String, String> map = new TreeMap<>();
 330         map.put("ckey", "cvalue");
 331
 332         List<Map<String, String>> lst = new LinkedList<>();
 333         lst.add(map);
 334
 335         return Serialization.gsonPretty.toJson(lst);
 336     }
 337
 338     /**
 339      * Reads an AAI vserver named-query response from a file.
 340      *
 341      * @param onset the ONSET event
 342      * @param fileName name of the file containing the JSON response
 343      * @return output from the AAI vserver named-query
 344      * @throws IOException if the file cannot be read
 345      */
 346     private AaiNqResponseWrapper loadAaiResponse(VirtualControlLoopEvent onset, String fileName) throws IOException {
 347         String resp = IOUtils.toString(getClass().getResource(fileName), StandardCharsets.UTF_8);
 348         AaiNqResponse aaiNqResponse = Serialization.gsonPretty.fromJson(resp, AaiNqResponse.class);
 349
 350         return new AaiNqResponseWrapper(onset.getRequestId(), aaiNqResponse);
 351     }
 352 }