[SO] Pending Create changes for SO-API and BPMN-INFRA to support CNF's through ASD

Issue-ID: SO-4069
Signed-off-by: raviteja.karumuri <raviteja.karumuri@est.tech>
Change-Id: I91e6d2dfc3ce84f7fe496b9b87c2a4ac6f521673

5 files changed, 223 insertions, 15 deletions

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfInstantiateTask.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfInstantiateTask.java
index ab20a08e74..105cca28c8 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfInstantiateTask.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfInstantiateTask.java
@@ -26,6 +26,10 @@ import static org.onap.so.cnfm.lcm.model.utils.AdditionalParamsConstants.CLOUD_R
 import static org.onap.so.cnfm.lcm.model.utils.AdditionalParamsConstants.SERVICE_INSTANCE_ID_PARAM_KEY;
 import static org.onap.so.cnfm.lcm.model.utils.AdditionalParamsConstants.SERVICE_INSTANCE_NAME_PARAM_KEY;
 import static org.onap.so.cnfm.lcm.model.utils.AdditionalParamsConstants.TENANT_ID_PARAM_KEY;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import org.apache.groovy.util.Maps;
 import org.onap.logging.filter.base.ONAPComponents;
@@ -37,6 +41,7 @@ import org.onap.so.client.exception.ExceptionBuilder;
 import org.onap.so.cnfm.lcm.model.AsInstance;
 import org.onap.so.cnfm.lcm.model.CreateAsRequest;
 import org.onap.so.cnfm.lcm.model.InstantiateAsRequest;
+import org.onap.so.cnfm.lcm.model.AsInfoModificationRequestDeploymentItems;
 import org.onap.so.serviceinstancebeans.CloudConfiguration;
 import org.onap.so.serviceinstancebeans.ModelInfo;
 import org.onap.so.serviceinstancebeans.RequestDetails;
