gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.openecomp.sdcrests.vendorlicense.rest.services;
  17
  18 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  19 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  20 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  21 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.SUBMIT_DESCRIPTION;
  22 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_ID;
  23 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_NAME;
  24 import static org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto.VendorLicenseModelAction.Submit;
  25
  26 import java.util.HashMap;
  27 import java.util.Map;
  28 import java.util.Objects;
  29 import java.util.function.Predicate;
  30 import javax.inject.Named;
  31 import javax.ws.rs.core.Response;
  32 import org.openecomp.core.dao.UniqueValueDaoFactory;
  33 import org.openecomp.core.util.UniqueValueUtil;
  34 import org.openecomp.sdc.activitylog.ActivityLogManager;
  35 import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
  36 import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
  37 import org.openecomp.sdc.activitylog.dao.type.ActivityType;
  38 import org.openecomp.sdc.common.errors.CoreException;
  39 import org.openecomp.sdc.common.errors.ErrorCode;
  40 import org.openecomp.sdc.common.errors.Messages;
  41 import org.openecomp.sdc.datatypes.model.ItemType;
  42 import org.openecomp.sdc.healing.factory.HealingManagerFactory;
  43 import org.openecomp.sdc.itempermissions.PermissionsManager;
  44 import org.openecomp.sdc.itempermissions.PermissionsManagerFactory;
  45 import org.openecomp.sdc.itempermissions.impl.types.PermissionTypes;
  46 import org.openecomp.sdc.logging.api.Logger;
  47 import org.openecomp.sdc.logging.api.LoggerFactory;
  48 import org.openecomp.sdc.notification.dtos.Event;
  49 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  50 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  51 import org.openecomp.sdc.vendorlicense.VendorLicenseConstants;
  52 import org.openecomp.sdc.vendorlicense.VendorLicenseManager;
  53 import org.openecomp.sdc.vendorlicense.VendorLicenseManagerFactory;
  54 import org.openecomp.sdc.vendorlicense.dao.types.VendorLicenseModelEntity;
  55 import org.openecomp.sdc.versioning.AsdcItemManager;
  56 import org.openecomp.sdc.versioning.AsdcItemManagerFactory;
  57 import org.openecomp.sdc.versioning.VersioningManager;
  58 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  59 import org.openecomp.sdc.versioning.dao.types.Version;
  60 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  61 import org.openecomp.sdc.versioning.types.Item;
  62 import org.openecomp.sdc.versioning.types.ItemStatus;
  63 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  64 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  65 import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
  66 import org.openecomp.sdcrests.item.types.ItemCreationDto;
  67 import org.openecomp.sdcrests.item.types.ItemDto;
  68 import org.openecomp.sdcrests.item.types.VersionDto;
  69 import org.openecomp.sdcrests.vendorlicense.rest.VendorLicenseModels;
  70 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelEntityToDto;
  71 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity;
  72 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto;
  73 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelEntityDto;
  74 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelRequestDto;
  75 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  76 import org.springframework.context.annotation.Scope;
  77 import org.springframework.stereotype.Service;
  78 import org.springframework.validation.annotation.Validated;
  79
  80 @Named
  81 @Service("vendorLicenseModels")
  82 @Scope(value = "prototype")
  83 @Validated
  84 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  85
  86     private static final String SUBMIT_ITEM_ACTION = "Submit_Item";
  87     private static final String SUBMIT_HEALED_VERSION_ERROR = "VLM Id %s: Error while submitting version %s created based on Certified version %s for healing purpose.";
  88     private static final Logger LOGGER = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  89     private PermissionsManager permissionsManager = PermissionsManagerFactory.getInstance().createInterface();
  90     private NotificationPropagationManager notifier = NotificationPropagationManagerFactory.getInstance().createInterface();
  91     private AsdcItemManager asdcItemManager = AsdcItemManagerFactory.getInstance().createInterface();
  92     private VersioningManager versioningManager = VersioningManagerFactory.getInstance().createInterface();
  93     private VendorLicenseManager vendorLicenseManager = VendorLicenseManagerFactory.getInstance().createInterface();
  94     private ActivityLogManager activityLogManager = ActivityLogManagerFactory.getInstance().createInterface();
  95     private UniqueValueUtil uniqueValueUtil = new UniqueValueUtil(UniqueValueDaoFactory.getInstance().createInterface());
  96
  97     @Override
  98     public Response listLicenseModels(String versionStatus, String itemStatus, String user) {
  99         Predicate<Item> itemPredicate = createItemPredicate(versionStatus, itemStatus, user);
 100         GenericCollectionWrapper<ItemDto> results = new GenericCollectionWrapper<>();
 101         MapItemToDto mapper = new MapItemToDto();
 102         asdcItemManager.list(itemPredicate).stream().sorted((o1, o2) -> o2.getModificationTime().compareTo(o1.getModificationTime()))
 103             .forEach(item -> results.add(mapper.applyMapping(item, ItemDto.class)));
 104         return Response.ok(results).build();
 105     }
 106
 107     @Override
 108     public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 109         Item item = new Item();
 110         item.setType(ItemType.vlm.name());
 111         item.setOwner(user);
 112         item.setStatus(ItemStatus.ACTIVE);
 113         item.setName(request.getVendorName());
 114         item.setDescription(request.getDescription());
 115         uniqueValueUtil.validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 116         item = asdcItemManager.create(item);
 117         uniqueValueUtil.createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 118         Version version = versioningManager.create(item.getId(), new Version(), null);
 119         VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 120             .applyMapping(request, VendorLicenseModelEntity.class);
 121         vlm.setId(item.getId());
 122         vlm.setVersion(version);
 123         vendorLicenseManager.createVendorLicenseModel(vlm);
 124         versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 125         ItemCreationDto itemCreationDto = new ItemCreationDto();
 126         itemCreationDto.setItemId(item.getId());
 127         itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 128         activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version, ActivityType.Create, user, true, "", ""));
 129         return Response.ok(itemCreationDto).build();
 130     }
 131
 132     @Override
 133     public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId, String versionId, String user) {
 134         VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 135             .applyMapping(request, VendorLicenseModelEntity.class);
 136         vlm.setId(vlmId);
 137         vlm.setVersion(new Version(versionId));
 138         vendorLicenseManager.updateVendorLicenseModel(vlm);
 139         return Response.ok().build();
 140     }
 141
 142     @Override
 143     public Response getLicenseModel(String vlmId, String versionId, String user) {
 144         Version version = versioningManager.get(vlmId, new Version(versionId));
 145         VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 146         try {
 147             HealingManagerFactory.getInstance().createInterface().healItemVersion(vlmId, version, ItemType.vlm, false).ifPresent(healedVersion -> {
 148                 vlm.setVersion(healedVersion);
 149                 if (version.getStatus() == VersionStatus.Certified) {
 150                     submitHealedVersion(vlmId, healedVersion, versionId, user);
 151                 }
 152             });
 153         } catch (Exception e) {
 154             LOGGER.error(String.format("Error while auto healing VLM with Id %s and version %s", vlmId, versionId), e);
 155         }
 156         VendorLicenseModelEntityDto vlmDto = new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 157         return Response.ok(vlmDto).build();
 158     }
 159
 160     @Override
 161     public Response deleteLicenseModel(String vlmId, String user) {
 162         Item vlm = asdcItemManager.get(vlmId);
 163         if (!vlm.getType().equals(ItemType.vlm.name())) {
 164             throw new CoreException((new ErrorCode.ErrorCodeBuilder().withMessage(String.format("Vlm with id %s does not exist.", vlmId)).build()));
 165         }
 166         Integer certifiedVersionsCounter = vlm.getVersionStatusCounters().get(VersionStatus.Certified);
 167         if (Objects.isNull(certifiedVersionsCounter) || certifiedVersionsCounter == 0) {
 168             asdcItemManager.delete(vlm);
 169             permissionsManager.deleteItemPermissions(vlmId);
 170             uniqueValueUtil.deleteUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, vlm.getName());
 171             notifyUsers(vlmId, vlm.getName(), null, null, user, NotificationEventTypes.DELETE);
 172             return Response.ok().build();
 173         } else {
 174             return Response.status(Response.Status.FORBIDDEN).entity(new Exception(Messages.DELETE_VLM_ERROR.getErrorMessage())).build();
 175         }
 176     }
 177
 178     @Override
 179     public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId, String versionId, String user) {
 180         Version version = new Version(versionId);
 181         if (request.getAction() == Submit) {
 182             if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM_ACTION)) {
 183                 return Response.status(Response.Status.FORBIDDEN).entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 184             }
 185             String message = request.getSubmitRequest() == null ? "Submit" : request.getSubmitRequest().getMessage();
 186             submit(vlmId, version, message, user);
 187             notifyUsers(vlmId, null, version, message, user, NotificationEventTypes.SUBMIT);
 188         }
 189         return Response.ok().build();
 190     }
 191
 192     private void submit(String vlmId, Version version, String message, String user) {
 193         vendorLicenseManager.validate(vlmId, version);
 194         versioningManager.submit(vlmId, version, message);
 195         activityLogManager.logActivity(new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 196     }
 197
 198     private void submitHealedVersion(String vlmId, Version healedVersion, String baseVersionId, String user) {
 199         try {
 200             submit(vlmId, healedVersion, "Submit after heal", user);
 201         } catch (Exception ex) {
 202             LOGGER.error(String.format(SUBMIT_HEALED_VERSION_ERROR, vlmId, healedVersion.getId(), baseVersionId), ex);
 203         }
 204     }
 205
 206     private void notifyUsers(String itemId, String itemName, Version version, String message, String userName, NotificationEventTypes eventType) {
 207         Map<String, Object> eventProperties = new HashMap<>();
 208         eventProperties.put(ITEM_NAME, itemName == null ? asdcItemManager.get(itemId).getName() : itemName);
 209         eventProperties.put(ITEM_ID, itemId);
 210         if (version != null) {
 211             eventProperties.put(VERSION_NAME, version.getName() == null ? versioningManager.get(itemId, version).getName() : version.getName());
 212             eventProperties.put(VERSION_ID, version.getId());
 213         }
 214         eventProperties.put(SUBMIT_DESCRIPTION, message);
 215         eventProperties.put(PERMISSION_USER, userName);
 216         Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 217         try {
 218             notifier.notifySubscribers(syncEvent, userName);
 219         } catch (Exception e) {
 220             LOGGER.error("Failed to send sync notification to users subscribed o item '" + itemId);
 221         }
 222     }
 223
 224     private boolean userHasPermission(String itemId, String userId) {
 225         return permissionsManager.getUserItemPermission(itemId, userId)
 226             .map(permission -> permission.matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name())).orElse(false);
 227     }
 228
 229     private Predicate<Item> createItemPredicate(String versionStatus, String itemStatus, String user) {
 230         Predicate<Item> itemPredicate = item -> ItemType.vlm.name().equals(item.getType());
 231         if (ItemStatus.ARCHIVED.name().equals(itemStatus)) {
 232             itemPredicate = itemPredicate.and(item -> ItemStatus.ARCHIVED.equals(item.getStatus()));
 233         } else {
 234             itemPredicate = itemPredicate.and(item -> ItemStatus.ACTIVE.equals(item.getStatus()));
 235             if (VersionStatus.Certified.name().equals(versionStatus)) {
 236                 itemPredicate = itemPredicate.and(item -> item.getVersionStatusCounters().containsKey(VersionStatus.Certified));
 237             } else if (VersionStatus.Draft.name().equals(versionStatus)) {
 238                 itemPredicate = itemPredicate
 239                     .and(item -> item.getVersionStatusCounters().containsKey(VersionStatus.Draft) && userHasPermission(item.getId(), user));
 240             }
 241         }
 242         return itemPredicate;
 243     }
 244
 245     private class SyncEvent implements Event {
 246
 247         private String eventType;
 248         private String originatorId;
 249         private Map<String, Object> attributes;
 250         private String entityId;
 251
 252         SyncEvent(String eventType, String originatorId, Map<String, Object> attributes, String entityId) {
 253             this.eventType = eventType;
 254             this.originatorId = originatorId;
 255             this.attributes = attributes;
 256             this.entityId = entityId;
 257         }
 258
 259         @Override
 260         public String getEventType() {
 261             return eventType;
 262         }
 263
 264         @Override
 265         public String getOriginatorId() {
 266             return originatorId;
 267         }
 268
 269         @Override
 270         public Map<String, Object> getAttributes() {
 271             return attributes;
 272         }
 273
 274         @Override
 275         public String getEntityId() {
 276             return entityId;
 277         }
 278     }
 279 }