mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/tenantisolation/process/ActivateVnfStatusOperationalEnvironment.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 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.so.apihandlerinfra.tenantisolation.process;
  22
  23
  24 import java.util.List;
  25
  26 import javax.ws.rs.core.Response;
  27
  28 import org.apache.http.HttpStatus;
  29 import org.json.JSONObject;
  30 import org.onap.so.apihandler.common.ErrorNumbers;
  31 import org.onap.so.apihandlerinfra.exceptions.ApiException;
  32 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  33 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  34 import org.onap.so.apihandlerinfra.tenantisolation.CloudOrchestrationRequest;
  35 import org.onap.so.apihandlerinfra.tenantisolation.helpers.ActivateVnfDBHelper;
  36 import org.onap.so.apihandlerinfra.tenantisolation.helpers.SDCClientHelper;
  37 import org.onap.so.apihandlerinfra.tenantisolationbeans.Distribution;
  38 import org.onap.so.apihandlerinfra.tenantisolationbeans.DistributionStatus;
  39 import org.onap.so.db.request.beans.OperationalEnvDistributionStatus;
  40 import org.onap.so.db.request.beans.OperationalEnvServiceModelStatus;
  41 import org.onap.so.db.request.data.repository.OperationalEnvDistributionStatusRepository;
  42 import org.onap.so.db.request.data.repository.OperationalEnvServiceModelStatusRepository;
  43 import org.onap.so.logger.MessageEnum;
  44 import org.onap.so.logger.MsoLogger;
  45 import org.onap.so.requestsdb.RequestsDBHelper;
  46 import org.springframework.beans.factory.annotation.Autowired;
  47 import org.springframework.stereotype.Component;
  48
  49 @Component
  50 public class ActivateVnfStatusOperationalEnvironment {
  51
  52         private static MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.APIH, ActivateVnfStatusOperationalEnvironment.class);
  53         private String origRequestId = "";
  54         private String errorMessage = "";
  55         private OperationalEnvDistributionStatus queryDistributionDbResponse = null;
  56         private OperationalEnvServiceModelStatus queryServiceModelResponse = null;
  57
  58         private final int RETRY_COUNT_ZERO = 0;
  59         private final String ERROR_REASON_ABORTED = "ABORTED";
  60         private final String RECOVERY_ACTION_RETRY  = "RETRY";
  61         private final String RECOVERY_ACTION_ABORT  = "ABORT";
  62         private final String RECOVERY_ACTION_SKIP  = "SKIP";
  63         private final String DISTRIBUTION_STATUS_OK = DistributionStatus.DISTRIBUTION_COMPLETE_OK.toString();
  64         private final String DISTRIBUTION_STATUS_ERROR = DistributionStatus.DISTRIBUTION_COMPLETE_ERROR.toString();
  65         private final String DISTRIBUTION_STATUS_SENT = "SENT";
  66
  67         private final String MESSAGE_UNDEFINED_ID = "Undefined Error Message!";
  68
  69         @Autowired
  70         private ActivateVnfDBHelper dbHelper;
  71         @Autowired
  72         private RequestsDBHelper requestDb;
  73         @Autowired
  74         private SDCClientHelper sdcClientHelper;
  75
  76         /**
  77          * The Point-Of-Entry from APIH with activate status from SDC
  78          * @param requestId - String
  79          * @param request - CloudOrchestrationRequest - object
  80          * @param distributionStatusRepository - OperationalEnvDistributionStatusRepository - object
  81          * @param modelStatusRepository - OperationalEnvServiceModelStatusRepository - object
  82          * @return void - nothing
  83          */
  84         public void execute(String requestId, CloudOrchestrationRequest request, OperationalEnvDistributionStatusRepository distributionStatusRepository,
  85                                                 OperationalEnvServiceModelStatusRepository modelStatusRepository) throws ApiException {
  86
  87
  88                 String operationalEnvironmentId = "";
  89
  90                         String sdcDistributionId = request.getDistributionId();
  91                         Distribution sdcStatus = request.getDistribution();
  92
  93                         // Distribution, Query for operationalEnvironmentId, serviceModelVersionId
  94                         this.queryDistributionDbResponse = distributionStatusRepository.findOne(sdcDistributionId);
  95                         operationalEnvironmentId = this.queryDistributionDbResponse.getOperationalEnvId();
  96
  97                         // ServiceModel, Query for dbRequestId, recoveryAction, retryCountString
  98                         this.queryServiceModelResponse = modelStatusRepository.findOneByOperationalEnvIdAndServiceModelVersionId(operationalEnvironmentId, queryDistributionDbResponse.getServiceModelVersionId());
  99                         this.origRequestId = this.queryServiceModelResponse.getRequestId();
 100
 101                         processActivateSDCStatus(sdcDistributionId, sdcStatus, this.queryDistributionDbResponse, this.queryServiceModelResponse, distributionStatusRepository, modelStatusRepository);
 102
 103                         // After EVERY status processed, need to query the status of all service modelId
 104                         //  to determine the OVERALL status if "COMPLETE" or "FAILURE":
 105                         checkOrUpdateOverallStatus(operationalEnvironmentId, this.origRequestId, modelStatusRepository);
 106
 107         }
 108
 109         /**
 110          * The Method to process the Activation Status from SDC
 111          * @param sdcDistributionId - string
 112          * @param sdcStatus - Distribution object
 113          * @param queryDistributionDbResponse - OperationalEnvDistributionStatus object
 114          * @param queryServiceModelResponse - OperationalEnvServiceModelStatus object
 115          * @param distributionStatusRepository - OperationalEnvDistributionStatusRepository object
 116          * @param modelStatusRepository - OperationalEnvServiceModelStatusRepository object
 117          * @return void - nothing
 118          */
 119         public void processActivateSDCStatus(String sdcDistributionId, Distribution sdcStatus, OperationalEnvDistributionStatus queryDistributionDbResponse,
 120                         OperationalEnvServiceModelStatus queryServiceModelResponse, OperationalEnvDistributionStatusRepository distributionStatusRepository,
 121                         OperationalEnvServiceModelStatusRepository modelStatusRepository) throws ApiException {
 122
 123                 String sdcStatusValue = sdcStatus.getStatus().toString();
 124                 String recoveryAction = queryServiceModelResponse.getRecoveryAction();
 125                 int retryCount = queryServiceModelResponse.getRetryCount();
 126
 127                 // Validate/process status
 128                 if (sdcStatus.getStatus().toString().equals(DISTRIBUTION_STATUS_OK)) {
 129                         // should update 1 row, update status to "DISTRIBUTION_COMPLETE_OK"
 130                         OperationalEnvDistributionStatus updateDistStatusOk =
 131                                         dbHelper.updateStatusInOperationalEnvDistributionStatus(queryDistributionDbResponse,
 132                                                                                                                                                         sdcStatusValue,
 133                                                                                                                                                         "");
 134                         distributionStatusRepository.save(updateDistStatusOk);
 135                         // should update 1 row, update status and retryCount = 0 (ie, serviceModelVersionId is DONE!)
 136                         OperationalEnvServiceModelStatus updateRetryCountZeroAndStatusOk =
 137                                         dbHelper.updateRetryCountAndStatusInOperationalEnvServiceModelStatus(queryServiceModelResponse,
 138                                                                                                                                                                                  sdcStatusValue,
 139                                                                                                                                                                                  RETRY_COUNT_ZERO);
 140                         modelStatusRepository.save(updateRetryCountZeroAndStatusOk);
 141                 } else {
 142
 143                           // "DISTRIBUTION_COMPLETE_ERROR", Check if recoveryAction is "RETRY"
 144                           if (recoveryAction.equals(RECOVERY_ACTION_RETRY) && retryCount > RETRY_COUNT_ZERO) {
 145
 146                                     // RESEND / RETRY serviceModelVersionId to SDC
 147
 148                                   JSONObject jsonResponse = callSDClientForRetry(queryDistributionDbResponse, queryServiceModelResponse, sdcStatus,
 149                                                   distributionStatusRepository, modelStatusRepository);
 150
 151                          } else { // either RETRY & Count = 0, or 'ABORT', or 'SKIP'
 152
 153                                         if (recoveryAction.equals(RECOVERY_ACTION_SKIP) || recoveryAction.equals(RECOVERY_ACTION_ABORT)) {
 154                                                 String modifiedStatus = "";
 155                                                 String errorReason = "";
 156                                                 if (recoveryAction.equals(RECOVERY_ACTION_SKIP)) {  // considered SUCCESS
 157                                                         modifiedStatus = DISTRIBUTION_STATUS_OK;
 158                                                 } else {
 159                                                         if (recoveryAction.equals(RECOVERY_ACTION_ABORT)) {
 160                                                                 modifiedStatus = DISTRIBUTION_STATUS_ERROR;  // ABORT, error
 161                                                                 errorReason = ERROR_REASON_ABORTED;
 162                                                         }
 163                                                 }
 164
 165                                                 sdcStatusValue = modifiedStatus;
 166                                             // should update 1 row, modified status & retryCount set 0
 167                                                 OperationalEnvServiceModelStatus updateRetryCountZeroAndStatus =
 168                                                                 dbHelper.updateRetryCountAndStatusInOperationalEnvServiceModelStatus(queryServiceModelResponse,
 169                                                                                                                                                                                                          modifiedStatus,
 170                                                                                                                                                                                                          RETRY_COUNT_ZERO);
 171                                                 modelStatusRepository.save(updateRetryCountZeroAndStatus);
 172                                                 // should update 1 row, modified status
 173                                                 OperationalEnvDistributionStatus updateDistStatus =
 174                                                                 dbHelper.updateStatusInOperationalEnvDistributionStatus(queryDistributionDbResponse,
 175                                                                                                                                                                                 modifiedStatus,
 176                                                                                                                                                                                 errorReason);
 177                                                 distributionStatusRepository.save(updateDistStatus);
 178                                         } else {
 179                                                 // RETRY & Count = 0 (do nothing!)
 180                                         }
 181                           }
 182                 }
 183         }
 184
 185         /**
 186          * The Method to call SDC for recoveryActioin RETRY
 187          * @param queryDistributionDbResponse - OperationalEnvDistributionStatus object
 188          * @param queryServiceModelResponse - OperationalEnvServiceModelStatus object
 189          * @param sdcStatus - Distribution object
 190          * @param distributionStatusRepository - OperationalEnvDistributionStatusRepository object
 191          * @param modelStatusRepository - OperationalEnvServiceModelStatusRepository object
 192          * @return JSONObject object
 193          */
 194         public JSONObject callSDClientForRetry(OperationalEnvDistributionStatus queryDistributionDbResponse,
 195                                                                                         OperationalEnvServiceModelStatus queryServiceModelResponse,
 196                                                                             Distribution sdcStatus,
 197                                                                             OperationalEnvDistributionStatusRepository distributionStatusRepository,
 198                                                                                         OperationalEnvServiceModelStatusRepository modelStatusRepository) throws ApiException {
 199
 200                 JSONObject jsonResponse = null;
 201
 202                 String operEnvironmentId = queryDistributionDbResponse.getOperationalEnvId();
 203                 String serviceModelVersionId = queryDistributionDbResponse.getServiceModelVersionId();
 204                 String originalRequestId = queryServiceModelResponse.getRequestId();
 205                 int retryCount = queryServiceModelResponse.getRetryCount();
 206                 String workloadContext  = queryServiceModelResponse.getWorkloadContext();
 207
 208
 209                 jsonResponse = sdcClientHelper.postActivateOperationalEnvironment(serviceModelVersionId, operEnvironmentId, workloadContext);
 210                 String statusCode = jsonResponse.get("statusCode").toString();
 211                 if (statusCode.equals(String.valueOf(Response.Status.ACCEPTED.getStatusCode()))) {
 212                         String newDistributionId = jsonResponse.get("distributionId").toString();
 213                         // should insert 1 row, NEW distributionId for replacement of the serviceModelServiceId record
 214                         OperationalEnvDistributionStatus insertNewDistributionId =
 215                                         dbHelper.insertRecordToOperationalEnvDistributionStatus(newDistributionId,
 216                                                         operEnvironmentId,
 217                                                         serviceModelVersionId,
 218                                                         originalRequestId,
 219                                                         DISTRIBUTION_STATUS_SENT,
 220                                                         "");
 221                         distributionStatusRepository.save(insertNewDistributionId);
 222
 223                         // update retryCount (less 1) for the serviceModelServiceId
 224                         retryCount = retryCount - 1;
 225                         // should update 1 row, original insert
 226                         OperationalEnvServiceModelStatus updateRetryCountAndStatus =
 227                                         dbHelper.updateRetryCountAndStatusInOperationalEnvServiceModelStatus(queryServiceModelResponse,
 228                                                         DISTRIBUTION_STATUS_SENT,
 229                                                         retryCount);
 230                         modelStatusRepository.save(updateRetryCountAndStatus);
 231
 232                         // should update 1 row, OLD distributionId set to status error (ie, old distributionId is DONE!).
 233                         OperationalEnvDistributionStatus updateStatus =
 234                                         dbHelper.updateStatusInOperationalEnvDistributionStatus(queryDistributionDbResponse,
 235                                                         DISTRIBUTION_STATUS_ERROR,
 236                                                         sdcStatus.getErrorReason());
 237                         distributionStatusRepository.save(updateStatus);
 238                 } else {
 239             String dbErrorMessage = "Failure calling SDC: statusCode: " + statusCode +
 240                     "; messageId: " + jsonResponse.get("messageId") +
 241                     "; message: " + jsonResponse.get("message");
 242                         ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_GENERAL_EXCEPTION, MsoLogger.ErrorCode.BusinessProcesssError).build();
 243                         ValidateException validateException = new ValidateException.Builder(dbErrorMessage,
 244                                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
 245                     requestDb.updateInfraFailureCompletion(dbErrorMessage, this.origRequestId, operEnvironmentId);
 246                         throw validateException;
 247                         }
 248
 249                 return jsonResponse;
 250
 251         }
 252
 253
 254         /**
 255          * The Method to check the overall status of the Activation for an operationalEnvironmentId
 256          * @param operationalEnvironmentId - string
 257          * @param origRequestId - string
 258          * @param  modelStatusRepository - OperationalEnvServiceModelStatusRepository object
 259          * @return void - nothing
 260          */
 261         public void checkOrUpdateOverallStatus(String operationalEnvironmentId, String origRequestId, OperationalEnvServiceModelStatusRepository modelStatusRepository) throws ApiException{
 262
 263                 List<OperationalEnvServiceModelStatus> queryServiceModelResponseList = modelStatusRepository.findAllByOperationalEnvIdAndRequestId(operationalEnvironmentId, origRequestId);
 264
 265                 String status = "Waiting";
 266                 int count = 0;
 267                 // loop through the statuses of the service model
 268                 for (OperationalEnvServiceModelStatus  querySrvModelResponse : queryServiceModelResponseList) {
 269                                 status = querySrvModelResponse.getServiceModelVersionDistrStatus();
 270                                 // all should be OK to be completed.
 271                                 if ((status.equals(DistributionStatus.DISTRIBUTION_COMPLETE_OK.toString()) &&
 272                                         (querySrvModelResponse.getRetryCount() == 0))) {
 273                                         status = "Completed";
 274                                         count ++;
 275                                 }
 276                                 // one error with zero retry, means all are failures.
 277                                 if ((status.equals(DistributionStatus.DISTRIBUTION_COMPLETE_ERROR.toString()) &&
 278                                         (querySrvModelResponse.getRetryCount() == 0))) {
 279                                         status = "Failure";
 280                                         count = queryServiceModelResponseList.size();
 281                                         break;
 282                                 }
 283                 }
 284
 285                 if (status.equals("Completed") && queryServiceModelResponseList.size() == count) {
 286                         String messageStatus = "Overall Activation process is complete. " + status;
 287                         requestDb.updateInfraSuccessCompletion(messageStatus, origRequestId, operationalEnvironmentId);
 288                 } else {
 289                         if (status.equals("Failure") && queryServiceModelResponseList.size() == count) {
 290                                 this.errorMessage = "Overall Activation process is a Failure. " + status;
 291                                 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_GENERAL_EXCEPTION, MsoLogger.ErrorCode.BusinessProcesssError).build();
 292                                 ValidateException validateException = new ValidateException.Builder(this.errorMessage,
 293                                                 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
 294                 requestDb.updateInfraFailureCompletion(this.errorMessage, origRequestId, operationalEnvironmentId);
 295                                 throw validateException;
 296                         }
 297
 298                 }
 299         }
 300 }