vid-app-common/src/test/java/org/onap/vid/mso/MsoOperationalEnvironmentTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 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.vid.mso;
  22
  23 import com.fasterxml.jackson.core.JsonProcessingException;
  24 import com.fasterxml.jackson.databind.ObjectMapper;
  25 import com.fasterxml.jackson.databind.SerializationFeature;
  26 import com.google.common.collect.ImmutableList;
  27 import com.google.common.collect.ImmutableListMultimap;
  28 import java.io.IOException;
  29 import java.net.URL;
  30 import java.util.HashMap;
  31 import java.util.LinkedList;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.stream.Collectors;
  35 import org.apache.commons.io.IOUtils;
  36 import org.apache.log4j.LogManager;
  37 import org.apache.log4j.Logger;
  38 import org.onap.vid.changeManagement.RequestDetailsWrapper;
  39 import org.onap.vid.controller.OperationalEnvironmentController;
  40 import org.onap.vid.controller.OperationalEnvironmentController.OperationalEnvironmentManifest;
  41 import org.onap.vid.mso.model.OperationalEnvironmentActivateInfo;
  42 import org.onap.vid.mso.model.OperationalEnvironmentDeactivateInfo;
  43 import org.onap.vid.mso.rest.OperationalEnvironment.OperationEnvironmentRequestDetails;
  44 import org.onap.vid.mso.rest.RequestDetails;
  45 import org.skyscreamer.jsonassert.JSONAssert;
  46 import org.skyscreamer.jsonassert.JSONCompareMode;
  47 import org.testng.annotations.DataProvider;
  48 import org.testng.annotations.Test;
  49
  50 public class MsoOperationalEnvironmentTest {
  51
  52     private MsoBusinessLogic msoBusinessLogic = new MsoBusinessLogicImpl(null, null);
  53     private static final Logger logger = LogManager.getLogger(MsoOperationalEnvironmentTest.class);
  54
  55     @Test(dataProvider = "getOperationalEnvironmentActivationPermutations")
  56     public void testJsonResultOfOperationalEnvironmentActivationRequestDetails(HashMap<String, String> permutation) throws IOException {
  57
  58         // Convert 'manifest' to model
  59         final OperationalEnvironmentManifest manifest = new ObjectMapper().readerFor(OperationalEnvironmentManifest.class).readValue(permutation.get("<manifest>"));
  60
  61         // build OperationalEnvironmentActivateInfo
  62         OperationalEnvironmentActivateInfo inputUnderTest = createOperationalEnvironmentActivateInfo("<instanceId>", permutation.get("<userId>"), manifest, permutation.get("<relatedInstanceId>"), permutation.get("<relatedInstanceName>"), permutation.get("<workloadContext>"));
  63
  64         // transform to RequestDetails, and serialize to json
  65         //   -> actually, the function "msoBusinessLogic.createOperationalEnvironmentActivationRequestDetails"
  66         //      is the code under test here
  67         final RequestDetailsWrapper<RequestDetails> operationalEnvironmentActivationRequestDetails = msoBusinessLogic.createOperationalEnvironmentActivationRequestDetails(inputUnderTest);
  68
  69         String expected = buildExpectation("payload_jsons/activateOperationalEnvironmentsPayloadToMso.json", permutation);
  70
  71         assertThatExpectationIsLikeObject(expected, operationalEnvironmentActivationRequestDetails);
  72     }
  73
  74     @DataProvider
  75     private Object[][] getOperationalEnvironmentActivationPermutations() {
  76         final String manifest = "" +
  77                 "{" +
  78                 "  \"serviceModelList\": [" +
  79                 "    {" +
  80                 "      \"serviceModelVersionId\": \"uuid2\"," +
  81                 "      \"recoveryAction\": \"retry\"" +
  82                 "    }" +
  83                 "  ]" +
  84                 "}";
  85
  86
  87         final ImmutableListMultimap<String, String> options = ImmutableListMultimap.<String, String>builder()
  88                 .putAll("<instanceId>", "instanceId")
  89                 .putAll("<userId>", "1", "0198adb8-87fd-46ef-94ae-258816629c8b")
  90                 .putAll("<relatedInstanceId>", "relatedInstanceId", "2744cf56-4f00-4e48-917b-c3bd3b1f8984")
  91                 .putAll("<relatedInstanceName>", "relatedInstanceName", "Brooklynn Puanani")
  92                 .putAll("<workloadContext>", "workloadContext", "VNF_E2E-extreme")
  93                 .putAll("<manifest>", manifest)
  94                 .build();
  95
  96         List<HashMap<String, String>> permutations = permuteOptions(options);
  97
  98         return permutations.stream().map(m -> new Object[] { m }).collect(Collectors.toList()).toArray(new Object[0][0]);
  99     }
 100
 101     @Test(dataProvider = "getOperationalEnvironmentCreationPermutations")
 102     public void testJsonResultOfOperationalEnvironmentCreationRequestDetails(HashMap<String, String> permutation) throws IOException {
 103
 104         // build OperationalEnvironmentCreateBody
 105         OperationalEnvironmentController.OperationalEnvironmentCreateBody inputUnderTest = createOperationalEnvironmentCreateBody(permutation.get("<instanceName>"), permutation.get("<ecompInstanceId>"), permutation.get("<ecompInstanceName>"), permutation.get("<operationalEnvType>"), permutation.get("<tenantContext>"), permutation.get("<workloadContext>"));
 106
 107         // transform to RequestDetails, and serialize to json
 108         //   -> actually, the function "msoBusinessLogic.createOperationalEnvironmentActivationRequestDetails"
 109         //      is the code under test here
 110         final RequestDetailsWrapper<OperationEnvironmentRequestDetails> operationalEnvironmentCreationRequestDetails = msoBusinessLogic.convertParametersToRequestDetails(inputUnderTest, permutation.get("<userId>"));
 111
 112         String expected = buildExpectation("payload_jsons/createOperationalEnvironmentsPayloadToMso.json", permutation);
 113
 114         assertThatExpectationIsLikeObject(expected, operationalEnvironmentCreationRequestDetails);
 115     }
 116
 117     @DataProvider
 118     private Object[][] getOperationalEnvironmentCreationPermutations() {
 119
 120         final ImmutableListMultimap<String, String> options = ImmutableListMultimap.<String, String>builder()
 121                 // instanceName, ecompInstanceId, ecompInstanceName, operationalEnvType, tenantContext, workloadContext
 122                 .putAll("<userId>", "1", "ceb60bba-7c18-49cd-a8f6-83ff2e1430b0", "Storm Landebert")
 123                 .putAll("<instanceName>", "instanceName", "Slavica Hadrien")
 124                 .putAll("<ecompInstanceId>", "ecompInstanceId", "58ec6753-957f-4124-8f92-c1c0bd2464a4")
 125                 .putAll("<ecompInstanceName>", "ecompInstanceName", "Bente Keelin")
 126                 .putAll("<operationalEnvType>", "operationalEnvType", "VNF")
 127                 .putAll("<tenantContext>", "tenantContext", "Production")
 128                 .putAll("<workloadContext>", "workloadContext", "E2E-extreme")
 129                 .build();
 130
 131         List<HashMap<String, String>> permutations = permuteOptions(options);
 132
 133         return permutations.stream().map(m -> new Object[] { m }).collect(Collectors.toList()).toArray(new Object[0][0]);
 134     }
 135
 136     @Test(dataProvider = "getOperationalEnvironmentDeactivationPermutations")
 137     public void testJsonResultOfOperationalEnvironmentDeactivationRequestDetails(HashMap<String, String> permutation) throws IOException {
 138
 139         OperationalEnvironmentDeactivateInfo inputUnderTest = createOperationalEnvironmentDeactivateInfo("operationalEnvId>", permutation.get("<userId>"));
 140
 141         final RequestDetailsWrapper<RequestDetails> operationalEnvironmentDeactivationRequestDetails = msoBusinessLogic.createOperationalEnvironmentDeactivationRequestDetails(inputUnderTest);
 142
 143         String expected = buildExpectation("payload_jsons/deactivateOperationalEnvironmentsPayloadToMso.json", permutation);
 144
 145         assertThatExpectationIsLikeObject(expected, operationalEnvironmentDeactivationRequestDetails);
 146     }
 147
 148     @DataProvider
 149     private Object[][] getOperationalEnvironmentDeactivationPermutations() {
 150
 151         final ImmutableListMultimap<String, String> options = ImmutableListMultimap.<String, String>builder()
 152                 .putAll("<userId>", "instanceName", "Slavica Hadrien")
 153                 .build();
 154
 155         List<HashMap<String, String>> permutations = permuteOptions(options);
 156
 157         return permutations.stream().map(m -> new Object[] { m }).collect(Collectors.toList()).toArray(new Object[0][0]);
 158     }
 159
 160     private List<HashMap<String, String>> permuteOptions(ImmutableListMultimap<String, String> options) {
 161         // try any value, where the other keys are on the default one (index zero)
 162         // result it's not the whole world of permutations, but rather a skim set, which its
 163         // size is as the number of unique values in "options"
 164
 165         HashMap<String, String> baseMutation = new HashMap<>();
 166         for (String key : options.keySet()) {
 167             baseMutation.put(key, options.get(key).get(0));
 168         }
 169
 170         List<HashMap<String, String>> res = new LinkedList<>();
 171         res.add(baseMutation);
 172
 173         for (String key : options.keySet()) {
 174             final ImmutableList<String> entry = options.get(key);
 175             for (String value : entry.subList(1, entry.size())) { // skip the first option at index zero
 176                 HashMap<String, String> mutation = new HashMap<>();
 177                 mutation.putAll(baseMutation);
 178                 mutation.put(key, value);
 179                 res.add(mutation);
 180             }
 181         }
 182         return res;
 183     }
 184
 185     public static void assertThatExpectationIsLikeObject(String expected, Object requestDetails) throws JsonProcessingException {
 186         final String requestDetailsAsString = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT).writeValueAsString(requestDetails);
 187
 188         // assert for exact match
 189         try {
 190             JSONAssert.assertEquals("built mso request is not ok", expected, requestDetailsAsString, JSONCompareMode.STRICT);
 191         } catch (AssertionError | Exception e) {
 192             logger.info("requestDetailsAsString: \n" + requestDetailsAsString);
 193             logger.info("expected: \n" + expected);
 194             throw e;
 195         }
 196     }
 197
 198     private String buildExpectation(String modelFileName, HashMap<String, String> permutation) throws IOException {
 199         // load expected result, and populate it with current input 'permutation' values
 200         final URL resource = this.getClass().getResource("/" + modelFileName);
 201         String expected = IOUtils.toString(resource, "UTF-8");
 202
 203         for (Map.Entry<String, String> stringStringEntry : permutation.entrySet()) {
 204             expected = expected.replaceAll(stringStringEntry.getKey(), stringStringEntry.getValue());
 205         }
 206         return expected;
 207     }
 208
 209     private OperationalEnvironmentActivateInfo createOperationalEnvironmentActivateInfo(String operationalEnvId, String userId, OperationalEnvironmentManifest manifest, String relatedInstanceId, String relatedInstanceName, String workloadContext) {
 210         OperationalEnvironmentController.OperationalEnvironmentActivateBody body = new OperationalEnvironmentController.OperationalEnvironmentActivateBody(relatedInstanceId, relatedInstanceName, workloadContext, manifest);
 211         return new OperationalEnvironmentActivateInfo(body, userId, operationalEnvId);
 212     }
 213
 214     private OperationalEnvironmentDeactivateInfo createOperationalEnvironmentDeactivateInfo(String operationalEnvId, String userId) {
 215         return new OperationalEnvironmentDeactivateInfo(userId, operationalEnvId);
 216     }
 217
 218     private OperationalEnvironmentController.OperationalEnvironmentCreateBody createOperationalEnvironmentCreateBody(String instanceName, String ecompInstanceId, String ecompInstanceName, String operationalEnvType, String tenantContext, String workloadContext) {
 219         return new OperationalEnvironmentController.OperationalEnvironmentCreateBody(instanceName, ecompInstanceId, ecompInstanceName, operationalEnvType, tenantContext, workloadContext);
 220     }
 221 }