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         grpcNettyServer.resetList();
 111
 112         final String msoRequestId = UUID.randomUUID().toString();
 113         executionVariables.put(ExecutionVariableNames.MSO_REQUEST_ID, msoRequestId);
 114
 115         final String testBusinessKey = UUID.randomUUID().toString();
 116         logger.info("Test the process instance: {} with business key: {}", TEST_PROCESSINSTANCE_KEY, testBusinessKey);
 117
 118         ProcessInstance pi =
 119                 runtimeService.startProcessInstanceByKey(TEST_PROCESSINSTANCE_KEY, testBusinessKey, executionVariables);
 120
 121         int waitCount = 10;
 122         while (!isProcessInstanceEnded() && waitCount >= 0) {
 123             Thread.sleep(WORKFLOW_WAIT_TIME);
 124             waitCount--;
 125         }
 126
 127         // Layout is to reflect the bpmn visual layout
 128         assertThat(pi).isStarted().hasPassedInOrder("softwareUpgrade_startEvent", "ServiceTask_042uz7n",
 129                 "ScriptTask_10klpg8", "ServiceTask_0slpahe", "ExclusiveGateway_0x6h0ni", "ServiceTask_0x5cje8",
 130                 "ExclusiveGateway_0v3l3wv", "ServiceTask_02lxf48", "ExclusiveGateway_0ch3fef", "ServiceTask_0y2uysu",
 131                 "ExclusiveGateway_1ny9b1z", "ScriptTask_1igtc83", "CallActivity_0o1mi8u", "softwareUpgrade_endEvent");
 132
 133         List<ExecutionServiceInput> detailedMessages = grpcNettyServer.getDetailedMessages();
 134         assertEquals(4, detailedMessages.size());
 135         int count = 0;
 136         try {
 137             for (ExecutionServiceInput eSI : detailedMessages) {
 138                 for (String action : actionNames) {
 139                     if (action.equals(eSI.getActionIdentifiers().getActionName())
 140                             && eSI.getCommonHeader().getRequestId().equals(msoRequestId)) {
 141                         checkWithActionName(eSI, action);
 142                         count++;
 143                     }
 144                 }
 145             }
 146         } catch (Exception e) {
 147             e.printStackTrace();
 148             fail("GenericPnfSoftwareUpgrade request exception", e);
 149         }
 150         assertTrue(count == actionNames.length);
 151     }
 152
 153     private boolean isProcessInstanceEnded() {
 154         return runtimeService.createProcessInstanceQuery().processDefinitionKey(TEST_PROCESSINSTANCE_KEY)
 155                 .singleResult() == null;
 156     }
 157
 158     private void checkWithActionName(ExecutionServiceInput executionServiceInput, String action) {
 159
 160         logger.info("Checking the " + action + " request");
 161         ActionIdentifiers actionIdentifiers = executionServiceInput.getActionIdentifiers();
 162
 163         /**
 164          * the fields of actionIdentifiers should match the one in the
 165          * response/GenericPnfSoftwareUpgrade_catalogdb.json.
 166          */
 167         assertEquals("test_pnf_software_upgrade_restconf", actionIdentifiers.getBlueprintName());
 168         assertEquals("1.0.0", actionIdentifiers.getBlueprintVersion());
 169         assertEquals(action, actionIdentifiers.getActionName());
 170         assertEquals("async", actionIdentifiers.getMode());
 171
 172         CommonHeader commonHeader = executionServiceInput.getCommonHeader();
 173         assertEquals("SO", commonHeader.getOriginatorId());
 174
 175         Struct payload = executionServiceInput.getPayload();
 176         Struct requeststruct = payload.getFieldsOrThrow(action + "-request").getStructValue();
 177
 178         assertEquals("PNFDemo", requeststruct.getFieldsOrThrow("resolution-key").getStringValue());
 179         Struct propertiesStruct = requeststruct.getFieldsOrThrow(action + "-properties").getStructValue();
 180
 181         assertEquals("PNFDemo", propertiesStruct.getFieldsOrThrow("pnf-name").getStringValue());
 182         assertEquals("32daaac6-5017-4e1e-96c8-6a27dfbe1421",
 183                 propertiesStruct.getFieldsOrThrow("service-model-uuid").getStringValue());
 184         assertEquals("38dc9a92-214c-11e7-93ae-92361f002680",
 185                 propertiesStruct.getFieldsOrThrow("pnf-customization-uuid").getStringValue());
 186         assertEquals("demo-sw-ver2.0.0", propertiesStruct.getFieldsOrThrow("target-software-version").getStringValue());
 187     }
 188
 189     private void mockAai() {
 190
 191         String aaiPnfEntry =
 192                 "{  \n" + "   \"pnf-name\":\"PNFDemo\",\n" + "   \"pnf-id\":\"testtest\",\n" + "   \"in-maint\":true,\n"
 193                         + "   \"resource-version\":\"1541720264047\",\n" + "   \"swVersion\":\"demo-1.1\",\n"
 194                         + "   \"ipaddress-v4-oam\":\"1.1.1.1\",\n" + "   \"ipaddress-v6-oam\":\"::/128\"\n" + "}";
 195
 196         /**
 197          * PUT the PNF correlation ID to AAI.
 198          */
 199         wireMockServer.stubFor(put(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")));
 200
 201         /**
 202          * Get the PNF entry from AAI.
 203          */
 204         wireMockServer.stubFor(
 205                 get(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")).willReturn(okJson(aaiPnfEntry)));
 206
 207         /*
 208          * Post the pnf to AAI
 209          */
 210         wireMockServer.stubFor(post(urlEqualTo("/aai/" + VERSION + "/network/pnfs/pnf/PNFDemo")));
 211     }
 212
 213     private void mockRequestDb() {
 214         /**
 215          * Update Request DB
 216          */
 217         wireMockServer.stubFor(put(urlEqualTo("/infraActiveRequests/" + REQUEST_ID)));
 218
 219     }
 220
 221     /**
 222      * Mock the catalobdb rest interface.
 223      */
 224     private void mockCatalogDb() {
 225
 226         String catalogdbClientResponse =
 227                 FileUtil.readResourceFile("response/" + getClass().getSimpleName() + "_catalogdb.json");
 228
 229
 230         /**
 231          * Return valid json for the model UUID in the request file.
 232          */
 233         wireMockServer
 234                 .stubFor(get(urlEqualTo("/v2/serviceResources?serviceModelUuid=32daaac6-5017-4e1e-96c8-6a27dfbe1421"))
 235                         .willReturn(okJson(responseObject)));
 236
 237         /**
 238          * Return valid json for the service model InvariantUUID as specified in the request file.
 239          */
 240         wireMockServer.stubFor(
 241                 get(urlEqualTo("/v2/serviceResources?serviceModelInvariantUuid=339b7a2f-9524-4dbf-9eee-f2e05521df3f"))
 242                         .willReturn(okJson(responseObject)));
 243
 244         /**
 245          * Return valid spring data rest json for the service model UUID as specified in the request file.
 246          */
 247         wireMockServer.stubFor(get(urlEqualTo(
 248                 "/pnfResourceCustomization/search/findPnfResourceCustomizationByModelUuid?SERVICE_MODEL_UUID=32daaac6-5017-4e1e-96c8-6a27dfbe1421"))
 249                         .willReturn(okJson(catalogdbClientResponse)));
 250     }
 251
 252 }