src/main/java/org/onap/aai/babel/xml/generator/api/AaiArtifactGenerator.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2019 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.aai.babel.xml.generator.api;
  23
  24 import java.io.IOException;
  25 import java.nio.file.Files;
  26 import java.nio.file.Path;
  27 import java.util.ArrayList;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Optional;
  31 import org.apache.commons.io.FileUtils;
  32 import org.apache.commons.lang3.StringUtils;
  33 import org.onap.aai.babel.logging.ApplicationMsgs;
  34 import org.onap.aai.babel.logging.LogHelper;
  35 import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
  36 import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
  37 import org.onap.aai.babel.xml.generator.data.AdditionalParams;
  38 import org.onap.aai.babel.xml.generator.data.Artifact;
  39 import org.onap.aai.babel.xml.generator.data.ArtifactType;
  40 import org.onap.aai.babel.xml.generator.data.GenerationData;
  41 import org.onap.aai.babel.xml.generator.data.GeneratorUtil;
  42 import org.onap.aai.babel.xml.generator.data.GroupType;
  43 import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
  44 import org.onap.aai.babel.xml.generator.model.Model;
  45 import org.onap.aai.babel.xml.generator.model.Resource;
  46 import org.onap.aai.babel.xml.generator.model.Service;
  47 import org.onap.aai.babel.xml.generator.model.Widget;
  48 import org.onap.aai.babel.xml.generator.model.Widget.Type;
  49 import org.onap.aai.babel.xml.generator.types.ModelType;
  50 import org.onap.aai.cl.api.Logger;
  51 import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
  52 import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException;
  53 import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
  54 import org.onap.sdc.toscaparser.api.Group;
  55 import org.onap.sdc.toscaparser.api.NodeTemplate;
  56 import org.onap.sdc.toscaparser.api.elements.Metadata;
  57 import org.slf4j.MDC;
  58
  59 public class AaiArtifactGenerator implements ArtifactGenerator {
  60
  61     private static Logger log = LogHelper.INSTANCE;
  62
  63     private static final String MDC_PARAM_MODEL_INFO = "ARTIFACT_MODEL_INFO";
  64     private static final String GENERATOR_AAI_GENERATED_ARTIFACT_EXTENSION = "xml";
  65     private static final String GENERATOR_AAI_ERROR_MISSING_SERVICE_TOSCA =
  66             "Service tosca missing from list of input artifacts";
  67     private static final String GENERATOR_AAI_ERROR_MISSING_SERVICE_VERSION =
  68             "Cannot generate artifacts. Service version is not specified";
  69     private static final String GENERATOR_AAI_INVALID_SERVICE_VERSION =
  70             "Cannot generate artifacts. Service version is incorrect";
  71
  72     private AaiModelGenerator modelGenerator = new AaiModelGeneratorImpl();
  73
  74     @Override
  75     public GenerationData generateArtifact(byte[] csarArchive, List<Artifact> input,
  76             Map<String, String> additionalParams) {
  77         String configLocation = System.getProperty(ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE);
  78         if (configLocation == null) {
  79             throw new IllegalArgumentException(
  80                     String.format(ArtifactGeneratorToscaParser.GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND,
  81                             ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE));
  82         }
  83
  84         try {
  85             ArtifactGeneratorToscaParser.initWidgetConfiguration();
  86             ArtifactGeneratorToscaParser.initToscaMappingsConfiguration(configLocation);
  87         } catch (IOException e) {
  88             log.error(ApplicationMsgs.LOAD_PROPERTIES, e, configLocation);
  89             return createErrorData(e);
  90         }
  91
  92         Path csarPath;
  93
  94         try {
  95             csarPath = createTempFile(csarArchive);
  96         } catch (IOException e) {
  97             log.error(ApplicationMsgs.TEMP_FILE_ERROR, e);
  98             return createErrorData(e);
  99         }
 100
 101         try {
 102             ISdcCsarHelper csarHelper =
 103                     SdcToscaParserFactory.getInstance().getSdcCsarHelper(csarPath.toAbsolutePath().toString());
 104             return generateAllArtifacts(validateServiceVersion(additionalParams), csarHelper);
 105         } catch (SdcToscaParserException | XmlArtifactGenerationException e) {
 106             log.error(ApplicationMsgs.INVALID_CSAR_FILE, e);
 107             return createErrorData(e);
 108         } finally {
 109             FileUtils.deleteQuietly(csarPath.toFile());
 110         }
 111     }
 112
 113     private GenerationData createErrorData(Exception e) {
 114         GenerationData generationData = new GenerationData();
 115         generationData.add(ArtifactType.AAI.name(), e.getMessage());
 116         return generationData;
 117     }
 118
 119     /**
 120      * Generate model artifacts for the Service and its associated Resources.
 121      *
 122      * @param serviceVersion
 123      * @param csarHelper
 124      *            interface to the TOSCA parser
 125      * @return the generated Artifacts (containing XML models)
 126      * @throws XmlArtifactGenerationException
 127      */
 128     private GenerationData generateAllArtifacts(final String serviceVersion, ISdcCsarHelper csarHelper)
 129             throws XmlArtifactGenerationException {
 130         List<NodeTemplate> serviceNodeTemplates = csarHelper.getServiceNodeTemplates();
 131         if (serviceNodeTemplates == null) {
 132             throw new IllegalArgumentException(GENERATOR_AAI_ERROR_MISSING_SERVICE_TOSCA);
 133         }
 134
 135         Service serviceModel = createServiceModel(serviceVersion, csarHelper.getServiceMetadataAllProperties());
 136
 137         MDC.put(MDC_PARAM_MODEL_INFO, serviceModel.getModelName() + "," + getArtifactLabel(serviceModel));
 138
 139         List<Resource> resources = generateResourceModels(csarHelper, serviceNodeTemplates, serviceModel);
 140
 141         // Generate the A&AI XML model for the Service.
 142         final String serviceArtifact = modelGenerator.generateModelFor(serviceModel);
 143
 144         // Build a Babel Artifact to be returned to the caller.
 145         GenerationData generationData = new GenerationData();
 146         generationData.add(getServiceArtifact(serviceModel, serviceArtifact));
 147
 148         // For each Resource, generate the A&AI XML model and then create an additional Artifact for that model.
 149         for (Resource resource : resources) {
 150             generateResourceArtifact(generationData, resource);
 151             for (Resource childResource : resource.getResources()) {
 152                 boolean isProvidingService =
 153                         (boolean) Optional.ofNullable(childResource.getProperties().get("providingService")) //
 154                                 .orElse(false);
 155                 if (!isProvidingService) {
 156                     generateResourceArtifact(generationData, childResource);
 157                 }
 158             }
 159         }
 160
 161         return generationData;
 162     }
 163
 164     /**
 165      * Create a Service from the provided metadata
 166      *
 167      * @param serviceVersion
 168      * @param properties
 169      * @return
 170      */
 171     private Service createServiceModel(final String serviceVersion, Map<String, String> properties) {
 172         log.debug("Processing (TOSCA) Service object");
 173         Service serviceModel = new Service();
 174         serviceModel.setModelVersion(serviceVersion);
 175         serviceModel.populateModelIdentificationInformation(properties);
 176         return serviceModel;
 177     }
 178
 179     /**
 180      * @param csarHelper
 181      * @param serviceNodeTemplates
 182      * @param serviceModel
 183      * @return the generated Models
 184      * @throws XmlArtifactGenerationException
 185      */
 186     private List<Resource> generateResourceModels(ISdcCsarHelper csarHelper, List<NodeTemplate> serviceNodeTemplates,
 187             Service serviceModel) throws XmlArtifactGenerationException {
 188         final List<Group> serviceGroups = csarHelper.getGroupsOfTopologyTemplate();
 189         final ArtifactGeneratorToscaParser parser = new ArtifactGeneratorToscaParser(csarHelper);
 190
 191         List<Resource> resources = new ArrayList<>();
 192
 193         for (NodeTemplate nodeTemplate : serviceNodeTemplates) {
 194             if (nodeTemplate.getMetaData() != null) {
 195                 generateModelFromNodeTemplate(csarHelper, serviceModel, resources, serviceGroups, parser, nodeTemplate);
 196             } else {
 197                 log.warn(ApplicationMsgs.MISSING_SERVICE_METADATA, nodeTemplate.getName());
 198             }
 199         }
 200
 201         return resources;
 202     }
 203
 204     private void generateModelFromNodeTemplate(ISdcCsarHelper csarHelper, Service serviceModel,
 205             List<Resource> resources, final List<Group> serviceGroups, ArtifactGeneratorToscaParser parser,
 206             NodeTemplate nodeTemplate) throws XmlArtifactGenerationException {
 207         Resource model = getModelFor(parser, nodeTemplate);
 208
 209         if (model != null) {
 210             if (nodeTemplate.getMetaData() != null) {
 211                 model.populateModelIdentificationInformation(nodeTemplate.getMetaData().getAllProperties());
 212             }
 213
 214             parser.addRelatedModel(serviceModel, model);
 215             if (model.getModelType() == ModelType.RESOURCE) {
 216                 generateResourceModel(csarHelper, resources, parser, nodeTemplate);
 217             }
 218         } else {
 219             for (Group group : serviceGroups) {
 220                 ArrayList<String> members = group.getMembers();
 221                 if (members != null && members.contains(nodeTemplate.getName())
 222                         && WidgetConfigurationUtil.isSupportedInstanceGroup(group.getType())) {
 223                     log.debug(String.format("Adding group %s (type %s) with members %s", group.getName(),
 224                             group.getType(), members));
 225
 226                     Resource groupModel = parser.createInstanceGroupModel(
 227                             parser.mergeProperties(group.getMetadata().getAllProperties(), group.getProperties()));
 228                     serviceModel.addResource(groupModel);
 229                     resources.add(groupModel);
 230                 }
 231             }
 232         }
 233     }
 234
 235     private Resource getModelFor(ArtifactGeneratorToscaParser parser, NodeTemplate nodeTemplate) {
 236         String nodeTypeName = nodeTemplate.getType();
 237
 238         log.debug("Processing resource " + nodeTypeName + ": " + nodeTemplate.getMetaData().getValue("UUID"));
 239
 240         Resource model = Model.getModelFor(nodeTypeName, nodeTemplate.getMetaData().getValue("type"));
 241
 242         if (model != null) {
 243             Metadata metadata = nodeTemplate.getMetaData();
 244             if (metadata != null && parser.hasAllottedResource(metadata.getAllProperties())
 245                     && model.getWidgetType() == Type.VF) {
 246                 model = new Resource(Type.ALLOTTED_RESOURCE, true);
 247             }
 248         }
 249
 250         return model;
 251     }
 252
 253     private void generateResourceModel(ISdcCsarHelper csarHelper, List<Resource> resources,
 254             ArtifactGeneratorToscaParser parser, NodeTemplate nodeTemplate) throws XmlArtifactGenerationException {
 255         Resource resourceModel = getModelFor(parser, nodeTemplate);
 256         if (resourceModel == null) {
 257             log.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Could not generate resource model");
 258             return;
 259         }
 260
 261         Map<String, String> serviceMetadata = nodeTemplate.getMetaData().getAllProperties();
 262         resourceModel.populateModelIdentificationInformation(serviceMetadata);
 263
 264         parser.processResourceModels(resourceModel, csarHelper.getNodeTemplateChildren(nodeTemplate));
 265
 266         if (csarHelper.getServiceVfList() != null) {
 267             parser.processVfModules(resources, resourceModel, nodeTemplate);
 268         }
 269
 270         if (parser.hasSubCategoryTunnelXConnect(serviceMetadata) && parser.hasAllottedResource(serviceMetadata)) {
 271             resourceModel.addWidget(Widget.getWidget(Type.TUNNEL_XCONNECT));
 272         }
 273
 274         resources.addAll(parser.processInstanceGroups(resourceModel, nodeTemplate));
 275         resources.add((Resource) resourceModel);
 276     }
 277
 278     /**
 279      * @param generationData
 280      * @param resource
 281      * @throws XmlArtifactGenerationException
 282      */
 283     private void generateResourceArtifact(GenerationData generationData, Resource resource)
 284             throws XmlArtifactGenerationException {
 285         if (!isContained(generationData, getArtifactName(resource))) {
 286             log.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Generating resource model");
 287             generationData.add(getResourceArtifact(resource, modelGenerator.generateModelFor(resource)));
 288         }
 289     }
 290
 291     private Path createTempFile(byte[] bytes) throws IOException {
 292         log.debug("Creating temp file on file system for the csar");
 293         Path path = Files.createTempFile("temp", ".csar");
 294         Files.write(path, bytes);
 295         return path;
 296     }
 297
 298     /**
 299      * Create the artifact label for an AAI model.
 300      *
 301      * @param model
 302      * @return the artifact label as String
 303      */
 304     private String getArtifactLabel(Model model) {
 305         StringBuilder artifactName = new StringBuilder(ArtifactType.AAI.name());
 306         artifactName.append("-");
 307         artifactName.append(model.getModelTypeName());
 308         artifactName.append("-");
 309         artifactName.append(hashCodeUuId(model.getModelNameVersionId()));
 310         return (artifactName.toString()).replaceAll("[^a-zA-Z0-9 +]+", "-");
 311     }
 312
 313     /**
 314      * Method to generate the artifact name for an AAI model.
 315      *
 316      * @param model
 317      *            AAI artifact model
 318      * @return Model artifact name
 319      */
 320     private String getArtifactName(Model model) {
 321         StringBuilder artifactName = new StringBuilder(ArtifactType.AAI.name());
 322         artifactName.append("-");
 323
 324         String truncatedArtifactName = truncateName(model.getModelName());
 325         artifactName.append(truncatedArtifactName);
 326
 327         artifactName.append("-");
 328         artifactName.append(model.getModelTypeName());
 329         artifactName.append("-");
 330         artifactName.append(model.getModelVersion());
 331
 332         artifactName.append(".");
 333         artifactName.append(GENERATOR_AAI_GENERATED_ARTIFACT_EXTENSION);
 334         return artifactName.toString();
 335     }
 336
 337     /**
 338      * Create Resource artifact model from the AAI xml model string.
 339      *
 340      * @param resourceModel
 341      *            Model of the resource artifact
 342      * @param aaiResourceModel
 343      *            AAI model as string
 344      * @return Generated {@link Artifact} model for the resource
 345      */
 346     private Artifact getResourceArtifact(Resource resourceModel, String aaiResourceModel) {
 347         final String resourceArtifactLabel = getArtifactLabel(resourceModel);
 348         MDC.put(MDC_PARAM_MODEL_INFO, resourceModel.getModelName() + "," + resourceArtifactLabel);
 349         final byte[] bytes = aaiResourceModel.getBytes();
 350
 351         Artifact artifact = new Artifact(ArtifactType.MODEL_INVENTORY_PROFILE.name(), GroupType.DEPLOYMENT.name(),
 352                 GeneratorUtil.checkSum(bytes), GeneratorUtil.encode(bytes));
 353         artifact.setName(getArtifactName(resourceModel));
 354         artifact.setLabel(resourceArtifactLabel);
 355         artifact.setDescription("AAI Resource Model");
 356         return artifact;
 357     }
 358
 359     /**
 360      * @param generationData
 361      * @param artifactName
 362      * @return
 363      */
 364     private boolean isContained(GenerationData generationData, final String artifactName) {
 365         return generationData.getResultData().stream()
 366                 .anyMatch(artifact -> StringUtils.equals(artifact.getName(), artifactName));
 367     }
 368
 369     /**
 370      * Create Service artifact model from the AAI XML model.
 371      *
 372      * @param serviceModel
 373      *            Model of the service artifact
 374      * @param aaiServiceModel
 375      *            AAI model as string
 376      * @return Generated {@link Artifact} model for the service
 377      */
 378     private Artifact getServiceArtifact(Service serviceModel, String aaiServiceModel) {
 379         Artifact artifact = new Artifact(ArtifactType.MODEL_INVENTORY_PROFILE.name(), GroupType.DEPLOYMENT.name(),
 380                 GeneratorUtil.checkSum(aaiServiceModel.getBytes()), GeneratorUtil.encode(aaiServiceModel.getBytes()));
 381         String serviceArtifactName = getArtifactName(serviceModel);
 382         String serviceArtifactLabel = getArtifactLabel(serviceModel);
 383         artifact.setName(serviceArtifactName);
 384         artifact.setLabel(serviceArtifactLabel);
 385         artifact.setDescription("AAI Service Model");
 386         return artifact;
 387     }
 388
 389     private int hashCodeUuId(String uuId) {
 390         int hashcode = 0;
 391         for (int i = 0; i < uuId.length(); i++) {
 392             hashcode = 31 * hashcode + uuId.charAt(i);
 393         }
 394         return hashcode;
 395     }
 396
 397     private String truncateName(String name) {
 398         String truncatedName = name;
 399         if (name.length() >= 200) {
 400             truncatedName = name.substring(0, 199);
 401         }
 402         return truncatedName;
 403     }
 404
 405     private String validateServiceVersion(Map<String, String> additionalParams) {
 406         String serviceVersion = additionalParams.get(AdditionalParams.SERVICE_VERSION.getName());
 407         if (serviceVersion == null) {
 408             throw new IllegalArgumentException(GENERATOR_AAI_ERROR_MISSING_SERVICE_VERSION);
 409         } else {
 410             String versionRegex = "^[1-9]\\d*(\\.0)$";
 411             if (!(serviceVersion.matches(versionRegex))) {
 412                 throw new IllegalArgumentException(String.format(GENERATOR_AAI_INVALID_SERVICE_VERSION));
 413             }
 414         }
 415         return serviceVersion;
 416     }
 417 }