Added instatntiation job monitoring

Issue-ID: SO-1630
Change-Id: I2e921f0f86553b804ea119cd640b8c4e1b1195b9
Signed-off-by: Lathish <lathishbabu.ganesan@est.tech>

5 files changed, 208 insertions, 0 deletions

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 0153b4b3f9..59f8be50c8 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
@@ -20,6 +20,11 @@
 
 package org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks;
 
+import static com.google.common.collect.Sets.newHashSet;
+import java.util.Set;
+import org.onap.vnfmadapter.v1.model.OperationStateEnum;
+import org.onap.vnfmadapter.v1.model.OperationStatusRetrievalStatusEnum;
+
 /**
  * @author waqas.ikram@est.tech
  */
@@ -30,6 +35,7 @@ public class Constants {
   public static final String INPUT_PARAMETER = "inputParameter";
   public static final String DELETE_VNF_RESPONSE_PARAM_NAME = "deleteVnfResponse";
 
+
   public static final String DOT = ".";
   public static final String UNDERSCORE = "_";
   public static final String SPACE = "\\s+";
@@ -40,5 +46,14 @@ public class Constants {
   public static final String FORWARD_SLASH = "/";
   public static final String PRELOAD_VNFS_URL = "/restconf/config/VNF-API:preload-vnfs/vnf-preload-list/";
 
+
+  public static final Set<OperationStateEnum> OPERATION_FINISHED_STATES =
+      newHashSet(OperationStateEnum.COMPLETED, OperationStateEnum.FAILED, OperationStateEnum.ROLLED_BACK);
+
+  public static final Set<OperationStatusRetrievalStatusEnum> OPERATION_RETRIEVAL_STATES = newHashSet(
+      OperationStatusRetrievalStatusEnum.STATUS_FOUND, OperationStatusRetrievalStatusEnum.WAITING_FOR_STATUS);
+
+  public static final String OPERATION_STATUS_PARAM_NAME = "operationStatus";
+
   private Constants() {}
 }
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/MonitorVnfmCreateJobTask.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/MonitorVnfmCreateJobTask.java
new file mode 100644
index 0000000000..f89931063c
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/MonitorVnfmCreateJobTask.java
@@ -0,0 +1,154 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2019 Ericsson. All rights reserved.
+ * ================================================================================
+ * 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.
+ * 
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks;
+
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.CREATE_VNF_RESPONSE_PARAM_NAME;
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.OPERATION_FINISHED_STATES;
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.OPERATION_RETRIEVAL_STATES;
+import static org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks.Constants.OPERATION_STATUS_PARAM_NAME;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.onap.so.client.exception.ExceptionBuilder;
+import org.onap.vnfmadapter.v1.model.CreateVnfResponse;
+import org.onap.vnfmadapter.v1.model.OperationStateEnum;
+import org.onap.vnfmadapter.v1.model.QueryJobResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import com.google.common.base.Optional;
+
+
+/**
+ * @author waqas.ikram@est.tech
+ *
+ */
+@Component
+public class MonitorVnfmCreateJobTask {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(MonitorVnfmCreateJobTask.class);
+  private final ExceptionBuilder exceptionUtil;
+  private final VnfmAdapterServiceProvider vnfmAdapterServiceProvider;
+
+  @Autowired
+  public MonitorVnfmCreateJobTask(final VnfmAdapterServiceProvider vnfmAdapterServiceProvider,
+      final ExceptionBuilder exceptionUtil) {
+    this.vnfmAdapterServiceProvider = vnfmAdapterServiceProvider;
+    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) {
+    LOGGER.debug("Executing getCurrentOperationStatus  ...");
+    final CreateVnfResponse vnfInstantiateResponse = execution.getVariable(CREATE_VNF_RESPONSE_PARAM_NAME);
+    execution.setVariable(OPERATION_STATUS_PARAM_NAME, getOperationStatus(execution, vnfInstantiateResponse));
+    LOGGER.debug("Finished executing getCurrentOperationStatus ...");
+  }
+
+  /**
+   * @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 Optional<OperationStateEnum> operationStatusOption = execution.getVariable(OPERATION_STATUS_PARAM_NAME);
+    if (operationStatusOption != null && operationStatusOption.isPresent()) {
+      return OPERATION_FINISHED_STATES.contains(operationStatusOption.get());
+    }
+    LOGGER.debug("OperationStatus is not present yet... ");
+    LOGGER.debug("Finished executing hasOperationFinished ...");
+    return false;
+
+  }
+
+  /**
+   * 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 = "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 checkIfOperationWasSuccessful  ...");
+    final Optional<OperationStateEnum> operationStatusOption = execution.getVariable(OPERATION_STATUS_PARAM_NAME);
+    final CreateVnfResponse vnfInstantiateResponse = execution.getVariable(CREATE_VNF_RESPONSE_PARAM_NAME);
+    if (operationStatusOption == null || !operationStatusOption.isPresent()) {
+      final String message = "Unable to instantiate jobId: "
+          + (vnfInstantiateResponse != null ? vnfInstantiateResponse.getJobId() : "null")
+          + "Unable to retrieve OperationStatus";
+      LOGGER.error(message);
+      exceptionUtil.buildAndThrowWorkflowException(execution, 1206, message);
+    }
+    if (operationStatusOption.isPresent()) {
+      final OperationStateEnum operationStatus = operationStatusOption.get();
+      if (operationStatus != OperationStateEnum.COMPLETED) {
+        final String message = "Unable to instantiate jobId: "
+            + (vnfInstantiateResponse != null ? vnfInstantiateResponse.getJobId() : "null") + " OperationStatus: "
+            + operationStatus;
+        LOGGER.error(message);
+        exceptionUtil.buildAndThrowWorkflowException(execution, 1207, message);
+      }
+      LOGGER.debug("Successfully completed instatiation of job {}", vnfInstantiateResponse);
+    }
+  }
+
+  private Optional<OperationStateEnum> getOperationStatus(final BuildingBlockExecution execution,
+      final CreateVnfResponse vnfInstantiateResponse) {
+
+    final Optional<QueryJobResponse> instantiateOperationJobStatus =
+        vnfmAdapterServiceProvider.getInstantiateOperationJobStatus(vnfInstantiateResponse.getJobId());
+
+    if (instantiateOperationJobStatus.isPresent()) {
+      final QueryJobResponse queryJobResponse = instantiateOperationJobStatus.get();
+
+      if (!OPERATION_RETRIEVAL_STATES.contains(queryJobResponse.getOperationStatusRetrievalStatus())) {
+        final String message =
+            "Recevied invalid operation reterivel state: " + queryJobResponse.getOperationStatusRetrievalStatus();
+        LOGGER.error(message);
+        exceptionUtil.buildAndThrowWorkflowException(execution, 1203, message);
+      }
+
+      if (queryJobResponse.getOperationState() != null) {
+        final OperationStateEnum operationStatus = queryJobResponse.getOperationState();
+        LOGGER.debug("Operation {} with {} and operation retrieval status : {}", queryJobResponse.getId(),
+            operationStatus, queryJobResponse.getOperationStatusRetrievalStatus());
+        return Optional.of(queryJobResponse.getOperationState());
+      }
+
+      LOGGER.debug("Operation {} without operationStatus and operation retrieval status :{}", queryJobResponse.getId(),
+          queryJobResponse.getOperationStatusRetrievalStatus());
+
+    }
+    return Optional.absent();
+  }
+}
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProvider.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProvider.java
index a76a4bf3c1..1e785074f3 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProvider.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProvider.java
@@ -23,6 +23,7 @@ package org.onap.so.bpmn.infrastructure.adapter.vnfm.tasks;
 import org.onap.vnfmadapter.v1.model.CreateVnfRequest;
 import org.onap.vnfmadapter.v1.model.CreateVnfResponse;
 import org.onap.vnfmadapter.v1.model.DeleteVnfResponse;
+import org.onap.vnfmadapter.v1.model.QueryJobResponse;
 import com.google.common.base.Optional;
 
 
@@ -37,4 +38,6 @@ public interface VnfmAdapterServiceProvider {
 
   Optional<DeleteVnfResponse> invokeDeleteRequest(final String vnfId);
 
+  Optional<QueryJobResponse> getInstantiateOperationJobStatus(final String jobId);
+
 }
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProviderImpl.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProviderImpl.java
index f727423e85..e8f4c08f38 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProviderImpl.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterServiceProviderImpl.java
@@ -26,6 +26,7 @@ import org.onap.so.rest.service.HttpRestServiceProvider;
 import org.onap.vnfmadapter.v1.model.CreateVnfRequest;
 import org.onap.vnfmadapter.v1.model.CreateVnfResponse;
 import org.onap.vnfmadapter.v1.model.DeleteVnfResponse;
+import org.onap.vnfmadapter.v1.model.QueryJobResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -121,4 +122,30 @@ public class VnfmAdapterServiceProviderImpl implements VnfmAdapterServiceProvide
       return Optional.absent();
     }
   }
+
+  @Override
+  public Optional<QueryJobResponse> getInstantiateOperationJobStatus(final String jobId) {
+    try {
+      final String url = urlProvider.getJobStatusUrl(jobId);
+
+      final ResponseEntity<QueryJobResponse> response =
+          httpServiceProvider.getHttpResponse(url, QueryJobResponse.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.absent();
+      }
+
+      if (!response.hasBody()) {
+        LOGGER.error("Received response without body: {}", response);
+        return Optional.absent();
+      }
+      return Optional.of(response.getBody());
+    } catch (final RestProcessingException | InvalidRestRequestException httpInvocationException) {
+      LOGGER.error("Unexpected error while processing job request", httpInvocationException);
+      return Optional.absent();
+    }
+  }
 }
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterUrlProvider.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterUrlProvider.java
index 61063fe90e..97a7197373 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterUrlProvider.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnfm/tasks/VnfmAdapterUrlProvider.java
@@ -64,5 +64,14 @@ public class VnfmAdapterUrlProvider {
     return UriComponentsBuilder.fromUri(baseUri).pathSegment("vnfs").pathSegment(vnfId).build().toString();
   }
 
+    /**
+     * Get job status URL
+     * 
+     * @param jobId The instantiation job identifier
+     * @return job status URL
+     */
+    public String getJobStatusUrl(final String jobId) {
+        return UriComponentsBuilder.fromUri(baseUri).pathSegment("jobs").pathSegment(jobId).build().toString();
+    }
 
 }