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