gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.bpmn.infrastructure.process;
  22
  23 import com.google.protobuf.Struct;
  24 import org.camunda.bpm.engine.runtime.ProcessInstance;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers;
  28 import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader;
  29 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
  30 import org.onap.so.BaseBPMNTest;
  31 import org.onap.so.GrpcNettyServer;
  32 import org.onap.so.bpmn.infrastructure.pnf.delegate.ExecutionVariableNames;
  33 import org.onap.so.bpmn.mock.FileUtil;
  34 import org.onap.aaiclient.client.aai.AAIVersion;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.springframework.beans.factory.annotation.Autowired;
  38 import java.io.IOException;
  39 import java.util.HashMap;
  40 import java.util.List;
  41 import java.util.Map;
  42 import java.util.UUID;
  43 import static com.github.tomakehurst.wiremock.client.WireMock.okJson;
  44 import static com.github.tomakehurst.wiremock.client.WireMock.get;
  45 import static com.github.tomakehurst.wiremock.client.WireMock.put;
  46 import static com.github.tomakehurst.wiremock.client.WireMock.post;
  47 import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
  48 import static org.assertj.core.api.Assertions.fail;
  49 import static org.camunda.bpm.engine.test.assertions.bpmn.BpmnAwareTests.assertThat;
  50 import static org.junit.Assert.assertEquals;
  51 import static org.junit.Assert.assertThat;
  52 import static org.junit.Assert.assertTrue;
  53
  54 /**
  55  * Basic Integration test for GenericPnfSoftwareUpgrade.bpmn workflow.
  56  */
  57 public class GenericPnfSoftwareUpgradeTest extends BaseBPMNTest {
  58
  59     private final Logger logger = LoggerFactory.getLogger(getClass());
  60
  61     private static final long WORKFLOW_WAIT_TIME = 1000L;
  62
  63     private static final String TEST_PROCESSINSTANCE_KEY = "GenericPnfSoftwareUpgrade";
  64     private static final AAIVersion VERSION = AAIVersion.LATEST;
  65     private static final Map<String, Object> executionVariables = new HashMap();
  66     private static final String REQUEST_ID = "50ae41ad-049c-4fe2-9950-539f111120f5";
  67     private final String[] actionNames = new String[4];
  68     private String requestObject;
  69     private String responseObject;
  70
  71     @Autowired
  72     private GrpcNettyServer grpcNettyServer;
  73
  74     @Before
  75     public void setUp() throws IOException {
  76         actionNames[0] = "preCheck";
  77         actionNames[1] = "downloadNESw";
  78         actionNames[2] = "activateNESw";
  79         actionNames[3] = "postCheck";
  80
  81         executionVariables.clear();
  82
  83         requestObject = FileUtil.readResourceFile("request/" + getClass().getSimpleName() + ".json");
  84         responseObject = FileUtil.readResourceFile("response/" + getClass().getSimpleName() + ".json");
  85
  86         executionVariables.put("bpmnRequest", requestObject);
  87         executionVariables.put("requestId", REQUEST_ID);
  88
  89         /**
  90          * This variable indicates that the flow was invoked asynchronously. It's injected by {@link WorkflowProcessor}.
  91          */
  92         executionVariables.put("isAsyncProcess", "true");
  93         executionVariables.put(ExecutionVariableNames.PRC_CUSTOMIZATION_UUID, "38dc9a92-214c-11e7-93ae-92361f002680");
  94
  95         /**
  96          * Temporary solution to add pnfCorrelationId to context. this value is getting from the request to SO api
  97          * handler and then convert to CamudaInput
  98          */
  99         executionVariables.put(ExecutionVariableNames.PNF_CORRELATION_ID, "PNFDemo");
 100     }
 101
 102
 103     @Test
 104     public void workflow_validInput_expectedOutput() throws InterruptedException {
 105
 106         mockCatalogDb();
 107         mockRequestDb();
 108         mockAai();
 109
 110         final String msoRequestId = UUID.randomUUID().toString();
 111         executionVariables.put(ExecutionVariableNames.MSO_REQUEST_ID, msoRequestId);
 112
 113         final String testBusinessKey = UUID.randomUUID().toString();
 114         logger.info("Test the process instance: {} with business key: {}", TEST_PROCESSINSTANCE_KEY, testBusinessKey);
 115
 116         ProcessInstance pi =
 117                 runtimeService.startProcessInstanceByKey(TEST_PROCESSINSTANCE_KEY, testBusinessKey, executionVariables);
 118
 119         int waitCount = 10;
 120         while (!isProcessInstanceEnded() && waitCount >= 0) {
 121             Thread.sleep(WORKFLOW_WAIT_TIME);
 122             waitCount--;
 123         }
 124
 125         // Layout is to reflect the bpmn visual layout
 126         assertThat(pi).isStarted().hasPassedInOrder("softwareUpgrade_startEvent", "ServiceTask_042uz7n",
 127                 "ScriptTask_10klpg8", "ServiceTask_0slpahe", "ExclusiveGateway_0x6h0ni", "ServiceTask_0x5cje8",
 128                 "ExclusiveGateway_0v3l3wv", "ServiceTask_02lxf48", "ExclusiveGateway_0ch3fef", "ServiceTask_0y2uysu",
 129                 "ExclusiveGateway_1ny9b1z", "ScriptTask_1igtc83", "CallActivity_0o1mi8u", "softwareUpgrade_endEvent");
 130
 131         List<ExecutionServiceInput> detailedMessages = grpcNettyServer.getDetailedMessages();
 132         assertEquals(4, detailedMessages.size());
 133         int count = 0;
 134         try {
 135             for (ExecutionServiceInput eSI : detailedMessages) {
 136                 for (String action : actionNames) {
 137                     if (action.equals(eSI.getActionIdentifiers().getActionName())
 138                             && eSI.getCommonHeader().getRequestId().equals(msoRequestId)) {
 139                         checkWithActionName(eSI, action);
 140                         count++;
 141                     }
 142                 }
 143             }
 144         } catch (Exception e) {
 145             e.printStackTrace();
 146             fail("GenericPnfSoftwareUpgrade request exception", e);
 147         }
 148         assertTrue(count == actionNames.length);
 149         grpcNettyServer.resetList();
 150     }
 151
 152     private boolean isProcessInstanceEnded() {
 153         return runtimeService.createProcessInstanceQuery().processDefinitionKey(TEST_PROCESSINSTANCE_KEY)
 154                 .singleResult() == null;
 155     }
 156
 157     private void checkWithActionName(ExecutionServiceInput executionServiceInput, String action) {
 158
 159         logger.info("Checking the " + action + " request");
 160         ActionIdentifiers actionIdentifiers = executionServiceInput.getActionIdentifiers();
 161
 162         /**
 163          * the fields of actionIdentifiers should match the one in the
 164          * response/GenericPnfSoftwareUpgrade_catalogdb.json.
 165          */
 166         assertEquals("test_pnf_software_upgrade_restconf", actionIdentifiers.getBlueprintName());
 167         assertEquals("1.0.0", actionIdentifiers.getBlueprintVersion());
 168         assertEquals(action, actionIdentifiers.getActionName());
 169         assertEquals("async", actionIdentifiers.getMode());
 170
 171         CommonHeader commonHeader = executionServiceInput.getCommonHeader();
 172         assertEquals("SO", commonHeader.getOriginatorId());
 173
 174         Struct payload = executionServiceInput.getPayload();
 175         Struct requeststruct = payload.getFieldsOrThrow(action + "-request").getStructValue();
 176
 177         assertEquals("PNFDemo", requeststruct.getFieldsOrThrow("resolution-key").getStringValue());
 178         Struct propertiesStruct = requeststruct.getFieldsOrThrow(action + "-properties").getStructValue();
 179
 180         assertEquals("PNFDemo", propertiesStruct.getFieldsOrThrow("pnf-name").getStringValue());
 181         assertEquals("32daaac6-5017-4e1e-96c8-6a27dfbe1421",
 182                 propertiesStruct.getFieldsOrThrow("service-model-uuid").getStringValue());
 183         assertEquals("38dc9a92-214c-11e7-93ae-92361f002680",
 184                 propertiesStruct.getFieldsOrThrow("pnf-customization-uuid").getStringValue());
 185         assertEquals("demo-sw-ver2.0.0", propertiesStruct.getFieldsOrThrow("target-software-version").getStringValue());
 186     }
 187
 188     private void mockAai() {
 189
 190         String aaiPnfEntry =
 191                 "{  \n" + "   \"pnf-name\":\"PNFDemo\",\n" + "   \"pnf-id\":\"testtest\",\n" + "   \"in-maint\":true,\n"
 192                         + "   \"resource-version\":\"1541720264047\",\n" + "   \"swVersion\":\"demo-1.1\",\n"
 193                         + "   \"ipaddress-v4-oam\":\"1.1.1.1\",\n" + "   \"ipaddress-v6-oam\":\"::/128\"\n" + "}";
 194
 195         /**
 196          * PUT the PNF correlation ID to AAI.
 197          */
 198         wireMockServer.stubFor(put(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")));
 199
 200         /**
 201          * Get the PNF entry from AAI.
 202          */
 203         wireMockServer.stubFor(
 204                 get(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")).willReturn(okJson(aaiPnfEntry)));
 205
 206         /*
 207          * Post the pnf to AAI
 208          */
 209         wireMockServer.stubFor(post(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")));
 210     }
 211
 212     private void mockRequestDb() {
 213         /**
 214          * Update Request DB
 215          */
 216         wireMockServer.stubFor(put(urlEqualTo("/infraActiveRequests/" + REQUEST_ID)));
 217
 218     }
 219
 220     /**
 221      * Mock the catalobdb rest interface.
 222      */
 223     private void mockCatalogDb() {
 224
 225         String catalogdbClientResponse =
 226                 FileUtil.readResourceFile("response/" + getClass().getSimpleName() + "_catalogdb.json");
 227
 228
 229         /**
 230          * Return valid json for the model UUID in the request file.
 231          */
 232         wireMockServer
 233                 .stubFor(get(urlEqualTo("/v2/serviceResources?serviceModelUuid=32daaac6-5017-4e1e-96c8-6a27dfbe1421"))
 234                         .willReturn(okJson(responseObject)));
 235
 236         /**
 237          * Return valid json for the service model InvariantUUID as specified in the request file.
 238          */
 239         wireMockServer.stubFor(
 240                 get(urlEqualTo("/v2/serviceResources?serviceModelInvariantUuid=339b7a2f-9524-4dbf-9eee-f2e05521df3f"))
 241                         .willReturn(okJson(responseObject)));
 242
 243         /**
 244          * Return valid spring data rest json for the service model UUID as specified in the request file.
 245          */
 246         wireMockServer.stubFor(get(urlEqualTo(
 247                 "/pnfResourceCustomization/search/findPnfResourceCustomizationByModelUuid?SERVICE_MODEL_UUID=32daaac6-5017-4e1e-96c8-6a27dfbe1421"))
 248                         .willReturn(okJson(catalogdbClientResponse)));
 249     }
 250
 251 }