catalog-be/src/main/java/org/openecomp/sdc/be/components/lifecycle/CheckoutTransition.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   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.openecomp.sdc.be.components.lifecycle;
  22
  23 import fj.data.Either;
  24 import org.openecomp.sdc.be.components.impl.ComponentBusinessLogic;
  25 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  26 import org.openecomp.sdc.be.dao.api.ActionStatus;
  27 import org.openecomp.sdc.be.dao.jsongraph.TitanDao;
  28 import org.openecomp.sdc.be.dao.jsongraph.types.EdgeLabelEnum;
  29 import org.openecomp.sdc.be.dao.jsongraph.types.VertexTypeEnum;
  30 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  31 import org.openecomp.sdc.be.datatypes.enums.JsonPresentationFields;
  32 import org.openecomp.sdc.be.impl.ComponentsUtils;
  33 import org.openecomp.sdc.be.model.Component;
  34 import org.openecomp.sdc.be.model.InputDefinition;
  35 import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
  36 import org.openecomp.sdc.be.model.LifecycleStateEnum;
  37 import org.openecomp.sdc.be.model.User;
  38 import org.openecomp.sdc.be.model.jsontitan.datamodel.ToscaElement;
  39 import org.openecomp.sdc.be.model.jsontitan.datamodel.ToscaElementTypeEnum;
  40 import org.openecomp.sdc.be.model.jsontitan.operations.ToscaElementLifecycleOperation;
  41 import org.openecomp.sdc.be.model.jsontitan.operations.ToscaOperationFacade;
  42 import org.openecomp.sdc.be.model.jsontitan.utils.ModelConverter;
  43 import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
  44 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  45 import org.openecomp.sdc.be.user.Role;
  46 import org.openecomp.sdc.exception.ResponseFormat;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 import java.util.Arrays;
  51 import java.util.List;
  52
  53 public class CheckoutTransition extends LifeCycleTransition {
  54
  55     private static final Logger log = LoggerFactory.getLogger(CheckoutTransition.class);
  56
  57     public CheckoutTransition(ComponentsUtils componentUtils, ToscaElementLifecycleOperation lifecycleOperation, ToscaOperationFacade toscaOperationFacade, TitanDao titanDao) {
  58         super(componentUtils, lifecycleOperation, toscaOperationFacade, titanDao);
  59
  60         // authorized roles
  61         Role[] resourceServiceCheckoutRoles = { Role.ADMIN, Role.DESIGNER };
  62         Role[] productCheckoutRoles = { Role.ADMIN, Role.PRODUCT_MANAGER };
  63         addAuthorizedRoles(ComponentTypeEnum.RESOURCE, Arrays.asList(resourceServiceCheckoutRoles));
  64         addAuthorizedRoles(ComponentTypeEnum.SERVICE, Arrays.asList(resourceServiceCheckoutRoles));
  65         addAuthorizedRoles(ComponentTypeEnum.PRODUCT, Arrays.asList(productCheckoutRoles));
  66
  67     }
  68
  69     @Override
  70     public LifeCycleTransitionEnum getName() {
  71         return LifeCycleTransitionEnum.CHECKOUT;
  72     }
  73
  74     @Override
  75     public AuditingActionEnum getAuditingAction() {
  76         return AuditingActionEnum.CHECKOUT_RESOURCE;
  77     }
  78
  79     @Override
  80     public Either<? extends Component, ResponseFormat> changeState(ComponentTypeEnum componentType, Component component, ComponentBusinessLogic componentBl, User modifier, User owner, boolean shouldLock, boolean inTransaction) {
  81
  82         log.debug("start performing {} for resource {}", getName(), component.getUniqueId());
  83
  84         Either<? extends Component, ResponseFormat> result = null;
  85         try {
  86
  87             Either<ToscaElement, StorageOperationStatus> checkoutResourceResult = lifeCycleOperation.checkoutToscaElement(component.getUniqueId(), modifier.getUserId(), owner.getUserId());
  88
  89             if (checkoutResourceResult.isRight()) {
  90                 log.debug("checkout failed on graph");
  91                 StorageOperationStatus response = checkoutResourceResult.right().value();
  92                 ActionStatus actionStatus = componentUtils.convertFromStorageResponse(response);
  93
  94                 if (response.equals(StorageOperationStatus.ENTITY_ALREADY_EXISTS)) {
  95                     actionStatus = ActionStatus.COMPONENT_VERSION_ALREADY_EXIST;
  96                 }
  97                 ResponseFormat responseFormat = componentUtils.getResponseFormatByComponent(actionStatus, component, componentType);
  98                 result = Either.right(responseFormat);
  99             } else {
 100
 101                 Component clonedComponent = ModelConverter.convertFromToscaElement(checkoutResourceResult.left().value());
 102                 if ( checkoutResourceResult.left().value().getToscaType() == ToscaElementTypeEnum.NodeType ){
 103                     Either<Component, ActionStatus> upgradeToLatestDerived = componentBl.shouldUpgradeToLatestDerived(clonedComponent);
 104                     if (upgradeToLatestDerived.isRight() && ActionStatus.OK != upgradeToLatestDerived.right().value()){
 105                         result = Either.right(componentUtils.getResponseFormat(upgradeToLatestDerived.right().value()));
 106                         return result;
 107                     }
 108                     if ( upgradeToLatestDerived.isLeft() ){
 109                         //get resource after update derived
 110                         clonedComponent = upgradeToLatestDerived.left().value();
 111                     }
 112                 }
 113                 result = Either.left(clonedComponent);
 114                 Either<Boolean, ResponseFormat> upgradeToLatestGeneric = componentBl.shouldUpgradeToLatestGeneric(clonedComponent);
 115                 if (upgradeToLatestGeneric.isRight())
 116                     result = Either.right(upgradeToLatestGeneric.right().value());
 117                 else if (upgradeToLatestGeneric.left().value()  ) {
 118                     StorageOperationStatus response = upgradeToLatestGenericData(clonedComponent);
 119                     if (StorageOperationStatus.OK != response) {
 120                         ActionStatus actionStatus = componentUtils.convertFromStorageResponse(response);
 121                         ResponseFormat responseFormat = componentUtils.getResponseFormatByComponent(actionStatus, component, componentType);
 122                         result = Either.right(responseFormat);
 123                     }
 124                 }
 125
 126             }
 127
 128         } finally {
 129             if (result == null || result.isRight()) {
 130                 BeEcompErrorManager.getInstance().logBeDaoSystemError("Change LifecycleState");
 131                 if (inTransaction == false) {
 132                     log.debug("operation failed. do rollback");
 133                     titanDao.rollback();
 134                 }
 135             } else {
 136                 if (inTransaction == false) {
 137                     log.debug("operation success. do commit");
 138                     titanDao.commit();
 139                 }
 140             }
 141         }
 142         return result;
 143     }
 144
 145     private StorageOperationStatus upgradeToLatestGenericData(Component clonedComponent) {
 146
 147         StorageOperationStatus updateStatus = StorageOperationStatus.OK;
 148         Either<Component, StorageOperationStatus> updateEither = toscaOperationFacade.updateToscaElement(clonedComponent);
 149         if (updateEither.isRight())
 150             updateStatus = updateEither.right().value();
 151         else if (clonedComponent.shouldGenerateInputs()) {
 152             List<InputDefinition> newInputs = clonedComponent.getInputs();
 153             updateStatus = lifeCycleOperation.updateToscaDataOfToscaElement(clonedComponent.getUniqueId(), EdgeLabelEnum.INPUTS, VertexTypeEnum.INPUTS, newInputs, JsonPresentationFields.NAME);
 154         }
 155         return updateStatus;
 156     }
 157
 158     @Override
 159     public Either<Boolean, ResponseFormat> validateBeforeTransition(Component component, ComponentTypeEnum componentType, User modifier, User owner, LifecycleStateEnum oldState, LifecycleChangeInfoWithAction lifecycleChangeInfo) {
 160         String componentName = component.getComponentMetadataDefinition().getMetadataDataDefinition().getName();
 161         log.debug("validate before checkout. resource name={}, oldState={}, owner userId={}", componentName, oldState, owner.getUserId());
 162
 163         // validate user
 164         Either<Boolean, ResponseFormat> userValidationResponse = userRoleValidation(modifier, component, componentType, lifecycleChangeInfo);
 165         if (userValidationResponse.isRight()) {
 166             return userValidationResponse;
 167         }
 168
 169         // check resource is not locked by another user
 170         if (oldState.equals(LifecycleStateEnum.NOT_CERTIFIED_CHECKOUT)) {
 171             ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_IN_CHECKOUT_STATE, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 172             return Either.right(error);
 173         }
 174
 175         if (oldState.equals(LifecycleStateEnum.CERTIFICATION_IN_PROGRESS)) {
 176             ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_IN_CERT_IN_PROGRESS_STATE, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 177             return Either.right(error);
 178         }
 179
 180         if (oldState.equals(LifecycleStateEnum.READY_FOR_CERTIFICATION)) {
 181             if (!modifier.getRole().equals(Role.DESIGNER.name()) && !modifier.getRole().equals(Role.ADMIN.name())) {
 182                 ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_SENT_FOR_CERTIFICATION, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 183                 return Either.right(error);
 184             }
 185         }
 186         return Either.left(true);
 187     }
 188
 189 }