catalog-be/src/main/java/org/openecomp/sdc/be/components/distribution/engine/ServiceDistributionArtifactsBuilder.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 package org.openecomp.sdc.be.components.distribution.engine;
  21
  22 import fj.data.Either;
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Optional;
  27 import java.util.stream.Collectors;
  28 import org.apache.commons.collections.CollectionUtils;
  29 import org.apache.commons.collections.MapUtils;
  30 import org.openecomp.sdc.be.config.ConfigurationManager;
  31 import org.openecomp.sdc.be.model.ArtifactDefinition;
  32 import org.openecomp.sdc.be.model.ComponentInstance;
  33 import org.openecomp.sdc.be.model.ComponentParametersView;
  34 import org.openecomp.sdc.be.model.Resource;
  35 import org.openecomp.sdc.be.model.Service;
  36 import org.openecomp.sdc.be.model.category.CategoryDefinition;
  37 import org.openecomp.sdc.be.model.category.SubCategoryDefinition;
  38 import org.openecomp.sdc.be.model.jsonjanusgraph.operations.ToscaOperationFacade;
  39 import org.openecomp.sdc.be.model.operations.impl.ArtifactOperation;
  40 import org.openecomp.sdc.be.model.operations.impl.InterfaceLifecycleOperation;
  41 import org.openecomp.sdc.common.api.ArtifactTypeEnum;
  42 import org.openecomp.sdc.common.log.wrappers.Logger;
  43 import org.springframework.beans.factory.annotation.Autowired;
  44 import org.springframework.stereotype.Component;
  45
  46 @Component("serviceDistributionArtifactsBuilder")
  47 public class ServiceDistributionArtifactsBuilder {
  48
  49     private static final Logger logger = Logger.getLogger(ServiceDistributionArtifactsBuilder.class.getName());
  50     private static final String BASE_ARTIFACT_URL = "/sdc/v1/catalog/services/%s/%s/";
  51     private static final String SERVICE_ARTIFACT_URL = BASE_ARTIFACT_URL + "artifacts/%s";
  52     private static final String RESOURCE_INSTANCE_ARTIFACT_URL = BASE_ARTIFACT_URL + "resourceInstances/%s/artifacts/%s";
  53     private final ToscaOperationFacade toscaOperationFacade;
  54     @javax.annotation.Resource
  55     InterfaceLifecycleOperation interfaceLifecycleOperation;
  56     @javax.annotation.Resource
  57     ArtifactOperation artifactOperation;
  58
  59     @Autowired
  60     public ServiceDistributionArtifactsBuilder(ToscaOperationFacade toscaOperationFacade) {
  61         this.toscaOperationFacade = toscaOperationFacade;
  62     }
  63
  64     /**
  65      * build the URL for resource instance artifact
  66      *
  67      * @param service
  68      * @param resourceInstance
  69      * @param artifactName
  70      * @return URL string
  71      */
  72     public static String buildResourceInstanceArtifactUrl(Service service, ComponentInstance resourceInstance, String artifactName) {
  73         String url = String
  74             .format(RESOURCE_INSTANCE_ARTIFACT_URL, service.getSystemName(), service.getVersion(), resourceInstance.getNormalizedName(),
  75                 artifactName);
  76         logger.debug("After building artifact url {}", url);
  77         return url;
  78     }
  79
  80     /**
  81      * build the URL for resource instance artifact
  82      *
  83      * @param service
  84      * @param artifactName
  85      * @return URL string
  86      */
  87     public static String buildServiceArtifactUrl(Service service, String artifactName) {
  88         String url = String.format(SERVICE_ARTIFACT_URL, service.getSystemName(), service.getVersion(), artifactName);
  89         logger.debug("After building artifact url {}", url);
  90         return url;
  91     }
  92
  93     public InterfaceLifecycleOperation getInterfaceLifecycleOperation() {
  94         return interfaceLifecycleOperation;
  95     }
  96
  97     public void setInterfaceLifecycleOperation(InterfaceLifecycleOperation interfaceLifecycleOperation) {
  98         this.interfaceLifecycleOperation = interfaceLifecycleOperation;
  99     }
 100
 101     private String resolveWorkloadContext(String workloadContext) {
 102         return workloadContext != null ? workloadContext : ConfigurationManager.getConfigurationManager().getConfiguration().getWorkloadContext();
 103     }
 104
 105     public INotificationData buildResourceInstanceForDistribution(Service service, String distributionId, String workloadContext) {
 106         INotificationData notificationData = new NotificationDataImpl();
 107         notificationData.setResources(convertRIsToJsonContanier(service));
 108         notificationData.setServiceName(service.getName());
 109         notificationData.setServiceVersion(service.getVersion());
 110         notificationData.setDistributionID(distributionId);
 111         notificationData.setServiceUUID(service.getUUID());
 112         notificationData.setServiceDescription(service.getDescription());
 113         notificationData.setServiceInvariantUUID(service.getInvariantUUID());
 114         workloadContext = resolveWorkloadContext(workloadContext);
 115         if (workloadContext != null) {
 116             notificationData.setWorkloadContext(workloadContext);
 117         }
 118         logger.debug("Before returning notification data object {}", notificationData);
 119         return notificationData;
 120     }
 121
 122     public INotificationData buildServiceForDistribution(INotificationData notificationData, Service service) {
 123         notificationData.setServiceArtifacts(convertServiceArtifactsToArtifactInfo(service));
 124         logger.debug("Before returning notification data object {}", notificationData);
 125         return notificationData;
 126     }
 127
 128     private List<ArtifactInfoImpl> convertServiceArtifactsToArtifactInfo(Service service) {
 129         Map<String, ArtifactDefinition> serviceArtifactsMap = service.getDeploymentArtifacts();
 130         List<ArtifactDefinition> extractedServiceArtifacts = serviceArtifactsMap.values().stream()
 131             //filters all artifacts with existing EsId
 132             .filter(ArtifactDefinition::checkEsIdExist)
 133             //collects all filtered artifacts with existing EsId to List
 134             .collect(Collectors.toList());
 135         Optional<ArtifactDefinition> toscaTemplateArtifactOptl = exrtactToscaTemplateArtifact(service);
 136         if (toscaTemplateArtifactOptl.isPresent()) {
 137             extractedServiceArtifacts.add(toscaTemplateArtifactOptl.get());
 138         }
 139         Optional<ArtifactDefinition> toscaCsarArtifactOptl = exrtactToscaCsarArtifact(service);
 140         if (toscaCsarArtifactOptl.isPresent()) {
 141             extractedServiceArtifacts.add(toscaCsarArtifactOptl.get());
 142         }
 143         return ArtifactInfoImpl.convertServiceArtifactToArtifactInfoImpl(service, extractedServiceArtifacts);
 144     }
 145
 146     private Optional<ArtifactDefinition> exrtactToscaTemplateArtifact(Service service) {
 147         return service.getToscaArtifacts().values().stream()
 148             //filters TOSCA_TEMPLATE artifact
 149             .filter(e -> e.getArtifactType().equals(ArtifactTypeEnum.TOSCA_TEMPLATE.getType())).findAny();
 150     }
 151
 152     private Optional<ArtifactDefinition> exrtactToscaCsarArtifact(Service service) {
 153         return service.getToscaArtifacts().values().stream()
 154             //filters TOSCA_CSAR artifact
 155             .filter(e -> e.getArtifactType().equals(ArtifactTypeEnum.TOSCA_CSAR.getType())).findAny();
 156     }
 157
 158     private List<JsonContainerResourceInstance> convertRIsToJsonContanier(Service service) {
 159         List<JsonContainerResourceInstance> ret = new ArrayList<>();
 160         if (service.getComponentInstances() != null) {
 161             for (ComponentInstance instance : service.getComponentInstances()) {
 162                 JsonContainerResourceInstance jsonContainer = new JsonContainerResourceInstance(instance,
 163                     convertToArtifactsInfoImpl(service, instance));
 164                 ComponentParametersView filter = new ComponentParametersView();
 165                 filter.disableAll();
 166                 filter.setIgnoreCategories(false);
 167                 toscaOperationFacade.getToscaElement(instance.getComponentUid(), filter).left().bind(r -> {
 168                     fillJsonContainer(jsonContainer, (Resource) r);
 169                     return Either.left(r);
 170                 }).right().forEach(r -> logger.debug("Resource {} Invariant UUID & Categories retrieving failed", instance.getComponentUid()));
 171                 ret.add(jsonContainer);
 172             }
 173         }
 174         return ret;
 175     }
 176
 177     private void fillJsonContainer(JsonContainerResourceInstance jsonContainer, Resource resource) {
 178         jsonContainer.setResourceInvariantUUID(resource.getInvariantUUID());
 179         setCategories(jsonContainer, resource.getCategories());
 180     }
 181
 182     private List<ArtifactInfoImpl> convertToArtifactsInfoImpl(Service service, ComponentInstance resourceInstance) {
 183         List<ArtifactInfoImpl> artifacts = ArtifactInfoImpl
 184             .convertToArtifactInfoImpl(service, resourceInstance, getArtifactsWithPayload(resourceInstance));
 185         return artifacts;
 186     }
 187
 188     private void setCategories(JsonContainerResourceInstance jsonContainer, List<CategoryDefinition> categories) {
 189         if (categories != null) {
 190             CategoryDefinition categoryDefinition = categories.get(0);
 191             if (categoryDefinition != null) {
 192                 jsonContainer.setCategory(categoryDefinition.getName());
 193                 List<SubCategoryDefinition> subcategories = categoryDefinition.getSubcategories();
 194                 if (null != subcategories) {
 195                     SubCategoryDefinition subCategoryDefinition = subcategories.get(0);
 196                     if (subCategoryDefinition != null) {
 197                         jsonContainer.setSubcategory(subCategoryDefinition.getName());
 198                     }
 199                 }
 200             }
 201         }
 202     }
 203
 204     private List<ArtifactDefinition> getArtifactsWithPayload(ComponentInstance resourceInstance) {
 205         List<ArtifactDefinition> ret = new ArrayList<>();
 206         List<ArtifactDefinition> deployableArtifacts = new ArrayList<>();
 207         if (resourceInstance.getDeploymentArtifacts() != null) {
 208             deployableArtifacts.addAll(resourceInstance.getDeploymentArtifacts().values());
 209         }
 210         for (ArtifactDefinition artifactDef : deployableArtifacts) {
 211             if (artifactDef.checkEsIdExist()) {
 212                 ret.add(artifactDef);
 213             }
 214         }
 215         return ret;
 216     }
 217
 218     /**
 219      * Verifies that the service or at least one of its instance contains deployment artifacts
 220      *
 221      * @param the service
 222      * @return boolean
 223      */
 224     public boolean verifyServiceContainsDeploymentArtifacts(Service service) {
 225         if (MapUtils.isNotEmpty(service.getDeploymentArtifacts())) {
 226             return true;
 227         }
 228         boolean contains = false;
 229         List<ComponentInstance> resourceInstances = service.getComponentInstances();
 230         if (CollectionUtils.isNotEmpty(resourceInstances)) {
 231             contains = resourceInstances.stream().anyMatch(i -> isContainsPayload(i.getDeploymentArtifacts()));
 232         }
 233         return contains;
 234     }
 235
 236     private boolean isContainsPayload(Map<String, ArtifactDefinition> deploymentArtifacts) {
 237         return deploymentArtifacts != null && deploymentArtifacts.values().stream().anyMatch(ArtifactDefinition::checkEsIdExist);
 238     }
 239 }