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