This enhancement will enable Babel to process artifacts of version n.n
[aai/babel.git] / src / main / java / org / onap / aai / babel / xml / generator / api / AaiArtifactGenerator.java
index 19b3d80..8da541f 100644 (file)
@@ -2,8 +2,8 @@
  * ============LICENSE_START=======================================================
  * org.onap.aai
  * ================================================================================
- * Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2017-2019 European Software Marketing Ltd.
+ * Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (c) 2017-2019 European Software Marketing Ltd.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,14 +25,18 @@ import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.stream.Collectors;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.onap.aai.babel.logging.ApplicationMsgs;
 import org.onap.aai.babel.logging.LogHelper;
 import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
+import org.onap.aai.babel.parser.ToscaParser;
+import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
 import org.onap.aai.babel.xml.generator.data.AdditionalParams;
 import org.onap.aai.babel.xml.generator.data.Artifact;
 import org.onap.aai.babel.xml.generator.data.ArtifactType;
@@ -43,10 +47,13 @@ import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
 import org.onap.aai.babel.xml.generator.model.Model;
 import org.onap.aai.babel.xml.generator.model.Resource;
 import org.onap.aai.babel.xml.generator.model.Service;
-import org.onap.aai.babel.xml.generator.model.TunnelXconnectWidget;
-import org.onap.aai.babel.xml.generator.model.Widget.Type;
+import org.onap.aai.babel.xml.generator.model.Widget;
+import org.onap.aai.babel.xml.generator.model.WidgetType;
+import org.onap.aai.babel.xml.generator.types.ModelType;
 import org.onap.aai.cl.api.Logger;
 import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
+import org.onap.sdc.tosca.parser.enums.SdcTypes;
+import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException;
 import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
 import org.onap.sdc.toscaparser.api.Group;
 import org.onap.sdc.toscaparser.api.NodeTemplate;
@@ -66,11 +73,25 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
     private static final String GENERATOR_AAI_INVALID_SERVICE_VERSION =
             "Cannot generate artifacts. Service version is incorrect";
 
