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
  17
  18 package org.openecomp.sdcrests.vendorlicense.rest.services;
  19
  20 import org.openecomp.core.dao.UniqueValueDaoFactory;
  21 import org.openecomp.core.util.UniqueValueUtil;
  22 import org.openecomp.sdc.activitylog.ActivityLogManager;
  23 import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
  24 import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
  25 import org.openecomp.sdc.activitylog.dao.type.ActivityType;
  26 import org.openecomp.sdc.common.errors.CoreException;
  27 import org.openecomp.sdc.common.errors.ErrorCode;
  28 import org.openecomp.sdc.common.errors.Messages;
  29 import org.openecomp.sdc.datatypes.model.ItemType;
  30 import org.openecomp.sdc.healing.factory.HealingManagerFactory;
  31 import org.openecomp.sdc.itempermissions.PermissionsManager;
  32 import org.openecomp.sdc.itempermissions.PermissionsManagerFactory;
  33 import org.openecomp.sdc.itempermissions.impl.types.PermissionTypes;
  34 import org.openecomp.sdc.logging.api.Logger;
  35 import org.openecomp.sdc.logging.api.LoggerFactory;
  36 import org.openecomp.sdc.notification.dtos.Event;
  37 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  38 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  39 import org.openecomp.sdc.vendorlicense.VendorLicenseConstants;
  40 import org.openecomp.sdc.vendorlicense.VendorLicenseManager;
  41 import org.openecomp.sdc.vendorlicense.VendorLicenseManagerFactory;
  42 import org.openecomp.sdc.vendorlicense.dao.types.VendorLicenseModelEntity;
  43 import org.openecomp.sdc.versioning.AsdcItemManager;
  44 import org.openecomp.sdc.versioning.AsdcItemManagerFactory;
  45 import org.openecomp.sdc.versioning.VersioningManager;
  46 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  47 import org.openecomp.sdc.versioning.dao.types.Version;
  48 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  49 import org.openecomp.sdc.versioning.types.Item;
  50 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  51 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  52 import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
  53 import org.openecomp.sdcrests.item.types.ItemCreationDto;
  54 import org.openecomp.sdcrests.item.types.ItemDto;
  55 import org.openecomp.sdc.versioning.types.ItemStatus;
  56 import org.openecomp.sdcrests.item.types.VersionDto;
  57 import org.openecomp.sdcrests.vendorlicense.rest.VendorLicenseModels;
  58 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelEntityToDto;
  59 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity;
  60 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto;
  61 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelEntityDto;
  62 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelRequestDto;
  63 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  64 import org.springframework.context.annotation.Scope;
  65 import org.springframework.stereotype.Service;
  66 import org.springframework.validation.annotation.Validated;
  67
  68 import javax.inject.Named;
  69 import javax.ws.rs.core.Response;
  70 import java.util.*;
  71 import java.util.function.Predicate;
  72 import java.util.stream.Collectors;
  73
  74 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  75 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  76 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  77 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.SUBMIT_DESCRIPTION;
  78 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_ID;
  79 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_NAME;
  80 import static org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto.VendorLicenseModelAction.Submit;
  81
  82 @Named
  83 @Service("vendorLicenseModels")
  84 @Scope(value = "prototype")
  85 @Validated
  86 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  87
  88   private static final String SUBMIT_ITEM_ACTION = "Submit_Item";
  89   private static final String SUBMIT_HEALED_VERSION_ERROR =
  90       "VLM Id %s: Error while submitting version %s created based on Certified version %s for healing purpose.";
  91   private static final Logger LOGGER = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  92   private PermissionsManager permissionsManager = PermissionsManagerFactory.getInstance()
  93       .createInterface();
  94   private NotificationPropagationManager notifier =
  95       NotificationPropagationManagerFactory.getInstance().createInterface();
  96
  97   private AsdcItemManager asdcItemManager = AsdcItemManagerFactory.getInstance().createInterface();
  98   private VersioningManager versioningManager =
  99       VersioningManagerFactory.getInstance().createInterface();
 100   private VendorLicenseManager vendorLicenseManager =
 101       VendorLicenseManagerFactory.getInstance().createInterface();
 102   private ActivityLogManager activityLogManager =
 103       ActivityLogManagerFactory.getInstance().createInterface();
 104   private UniqueValueUtil uniqueValueUtil = new UniqueValueUtil(UniqueValueDaoFactory.getInstance()
 105       .createInterface());
 106
 107   @Override
 108   public Response listLicenseModels(String versionStatus,String itemStatus, String user) {
 109     Predicate<Item> itemPredicate = createItemPredicate(versionStatus, itemStatus, user);
 110
 111     MapItemToDto mapper = new MapItemToDto();
 112     GenericCollectionWrapper<ItemDto> results = new GenericCollectionWrapper<>(asdcItemManager.list(itemPredicate)
 113             .stream().sorted((o1, o2) -> o2.getModificationTime().compareTo(o1.getModificationTime()))
 114             .map(item ->mapper.applyMapping(item, ItemDto.class)).collect(Collectors.toList()));
 115
 116     return Response.ok(results).build();
 117   }
 118
 119   @Override
 120   public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 121
 122     Item item = new Item();
 123     item.setType(ItemType.vlm.name());
 124     item.setOwner(user);
 125     item.setStatus(ItemStatus.ACTIVE);
 126     item.setName(request.getVendorName());
 127     item.setDescription(request.getDescription());
 128
 129     uniqueValueUtil
 130         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 131     item = asdcItemManager.create(item);
 132     uniqueValueUtil
 133         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 134
 135     Version version = versioningManager.create(item.getId(), new Version(), null);
 136
 137     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 138         .applyMapping(request, VendorLicenseModelEntity.class);
 139     vlm.setId(item.getId());
 140     vlm.setVersion(version);
 141
 142     vendorLicenseManager.createVendorLicenseModel(vlm);
 143     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 144
 145     ItemCreationDto itemCreationDto = new ItemCreationDto();
 146     itemCreationDto.setItemId(item.getId());
 147     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 148
 149     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 150         ActivityType.Create, user, true, "", ""));
 151     return Response.ok(itemCreationDto).build();
 152   }
 153
 154   @Override
 155   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 156                                      String versionId, String user) {
 157     VendorLicenseModelEntity vlm =
 158         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 159             .applyMapping(request, VendorLicenseModelEntity.class);
 160     vlm.setId(vlmId);
 161     vlm.setVersion(new Version(versionId));
 162
 163     vendorLicenseManager.updateVendorLicenseModel(vlm);
 164     return Response.ok().build();
 165   }
 166
 167   @Override
 168   public Response getLicenseModel(String vlmId, String versionId, String user) {
 169     Version version = versioningManager.get(vlmId, new Version(versionId));
 170     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 171     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 172
 173     try {
 174       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 175           .healItemVersion(vlmId, version, ItemType.vlm, false);
 176
 177       if (healedVersion.isPresent()) {
 178         vlm.setVersion(healedVersion.get());
 179         if (version.getStatus() == VersionStatus.Certified) {
 180           submitHealedVersion(vlmId, healedVersion.get(), versionId, user);
 181         }
 182       }
 183     } catch (Exception e) {
 184       LOGGER.error(
 185           String.format("Error while auto healing VLM with Id %s and version %s", vlmId, versionId),
 186           e);
 187     }
 188
 189     VendorLicenseModelEntityDto vlmDto =
 190         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 191     return Response.ok(vlmDto).build();
 192   }
 193
 194   @Override
 195   public Response deleteLicenseModel(String vlmId, String user) {
 196     Item vlm = asdcItemManager.get(vlmId);
 197
 198     if (!vlm.getType().equals(ItemType.vlm.name())){
 199       throw new CoreException((new ErrorCode.ErrorCodeBuilder()
 200               .withMessage(String.format("Vlm with id %s does not exist.",
 201                       vlmId)).build()));
 202     }
 203
 204     Integer certifiedVersionsCounter = vlm.getVersionStatusCounters().get(VersionStatus.Certified);
 205     if (Objects.isNull(certifiedVersionsCounter) || certifiedVersionsCounter == 0) {
 206       asdcItemManager.delete(vlm);
 207       permissionsManager.deleteItemPermissions(vlmId);
 208       uniqueValueUtil
 209           .deleteUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, vlm.getName());
 210       notifyUsers(vlmId, vlm.getName(), null, null, user,
 211           NotificationEventTypes.DELETE);
 212
 213       return Response.ok().build();
 214     } else {
 215       return Response.status(Response.Status.FORBIDDEN)
 216           .entity(new Exception(Messages.DELETE_VLM_ERROR.getErrorMessage())).build();
 217     }
 218   }
 219
 220   @Override
 221   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 222                                     String versionId, String user) {
 223     Version version = new Version(versionId);
 224
 225     if (request.getAction() == Submit) {
 226       if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM_ACTION)) {
 227         return Response.status(Response.Status.FORBIDDEN)
 228             .entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 229       }
 230       String message =
 231           request.getSubmitRequest() == null ? "Submit" : request.getSubmitRequest().getMessage();
 232       submit(vlmId, version, message, user);
 233
 234       notifyUsers(vlmId, null, version, message, user, NotificationEventTypes.SUBMIT);
 235
 236     }
 237     return Response.ok().build();
 238   }
 239
 240   private void submit(String vlmId, Version version, String message, String user) {
 241
 242     vendorLicenseManager.validate(vlmId, version);
 243     versioningManager.submit(vlmId, version, message);
 244
 245     activityLogManager.logActivity(
 246         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 247   }
 248
 249   private void submitHealedVersion(String vlmId, Version healedVersion, String baseVersionId,
 250                                    String user) {
 251     try {
 252       submit(vlmId, healedVersion, "Submit after heal", user);
 253     } catch (Exception ex) {
 254       LOGGER.error(
 255           String.format(SUBMIT_HEALED_VERSION_ERROR, vlmId, healedVersion.getId(), baseVersionId),
 256           ex);
 257     }
 258   }
 259
 260   private void notifyUsers(String itemId, String itemName, Version version, String message,
 261                            String userName, NotificationEventTypes eventType) {
 262     Map<String, Object> eventProperties = new HashMap<>();
 263     eventProperties.put(ITEM_NAME, itemName == null ? asdcItemManager.get(itemId).getName() : itemName);
 264     eventProperties.put(ITEM_ID, itemId);
 265
 266     if (version != null) {
 267       eventProperties.put(VERSION_NAME, version.getName() == null
 268           ? versioningManager.get(itemId, version).getName()
 269           : version.getName());
 270       eventProperties.put(VERSION_ID, version.getId());
 271     }
 272
 273     eventProperties.put(SUBMIT_DESCRIPTION, message);
 274     eventProperties.put(PERMISSION_USER, userName);
 275
 276     Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 277     try {
 278       notifier.notifySubscribers(syncEvent, userName);
 279     } catch (Exception e) {
 280       LOGGER.error("Failed to send sync notification to users subscribed o item '" + itemId);
 281     }
 282   }
 283
 284   private class SyncEvent implements Event {
 285
 286     private String eventType;
 287     private String originatorId;
 288     private Map<String, Object> attributes;
 289     private String entityId;
 290
 291     SyncEvent(String eventType, String originatorId,
 292               Map<String, Object> attributes, String entityId) {
 293       this.eventType = eventType;
 294       this.originatorId = originatorId;
 295       this.attributes = attributes;
 296       this.entityId = entityId;
 297     }
 298
 299     @Override
 300     public String getEventType() {
 301       return eventType;
 302     }
 303
 304     @Override
 305     public String getOriginatorId() {
 306       return originatorId;
 307     }
 308
 309     @Override
 310     public Map<String, Object> getAttributes() {
 311       return attributes;
 312     }
 313
 314     @Override
 315     public String getEntityId() {
 316       return entityId;
 317     }
 318   }
 319
 320   private boolean userHasPermission(String itemId, String userId) {
 321     String permission = permissionsManager.getUserItemPermission(itemId, userId);
 322     return (permission != null && permission
 323         .matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name()));
 324   }
 325
 326   private Predicate<Item> createItemPredicate(String versionStatus,
 327                                               String itemStatus,
 328                                               String user) {
 329     Predicate<Item> itemPredicate = item -> ItemType.vlm.name().equals(item.getType());
 330
 331     if (ItemStatus.ARCHIVED.name().equals(itemStatus)) {
 332       itemPredicate = itemPredicate.and(item -> ItemStatus.ARCHIVED.equals(item.getStatus()));
 333     } else {
 334       itemPredicate = itemPredicate.and(item -> ItemStatus.ACTIVE.equals(item.getStatus()));
 335
 336       if (VersionStatus.Certified.name().equals(versionStatus)) {
 337         itemPredicate = itemPredicate
 338                 .and(item -> item.getVersionStatusCounters().containsKey(VersionStatus.Certified));
 339
 340       } else if (VersionStatus.Draft.name().equals(versionStatus)) {
 341         itemPredicate = itemPredicate.and(
 342                 item -> item.getVersionStatusCounters().containsKey(VersionStatus.Draft)
 343                         &&  userHasPermission(item.getId(), user));
 344       }
 345     }
 346     return itemPredicate;
 347   }
 348
 349 }