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