-    private AaiModelGenerator modelGenerator = new AaiModelGeneratorImpl();
+    private AaiModelGenerator modelGenerator = new AaiModelGenerator();
 
     @Override
     public GenerationData generateArtifact(byte[] csarArchive, List<Artifact> input,
             Map<String, String> additionalParams) {
+        String configLocation = System.getProperty(ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE);
+        if (configLocation == null) {
+            throw new IllegalArgumentException(
+                    String.format(ArtifactGeneratorToscaParser.GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND,
+                            ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE));
+        }
+
+        try {
+            ArtifactGeneratorToscaParser.initToscaMappingsConfiguration(configLocation);
+        } catch (IOException e) {
+            log.error(ApplicationMsgs.LOAD_PROPERTIES, e, configLocation);
+            return createErrorData(e);
+        }
+
         Path csarPath;
 
         try {
@@ -80,20 +101,11 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
             return createErrorData(e);
         }
 
-        String configLocation = System.getProperty(ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE);
-        if (configLocation == null) {
-            throw new IllegalArgumentException(
-                    String.format(ArtifactGeneratorToscaParser.GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND,
-                            ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE));
-        }
-
         try {
-            ArtifactGeneratorToscaParser.initWidgetConfiguration();
-            ArtifactGeneratorToscaParser.initToscaMappingsConfiguration(configLocation);
             ISdcCsarHelper csarHelper =
                     SdcToscaParserFactory.getInstance().getSdcCsarHelper(csarPath.toAbsolutePath().toString());
             return generateAllArtifacts(validateServiceVersion(additionalParams), csarHelper);
-        } catch (Exception e) {
+        } catch (SdcToscaParserException | ClassCastException | XmlArtifactGenerationException e) {
             log.error(ApplicationMsgs.INVALID_CSAR_FILE, e);
             return createErrorData(e);
         } finally {
@@ -114,18 +126,16 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
      * @param csarHelper
      *            interface to the TOSCA parser
      * @return the generated Artifacts (containing XML models)
+     * @throws XmlArtifactGenerationException
+     *             if the configured widget mappings do not support processed widget type(s)
      */
-    private GenerationData generateAllArtifacts(final String serviceVersion, ISdcCsarHelper csarHelper) {
-        List<NodeTemplate> serviceNodeTemplates = csarHelper.getServiceNodeTemplates();
-        if (serviceNodeTemplates == null) {
-            throw new IllegalArgumentException(GENERATOR_AAI_ERROR_MISSING_SERVICE_TOSCA);
-        }
-
+    public GenerationData generateAllArtifacts(final String serviceVersion, ISdcCsarHelper csarHelper)
+            throws XmlArtifactGenerationException {
         Service serviceModel = createServiceModel(serviceVersion, csarHelper.getServiceMetadataAllProperties());
 
         MDC.put(MDC_PARAM_MODEL_INFO, serviceModel.getModelName() + "," + getArtifactLabel(serviceModel));
 
-        List<Resource> resources = generateResourceModels(csarHelper, serviceNodeTemplates, serviceModel);
+        List<Resource> resources = generateResourceModels(csarHelper, serviceModel);
 
         // Generate the A&AI XML model for the Service.
         final String serviceArtifact = modelGenerator.generateModelFor(serviceModel);
@@ -167,17 +177,22 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
 
     /**
      * @param csarHelper
-     * @param serviceNodeTemplates
      * @param serviceModel
      * @return the generated Models
+     * @throws XmlArtifactGenerationException
+     *             if the configured widget mappings do not support processed widget type(s)
      */
-    private List<Resource> generateResourceModels(ISdcCsarHelper csarHelper, List<NodeTemplate> serviceNodeTemplates,
-            Service serviceModel) {
-        final List<Group> serviceGroups = csarHelper.getGroupsOfTopologyTemplate();
-        final ArtifactGeneratorToscaParser parser = new ArtifactGeneratorToscaParser(csarHelper);
+    private List<Resource> generateResourceModels(ISdcCsarHelper csarHelper, Service serviceModel)
+            throws XmlArtifactGenerationException {
+        List<NodeTemplate> serviceNodeTemplates =
+                ToscaParser.getServiceNodeTemplates(csarHelper).collect(Collectors.toList());
+        if (serviceNodeTemplates == null) {
+            throw new IllegalArgumentException(GENERATOR_AAI_ERROR_MISSING_SERVICE_TOSCA);
+        }
 
+        final ArtifactGeneratorToscaParser parser = new ArtifactGeneratorToscaParser(csarHelper);
         List<Resource> resources = new ArrayList<>();
-
+        final List<Group> serviceGroups = ToscaParser.getServiceLevelGroups(csarHelper);
         for (NodeTemplate nodeTemplate : serviceNodeTemplates) {
             if (nodeTemplate.getMetaData() != null) {
                 generateModelFromNodeTemplate(csarHelper, serviceModel, resources, serviceGroups, parser, nodeTemplate);
@@ -189,9 +204,19 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
         return resources;
     }
 
+    /**
+     * @param csarHelper
+     * @param serviceModel
+     * @param resources
+     * @param serviceGroups
+     * @param parser
+     * @param nodeTemplate
+     * @throws XmlArtifactGenerationException
+     *             if the configured widget mappings do not support processed widget type(s)
+     */
     private void generateModelFromNodeTemplate(ISdcCsarHelper csarHelper, Service serviceModel,
             List<Resource> resources, final List<Group> serviceGroups, ArtifactGeneratorToscaParser parser,
-            NodeTemplate nodeTemplate) {
+            NodeTemplate nodeTemplate) throws XmlArtifactGenerationException {
         Resource model = getModelFor(parser, nodeTemplate);
 
         if (model != null) {
@@ -200,7 +225,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
             }
 
             parser.addRelatedModel(serviceModel, model);
-            if (model.isResource()) {
+            if (model.getModelType() == ModelType.RESOURCE) {
                 generateResourceModel(csarHelper, resources, parser, nodeTemplate);
             }
         } else {
@@ -229,41 +254,79 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
 
         if (model != null) {
             Metadata metadata = nodeTemplate.getMetaData();
-            if (metadata != null && parser.hasAllottedResource(metadata.getAllProperties())) {
-                if (model.getWidgetType() == Type.VF) {
-                    model = new Resource(Type.ALLOTTED_RESOURCE, true);
-                }
+            if (metadata != null && parser.hasAllottedResource(metadata.getAllProperties())
+                    && model.hasWidgetType("VF")) {
+                model = new Resource(WidgetType.valueOf("ALLOTTED_RESOURCE"), true);
             }
         }
 
         return model;
     }
 
+    /**
+     * @param csarHelper
+     * @param resources
+     * @param parser
+     * @param serviceVfNode
+     *            a VF resource Node Template
+     * @throws XmlArtifactGenerationException
+     *             if the configured widget mappings do not support processed widget type(s)
+     */
     private void generateResourceModel(ISdcCsarHelper csarHelper, List<Resource> resources,
-            ArtifactGeneratorToscaParser parser, NodeTemplate nodeTemplate) {
-        Resource resourceModel = getModelFor(parser, nodeTemplate);
-        Map<String, String> serviceMetadata = nodeTemplate.getMetaData().getAllProperties();
+            ArtifactGeneratorToscaParser parser, NodeTemplate serviceVfNode) throws XmlArtifactGenerationException {
+        Resource resourceModel = getModelFor(parser, serviceVfNode);
+        if (resourceModel == null) {
+            log.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Could not generate resource model");
+            return;
+        }
+
+        Map<String, String> serviceMetadata = serviceVfNode.getMetaData().getAllProperties();
         resourceModel.populateModelIdentificationInformation(serviceMetadata);
 
-        parser.processResourceModels(resourceModel, csarHelper.getNodeTemplateChildren(nodeTemplate));
+        parser.processResourceModels(resourceModel, getNonVnfChildren(serviceVfNode));
 
-        if (csarHelper.getServiceVfList() != null) {
-            parser.processVfModules(resources, resourceModel, nodeTemplate);
+        List<NodeTemplate> serviceVfList = ToscaParser.getServiceNodeTemplates(csarHelper)
+                .filter(ToscaParser.filterOnType(SdcTypes.VF)).collect(Collectors.toList());
+
+        if (serviceVfList != null) {
+            parser.processVfModules(resources, resourceModel, serviceVfNode);
         }
 
         if (parser.hasSubCategoryTunnelXConnect(serviceMetadata) && parser.hasAllottedResource(serviceMetadata)) {
-            resourceModel.addWidget(new TunnelXconnectWidget());
+            resourceModel.addWidget(Widget.createWidget("TUNNEL_XCONNECT"));
         }
 
-        resources.addAll(parser.processInstanceGroups(resourceModel, nodeTemplate));
-        resources.add((Resource) resourceModel);
+        resources.addAll(parser.processInstanceGroups(resourceModel, serviceVfNode));
+        resources.add(resourceModel);
+    }
+
+    /**
+     * Return all child Node Templates (via Substitution Mappings) that do not have a type ending VnfConfiguration.
+     *
+     * @param nodeTemplate
+     *            the parent Node Template
+     * @return the child Node Templates which are not a VNF Configuration type
+     */
+    private List<NodeTemplate> getNonVnfChildren(NodeTemplate nodeTemplate) {
+        return Optional.ofNullable(nodeTemplate.getSubMappingToscaTemplate()) //
+                .map(sm -> Optional.ofNullable(sm.getNodeTemplates())
+                        .map(nts -> nts.stream().filter(nt -> !isVNFType(nt)) //
+                                .collect(Collectors.toList()))
+                        .orElse(Collections.emptyList()))
+                .orElse(Collections.emptyList());
+    }
+
+    private boolean isVNFType(NodeTemplate nt) {
+        return nt.getType().endsWith("VnfConfiguration");
     }
 
     /**
      * @param generationData
      * @param resource
+     * @throws XmlArtifactGenerationException
      */
-    private void generateResourceArtifact(GenerationData generationData, Resource resource) {
+    private void generateResourceArtifact(GenerationData generationData, Resource resource)
+            throws XmlArtifactGenerationException {
         if (!isContained(generationData, getArtifactName(resource))) {
             log.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Generating resource model");
             generationData.add(getResourceArtifact(resource, modelGenerator.generateModelFor(resource)));
@@ -286,7 +349,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
     private String getArtifactLabel(Model model) {
         StringBuilder artifactName = new StringBuilder(ArtifactType.AAI.name());
         artifactName.append("-");
-        artifactName.append(model.getModelType().name().toLowerCase());
+        artifactName.append(model.getModelTypeName());
         artifactName.append("-");
         artifactName.append(hashCodeUuId(model.getModelNameVersionId()));
         return (artifactName.toString()).replaceAll("[^a-zA-Z0-9 +]+", "-");
@@ -307,7 +370,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
         artifactName.append(truncatedArtifactName);
 
         artifactName.append("-");
-        artifactName.append(model.getModelType().name().toLowerCase());
+        artifactName.append(model.getModelTypeName());
         artifactName.append("-");
         artifactName.append(model.getModelVersion());
 
@@ -325,7 +388,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
      *            AAI model as string
      * @return Generated {@link Artifact} model for the resource
      */
-    private Artifact getResourceArtifact(Model resourceModel, String aaiResourceModel) {
+    private Artifact getResourceArtifact(Resource resourceModel, String aaiResourceModel) {
         final String resourceArtifactLabel = getArtifactLabel(resourceModel);
         MDC.put(MDC_PARAM_MODEL_INFO, resourceModel.getModelName() + "," + resourceArtifactLabel);
         final byte[] bytes = aaiResourceModel.getBytes();
@@ -334,7 +397,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
                 GeneratorUtil.checkSum(bytes), GeneratorUtil.encode(bytes));
         artifact.setName(getArtifactName(resourceModel));
         artifact.setLabel(resourceArtifactLabel);
-        artifact.setDescription(ArtifactGeneratorToscaParser.getArtifactDescription(resourceModel));
+        artifact.setDescription("AAI Resource Model");
         return artifact;
     }
 
@@ -364,22 +427,23 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
         String serviceArtifactLabel = getArtifactLabel(serviceModel);
         artifact.setName(serviceArtifactName);
         artifact.setLabel(serviceArtifactLabel);
-        String description = ArtifactGeneratorToscaParser.getArtifactDescription(serviceModel);
-        artifact.setDescription(description);
+        artifact.setDescription("AAI Service Model");
         return artifact;
     }
 
     private int hashCodeUuId(String uuId) {
         int hashcode = 0;
-        for (int i = 0; i < uuId.length(); i++) {
-            hashcode = 31 * hashcode + uuId.charAt(i);
+        if (uuId != null) {
+            for (int i = 0; i < uuId.length(); i++) {
+                hashcode = 31 * hashcode + uuId.charAt(i);
+            }
         }
         return hashcode;
     }
 
     private String truncateName(String name) {
         String truncatedName = name;
-        if (name.length() >= 200) {
+        if (name != null && name.length() >= 200) {
             truncatedName = name.substring(0, 199);
         }
         return truncatedName;
@@ -390,7 +454,7 @@ public class AaiArtifactGenerator implements ArtifactGenerator {
         if (serviceVersion == null) {
             throw new IllegalArgumentException(GENERATOR_AAI_ERROR_MISSING_SERVICE_VERSION);
         } else {
-            String versionRegex = "^[1-9]\\d*(\\.0)$";
+            String versionRegex = "^\\d*\\.\\d*$";
             if (!(serviceVersion.matches(versionRegex))) {
                 throw new IllegalArgumentException(String.format(GENERATOR_AAI_INVALID_SERVICE_VERSION));
             }