@@ -57,6 +62,7 @@ import org.springframework.stereotype.Component;
 public class CnfInstantiateTask {
     private static final String CREATE_AS_REQUEST_OBJECT = "CreateAsRequestObject";
     private static final String INSTANTIATE_AS_REQUEST_OBJECT = "InstantiateAsRequest";
+    private static final String CNFM_REQUEST_STATUS_CHECK_URL = "CnfmStatusCheckUrl";
     private static final String AS_INSTANCE_ID = "asInstanceid";
     private static final Logger LOGGER = LoggerFactory.getLogger(CnfInstantiateTask.class);
     private final ExceptionBuilder exceptionUtil;
@@ -80,9 +86,9 @@ public class CnfInstantiateTask {
             final RequestDetails requestDetails = executeBuildingBlock.getRequestDetails();
             LOGGER.debug("RequestDetails: {}", requestDetails);
 
-            if (isNull(requestDetails) && isNull(requestDetails.getModelInfo())
-                    && isNull(requestDetails.getRequestInfo()) && isNull(requestDetails.getCloudConfiguration())
-                    && isNull(generalBuildingBlock)) {
+            if (isNull(requestDetails) || isNull(requestDetails.getModelInfo())
+                    || isNull(requestDetails.getRequestInfo())
+                    || isNull(requestDetails.getCloudConfiguration()) && isNull(generalBuildingBlock)) {
                 LOGGER.error("Missing Mandatory attribute from RequestDetails: {} or GeneralBuildingBlock: {}",
                         requestDetails, generalBuildingBlock);
                 exceptionUtil.buildAndThrowWorkflowException(execution, 2000,
@@ -137,9 +143,31 @@ public class CnfInstantiateTask {
     public void createAsInstanceRequest(final BuildingBlockExecution execution) {
         try {
             LOGGER.debug("Executing createAsInstanceRequest task  ...");
-
+            final ExecuteBuildingBlock executeBuildingBlock =
+                    (ExecuteBuildingBlock) execution.getVariable("buildingBlock");
+            final RequestDetails requestDetails = executeBuildingBlock.getRequestDetails();
             final InstantiateAsRequest instantiateAsRequest = new InstantiateAsRequest();
-
+            if (requestDetails != null && requestDetails.getRequestParameters() != null) {
+                List<Map<String, Object>> userParams = requestDetails.getRequestParameters().getUserParams();
+                if (userParams != null && !userParams.isEmpty()) {
+                    List deploymentItems = new ArrayList<Object>();
+                    List deploymentItemsReq = new ArrayList<AsInfoModificationRequestDeploymentItems>();
+                    for (Map<String, Object> userParam : userParams) {
+                        if (userParam.containsKey("deploymentItems")) {
+                            deploymentItems = (ArrayList<Object>) userParam.get("deploymentItems");
+                            break;
+                        }
+                    }
+                    for (Object deploymentItem : deploymentItems) {
+                        Map<String, Object> deploymentItemMap = (Map<String, Object>) deploymentItem;
+                        AsInfoModificationRequestDeploymentItems item = new AsInfoModificationRequestDeploymentItems();
+                        item.setDeploymentItemsId(deploymentItemMap.get("deploymentItemsId").toString());
+                        item.setLifecycleParameterKeyValues(deploymentItemMap.get("lifecycleParameterKeyValues"));
+                        deploymentItemsReq.add(item);
+                    }
+                    instantiateAsRequest.setDeploymentItems(deploymentItemsReq);
+                }
+            }
             LOGGER.debug("Adding InstantiateAsRequest to execution {}", instantiateAsRequest);
 
             execution.setVariable(INSTANTIATE_AS_REQUEST_OBJECT, instantiateAsRequest);
@@ -155,9 +183,10 @@ public class CnfInstantiateTask {
         try {
             final InstantiateAsRequest instantiateAsRequest = execution.getVariable(INSTANTIATE_AS_REQUEST_OBJECT);
             final String asInstanceId = execution.getVariable(AS_INSTANCE_ID);
-            cnfmHttpServiceProvider.invokeInstantiateAsRequest(instantiateAsRequest, asInstanceId);
+            Optional<URI> cnf_status_check_url =
+                    cnfmHttpServiceProvider.invokeInstantiateAsRequest(instantiateAsRequest, asInstanceId);
+            execution.setVariable(CNFM_REQUEST_STATUS_CHECK_URL, cnf_status_check_url.get());
             LOGGER.debug("Successfully invoked CNFM instantiate AS request: {}", asInstanceId);
-
         } catch (final Exception exception) {
             LOGGER.error("Unable to invoke CNFM InstantiateAsRequest", exception);
             exceptionUtil.buildAndThrowWorkflowException(execution, 2005, exception);
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProvider.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProvider.java
index 5e9112f3e0..cb6a96c152 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProvider.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProvider.java
@@ -19,8 +19,10 @@
  */
 package org.onap.so.bpmn.infrastructure.adapter.cnfm.tasks;
 
+import java.net.URI;
 import java.util.Optional;
 import org.onap.so.cnfm.lcm.model.AsInstance;
+import org.onap.so.cnfm.lcm.model.AsLcmOpOcc;
 import org.onap.so.cnfm.lcm.model.CreateAsRequest;
 import org.onap.so.cnfm.lcm.model.InstantiateAsRequest;
 
@@ -34,6 +36,7 @@ public interface CnfmHttpServiceProvider {
 
     Optional<AsInstance> invokeCreateAsRequest(final CreateAsRequest createAsRequest);
 
-    void invokeInstantiateAsRequest(InstantiateAsRequest instantiateAsRequest, String asInstanceId);
+    Optional<URI> invokeInstantiateAsRequest(InstantiateAsRequest instantiateAsRequest, String asInstanceId);
 
+    Optional<AsLcmOpOcc> getInstantiateOperationJobStatus(final String url);
 }
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProviderImpl.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProviderImpl.java
index 3f78896b5d..1035f4314e 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProviderImpl.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/CnfmHttpServiceProviderImpl.java
@@ -17,13 +17,15 @@
  * SPDX-License-Identifier: Apache-2.0
  * ============LICENSE_END=========================================================
  */
-
 package org.onap.so.bpmn.infrastructure.adapter.cnfm.tasks;
 
 import static org.onap.so.bpmn.infrastructure.adapter.cnfm.tasks.CnfmHttpServiceConfiguration.CNFM_HTTP_REST_SERVICE_PROVIDER_BEAN;
+import java.net.URI;
 import java.util.Optional;
 import org.onap.so.cnfm.lcm.model.AsInstance;
+import org.onap.so.cnfm.lcm.model.AsLcmOpOcc;
 import org.onap.so.cnfm.lcm.model.CreateAsRequest;
+import org.onap.so.cnfm.lcm.model.InstantiateAsRequest;
 import org.onap.so.rest.exceptions.HttpResouceNotFoundException;
 import org.onap.so.rest.exceptions.InvalidRestRequestException;
 import org.onap.so.rest.exceptions.RestProcessingException;
@@ -35,7 +37,6 @@ import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Service;
-import org.onap.so.cnfm.lcm.model.InstantiateAsRequest;
 
 @Service
 public class CnfmHttpServiceProviderImpl implements CnfmHttpServiceProvider {
@@ -83,24 +84,54 @@ public class CnfmHttpServiceProviderImpl implements CnfmHttpServiceProvider {
     }
 
     @Override
-    public void invokeInstantiateAsRequest(InstantiateAsRequest instantiateAsRequest, String asInstanceId) {
+    public Optional<URI> invokeInstantiateAsRequest(InstantiateAsRequest instantiateAsRequest, String asInstanceId) {
         try {
 
             final String url = cnfmUrlProvider.getInstantiateAsRequestUrl(asInstanceId);
             final ResponseEntity<AsInstance> response =
                     httpServiceProvider.postHttpRequest(instantiateAsRequest, url, AsInstance.class);
-
             final HttpStatus httpStatus = response.getStatusCode();
-            if (httpStatus.is2xxSuccessful() && !(response.hasBody())) {
-                LOGGER.error("Response received without body: {}", response);
+            if (httpStatus.is2xxSuccessful()) {
+                URI statusUri = response.getHeaders().getLocation();
+                if (statusUri == null) {
+                    LOGGER.error("Received response without status URL for instance ID: {}", asInstanceId);
+                    return Optional.empty();
+                }
+                return Optional.of(statusUri);
             }
             LOGGER.error("Unable to invoke HTTP POST using URL: {}, Response Code: {}", url, httpStatus.value());
+            return Optional.empty();
 
         } catch (final RestProcessingException | InvalidRestRequestException
                 | HttpResouceNotFoundException httpInvocationException) {
             LOGGER.error("Unexpected error while processing instantiation request", httpInvocationException);
+            return Optional.empty();
         }
 
     }
 
+    @Override
+    public Optional<AsLcmOpOcc> getInstantiateOperationJobStatus(final String url) {
+        try {
+            final ResponseEntity<AsLcmOpOcc> response = httpServiceProvider.getHttpResponse(url, AsLcmOpOcc.class);
+
+            final HttpStatus httpStatus = response.getStatusCode();
+
+            if (!(httpStatus.equals(HttpStatus.ACCEPTED)) && !(httpStatus.equals(HttpStatus.OK))) {
+                LOGGER.error("Unable to invoke HTTP GET using URL: {}, Response Code: ", url, httpStatus.value());
+                return Optional.empty();
+            }
+
+            if (!response.hasBody()) {
+                LOGGER.error("CNFM status response recieved without body: {}", response);
+                return Optional.empty();
+            }
+            return Optional.of(response.getBody());
+        } catch (final RestProcessingException | InvalidRestRequestException
+                | HttpResouceNotFoundException httpInvocationException) {
+            LOGGER.error("Unexpected error while processing job request", httpInvocationException);
+            throw httpInvocationException;
+        }
+    }
+
 }
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/MonitorCnfmCreateJobTask.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/MonitorCnfmCreateJobTask.java
new file mode 100644
index 0000000000..06b44e4512
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/cnfm/tasks/MonitorCnfmCreateJobTask.java
@@ -0,0 +1,144 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2023 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.so.bpmn.infrastructure.adapter.cnfm.tasks;
+
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.CREATE_CNF_STATUS_RESPONSE_PARAM_NAME;
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.OPERATION_STATUS_PARAM_NAME;
+import java.net.URI;
+import java.util.Optional;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.onap.so.client.exception.ExceptionBuilder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import com.google.common.collect.ImmutableSet;
+import org.onap.so.cnfm.lcm.model.AsLcmOpOcc;
+import org.onap.so.cnfm.lcm.model.AsLcmOpOcc.OperationStateEnum;
+
+
+/**
+ * @author sagar.shetty@est.tech
+ */
+@Component
+public class MonitorCnfmCreateJobTask {
+
+    public static final ImmutableSet<OperationStateEnum> OPERATION_FINISHED_STATES =
+            ImmutableSet.of(OperationStateEnum.COMPLETED, OperationStateEnum.FAILED, OperationStateEnum.ROLLED_BACK);
+    private static final String CNFM_REQUEST_STATUS_CHECK_URL = "CnfmStatusCheckUrl";
+    private static final Logger LOGGER = LoggerFactory.getLogger(MonitorCnfmCreateJobTask.class);
+    protected final ExceptionBuilder exceptionUtil;
+    private final CnfmHttpServiceProvider cnfmHttpServiceProvider;
+
+    @Autowired
+    public MonitorCnfmCreateJobTask(final CnfmHttpServiceProvider cnfmHttpServiceProvider,
+            final ExceptionBuilder exceptionUtil) {
+        this.cnfmHttpServiceProvider = cnfmHttpServiceProvider;
+        this.exceptionUtil = exceptionUtil;
+    }
+
+    /**
+     * Get the current operation status of instantiation job
+     *
+     * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl}
+     */
+    public void getCurrentOperationStatus(final BuildingBlockExecution execution) {
+        try {
+            LOGGER.debug("Executing getCurrentOperationStatus  ...");
+            final URI operation_status_url = execution.getVariable(CNFM_REQUEST_STATUS_CHECK_URL);
+            LOGGER.debug("Executing getCurrentOperationStatus for CNF... :{}", operation_status_url.toString());
+            final Optional<AsLcmOpOcc> instantiateOperationJobStatus =
+                    cnfmHttpServiceProvider.getInstantiateOperationJobStatus(operation_status_url.toString());
+            if (instantiateOperationJobStatus.isPresent()) {
+                final AsLcmOpOcc asLcmOpOccResponse = instantiateOperationJobStatus.get();
+                if (asLcmOpOccResponse.getOperationState() != null) {
+                    final OperationStateEnum operationStatus = asLcmOpOccResponse.getOperationState();
+                    LOGGER.debug("Operation {} with {} and operation retrieval status : {}", asLcmOpOccResponse.getId(),
+                            operationStatus, asLcmOpOccResponse.getOperationState());
+                    execution.setVariable(OPERATION_STATUS_PARAM_NAME, asLcmOpOccResponse.getOperationState());
+                }
+
+                LOGGER.debug("Operation {} without operationStatus and operation retrieval status :{}",
+                        asLcmOpOccResponse.getId(), asLcmOpOccResponse.getOperationState());
+            }
+            execution.setVariable(CREATE_CNF_STATUS_RESPONSE_PARAM_NAME, instantiateOperationJobStatus.get());
+            LOGGER.debug("Finished executing getCurrentOperationStatus for CNF...");
+        } catch (final Exception exception) {
+            final String message = "Unable to invoke get current Operation status";
+            LOGGER.error(message);
+            exceptionUtil.buildAndThrowWorkflowException(execution, 1209, message);
+
+        }
+    }
+
+    /**
+     * Log and throw exception on timeout for job status
+     *
+     * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl}
+     */
+    public void timeOutLogFailue(final BuildingBlockExecution execution) {
+        final String message = "CNF Instantiation operation time out";
+        LOGGER.error(message);
+        exceptionUtil.buildAndThrowWorkflowException(execution, 1205, message);
+    }
+
+    /**
+     * Check the final status of instantiation throw exception if not completed successfully
+     *
+     * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl}
+     */
+    public void checkIfOperationWasSuccessful(final BuildingBlockExecution execution) {
+        LOGGER.debug("Executing CNF checkIfOperationWasSuccessful  ...");
+        final OperationStateEnum operationStatusOption = execution.getVariable(OPERATION_STATUS_PARAM_NAME);
+        final AsLcmOpOcc cnfInstantiateStautusResponse = execution.getVariable(CREATE_CNF_STATUS_RESPONSE_PARAM_NAME);
+        if (operationStatusOption == null) {
+            final String message = "Unable to instantiate CNF jobId: "
+                    + (cnfInstantiateStautusResponse != null ? cnfInstantiateStautusResponse.getId() : "null")
+                    + "Unable to retrieve OperationStatus";
+            LOGGER.error(message);
+            exceptionUtil.buildAndThrowWorkflowException(execution, 1206, message);
+        } else {
+            final OperationStateEnum operationStatus = operationStatusOption;
+            if (operationStatus != OperationStateEnum.COMPLETED) {
+                final String message = "Unable to instantiate jobId: "
+                        + (cnfInstantiateStautusResponse != null ? cnfInstantiateStautusResponse.getId() : "null")
+                        + " OperationStatus: " + operationStatus;
+                LOGGER.error(message);
+                exceptionUtil.buildAndThrowWorkflowException(execution, 1207, message);
+            }
+            LOGGER.debug("Successfully completed CNF instatiation of job status {}", cnfInstantiateStautusResponse);
+        }
+    }
+
+    /**
+     * @param execution {@link org.onap.so.bpmn.common.DelegateExecutionImpl}
+     * @return boolean to indicate whether job has competed or not
+     */
+    public boolean hasOperationFinished(final BuildingBlockExecution execution) {
+        LOGGER.debug("Executing hasOperationFinished  ...");
+
+        final OperationStateEnum operationStatusOption = execution.getVariable(OPERATION_STATUS_PARAM_NAME);
+        if (operationStatusOption != null) {
+            return OPERATION_FINISHED_STATES.contains(operationStatusOption);
+        }
+        LOGGER.debug("OperationStatus is not present yet... ");
+        LOGGER.debug("Finished executing hasOperationFinished ...");
+        return false;
+    }
+}
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/Constants.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/Constants.java
index 6afd7799f8..37d6221b77 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/Constants.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/Constants.java
@@ -1,6 +1,6 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2023 Nordix Foundation.
  * ================================================================================
  * Modifications Copyright (c) 2019 Samsung
  * ================================================================================
@@ -33,6 +33,7 @@ public class Constants {
 
     public static final String CREATE_VNF_REQUEST_PARAM_NAME = "createVnfRequest";
     public static final String CREATE_VNF_RESPONSE_PARAM_NAME = "createVnfResponse";
+    public static final String CREATE_CNF_STATUS_RESPONSE_PARAM_NAME = "createCnfStatusResponse";
     public static final String INPUT_PARAMETER = "inputParameter";
     public static final String DELETE_VNF_RESPONSE_PARAM_NAME = "deleteVnfResponse";
     public static final String DELETE_VNF_NODE_STATUS = "deleteVnfNodeStatus";