catalog-be/src/main/java/org/openecomp/sdc/be/components/lifecycle/CheckinTransition.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.datatypes.enums.ComponentTypeEnum;
  29 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
  30 import org.openecomp.sdc.be.impl.ComponentsUtils;
  31 import org.openecomp.sdc.be.model.Component;
  32 import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
  33 import org.openecomp.sdc.be.model.LifecycleStateEnum;
  34 import org.openecomp.sdc.be.model.User;
  35 import org.openecomp.sdc.be.model.jsonjanusgraph.datamodel.ToscaElement;
  36 import org.openecomp.sdc.be.model.jsonjanusgraph.datamodel.ToscaElementTypeEnum;
  37 import org.openecomp.sdc.be.model.jsonjanusgraph.operations.ToscaElementLifecycleOperation;
  38 import org.openecomp.sdc.be.model.jsonjanusgraph.operations.ToscaOperationFacade;
  39 import org.openecomp.sdc.be.model.jsonjanusgraph.utils.ModelConverter;
  40 import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
  41 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  42 import org.openecomp.sdc.be.user.Role;
  43 import org.openecomp.sdc.common.log.wrappers.Logger;
  44 import org.openecomp.sdc.exception.ResponseFormat;
  45
  46 import java.util.Arrays;
  47
  48 public class CheckinTransition extends LifeCycleTransition {
  49
  50     private static final Logger log = Logger.getLogger(CheckinTransition.class);
  51
  52     public CheckinTransition(ComponentsUtils componentUtils, ToscaElementLifecycleOperation lifecycleOperation, ToscaOperationFacade toscaOperationFacade, JanusGraphDao janusGraphDao) {
  53         super(componentUtils, lifecycleOperation, toscaOperationFacade, janusGraphDao);
  54
  55         // authorized roles
  56         Role[] resourceServiceCheckoutRoles = { Role.ADMIN, Role.DESIGNER };
  57         Role[] productCheckoutRoles = { Role.ADMIN, Role.PRODUCT_MANAGER };
  58         addAuthorizedRoles(ComponentTypeEnum.RESOURCE, Arrays.asList(resourceServiceCheckoutRoles));
  59         addAuthorizedRoles(ComponentTypeEnum.SERVICE, Arrays.asList(resourceServiceCheckoutRoles));
  60         addAuthorizedRoles(ComponentTypeEnum.PRODUCT, Arrays.asList(productCheckoutRoles));
  61
  62     }
  63
  64     @Override
  65     public LifeCycleTransitionEnum getName() {
  66         return LifeCycleTransitionEnum.CHECKIN;
  67     }
  68
  69     @Override
  70     public AuditingActionEnum getAuditingAction() {
  71         return AuditingActionEnum.CHECKIN_RESOURCE;
  72     }
  73
  74     @Override
  75     public Either<? extends Component, ResponseFormat> changeState(ComponentTypeEnum componentType, Component component, ComponentBusinessLogic componentBl, User modifier, User owner, boolean shouldLock, boolean inTransaction) {
  76         log.debug("start performing checkin for {} {}", componentType, component.getUniqueId());
  77
  78         Either<? extends Component, ResponseFormat> result = null;
  79         try{
  80             Either<ToscaElement, StorageOperationStatus> checkinResourceResult = lifeCycleOperation.
  81                     checkinToscaELement(component.getLifecycleState(), component.getUniqueId(), modifier.getUserId(), owner.getUserId());
  82
  83             if (checkinResourceResult.isRight()) {
  84                 log.debug("checkout failed on graph");
  85                 StorageOperationStatus response = checkinResourceResult.right().value();
  86                 ActionStatus actionStatus = componentUtils.convertFromStorageResponse(response);
  87
  88                 if (response.equals(StorageOperationStatus.ENTITY_ALREADY_EXISTS)) {
  89                     actionStatus = ActionStatus.COMPONENT_VERSION_ALREADY_EXIST;
  90                 }
  91                 ResponseFormat responseFormat = componentUtils.getResponseFormatByComponent(actionStatus, component, componentType);
  92                 result =  Either.right(responseFormat);
  93             }
  94             else {
  95                 updateCalculatedCapabilitiesRequirements(checkinResourceResult.left().value());
  96                 result =  Either.left(ModelConverter.convertFromToscaElement(checkinResourceResult.left().value()));
  97             }
  98         } finally {
  99             if (result == null || result.isRight()) {
 100                 BeEcompErrorManager.getInstance().logBeDaoSystemError("Change LifecycleState");
 101                 if (!inTransaction) {
 102                     log.debug("operation failed. do rollback");
 103                     janusGraphDao.rollback();
 104                 }
 105             } else {
 106                 if (!inTransaction) {
 107                     log.debug("operation success. do commit");
 108                     janusGraphDao.commit();
 109                 }
 110             }
 111         }
 112         return result;
 113     }
 114
 115     @Override
 116     public Either<Boolean, ResponseFormat> validateBeforeTransition(Component component, ComponentTypeEnum componentType, User modifier, User owner, LifecycleStateEnum oldState, LifecycleChangeInfoWithAction lifecycleChangeInfo) {
 117         String componentName = component.getComponentMetadataDefinition().getMetadataDataDefinition().getName();
 118         log.debug("validate before checkin. component name={}, oldState={}, owner userId={}", componentName, oldState, owner.getUserId());
 119
 120         // validate user
 121         Either<Boolean, ResponseFormat> userValidationResponse = userRoleValidation(modifier,component, componentType, lifecycleChangeInfo);
 122         if (userValidationResponse.isRight()) {
 123             return userValidationResponse;
 124         }
 125
 126         if (!oldState.equals(LifecycleStateEnum.READY_FOR_CERTIFICATION) && !oldState.equals(LifecycleStateEnum.NOT_CERTIFIED_CHECKOUT)) {
 127             ActionStatus action = ActionStatus.COMPONENT_ALREADY_CHECKED_IN;
 128             if (oldState.equals(LifecycleStateEnum.CERTIFICATION_IN_PROGRESS)){
 129                 action = ActionStatus.COMPONENT_SENT_FOR_CERTIFICATION;
 130             } else if (oldState.equals(LifecycleStateEnum.CERTIFIED)){
 131                 action = ActionStatus.COMPONENT_ALREADY_CERTIFIED;
 132             }
 133             ResponseFormat error = componentUtils.getResponseFormat(action, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 134             return Either.right(error);
 135         }
 136
 137         if (oldState.equals(LifecycleStateEnum.NOT_CERTIFIED_CHECKOUT) && !modifier.getUserId().equals(owner.getUserId()) && !modifier.getRole().equals(Role.ADMIN.name())) {
 138             ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_CHECKOUT_BY_ANOTHER_USER, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 139             return Either.right(error);
 140         }
 141
 142         if (oldState.equals(LifecycleStateEnum.READY_FOR_CERTIFICATION) && !modifier.equals(owner) && !modifier.getRole().equals(Role.ADMIN.name())) {
 143             ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_SENT_FOR_CERTIFICATION, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
 144             return Either.right(error);
 145         }
 146
 147         return Either.left(true);
 148     }
 149
 150     private void updateCalculatedCapabilitiesRequirements(ToscaElement toscaElement) {
 151         if(toscaElement.getToscaType() == ToscaElementTypeEnum.TOPOLOGY_TEMPLATE && toscaElement.getResourceType() != ResourceTypeEnum.CVFC){
 152             toscaOperationFacade.updateNamesOfCalculatedCapabilitiesRequirements(toscaElement.getUniqueId());
 153         }
 154     }
 155 }